]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
wxGTK compilation fixes.
[wxWidgets.git] / wxPython / src / msw / _core.py
CommitLineData
d55e5bfc
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
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
d55e5bfc
RD
47#// Give a reference to the dictionary of this module to the C++ extension
48#// code.
49_core_._wxPySetDictionary(vars())
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
c24da6d6
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
d55e5bfc
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
d55e5bfc
RD
125RB_GROUP = _core_.RB_GROUP
126RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD
127SB_HORIZONTAL = _core_.SB_HORIZONTAL
128SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 129RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
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
0f63ec68
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
d55e5bfc
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
62d32a5f
RD
283PD_SMOOTH = _core_.PD_SMOOTH
284PD_CAN_SKIP = _core_.PD_CAN_SKIP
d55e5bfc
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
0f63ec68
RD
353BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
354BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
355BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
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
611#---------------------------------------------------------------------------
612
613class Object(object):
614 """
615 The base class for most wx objects, although in wxPython not
616 much functionality is needed nor exposed.
617 """
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,)
621 def GetClassName(*args, **kwargs):
622 """
623 GetClassName(self) -> String
624
625 Returns the class name of the C++ class using wxRTTI.
626 """
627 return _core_.Object_GetClassName(*args, **kwargs)
628
629 def Destroy(*args, **kwargs):
630 """
631 Destroy(self)
632
633 Deletes the C++ object this Python object is a proxy for.
634 """
635 return _core_.Object_Destroy(*args, **kwargs)
636
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
643_core_.Object_swigregister(ObjectPtr)
644_wxPySetDictionary = _core_._wxPySetDictionary
645
646_wxPyFixStockObjects = _core_._wxPyFixStockObjects
647
648cvar = _core_.cvar
649EmptyString = cvar.EmptyString
650
651#---------------------------------------------------------------------------
652
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
704#---------------------------------------------------------------------------
705
706class Size(object):
707 """
79fccf9d 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.
d55e5bfc
RD
712 """
713 def __repr__(self):
714 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
715 width = property(_core_.Size_width_get, _core_.Size_width_set)
716 height = property(_core_.Size_height_get, _core_.Size_height_set)
717 x = width; y = height
718 def __init__(self, *args, **kwargs):
719 """
720 __init__(self, int w=0, int h=0) -> Size
721
722 Creates a size object.
723 """
724 newobj = _core_.new_Size(*args, **kwargs)
725 self.this = newobj.this
726 self.thisown = 1
727 del newobj.thisown
728 def __del__(self, destroy=_core_.delete_Size):
729 """__del__(self)"""
730 try:
731 if self.thisown: destroy(self)
732 except: pass
733
734 def __eq__(*args, **kwargs):
735 """
736 __eq__(self, Size sz) -> bool
737
738 Test for equality of wx.Size objects.
739 """
740 return _core_.Size___eq__(*args, **kwargs)
741
742 def __ne__(*args, **kwargs):
743 """
744 __ne__(self, Size sz) -> bool
745
746 Test for inequality.
747 """
748 return _core_.Size___ne__(*args, **kwargs)
749
750 def __add__(*args, **kwargs):
751 """
752 __add__(self, Size sz) -> Size
753
754 Add sz's proprties to this and return the result.
755 """
756 return _core_.Size___add__(*args, **kwargs)
757
758 def __sub__(*args, **kwargs):
759 """
760 __sub__(self, Size sz) -> Size
761
762 Subtract sz's properties from this and return the result.
763 """
764 return _core_.Size___sub__(*args, **kwargs)
765
766 def IncTo(*args, **kwargs):
767 """
768 IncTo(self, Size sz)
769
770 Increments this object so that both of its dimensions are not less
771 than the corresponding dimensions of the size.
772 """
773 return _core_.Size_IncTo(*args, **kwargs)
774
775 def DecTo(*args, **kwargs):
776 """
777 DecTo(self, Size sz)
778
779 Decrements this object so that both of its dimensions are not greater
780 than the corresponding dimensions of the size.
781 """
782 return _core_.Size_DecTo(*args, **kwargs)
783
784 def Set(*args, **kwargs):
785 """
786 Set(self, int w, int h)
787
788 Set both width and height.
789 """
790 return _core_.Size_Set(*args, **kwargs)
791
792 def SetWidth(*args, **kwargs):
793 """SetWidth(self, int w)"""
794 return _core_.Size_SetWidth(*args, **kwargs)
795
796 def SetHeight(*args, **kwargs):
797 """SetHeight(self, int h)"""
798 return _core_.Size_SetHeight(*args, **kwargs)
799
800 def GetWidth(*args, **kwargs):
801 """GetWidth(self) -> int"""
802 return _core_.Size_GetWidth(*args, **kwargs)
803
804 def GetHeight(*args, **kwargs):
805 """GetHeight(self) -> int"""
806 return _core_.Size_GetHeight(*args, **kwargs)
807
808 def IsFullySpecified(*args, **kwargs):
809 """
810 IsFullySpecified(self) -> bool
811
812 Returns True if both components of the size are non-default values.
813 """
814 return _core_.Size_IsFullySpecified(*args, **kwargs)
815
816 def SetDefaults(*args, **kwargs):
817 """
818 SetDefaults(self, Size size)
819
79fccf9d
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.
d55e5bfc
RD
822 """
823 return _core_.Size_SetDefaults(*args, **kwargs)
824
825 def Get(*args, **kwargs):
826 """
827 Get() -> (width,height)
828
829 Returns the width and height properties as a tuple.
830 """
831 return _core_.Size_Get(*args, **kwargs)
832
79fccf9d 833 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
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]
838 def __setitem__(self, index, val):
839 if index == 0: self.width = val
840 elif index == 1: self.height = val
841 else: raise IndexError
842 def __nonzero__(self): return self.Get() != (0,0)
843 __safe_for_unpickling__ = True
844 def __reduce__(self): return (wx.Size, self.Get())
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
852_core_.Size_swigregister(SizePtr)
853
854#---------------------------------------------------------------------------
855
856class RealPoint(object):
857 """
79fccf9d
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.
d55e5bfc
RD
861 """
862 def __repr__(self):
863 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
864 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
865 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
866 def __init__(self, *args, **kwargs):
867 """
868 __init__(self, double x=0.0, double y=0.0) -> RealPoint
869
870 Create a wx.RealPoint object
871 """
872 newobj = _core_.new_RealPoint(*args, **kwargs)
873 self.this = newobj.this
874 self.thisown = 1
875 del newobj.thisown
876 def __del__(self, destroy=_core_.delete_RealPoint):
877 """__del__(self)"""
878 try:
879 if self.thisown: destroy(self)
880 except: pass
881
882 def __eq__(*args, **kwargs):
883 """
884 __eq__(self, RealPoint pt) -> bool
885
886 Test for equality of wx.RealPoint objects.
887 """
888 return _core_.RealPoint___eq__(*args, **kwargs)
889
890 def __ne__(*args, **kwargs):
891 """
892 __ne__(self, RealPoint pt) -> bool
893
894 Test for inequality of wx.RealPoint objects.
895 """
896 return _core_.RealPoint___ne__(*args, **kwargs)
897
898 def __add__(*args, **kwargs):
899 """
900 __add__(self, RealPoint pt) -> RealPoint
901
902 Add pt's proprties to this and return the result.
903 """
904 return _core_.RealPoint___add__(*args, **kwargs)
905
906 def __sub__(*args, **kwargs):
907 """
908 __sub__(self, RealPoint pt) -> RealPoint
909
910 Subtract pt's proprties from this and return the result
911 """
912 return _core_.RealPoint___sub__(*args, **kwargs)
913
914 def Set(*args, **kwargs):
915 """
916 Set(self, double x, double y)
917
918 Set both the x and y properties
919 """
920 return _core_.RealPoint_Set(*args, **kwargs)
921
922 def Get(*args, **kwargs):
923 """
924 Get() -> (x,y)
925
926 Return the x and y properties as a tuple.
927 """
928 return _core_.RealPoint_Get(*args, **kwargs)
929
79fccf9d 930 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
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]
935 def __setitem__(self, index, val):
936 if index == 0: self.x = val
937 elif index == 1: self.y = val
938 else: raise IndexError
939 def __nonzero__(self): return self.Get() != (0.0, 0.0)
940 __safe_for_unpickling__ = True
941 def __reduce__(self): return (wx.RealPoint, self.Get())
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
949_core_.RealPoint_swigregister(RealPointPtr)
950
951#---------------------------------------------------------------------------
952
953class Point(object):
954 """
79fccf9d
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.
d55e5bfc
RD
958 """
959 def __repr__(self):
960 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
961 x = property(_core_.Point_x_get, _core_.Point_x_set)
962 y = property(_core_.Point_y_get, _core_.Point_y_set)
963 def __init__(self, *args, **kwargs):
964 """
965 __init__(self, int x=0, int y=0) -> Point
966
967 Create a wx.Point object
968 """
969 newobj = _core_.new_Point(*args, **kwargs)
970 self.this = newobj.this
971 self.thisown = 1
972 del newobj.thisown
973 def __del__(self, destroy=_core_.delete_Point):
974 """__del__(self)"""
975 try:
976 if self.thisown: destroy(self)
977 except: pass
978
979 def __eq__(*args, **kwargs):
980 """
981 __eq__(self, Point pt) -> bool
982
983 Test for equality of wx.Point objects.
984 """
985 return _core_.Point___eq__(*args, **kwargs)
986
987 def __ne__(*args, **kwargs):
988 """
989 __ne__(self, Point pt) -> bool
990
991 Test for inequality of wx.Point objects.
992 """
993 return _core_.Point___ne__(*args, **kwargs)
994
995 def __add__(*args, **kwargs):
996 """
997 __add__(self, Point pt) -> Point
998
999 Add pt's proprties to this and return the result.
1000 """
1001 return _core_.Point___add__(*args, **kwargs)
1002
1003 def __sub__(*args, **kwargs):
1004 """
1005 __sub__(self, Point pt) -> Point
1006
1007 Subtract pt's proprties from this and return the result
1008 """
1009 return _core_.Point___sub__(*args, **kwargs)
1010
1011 def __iadd__(*args, **kwargs):
1012 """
1013 __iadd__(self, Point pt) -> Point
1014
1015 Add pt to this object.
1016 """
1017 return _core_.Point___iadd__(*args, **kwargs)
1018
1019 def __isub__(*args, **kwargs):
1020 """
1021 __isub__(self, Point pt) -> Point
1022
1023 Subtract pt from this object.
1024 """
1025 return _core_.Point___isub__(*args, **kwargs)
1026
1027 def Set(*args, **kwargs):
1028 """
1029 Set(self, long x, long y)
1030
1031 Set both the x and y properties
1032 """
1033 return _core_.Point_Set(*args, **kwargs)
1034
1035 def Get(*args, **kwargs):
1036 """
1037 Get() -> (x,y)
1038
1039 Return the x and y properties as a tuple.
1040 """
1041 return _core_.Point_Get(*args, **kwargs)
1042
79fccf9d 1043 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
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]
1048 def __setitem__(self, index, val):
1049 if index == 0: self.x = val
1050 elif index == 1: self.y = val
1051 else: raise IndexError
1052 def __nonzero__(self): return self.Get() != (0,0)
1053 __safe_for_unpickling__ = True
1054 def __reduce__(self): return (wx.Point, self.Get())
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
1062_core_.Point_swigregister(PointPtr)
1063
1064#---------------------------------------------------------------------------
1065
1066class Rect(object):
1067 """
79fccf9d
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.
d55e5bfc
RD
1071 """
1072 def __repr__(self):
1073 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1074 def __init__(self, *args, **kwargs):
1075 """
1076 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1077
1078 Create a new Rect object.
1079 """
1080 newobj = _core_.new_Rect(*args, **kwargs)
1081 self.this = newobj.this
1082 self.thisown = 1
1083 del newobj.thisown
1084 def __del__(self, destroy=_core_.delete_Rect):
1085 """__del__(self)"""
1086 try:
1087 if self.thisown: destroy(self)
1088 except: pass
1089
1090 def GetX(*args, **kwargs):
1091 """GetX(self) -> int"""
1092 return _core_.Rect_GetX(*args, **kwargs)
1093
1094 def SetX(*args, **kwargs):
1095 """SetX(self, int x)"""
1096 return _core_.Rect_SetX(*args, **kwargs)
1097
1098 def GetY(*args, **kwargs):
1099 """GetY(self) -> int"""
1100 return _core_.Rect_GetY(*args, **kwargs)
1101
1102 def SetY(*args, **kwargs):
1103 """SetY(self, int y)"""
1104 return _core_.Rect_SetY(*args, **kwargs)
1105
1106 def GetWidth(*args, **kwargs):
1107 """GetWidth(self) -> int"""
1108 return _core_.Rect_GetWidth(*args, **kwargs)
1109
1110 def SetWidth(*args, **kwargs):
1111 """SetWidth(self, int w)"""
1112 return _core_.Rect_SetWidth(*args, **kwargs)
1113
1114 def GetHeight(*args, **kwargs):
1115 """GetHeight(self) -> int"""
1116 return _core_.Rect_GetHeight(*args, **kwargs)
1117
1118 def SetHeight(*args, **kwargs):
1119 """SetHeight(self, int h)"""
1120 return _core_.Rect_SetHeight(*args, **kwargs)
1121
1122 def GetPosition(*args, **kwargs):
1123 """GetPosition(self) -> Point"""
1124 return _core_.Rect_GetPosition(*args, **kwargs)
1125
1126 def SetPosition(*args, **kwargs):
1127 """SetPosition(self, Point p)"""
1128 return _core_.Rect_SetPosition(*args, **kwargs)
1129
1130 def GetSize(*args, **kwargs):
1131 """GetSize(self) -> Size"""
1132 return _core_.Rect_GetSize(*args, **kwargs)
1133
1134 def SetSize(*args, **kwargs):
1135 """SetSize(self, Size s)"""
1136 return _core_.Rect_SetSize(*args, **kwargs)
1137
1138 def GetTopLeft(*args, **kwargs):
1139 """GetTopLeft(self) -> Point"""
1140 return _core_.Rect_GetTopLeft(*args, **kwargs)
1141
1142 def SetTopLeft(*args, **kwargs):
1143 """SetTopLeft(self, Point p)"""
1144 return _core_.Rect_SetTopLeft(*args, **kwargs)
1145
1146 def GetBottomRight(*args, **kwargs):
1147 """GetBottomRight(self) -> Point"""
1148 return _core_.Rect_GetBottomRight(*args, **kwargs)
1149
1150 def SetBottomRight(*args, **kwargs):
1151 """SetBottomRight(self, Point p)"""
1152 return _core_.Rect_SetBottomRight(*args, **kwargs)
1153
1154 def GetLeft(*args, **kwargs):
1155 """GetLeft(self) -> int"""
1156 return _core_.Rect_GetLeft(*args, **kwargs)
1157
1158 def GetTop(*args, **kwargs):
1159 """GetTop(self) -> int"""
1160 return _core_.Rect_GetTop(*args, **kwargs)
1161
1162 def GetBottom(*args, **kwargs):
1163 """GetBottom(self) -> int"""
1164 return _core_.Rect_GetBottom(*args, **kwargs)
1165
1166 def GetRight(*args, **kwargs):
1167 """GetRight(self) -> int"""
1168 return _core_.Rect_GetRight(*args, **kwargs)
1169
1170 def SetLeft(*args, **kwargs):
1171 """SetLeft(self, int left)"""
1172 return _core_.Rect_SetLeft(*args, **kwargs)
1173
1174 def SetRight(*args, **kwargs):
1175 """SetRight(self, int right)"""
1176 return _core_.Rect_SetRight(*args, **kwargs)
1177
1178 def SetTop(*args, **kwargs):
1179 """SetTop(self, int top)"""
1180 return _core_.Rect_SetTop(*args, **kwargs)
1181
1182 def SetBottom(*args, **kwargs):
1183 """SetBottom(self, int bottom)"""
1184 return _core_.Rect_SetBottom(*args, **kwargs)
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):
1194 """
1195 Inflate(self, int dx, int dy) -> Rect
1196
79fccf9d 1197 Increase the rectangle size by dx in x direction and dy in y
b519803b 1198 direction. Both (or one of) parameters may be negative to decrease the
79fccf9d 1199 rectangle size.
d55e5bfc
RD
1200 """
1201 return _core_.Rect_Inflate(*args, **kwargs)
1202
1203 def Deflate(*args, **kwargs):
1204 """
1205 Deflate(self, int dx, int dy) -> Rect
1206
79fccf9d 1207 Decrease the rectangle size by dx in x direction and dy in y
b519803b 1208 direction. Both (or one of) parameters may be negative to increase the
79fccf9d 1209 rectngle size. This method is the opposite of Inflate.
d55e5bfc
RD
1210 """
1211 return _core_.Rect_Deflate(*args, **kwargs)
1212
1213 def OffsetXY(*args, **kwargs):
1214 """
1215 OffsetXY(self, int dx, int dy)
1216
79fccf9d
RD
1217 Moves the rectangle by the specified offset. If dx is positive, the
1218 rectangle is moved to the right, if dy is positive, it is moved to the
1219 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1220 """
1221 return _core_.Rect_OffsetXY(*args, **kwargs)
1222
1223 def Offset(*args, **kwargs):
1224 """
1225 Offset(self, Point pt)
1226
1227 Same as OffsetXY but uses dx,dy from Point
1228 """
1229 return _core_.Rect_Offset(*args, **kwargs)
1230
1231 def Intersect(*args, **kwargs):
1232 """
1233 Intersect(self, Rect rect) -> Rect
1234
b519803b 1235 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD
1236 """
1237 return _core_.Rect_Intersect(*args, **kwargs)
1238
b519803b
RD
1239 def Union(*args, **kwargs):
1240 """
1241 Union(self, Rect rect) -> Rect
1242
1243 Returns the union of this rectangle and rect.
1244 """
1245 return _core_.Rect_Union(*args, **kwargs)
1246
d55e5bfc
RD
1247 def __add__(*args, **kwargs):
1248 """
1249 __add__(self, Rect rect) -> Rect
1250
1251 Add the properties of rect to this rectangle and return the result.
1252 """
1253 return _core_.Rect___add__(*args, **kwargs)
1254
1255 def __iadd__(*args, **kwargs):
1256 """
1257 __iadd__(self, Rect rect) -> Rect
1258
1259 Add the properties of rect to this rectangle, updating this rectangle.
1260 """
1261 return _core_.Rect___iadd__(*args, **kwargs)
1262
1263 def __eq__(*args, **kwargs):
1264 """
1265 __eq__(self, Rect rect) -> bool
1266
1267 Test for equality.
1268 """
1269 return _core_.Rect___eq__(*args, **kwargs)
1270
1271 def __ne__(*args, **kwargs):
1272 """
1273 __ne__(self, Rect rect) -> bool
1274
1275 Test for inequality.
1276 """
1277 return _core_.Rect___ne__(*args, **kwargs)
1278
1279 def InsideXY(*args, **kwargs):
1280 """
1281 InsideXY(self, int x, int y) -> bool
1282
1283 Return True if the point is (not strcitly) inside the rect.
1284 """
1285 return _core_.Rect_InsideXY(*args, **kwargs)
1286
1287 def Inside(*args, **kwargs):
1288 """
1289 Inside(self, Point pt) -> bool
1290
1291 Return True if the point is (not strcitly) inside the rect.
1292 """
1293 return _core_.Rect_Inside(*args, **kwargs)
1294
1295 def Intersects(*args, **kwargs):
1296 """
1297 Intersects(self, Rect rect) -> bool
1298
1299 Returns True if the rectangles have a non empty intersection.
1300 """
1301 return _core_.Rect_Intersects(*args, **kwargs)
1302
1303 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1304 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1305 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1306 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1307 def Set(*args, **kwargs):
1308 """
1309 Set(self, int x=0, int y=0, int width=0, int height=0)
1310
1311 Set all rectangle properties.
1312 """
1313 return _core_.Rect_Set(*args, **kwargs)
1314
1315 def Get(*args, **kwargs):
1316 """
1317 Get() -> (x,y,width,height)
1318
1319 Return the rectangle properties as a tuple.
1320 """
1321 return _core_.Rect_Get(*args, **kwargs)
1322
79fccf9d 1323 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1324 def __str__(self): return str(self.Get())
1325 def __repr__(self): return 'wx.Rect'+str(self.Get())
1326 def __len__(self): return len(self.Get())
1327 def __getitem__(self, index): return self.Get()[index]
1328 def __setitem__(self, index, val):
1329 if index == 0: self.x = val
1330 elif index == 1: self.y = val
1331 elif index == 2: self.width = val
1332 elif index == 3: self.height = val
1333 else: raise IndexError
1334 def __nonzero__(self): return self.Get() != (0,0,0,0)
1335 __safe_for_unpickling__ = True
1336 def __reduce__(self): return (wx.Rect, self.Get())
1337
1338
1339class RectPtr(Rect):
1340 def __init__(self, this):
1341 self.this = this
1342 if not hasattr(self,"thisown"): self.thisown = 0
1343 self.__class__ = Rect
1344_core_.Rect_swigregister(RectPtr)
1345
1346def RectPP(*args, **kwargs):
1347 """
1348 RectPP(Point topLeft, Point bottomRight) -> Rect
1349
1350 Create a new Rect object from Points representing two corners.
1351 """
1352 val = _core_.new_RectPP(*args, **kwargs)
1353 val.thisown = 1
1354 return val
1355
1356def RectPS(*args, **kwargs):
1357 """
1358 RectPS(Point pos, Size size) -> Rect
1359
1360 Create a new Rect from a position and size.
1361 """
1362 val = _core_.new_RectPS(*args, **kwargs)
1363 val.thisown = 1
1364 return val
1365
c1cb24a4
RD
1366def RectS(*args, **kwargs):
1367 """
1368 RectS(Size size) -> Rect
1369
1370 Create a new Rect from a size only.
1371 """
1372 val = _core_.new_RectS(*args, **kwargs)
1373 val.thisown = 1
1374 return val
1375
d55e5bfc
RD
1376
1377def IntersectRect(*args, **kwargs):
1378 """
1379 IntersectRect(Rect r1, Rect r2) -> Rect
1380
1381 Calculate and return the intersection of r1 and r2.
1382 """
1383 return _core_.IntersectRect(*args, **kwargs)
1384#---------------------------------------------------------------------------
1385
1386class Point2D(object):
79fccf9d
RD
1387 """
1388 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1389 with floating point values.
1390 """
d55e5bfc
RD
1391 def __repr__(self):
1392 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1393 def __init__(self, *args, **kwargs):
1394 """
1395 __init__(self, double x=0.0, double y=0.0) -> Point2D
1396
1397 Create a w.Point2D object.
1398 """
1399 newobj = _core_.new_Point2D(*args, **kwargs)
1400 self.this = newobj.this
1401 self.thisown = 1
1402 del newobj.thisown
1403 def GetFloor(*args, **kwargs):
a8eff060
RD
1404 """
1405 GetFloor() -> (x,y)
1406
1407 Convert to integer
1408 """
d55e5bfc
RD
1409 return _core_.Point2D_GetFloor(*args, **kwargs)
1410
1411 def GetRounded(*args, **kwargs):
a8eff060
RD
1412 """
1413 GetRounded() -> (x,y)
1414
1415 Convert to integer
1416 """
d55e5bfc
RD
1417 return _core_.Point2D_GetRounded(*args, **kwargs)
1418
1419 def GetVectorLength(*args, **kwargs):
1420 """GetVectorLength(self) -> double"""
1421 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1422
1423 def GetVectorAngle(*args, **kwargs):
1424 """GetVectorAngle(self) -> double"""
1425 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1426
1427 def SetVectorLength(*args, **kwargs):
1428 """SetVectorLength(self, double length)"""
1429 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1430
1431 def SetVectorAngle(*args, **kwargs):
1432 """SetVectorAngle(self, double degrees)"""
1433 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1434
1435 def SetPolarCoordinates(self, angle, length):
1436 self.SetVectorLength(length)
1437 self.SetVectorAngle(angle)
1438 def Normalize(self):
1439 self.SetVectorLength(1.0)
1440
1441 def GetDistance(*args, **kwargs):
1442 """GetDistance(self, Point2D pt) -> double"""
1443 return _core_.Point2D_GetDistance(*args, **kwargs)
1444
1445 def GetDistanceSquare(*args, **kwargs):
1446 """GetDistanceSquare(self, Point2D pt) -> double"""
1447 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1448
1449 def GetDotProduct(*args, **kwargs):
1450 """GetDotProduct(self, Point2D vec) -> double"""
1451 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1452
1453 def GetCrossProduct(*args, **kwargs):
1454 """GetCrossProduct(self, Point2D vec) -> double"""
1455 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1456
1457 def __neg__(*args, **kwargs):
1458 """
1459 __neg__(self) -> Point2D
1460
1461 the reflection of this point
1462 """
1463 return _core_.Point2D___neg__(*args, **kwargs)
1464
1465 def __iadd__(*args, **kwargs):
1466 """__iadd__(self, Point2D pt) -> Point2D"""
1467 return _core_.Point2D___iadd__(*args, **kwargs)
1468
1469 def __isub__(*args, **kwargs):
1470 """__isub__(self, Point2D pt) -> Point2D"""
1471 return _core_.Point2D___isub__(*args, **kwargs)
1472
1473 def __imul__(*args, **kwargs):
1474 """__imul__(self, Point2D pt) -> Point2D"""
1475 return _core_.Point2D___imul__(*args, **kwargs)
1476
1477 def __idiv__(*args, **kwargs):
1478 """__idiv__(self, Point2D pt) -> Point2D"""
1479 return _core_.Point2D___idiv__(*args, **kwargs)
1480
1481 def __eq__(*args, **kwargs):
1482 """
1483 __eq__(self, Point2D pt) -> bool
1484
1485 Test for equality
1486 """
1487 return _core_.Point2D___eq__(*args, **kwargs)
1488
1489 def __ne__(*args, **kwargs):
1490 """
1491 __ne__(self, Point2D pt) -> bool
1492
1493 Test for inequality
1494 """
1495 return _core_.Point2D___ne__(*args, **kwargs)
1496
1497 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1498 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1499 def Set(*args, **kwargs):
1500 """Set(self, double x=0, double y=0)"""
1501 return _core_.Point2D_Set(*args, **kwargs)
1502
1503 def Get(*args, **kwargs):
1504 """
1505 Get() -> (x,y)
1506
1507 Return x and y properties as a tuple.
1508 """
1509 return _core_.Point2D_Get(*args, **kwargs)
1510
79fccf9d 1511 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1512 def __str__(self): return str(self.Get())
1513 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1514 def __len__(self): return len(self.Get())
1515 def __getitem__(self, index): return self.Get()[index]
1516 def __setitem__(self, index, val):
1517 if index == 0: self.x = val
1518 elif index == 1: self.y = val
1519 else: raise IndexError
1520 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1521 __safe_for_unpickling__ = True
1522 def __reduce__(self): return (wx.Point2D, self.Get())
1523
1524
1525class Point2DPtr(Point2D):
1526 def __init__(self, this):
1527 self.this = this
1528 if not hasattr(self,"thisown"): self.thisown = 0
1529 self.__class__ = Point2D
1530_core_.Point2D_swigregister(Point2DPtr)
1531
1532def Point2DCopy(*args, **kwargs):
1533 """
1534 Point2DCopy(Point2D pt) -> Point2D
1535
1536 Create a w.Point2D object.
1537 """
1538 val = _core_.new_Point2DCopy(*args, **kwargs)
1539 val.thisown = 1
1540 return val
1541
1542def Point2DFromPoint(*args, **kwargs):
1543 """
1544 Point2DFromPoint(Point pt) -> Point2D
1545
1546 Create a w.Point2D object.
1547 """
1548 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1549 val.thisown = 1
1550 return val
1551
1552#---------------------------------------------------------------------------
1553
1554FromStart = _core_.FromStart
1555FromCurrent = _core_.FromCurrent
1556FromEnd = _core_.FromEnd
1557class InputStream(object):
093d3ff1 1558 """Proxy of C++ InputStream class"""
d55e5bfc
RD
1559 def __repr__(self):
1560 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1561 def __init__(self, *args, **kwargs):
1562 """__init__(self, PyObject p) -> InputStream"""
1563 newobj = _core_.new_InputStream(*args, **kwargs)
1564 self.this = newobj.this
1565 self.thisown = 1
1566 del newobj.thisown
8fb0e70a
RD
1567 def __del__(self, destroy=_core_.delete_InputStream):
1568 """__del__(self)"""
1569 try:
1570 if self.thisown: destroy(self)
1571 except: pass
1572
d55e5bfc
RD
1573 def close(*args, **kwargs):
1574 """close(self)"""
1575 return _core_.InputStream_close(*args, **kwargs)
1576
1577 def flush(*args, **kwargs):
1578 """flush(self)"""
1579 return _core_.InputStream_flush(*args, **kwargs)
1580
1581 def eof(*args, **kwargs):
1582 """eof(self) -> bool"""
1583 return _core_.InputStream_eof(*args, **kwargs)
1584
1585 def read(*args, **kwargs):
1586 """read(self, int size=-1) -> PyObject"""
1587 return _core_.InputStream_read(*args, **kwargs)
1588
1589 def readline(*args, **kwargs):
1590 """readline(self, int size=-1) -> PyObject"""
1591 return _core_.InputStream_readline(*args, **kwargs)
1592
1593 def readlines(*args, **kwargs):
1594 """readlines(self, int sizehint=-1) -> PyObject"""
1595 return _core_.InputStream_readlines(*args, **kwargs)
1596
1597 def seek(*args, **kwargs):
1598 """seek(self, int offset, int whence=0)"""
1599 return _core_.InputStream_seek(*args, **kwargs)
1600
1601 def tell(*args, **kwargs):
1602 """tell(self) -> int"""
1603 return _core_.InputStream_tell(*args, **kwargs)
1604
1605 def Peek(*args, **kwargs):
1606 """Peek(self) -> char"""
1607 return _core_.InputStream_Peek(*args, **kwargs)
1608
1609 def GetC(*args, **kwargs):
1610 """GetC(self) -> char"""
1611 return _core_.InputStream_GetC(*args, **kwargs)
1612
1613 def LastRead(*args, **kwargs):
1614 """LastRead(self) -> size_t"""
1615 return _core_.InputStream_LastRead(*args, **kwargs)
1616
1617 def CanRead(*args, **kwargs):
1618 """CanRead(self) -> bool"""
1619 return _core_.InputStream_CanRead(*args, **kwargs)
1620
1621 def Eof(*args, **kwargs):
1622 """Eof(self) -> bool"""
1623 return _core_.InputStream_Eof(*args, **kwargs)
1624
1625 def Ungetch(*args, **kwargs):
1626 """Ungetch(self, char c) -> bool"""
1627 return _core_.InputStream_Ungetch(*args, **kwargs)
1628
1629 def SeekI(*args, **kwargs):
1630 """SeekI(self, long pos, int mode=FromStart) -> long"""
1631 return _core_.InputStream_SeekI(*args, **kwargs)
1632
1633 def TellI(*args, **kwargs):
1634 """TellI(self) -> long"""
1635 return _core_.InputStream_TellI(*args, **kwargs)
1636
1637
1638class InputStreamPtr(InputStream):
1639 def __init__(self, this):
1640 self.this = this
1641 if not hasattr(self,"thisown"): self.thisown = 0
1642 self.__class__ = InputStream
1643_core_.InputStream_swigregister(InputStreamPtr)
1644DefaultPosition = cvar.DefaultPosition
1645DefaultSize = cvar.DefaultSize
1646
1647class OutputStream(object):
093d3ff1 1648 """Proxy of C++ OutputStream class"""
d55e5bfc
RD
1649 def __init__(self): raise RuntimeError, "No constructor defined"
1650 def __repr__(self):
1651 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1652 def write(*args, **kwargs):
1653 """write(self, PyObject obj)"""
1654 return _core_.OutputStream_write(*args, **kwargs)
1655
1656
1657class OutputStreamPtr(OutputStream):
1658 def __init__(self, this):
1659 self.this = this
1660 if not hasattr(self,"thisown"): self.thisown = 0
1661 self.__class__ = OutputStream
1662_core_.OutputStream_swigregister(OutputStreamPtr)
1663
1664#---------------------------------------------------------------------------
1665
1666class FSFile(Object):
093d3ff1 1667 """Proxy of C++ FSFile class"""
d55e5bfc
RD
1668 def __repr__(self):
1669 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1670 def __init__(self, *args, **kwargs):
1671 """
1672 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1673 DateTime modif) -> FSFile
1674 """
1675 newobj = _core_.new_FSFile(*args, **kwargs)
1676 self.this = newobj.this
1677 self.thisown = 1
1678 del newobj.thisown
4cf4100f
RD
1679 self.thisown = 0 # It will normally be deleted by the user of the wxFileSystem
1680
d55e5bfc
RD
1681 def __del__(self, destroy=_core_.delete_FSFile):
1682 """__del__(self)"""
1683 try:
1684 if self.thisown: destroy(self)
1685 except: pass
1686
1687 def GetStream(*args, **kwargs):
1688 """GetStream(self) -> InputStream"""
1689 return _core_.FSFile_GetStream(*args, **kwargs)
1690
1691 def GetMimeType(*args, **kwargs):
1692 """GetMimeType(self) -> String"""
1693 return _core_.FSFile_GetMimeType(*args, **kwargs)
1694
1695 def GetLocation(*args, **kwargs):
1696 """GetLocation(self) -> String"""
1697 return _core_.FSFile_GetLocation(*args, **kwargs)
1698
1699 def GetAnchor(*args, **kwargs):
1700 """GetAnchor(self) -> String"""
1701 return _core_.FSFile_GetAnchor(*args, **kwargs)
1702
1703 def GetModificationTime(*args, **kwargs):
1704 """GetModificationTime(self) -> DateTime"""
1705 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1706
1707
1708class FSFilePtr(FSFile):
1709 def __init__(self, this):
1710 self.this = this
1711 if not hasattr(self,"thisown"): self.thisown = 0
1712 self.__class__ = FSFile
1713_core_.FSFile_swigregister(FSFilePtr)
1714
1715class CPPFileSystemHandler(object):
093d3ff1 1716 """Proxy of C++ CPPFileSystemHandler class"""
d55e5bfc
RD
1717 def __init__(self): raise RuntimeError, "No constructor defined"
1718 def __repr__(self):
1719 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1720
1721class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1722 def __init__(self, this):
1723 self.this = this
1724 if not hasattr(self,"thisown"): self.thisown = 0
1725 self.__class__ = CPPFileSystemHandler
1726_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1727
1728class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1729 """Proxy of C++ FileSystemHandler class"""
d55e5bfc
RD
1730 def __repr__(self):
1731 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1732 def __init__(self, *args, **kwargs):
1733 """__init__(self) -> FileSystemHandler"""
1734 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1735 self.this = newobj.this
1736 self.thisown = 1
1737 del newobj.thisown
1738 self._setCallbackInfo(self, FileSystemHandler)
1739
1740 def _setCallbackInfo(*args, **kwargs):
1741 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1742 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1743
1744 def CanOpen(*args, **kwargs):
1745 """CanOpen(self, String location) -> bool"""
1746 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1747
1748 def OpenFile(*args, **kwargs):
1749 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1750 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1751
1752 def FindFirst(*args, **kwargs):
1753 """FindFirst(self, String spec, int flags=0) -> String"""
1754 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1755
1756 def FindNext(*args, **kwargs):
1757 """FindNext(self) -> String"""
1758 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1759
1760 def GetProtocol(*args, **kwargs):
1761 """GetProtocol(self, String location) -> String"""
1762 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1763
1764 def GetLeftLocation(*args, **kwargs):
1765 """GetLeftLocation(self, String location) -> String"""
1766 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1767
1768 def GetAnchor(*args, **kwargs):
1769 """GetAnchor(self, String location) -> String"""
1770 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1771
1772 def GetRightLocation(*args, **kwargs):
1773 """GetRightLocation(self, String location) -> String"""
1774 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1775
1776 def GetMimeTypeFromExt(*args, **kwargs):
1777 """GetMimeTypeFromExt(self, String location) -> String"""
1778 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1779
1780
1781class FileSystemHandlerPtr(FileSystemHandler):
1782 def __init__(self, this):
1783 self.this = this
1784 if not hasattr(self,"thisown"): self.thisown = 0
1785 self.__class__ = FileSystemHandler
1786_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1787
1788class FileSystem(Object):
093d3ff1 1789 """Proxy of C++ FileSystem class"""
d55e5bfc
RD
1790 def __repr__(self):
1791 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1792 def __init__(self, *args, **kwargs):
1793 """__init__(self) -> FileSystem"""
1794 newobj = _core_.new_FileSystem(*args, **kwargs)
1795 self.this = newobj.this
1796 self.thisown = 1
1797 del newobj.thisown
1798 def __del__(self, destroy=_core_.delete_FileSystem):
1799 """__del__(self)"""
1800 try:
1801 if self.thisown: destroy(self)
1802 except: pass
1803
1804 def ChangePathTo(*args, **kwargs):
1805 """ChangePathTo(self, String location, bool is_dir=False)"""
1806 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1807
1808 def GetPath(*args, **kwargs):
1809 """GetPath(self) -> String"""
1810 return _core_.FileSystem_GetPath(*args, **kwargs)
1811
1812 def OpenFile(*args, **kwargs):
1813 """OpenFile(self, String location) -> FSFile"""
1814 return _core_.FileSystem_OpenFile(*args, **kwargs)
1815
1816 def FindFirst(*args, **kwargs):
1817 """FindFirst(self, String spec, int flags=0) -> String"""
1818 return _core_.FileSystem_FindFirst(*args, **kwargs)
1819
1820 def FindNext(*args, **kwargs):
1821 """FindNext(self) -> String"""
1822 return _core_.FileSystem_FindNext(*args, **kwargs)
1823
1824 def AddHandler(*args, **kwargs):
c24da6d6 1825 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1826 return _core_.FileSystem_AddHandler(*args, **kwargs)
1827
1828 AddHandler = staticmethod(AddHandler)
1829 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1830 """CleanUpHandlers()"""
d55e5bfc
RD
1831 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1832
1833 CleanUpHandlers = staticmethod(CleanUpHandlers)
1834 def FileNameToURL(*args, **kwargs):
c24da6d6 1835 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1836 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1837
1838 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD
1839 def URLToFileName(*args, **kwargs):
1840 """URLToFileName(String url) -> String"""
1841 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1842
1843 URLToFileName = staticmethod(URLToFileName)
d55e5bfc
RD
1844
1845class FileSystemPtr(FileSystem):
1846 def __init__(self, this):
1847 self.this = this
1848 if not hasattr(self,"thisown"): self.thisown = 0
1849 self.__class__ = FileSystem
1850_core_.FileSystem_swigregister(FileSystemPtr)
1851
1852def FileSystem_AddHandler(*args, **kwargs):
1853 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1854 return _core_.FileSystem_AddHandler(*args, **kwargs)
1855
1856def FileSystem_CleanUpHandlers(*args, **kwargs):
1857 """FileSystem_CleanUpHandlers()"""
1858 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1859
1860def FileSystem_FileNameToURL(*args, **kwargs):
1861 """FileSystem_FileNameToURL(String filename) -> String"""
1862 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1863
d55e5bfc
RD
1864def FileSystem_URLToFileName(*args, **kwargs):
1865 """FileSystem_URLToFileName(String url) -> String"""
1866 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1867
d55e5bfc 1868class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1869 """Proxy of C++ InternetFSHandler class"""
d55e5bfc
RD
1870 def __repr__(self):
1871 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1872 def __init__(self, *args, **kwargs):
1873 """__init__(self) -> InternetFSHandler"""
1874 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1875 self.this = newobj.this
1876 self.thisown = 1
1877 del newobj.thisown
1878 def CanOpen(*args, **kwargs):
1879 """CanOpen(self, String location) -> bool"""
1880 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1881
1882 def OpenFile(*args, **kwargs):
1883 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1884 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1885
1886
1887class InternetFSHandlerPtr(InternetFSHandler):
1888 def __init__(self, this):
1889 self.this = this
1890 if not hasattr(self,"thisown"): self.thisown = 0
1891 self.__class__ = InternetFSHandler
1892_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1893
1894class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1895 """Proxy of C++ ZipFSHandler class"""
d55e5bfc
RD
1896 def __repr__(self):
1897 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1898 def __init__(self, *args, **kwargs):
1899 """__init__(self) -> ZipFSHandler"""
1900 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1901 self.this = newobj.this
1902 self.thisown = 1
1903 del newobj.thisown
1904 def CanOpen(*args, **kwargs):
1905 """CanOpen(self, String location) -> bool"""
1906 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1907
1908 def OpenFile(*args, **kwargs):
1909 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1910 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1911
1912 def FindFirst(*args, **kwargs):
1913 """FindFirst(self, String spec, int flags=0) -> String"""
1914 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1915
1916 def FindNext(*args, **kwargs):
1917 """FindNext(self) -> String"""
1918 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1919
1920
1921class ZipFSHandlerPtr(ZipFSHandler):
1922 def __init__(self, this):
1923 self.this = this
1924 if not hasattr(self,"thisown"): self.thisown = 0
1925 self.__class__ = ZipFSHandler
1926_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
1927
1928
1929def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1930 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1931 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1932
1933def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1934 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1935 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1936
1937def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1938 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1939 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD
1940def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1941 """
1942 Add 'file' to the memory filesystem. The dataItem parameter can
1943 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1944 arbitrary data. If a bitmap or image is used then the imgType
1945 parameter should specify what kind of image file it should be
1946 written as, wx.BITMAP_TYPE_PNG, etc.
1947 """
1948 if isinstance(dataItem, wx.Image):
1949 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1950 elif isinstance(dataItem, wx.Bitmap):
1951 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1952 elif type(dataItem) == str:
1953 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1954 else:
1955 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD
1956
1957class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 1958 """Proxy of C++ MemoryFSHandler class"""
d55e5bfc
RD
1959 def __repr__(self):
1960 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1961 def __init__(self, *args, **kwargs):
1962 """__init__(self) -> MemoryFSHandler"""
1963 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
1964 self.this = newobj.this
1965 self.thisown = 1
1966 del newobj.thisown
1967 def RemoveFile(*args, **kwargs):
c24da6d6 1968 """RemoveFile(String filename)"""
d55e5bfc
RD
1969 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1970
1971 RemoveFile = staticmethod(RemoveFile)
1972 AddFile = staticmethod(MemoryFSHandler_AddFile)
1973 def CanOpen(*args, **kwargs):
1974 """CanOpen(self, String location) -> bool"""
1975 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1976
1977 def OpenFile(*args, **kwargs):
1978 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1979 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1980
1981 def FindFirst(*args, **kwargs):
1982 """FindFirst(self, String spec, int flags=0) -> String"""
1983 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1984
1985 def FindNext(*args, **kwargs):
1986 """FindNext(self) -> String"""
1987 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1988
1989
1990class MemoryFSHandlerPtr(MemoryFSHandler):
1991 def __init__(self, this):
1992 self.this = this
1993 if not hasattr(self,"thisown"): self.thisown = 0
1994 self.__class__ = MemoryFSHandler
1995_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
1996
1997def MemoryFSHandler_RemoveFile(*args, **kwargs):
1998 """MemoryFSHandler_RemoveFile(String filename)"""
1999 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2000
2001#---------------------------------------------------------------------------
2002
2003class ImageHandler(Object):
093d3ff1 2004 """Proxy of C++ ImageHandler class"""
d55e5bfc
RD
2005 def __init__(self): raise RuntimeError, "No constructor defined"
2006 def __repr__(self):
2007 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2008 def GetName(*args, **kwargs):
2009 """GetName(self) -> String"""
2010 return _core_.ImageHandler_GetName(*args, **kwargs)
2011
2012 def GetExtension(*args, **kwargs):
2013 """GetExtension(self) -> String"""
2014 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2015
2016 def GetType(*args, **kwargs):
2017 """GetType(self) -> long"""
2018 return _core_.ImageHandler_GetType(*args, **kwargs)
2019
2020 def GetMimeType(*args, **kwargs):
2021 """GetMimeType(self) -> String"""
2022 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2023
2024 def CanRead(*args, **kwargs):
2025 """CanRead(self, String name) -> bool"""
2026 return _core_.ImageHandler_CanRead(*args, **kwargs)
2027
2028 def SetName(*args, **kwargs):
2029 """SetName(self, String name)"""
2030 return _core_.ImageHandler_SetName(*args, **kwargs)
2031
2032 def SetExtension(*args, **kwargs):
2033 """SetExtension(self, String extension)"""
2034 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2035
2036 def SetType(*args, **kwargs):
2037 """SetType(self, long type)"""
2038 return _core_.ImageHandler_SetType(*args, **kwargs)
2039
2040 def SetMimeType(*args, **kwargs):
2041 """SetMimeType(self, String mimetype)"""
2042 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2043
2044
2045class ImageHandlerPtr(ImageHandler):
2046 def __init__(self, this):
2047 self.this = this
2048 if not hasattr(self,"thisown"): self.thisown = 0
2049 self.__class__ = ImageHandler
2050_core_.ImageHandler_swigregister(ImageHandlerPtr)
2051
2052class ImageHistogram(object):
093d3ff1 2053 """Proxy of C++ ImageHistogram class"""
d55e5bfc
RD
2054 def __repr__(self):
2055 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2056 def __init__(self, *args, **kwargs):
2057 """__init__(self) -> ImageHistogram"""
2058 newobj = _core_.new_ImageHistogram(*args, **kwargs)
2059 self.this = newobj.this
2060 self.thisown = 1
2061 del newobj.thisown
2062 def MakeKey(*args, **kwargs):
2063 """
c24da6d6 2064 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
d55e5bfc
RD
2065
2066 Get the key in the histogram for the given RGB values
2067 """
2068 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2069
2070 MakeKey = staticmethod(MakeKey)
2071 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2072 """
2073 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2074
2075 Find first colour that is not used in the image and has higher RGB
2076 values than startR, startG, startB. Returns a tuple consisting of a
2077 success flag and rgb values.
2078 """
d55e5bfc
RD
2079 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2080
2081
2082class ImageHistogramPtr(ImageHistogram):
2083 def __init__(self, this):
2084 self.this = this
2085 if not hasattr(self,"thisown"): self.thisown = 0
2086 self.__class__ = ImageHistogram
2087_core_.ImageHistogram_swigregister(ImageHistogramPtr)
2088
2089def ImageHistogram_MakeKey(*args, **kwargs):
2090 """
2091 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2092
2093 Get the key in the histogram for the given RGB values
2094 """
2095 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2096
2097class Image(Object):
093d3ff1 2098 """Proxy of C++ Image class"""
d55e5bfc
RD
2099 def __repr__(self):
2100 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2101 def __init__(self, *args, **kwargs):
2102 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2103 newobj = _core_.new_Image(*args, **kwargs)
2104 self.this = newobj.this
2105 self.thisown = 1
2106 del newobj.thisown
2107 def __del__(self, destroy=_core_.delete_Image):
2108 """__del__(self)"""
2109 try:
2110 if self.thisown: destroy(self)
2111 except: pass
2112
2113 def Create(*args, **kwargs):
2114 """Create(self, int width, int height)"""
2115 return _core_.Image_Create(*args, **kwargs)
2116
2117 def Destroy(*args, **kwargs):
2118 """
2119 Destroy(self)
2120
2121 Deletes the C++ object this Python object is a proxy for.
2122 """
2123 return _core_.Image_Destroy(*args, **kwargs)
2124
2125 def Scale(*args, **kwargs):
2126 """Scale(self, int width, int height) -> Image"""
2127 return _core_.Image_Scale(*args, **kwargs)
2128
2129 def ShrinkBy(*args, **kwargs):
2130 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
2131 return _core_.Image_ShrinkBy(*args, **kwargs)
2132
2133 def Rescale(*args, **kwargs):
2134 """Rescale(self, int width, int height) -> Image"""
2135 return _core_.Image_Rescale(*args, **kwargs)
2136
2137 def SetRGB(*args, **kwargs):
2138 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
2139 return _core_.Image_SetRGB(*args, **kwargs)
2140
2141 def GetRed(*args, **kwargs):
2142 """GetRed(self, int x, int y) -> unsigned char"""
2143 return _core_.Image_GetRed(*args, **kwargs)
2144
2145 def GetGreen(*args, **kwargs):
2146 """GetGreen(self, int x, int y) -> unsigned char"""
2147 return _core_.Image_GetGreen(*args, **kwargs)
2148
2149 def GetBlue(*args, **kwargs):
2150 """GetBlue(self, int x, int y) -> unsigned char"""
2151 return _core_.Image_GetBlue(*args, **kwargs)
2152
2153 def SetAlpha(*args, **kwargs):
2154 """SetAlpha(self, int x, int y, unsigned char alpha)"""
2155 return _core_.Image_SetAlpha(*args, **kwargs)
2156
2157 def GetAlpha(*args, **kwargs):
2158 """GetAlpha(self, int x, int y) -> unsigned char"""
2159 return _core_.Image_GetAlpha(*args, **kwargs)
2160
2161 def HasAlpha(*args, **kwargs):
2162 """HasAlpha(self) -> bool"""
2163 return _core_.Image_HasAlpha(*args, **kwargs)
2164
2165 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2166 """
2167 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2168
2169 Find first colour that is not used in the image and has higher RGB
2170 values than startR, startG, startB. Returns a tuple consisting of a
2171 success flag and rgb values.
2172 """
d55e5bfc
RD
2173 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2174
4cf4100f
RD
2175 def ConvertAlphaToMask(*args, **kwargs):
2176 """
2177 ConvertAlphaToMask(self, byte threshold=128) -> bool
2178
2179 If the image has alpha channel, this method converts it to mask. All pixels
2180 with alpha value less than ``threshold`` are replaced with mask colour and the
2181 alpha channel is removed. Mask colour is chosen automatically using
2182 `FindFirstUnusedColour`.
2183
2184 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2185 nothing.
2186 """
2187 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2188
8fb0e70a
RD
2189 def ConvertColourToAlpha(*args, **kwargs):
2190 """
2191 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2192
2193 This method converts an image where the original alpha information is
2194 only available as a shades of a colour (actually shades of grey)
2195 typically when you draw anti-aliased text into a bitmap. The DC
2196 drawing routines draw grey values on the black background although
2197 they actually mean to draw white with differnt alpha values. This
2198 method reverses it, assuming a black (!) background and white text.
2199 The method will then fill up the whole image with the colour given.
2200 """
2201 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2202
d55e5bfc
RD
2203 def SetMaskFromImage(*args, **kwargs):
2204 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
2205 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2206
2207 def CanRead(*args, **kwargs):
c24da6d6 2208 """CanRead(String name) -> bool"""
d55e5bfc
RD
2209 return _core_.Image_CanRead(*args, **kwargs)
2210
2211 CanRead = staticmethod(CanRead)
2212 def GetImageCount(*args, **kwargs):
c24da6d6 2213 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
d55e5bfc
RD
2214 return _core_.Image_GetImageCount(*args, **kwargs)
2215
2216 GetImageCount = staticmethod(GetImageCount)
2217 def LoadFile(*args, **kwargs):
2218 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2219 return _core_.Image_LoadFile(*args, **kwargs)
2220
2221 def LoadMimeFile(*args, **kwargs):
2222 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
2223 return _core_.Image_LoadMimeFile(*args, **kwargs)
2224
2225 def SaveFile(*args, **kwargs):
2226 """SaveFile(self, String name, int type) -> bool"""
2227 return _core_.Image_SaveFile(*args, **kwargs)
2228
2229 def SaveMimeFile(*args, **kwargs):
2230 """SaveMimeFile(self, String name, String mimetype) -> bool"""
2231 return _core_.Image_SaveMimeFile(*args, **kwargs)
2232
2233 def CanReadStream(*args, **kwargs):
c24da6d6 2234 """CanReadStream(InputStream stream) -> bool"""
d55e5bfc
RD
2235 return _core_.Image_CanReadStream(*args, **kwargs)
2236
2237 CanReadStream = staticmethod(CanReadStream)
2238 def LoadStream(*args, **kwargs):
2239 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2240 return _core_.Image_LoadStream(*args, **kwargs)
2241
2242 def LoadMimeStream(*args, **kwargs):
2243 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
2244 return _core_.Image_LoadMimeStream(*args, **kwargs)
2245
2246 def Ok(*args, **kwargs):
2247 """Ok(self) -> bool"""
2248 return _core_.Image_Ok(*args, **kwargs)
2249
2250 def GetWidth(*args, **kwargs):
2251 """GetWidth(self) -> int"""
2252 return _core_.Image_GetWidth(*args, **kwargs)
2253
2254 def GetHeight(*args, **kwargs):
2255 """GetHeight(self) -> int"""
2256 return _core_.Image_GetHeight(*args, **kwargs)
2257
2258 def GetSize(*args, **kwargs):
2259 """GetSize(self) -> Size"""
2260 return _core_.Image_GetSize(*args, **kwargs)
2261
2262 def GetSubImage(*args, **kwargs):
2263 """GetSubImage(self, Rect rect) -> Image"""
2264 return _core_.Image_GetSubImage(*args, **kwargs)
2265
2266 def Copy(*args, **kwargs):
2267 """Copy(self) -> Image"""
2268 return _core_.Image_Copy(*args, **kwargs)
2269
2270 def Paste(*args, **kwargs):
2271 """Paste(self, Image image, int x, int y)"""
2272 return _core_.Image_Paste(*args, **kwargs)
2273
2274 def GetData(*args, **kwargs):
2275 """GetData(self) -> PyObject"""
2276 return _core_.Image_GetData(*args, **kwargs)
2277
2278 def SetData(*args, **kwargs):
2279 """SetData(self, PyObject data)"""
2280 return _core_.Image_SetData(*args, **kwargs)
2281
2282 def GetDataBuffer(*args, **kwargs):
2283 """GetDataBuffer(self) -> PyObject"""
2284 return _core_.Image_GetDataBuffer(*args, **kwargs)
2285
2286 def SetDataBuffer(*args, **kwargs):
2287 """SetDataBuffer(self, PyObject data)"""
2288 return _core_.Image_SetDataBuffer(*args, **kwargs)
2289
2290 def GetAlphaData(*args, **kwargs):
2291 """GetAlphaData(self) -> PyObject"""
2292 return _core_.Image_GetAlphaData(*args, **kwargs)
2293
2294 def SetAlphaData(*args, **kwargs):
2295 """SetAlphaData(self, PyObject data)"""
2296 return _core_.Image_SetAlphaData(*args, **kwargs)
2297
2298 def GetAlphaBuffer(*args, **kwargs):
2299 """GetAlphaBuffer(self) -> PyObject"""
2300 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2301
2302 def SetAlphaBuffer(*args, **kwargs):
2303 """SetAlphaBuffer(self, PyObject data)"""
2304 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2305
2306 def SetMaskColour(*args, **kwargs):
2307 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
2308 return _core_.Image_SetMaskColour(*args, **kwargs)
2309
2310 def GetMaskRed(*args, **kwargs):
2311 """GetMaskRed(self) -> unsigned char"""
2312 return _core_.Image_GetMaskRed(*args, **kwargs)
2313
2314 def GetMaskGreen(*args, **kwargs):
2315 """GetMaskGreen(self) -> unsigned char"""
2316 return _core_.Image_GetMaskGreen(*args, **kwargs)
2317
2318 def GetMaskBlue(*args, **kwargs):
2319 """GetMaskBlue(self) -> unsigned char"""
2320 return _core_.Image_GetMaskBlue(*args, **kwargs)
2321
2322 def SetMask(*args, **kwargs):
2323 """SetMask(self, bool mask=True)"""
2324 return _core_.Image_SetMask(*args, **kwargs)
2325
2326 def HasMask(*args, **kwargs):
2327 """HasMask(self) -> bool"""
2328 return _core_.Image_HasMask(*args, **kwargs)
2329
2330 def Rotate(*args, **kwargs):
2331 """
2332 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2333 Point offset_after_rotation=None) -> Image
2334 """
2335 return _core_.Image_Rotate(*args, **kwargs)
2336
2337 def Rotate90(*args, **kwargs):
2338 """Rotate90(self, bool clockwise=True) -> Image"""
2339 return _core_.Image_Rotate90(*args, **kwargs)
2340
2341 def Mirror(*args, **kwargs):
2342 """Mirror(self, bool horizontally=True) -> Image"""
2343 return _core_.Image_Mirror(*args, **kwargs)
2344
2345 def Replace(*args, **kwargs):
2346 """
2347 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
2348 unsigned char r2, unsigned char g2, unsigned char b2)
2349 """
2350 return _core_.Image_Replace(*args, **kwargs)
2351
2352 def ConvertToMono(*args, **kwargs):
2353 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
2354 return _core_.Image_ConvertToMono(*args, **kwargs)
2355
2356 def SetOption(*args, **kwargs):
2357 """SetOption(self, String name, String value)"""
2358 return _core_.Image_SetOption(*args, **kwargs)
2359
2360 def SetOptionInt(*args, **kwargs):
2361 """SetOptionInt(self, String name, int value)"""
2362 return _core_.Image_SetOptionInt(*args, **kwargs)
2363
2364 def GetOption(*args, **kwargs):
2365 """GetOption(self, String name) -> String"""
2366 return _core_.Image_GetOption(*args, **kwargs)
2367
2368 def GetOptionInt(*args, **kwargs):
2369 """GetOptionInt(self, String name) -> int"""
2370 return _core_.Image_GetOptionInt(*args, **kwargs)
2371
2372 def HasOption(*args, **kwargs):
2373 """HasOption(self, String name) -> bool"""
2374 return _core_.Image_HasOption(*args, **kwargs)
2375
2376 def CountColours(*args, **kwargs):
2377 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2378 return _core_.Image_CountColours(*args, **kwargs)
2379
2380 def ComputeHistogram(*args, **kwargs):
2381 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2382 return _core_.Image_ComputeHistogram(*args, **kwargs)
2383
2384 def AddHandler(*args, **kwargs):
c24da6d6 2385 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
2386 return _core_.Image_AddHandler(*args, **kwargs)
2387
2388 AddHandler = staticmethod(AddHandler)
2389 def InsertHandler(*args, **kwargs):
c24da6d6 2390 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
2391 return _core_.Image_InsertHandler(*args, **kwargs)
2392
2393 InsertHandler = staticmethod(InsertHandler)
2394 def RemoveHandler(*args, **kwargs):
c24da6d6 2395 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
2396 return _core_.Image_RemoveHandler(*args, **kwargs)
2397
2398 RemoveHandler = staticmethod(RemoveHandler)
2399 def GetImageExtWildcard(*args, **kwargs):
c24da6d6 2400 """GetImageExtWildcard() -> String"""
d55e5bfc
RD
2401 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2402
2403 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2404 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2405 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD
2406 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2407
2408 def ConvertToMonoBitmap(*args, **kwargs):
2409 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
2410 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2411
2412 def __nonzero__(self): return self.Ok()
2413
2414class ImagePtr(Image):
2415 def __init__(self, this):
2416 self.this = this
2417 if not hasattr(self,"thisown"): self.thisown = 0
2418 self.__class__ = Image
2419_core_.Image_swigregister(ImagePtr)
2420
2421def ImageFromMime(*args, **kwargs):
2422 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
2423 val = _core_.new_ImageFromMime(*args, **kwargs)
2424 val.thisown = 1
2425 return val
2426
2427def ImageFromStream(*args, **kwargs):
2428 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2429 val = _core_.new_ImageFromStream(*args, **kwargs)
2430 val.thisown = 1
2431 return val
2432
2433def ImageFromStreamMime(*args, **kwargs):
2434 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
2435 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2436 val.thisown = 1
2437 return val
2438
c24da6d6
RD
2439def EmptyImage(*args, **kwargs):
2440 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2441 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
2442 val.thisown = 1
2443 return val
2444
2445def ImageFromBitmap(*args, **kwargs):
2446 """ImageFromBitmap(Bitmap bitmap) -> Image"""
2447 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2448 val.thisown = 1
2449 return val
2450
2451def ImageFromData(*args, **kwargs):
2452 """ImageFromData(int width, int height, unsigned char data) -> Image"""
2453 val = _core_.new_ImageFromData(*args, **kwargs)
2454 val.thisown = 1
2455 return val
2456
c9c2cf70
RD
2457def ImageFromDataWithAlpha(*args, **kwargs):
2458 """ImageFromDataWithAlpha(int width, int height, unsigned char data, unsigned char alpha) -> Image"""
2459 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2460 val.thisown = 1
2461 return val
2462
d55e5bfc
RD
2463def Image_CanRead(*args, **kwargs):
2464 """Image_CanRead(String name) -> bool"""
2465 return _core_.Image_CanRead(*args, **kwargs)
2466
2467def Image_GetImageCount(*args, **kwargs):
2468 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
2469 return _core_.Image_GetImageCount(*args, **kwargs)
2470
2471def Image_CanReadStream(*args, **kwargs):
2472 """Image_CanReadStream(InputStream stream) -> bool"""
2473 return _core_.Image_CanReadStream(*args, **kwargs)
2474
2475def Image_AddHandler(*args, **kwargs):
2476 """Image_AddHandler(ImageHandler handler)"""
2477 return _core_.Image_AddHandler(*args, **kwargs)
2478
2479def Image_InsertHandler(*args, **kwargs):
2480 """Image_InsertHandler(ImageHandler handler)"""
2481 return _core_.Image_InsertHandler(*args, **kwargs)
2482
2483def Image_RemoveHandler(*args, **kwargs):
2484 """Image_RemoveHandler(String name) -> bool"""
2485 return _core_.Image_RemoveHandler(*args, **kwargs)
2486
2487def Image_GetImageExtWildcard(*args, **kwargs):
2488 """Image_GetImageExtWildcard() -> String"""
2489 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2490
a07a67e6
RD
2491def InitAllImageHandlers():
2492 """
2493 The former functionality of InitAllImageHanders is now done internal to
2494 the _core_ extension module and so this function has become a simple NOP.
2495 """
2496 pass
d55e5bfc 2497
d55e5bfc
RD
2498IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2499IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2500BMP_24BPP = _core_.BMP_24BPP
2501BMP_8BPP = _core_.BMP_8BPP
2502BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2503BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2504BMP_8BPP_RED = _core_.BMP_8BPP_RED
2505BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2506BMP_4BPP = _core_.BMP_4BPP
2507BMP_1BPP = _core_.BMP_1BPP
2508BMP_1BPP_BW = _core_.BMP_1BPP_BW
2509class BMPHandler(ImageHandler):
093d3ff1 2510 """Proxy of C++ BMPHandler class"""
d55e5bfc
RD
2511 def __repr__(self):
2512 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2513 def __init__(self, *args, **kwargs):
2514 """__init__(self) -> BMPHandler"""
2515 newobj = _core_.new_BMPHandler(*args, **kwargs)
2516 self.this = newobj.this
2517 self.thisown = 1
2518 del newobj.thisown
2519
2520class BMPHandlerPtr(BMPHandler):
2521 def __init__(self, this):
2522 self.this = this
2523 if not hasattr(self,"thisown"): self.thisown = 0
2524 self.__class__ = BMPHandler
2525_core_.BMPHandler_swigregister(BMPHandlerPtr)
2526NullImage = cvar.NullImage
2527IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2528IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2529IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2530IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2531IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2532
2533class ICOHandler(BMPHandler):
093d3ff1 2534 """Proxy of C++ ICOHandler class"""
d55e5bfc
RD
2535 def __repr__(self):
2536 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2537 def __init__(self, *args, **kwargs):
2538 """__init__(self) -> ICOHandler"""
2539 newobj = _core_.new_ICOHandler(*args, **kwargs)
2540 self.this = newobj.this
2541 self.thisown = 1
2542 del newobj.thisown
2543
2544class ICOHandlerPtr(ICOHandler):
2545 def __init__(self, this):
2546 self.this = this
2547 if not hasattr(self,"thisown"): self.thisown = 0
2548 self.__class__ = ICOHandler
2549_core_.ICOHandler_swigregister(ICOHandlerPtr)
2550
2551class CURHandler(ICOHandler):
093d3ff1 2552 """Proxy of C++ CURHandler class"""
d55e5bfc
RD
2553 def __repr__(self):
2554 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2555 def __init__(self, *args, **kwargs):
2556 """__init__(self) -> CURHandler"""
2557 newobj = _core_.new_CURHandler(*args, **kwargs)
2558 self.this = newobj.this
2559 self.thisown = 1
2560 del newobj.thisown
2561
2562class CURHandlerPtr(CURHandler):
2563 def __init__(self, this):
2564 self.this = this
2565 if not hasattr(self,"thisown"): self.thisown = 0
2566 self.__class__ = CURHandler
2567_core_.CURHandler_swigregister(CURHandlerPtr)
2568
2569class ANIHandler(CURHandler):
093d3ff1 2570 """Proxy of C++ ANIHandler class"""
d55e5bfc
RD
2571 def __repr__(self):
2572 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2573 def __init__(self, *args, **kwargs):
2574 """__init__(self) -> ANIHandler"""
2575 newobj = _core_.new_ANIHandler(*args, **kwargs)
2576 self.this = newobj.this
2577 self.thisown = 1
2578 del newobj.thisown
2579
2580class ANIHandlerPtr(ANIHandler):
2581 def __init__(self, this):
2582 self.this = this
2583 if not hasattr(self,"thisown"): self.thisown = 0
2584 self.__class__ = ANIHandler
2585_core_.ANIHandler_swigregister(ANIHandlerPtr)
2586
2587class PNGHandler(ImageHandler):
093d3ff1 2588 """Proxy of C++ PNGHandler class"""
d55e5bfc
RD
2589 def __repr__(self):
2590 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2591 def __init__(self, *args, **kwargs):
2592 """__init__(self) -> PNGHandler"""
2593 newobj = _core_.new_PNGHandler(*args, **kwargs)
2594 self.this = newobj.this
2595 self.thisown = 1
2596 del newobj.thisown
2597
2598class PNGHandlerPtr(PNGHandler):
2599 def __init__(self, this):
2600 self.this = this
2601 if not hasattr(self,"thisown"): self.thisown = 0
2602 self.__class__ = PNGHandler
2603_core_.PNGHandler_swigregister(PNGHandlerPtr)
2604
2605class GIFHandler(ImageHandler):
093d3ff1 2606 """Proxy of C++ GIFHandler class"""
d55e5bfc
RD
2607 def __repr__(self):
2608 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2609 def __init__(self, *args, **kwargs):
2610 """__init__(self) -> GIFHandler"""
2611 newobj = _core_.new_GIFHandler(*args, **kwargs)
2612 self.this = newobj.this
2613 self.thisown = 1
2614 del newobj.thisown
2615
2616class GIFHandlerPtr(GIFHandler):
2617 def __init__(self, this):
2618 self.this = this
2619 if not hasattr(self,"thisown"): self.thisown = 0
2620 self.__class__ = GIFHandler
2621_core_.GIFHandler_swigregister(GIFHandlerPtr)
2622
2623class PCXHandler(ImageHandler):
093d3ff1 2624 """Proxy of C++ PCXHandler class"""
d55e5bfc
RD
2625 def __repr__(self):
2626 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2627 def __init__(self, *args, **kwargs):
2628 """__init__(self) -> PCXHandler"""
2629 newobj = _core_.new_PCXHandler(*args, **kwargs)
2630 self.this = newobj.this
2631 self.thisown = 1
2632 del newobj.thisown
2633
2634class PCXHandlerPtr(PCXHandler):
2635 def __init__(self, this):
2636 self.this = this
2637 if not hasattr(self,"thisown"): self.thisown = 0
2638 self.__class__ = PCXHandler
2639_core_.PCXHandler_swigregister(PCXHandlerPtr)
2640
2641class JPEGHandler(ImageHandler):
093d3ff1 2642 """Proxy of C++ JPEGHandler class"""
d55e5bfc
RD
2643 def __repr__(self):
2644 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2645 def __init__(self, *args, **kwargs):
2646 """__init__(self) -> JPEGHandler"""
2647 newobj = _core_.new_JPEGHandler(*args, **kwargs)
2648 self.this = newobj.this
2649 self.thisown = 1
2650 del newobj.thisown
2651
2652class JPEGHandlerPtr(JPEGHandler):
2653 def __init__(self, this):
2654 self.this = this
2655 if not hasattr(self,"thisown"): self.thisown = 0
2656 self.__class__ = JPEGHandler
2657_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
2658
2659class PNMHandler(ImageHandler):
093d3ff1 2660 """Proxy of C++ PNMHandler class"""
d55e5bfc
RD
2661 def __repr__(self):
2662 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2663 def __init__(self, *args, **kwargs):
2664 """__init__(self) -> PNMHandler"""
2665 newobj = _core_.new_PNMHandler(*args, **kwargs)
2666 self.this = newobj.this
2667 self.thisown = 1
2668 del newobj.thisown
2669
2670class PNMHandlerPtr(PNMHandler):
2671 def __init__(self, this):
2672 self.this = this
2673 if not hasattr(self,"thisown"): self.thisown = 0
2674 self.__class__ = PNMHandler
2675_core_.PNMHandler_swigregister(PNMHandlerPtr)
2676
2677class XPMHandler(ImageHandler):
093d3ff1 2678 """Proxy of C++ XPMHandler class"""
d55e5bfc
RD
2679 def __repr__(self):
2680 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2681 def __init__(self, *args, **kwargs):
2682 """__init__(self) -> XPMHandler"""
2683 newobj = _core_.new_XPMHandler(*args, **kwargs)
2684 self.this = newobj.this
2685 self.thisown = 1
2686 del newobj.thisown
2687
2688class XPMHandlerPtr(XPMHandler):
2689 def __init__(self, this):
2690 self.this = this
2691 if not hasattr(self,"thisown"): self.thisown = 0
2692 self.__class__ = XPMHandler
2693_core_.XPMHandler_swigregister(XPMHandlerPtr)
2694
2695class TIFFHandler(ImageHandler):
093d3ff1 2696 """Proxy of C++ TIFFHandler class"""
d55e5bfc
RD
2697 def __repr__(self):
2698 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2699 def __init__(self, *args, **kwargs):
2700 """__init__(self) -> TIFFHandler"""
2701 newobj = _core_.new_TIFFHandler(*args, **kwargs)
2702 self.this = newobj.this
2703 self.thisown = 1
2704 del newobj.thisown
2705
2706class TIFFHandlerPtr(TIFFHandler):
2707 def __init__(self, this):
2708 self.this = this
2709 if not hasattr(self,"thisown"): self.thisown = 0
2710 self.__class__ = TIFFHandler
2711_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
2712
c0de73ae
RD
2713QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2714QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2715class Quantize(object):
2716 """Performs quantization, or colour reduction, on a wxImage."""
2717 def __init__(self): raise RuntimeError, "No constructor defined"
2718 def __repr__(self):
2719 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2720 def Quantize(*args, **kwargs):
2721 """
2722 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2723
2724 Reduce the colours in the source image and put the result into the
2725 destination image, setting the palette in the destination if
2726 needed. Both images may be the same, to overwrite the source image.
2727 """
2728 return _core_.Quantize_Quantize(*args, **kwargs)
2729
2730 Quantize = staticmethod(Quantize)
2731
2732class QuantizePtr(Quantize):
2733 def __init__(self, this):
2734 self.this = this
2735 if not hasattr(self,"thisown"): self.thisown = 0
2736 self.__class__ = Quantize
2737_core_.Quantize_swigregister(QuantizePtr)
2738
2739def Quantize_Quantize(*args, **kwargs):
2740 """
2741 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2742
2743 Reduce the colours in the source image and put the result into the
2744 destination image, setting the palette in the destination if
2745 needed. Both images may be the same, to overwrite the source image.
2746 """
2747 return _core_.Quantize_Quantize(*args, **kwargs)
2748
d55e5bfc
RD
2749#---------------------------------------------------------------------------
2750
2751class EvtHandler(Object):
093d3ff1 2752 """Proxy of C++ EvtHandler class"""
d55e5bfc
RD
2753 def __repr__(self):
2754 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2755 def __init__(self, *args, **kwargs):
2756 """__init__(self) -> EvtHandler"""
2757 newobj = _core_.new_EvtHandler(*args, **kwargs)
2758 self.this = newobj.this
2759 self.thisown = 1
2760 del newobj.thisown
2761 def GetNextHandler(*args, **kwargs):
2762 """GetNextHandler(self) -> EvtHandler"""
2763 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
2764
2765 def GetPreviousHandler(*args, **kwargs):
2766 """GetPreviousHandler(self) -> EvtHandler"""
2767 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
2768
2769 def SetNextHandler(*args, **kwargs):
2770 """SetNextHandler(self, EvtHandler handler)"""
2771 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
2772
2773 def SetPreviousHandler(*args, **kwargs):
2774 """SetPreviousHandler(self, EvtHandler handler)"""
2775 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
2776
2777 def GetEvtHandlerEnabled(*args, **kwargs):
2778 """GetEvtHandlerEnabled(self) -> bool"""
2779 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
2780
2781 def SetEvtHandlerEnabled(*args, **kwargs):
2782 """SetEvtHandlerEnabled(self, bool enabled)"""
2783 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
2784
2785 def ProcessEvent(*args, **kwargs):
2786 """ProcessEvent(self, Event event) -> bool"""
2787 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
2788
2789 def AddPendingEvent(*args, **kwargs):
2790 """AddPendingEvent(self, Event event)"""
2791 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
2792
2793 def ProcessPendingEvents(*args, **kwargs):
2794 """ProcessPendingEvents(self)"""
2795 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
2796
2797 def Connect(*args, **kwargs):
2798 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
2799 return _core_.EvtHandler_Connect(*args, **kwargs)
2800
2801 def Disconnect(*args, **kwargs):
2802 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
2803 return _core_.EvtHandler_Disconnect(*args, **kwargs)
2804
2805 def _setOORInfo(*args, **kwargs):
093d3ff1 2806 """_setOORInfo(self, PyObject _self, bool incref=True)"""
d55e5bfc
RD
2807 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
2808
2809 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2810 """
2811 Bind an event to an event handler.
2812
caef1a4d
RD
2813 :param event: One of the EVT_* objects that specifies the
2814 type of event to bind,
d55e5bfc 2815
caef1a4d
RD
2816 :param handler: A callable object to be invoked when the
2817 event is delivered to self. Pass None to
2818 disconnect an event handler.
d55e5bfc 2819
caef1a4d
RD
2820 :param source: Sometimes the event originates from a
2821 different window than self, but you still
2822 want to catch it in self. (For example, a
2823 button event delivered to a frame.) By
2824 passing the source of the event, the event
2825 handling system is able to differentiate
2826 between the same event type from different
2827 controls.
d55e5bfc 2828
caef1a4d
RD
2829 :param id: Used to spcify the event source by ID instead
2830 of instance.
2831
2832 :param id2: Used when it is desirable to bind a handler
2833 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
2834 """
2835 if source is not None:
2836 id = source.GetId()
2837 event.Bind(self, id, id2, handler)
2838
c24da6d6
RD
2839 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2840 """
2841 Disconencts the event handler binding for event from self.
2842 Returns True if successful.
2843 """
2844 if source is not None:
2845 id = source.GetId()
2846 return event.Unbind(self, id, id2)
d55e5bfc
RD
2847
2848
2849class EvtHandlerPtr(EvtHandler):
2850 def __init__(self, this):
2851 self.this = this
2852 if not hasattr(self,"thisown"): self.thisown = 0
2853 self.__class__ = EvtHandler
2854_core_.EvtHandler_swigregister(EvtHandlerPtr)
2855
2856#---------------------------------------------------------------------------
2857
2858class PyEventBinder(object):
2859 """
2860 Instances of this class are used to bind specific events to event
2861 handlers.
2862 """
2863 def __init__(self, evtType, expectedIDs=0):
2864 if expectedIDs not in [0, 1, 2]:
2865 raise ValueError, "Invalid number of expectedIDs"
2866 self.expectedIDs = expectedIDs
2867
2868 if type(evtType) == list or type(evtType) == tuple:
2869 self.evtType = evtType
2870 else:
2871 self.evtType = [evtType]
2872
2873
2874 def Bind(self, target, id1, id2, function):
2875 """Bind this set of event types to target."""
2876 for et in self.evtType:
2877 target.Connect(id1, id2, et, function)
2878
c24da6d6
RD
2879
2880 def Unbind(self, target, id1, id2):
2881 """Remove an event binding."""
2882 success = 0
2883 for et in self.evtType:
2884 success += target.Disconnect(id1, id2, et)
2885 return success != 0
2886
d55e5bfc
RD
2887
2888 def __call__(self, *args):
2889 """
2890 For backwards compatibility with the old EVT_* functions.
2891 Should be called with either (window, func), (window, ID,
2892 func) or (window, ID1, ID2, func) parameters depending on the
2893 type of the event.
2894 """
2895 assert len(args) == 2 + self.expectedIDs
2896 id1 = wx.ID_ANY
2897 id2 = wx.ID_ANY
2898 target = args[0]
2899 if self.expectedIDs == 0:
2900 func = args[1]
2901 elif self.expectedIDs == 1:
2902 id1 = args[1]
2903 func = args[2]
2904 elif self.expectedIDs == 2:
2905 id1 = args[1]
2906 id2 = args[2]
2907 func = args[3]
2908 else:
2909 raise ValueError, "Unexpected number of IDs"
2910
2911 self.Bind(target, id1, id2, func)
2912
2913
2914# These two are square pegs that don't fit the PyEventBinder hole...
2915def EVT_COMMAND(win, id, cmd, func):
2916 win.Connect(id, -1, cmd, func)
2917def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2918 win.Connect(id1, id2, cmd, func)
2919
2920
2921#---------------------------------------------------------------------------
2922
2923#---------------------------------------------------------------------------
2924
2925EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2926EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
2927
2928def NewEventType(*args, **kwargs):
2929 """NewEventType() -> wxEventType"""
2930 return _core_.NewEventType(*args, **kwargs)
2931wxEVT_NULL = _core_.wxEVT_NULL
2932wxEVT_FIRST = _core_.wxEVT_FIRST
2933wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2934wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2935wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2936wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2937wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2938wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2939wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2940wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2941wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2942wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2943wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2944wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2945wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2946wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2947wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2948wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2949wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2950wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2951wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2952wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2953wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2954wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2955wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2956wxEVT_MOTION = _core_.wxEVT_MOTION
2957wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2958wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2959wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2960wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2961wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2962wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2963wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2964wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2965wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2966wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2967wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2968wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2969wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2970wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2971wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2972wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2973wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2974wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2975wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2976wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2977wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2978wxEVT_CHAR = _core_.wxEVT_CHAR
2979wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2980wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2981wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2982wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2983wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2984wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2985wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2986wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2987wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2988wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2989wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2990wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2991wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2992wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2993wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2994wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2995wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2996wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2997wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2998wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2999wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3000wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3001wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3002wxEVT_SIZE = _core_.wxEVT_SIZE
3003wxEVT_MOVE = _core_.wxEVT_MOVE
3004wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3005wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3006wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3007wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3008wxEVT_POWER = _core_.wxEVT_POWER
3009wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3010wxEVT_CREATE = _core_.wxEVT_CREATE
3011wxEVT_DESTROY = _core_.wxEVT_DESTROY
3012wxEVT_SHOW = _core_.wxEVT_SHOW
3013wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3014wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3015wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3016wxEVT_PAINT = _core_.wxEVT_PAINT
3017wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3018wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3019wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3020wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3021wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3022wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3023wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3024wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3025wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3026wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3027wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3028wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3029wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3030wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3031wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3032wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3033wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3034wxEVT_IDLE = _core_.wxEVT_IDLE
3035wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3036wxEVT_SIZING = _core_.wxEVT_SIZING
3037wxEVT_MOVING = _core_.wxEVT_MOVING
3038wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3039wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3040wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3041wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3042wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3043wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3044wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3045#
3046# Create some event binders
3047EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3048EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3049EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3050EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3051EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3052EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3053EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3054EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3055EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3056EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3057EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3058EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3059EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3060EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3061EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3062EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3063EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3064EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3065EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3066EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3067EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3068EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3069EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3070EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
3071EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3072EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3073EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3074EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3075EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3076EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3077EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3078EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3079EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3080EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3081EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3082EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3083EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3084EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3085EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3086EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3087
3088EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3089EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3090EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3091EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3092EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3093EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3094EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3095EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3096EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3097EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3098EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3099EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3100EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3101
3102EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3103 wxEVT_LEFT_UP,
3104 wxEVT_MIDDLE_DOWN,
3105 wxEVT_MIDDLE_UP,
3106 wxEVT_RIGHT_DOWN,
3107 wxEVT_RIGHT_UP,
3108 wxEVT_MOTION,
3109 wxEVT_LEFT_DCLICK,
3110 wxEVT_MIDDLE_DCLICK,
3111 wxEVT_RIGHT_DCLICK,
3112 wxEVT_ENTER_WINDOW,
3113 wxEVT_LEAVE_WINDOW,
3114 wxEVT_MOUSEWHEEL
3115 ])
3116
3117
3118# Scrolling from wxWindow (sent to wxScrolledWindow)
3119EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3120 wxEVT_SCROLLWIN_BOTTOM,
3121 wxEVT_SCROLLWIN_LINEUP,
3122 wxEVT_SCROLLWIN_LINEDOWN,
3123 wxEVT_SCROLLWIN_PAGEUP,
3124 wxEVT_SCROLLWIN_PAGEDOWN,
3125 wxEVT_SCROLLWIN_THUMBTRACK,
3126 wxEVT_SCROLLWIN_THUMBRELEASE,
3127 ])
3128
3129EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3130EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3131EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3132EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3133EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3134EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3135EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3136EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3137
3138# Scrolling from wxSlider and wxScrollBar
3139EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3140 wxEVT_SCROLL_BOTTOM,
3141 wxEVT_SCROLL_LINEUP,
3142 wxEVT_SCROLL_LINEDOWN,
3143 wxEVT_SCROLL_PAGEUP,
3144 wxEVT_SCROLL_PAGEDOWN,
3145 wxEVT_SCROLL_THUMBTRACK,
3146 wxEVT_SCROLL_THUMBRELEASE,
3147 wxEVT_SCROLL_ENDSCROLL,
3148 ])
3149
3150EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3151EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3152EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3153EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3154EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3155EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3156EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3157EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3158EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3159
3160# Scrolling from wxSlider and wxScrollBar, with an id
3161EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3162 wxEVT_SCROLL_BOTTOM,
3163 wxEVT_SCROLL_LINEUP,
3164 wxEVT_SCROLL_LINEDOWN,
3165 wxEVT_SCROLL_PAGEUP,
3166 wxEVT_SCROLL_PAGEDOWN,
3167 wxEVT_SCROLL_THUMBTRACK,
3168 wxEVT_SCROLL_THUMBRELEASE,
3169 wxEVT_SCROLL_ENDSCROLL,
3170 ], 1)
3171
3172EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3173EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3174EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3175EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3176EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3177EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3178EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3179EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3180EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3181
3182EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3183EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3184EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3185EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3186EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3187EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3188EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3189EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3190EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3191EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3192
3193EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3194EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3195EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3196EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3197EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3198EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3199EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3200EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3201EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3202
3203
3204EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3205EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3206EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3207EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3208EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3209EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3210EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3211
3212EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3213
3214EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3215EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3216
3217EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3218
3219
3220
3221#---------------------------------------------------------------------------
3222
3223class Event(Object):
093d3ff1 3224 """Proxy of C++ Event class"""
d55e5bfc
RD
3225 def __init__(self): raise RuntimeError, "No constructor defined"
3226 def __repr__(self):
3227 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3228 def __del__(self, destroy=_core_.delete_Event):
3229 """__del__(self)"""
3230 try:
3231 if self.thisown: destroy(self)
3232 except: pass
3233
3234 def SetEventType(*args, **kwargs):
3235 """SetEventType(self, wxEventType typ)"""
3236 return _core_.Event_SetEventType(*args, **kwargs)
3237
3238 def GetEventType(*args, **kwargs):
3239 """GetEventType(self) -> wxEventType"""
3240 return _core_.Event_GetEventType(*args, **kwargs)
3241
3242 def GetEventObject(*args, **kwargs):
3243 """GetEventObject(self) -> Object"""
3244 return _core_.Event_GetEventObject(*args, **kwargs)
3245
3246 def SetEventObject(*args, **kwargs):
3247 """SetEventObject(self, Object obj)"""
3248 return _core_.Event_SetEventObject(*args, **kwargs)
3249
3250 def GetTimestamp(*args, **kwargs):
3251 """GetTimestamp(self) -> long"""
3252 return _core_.Event_GetTimestamp(*args, **kwargs)
3253
3254 def SetTimestamp(*args, **kwargs):
3255 """SetTimestamp(self, long ts=0)"""
3256 return _core_.Event_SetTimestamp(*args, **kwargs)
3257
3258 def GetId(*args, **kwargs):
3259 """GetId(self) -> int"""
3260 return _core_.Event_GetId(*args, **kwargs)
3261
3262 def SetId(*args, **kwargs):
3263 """SetId(self, int Id)"""
3264 return _core_.Event_SetId(*args, **kwargs)
3265
3266 def IsCommandEvent(*args, **kwargs):
3267 """IsCommandEvent(self) -> bool"""
3268 return _core_.Event_IsCommandEvent(*args, **kwargs)
3269
3270 def Skip(*args, **kwargs):
51b83b37
RD
3271 """
3272 Skip(self, bool skip=True)
3273
3274 Called by an event handler, it controls whether additional event
3275 handlers bound to this event will be called after the current event
3276 handler returns. Skip(false) (the default setting) will prevent
3277 additional event handlers from being called and control will be
3278 returned to the sender of the event immediately after the current
3279 handler has finished. Skip(True) will cause the event processing
3280 system to continue searching for a handler function for this event.
3281
3282 """
d55e5bfc
RD
3283 return _core_.Event_Skip(*args, **kwargs)
3284
3285 def GetSkipped(*args, **kwargs):
3286 """GetSkipped(self) -> bool"""
3287 return _core_.Event_GetSkipped(*args, **kwargs)
3288
3289 def ShouldPropagate(*args, **kwargs):
3290 """ShouldPropagate(self) -> bool"""
3291 return _core_.Event_ShouldPropagate(*args, **kwargs)
3292
3293 def StopPropagation(*args, **kwargs):
3294 """StopPropagation(self) -> int"""
3295 return _core_.Event_StopPropagation(*args, **kwargs)
3296
3297 def ResumePropagation(*args, **kwargs):
3298 """ResumePropagation(self, int propagationLevel)"""
3299 return _core_.Event_ResumePropagation(*args, **kwargs)
3300
3301 def Clone(*args, **kwargs):
3302 """Clone(self) -> Event"""
3303 return _core_.Event_Clone(*args, **kwargs)
3304
3305
3306class EventPtr(Event):
3307 def __init__(self, this):
3308 self.this = this
3309 if not hasattr(self,"thisown"): self.thisown = 0
3310 self.__class__ = Event
3311_core_.Event_swigregister(EventPtr)
3312
3313#---------------------------------------------------------------------------
3314
3315class PropagationDisabler(object):
093d3ff1 3316 """Proxy of C++ PropagationDisabler class"""
d55e5bfc
RD
3317 def __repr__(self):
3318 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3319 def __init__(self, *args, **kwargs):
3320 """__init__(self, Event event) -> PropagationDisabler"""
3321 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
3322 self.this = newobj.this
3323 self.thisown = 1
3324 del newobj.thisown
3325 def __del__(self, destroy=_core_.delete_PropagationDisabler):
3326 """__del__(self)"""
3327 try:
3328 if self.thisown: destroy(self)
3329 except: pass
3330
3331
3332class PropagationDisablerPtr(PropagationDisabler):
3333 def __init__(self, this):
3334 self.this = this
3335 if not hasattr(self,"thisown"): self.thisown = 0
3336 self.__class__ = PropagationDisabler
3337_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
3338
3339class PropagateOnce(object):
093d3ff1 3340 """Proxy of C++ PropagateOnce class"""
d55e5bfc
RD
3341 def __repr__(self):
3342 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3343 def __init__(self, *args, **kwargs):
3344 """__init__(self, Event event) -> PropagateOnce"""
3345 newobj = _core_.new_PropagateOnce(*args, **kwargs)
3346 self.this = newobj.this
3347 self.thisown = 1
3348 del newobj.thisown
3349 def __del__(self, destroy=_core_.delete_PropagateOnce):
3350 """__del__(self)"""
3351 try:
3352 if self.thisown: destroy(self)
3353 except: pass
3354
3355
3356class PropagateOncePtr(PropagateOnce):
3357 def __init__(self, this):
3358 self.this = this
3359 if not hasattr(self,"thisown"): self.thisown = 0
3360 self.__class__ = PropagateOnce
3361_core_.PropagateOnce_swigregister(PropagateOncePtr)
3362
3363#---------------------------------------------------------------------------
3364
3365class CommandEvent(Event):
093d3ff1 3366 """Proxy of C++ CommandEvent class"""
d55e5bfc
RD
3367 def __repr__(self):
3368 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3369 def __init__(self, *args, **kwargs):
3370 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
3371 newobj = _core_.new_CommandEvent(*args, **kwargs)
3372 self.this = newobj.this
3373 self.thisown = 1
3374 del newobj.thisown
3375 def GetSelection(*args, **kwargs):
3376 """GetSelection(self) -> int"""
3377 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3378
3379 def SetString(*args, **kwargs):
3380 """SetString(self, String s)"""
3381 return _core_.CommandEvent_SetString(*args, **kwargs)
3382
3383 def GetString(*args, **kwargs):
3384 """GetString(self) -> String"""
3385 return _core_.CommandEvent_GetString(*args, **kwargs)
3386
3387 def IsChecked(*args, **kwargs):
3388 """IsChecked(self) -> bool"""
3389 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3390
3391 Checked = IsChecked
3392 def IsSelection(*args, **kwargs):
3393 """IsSelection(self) -> bool"""
3394 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3395
3396 def SetExtraLong(*args, **kwargs):
3397 """SetExtraLong(self, long extraLong)"""
3398 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3399
3400 def GetExtraLong(*args, **kwargs):
3401 """GetExtraLong(self) -> long"""
3402 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3403
3404 def SetInt(*args, **kwargs):
3405 """SetInt(self, int i)"""
3406 return _core_.CommandEvent_SetInt(*args, **kwargs)
3407
3408 def GetInt(*args, **kwargs):
3409 """GetInt(self) -> long"""
3410 return _core_.CommandEvent_GetInt(*args, **kwargs)
3411
3412 def Clone(*args, **kwargs):
3413 """Clone(self) -> Event"""
3414 return _core_.CommandEvent_Clone(*args, **kwargs)
3415
3416
3417class CommandEventPtr(CommandEvent):
3418 def __init__(self, this):
3419 self.this = this
3420 if not hasattr(self,"thisown"): self.thisown = 0
3421 self.__class__ = CommandEvent
3422_core_.CommandEvent_swigregister(CommandEventPtr)
3423
3424#---------------------------------------------------------------------------
3425
3426class NotifyEvent(CommandEvent):
093d3ff1 3427 """Proxy of C++ NotifyEvent class"""
d55e5bfc
RD
3428 def __repr__(self):
3429 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3430 def __init__(self, *args, **kwargs):
3431 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
3432 newobj = _core_.new_NotifyEvent(*args, **kwargs)
3433 self.this = newobj.this
3434 self.thisown = 1
3435 del newobj.thisown
3436 def Veto(*args, **kwargs):
3437 """Veto(self)"""
3438 return _core_.NotifyEvent_Veto(*args, **kwargs)
3439
3440 def Allow(*args, **kwargs):
3441 """Allow(self)"""
3442 return _core_.NotifyEvent_Allow(*args, **kwargs)
3443
3444 def IsAllowed(*args, **kwargs):
3445 """IsAllowed(self) -> bool"""
3446 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
3447
3448
3449class NotifyEventPtr(NotifyEvent):
3450 def __init__(self, this):
3451 self.this = this
3452 if not hasattr(self,"thisown"): self.thisown = 0
3453 self.__class__ = NotifyEvent
3454_core_.NotifyEvent_swigregister(NotifyEventPtr)
3455
3456#---------------------------------------------------------------------------
3457
3458class ScrollEvent(CommandEvent):
093d3ff1 3459 """Proxy of C++ ScrollEvent class"""
d55e5bfc
RD
3460 def __repr__(self):
3461 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3462 def __init__(self, *args, **kwargs):
3463 """
3464 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
3465 int orient=0) -> ScrollEvent
3466 """
3467 newobj = _core_.new_ScrollEvent(*args, **kwargs)
3468 self.this = newobj.this
3469 self.thisown = 1
3470 del newobj.thisown
3471 def GetOrientation(*args, **kwargs):
3472 """GetOrientation(self) -> int"""
3473 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
3474
3475 def GetPosition(*args, **kwargs):
3476 """GetPosition(self) -> int"""
3477 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
3478
3479 def SetOrientation(*args, **kwargs):
3480 """SetOrientation(self, int orient)"""
3481 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
3482
3483 def SetPosition(*args, **kwargs):
3484 """SetPosition(self, int pos)"""
3485 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
3486
3487
3488class ScrollEventPtr(ScrollEvent):
3489 def __init__(self, this):
3490 self.this = this
3491 if not hasattr(self,"thisown"): self.thisown = 0
3492 self.__class__ = ScrollEvent
3493_core_.ScrollEvent_swigregister(ScrollEventPtr)
3494
3495#---------------------------------------------------------------------------
3496
3497class ScrollWinEvent(Event):
093d3ff1 3498 """Proxy of C++ ScrollWinEvent class"""
d55e5bfc
RD
3499 def __repr__(self):
3500 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3501 def __init__(self, *args, **kwargs):
3502 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
3503 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
3504 self.this = newobj.this
3505 self.thisown = 1
3506 del newobj.thisown
3507 def GetOrientation(*args, **kwargs):
3508 """GetOrientation(self) -> int"""
3509 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
3510
3511 def GetPosition(*args, **kwargs):
3512 """GetPosition(self) -> int"""
3513 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
3514
3515 def SetOrientation(*args, **kwargs):
3516 """SetOrientation(self, int orient)"""
3517 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
3518
3519 def SetPosition(*args, **kwargs):
3520 """SetPosition(self, int pos)"""
3521 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
3522
3523
3524class ScrollWinEventPtr(ScrollWinEvent):
3525 def __init__(self, this):
3526 self.this = this
3527 if not hasattr(self,"thisown"): self.thisown = 0
3528 self.__class__ = ScrollWinEvent
3529_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
3530
3531#---------------------------------------------------------------------------
3532
3533MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3534MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3535MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3536MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3537MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
3538class MouseEvent(Event):
093d3ff1 3539 """Proxy of C++ MouseEvent class"""
d55e5bfc
RD
3540 def __repr__(self):
3541 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3542 def __init__(self, *args, **kwargs):
3543 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
3544 newobj = _core_.new_MouseEvent(*args, **kwargs)
3545 self.this = newobj.this
3546 self.thisown = 1
3547 del newobj.thisown
3548 def IsButton(*args, **kwargs):
3549 """IsButton(self) -> bool"""
3550 return _core_.MouseEvent_IsButton(*args, **kwargs)
3551
3552 def ButtonDown(*args, **kwargs):
3553 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
3554 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
3555
3556 def ButtonDClick(*args, **kwargs):
3557 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
3558 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
3559
3560 def ButtonUp(*args, **kwargs):
3561 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
3562 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
3563
3564 def Button(*args, **kwargs):
3565 """Button(self, int but) -> bool"""
3566 return _core_.MouseEvent_Button(*args, **kwargs)
3567
3568 def ButtonIsDown(*args, **kwargs):
3569 """ButtonIsDown(self, int but) -> bool"""
3570 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
3571
3572 def GetButton(*args, **kwargs):
3573 """GetButton(self) -> int"""
3574 return _core_.MouseEvent_GetButton(*args, **kwargs)
3575
3576 def ControlDown(*args, **kwargs):
3577 """ControlDown(self) -> bool"""
3578 return _core_.MouseEvent_ControlDown(*args, **kwargs)
3579
3580 def MetaDown(*args, **kwargs):
3581 """MetaDown(self) -> bool"""
3582 return _core_.MouseEvent_MetaDown(*args, **kwargs)
3583
3584 def AltDown(*args, **kwargs):
3585 """AltDown(self) -> bool"""
3586 return _core_.MouseEvent_AltDown(*args, **kwargs)
3587
3588 def ShiftDown(*args, **kwargs):
3589 """ShiftDown(self) -> bool"""
3590 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
3591
412d302d
RD
3592 def CmdDown(*args, **kwargs):
3593 """
3594 CmdDown(self) -> bool
3595
3596 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3597 platforms but the special "Apple" (a.k.a as "Command") key on
3598 Macs: it makes often sense to use it instead of, say, `ControlDown`
3599 because Cmd key is used for the same thing under Mac as Ctrl
3600 elsewhere. The Ctrl still exists, it's just not used for this
3601 purpose. So for non-Mac platforms this is the same as `ControlDown`
3602 and Macs this is the same as `MetaDown`.
3603 """
3604 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3605
d55e5bfc
RD
3606 def LeftDown(*args, **kwargs):
3607 """LeftDown(self) -> bool"""
3608 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3609
3610 def MiddleDown(*args, **kwargs):
3611 """MiddleDown(self) -> bool"""
3612 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3613
3614 def RightDown(*args, **kwargs):
3615 """RightDown(self) -> bool"""
3616 return _core_.MouseEvent_RightDown(*args, **kwargs)
3617
3618 def LeftUp(*args, **kwargs):
3619 """LeftUp(self) -> bool"""
3620 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3621
3622 def MiddleUp(*args, **kwargs):
3623 """MiddleUp(self) -> bool"""
3624 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3625
3626 def RightUp(*args, **kwargs):
3627 """RightUp(self) -> bool"""
3628 return _core_.MouseEvent_RightUp(*args, **kwargs)
3629
3630 def LeftDClick(*args, **kwargs):
3631 """LeftDClick(self) -> bool"""
3632 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3633
3634 def MiddleDClick(*args, **kwargs):
3635 """MiddleDClick(self) -> bool"""
3636 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3637
3638 def RightDClick(*args, **kwargs):
3639 """RightDClick(self) -> bool"""
3640 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3641
3642 def LeftIsDown(*args, **kwargs):
3643 """LeftIsDown(self) -> bool"""
3644 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3645
3646 def MiddleIsDown(*args, **kwargs):
3647 """MiddleIsDown(self) -> bool"""
3648 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3649
3650 def RightIsDown(*args, **kwargs):
3651 """RightIsDown(self) -> bool"""
3652 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3653
3654 def Dragging(*args, **kwargs):
3655 """Dragging(self) -> bool"""
3656 return _core_.MouseEvent_Dragging(*args, **kwargs)
3657
3658 def Moving(*args, **kwargs):
3659 """Moving(self) -> bool"""
3660 return _core_.MouseEvent_Moving(*args, **kwargs)
3661
3662 def Entering(*args, **kwargs):
3663 """Entering(self) -> bool"""
3664 return _core_.MouseEvent_Entering(*args, **kwargs)
3665
3666 def Leaving(*args, **kwargs):
3667 """Leaving(self) -> bool"""
3668 return _core_.MouseEvent_Leaving(*args, **kwargs)
3669
3670 def GetPosition(*args, **kwargs):
3671 """
3672 GetPosition(self) -> Point
3673
79fccf9d
RD
3674 Returns the position of the mouse in window coordinates when the event
3675 happened.
d55e5bfc
RD
3676 """
3677 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3678
3679 def GetPositionTuple(*args, **kwargs):
3680 """
3681 GetPositionTuple() -> (x,y)
3682
79fccf9d
RD
3683 Returns the position of the mouse in window coordinates when the event
3684 happened.
d55e5bfc
RD
3685 """
3686 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3687
3688 def GetLogicalPosition(*args, **kwargs):
3689 """GetLogicalPosition(self, DC dc) -> Point"""
3690 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3691
3692 def GetX(*args, **kwargs):
3693 """GetX(self) -> int"""
3694 return _core_.MouseEvent_GetX(*args, **kwargs)
3695
3696 def GetY(*args, **kwargs):
3697 """GetY(self) -> int"""
3698 return _core_.MouseEvent_GetY(*args, **kwargs)
3699
3700 def GetWheelRotation(*args, **kwargs):
3701 """GetWheelRotation(self) -> int"""
3702 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3703
3704 def GetWheelDelta(*args, **kwargs):
3705 """GetWheelDelta(self) -> int"""
3706 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3707
3708 def GetLinesPerAction(*args, **kwargs):
3709 """GetLinesPerAction(self) -> int"""
3710 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3711
3712 def IsPageScroll(*args, **kwargs):
3713 """IsPageScroll(self) -> bool"""
3714 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3715
3716 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3717 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3718 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3719 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3720 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3721 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3722 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3723 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3724 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3725 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3726 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3727 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3728
3729class MouseEventPtr(MouseEvent):
3730 def __init__(self, this):
3731 self.this = this
3732 if not hasattr(self,"thisown"): self.thisown = 0
3733 self.__class__ = MouseEvent
3734_core_.MouseEvent_swigregister(MouseEventPtr)
3735
3736#---------------------------------------------------------------------------
3737
3738class SetCursorEvent(Event):
093d3ff1 3739 """Proxy of C++ SetCursorEvent class"""
d55e5bfc
RD
3740 def __repr__(self):
3741 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3742 def __init__(self, *args, **kwargs):
3743 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3744 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3745 self.this = newobj.this
3746 self.thisown = 1
3747 del newobj.thisown
3748 def GetX(*args, **kwargs):
3749 """GetX(self) -> int"""
3750 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3751
3752 def GetY(*args, **kwargs):
3753 """GetY(self) -> int"""
3754 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3755
3756 def SetCursor(*args, **kwargs):
3757 """SetCursor(self, Cursor cursor)"""
3758 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3759
3760 def GetCursor(*args, **kwargs):
3761 """GetCursor(self) -> Cursor"""
3762 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3763
3764 def HasCursor(*args, **kwargs):
3765 """HasCursor(self) -> bool"""
3766 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3767
3768
3769class SetCursorEventPtr(SetCursorEvent):
3770 def __init__(self, this):
3771 self.this = this
3772 if not hasattr(self,"thisown"): self.thisown = 0
3773 self.__class__ = SetCursorEvent
3774_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3775
3776#---------------------------------------------------------------------------
3777
3778class KeyEvent(Event):
093d3ff1 3779 """Proxy of C++ KeyEvent class"""
d55e5bfc
RD
3780 def __repr__(self):
3781 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3782 def __init__(self, *args, **kwargs):
3783 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3784 newobj = _core_.new_KeyEvent(*args, **kwargs)
3785 self.this = newobj.this
3786 self.thisown = 1
3787 del newobj.thisown
3788 def ControlDown(*args, **kwargs):
3789 """ControlDown(self) -> bool"""
3790 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3791
3792 def MetaDown(*args, **kwargs):
3793 """MetaDown(self) -> bool"""
3794 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3795
3796 def AltDown(*args, **kwargs):
3797 """AltDown(self) -> bool"""
3798 return _core_.KeyEvent_AltDown(*args, **kwargs)
3799
3800 def ShiftDown(*args, **kwargs):
3801 """ShiftDown(self) -> bool"""
3802 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3803
412d302d
RD
3804 def CmdDown(*args, **kwargs):
3805 """
3806 CmdDown(self) -> bool
3807
3808 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3809 platforms but the special "Apple" (a.k.a as "Command") key on
3810 Macs: it makes often sense to use it instead of, say, `ControlDown`
3811 because Cmd key is used for the same thing under Mac as Ctrl
3812 elsewhere. The Ctrl still exists, it's just not used for this
3813 purpose. So for non-Mac platforms this is the same as `ControlDown`
3814 and Macs this is the same as `MetaDown`.
3815 """
3816 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3817
d55e5bfc
RD
3818 def HasModifiers(*args, **kwargs):
3819 """HasModifiers(self) -> bool"""
3820 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3821
3822 def GetKeyCode(*args, **kwargs):
3823 """GetKeyCode(self) -> int"""
3824 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3825
3826 KeyCode = GetKeyCode
19272049
RD
3827 def GetUnicodeKey(*args, **kwargs):
3828 """GetUnicodeKey(self) -> int"""
3829 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 3830
19272049 3831 GetUniChar = GetUnicodeKey
d55e5bfc
RD
3832 def GetRawKeyCode(*args, **kwargs):
3833 """GetRawKeyCode(self) -> unsigned int"""
3834 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3835
3836 def GetRawKeyFlags(*args, **kwargs):
3837 """GetRawKeyFlags(self) -> unsigned int"""
3838 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3839
3840 def GetPosition(*args, **kwargs):
3841 """
3842 GetPosition(self) -> Point
3843
3844 Find the position of the event.
3845 """
3846 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3847
3848 def GetPositionTuple(*args, **kwargs):
3849 """
3850 GetPositionTuple() -> (x,y)
3851
3852 Find the position of the event.
3853 """
3854 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3855
3856 def GetX(*args, **kwargs):
3857 """GetX(self) -> int"""
3858 return _core_.KeyEvent_GetX(*args, **kwargs)
3859
3860 def GetY(*args, **kwargs):
3861 """GetY(self) -> int"""
3862 return _core_.KeyEvent_GetY(*args, **kwargs)
3863
3864 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3865 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3866 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3867 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3868 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3869 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3870 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3871 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3872 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3873 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3874
3875class KeyEventPtr(KeyEvent):
3876 def __init__(self, this):
3877 self.this = this
3878 if not hasattr(self,"thisown"): self.thisown = 0
3879 self.__class__ = KeyEvent
3880_core_.KeyEvent_swigregister(KeyEventPtr)
3881
3882#---------------------------------------------------------------------------
3883
3884class SizeEvent(Event):
093d3ff1 3885 """Proxy of C++ SizeEvent class"""
d55e5bfc
RD
3886 def __repr__(self):
3887 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3888 def __init__(self, *args, **kwargs):
3889 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3890 newobj = _core_.new_SizeEvent(*args, **kwargs)
3891 self.this = newobj.this
3892 self.thisown = 1
3893 del newobj.thisown
3894 def GetSize(*args, **kwargs):
3895 """GetSize(self) -> Size"""
3896 return _core_.SizeEvent_GetSize(*args, **kwargs)
3897
3898 def GetRect(*args, **kwargs):
3899 """GetRect(self) -> Rect"""
3900 return _core_.SizeEvent_GetRect(*args, **kwargs)
3901
3902 def SetRect(*args, **kwargs):
3903 """SetRect(self, Rect rect)"""
3904 return _core_.SizeEvent_SetRect(*args, **kwargs)
3905
3906 def SetSize(*args, **kwargs):
3907 """SetSize(self, Size size)"""
3908 return _core_.SizeEvent_SetSize(*args, **kwargs)
3909
3910 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3911 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
3912
3913class SizeEventPtr(SizeEvent):
3914 def __init__(self, this):
3915 self.this = this
3916 if not hasattr(self,"thisown"): self.thisown = 0
3917 self.__class__ = SizeEvent
3918_core_.SizeEvent_swigregister(SizeEventPtr)
3919
3920#---------------------------------------------------------------------------
3921
3922class MoveEvent(Event):
093d3ff1 3923 """Proxy of C++ MoveEvent class"""
d55e5bfc
RD
3924 def __repr__(self):
3925 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3926 def __init__(self, *args, **kwargs):
3927 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
3928 newobj = _core_.new_MoveEvent(*args, **kwargs)
3929 self.this = newobj.this
3930 self.thisown = 1
3931 del newobj.thisown
3932 def GetPosition(*args, **kwargs):
3933 """GetPosition(self) -> Point"""
3934 return _core_.MoveEvent_GetPosition(*args, **kwargs)
3935
3936 def GetRect(*args, **kwargs):
3937 """GetRect(self) -> Rect"""
3938 return _core_.MoveEvent_GetRect(*args, **kwargs)
3939
3940 def SetRect(*args, **kwargs):
3941 """SetRect(self, Rect rect)"""
3942 return _core_.MoveEvent_SetRect(*args, **kwargs)
3943
3944 def SetPosition(*args, **kwargs):
3945 """SetPosition(self, Point pos)"""
3946 return _core_.MoveEvent_SetPosition(*args, **kwargs)
3947
fef4c27a
RD
3948 m_pos = property(GetPosition, SetPosition)
3949 m_rect = property(GetRect, SetRect)
3950
d55e5bfc
RD
3951
3952class MoveEventPtr(MoveEvent):
3953 def __init__(self, this):
3954 self.this = this
3955 if not hasattr(self,"thisown"): self.thisown = 0
3956 self.__class__ = MoveEvent
3957_core_.MoveEvent_swigregister(MoveEventPtr)
3958
3959#---------------------------------------------------------------------------
3960
3961class PaintEvent(Event):
093d3ff1 3962 """Proxy of C++ PaintEvent class"""
d55e5bfc
RD
3963 def __repr__(self):
3964 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3965 def __init__(self, *args, **kwargs):
3966 """__init__(self, int Id=0) -> PaintEvent"""
3967 newobj = _core_.new_PaintEvent(*args, **kwargs)
3968 self.this = newobj.this
3969 self.thisown = 1
3970 del newobj.thisown
3971
3972class PaintEventPtr(PaintEvent):
3973 def __init__(self, this):
3974 self.this = this
3975 if not hasattr(self,"thisown"): self.thisown = 0
3976 self.__class__ = PaintEvent
3977_core_.PaintEvent_swigregister(PaintEventPtr)
3978
3979class NcPaintEvent(Event):
093d3ff1 3980 """Proxy of C++ NcPaintEvent class"""
d55e5bfc
RD
3981 def __repr__(self):
3982 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3983 def __init__(self, *args, **kwargs):
3984 """__init__(self, int winid=0) -> NcPaintEvent"""
3985 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
3986 self.this = newobj.this
3987 self.thisown = 1
3988 del newobj.thisown
3989
3990class NcPaintEventPtr(NcPaintEvent):
3991 def __init__(self, this):
3992 self.this = this
3993 if not hasattr(self,"thisown"): self.thisown = 0
3994 self.__class__ = NcPaintEvent
3995_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
3996
3997#---------------------------------------------------------------------------
3998
3999class EraseEvent(Event):
093d3ff1 4000 """Proxy of C++ EraseEvent class"""
d55e5bfc
RD
4001 def __repr__(self):
4002 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4003 def __init__(self, *args, **kwargs):
4004 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
4005 newobj = _core_.new_EraseEvent(*args, **kwargs)
4006 self.this = newobj.this
4007 self.thisown = 1
4008 del newobj.thisown
4009 def GetDC(*args, **kwargs):
4010 """GetDC(self) -> DC"""
4011 return _core_.EraseEvent_GetDC(*args, **kwargs)
4012
4013
4014class EraseEventPtr(EraseEvent):
4015 def __init__(self, this):
4016 self.this = this
4017 if not hasattr(self,"thisown"): self.thisown = 0
4018 self.__class__ = EraseEvent
4019_core_.EraseEvent_swigregister(EraseEventPtr)
4020
4021#---------------------------------------------------------------------------
4022
4023class FocusEvent(Event):
093d3ff1 4024 """Proxy of C++ FocusEvent class"""
d55e5bfc
RD
4025 def __repr__(self):
4026 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4027 def __init__(self, *args, **kwargs):
4028 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
4029 newobj = _core_.new_FocusEvent(*args, **kwargs)
4030 self.this = newobj.this
4031 self.thisown = 1
4032 del newobj.thisown
4033 def GetWindow(*args, **kwargs):
4034 """GetWindow(self) -> Window"""
4035 return _core_.FocusEvent_GetWindow(*args, **kwargs)
4036
4037 def SetWindow(*args, **kwargs):
4038 """SetWindow(self, Window win)"""
4039 return _core_.FocusEvent_SetWindow(*args, **kwargs)
4040
4041
4042class FocusEventPtr(FocusEvent):
4043 def __init__(self, this):
4044 self.this = this
4045 if not hasattr(self,"thisown"): self.thisown = 0
4046 self.__class__ = FocusEvent
4047_core_.FocusEvent_swigregister(FocusEventPtr)
4048
4049#---------------------------------------------------------------------------
4050
4051class ChildFocusEvent(CommandEvent):
093d3ff1 4052 """Proxy of C++ ChildFocusEvent class"""
d55e5bfc
RD
4053 def __repr__(self):
4054 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4055 def __init__(self, *args, **kwargs):
4056 """__init__(self, Window win=None) -> ChildFocusEvent"""
4057 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
4058 self.this = newobj.this
4059 self.thisown = 1
4060 del newobj.thisown
4061 def GetWindow(*args, **kwargs):
4062 """GetWindow(self) -> Window"""
4063 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
4064
4065
4066class ChildFocusEventPtr(ChildFocusEvent):
4067 def __init__(self, this):
4068 self.this = this
4069 if not hasattr(self,"thisown"): self.thisown = 0
4070 self.__class__ = ChildFocusEvent
4071_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
4072
4073#---------------------------------------------------------------------------
4074
4075class ActivateEvent(Event):
093d3ff1 4076 """Proxy of C++ ActivateEvent class"""
d55e5bfc
RD
4077 def __repr__(self):
4078 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4079 def __init__(self, *args, **kwargs):
4080 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
4081 newobj = _core_.new_ActivateEvent(*args, **kwargs)
4082 self.this = newobj.this
4083 self.thisown = 1
4084 del newobj.thisown
4085 def GetActive(*args, **kwargs):
4086 """GetActive(self) -> bool"""
4087 return _core_.ActivateEvent_GetActive(*args, **kwargs)
4088
4089
4090class ActivateEventPtr(ActivateEvent):
4091 def __init__(self, this):
4092 self.this = this
4093 if not hasattr(self,"thisown"): self.thisown = 0
4094 self.__class__ = ActivateEvent
4095_core_.ActivateEvent_swigregister(ActivateEventPtr)
4096
4097#---------------------------------------------------------------------------
4098
4099class InitDialogEvent(Event):
093d3ff1 4100 """Proxy of C++ InitDialogEvent class"""
d55e5bfc
RD
4101 def __repr__(self):
4102 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4103 def __init__(self, *args, **kwargs):
4104 """__init__(self, int Id=0) -> InitDialogEvent"""
4105 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
4106 self.this = newobj.this
4107 self.thisown = 1
4108 del newobj.thisown
4109
4110class InitDialogEventPtr(InitDialogEvent):
4111 def __init__(self, this):
4112 self.this = this
4113 if not hasattr(self,"thisown"): self.thisown = 0
4114 self.__class__ = InitDialogEvent
4115_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
4116
4117#---------------------------------------------------------------------------
4118
4119class MenuEvent(Event):
093d3ff1 4120 """Proxy of C++ MenuEvent class"""
d55e5bfc
RD
4121 def __repr__(self):
4122 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4123 def __init__(self, *args, **kwargs):
4124 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
4125 newobj = _core_.new_MenuEvent(*args, **kwargs)
4126 self.this = newobj.this
4127 self.thisown = 1
4128 del newobj.thisown
4129 def GetMenuId(*args, **kwargs):
4130 """GetMenuId(self) -> int"""
4131 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
4132
4133 def IsPopup(*args, **kwargs):
4134 """IsPopup(self) -> bool"""
4135 return _core_.MenuEvent_IsPopup(*args, **kwargs)
4136
4137 def GetMenu(*args, **kwargs):
4138 """GetMenu(self) -> Menu"""
4139 return _core_.MenuEvent_GetMenu(*args, **kwargs)
4140
4141
4142class MenuEventPtr(MenuEvent):
4143 def __init__(self, this):
4144 self.this = this
4145 if not hasattr(self,"thisown"): self.thisown = 0
4146 self.__class__ = MenuEvent
4147_core_.MenuEvent_swigregister(MenuEventPtr)
4148
4149#---------------------------------------------------------------------------
4150
4151class CloseEvent(Event):
093d3ff1 4152 """Proxy of C++ CloseEvent class"""
d55e5bfc
RD
4153 def __repr__(self):
4154 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4155 def __init__(self, *args, **kwargs):
4156 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
4157 newobj = _core_.new_CloseEvent(*args, **kwargs)
4158 self.this = newobj.this
4159 self.thisown = 1
4160 del newobj.thisown
4161 def SetLoggingOff(*args, **kwargs):
4162 """SetLoggingOff(self, bool logOff)"""
4163 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
4164
4165 def GetLoggingOff(*args, **kwargs):
4166 """GetLoggingOff(self) -> bool"""
4167 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
4168
4169 def Veto(*args, **kwargs):
4170 """Veto(self, bool veto=True)"""
4171 return _core_.CloseEvent_Veto(*args, **kwargs)
4172
4173 def SetCanVeto(*args, **kwargs):
4174 """SetCanVeto(self, bool canVeto)"""
4175 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
4176
4177 def CanVeto(*args, **kwargs):
4178 """CanVeto(self) -> bool"""
4179 return _core_.CloseEvent_CanVeto(*args, **kwargs)
4180
4181 def GetVeto(*args, **kwargs):
4182 """GetVeto(self) -> bool"""
4183 return _core_.CloseEvent_GetVeto(*args, **kwargs)
4184
4185
4186class CloseEventPtr(CloseEvent):
4187 def __init__(self, this):
4188 self.this = this
4189 if not hasattr(self,"thisown"): self.thisown = 0
4190 self.__class__ = CloseEvent
4191_core_.CloseEvent_swigregister(CloseEventPtr)
4192
4193#---------------------------------------------------------------------------
4194
4195class ShowEvent(Event):
093d3ff1 4196 """Proxy of C++ ShowEvent class"""
d55e5bfc
RD
4197 def __repr__(self):
4198 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4199 def __init__(self, *args, **kwargs):
4200 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
4201 newobj = _core_.new_ShowEvent(*args, **kwargs)
4202 self.this = newobj.this
4203 self.thisown = 1
4204 del newobj.thisown
4205 def SetShow(*args, **kwargs):
4206 """SetShow(self, bool show)"""
4207 return _core_.ShowEvent_SetShow(*args, **kwargs)
4208
4209 def GetShow(*args, **kwargs):
4210 """GetShow(self) -> bool"""
4211 return _core_.ShowEvent_GetShow(*args, **kwargs)
4212
4213
4214class ShowEventPtr(ShowEvent):
4215 def __init__(self, this):
4216 self.this = this
4217 if not hasattr(self,"thisown"): self.thisown = 0
4218 self.__class__ = ShowEvent
4219_core_.ShowEvent_swigregister(ShowEventPtr)
4220
4221#---------------------------------------------------------------------------
4222
4223class IconizeEvent(Event):
093d3ff1 4224 """Proxy of C++ IconizeEvent class"""
d55e5bfc
RD
4225 def __repr__(self):
4226 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4227 def __init__(self, *args, **kwargs):
4228 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
4229 newobj = _core_.new_IconizeEvent(*args, **kwargs)
4230 self.this = newobj.this
4231 self.thisown = 1
4232 del newobj.thisown
4233 def Iconized(*args, **kwargs):
4234 """Iconized(self) -> bool"""
4235 return _core_.IconizeEvent_Iconized(*args, **kwargs)
4236
4237
4238class IconizeEventPtr(IconizeEvent):
4239 def __init__(self, this):
4240 self.this = this
4241 if not hasattr(self,"thisown"): self.thisown = 0
4242 self.__class__ = IconizeEvent
4243_core_.IconizeEvent_swigregister(IconizeEventPtr)
4244
4245#---------------------------------------------------------------------------
4246
4247class MaximizeEvent(Event):
093d3ff1 4248 """Proxy of C++ MaximizeEvent class"""
d55e5bfc
RD
4249 def __repr__(self):
4250 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4251 def __init__(self, *args, **kwargs):
4252 """__init__(self, int id=0) -> MaximizeEvent"""
4253 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
4254 self.this = newobj.this
4255 self.thisown = 1
4256 del newobj.thisown
4257
4258class MaximizeEventPtr(MaximizeEvent):
4259 def __init__(self, this):
4260 self.this = this
4261 if not hasattr(self,"thisown"): self.thisown = 0
4262 self.__class__ = MaximizeEvent
4263_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4264
4265#---------------------------------------------------------------------------
4266
4267class DropFilesEvent(Event):
093d3ff1 4268 """Proxy of C++ DropFilesEvent class"""
d55e5bfc
RD
4269 def __init__(self): raise RuntimeError, "No constructor defined"
4270 def __repr__(self):
4271 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4272 def GetPosition(*args, **kwargs):
4273 """GetPosition(self) -> Point"""
4274 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4275
4276 def GetNumberOfFiles(*args, **kwargs):
4277 """GetNumberOfFiles(self) -> int"""
4278 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4279
4280 def GetFiles(*args, **kwargs):
4281 """GetFiles(self) -> PyObject"""
4282 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4283
4284
4285class DropFilesEventPtr(DropFilesEvent):
4286 def __init__(self, this):
4287 self.this = this
4288 if not hasattr(self,"thisown"): self.thisown = 0
4289 self.__class__ = DropFilesEvent
4290_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4291
4292#---------------------------------------------------------------------------
4293
4294UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4295UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4296class UpdateUIEvent(CommandEvent):
093d3ff1 4297 """Proxy of C++ UpdateUIEvent class"""
d55e5bfc
RD
4298 def __repr__(self):
4299 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4300 def __init__(self, *args, **kwargs):
4301 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4302 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4303 self.this = newobj.this
4304 self.thisown = 1
4305 del newobj.thisown
4306 def GetChecked(*args, **kwargs):
4307 """GetChecked(self) -> bool"""
4308 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4309
4310 def GetEnabled(*args, **kwargs):
4311 """GetEnabled(self) -> bool"""
4312 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4313
4314 def GetText(*args, **kwargs):
4315 """GetText(self) -> String"""
4316 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4317
4318 def GetSetText(*args, **kwargs):
4319 """GetSetText(self) -> bool"""
4320 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4321
4322 def GetSetChecked(*args, **kwargs):
4323 """GetSetChecked(self) -> bool"""
4324 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4325
4326 def GetSetEnabled(*args, **kwargs):
4327 """GetSetEnabled(self) -> bool"""
4328 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4329
4330 def Check(*args, **kwargs):
4331 """Check(self, bool check)"""
4332 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4333
4334 def Enable(*args, **kwargs):
4335 """Enable(self, bool enable)"""
4336 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4337
4338 def SetText(*args, **kwargs):
4339 """SetText(self, String text)"""
4340 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4341
4342 def SetUpdateInterval(*args, **kwargs):
c24da6d6 4343 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD
4344 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4345
4346 SetUpdateInterval = staticmethod(SetUpdateInterval)
4347 def GetUpdateInterval(*args, **kwargs):
c24da6d6 4348 """GetUpdateInterval() -> long"""
d55e5bfc
RD
4349 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4350
4351 GetUpdateInterval = staticmethod(GetUpdateInterval)
4352 def CanUpdate(*args, **kwargs):
c24da6d6 4353 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD
4354 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4355
4356 CanUpdate = staticmethod(CanUpdate)
4357 def ResetUpdateTime(*args, **kwargs):
c24da6d6 4358 """ResetUpdateTime()"""
d55e5bfc
RD
4359 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4360
4361 ResetUpdateTime = staticmethod(ResetUpdateTime)
4362 def SetMode(*args, **kwargs):
c24da6d6 4363 """SetMode(int mode)"""
d55e5bfc
RD
4364 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4365
4366 SetMode = staticmethod(SetMode)
4367 def GetMode(*args, **kwargs):
c24da6d6 4368 """GetMode() -> int"""
d55e5bfc
RD
4369 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4370
4371 GetMode = staticmethod(GetMode)
4372
4373class UpdateUIEventPtr(UpdateUIEvent):
4374 def __init__(self, this):
4375 self.this = this
4376 if not hasattr(self,"thisown"): self.thisown = 0
4377 self.__class__ = UpdateUIEvent
4378_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4379
4380def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4381 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4382 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4383
4384def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4385 """UpdateUIEvent_GetUpdateInterval() -> long"""
4386 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4387
4388def UpdateUIEvent_CanUpdate(*args, **kwargs):
4389 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4390 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4391
4392def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4393 """UpdateUIEvent_ResetUpdateTime()"""
4394 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4395
4396def UpdateUIEvent_SetMode(*args, **kwargs):
4397 """UpdateUIEvent_SetMode(int mode)"""
4398 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4399
4400def UpdateUIEvent_GetMode(*args, **kwargs):
4401 """UpdateUIEvent_GetMode() -> int"""
4402 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4403
4404#---------------------------------------------------------------------------
4405
4406class SysColourChangedEvent(Event):
093d3ff1 4407 """Proxy of C++ SysColourChangedEvent class"""
d55e5bfc
RD
4408 def __repr__(self):
4409 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4410 def __init__(self, *args, **kwargs):
4411 """__init__(self) -> SysColourChangedEvent"""
4412 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4413 self.this = newobj.this
4414 self.thisown = 1
4415 del newobj.thisown
4416
4417class SysColourChangedEventPtr(SysColourChangedEvent):
4418 def __init__(self, this):
4419 self.this = this
4420 if not hasattr(self,"thisown"): self.thisown = 0
4421 self.__class__ = SysColourChangedEvent
4422_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4423
4424#---------------------------------------------------------------------------
4425
4426class MouseCaptureChangedEvent(Event):
093d3ff1 4427 """Proxy of C++ MouseCaptureChangedEvent class"""
d55e5bfc
RD
4428 def __repr__(self):
4429 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4430 def __init__(self, *args, **kwargs):
4431 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4432 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4433 self.this = newobj.this
4434 self.thisown = 1
4435 del newobj.thisown
4436 def GetCapturedWindow(*args, **kwargs):
4437 """GetCapturedWindow(self) -> Window"""
4438 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4439
4440
4441class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4442 def __init__(self, this):
4443 self.this = this
4444 if not hasattr(self,"thisown"): self.thisown = 0
4445 self.__class__ = MouseCaptureChangedEvent
4446_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4447
4448#---------------------------------------------------------------------------
4449
4450class DisplayChangedEvent(Event):
093d3ff1 4451 """Proxy of C++ DisplayChangedEvent class"""
d55e5bfc
RD
4452 def __repr__(self):
4453 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4454 def __init__(self, *args, **kwargs):
4455 """__init__(self) -> DisplayChangedEvent"""
4456 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4457 self.this = newobj.this
4458 self.thisown = 1
4459 del newobj.thisown
4460
4461class DisplayChangedEventPtr(DisplayChangedEvent):
4462 def __init__(self, this):
4463 self.this = this
4464 if not hasattr(self,"thisown"): self.thisown = 0
4465 self.__class__ = DisplayChangedEvent
4466_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4467
4468#---------------------------------------------------------------------------
4469
4470class PaletteChangedEvent(Event):
093d3ff1 4471 """Proxy of C++ PaletteChangedEvent class"""
d55e5bfc
RD
4472 def __repr__(self):
4473 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4474 def __init__(self, *args, **kwargs):
4475 """__init__(self, int id=0) -> PaletteChangedEvent"""
4476 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4477 self.this = newobj.this
4478 self.thisown = 1
4479 del newobj.thisown
4480 def SetChangedWindow(*args, **kwargs):
4481 """SetChangedWindow(self, Window win)"""
4482 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4483
4484 def GetChangedWindow(*args, **kwargs):
4485 """GetChangedWindow(self) -> Window"""
4486 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4487
4488
4489class PaletteChangedEventPtr(PaletteChangedEvent):
4490 def __init__(self, this):
4491 self.this = this
4492 if not hasattr(self,"thisown"): self.thisown = 0
4493 self.__class__ = PaletteChangedEvent
4494_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4495
4496#---------------------------------------------------------------------------
4497
4498class QueryNewPaletteEvent(Event):
093d3ff1 4499 """Proxy of C++ QueryNewPaletteEvent class"""
d55e5bfc
RD
4500 def __repr__(self):
4501 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4502 def __init__(self, *args, **kwargs):
4503 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4504 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4505 self.this = newobj.this
4506 self.thisown = 1
4507 del newobj.thisown
4508 def SetPaletteRealized(*args, **kwargs):
4509 """SetPaletteRealized(self, bool realized)"""
4510 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4511
4512 def GetPaletteRealized(*args, **kwargs):
4513 """GetPaletteRealized(self) -> bool"""
4514 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4515
4516
4517class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4518 def __init__(self, this):
4519 self.this = this
4520 if not hasattr(self,"thisown"): self.thisown = 0
4521 self.__class__ = QueryNewPaletteEvent
4522_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4523
4524#---------------------------------------------------------------------------
4525
4526class NavigationKeyEvent(Event):
093d3ff1 4527 """Proxy of C++ NavigationKeyEvent class"""
d55e5bfc
RD
4528 def __repr__(self):
4529 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4530 def __init__(self, *args, **kwargs):
4531 """__init__(self) -> NavigationKeyEvent"""
4532 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4533 self.this = newobj.this
4534 self.thisown = 1
4535 del newobj.thisown
4536 def GetDirection(*args, **kwargs):
4537 """GetDirection(self) -> bool"""
4538 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4539
4540 def SetDirection(*args, **kwargs):
908b74cd 4541 """SetDirection(self, bool forward)"""
d55e5bfc
RD
4542 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4543
4544 def IsWindowChange(*args, **kwargs):
4545 """IsWindowChange(self) -> bool"""
4546 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4547
4548 def SetWindowChange(*args, **kwargs):
908b74cd 4549 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD
4550 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4551
908b74cd
RD
4552 def SetFlags(*args, **kwargs):
4553 """SetFlags(self, long flags)"""
4554 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4555
d55e5bfc
RD
4556 def GetCurrentFocus(*args, **kwargs):
4557 """GetCurrentFocus(self) -> Window"""
4558 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4559
4560 def SetCurrentFocus(*args, **kwargs):
4561 """SetCurrentFocus(self, Window win)"""
4562 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4563
b0f7404b 4564 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4565 IsForward = _core_.NavigationKeyEvent_IsForward
4566 WinChange = _core_.NavigationKeyEvent_WinChange
d55e5bfc
RD
4567
4568class NavigationKeyEventPtr(NavigationKeyEvent):
4569 def __init__(self, this):
4570 self.this = this
4571 if not hasattr(self,"thisown"): self.thisown = 0
4572 self.__class__ = NavigationKeyEvent
4573_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4574
4575#---------------------------------------------------------------------------
4576
4577class WindowCreateEvent(CommandEvent):
093d3ff1 4578 """Proxy of C++ WindowCreateEvent class"""
d55e5bfc
RD
4579 def __repr__(self):
4580 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4581 def __init__(self, *args, **kwargs):
4582 """__init__(self, Window win=None) -> WindowCreateEvent"""
4583 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4584 self.this = newobj.this
4585 self.thisown = 1
4586 del newobj.thisown
4587 def GetWindow(*args, **kwargs):
4588 """GetWindow(self) -> Window"""
4589 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4590
4591
4592class WindowCreateEventPtr(WindowCreateEvent):
4593 def __init__(self, this):
4594 self.this = this
4595 if not hasattr(self,"thisown"): self.thisown = 0
4596 self.__class__ = WindowCreateEvent
4597_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4598
4599class WindowDestroyEvent(CommandEvent):
093d3ff1 4600 """Proxy of C++ WindowDestroyEvent class"""
d55e5bfc
RD
4601 def __repr__(self):
4602 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4603 def __init__(self, *args, **kwargs):
4604 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4605 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4606 self.this = newobj.this
4607 self.thisown = 1
4608 del newobj.thisown
4609 def GetWindow(*args, **kwargs):
4610 """GetWindow(self) -> Window"""
4611 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4612
4613
4614class WindowDestroyEventPtr(WindowDestroyEvent):
4615 def __init__(self, this):
4616 self.this = this
4617 if not hasattr(self,"thisown"): self.thisown = 0
4618 self.__class__ = WindowDestroyEvent
4619_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4620
4621#---------------------------------------------------------------------------
4622
4623class ContextMenuEvent(CommandEvent):
093d3ff1 4624 """Proxy of C++ ContextMenuEvent class"""
d55e5bfc
RD
4625 def __repr__(self):
4626 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4627 def __init__(self, *args, **kwargs):
4628 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4629 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4630 self.this = newobj.this
4631 self.thisown = 1
4632 del newobj.thisown
4633 def GetPosition(*args, **kwargs):
4634 """GetPosition(self) -> Point"""
4635 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4636
4637 def SetPosition(*args, **kwargs):
4638 """SetPosition(self, Point pos)"""
4639 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4640
4641
4642class ContextMenuEventPtr(ContextMenuEvent):
4643 def __init__(self, this):
4644 self.this = this
4645 if not hasattr(self,"thisown"): self.thisown = 0
4646 self.__class__ = ContextMenuEvent
4647_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4648
4649#---------------------------------------------------------------------------
4650
4651IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4652IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4653class IdleEvent(Event):
093d3ff1 4654 """Proxy of C++ IdleEvent class"""
d55e5bfc
RD
4655 def __repr__(self):
4656 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4657 def __init__(self, *args, **kwargs):
4658 """__init__(self) -> IdleEvent"""
4659 newobj = _core_.new_IdleEvent(*args, **kwargs)
4660 self.this = newobj.this
4661 self.thisown = 1
4662 del newobj.thisown
4663 def RequestMore(*args, **kwargs):
4664 """RequestMore(self, bool needMore=True)"""
4665 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4666
4667 def MoreRequested(*args, **kwargs):
4668 """MoreRequested(self) -> bool"""
4669 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4670
4671 def SetMode(*args, **kwargs):
c24da6d6 4672 """SetMode(int mode)"""
d55e5bfc
RD
4673 return _core_.IdleEvent_SetMode(*args, **kwargs)
4674
4675 SetMode = staticmethod(SetMode)
4676 def GetMode(*args, **kwargs):
c24da6d6 4677 """GetMode() -> int"""
d55e5bfc
RD
4678 return _core_.IdleEvent_GetMode(*args, **kwargs)
4679
4680 GetMode = staticmethod(GetMode)
4681 def CanSend(*args, **kwargs):
c24da6d6 4682 """CanSend(Window win) -> bool"""
d55e5bfc
RD
4683 return _core_.IdleEvent_CanSend(*args, **kwargs)
4684
4685 CanSend = staticmethod(CanSend)
4686
4687class IdleEventPtr(IdleEvent):
4688 def __init__(self, this):
4689 self.this = this
4690 if not hasattr(self,"thisown"): self.thisown = 0
4691 self.__class__ = IdleEvent
4692_core_.IdleEvent_swigregister(IdleEventPtr)
4693
4694def IdleEvent_SetMode(*args, **kwargs):
4695 """IdleEvent_SetMode(int mode)"""
4696 return _core_.IdleEvent_SetMode(*args, **kwargs)
4697
4698def IdleEvent_GetMode(*args, **kwargs):
4699 """IdleEvent_GetMode() -> int"""
4700 return _core_.IdleEvent_GetMode(*args, **kwargs)
4701
4702def IdleEvent_CanSend(*args, **kwargs):
4703 """IdleEvent_CanSend(Window win) -> bool"""
4704 return _core_.IdleEvent_CanSend(*args, **kwargs)
4705
4706#---------------------------------------------------------------------------
4707
4708class PyEvent(Event):
093d3ff1 4709 """Proxy of C++ PyEvent class"""
d55e5bfc
RD
4710 def __repr__(self):
4711 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4712 def __init__(self, *args, **kwargs):
4713 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4714 newobj = _core_.new_PyEvent(*args, **kwargs)
4715 self.this = newobj.this
4716 self.thisown = 1
4717 del newobj.thisown
4718 self.SetSelf(self)
4719
4720 def __del__(self, destroy=_core_.delete_PyEvent):
4721 """__del__(self)"""
4722 try:
4723 if self.thisown: destroy(self)
4724 except: pass
4725
4726 def SetSelf(*args, **kwargs):
4727 """SetSelf(self, PyObject self)"""
4728 return _core_.PyEvent_SetSelf(*args, **kwargs)
4729
4730 def GetSelf(*args, **kwargs):
4731 """GetSelf(self) -> PyObject"""
4732 return _core_.PyEvent_GetSelf(*args, **kwargs)
4733
4734
4735class PyEventPtr(PyEvent):
4736 def __init__(self, this):
4737 self.this = this
4738 if not hasattr(self,"thisown"): self.thisown = 0
4739 self.__class__ = PyEvent
4740_core_.PyEvent_swigregister(PyEventPtr)
4741
4742class PyCommandEvent(CommandEvent):
093d3ff1 4743 """Proxy of C++ PyCommandEvent class"""
d55e5bfc
RD
4744 def __repr__(self):
4745 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4746 def __init__(self, *args, **kwargs):
4747 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4748 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4749 self.this = newobj.this
4750 self.thisown = 1
4751 del newobj.thisown
4752 self.SetSelf(self)
4753
4754 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4755 """__del__(self)"""
4756 try:
4757 if self.thisown: destroy(self)
4758 except: pass
4759
4760 def SetSelf(*args, **kwargs):
4761 """SetSelf(self, PyObject self)"""
4762 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4763
4764 def GetSelf(*args, **kwargs):
4765 """GetSelf(self) -> PyObject"""
4766 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4767
4768
4769class PyCommandEventPtr(PyCommandEvent):
4770 def __init__(self, this):
4771 self.this = this
4772 if not hasattr(self,"thisown"): self.thisown = 0
4773 self.__class__ = PyCommandEvent
4774_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4775
4776#---------------------------------------------------------------------------
4777
4778PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4779PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4780PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4781PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4782PRINT_WINDOWS = _core_.PRINT_WINDOWS
4783PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4784class PyApp(EvtHandler):
c24da6d6
RD
4785 """
4786 The ``wx.PyApp`` class is an *implementation detail*, please use the
4787 `wx.App` class (or some other derived class) instead.
4788 """
d55e5bfc
RD
4789 def __repr__(self):
4790 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4791 def __init__(self, *args, **kwargs):
4792 """
4793 __init__(self) -> PyApp
4794
4795 Create a new application object, starting the bootstrap process.
4796 """
4797 newobj = _core_.new_PyApp(*args, **kwargs)
4798 self.this = newobj.this
4799 self.thisown = 1
4800 del newobj.thisown
4801 self._setCallbackInfo(self, PyApp)
4802 self._setOORInfo(self)
4803
4804 def __del__(self, destroy=_core_.delete_PyApp):
4805 """__del__(self)"""
4806 try:
4807 if self.thisown: destroy(self)
4808 except: pass
4809
4810 def _setCallbackInfo(*args, **kwargs):
4811 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4812 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4813
4814 def GetAppName(*args, **kwargs):
4815 """
4816 GetAppName(self) -> String
4817
4818 Get the application name.
4819 """
4820 return _core_.PyApp_GetAppName(*args, **kwargs)
4821
4822 def SetAppName(*args, **kwargs):
4823 """
4824 SetAppName(self, String name)
4825
c24da6d6
RD
4826 Set the application name. This value may be used automatically by
4827 `wx.Config` and such.
d55e5bfc
RD
4828 """
4829 return _core_.PyApp_SetAppName(*args, **kwargs)
4830
4831 def GetClassName(*args, **kwargs):
4832 """
4833 GetClassName(self) -> String
4834
4835 Get the application's class name.
4836 """
4837 return _core_.PyApp_GetClassName(*args, **kwargs)
4838
4839 def SetClassName(*args, **kwargs):
4840 """
4841 SetClassName(self, String name)
4842
c24da6d6
RD
4843 Set the application's class name. This value may be used for
4844 X-resources if applicable for the platform
d55e5bfc
RD
4845 """
4846 return _core_.PyApp_SetClassName(*args, **kwargs)
4847
4848 def GetVendorName(*args, **kwargs):
4849 """
4850 GetVendorName(self) -> String
4851
4852 Get the application's vendor name.
4853 """
4854 return _core_.PyApp_GetVendorName(*args, **kwargs)
4855
4856 def SetVendorName(*args, **kwargs):
4857 """
4858 SetVendorName(self, String name)
4859
c24da6d6
RD
4860 Set the application's vendor name. This value may be used
4861 automatically by `wx.Config` and such.
d55e5bfc
RD
4862 """
4863 return _core_.PyApp_SetVendorName(*args, **kwargs)
4864
4865 def GetTraits(*args, **kwargs):
4866 """
4867 GetTraits(self) -> wxAppTraits
4868
c24da6d6
RD
4869 Return (and create if necessary) the app traits object to which we
4870 delegate for everything which either should be configurable by the
4871 user (then he can change the default behaviour simply by overriding
4872 CreateTraits() and returning his own traits object) or which is
4873 GUI/console dependent as then wx.AppTraits allows us to abstract the
4874 differences behind the common facade.
4875
4876 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
4877 """
4878 return _core_.PyApp_GetTraits(*args, **kwargs)
4879
4880 def ProcessPendingEvents(*args, **kwargs):
4881 """
4882 ProcessPendingEvents(self)
4883
c24da6d6
RD
4884 Process all events in the Pending Events list -- it is necessary to
4885 call this function to process posted events. This normally happens
4886 during each event loop iteration.
d55e5bfc
RD
4887 """
4888 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
4889
4890 def Yield(*args, **kwargs):
4891 """
4892 Yield(self, bool onlyIfNeeded=False) -> bool
4893
c24da6d6
RD
4894 Process all currently pending events right now, instead of waiting
4895 until return to the event loop. It is an error to call ``Yield``
4896 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 4897
c24da6d6 4898 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD
4899 reentrancies (i.e. when called from an event handler it may
4900 result in calling the same event handler again), use with
4901 extreme care or, better, don't use at all!
d55e5bfc 4902
c24da6d6 4903 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 4904
d55e5bfc
RD
4905 """
4906 return _core_.PyApp_Yield(*args, **kwargs)
4907
4908 def WakeUpIdle(*args, **kwargs):
4909 """
4910 WakeUpIdle(self)
4911
c24da6d6
RD
4912 Make sure that idle events are sent again.
4913 :see: `wx.WakeUpIdle`
d55e5bfc
RD
4914 """
4915 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
4916
84f85550
RD
4917 def IsMainLoopRunning(*args, **kwargs):
4918 """
4919 IsMainLoopRunning() -> bool
4920
4921 Returns True if we're running the main loop, i.e. if the events can
4922 currently be dispatched.
4923 """
4924 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
4925
4926 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD
4927 def MainLoop(*args, **kwargs):
4928 """
4929 MainLoop(self) -> int
4930
c24da6d6
RD
4931 Execute the main GUI loop, the function doesn't normally return until
4932 all top level windows have been closed and destroyed.
d55e5bfc
RD
4933 """
4934 return _core_.PyApp_MainLoop(*args, **kwargs)
4935
4936 def Exit(*args, **kwargs):
4937 """
4938 Exit(self)
4939
4940 Exit the main loop thus terminating the application.
c24da6d6 4941 :see: `wx.Exit`
d55e5bfc
RD
4942 """
4943 return _core_.PyApp_Exit(*args, **kwargs)
4944
4945 def ExitMainLoop(*args, **kwargs):
4946 """
4947 ExitMainLoop(self)
4948
c24da6d6
RD
4949 Exit the main GUI loop during the next iteration of the main
4950 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
4951 """
4952 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
4953
4954 def Pending(*args, **kwargs):
4955 """
4956 Pending(self) -> bool
4957
4958 Returns True if there are unprocessed events in the event queue.
4959 """
4960 return _core_.PyApp_Pending(*args, **kwargs)
4961
4962 def Dispatch(*args, **kwargs):
4963 """
4964 Dispatch(self) -> bool
4965
4966 Process the first event in the event queue (blocks until an event
4967 appears if there are none currently)
4968 """
4969 return _core_.PyApp_Dispatch(*args, **kwargs)
4970
4971 def ProcessIdle(*args, **kwargs):
4972 """
4973 ProcessIdle(self) -> bool
4974
c24da6d6
RD
4975 Called from the MainLoop when the application becomes idle (there are
4976 no pending events) and sends a `wx.IdleEvent` to all interested
4977 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
4978 """
4979 return _core_.PyApp_ProcessIdle(*args, **kwargs)
4980
4981 def SendIdleEvents(*args, **kwargs):
4982 """
4983 SendIdleEvents(self, Window win, IdleEvent event) -> bool
4984
c24da6d6
RD
4985 Send idle event to window and all subwindows. Returns True if more
4986 idle time is requested.
d55e5bfc
RD
4987 """
4988 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
4989
4990 def IsActive(*args, **kwargs):
4991 """
4992 IsActive(self) -> bool
4993
4994 Return True if our app has focus.
4995 """
4996 return _core_.PyApp_IsActive(*args, **kwargs)
4997
4998 def SetTopWindow(*args, **kwargs):
4999 """
5000 SetTopWindow(self, Window win)
5001
c24da6d6 5002 Set the *main* top level window
d55e5bfc
RD
5003 """
5004 return _core_.PyApp_SetTopWindow(*args, **kwargs)
5005
5006 def GetTopWindow(*args, **kwargs):
5007 """
5008 GetTopWindow(self) -> Window
5009
c24da6d6
RD
5010 Return the *main* top level window (if it hadn't been set previously
5011 with SetTopWindow(), will return just some top level window and, if
5012 there not any, will return None)
d55e5bfc
RD
5013 """
5014 return _core_.PyApp_GetTopWindow(*args, **kwargs)
5015
5016 def SetExitOnFrameDelete(*args, **kwargs):
5017 """
5018 SetExitOnFrameDelete(self, bool flag)
5019
c24da6d6
RD
5020 Control the exit behaviour: by default, the program will exit the main
5021 loop (and so, usually, terminate) when the last top-level program
5022 window is deleted. Beware that if you disable this behaviour (with
5023 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
5024 explicitly from somewhere.
d55e5bfc
RD
5025 """
5026 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
5027
5028 def GetExitOnFrameDelete(*args, **kwargs):
5029 """
5030 GetExitOnFrameDelete(self) -> bool
5031
5032 Get the current exit behaviour setting.
5033 """
5034 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
5035
5036 def SetUseBestVisual(*args, **kwargs):
5037 """
5038 SetUseBestVisual(self, bool flag)
5039
c24da6d6
RD
5040 Set whether the app should try to use the best available visual on
5041 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
5042 """
5043 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
5044
5045 def GetUseBestVisual(*args, **kwargs):
5046 """
5047 GetUseBestVisual(self) -> bool
5048
5049 Get current UseBestVisual setting.
5050 """
5051 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
5052
5053 def SetPrintMode(*args, **kwargs):
5054 """SetPrintMode(self, int mode)"""
5055 return _core_.PyApp_SetPrintMode(*args, **kwargs)
5056
5057 def GetPrintMode(*args, **kwargs):
5058 """GetPrintMode(self) -> int"""
5059 return _core_.PyApp_GetPrintMode(*args, **kwargs)
5060
5061 def SetAssertMode(*args, **kwargs):
5062 """
5063 SetAssertMode(self, int mode)
5064
79fccf9d 5065 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
5066 """
5067 return _core_.PyApp_SetAssertMode(*args, **kwargs)
5068
5069 def GetAssertMode(*args, **kwargs):
5070 """
5071 GetAssertMode(self) -> int
5072
5073 Get the current OnAssert behaviour setting.
5074 """
5075 return _core_.PyApp_GetAssertMode(*args, **kwargs)
5076
5077 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 5078 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
5079 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
5080
5081 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
5082 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 5083 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
5084 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
5085
5086 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
5087 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 5088 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
5089 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
5090
5091 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
5092 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 5093 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
5094 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
5095
5096 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
5097 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 5098 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
5099 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
5100
5101 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
5102 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 5103 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
5104 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5105
5106 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
5107 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 5108 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
5109 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5110
5111 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
5112 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 5113 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
5114 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5115
5116 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
5117 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 5118 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
5119 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5120
5121 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
5122 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 5123 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
5124 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5125
5126 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5127 def _BootstrapApp(*args, **kwargs):
5128 """
5129 _BootstrapApp(self)
5130
5131 For internal use only
5132 """
5133 return _core_.PyApp__BootstrapApp(*args, **kwargs)
5134
5135 def GetComCtl32Version(*args, **kwargs):
5136 """
c24da6d6 5137 GetComCtl32Version() -> int
d55e5bfc 5138
c24da6d6
RD
5139 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5140 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
5141 """
5142 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5143
5144 GetComCtl32Version = staticmethod(GetComCtl32Version)
5145
5146class PyAppPtr(PyApp):
5147 def __init__(self, this):
5148 self.this = this
5149 if not hasattr(self,"thisown"): self.thisown = 0
5150 self.__class__ = PyApp
5151_core_.PyApp_swigregister(PyAppPtr)
5152
84f85550
RD
5153def PyApp_IsMainLoopRunning(*args, **kwargs):
5154 """
5155 PyApp_IsMainLoopRunning() -> bool
5156
5157 Returns True if we're running the main loop, i.e. if the events can
5158 currently be dispatched.
5159 """
5160 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5161
d55e5bfc
RD
5162def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5163 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
5164 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
5165
5166def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5167 """PyApp_GetMacAboutMenuItemId() -> long"""
5168 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
5169
5170def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5171 """PyApp_GetMacPreferencesMenuItemId() -> long"""
5172 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
5173
5174def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5175 """PyApp_GetMacExitMenuItemId() -> long"""
5176 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
5177
5178def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
5179 """PyApp_GetMacHelpMenuTitleName() -> String"""
5180 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
5181
5182def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5183 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
5184 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5185
5186def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5187 """PyApp_SetMacAboutMenuItemId(long val)"""
5188 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5189
5190def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5191 """PyApp_SetMacPreferencesMenuItemId(long val)"""
5192 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5193
5194def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5195 """PyApp_SetMacExitMenuItemId(long val)"""
5196 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5197
5198def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
5199 """PyApp_SetMacHelpMenuTitleName(String val)"""
5200 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5201
5202def PyApp_GetComCtl32Version(*args, **kwargs):
5203 """
5204 PyApp_GetComCtl32Version() -> int
5205
c24da6d6
RD
5206 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5207 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
5208 """
5209 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5210
5211#---------------------------------------------------------------------------
5212
5213
5214def Exit(*args, **kwargs):
5215 """
5216 Exit()
5217
5218 Force an exit of the application. Convenience for wx.GetApp().Exit()
5219 """
5220 return _core_.Exit(*args, **kwargs)
5221
5222def Yield(*args, **kwargs):
5223 """
5224 Yield() -> bool
5225
5226 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5227 """
5228 return _core_.Yield(*args, **kwargs)
5229
5230def YieldIfNeeded(*args, **kwargs):
5231 """
5232 YieldIfNeeded() -> bool
5233
5234 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5235 """
5236 return _core_.YieldIfNeeded(*args, **kwargs)
5237
5238def SafeYield(*args, **kwargs):
5239 """
5240 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
5241
c24da6d6
RD
5242 This function is similar to `wx.Yield`, except that it disables the
5243 user input to all program windows before calling `wx.Yield` and
5244 re-enables it again afterwards. If ``win`` is not None, this window
5245 will remain enabled, allowing the implementation of some limited user
5246 interaction.
d55e5bfc 5247
c24da6d6 5248 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
5249 """
5250 return _core_.SafeYield(*args, **kwargs)
5251
5252def WakeUpIdle(*args, **kwargs):
5253 """
5254 WakeUpIdle()
5255
c24da6d6
RD
5256 Cause the message queue to become empty again, so idle events will be
5257 sent.
d55e5bfc
RD
5258 """
5259 return _core_.WakeUpIdle(*args, **kwargs)
5260
5261def PostEvent(*args, **kwargs):
5262 """
5263 PostEvent(EvtHandler dest, Event event)
5264
c24da6d6
RD
5265 Send an event to a window or other wx.EvtHandler to be processed
5266 later.
d55e5bfc
RD
5267 """
5268 return _core_.PostEvent(*args, **kwargs)
5269
5270def App_CleanUp(*args, **kwargs):
5271 """
5272 App_CleanUp()
5273
79fccf9d 5274 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 5275 Python shuts down.
d55e5bfc
RD
5276 """
5277 return _core_.App_CleanUp(*args, **kwargs)
5278
5279def GetApp(*args, **kwargs):
5280 """
5281 GetApp() -> PyApp
5282
5283 Return a reference to the current wx.App object.
5284 """
5285 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD
5286
5287def SetDefaultPyEncoding(*args, **kwargs):
5288 """
5289 SetDefaultPyEncoding(string encoding)
5290
5291 Sets the encoding that wxPython will use when it needs to convert a
5292 Python string or unicode object to or from a wxString.
62d32a5f
RD
5293
5294 The default encoding is the value of ``locale.getdefaultlocale()[1]``
5295 but please be aware that the default encoding within the same locale
5296 may be slightly different on different platforms. For example, please
5297 see http://www.alanwood.net/demos/charsetdiffs.html for differences
5298 between the common latin/roman encodings.
5cbf236d
RD
5299 """
5300 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5301
5302def GetDefaultPyEncoding(*args, **kwargs):
5303 """
5304 GetDefaultPyEncoding() -> string
5305
5306 Gets the current encoding that wxPython will use when it needs to
5307 convert a Python string or unicode object to or from a wxString.
5308 """
5309 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d55e5bfc
RD
5310#----------------------------------------------------------------------
5311
5312class PyOnDemandOutputWindow:
5313 """
5314 A class that can be used for redirecting Python's stdout and
5315 stderr streams. It will do nothing until something is wrriten to
5316 the stream at which point it will create a Frame with a text area
5317 and write the text there.
5318 """
5319 def __init__(self, title = "wxPython: stdout/stderr"):
5320 self.frame = None
5321 self.title = title
412d302d
RD
5322 self.pos = wx.DefaultPosition
5323 self.size = (450, 300)
d55e5bfc
RD
5324 self.parent = None
5325
5326 def SetParent(self, parent):
5327 """Set the window to be used as the popup Frame's parent."""
5328 self.parent = parent
5329
5330
5331 def CreateOutputWindow(self, st):
412d302d
RD
5332 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5333 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 5334 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5335 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 5336 self.text.AppendText(st)
d55e5bfc
RD
5337 self.frame.Show(True)
5338 EVT_CLOSE(self.frame, self.OnCloseWindow)
5339
5340
5341 def OnCloseWindow(self, event):
5342 if self.frame is not None:
5343 self.frame.Destroy()
5344 self.frame = None
5345 self.text = None
5346
5347
5348 # These methods provide the file-like output behaviour.
5349 def write(self, text):
5350 """
5351 Create the output window if needed and write the string to it.
5352 If not called in the context of the gui thread then uses
5353 CallAfter to do the work there.
5354 """
5355 if self.frame is None:
5356 if not wx.Thread_IsMain():
5357 wx.CallAfter(self.CreateOutputWindow, text)
5358 else:
5359 self.CreateOutputWindow(text)
5360 else:
5361 if not wx.Thread_IsMain():
5362 wx.CallAfter(self.text.AppendText, text)
5363 else:
5364 self.text.AppendText(text)
5365
5366
5367 def close(self):
5368 if self.frame is not None:
5369 wx.CallAfter(self.frame.Close)
5370
5371
19272049
RD
5372 def flush(self):
5373 pass
5374
5375
d55e5bfc
RD
5376
5377#----------------------------------------------------------------------
5378
5379_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5380
5381class App(wx.PyApp):
5382 """
c24da6d6
RD
5383 The ``wx.App`` class represents the application and is used to:
5384
5385 * bootstrap the wxPython system and initialize the underlying
5386 gui toolkit
5387 * set and get application-wide properties
5388 * implement the windowing system main message or event loop,
5389 and to dispatch events to window instances
5390 * etc.
5391
5392 Every application must have a ``wx.App`` instance, and all
5393 creation of UI objects should be delayed until after the
5394 ``wx.App`` object has been created in order to ensure that the gui
5395 platform and wxWidgets have been fully initialized.
5396
5397 Normally you would derive from this class and implement an
5398 ``OnInit`` method that creates a frame and then calls
5399 ``self.SetTopWindow(frame)``.
5400
5401 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 5402 directly.
d55e5bfc 5403 """
c24da6d6 5404
d55e5bfc
RD
5405 outputWindowClass = PyOnDemandOutputWindow
5406
c24da6d6
RD
5407 def __init__(self, redirect=_defRedirect, filename=None,
5408 useBestVisual=False, clearSigInt=True):
5409 """
5410 Construct a ``wx.App`` object.
5411
5412 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5413 redirected? Defaults to True on Windows and Mac, False
5414 otherwise. If `filename` is None then output will be
5415 redirected to a window that pops up as needed. (You can
5416 control what kind of window is created for the output by
5417 resetting the class variable ``outputWindowClass`` to a
5418 class of your choosing.)
5419
5420 :param filename: The name of a file to redirect output to, if
5421 redirect is True.
5422
5423 :param useBestVisual: Should the app try to use the best
5424 available visual provided by the system (only relevant on
5425 systems that have more than one visual.) This parameter
5426 must be used instead of calling `SetUseBestVisual` later
5427 on because it must be set before the underlying GUI
5428 toolkit is initialized.
5429
5430 :param clearSigInt: Should SIGINT be cleared? This allows the
5431 app to terminate upon a Ctrl-C in the console like other
5432 GUI apps will.
5433
5434 :note: You should override OnInit to do applicaition
5435 initialization to ensure that the system, toolkit and
5436 wxWidgets are fully initialized.
5437 """
d55e5bfc
RD
5438 wx.PyApp.__init__(self)
5439
5440 if wx.Platform == "__WXMAC__":
5441 try:
5442 import MacOS
5443 if not MacOS.WMAvailable():
5444 print """\
5445This program needs access to the screen. Please run with 'pythonw',
5446not 'python', and only when you are logged in on the main display of
5447your Mac."""
5448 _sys.exit(1)
b1f29bf7
RD
5449 except SystemExit:
5450 raise
d55e5bfc
RD
5451 except:
5452 pass
5453
5454 # This has to be done before OnInit
5455 self.SetUseBestVisual(useBestVisual)
5456
5457 # Set the default handler for SIGINT. This fixes a problem
5458 # where if Ctrl-C is pressed in the console that started this
5459 # app then it will not appear to do anything, (not even send
5460 # KeyboardInterrupt???) but will later segfault on exit. By
5461 # setting the default handler then the app will exit, as
5462 # expected (depending on platform.)
c24da6d6
RD
5463 if clearSigInt:
5464 try:
5465 import signal
5466 signal.signal(signal.SIGINT, signal.SIG_DFL)
5467 except:
5468 pass
d55e5bfc
RD
5469
5470 # Save and redirect the stdio to a window?
5471 self.stdioWin = None
5472 self.saveStdio = (_sys.stdout, _sys.stderr)
5473 if redirect:
5474 self.RedirectStdio(filename)
5475
8fb0e70a
RD
5476 # Use Python's install prefix as the default
5477 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5478
d55e5bfc
RD
5479 # This finishes the initialization of wxWindows and then calls
5480 # the OnInit that should be present in the derived class
5481 self._BootstrapApp()
5482
5483
5484 def __del__(self):
5485 try:
5486 self.RestoreStdio() # Just in case the MainLoop was overridden
5487 except:
5488 pass
5489
5490
5491 def SetTopWindow(self, frame):
5492 """Set the \"main\" top level window"""
5493 if self.stdioWin:
5494 self.stdioWin.SetParent(frame)
5495 wx.PyApp.SetTopWindow(self, frame)
5496
5497
5498 def MainLoop(self):
5499 """Execute the main GUI event loop"""
5500 wx.PyApp.MainLoop(self)
5501 self.RestoreStdio()
5502
5503
5504 def RedirectStdio(self, filename=None):
5505 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5506 if filename:
5507 _sys.stdout = _sys.stderr = open(filename, 'a')
5508 else:
5509 self.stdioWin = self.outputWindowClass()
5510 _sys.stdout = _sys.stderr = self.stdioWin
5511
5512
5513 def RestoreStdio(self):
5514 _sys.stdout, _sys.stderr = self.saveStdio
5515
5516
412d302d
RD
5517 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5518 """
5519 Set the title, position and/or size of the output window if
f5b96ee1
RD
5520 the stdio has been redirected. This should be called before
5521 any output would cause the output window to be created.
412d302d
RD
5522 """
5523 if self.stdioWin:
5524 if title is not None:
5525 self.stdioWin.title = title
5526 if pos is not None:
5527 self.stdioWin.pos = pos
5528 if size is not None:
5529 self.stdioWin.size = size
5530
5531
5532
d55e5bfc 5533
c24da6d6 5534# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
5535App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5536App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5537App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5538App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5539App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5540App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5541App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5542App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5543App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5544App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5545App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5546
5547#----------------------------------------------------------------------------
5548
5549class PySimpleApp(wx.App):
5550 """
5551 A simple application class. You can just create one of these and
5552 then then make your top level windows later, and not have to worry
c24da6d6 5553 about OnInit. For example::
d55e5bfc 5554
c24da6d6
RD
5555 app = wx.PySimpleApp()
5556 frame = wx.Frame(None, title='Hello World')
5557 frame.Show()
5558 app.MainLoop()
5559
5560 :see: `wx.App`
5561 """
5562
5563 def __init__(self, redirect=False, filename=None,
5564 useBestVisual=False, clearSigInt=True):
5565 """
5566 :see: `wx.App.__init__`
5567 """
5568 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
5569
5570 def OnInit(self):
d55e5bfc
RD
5571 return True
5572
5573
c24da6d6 5574
d55e5bfc
RD
5575# Is anybody using this one?
5576class PyWidgetTester(wx.App):
5577 def __init__(self, size = (250, 100)):
5578 self.size = size
5579 wx.App.__init__(self, 0)
5580
5581 def OnInit(self):
5582 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5583 self.SetTopWindow(self.frame)
5584 return True
5585
c24da6d6
RD
5586 def SetWidget(self, widgetClass, *args, **kwargs):
5587 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
5588 self.frame.Show(True)
5589
5590#----------------------------------------------------------------------------
5591# DO NOT hold any other references to this object. This is how we
c24da6d6 5592# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5593# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 5594# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
5595
5596class __wxPyCleanup:
5597 def __init__(self):
5598 self.cleanup = _core_.App_CleanUp
5599 def __del__(self):
5600 self.cleanup()
5601
5602_sys.__wxPythonCleanup = __wxPyCleanup()
5603
5604## # another possible solution, but it gets called too early...
c24da6d6
RD
5605## import atexit
5606## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
5607
5608
5609#----------------------------------------------------------------------------
5610
5611#---------------------------------------------------------------------------
5612
ae8162c8 5613class EventLoop(object):
093d3ff1 5614 """Proxy of C++ EventLoop class"""
ae8162c8
RD
5615 def __repr__(self):
5616 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5617 def __init__(self, *args, **kwargs):
5618 """__init__(self) -> EventLoop"""
5619 newobj = _core_.new_EventLoop(*args, **kwargs)
5620 self.this = newobj.this
5621 self.thisown = 1
5622 del newobj.thisown
5623 def __del__(self, destroy=_core_.delete_EventLoop):
5624 """__del__(self)"""
5625 try:
5626 if self.thisown: destroy(self)
5627 except: pass
5628
5629 def Run(*args, **kwargs):
5630 """Run(self) -> int"""
5631 return _core_.EventLoop_Run(*args, **kwargs)
5632
5633 def Exit(*args, **kwargs):
5634 """Exit(self, int rc=0)"""
5635 return _core_.EventLoop_Exit(*args, **kwargs)
5636
5637 def Pending(*args, **kwargs):
5638 """Pending(self) -> bool"""
5639 return _core_.EventLoop_Pending(*args, **kwargs)
5640
5641 def Dispatch(*args, **kwargs):
5642 """Dispatch(self) -> bool"""
5643 return _core_.EventLoop_Dispatch(*args, **kwargs)
5644
5645 def IsRunning(*args, **kwargs):
5646 """IsRunning(self) -> bool"""
5647 return _core_.EventLoop_IsRunning(*args, **kwargs)
5648
5649 def GetActive(*args, **kwargs):
5650 """GetActive() -> EventLoop"""
5651 return _core_.EventLoop_GetActive(*args, **kwargs)
5652
5653 GetActive = staticmethod(GetActive)
5654 def SetActive(*args, **kwargs):
5655 """SetActive(EventLoop loop)"""
5656 return _core_.EventLoop_SetActive(*args, **kwargs)
5657
5658 SetActive = staticmethod(SetActive)
5659
5660class EventLoopPtr(EventLoop):
5661 def __init__(self, this):
5662 self.this = this
5663 if not hasattr(self,"thisown"): self.thisown = 0
5664 self.__class__ = EventLoop
5665_core_.EventLoop_swigregister(EventLoopPtr)
5666
5667def EventLoop_GetActive(*args, **kwargs):
5668 """EventLoop_GetActive() -> EventLoop"""
5669 return _core_.EventLoop_GetActive(*args, **kwargs)
5670
5671def EventLoop_SetActive(*args, **kwargs):
5672 """EventLoop_SetActive(EventLoop loop)"""
5673 return _core_.EventLoop_SetActive(*args, **kwargs)
5674
5675#---------------------------------------------------------------------------
5676
d55e5bfc 5677class AcceleratorEntry(object):
c24da6d6
RD
5678 """
5679 A class used to define items in an `wx.AcceleratorTable`. wxPython
5680 programs can choose to use wx.AcceleratorEntry objects, but using a
5681 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 5682 as well. See `__init__` for of the tuple values.
c24da6d6
RD
5683
5684 :see: `wx.AcceleratorTable`
5685 """
d55e5bfc
RD
5686 def __repr__(self):
5687 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5688 def __init__(self, *args, **kwargs):
c24da6d6
RD
5689 """
5690 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5691
5692 Construct a wx.AcceleratorEntry.
c24da6d6 5693 """
d55e5bfc
RD
5694 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5695 self.this = newobj.this
5696 self.thisown = 1
5697 del newobj.thisown
5698 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5699 """__del__(self)"""
5700 try:
5701 if self.thisown: destroy(self)
5702 except: pass
5703
5704 def Set(*args, **kwargs):
c24da6d6
RD
5705 """
5706 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5707
c24da6d6
RD
5708 (Re)set the attributes of a wx.AcceleratorEntry.
5709 :see `__init__`
5710 """
5711 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
5712
5713 def GetFlags(*args, **kwargs):
c24da6d6
RD
5714 """
5715 GetFlags(self) -> int
5716
5717 Get the AcceleratorEntry's flags.
5718 """
d55e5bfc
RD
5719 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5720
5721 def GetKeyCode(*args, **kwargs):
c24da6d6
RD
5722 """
5723 GetKeyCode(self) -> int
5724
5725 Get the AcceleratorEntry's keycode.
5726 """
d55e5bfc
RD
5727 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5728
5729 def GetCommand(*args, **kwargs):
c24da6d6
RD
5730 """
5731 GetCommand(self) -> int
5732
5733 Get the AcceleratorEntry's command ID.
5734 """
d55e5bfc
RD
5735 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5736
5737
5738class AcceleratorEntryPtr(AcceleratorEntry):
5739 def __init__(self, this):
5740 self.this = this
5741 if not hasattr(self,"thisown"): self.thisown = 0
5742 self.__class__ = AcceleratorEntry
5743_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5744
5745class AcceleratorTable(Object):
c24da6d6
RD
5746 """
5747 An accelerator table allows the application to specify a table of
5748 keyboard shortcuts for menus or other commands. On Windows, menu or
5749 button commands are supported; on GTK, only menu commands are
5750 supported.
c24da6d6 5751 """
d55e5bfc
RD
5752 def __repr__(self):
5753 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5754 def __init__(self, *args, **kwargs):
5755 """
5756 __init__(entries) -> AcceleratorTable
5757
c24da6d6
RD
5758 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5759 items or or of 3-tuples (flags, keyCode, cmdID)
5760
5761 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
5762 """
5763 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5764 self.this = newobj.this
5765 self.thisown = 1
5766 del newobj.thisown
5767 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5768 """__del__(self)"""
5769 try:
5770 if self.thisown: destroy(self)
5771 except: pass
5772
5773 def Ok(*args, **kwargs):
5774 """Ok(self) -> bool"""
5775 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5776
5777
5778class AcceleratorTablePtr(AcceleratorTable):
5779 def __init__(self, this):
5780 self.this = this
5781 if not hasattr(self,"thisown"): self.thisown = 0
5782 self.__class__ = AcceleratorTable
5783_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5784
5785
5786def GetAccelFromString(*args, **kwargs):
5787 """GetAccelFromString(String label) -> AcceleratorEntry"""
5788 return _core_.GetAccelFromString(*args, **kwargs)
5789#---------------------------------------------------------------------------
5790
5791class VisualAttributes(object):
5792 """struct containing all the visual attributes of a control"""
5793 def __repr__(self):
5794 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5795 def __init__(self, *args, **kwargs):
5796 """
5797 __init__(self) -> VisualAttributes
5798
5799 struct containing all the visual attributes of a control
5800 """
5801 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5802 self.this = newobj.this
5803 self.thisown = 1
5804 del newobj.thisown
5805 def __del__(self, destroy=_core_.delete_VisualAttributes):
5806 """__del__(self)"""
5807 try:
5808 if self.thisown: destroy(self)
5809 except: pass
5810
5811 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5812 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5813 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5814
5815class VisualAttributesPtr(VisualAttributes):
5816 def __init__(self, this):
5817 self.this = this
5818 if not hasattr(self,"thisown"): self.thisown = 0
5819 self.__class__ = VisualAttributes
5820_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5821NullAcceleratorTable = cvar.NullAcceleratorTable
5822PanelNameStr = cvar.PanelNameStr
5823
5824WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5825WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5826WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5827WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5828WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5829class Window(EvtHandler):
5830 """
5831 wx.Window is the base class for all windows and represents any visible
5832 object on the screen. All controls, top level windows and so on are
5833 wx.Windows. Sizers and device contexts are not however, as they don't
5834 appear on screen themselves.
5835
5836 """
5837 def __repr__(self):
5838 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5839 def __init__(self, *args, **kwargs):
5840 """
5841 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5842 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5843
5844 Construct and show a generic Window.
5845 """
5846 newobj = _core_.new_Window(*args, **kwargs)
5847 self.this = newobj.this
5848 self.thisown = 1
5849 del newobj.thisown
5850 self._setOORInfo(self)
5851
5852 def Create(*args, **kwargs):
5853 """
5854 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5855 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
5856
5857 Create the GUI part of the Window for 2-phase creation mode.
5858 """
5859 return _core_.Window_Create(*args, **kwargs)
5860
5861 def Close(*args, **kwargs):
5862 """
5863 Close(self, bool force=False) -> bool
5864
5865 This function simply generates a EVT_CLOSE event whose handler usually
5866 tries to close the window. It doesn't close the window itself,
5867 however. If force is False (the default) then the window's close
5868 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
5869 """
5870 return _core_.Window_Close(*args, **kwargs)
5871
5872 def Destroy(*args, **kwargs):
5873 """
5874 Destroy(self) -> bool
5875
5876 Destroys the window safely. Frames and dialogs are not destroyed
5877 immediately when this function is called -- they are added to a list
5878 of windows to be deleted on idle time, when all the window's events
5879 have been processed. This prevents problems with events being sent to
5880 non-existent windows.
5881
5882 Returns True if the window has either been successfully deleted, or it
5883 has been added to the list of windows pending real deletion.
5884 """
5885 return _core_.Window_Destroy(*args, **kwargs)
5886
5887 def DestroyChildren(*args, **kwargs):
5888 """
5889 DestroyChildren(self) -> bool
5890
79fccf9d
RD
5891 Destroys all children of a window. Called automatically by the
5892 destructor.
d55e5bfc
RD
5893 """
5894 return _core_.Window_DestroyChildren(*args, **kwargs)
5895
5896 def IsBeingDeleted(*args, **kwargs):
5897 """
5898 IsBeingDeleted(self) -> bool
5899
5900 Is the window in the process of being deleted?
5901 """
5902 return _core_.Window_IsBeingDeleted(*args, **kwargs)
5903
5904 def SetTitle(*args, **kwargs):
5905 """
5906 SetTitle(self, String title)
5907
5908 Sets the window's title. Applicable only to frames and dialogs.
5909 """
5910 return _core_.Window_SetTitle(*args, **kwargs)
5911
5912 def GetTitle(*args, **kwargs):
5913 """
5914 GetTitle(self) -> String
5915
5916 Gets the window's title. Applicable only to frames and dialogs.
5917 """
5918 return _core_.Window_GetTitle(*args, **kwargs)
5919
5920 def SetLabel(*args, **kwargs):
5921 """
5922 SetLabel(self, String label)
5923
5924 Set the text which the window shows in its label if applicable.
5925 """
5926 return _core_.Window_SetLabel(*args, **kwargs)
5927
5928 def GetLabel(*args, **kwargs):
5929 """
5930 GetLabel(self) -> String
5931
79fccf9d
RD
5932 Generic way of getting a label from any window, for identification
5933 purposes. The interpretation of this function differs from class to
5934 class. For frames and dialogs, the value returned is the title. For
5935 buttons or static text controls, it is the button text. This function
5936 can be useful for meta-programs such as testing tools or special-needs
5937 access programs)which need to identify windows by name.
d55e5bfc
RD
5938 """
5939 return _core_.Window_GetLabel(*args, **kwargs)
5940
5941 def SetName(*args, **kwargs):
5942 """
5943 SetName(self, String name)
5944
79fccf9d
RD
5945 Sets the window's name. The window name is used for ressource setting
5946 in X, it is not the same as the window title/label
d55e5bfc
RD
5947 """
5948 return _core_.Window_SetName(*args, **kwargs)
5949
5950 def GetName(*args, **kwargs):
5951 """
5952 GetName(self) -> String
5953
79fccf9d
RD
5954 Returns the windows name. This name is not guaranteed to be unique;
5955 it is up to the programmer to supply an appropriate name in the window
5956 constructor or via wx.Window.SetName.
d55e5bfc
RD
5957 """
5958 return _core_.Window_GetName(*args, **kwargs)
5959
5960 def SetWindowVariant(*args, **kwargs):
5961 """
5962 SetWindowVariant(self, int variant)
5963
79fccf9d
RD
5964 Sets the variant of the window/font size to use for this window, if
5965 the platform supports variants, for example, wxMac.
d55e5bfc
RD
5966 """
5967 return _core_.Window_SetWindowVariant(*args, **kwargs)
5968
5969 def GetWindowVariant(*args, **kwargs):
5970 """GetWindowVariant(self) -> int"""
5971 return _core_.Window_GetWindowVariant(*args, **kwargs)
5972
5973 def SetId(*args, **kwargs):
5974 """
5975 SetId(self, int winid)
5976
5977 Sets the identifier of the window. Each window has an integer
5978 identifier. If the application has not provided one, an identifier
5979 will be generated. Normally, the identifier should be provided on
5980 creation and should not be modified subsequently.
5981 """
5982 return _core_.Window_SetId(*args, **kwargs)
5983
5984 def GetId(*args, **kwargs):
5985 """
5986 GetId(self) -> int
5987
5988 Returns the identifier of the window. Each window has an integer
5989 identifier. If the application has not provided one (or the default Id
5990 -1 is used) then an unique identifier with a negative value will be
5991 generated.
5992 """
5993 return _core_.Window_GetId(*args, **kwargs)
5994
5995 def NewControlId(*args, **kwargs):
5996 """
c24da6d6 5997 NewControlId() -> int
d55e5bfc
RD
5998
5999 Generate a control id for the controls which were not given one.
6000 """
6001 return _core_.Window_NewControlId(*args, **kwargs)
6002
6003 NewControlId = staticmethod(NewControlId)
6004 def NextControlId(*args, **kwargs):
6005 """
c24da6d6 6006 NextControlId(int winid) -> int
d55e5bfc
RD
6007
6008 Get the id of the control following the one with the given
79fccf9d 6009 autogenerated) id
d55e5bfc
RD
6010 """
6011 return _core_.Window_NextControlId(*args, **kwargs)
6012
6013 NextControlId = staticmethod(NextControlId)
6014 def PrevControlId(*args, **kwargs):
6015 """
c24da6d6 6016 PrevControlId(int winid) -> int
d55e5bfc
RD
6017
6018 Get the id of the control preceding the one with the given
79fccf9d 6019 autogenerated) id
d55e5bfc
RD
6020 """
6021 return _core_.Window_PrevControlId(*args, **kwargs)
6022
6023 PrevControlId = staticmethod(PrevControlId)
6024 def SetSize(*args, **kwargs):
6025 """
6026 SetSize(self, Size size)
6027
6028 Sets the size of the window in pixels.
6029 """
6030 return _core_.Window_SetSize(*args, **kwargs)
6031
6032 def SetDimensions(*args, **kwargs):
6033 """
6034 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
6035
6036 Sets the position and size of the window in pixels. The sizeFlags
6037 parameter indicates the interpretation of the other params if they are
62d32a5f
RD
6038 equal to -1.
6039
6040 ======================== ======================================
6041 wx.SIZE_AUTO A -1 indicates that a class-specific
6042 default should be used.
6043 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
6044 -1 values are supplied.
6045 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
6046 interpreted as real dimensions, not
6047 default values.
6048 ======================== ======================================
6049
d55e5bfc
RD
6050 """
6051 return _core_.Window_SetDimensions(*args, **kwargs)
6052
6053 def SetRect(*args, **kwargs):
6054 """
6055 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
6056
6057 Sets the position and size of the window in pixels using a wx.Rect.
6058 """
6059 return _core_.Window_SetRect(*args, **kwargs)
6060
6061 def SetSizeWH(*args, **kwargs):
6062 """
6063 SetSizeWH(self, int width, int height)
6064
6065 Sets the size of the window in pixels.
6066 """
6067 return _core_.Window_SetSizeWH(*args, **kwargs)
6068
6069 def Move(*args, **kwargs):
6070 """
6071 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
6072
6073 Moves the window to the given position.
6074 """
6075 return _core_.Window_Move(*args, **kwargs)
6076
6077 SetPosition = Move
6078 def MoveXY(*args, **kwargs):
6079 """
6080 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
6081
6082 Moves the window to the given position.
6083 """
6084 return _core_.Window_MoveXY(*args, **kwargs)
6085
f8167d6e
RD
6086 def SetBestFittingSize(*args, **kwargs):
6087 """
6088 SetBestFittingSize(self, Size size=DefaultSize)
6089
6090 A 'Smart' SetSize that will fill in default size components with the
6091 window's *best size* values. Also set's the minsize for use with sizers.
6092 """
6093 return _core_.Window_SetBestFittingSize(*args, **kwargs)
6094
d55e5bfc
RD
6095 def Raise(*args, **kwargs):
6096 """
6097 Raise(self)
6098
6099 Raises the window to the top of the window hierarchy if it is a
6100 managed window (dialog or frame).
6101 """
6102 return _core_.Window_Raise(*args, **kwargs)
6103
6104 def Lower(*args, **kwargs):
6105 """
6106 Lower(self)
6107
6108 Lowers the window to the bottom of the window hierarchy if it is a
6109 managed window (dialog or frame).
6110 """
6111 return _core_.Window_Lower(*args, **kwargs)
6112
6113 def SetClientSize(*args, **kwargs):
6114 """
6115 SetClientSize(self, Size size)
6116
6117 This sets the size of the window client area in pixels. Using this
6118 function to size a window tends to be more device-independent than
6119 wx.Window.SetSize, since the application need not worry about what
6120 dimensions the border or title bar have when trying to fit the window
6121 around panel items, for example.
6122 """
6123 return _core_.Window_SetClientSize(*args, **kwargs)
6124
6125 def SetClientSizeWH(*args, **kwargs):
6126 """
6127 SetClientSizeWH(self, int width, int height)
6128
6129 This sets the size of the window client area in pixels. Using this
6130 function to size a window tends to be more device-independent than
6131 wx.Window.SetSize, since the application need not worry about what
6132 dimensions the border or title bar have when trying to fit the window
6133 around panel items, for example.
6134 """
6135 return _core_.Window_SetClientSizeWH(*args, **kwargs)
6136
6137 def SetClientRect(*args, **kwargs):
6138 """
6139 SetClientRect(self, Rect rect)
6140
6141 This sets the size of the window client area in pixels. Using this
6142 function to size a window tends to be more device-independent than
6143 wx.Window.SetSize, since the application need not worry about what
6144 dimensions the border or title bar have when trying to fit the window
6145 around panel items, for example.
6146 """
6147 return _core_.Window_SetClientRect(*args, **kwargs)
6148
6149 def GetPosition(*args, **kwargs):
6150 """
6151 GetPosition(self) -> Point
6152
6153 Get the window's position.
6154 """
6155 return _core_.Window_GetPosition(*args, **kwargs)
6156
6157 def GetPositionTuple(*args, **kwargs):
6158 """
6159 GetPositionTuple() -> (x,y)
6160
6161 Get the window's position.
6162 """
6163 return _core_.Window_GetPositionTuple(*args, **kwargs)
6164
6165 def GetSize(*args, **kwargs):
6166 """
6167 GetSize(self) -> Size
6168
6169 Get the window size.
6170 """
6171 return _core_.Window_GetSize(*args, **kwargs)
6172
6173 def GetSizeTuple(*args, **kwargs):
6174 """
6175 GetSizeTuple() -> (width, height)
6176
6177 Get the window size.
6178 """
6179 return _core_.Window_GetSizeTuple(*args, **kwargs)
6180
6181 def GetRect(*args, **kwargs):
6182 """
6183 GetRect(self) -> Rect
6184
6185 Returns the size and position of the window as a wx.Rect object.
6186 """
6187 return _core_.Window_GetRect(*args, **kwargs)
6188
6189 def GetClientSize(*args, **kwargs):
6190 """
6191 GetClientSize(self) -> Size
6192
6193 This gets the size of the window's 'client area' in pixels. The client
6194 area is the area which may be drawn on by the programmer, excluding
6195 title bar, border, scrollbars, etc.
6196 """
6197 return _core_.Window_GetClientSize(*args, **kwargs)
6198
6199 def GetClientSizeTuple(*args, **kwargs):
6200 """
6201 GetClientSizeTuple() -> (width, height)
6202
6203 This gets the size of the window's 'client area' in pixels. The client
6204 area is the area which may be drawn on by the programmer, excluding
6205 title bar, border, scrollbars, etc.
6206 """
6207 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
6208
6209 def GetClientAreaOrigin(*args, **kwargs):
6210 """
6211 GetClientAreaOrigin(self) -> Point
6212
6213 Get the origin of the client area of the window relative to the
6214 window's top left corner (the client area may be shifted because of
6215 the borders, scrollbars, other decorations...)
6216 """
6217 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
6218
6219 def GetClientRect(*args, **kwargs):
6220 """
6221 GetClientRect(self) -> Rect
6222
629f3c1b 6223 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
6224 """
6225 return _core_.Window_GetClientRect(*args, **kwargs)
6226
6227 def GetBestSize(*args, **kwargs):
6228 """
6229 GetBestSize(self) -> Size
6230
248ed943 6231 This function returns the best acceptable minimal size for the
79fccf9d
RD
6232 window, if applicable. For example, for a static text control, it will
6233 be the minimal size such that the control label is not truncated. For
6234 windows containing subwindows (suzh aswx.Panel), the size returned by
6235 this function will be the same as the size the window would have had
6236 after calling Fit.
d55e5bfc
RD
6237 """
6238 return _core_.Window_GetBestSize(*args, **kwargs)
6239
6240 def GetBestSizeTuple(*args, **kwargs):
6241 """
6242 GetBestSizeTuple() -> (width, height)
6243
248ed943 6244 This function returns the best acceptable minimal size for the
79fccf9d
RD
6245 window, if applicable. For example, for a static text control, it will
6246 be the minimal size such that the control label is not truncated. For
6247 windows containing subwindows (suzh aswx.Panel), the size returned by
6248 this function will be the same as the size the window would have had
6249 after calling Fit.
d55e5bfc
RD
6250 """
6251 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
6252
a001823c
RD
6253 def InvalidateBestSize(*args, **kwargs):
6254 """
6255 InvalidateBestSize(self)
6256
6257 Reset the cached best size value so it will be recalculated the next
6258 time it is needed.
6259 """
6260 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6261
6262 def GetBestFittingSize(*args, **kwargs):
6263 """
6264 GetBestFittingSize(self) -> Size
6265
6266 This function will merge the window's best size into the window's
6267 minimum size, giving priority to the min size components, and returns
6268 the results.
6269
6270 """
6271 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6272
d55e5bfc
RD
6273 def GetAdjustedBestSize(*args, **kwargs):
6274 """
6275 GetAdjustedBestSize(self) -> Size
6276
6277 This method is similar to GetBestSize, except in one
6278 thing. GetBestSize should return the minimum untruncated size of the
6279 window, while this method will return the largest of BestSize and any
6280 user specified minimum size. ie. it is the minimum size the window
6281 should currently be drawn at, not the minimal size it can possibly
6282 tolerate.
6283 """
6284 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
6285
6286 def Center(*args, **kwargs):
6287 """
6288 Center(self, int direction=BOTH)
6289
6290 Centers the window. The parameter specifies the direction for
6291 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6292 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6293 on the entire screen and not on its parent window. If it is a
6294 top-level window and has no parent then it will always be centered
6295 relative to the screen.
6296 """
6297 return _core_.Window_Center(*args, **kwargs)
6298
6299 Centre = Center
6300 def CenterOnScreen(*args, **kwargs):
6301 """
6302 CenterOnScreen(self, int dir=BOTH)
6303
6304 Center on screen (only works for top level windows)
6305 """
6306 return _core_.Window_CenterOnScreen(*args, **kwargs)
6307
6308 CentreOnScreen = CenterOnScreen
6309 def CenterOnParent(*args, **kwargs):
6310 """
6311 CenterOnParent(self, int dir=BOTH)
6312
6313 Center with respect to the the parent window
6314 """
6315 return _core_.Window_CenterOnParent(*args, **kwargs)
6316
6317 CentreOnParent = CenterOnParent
6318 def Fit(*args, **kwargs):
6319 """
6320 Fit(self)
6321
6322 Sizes the window so that it fits around its subwindows. This function
6323 won't do anything if there are no subwindows and will only really work
6324 correctly if sizers are used for the subwindows layout. Also, if the
6325 window has exactly one subwindow it is better (faster and the result
6326 is more precise as Fit adds some margin to account for fuzziness of
6327 its calculations) to call window.SetClientSize(child.GetSize())
6328 instead of calling Fit.
6329 """
6330 return _core_.Window_Fit(*args, **kwargs)
6331
6332 def FitInside(*args, **kwargs):
6333 """
6334 FitInside(self)
6335
6336 Similar to Fit, but sizes the interior (virtual) size of a
6337 window. Mainly useful with scrolled windows to reset scrollbars after
6338 sizing changes that do not trigger a size event, and/or scrolled
6339 windows without an interior sizer. This function similarly won't do
6340 anything if there are no subwindows.
6341 """
6342 return _core_.Window_FitInside(*args, **kwargs)
6343
03837c5c 6344 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD
6345 """
6346 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
6347 int incH=-1)
d55e5bfc
RD
6348
6349 Allows specification of minimum and maximum window sizes, and window
6350 size increments. If a pair of values is not set (or set to -1), the
6351 default values will be used. If this function is called, the user
908b74cd
RD
6352 will not be able to size the window outside the given bounds (if it is
6353 a top-level window.) Sizers will also inspect the minimum window size
6354 and will use that value if set when calculating layout.
6355
6356 The resizing increments are only significant under Motif or Xt.
d55e5bfc 6357 """
03837c5c 6358 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 6359
03837c5c
RD
6360 def SetSizeHintsSz(*args, **kwargs):
6361 """
6362 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
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
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.
6372 """
6373 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6374
6375 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 6376 """
908b74cd 6377 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
6378
6379 Allows specification of minimum and maximum virtual window sizes. If a
6380 pair of values is not set (or set to -1), the default values will be
6381 used. If this function is called, the user will not be able to size
6382 the virtual area of the window outside the given bounds.
6383 """
03837c5c
RD
6384 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6385
6386 def SetVirtualSizeHintsSz(*args, **kwargs):
6387 """
6388 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6389
6390 Allows specification of minimum and maximum virtual window sizes. If a
6391 pair of values is not set (or set to -1), the default values will be
6392 used. If this function is called, the user will not be able to size
6393 the virtual area of the window outside the given bounds.
6394 """
6395 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 6396
908b74cd
RD
6397 def GetMaxSize(*args, **kwargs):
6398 """GetMaxSize(self) -> Size"""
6399 return _core_.Window_GetMaxSize(*args, **kwargs)
6400
6401 def GetMinSize(*args, **kwargs):
6402 """GetMinSize(self) -> Size"""
6403 return _core_.Window_GetMinSize(*args, **kwargs)
6404
6405 def SetMinSize(*args, **kwargs):
6406 """
6407 SetMinSize(self, Size minSize)
6408
6409 A more convenient method than `SetSizeHints` for setting just the
6410 min size.
6411 """
6412 return _core_.Window_SetMinSize(*args, **kwargs)
6413
6414 def SetMaxSize(*args, **kwargs):
6415 """
6416 SetMaxSize(self, Size maxSize)
6417
6418 A more convenient method than `SetSizeHints` for setting just the
6419 max size.
6420 """
6421 return _core_.Window_SetMaxSize(*args, **kwargs)
6422
d55e5bfc
RD
6423 def GetMinWidth(*args, **kwargs):
6424 """GetMinWidth(self) -> int"""
6425 return _core_.Window_GetMinWidth(*args, **kwargs)
6426
6427 def GetMinHeight(*args, **kwargs):
6428 """GetMinHeight(self) -> int"""
6429 return _core_.Window_GetMinHeight(*args, **kwargs)
6430
6431 def GetMaxWidth(*args, **kwargs):
6432 """GetMaxWidth(self) -> int"""
6433 return _core_.Window_GetMaxWidth(*args, **kwargs)
6434
6435 def GetMaxHeight(*args, **kwargs):
6436 """GetMaxHeight(self) -> int"""
6437 return _core_.Window_GetMaxHeight(*args, **kwargs)
6438
d55e5bfc
RD
6439 def SetVirtualSize(*args, **kwargs):
6440 """
6441 SetVirtualSize(self, Size size)
6442
6443 Set the the virtual size of a window in pixels. For most windows this
6444 is just the client area of the window, but for some like scrolled
6445 windows it is more or less independent of the screen window size.
6446 """
6447 return _core_.Window_SetVirtualSize(*args, **kwargs)
6448
6449 def SetVirtualSizeWH(*args, **kwargs):
6450 """
6451 SetVirtualSizeWH(self, int w, int h)
6452
6453 Set the the virtual size of a window in pixels. For most windows this
6454 is just the client area of the window, but for some like scrolled
6455 windows it is more or less independent of the screen window size.
6456 """
6457 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6458
6459 def GetVirtualSize(*args, **kwargs):
6460 """
6461 GetVirtualSize(self) -> Size
6462
6463 Get the the virtual size of the window in pixels. For most windows
6464 this is just the client area of the window, but for some like scrolled
6465 windows it is more or less independent of the screen window size.
6466 """
6467 return _core_.Window_GetVirtualSize(*args, **kwargs)
6468
6469 def GetVirtualSizeTuple(*args, **kwargs):
6470 """
6471 GetVirtualSizeTuple() -> (width, height)
6472
6473 Get the the virtual size of the window in pixels. For most windows
6474 this is just the client area of the window, but for some like scrolled
6475 windows it is more or less independent of the screen window size.
6476 """
6477 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6478
6479 def GetBestVirtualSize(*args, **kwargs):
6480 """
6481 GetBestVirtualSize(self) -> Size
6482
6483 Return the largest of ClientSize and BestSize (as determined by a
6484 sizer, interior children, or other means)
6485 """
6486 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6487
6488 def Show(*args, **kwargs):
6489 """
6490 Show(self, bool show=True) -> bool
6491
6492 Shows or hides the window. You may need to call Raise for a top level
6493 window if you want to bring it to top, although this is not needed if
6494 Show is called immediately after the frame creation. Returns True if
6495 the window has been shown or hidden or False if nothing was done
6496 because it already was in the requested state.
6497 """
6498 return _core_.Window_Show(*args, **kwargs)
6499
6500 def Hide(*args, **kwargs):
6501 """
6502 Hide(self) -> bool
6503
6504 Equivalent to calling Show(False).
6505 """
6506 return _core_.Window_Hide(*args, **kwargs)
6507
6508 def Enable(*args, **kwargs):
6509 """
6510 Enable(self, bool enable=True) -> bool
6511
6512 Enable or disable the window for user input. Note that when a parent
6513 window is disabled, all of its children are disabled as well and they
6514 are reenabled again when the parent is. Returns true if the window
6515 has been enabled or disabled, false if nothing was done, i.e. if the
6516 window had already been in the specified state.
6517 """
6518 return _core_.Window_Enable(*args, **kwargs)
6519
6520 def Disable(*args, **kwargs):
6521 """
6522 Disable(self) -> bool
6523
6524 Disables the window, same as Enable(false).
6525 """
6526 return _core_.Window_Disable(*args, **kwargs)
6527
6528 def IsShown(*args, **kwargs):
6529 """
6530 IsShown(self) -> bool
6531
6532 Returns true if the window is shown, false if it has been hidden.
6533 """
6534 return _core_.Window_IsShown(*args, **kwargs)
6535
6536 def IsEnabled(*args, **kwargs):
6537 """
6538 IsEnabled(self) -> bool
6539
6540 Returns true if the window is enabled for input, false otherwise.
6541 """
6542 return _core_.Window_IsEnabled(*args, **kwargs)
6543
6544 def SetWindowStyleFlag(*args, **kwargs):
6545 """
6546 SetWindowStyleFlag(self, long style)
6547
79fccf9d
RD
6548 Sets the style of the window. Please note that some styles cannot be
6549 changed after the window creation and that Refresh() might need to be
6550 called after changing the others for the change to take place
6551 immediately.
d55e5bfc
RD
6552 """
6553 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6554
6555 def GetWindowStyleFlag(*args, **kwargs):
6556 """
6557 GetWindowStyleFlag(self) -> long
6558
6559 Gets the window style that was passed to the constructor or Create
6560 method.
6561 """
6562 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6563
6564 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6565 def HasFlag(*args, **kwargs):
6566 """
6567 HasFlag(self, int flag) -> bool
6568
6569 Test if the given style is set for this window.
6570 """
6571 return _core_.Window_HasFlag(*args, **kwargs)
6572
6573 def IsRetained(*args, **kwargs):
6574 """
6575 IsRetained(self) -> bool
6576
6577 Returns true if the window is retained, false otherwise. Retained
6578 windows are only available on X platforms.
6579 """
6580 return _core_.Window_IsRetained(*args, **kwargs)
6581
6582 def SetExtraStyle(*args, **kwargs):
6583 """
6584 SetExtraStyle(self, long exStyle)
6585
6586 Sets the extra style bits for the window. Extra styles are the less
6587 often used style bits which can't be set with the constructor or with
6588 SetWindowStyleFlag()
6589 """
6590 return _core_.Window_SetExtraStyle(*args, **kwargs)
6591
6592 def GetExtraStyle(*args, **kwargs):
6593 """
6594 GetExtraStyle(self) -> long
6595
6596 Returns the extra style bits for the window.
6597 """
6598 return _core_.Window_GetExtraStyle(*args, **kwargs)
6599
6600 def MakeModal(*args, **kwargs):
6601 """
6602 MakeModal(self, bool modal=True)
6603
6604 Disables all other windows in the application so that the user can
6605 only interact with this window. Passing False will reverse this
6606 effect.
6607 """
6608 return _core_.Window_MakeModal(*args, **kwargs)
6609
6610 def SetThemeEnabled(*args, **kwargs):
6611 """
6612 SetThemeEnabled(self, bool enableTheme)
6613
6614 This function tells a window if it should use the system's "theme"
6615 code to draw the windows' background instead if its own background
6616 drawing code. This will only have an effect on platforms that support
6617 the notion of themes in user defined windows. One such platform is
6618 GTK+ where windows can have (very colourful) backgrounds defined by a
6619 user's selected theme.
6620
6621 Dialogs, notebook pages and the status bar have this flag set to true
6622 by default so that the default look and feel is simulated best.
6623 """
6624 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6625
6626 def GetThemeEnabled(*args, **kwargs):
6627 """
6628 GetThemeEnabled(self) -> bool
6629
6630 Return the themeEnabled flag.
6631 """
6632 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6633
6634 def SetFocus(*args, **kwargs):
6635 """
6636 SetFocus(self)
6637
6638 Set's the focus to this window, allowing it to receive keyboard input.
6639 """
6640 return _core_.Window_SetFocus(*args, **kwargs)
6641
6642 def SetFocusFromKbd(*args, **kwargs):
6643 """
6644 SetFocusFromKbd(self)
6645
6646 Set focus to this window as the result of a keyboard action. Normally
6647 only called internally.
6648 """
6649 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6650
6651 def FindFocus(*args, **kwargs):
6652 """
c24da6d6 6653 FindFocus() -> Window
d55e5bfc
RD
6654
6655 Returns the window or control that currently has the keyboard focus,
6656 or None.
6657 """
6658 return _core_.Window_FindFocus(*args, **kwargs)
6659
6660 FindFocus = staticmethod(FindFocus)
6661 def AcceptsFocus(*args, **kwargs):
6662 """
6663 AcceptsFocus(self) -> bool
6664
6665 Can this window have focus?
6666 """
6667 return _core_.Window_AcceptsFocus(*args, **kwargs)
6668
6669 def AcceptsFocusFromKeyboard(*args, **kwargs):
6670 """
6671 AcceptsFocusFromKeyboard(self) -> bool
6672
6673 Can this window be given focus by keyboard navigation? if not, the
6674 only way to give it focus (provided it accepts it at all) is to click
6675 it.
6676 """
6677 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6678
6679 def GetDefaultItem(*args, **kwargs):
6680 """
6681 GetDefaultItem(self) -> Window
6682
6683 Get the default child of this parent, i.e. the one which is activated
6684 by pressing <Enter> such as the OK button on a wx.Dialog.
6685 """
6686 return _core_.Window_GetDefaultItem(*args, **kwargs)
6687
6688 def SetDefaultItem(*args, **kwargs):
6689 """
6690 SetDefaultItem(self, Window child) -> Window
6691
6692 Set this child as default, return the old default.
6693 """
6694 return _core_.Window_SetDefaultItem(*args, **kwargs)
6695
6696 def SetTmpDefaultItem(*args, **kwargs):
6697 """
6698 SetTmpDefaultItem(self, Window win)
6699
6700 Set this child as temporary default
6701 """
6702 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6703
908b74cd
RD
6704 def Navigate(*args, **kwargs):
6705 """
6706 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6707
a8eff060
RD
6708 Does keyboard navigation from this window to another, by sending a
6709 `wx.NavigationKeyEvent`.
908b74cd
RD
6710 """
6711 return _core_.Window_Navigate(*args, **kwargs)
6712
bf26d883
RD
6713 def MoveAfterInTabOrder(*args, **kwargs):
6714 """
6715 MoveAfterInTabOrder(self, Window win)
6716
6717 Moves this window in the tab navigation order after the specified
6718 sibling window. This means that when the user presses the TAB key on
6719 that other window, the focus switches to this window.
6720
6721 The default tab order is the same as creation order. This function
6722 and `MoveBeforeInTabOrder` allow to change it after creating all the
6723 windows.
6724
6725 """
6726 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6727
6728 def MoveBeforeInTabOrder(*args, **kwargs):
6729 """
6730 MoveBeforeInTabOrder(self, Window win)
6731
6732 Same as `MoveAfterInTabOrder` except that it inserts this window just
6733 before win instead of putting it right after it.
6734 """
6735 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6736
d55e5bfc
RD
6737 def GetChildren(*args, **kwargs):
6738 """
6739 GetChildren(self) -> PyObject
6740
6741 Returns a list of the window's children. NOTE: Currently this is a
6742 copy of the child window list maintained by the window, so the return
6743 value of this function is only valid as long as the window's children
6744 do not change.
6745 """
6746 return _core_.Window_GetChildren(*args, **kwargs)
6747
6748 def GetParent(*args, **kwargs):
6749 """
6750 GetParent(self) -> Window
6751
6752 Returns the parent window of this window, or None if there isn't one.
6753 """
6754 return _core_.Window_GetParent(*args, **kwargs)
6755
6756 def GetGrandParent(*args, **kwargs):
6757 """
6758 GetGrandParent(self) -> Window
6759
79fccf9d
RD
6760 Returns the parent of the parent of this window, or None if there
6761 isn't one.
d55e5bfc
RD
6762 """
6763 return _core_.Window_GetGrandParent(*args, **kwargs)
6764
6765 def IsTopLevel(*args, **kwargs):
6766 """
6767 IsTopLevel(self) -> bool
6768
6769 Returns true if the given window is a top-level one. Currently all
6770 frames and dialogs are always considered to be top-level windows (even
6771 if they have a parent window).
6772 """
6773 return _core_.Window_IsTopLevel(*args, **kwargs)
6774
6775 def Reparent(*args, **kwargs):
6776 """
6777 Reparent(self, Window newParent) -> bool
6778
6779 Reparents the window, i.e the window will be removed from its current
6780 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6781 re-inserted into another. Available on Windows and GTK. Returns True
6782 if the parent was changed, False otherwise (error or newParent ==
6783 oldParent)
6784 """
6785 return _core_.Window_Reparent(*args, **kwargs)
6786
6787 def AddChild(*args, **kwargs):
6788 """
6789 AddChild(self, Window child)
6790
6791 Adds a child window. This is called automatically by window creation
6792 functions so should not be required by the application programmer.
6793 """
6794 return _core_.Window_AddChild(*args, **kwargs)
6795
6796 def RemoveChild(*args, **kwargs):
6797 """
6798 RemoveChild(self, Window child)
6799
6800 Removes a child window. This is called automatically by window
6801 deletion functions so should not be required by the application
6802 programmer.
6803 """
6804 return _core_.Window_RemoveChild(*args, **kwargs)
6805
6806 def FindWindowById(*args, **kwargs):
6807 """
6808 FindWindowById(self, long winid) -> Window
6809
6810 Find a chld of this window by window ID
6811 """
6812 return _core_.Window_FindWindowById(*args, **kwargs)
6813
6814 def FindWindowByName(*args, **kwargs):
6815 """
6816 FindWindowByName(self, String name) -> Window
6817
6818 Find a child of this window by name
6819 """
6820 return _core_.Window_FindWindowByName(*args, **kwargs)
6821
6822 def GetEventHandler(*args, **kwargs):
6823 """
6824 GetEventHandler(self) -> EvtHandler
6825
6826 Returns the event handler for this window. By default, the window is
6827 its own event handler.
6828 """
6829 return _core_.Window_GetEventHandler(*args, **kwargs)
6830
6831 def SetEventHandler(*args, **kwargs):
6832 """
6833 SetEventHandler(self, EvtHandler handler)
6834
6835 Sets the event handler for this window. An event handler is an object
6836 that is capable of processing the events sent to a window. By default,
6837 the window is its own event handler, but an application may wish to
6838 substitute another, for example to allow central implementation of
6839 event-handling for a variety of different window classes.
6840
79fccf9d 6841 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
6842 up a chain of event handlers, where an event not handled by one event
6843 handler is handed to the next one in the chain.
6844 """
6845 return _core_.Window_SetEventHandler(*args, **kwargs)
6846
6847 def PushEventHandler(*args, **kwargs):
6848 """
6849 PushEventHandler(self, EvtHandler handler)
6850
6851 Pushes this event handler onto the event handler stack for the window.
6852 An event handler is an object that is capable of processing the events
6853 sent to a window. By default, the window is its own event handler, but
6854 an application may wish to substitute another, for example to allow
6855 central implementation of event-handling for a variety of different
6856 window classes.
6857
6858 wx.Window.PushEventHandler allows an application to set up a chain of
6859 event handlers, where an event not handled by one event handler is
79fccf9d 6860 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
6861 remove the event handler.
6862 """
6863 return _core_.Window_PushEventHandler(*args, **kwargs)
6864
6865 def PopEventHandler(*args, **kwargs):
6866 """
6867 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
6868
6869 Removes and returns the top-most event handler on the event handler
6870 stack. If deleteHandler is True then the wx.EvtHandler object will be
6871 destroyed after it is popped.
6872 """
6873 return _core_.Window_PopEventHandler(*args, **kwargs)
6874
6875 def RemoveEventHandler(*args, **kwargs):
6876 """
6877 RemoveEventHandler(self, EvtHandler handler) -> bool
6878
79fccf9d
RD
6879 Find the given handler in the event handler chain and remove (but not
6880 delete) it from the event handler chain, return True if it was found
6881 and False otherwise (this also results in an assert failure so this
6882 function should only be called when the handler is supposed to be
6883 there.)
d55e5bfc
RD
6884 """
6885 return _core_.Window_RemoveEventHandler(*args, **kwargs)
6886
6887 def SetValidator(*args, **kwargs):
6888 """
6889 SetValidator(self, Validator validator)
6890
6891 Deletes the current validator (if any) and sets the window validator,
6892 having called wx.Validator.Clone to create a new validator of this
6893 type.
6894 """
6895 return _core_.Window_SetValidator(*args, **kwargs)
6896
6897 def GetValidator(*args, **kwargs):
6898 """
6899 GetValidator(self) -> Validator
6900
6901 Returns a pointer to the current validator for the window, or None if
6902 there is none.
6903 """
6904 return _core_.Window_GetValidator(*args, **kwargs)
6905
6906 def Validate(*args, **kwargs):
6907 """
6908 Validate(self) -> bool
6909
6910 Validates the current values of the child controls using their
79fccf9d
RD
6911 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6912 style flag set, the method will also call Validate() of all child
6913 windows. Returns false if any of the validations failed.
d55e5bfc
RD
6914 """
6915 return _core_.Window_Validate(*args, **kwargs)
6916
6917 def TransferDataToWindow(*args, **kwargs):
6918 """
6919 TransferDataToWindow(self) -> bool
6920
79fccf9d
RD
6921 Transfers values to child controls from data areas specified by their
6922 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6923 style flag set, the method will also call TransferDataToWindow() of
6924 all child windows.
d55e5bfc
RD
6925 """
6926 return _core_.Window_TransferDataToWindow(*args, **kwargs)
6927
6928 def TransferDataFromWindow(*args, **kwargs):
6929 """
6930 TransferDataFromWindow(self) -> bool
6931
79fccf9d
RD
6932 Transfers values from child controls to data areas specified by their
6933 validators. Returns false if a transfer failed. If the window has
6934 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6935 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
6936 """
6937 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
6938
6939 def InitDialog(*args, **kwargs):
6940 """
6941 InitDialog(self)
6942
79fccf9d
RD
6943 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6944 to the dialog via validators.
d55e5bfc
RD
6945 """
6946 return _core_.Window_InitDialog(*args, **kwargs)
6947
6948 def SetAcceleratorTable(*args, **kwargs):
6949 """
6950 SetAcceleratorTable(self, AcceleratorTable accel)
6951
6952 Sets the accelerator table for this window.
6953 """
6954 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
6955
6956 def GetAcceleratorTable(*args, **kwargs):
6957 """
6958 GetAcceleratorTable(self) -> AcceleratorTable
6959
6960 Gets the accelerator table for this window.
6961 """
6962 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
6963
6964 def RegisterHotKey(*args, **kwargs):
6965 """
6966 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
6967
6968 Registers a system wide hotkey. Every time the user presses the hotkey
6969 registered here, this window will receive a hotkey event. It will
6970 receive the event even if the application is in the background and
6971 does not have the input focus because the user is working with some
6972 other application. To bind an event handler function to this hotkey
6973 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6974 hotkey was registered successfully.
6975 """
6976 return _core_.Window_RegisterHotKey(*args, **kwargs)
6977
6978 def UnregisterHotKey(*args, **kwargs):
6979 """
6980 UnregisterHotKey(self, int hotkeyId) -> bool
6981
6982 Unregisters a system wide hotkey.
6983 """
6984 return _core_.Window_UnregisterHotKey(*args, **kwargs)
6985
6986 def ConvertDialogPointToPixels(*args, **kwargs):
6987 """
6988 ConvertDialogPointToPixels(self, Point pt) -> Point
6989
6990 Converts a point or size from dialog units to pixels. Dialog units
6991 are used for maintaining a dialog's proportions even if the font
6992 changes. For the x dimension, the dialog units are multiplied by the
6993 average character width and then divided by 4. For the y dimension,
6994 the dialog units are multiplied by the average character height and
6995 then divided by 8.
6996 """
6997 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
6998
6999 def ConvertDialogSizeToPixels(*args, **kwargs):
7000 """
7001 ConvertDialogSizeToPixels(self, Size sz) -> Size
7002
7003 Converts a point or size from dialog units to pixels. Dialog units
7004 are used for maintaining a dialog's proportions even if the font
7005 changes. For the x dimension, the dialog units are multiplied by the
7006 average character width and then divided by 4. For the y dimension,
7007 the dialog units are multiplied by the average character height and
7008 then divided by 8.
7009 """
7010 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
7011
7012 def DLG_PNT(*args, **kwargs):
7013 """
7014 DLG_PNT(self, Point pt) -> Point
7015
7016 Converts a point or size from dialog units to pixels. Dialog units
7017 are used for maintaining a dialog's proportions even if the font
7018 changes. For the x dimension, the dialog units are multiplied by the
7019 average character width and then divided by 4. For the y dimension,
7020 the dialog units are multiplied by the average character height and
7021 then divided by 8.
7022 """
7023 return _core_.Window_DLG_PNT(*args, **kwargs)
7024
7025 def DLG_SZE(*args, **kwargs):
7026 """
7027 DLG_SZE(self, Size sz) -> Size
7028
7029 Converts a point or size from dialog units to pixels. Dialog units
7030 are used for maintaining a dialog's proportions even if the font
7031 changes. For the x dimension, the dialog units are multiplied by the
7032 average character width and then divided by 4. For the y dimension,
7033 the dialog units are multiplied by the average character height and
7034 then divided by 8.
7035 """
7036 return _core_.Window_DLG_SZE(*args, **kwargs)
7037
7038 def ConvertPixelPointToDialog(*args, **kwargs):
7039 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
7040 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
7041
7042 def ConvertPixelSizeToDialog(*args, **kwargs):
7043 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
7044 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
7045
7046 def WarpPointer(*args, **kwargs):
7047 """
7048 WarpPointer(self, int x, int y)
7049
7050 Moves the pointer to the given position on the window.
7051
7052 NOTE: This function is not supported under Mac because Apple Human
7053 Interface Guidelines forbid moving the mouse cursor programmatically.
7054 """
7055 return _core_.Window_WarpPointer(*args, **kwargs)
7056
7057 def CaptureMouse(*args, **kwargs):
7058 """
7059 CaptureMouse(self)
7060
7061 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
7062 release the capture.
7063
7064 Note that wxWindows maintains the stack of windows having captured the
7065 mouse and when the mouse is released the capture returns to the window
7066 which had had captured it previously and it is only really released if
7067 there were no previous window. In particular, this means that you must
7068 release the mouse as many times as you capture it.
7069 """
7070 return _core_.Window_CaptureMouse(*args, **kwargs)
7071
7072 def ReleaseMouse(*args, **kwargs):
7073 """
7074 ReleaseMouse(self)
7075
7076 Releases mouse input captured with wx.Window.CaptureMouse.
7077 """
7078 return _core_.Window_ReleaseMouse(*args, **kwargs)
7079
7080 def GetCapture(*args, **kwargs):
7081 """
c24da6d6 7082 GetCapture() -> Window
d55e5bfc
RD
7083
7084 Returns the window which currently captures the mouse or None
7085 """
7086 return _core_.Window_GetCapture(*args, **kwargs)
7087
7088 GetCapture = staticmethod(GetCapture)
7089 def HasCapture(*args, **kwargs):
7090 """
7091 HasCapture(self) -> bool
7092
7093 Returns true if this window has the current mouse capture.
7094 """
7095 return _core_.Window_HasCapture(*args, **kwargs)
7096
7097 def Refresh(*args, **kwargs):
7098 """
7099 Refresh(self, bool eraseBackground=True, Rect rect=None)
7100
7101 Mark the specified rectangle (or the whole window) as "dirty" so it
7102 will be repainted. Causes an EVT_PAINT event to be generated and sent
7103 to the window.
7104 """
7105 return _core_.Window_Refresh(*args, **kwargs)
7106
7107 def RefreshRect(*args, **kwargs):
7108 """
fef4c27a 7109 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD
7110
7111 Redraws the contents of the given rectangle: the area inside it will
7112 be repainted. This is the same as Refresh but has a nicer syntax.
7113 """
7114 return _core_.Window_RefreshRect(*args, **kwargs)
7115
7116 def Update(*args, **kwargs):
7117 """
7118 Update(self)
7119
7120 Calling this method immediately repaints the invalidated area of the
7121 window instead of waiting for the EVT_PAINT event to happen, (normally
7122 this would usually only happen when the flow of control returns to the
7123 event loop.) Notice that this function doesn't refresh the window and
7124 does nothing if the window has been already repainted. Use Refresh
7125 first if you want to immediately redraw the window (or some portion of
7126 it) unconditionally.
7127 """
7128 return _core_.Window_Update(*args, **kwargs)
7129
7130 def ClearBackground(*args, **kwargs):
7131 """
7132 ClearBackground(self)
7133
7134 Clears the window by filling it with the current background
7135 colour. Does not cause an erase background event to be generated.
7136 """
7137 return _core_.Window_ClearBackground(*args, **kwargs)
7138
7139 def Freeze(*args, **kwargs):
7140 """
7141 Freeze(self)
7142
79fccf9d
RD
7143 Freezes the window or, in other words, prevents any updates from
7144 taking place on screen, the window is not redrawn at all. Thaw must be
7145 called to reenable window redrawing. Calls to Freeze/Thaw may be
7146 nested, with the actual Thaw being delayed until all the nesting has
7147 been undone.
d55e5bfc
RD
7148
7149 This method is useful for visual appearance optimization (for example,
7150 it is a good idea to use it before inserting large amount of text into
7151 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
7152 for all controls so it is mostly just a hint to wxWindows and not a
7153 mandatory directive.
7154 """
7155 return _core_.Window_Freeze(*args, **kwargs)
7156
7157 def Thaw(*args, **kwargs):
7158 """
7159 Thaw(self)
7160
7161 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD
7162 Freeze/Thaw may be nested, so Thaw must be called the same number of
7163 times that Freeze was before the window will be updated.
d55e5bfc
RD
7164 """
7165 return _core_.Window_Thaw(*args, **kwargs)
7166
7167 def PrepareDC(*args, **kwargs):
7168 """
7169 PrepareDC(self, DC dc)
7170
7171 Call this function to prepare the device context for drawing a
7172 scrolled image. It sets the device origin according to the current
7173 scroll position.
7174 """
7175 return _core_.Window_PrepareDC(*args, **kwargs)
7176
7177 def GetUpdateRegion(*args, **kwargs):
7178 """
7179 GetUpdateRegion(self) -> Region
7180
7181 Returns the region specifying which parts of the window have been
7182 damaged. Should only be called within an EVT_PAINT handler.
7183 """
7184 return _core_.Window_GetUpdateRegion(*args, **kwargs)
7185
7186 def GetUpdateClientRect(*args, **kwargs):
7187 """
7188 GetUpdateClientRect(self) -> Rect
7189
7190 Get the update rectangle region bounding box in client coords.
7191 """
7192 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
7193
7194 def IsExposed(*args, **kwargs):
7195 """
7196 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
7197
7198 Returns true if the given point or rectangle area has been exposed
7199 since the last repaint. Call this in an paint event handler to
7200 optimize redrawing by only redrawing those areas, which have been
7201 exposed.
7202 """
7203 return _core_.Window_IsExposed(*args, **kwargs)
7204
7205 def IsExposedPoint(*args, **kwargs):
7206 """
7207 IsExposedPoint(self, Point pt) -> bool
7208
7209 Returns true if the given point or rectangle area has been exposed
7210 since the last repaint. Call this in an paint event handler to
7211 optimize redrawing by only redrawing those areas, which have been
7212 exposed.
7213 """
7214 return _core_.Window_IsExposedPoint(*args, **kwargs)
7215
7216 def IsExposedRect(*args, **kwargs):
7217 """
7218 IsExposedRect(self, Rect rect) -> bool
7219
7220 Returns true if the given point or rectangle area has been exposed
7221 since the last repaint. Call this in an paint event handler to
7222 optimize redrawing by only redrawing those areas, which have been
7223 exposed.
7224 """
7225 return _core_.Window_IsExposedRect(*args, **kwargs)
7226
7227 def GetDefaultAttributes(*args, **kwargs):
7228 """
7229 GetDefaultAttributes(self) -> VisualAttributes
7230
79fccf9d
RD
7231 Get the default attributes for an instance of this class. This is
7232 useful if you want to use the same font or colour in your own control
7233 as in a standard control -- which is a much better idea than hard
7234 coding specific colours or fonts which might look completely out of
caef1a4d 7235 place on the user's system, especially if it uses themes.
d55e5bfc
RD
7236 """
7237 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
7238
7239 def GetClassDefaultAttributes(*args, **kwargs):
7240 """
c24da6d6 7241 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 7242
79fccf9d
RD
7243 Get the default attributes for this class. This is useful if you want
7244 to use the same font or colour in your own control as in a standard
7245 control -- which is a much better idea than hard coding specific
caef1a4d
RD
7246 colours or fonts which might look completely out of place on the
7247 user's system, especially if it uses themes.
d55e5bfc
RD
7248
7249 The variant parameter is only relevant under Mac currently and is
79fccf9d 7250 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
7251 the returned font. See `wx.Window.SetWindowVariant` for more about
7252 this.
d55e5bfc
RD
7253 """
7254 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7255
7256 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
7257 def SetBackgroundColour(*args, **kwargs):
7258 """
7259 SetBackgroundColour(self, Colour colour) -> bool
7260
7261 Sets the background colour of the window. Returns True if the colour
7262 was changed. The background colour is usually painted by the default
7263 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
7264 automatically under GTK. Using `wx.NullColour` will reset the window
7265 to the default background colour.
d55e5bfc 7266
caef1a4d 7267 Note that setting the background colour may not cause an immediate
f8167d6e 7268 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
7269 calling this function.
7270
f8167d6e
RD
7271 Using this function will disable attempts to use themes for this
7272 window, if the system supports them. Use with care since usually the
7273 themes represent the appearance chosen by the user to be used for all
7274 applications on the system.
d55e5bfc
RD
7275 """
7276 return _core_.Window_SetBackgroundColour(*args, **kwargs)
7277
412d302d
RD
7278 def SetOwnBackgroundColour(*args, **kwargs):
7279 """SetOwnBackgroundColour(self, Colour colour)"""
7280 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD
7281
7282 def SetForegroundColour(*args, **kwargs):
7283 """
7284 SetForegroundColour(self, Colour colour) -> bool
7285
7286 Sets the foreground colour of the window. Returns True is the colour
7287 was changed. The interpretation of foreground colour is dependent on
7288 the window class; it may be the text colour or other colour, or it may
7289 not be used at all.
7290 """
7291 return _core_.Window_SetForegroundColour(*args, **kwargs)
7292
fa47d7a7
VS
7293 def SetOwnForegroundColour(*args, **kwargs):
7294 """SetOwnForegroundColour(self, Colour colour)"""
7295 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
7296
7297 def GetBackgroundColour(*args, **kwargs):
7298 """
7299 GetBackgroundColour(self) -> Colour
7300
7301 Returns the background colour of the window.
7302 """
7303 return _core_.Window_GetBackgroundColour(*args, **kwargs)
7304
7305 def GetForegroundColour(*args, **kwargs):
7306 """
7307 GetForegroundColour(self) -> Colour
7308
7309 Returns the foreground colour of the window. The interpretation of
7310 foreground colour is dependent on the window class; it may be the text
7311 colour or other colour, or it may not be used at all.
7312 """
7313 return _core_.Window_GetForegroundColour(*args, **kwargs)
7314
0f63ec68
RD
7315 def SetBackgroundStyle(*args, **kwargs):
7316 """
7317 SetBackgroundStyle(self, int style) -> bool
7318
7319 Returns the background style of the window. The background style
7320 indicates how the background of the window is drawn.
7321
7322 ====================== ========================================
7323 wx.BG_STYLE_SYSTEM The background colour or pattern should
7324 be determined by the system
7325 wx.BG_STYLE_COLOUR The background should be a solid colour
7326 wx.BG_STYLE_CUSTOM The background will be implemented by the
7327 application.
7328 ====================== ========================================
7329
7330 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7331 a custom background, such as a tiled bitmap. Currently the style has
7332 no effect on other platforms.
7333
7334 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7335 """
7336 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7337
7338 def GetBackgroundStyle(*args, **kwargs):
7339 """
7340 GetBackgroundStyle(self) -> int
7341
7342 Returns the background style of the window.
7343
7344 :see: `SetBackgroundStyle`
7345 """
7346 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7347
51b83b37
RD
7348 def HasTransparentBackground(*args, **kwargs):
7349 """
7350 HasTransparentBackground(self) -> bool
7351
7352 Returns True if this window's background is transparent (as, for
7353 example, for `wx.StaticText`) and should show the parent window's
7354 background.
7355
7356 This method is mostly used internally by the library itself and you
7357 normally shouldn't have to call it. You may, however, have to override
7358 it in your custom control classes to ensure that background is painted
7359 correctly.
7360 """
7361 return _core_.Window_HasTransparentBackground(*args, **kwargs)
7362
d55e5bfc
RD
7363 def SetCursor(*args, **kwargs):
7364 """
7365 SetCursor(self, Cursor cursor) -> bool
7366
7367 Sets the window's cursor. Notice that the window cursor also sets it
7368 for the children of the window implicitly.
7369
7370 The cursor may be wx.NullCursor in which case the window cursor will
7371 be reset back to default.
7372 """
7373 return _core_.Window_SetCursor(*args, **kwargs)
7374
7375 def GetCursor(*args, **kwargs):
7376 """
7377 GetCursor(self) -> Cursor
7378
7379 Return the cursor associated with this window.
7380 """
7381 return _core_.Window_GetCursor(*args, **kwargs)
7382
7383 def SetFont(*args, **kwargs):
7384 """
7385 SetFont(self, Font font) -> bool
7386
7387 Sets the font for this window.
7388 """
7389 return _core_.Window_SetFont(*args, **kwargs)
7390
fa47d7a7
VS
7391 def SetOwnFont(*args, **kwargs):
7392 """SetOwnFont(self, Font font)"""
7393 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
7394
7395 def GetFont(*args, **kwargs):
7396 """
7397 GetFont(self) -> Font
7398
7399 Returns the default font used for this window.
7400 """
7401 return _core_.Window_GetFont(*args, **kwargs)
7402
7403 def SetCaret(*args, **kwargs):
7404 """
7405 SetCaret(self, Caret caret)
7406
7407 Sets the caret associated with the window.
7408 """
7409 return _core_.Window_SetCaret(*args, **kwargs)
7410
7411 def GetCaret(*args, **kwargs):
7412 """
7413 GetCaret(self) -> Caret
7414
7415 Returns the caret associated with the window.
7416 """
7417 return _core_.Window_GetCaret(*args, **kwargs)
7418
7419 def GetCharHeight(*args, **kwargs):
7420 """
7421 GetCharHeight(self) -> int
7422
7423 Get the (average) character size for the current font.
7424 """
7425 return _core_.Window_GetCharHeight(*args, **kwargs)
7426
7427 def GetCharWidth(*args, **kwargs):
7428 """
7429 GetCharWidth(self) -> int
7430
7431 Get the (average) character size for the current font.
7432 """
7433 return _core_.Window_GetCharWidth(*args, **kwargs)
7434
7435 def GetTextExtent(*args, **kwargs):
a8eff060
RD
7436 """
7437 GetTextExtent(String string) -> (width, height)
7438
7439 Get the width and height of the text using the current font.
7440 """
d55e5bfc
RD
7441 return _core_.Window_GetTextExtent(*args, **kwargs)
7442
7443 def GetFullTextExtent(*args, **kwargs):
7444 """
7445 GetFullTextExtent(String string, Font font=None) ->
7446 (width, height, descent, externalLeading)
7447
7448 Get the width, height, decent and leading of the text using the
7449 current or specified font.
7450 """
7451 return _core_.Window_GetFullTextExtent(*args, **kwargs)
7452
7453 def ClientToScreenXY(*args, **kwargs):
7454 """
7455 ClientToScreenXY(int x, int y) -> (x,y)
7456
7457 Converts to screen coordinates from coordinates relative to this window.
7458 """
7459 return _core_.Window_ClientToScreenXY(*args, **kwargs)
7460
7461 def ScreenToClientXY(*args, **kwargs):
7462 """
7463 ScreenToClientXY(int x, int y) -> (x,y)
7464
7465 Converts from screen to client window coordinates.
7466 """
7467 return _core_.Window_ScreenToClientXY(*args, **kwargs)
7468
7469 def ClientToScreen(*args, **kwargs):
7470 """
7471 ClientToScreen(self, Point pt) -> Point
7472
7473 Converts to screen coordinates from coordinates relative to this window.
7474 """
7475 return _core_.Window_ClientToScreen(*args, **kwargs)
7476
7477 def ScreenToClient(*args, **kwargs):
7478 """
7479 ScreenToClient(self, Point pt) -> Point
7480
7481 Converts from screen to client window coordinates.
7482 """
7483 return _core_.Window_ScreenToClient(*args, **kwargs)
7484
7485 def HitTestXY(*args, **kwargs):
7486 """
7487 HitTestXY(self, int x, int y) -> int
7488
7489 Test where the given (in client coords) point lies
7490 """
7491 return _core_.Window_HitTestXY(*args, **kwargs)
7492
7493 def HitTest(*args, **kwargs):
7494 """
7495 HitTest(self, Point pt) -> int
7496
7497 Test where the given (in client coords) point lies
7498 """
7499 return _core_.Window_HitTest(*args, **kwargs)
7500
7501 def GetBorder(*args):
7502 """
7503 GetBorder(self, long flags) -> int
7504 GetBorder(self) -> int
7505
7506 Get border for the flags of this window
7507 """
7508 return _core_.Window_GetBorder(*args)
7509
7510 def UpdateWindowUI(*args, **kwargs):
7511 """
7512 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
7513
7514 This function sends EVT_UPDATE_UI events to the window. The particular
7515 implementation depends on the window; for example a wx.ToolBar will
7516 send an update UI event for each toolbar button, and a wx.Frame will
7517 send an update UI event for each menubar menu item. You can call this
7518 function from your application to ensure that your UI is up-to-date at
7519 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7520 concerned). This may be necessary if you have called
7521 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7522 limit the overhead that wxWindows incurs by sending update UI events
7523 in idle time.
d55e5bfc
RD
7524 """
7525 return _core_.Window_UpdateWindowUI(*args, **kwargs)
7526
7527 def PopupMenuXY(*args, **kwargs):
7528 """
7a0b95b0 7529 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7530
7a0b95b0
RD
7531 Pops up the given menu at the specified coordinates, relative to this window,
7532 and returns control when the user has dismissed the menu. If a menu item is
7533 selected, the corresponding menu event is generated and will be processed as
7534 usual. If the default position is given then the current position of the
7535 mouse cursor will be used.
d55e5bfc
RD
7536 """
7537 return _core_.Window_PopupMenuXY(*args, **kwargs)
7538
7539 def PopupMenu(*args, **kwargs):
7540 """
7a0b95b0 7541 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7542
7a0b95b0
RD
7543 Pops up the given menu at the specified coordinates, relative to this window,
7544 and returns control when the user has dismissed the menu. If a menu item is
7545 selected, the corresponding menu event is generated and will be processed as
7546 usual. If the default position is given then the current position of the
7547 mouse cursor will be used.
d55e5bfc
RD
7548 """
7549 return _core_.Window_PopupMenu(*args, **kwargs)
7550
7551 def GetHandle(*args, **kwargs):
7552 """
7553 GetHandle(self) -> long
7554
7555 Returns the platform-specific handle (as a long integer) of the
7556 physical window. Currently on wxMac it returns the handle of the
7557 toplevel parent of the window.
7558 """
7559 return _core_.Window_GetHandle(*args, **kwargs)
7560
629e65c2
RD
7561 def AssociateHandle(*args, **kwargs):
7562 """
7563 AssociateHandle(self, long handle)
7564
7565 Associate the window with a new native handle
7566 """
7567 return _core_.Window_AssociateHandle(*args, **kwargs)
7568
7569 def DissociateHandle(*args, **kwargs):
7570 """
7571 DissociateHandle(self)
7572
7573 Dissociate the current native handle from the window
7574 """
7575 return _core_.Window_DissociateHandle(*args, **kwargs)
7576
d55e5bfc
RD
7577 def OnPaint(*args, **kwargs):
7578 """OnPaint(self, PaintEvent event)"""
7579 return _core_.Window_OnPaint(*args, **kwargs)
7580
7581 def HasScrollbar(*args, **kwargs):
7582 """
7583 HasScrollbar(self, int orient) -> bool
7584
7585 Does the window have the scrollbar for this orientation?
7586 """
7587 return _core_.Window_HasScrollbar(*args, **kwargs)
7588
7589 def SetScrollbar(*args, **kwargs):
7590 """
79fccf9d 7591 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
7592 bool refresh=True)
7593
7594 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
7595 """
7596 return _core_.Window_SetScrollbar(*args, **kwargs)
7597
7598 def SetScrollPos(*args, **kwargs):
7599 """
7600 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7601
7602 Sets the position of one of the built-in scrollbars.
7603 """
7604 return _core_.Window_SetScrollPos(*args, **kwargs)
7605
7606 def GetScrollPos(*args, **kwargs):
7607 """
7608 GetScrollPos(self, int orientation) -> int
7609
7610 Returns the built-in scrollbar position.
7611 """
7612 return _core_.Window_GetScrollPos(*args, **kwargs)
7613
7614 def GetScrollThumb(*args, **kwargs):
7615 """
7616 GetScrollThumb(self, int orientation) -> int
7617
7618 Returns the built-in scrollbar thumb size.
7619 """
7620 return _core_.Window_GetScrollThumb(*args, **kwargs)
7621
7622 def GetScrollRange(*args, **kwargs):
7623 """
7624 GetScrollRange(self, int orientation) -> int
7625
7626 Returns the built-in scrollbar range.
7627 """
7628 return _core_.Window_GetScrollRange(*args, **kwargs)
7629
7630 def ScrollWindow(*args, **kwargs):
7631 """
7632 ScrollWindow(self, int dx, int dy, Rect rect=None)
7633
7634 Physically scrolls the pixels in the window and move child windows
7635 accordingly. Use this function to optimise your scrolling
7636 implementations, to minimise the area that must be redrawn. Note that
7637 it is rarely required to call this function from a user program.
d55e5bfc
RD
7638 """
7639 return _core_.Window_ScrollWindow(*args, **kwargs)
7640
7641 def ScrollLines(*args, **kwargs):
7642 """
7643 ScrollLines(self, int lines) -> bool
7644
7645 If the platform and window class supports it, scrolls the window by
7646 the given number of lines down, if lines is positive, or up if lines
7647 is negative. Returns True if the window was scrolled, False if it was
7648 already on top/bottom and nothing was done.
7649 """
7650 return _core_.Window_ScrollLines(*args, **kwargs)
7651
7652 def ScrollPages(*args, **kwargs):
7653 """
7654 ScrollPages(self, int pages) -> bool
7655
79fccf9d 7656 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
7657 the given number of pages down, if pages is positive, or up if pages
7658 is negative. Returns True if the window was scrolled, False if it was
7659 already on top/bottom and nothing was done.
7660 """
7661 return _core_.Window_ScrollPages(*args, **kwargs)
7662
7663 def LineUp(*args, **kwargs):
7664 """
7665 LineUp(self) -> bool
7666
7667 This is just a wrapper for ScrollLines(-1).
7668 """
7669 return _core_.Window_LineUp(*args, **kwargs)
7670
7671 def LineDown(*args, **kwargs):
7672 """
7673 LineDown(self) -> bool
7674
7675 This is just a wrapper for ScrollLines(1).
7676 """
7677 return _core_.Window_LineDown(*args, **kwargs)
7678
7679 def PageUp(*args, **kwargs):
7680 """
7681 PageUp(self) -> bool
7682
7683 This is just a wrapper for ScrollPages(-1).
7684 """
7685 return _core_.Window_PageUp(*args, **kwargs)
7686
7687 def PageDown(*args, **kwargs):
7688 """
7689 PageDown(self) -> bool
7690
7691 This is just a wrapper for ScrollPages(1).
7692 """
7693 return _core_.Window_PageDown(*args, **kwargs)
7694
7695 def SetHelpText(*args, **kwargs):
7696 """
7697 SetHelpText(self, String text)
7698
7699 Sets the help text to be used as context-sensitive help for this
7700 window. Note that the text is actually stored by the current
7701 wxHelpProvider implementation, and not in the window object itself.
7702 """
7703 return _core_.Window_SetHelpText(*args, **kwargs)
7704
7705 def SetHelpTextForId(*args, **kwargs):
7706 """
7707 SetHelpTextForId(self, String text)
7708
7709 Associate this help text with all windows with the same id as this
7710 one.
7711 """
7712 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7713
7714 def GetHelpText(*args, **kwargs):
7715 """
7716 GetHelpText(self) -> String
7717
7718 Gets the help text to be used as context-sensitive help for this
7719 window. Note that the text is actually stored by the current
7720 wxHelpProvider implementation, and not in the window object itself.
7721 """
7722 return _core_.Window_GetHelpText(*args, **kwargs)
7723
7724 def SetToolTipString(*args, **kwargs):
7725 """
7726 SetToolTipString(self, String tip)
7727
7728 Attach a tooltip to the window.
7729 """
7730 return _core_.Window_SetToolTipString(*args, **kwargs)
7731
7732 def SetToolTip(*args, **kwargs):
7733 """
7734 SetToolTip(self, ToolTip tip)
7735
7736 Attach a tooltip to the window.
7737 """
7738 return _core_.Window_SetToolTip(*args, **kwargs)
7739
7740 def GetToolTip(*args, **kwargs):
7741 """
7742 GetToolTip(self) -> ToolTip
7743
7744 get the associated tooltip or None if none
7745 """
7746 return _core_.Window_GetToolTip(*args, **kwargs)
7747
7748 def SetDropTarget(*args, **kwargs):
7749 """
7750 SetDropTarget(self, DropTarget dropTarget)
7751
7752 Associates a drop target with this window. If the window already has
7753 a drop target, it is deleted.
7754 """
7755 return _core_.Window_SetDropTarget(*args, **kwargs)
7756
7757 def GetDropTarget(*args, **kwargs):
7758 """
7759 GetDropTarget(self) -> DropTarget
7760
7761 Returns the associated drop target, which may be None.
7762 """
7763 return _core_.Window_GetDropTarget(*args, **kwargs)
7764
7765 def DragAcceptFiles(*args, **kwargs):
7766 """
7767 DragAcceptFiles(self, bool accept)
7768
7769 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
7770 Only available on Windows.
7771 """
7772 return _core_.Window_DragAcceptFiles(*args, **kwargs)
7773
7774 def SetConstraints(*args, **kwargs):
7775 """
7776 SetConstraints(self, LayoutConstraints constraints)
7777
7778 Sets the window to have the given layout constraints. If an existing
7779 layout constraints object is already owned by the window, it will be
7780 deleted. Pass None to disassociate and delete the window's current
7781 constraints.
7782
7783 You must call SetAutoLayout to tell a window to use the constraints
7784 automatically in its default EVT_SIZE handler; otherwise, you must
7785 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7786 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7787 effect.
7788 """
7789 return _core_.Window_SetConstraints(*args, **kwargs)
7790
7791 def GetConstraints(*args, **kwargs):
7792 """
7793 GetConstraints(self) -> LayoutConstraints
7794
7795 Returns a pointer to the window's layout constraints, or None if there
7796 are none.
7797 """
7798 return _core_.Window_GetConstraints(*args, **kwargs)
7799
7800 def SetAutoLayout(*args, **kwargs):
7801 """
7802 SetAutoLayout(self, bool autoLayout)
7803
7804 Determines whether the Layout function will be called automatically
7805 when the window is resized. It is called implicitly by SetSizer but
7806 if you use SetConstraints you should call it manually or otherwise the
7807 window layout won't be correctly updated when its size changes.
7808 """
7809 return _core_.Window_SetAutoLayout(*args, **kwargs)
7810
7811 def GetAutoLayout(*args, **kwargs):
7812 """
7813 GetAutoLayout(self) -> bool
7814
7815 Returns the current autoLayout setting
7816 """
7817 return _core_.Window_GetAutoLayout(*args, **kwargs)
7818
7819 def Layout(*args, **kwargs):
7820 """
7821 Layout(self) -> bool
7822
7823 Invokes the constraint-based layout algorithm or the sizer-based
7824 algorithm for this window. See SetAutoLayout: when auto layout is on,
7825 this function gets called automatically by the default EVT_SIZE
7826 handler when the window is resized.
7827 """
7828 return _core_.Window_Layout(*args, **kwargs)
7829
7830 def SetSizer(*args, **kwargs):
7831 """
7832 SetSizer(self, Sizer sizer, bool deleteOld=True)
7833
7834 Sets the window to have the given layout sizer. The window will then
7835 own the object, and will take care of its deletion. If an existing
7836 layout sizer object is already owned by the window, it will be deleted
7837 if the deleteOld parameter is true. Note that this function will also
7838 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 7839 non-None, and False otherwise.
d55e5bfc
RD
7840 """
7841 return _core_.Window_SetSizer(*args, **kwargs)
7842
7843 def SetSizerAndFit(*args, **kwargs):
7844 """
7845 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7846
7847 The same as SetSizer, except it also sets the size hints for the
7848 window based on the sizer's minimum size.
7849 """
7850 return _core_.Window_SetSizerAndFit(*args, **kwargs)
7851
7852 def GetSizer(*args, **kwargs):
7853 """
7854 GetSizer(self) -> Sizer
7855
7856 Return the sizer associated with the window by a previous call to
7857 SetSizer or None if there isn't one.
7858 """
7859 return _core_.Window_GetSizer(*args, **kwargs)
7860
7861 def SetContainingSizer(*args, **kwargs):
7862 """
7863 SetContainingSizer(self, Sizer sizer)
7864
7865 This normally does not need to be called by application code. It is
7866 called internally when a window is added to a sizer, and is used so
7867 the window can remove itself from the sizer when it is destroyed.
7868 """
7869 return _core_.Window_SetContainingSizer(*args, **kwargs)
7870
7871 def GetContainingSizer(*args, **kwargs):
7872 """
7873 GetContainingSizer(self) -> Sizer
7874
7875 Return the sizer that this window is a member of, if any, otherwise None.
7876 """
7877 return _core_.Window_GetContainingSizer(*args, **kwargs)
7878
7879 def InheritAttributes(*args, **kwargs):
7880 """
7881 InheritAttributes(self)
7882
79fccf9d
RD
7883 This function is (or should be, in case of custom controls) called
7884 during window creation to intelligently set up the window visual
7885 attributes, that is the font and the foreground and background
7886 colours.
7887
7888 By 'intelligently' the following is meant: by default, all windows use
7889 their own default attributes. However if some of the parent's
7890 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7891 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD
7892 explicitly set for this window itself, then this window takes the same
7893 value as used by the parent. In addition, if the window overrides
7894 ShouldInheritColours to return false, the colours will not be changed
7895 no matter what and only the font might.
7896
ec9b55ca
RD
7897 This rather complicated logic is necessary in order to accommodate the
7898 different usage scenarios. The most common one is when all default
79fccf9d
RD
7899 attributes are used and in this case, nothing should be inherited as
7900 in modern GUIs different controls use different fonts (and colours)
7901 than their siblings so they can't inherit the same value from the
7902 parent. However it was also deemed desirable to allow to simply change
7903 the attributes of all children at once by just changing the font or
7904 colour of their common parent, hence in this case we do inherit the
7905 parents attributes.
7906
d55e5bfc
RD
7907 """
7908 return _core_.Window_InheritAttributes(*args, **kwargs)
7909
7910 def ShouldInheritColours(*args, **kwargs):
7911 """
7912 ShouldInheritColours(self) -> bool
7913
7914 Return true from here to allow the colours of this window to be
79fccf9d
RD
7915 changed by InheritAttributes, returning false forbids inheriting them
7916 from the parent window.
d55e5bfc 7917
79fccf9d
RD
7918 The base class version returns false, but this method is overridden in
7919 wxControl where it returns true.
d55e5bfc
RD
7920 """
7921 return _core_.Window_ShouldInheritColours(*args, **kwargs)
7922
7923 def PostCreate(self, pre):
7924 """
7925 Phase 3 of the 2-phase create <wink!>
7926 Call this method after precreating the window with the 2-phase create method.
7927 """
7928 self.this = pre.this
7929 self.thisown = pre.thisown
7930 pre.thisown = 0
7931 if hasattr(self, '_setOORInfo'):
7932 self._setOORInfo(self)
7933 if hasattr(self, '_setCallbackInfo'):
7934 self._setCallbackInfo(self, self.__class__)
7935
7936
7937class WindowPtr(Window):
7938 def __init__(self, this):
7939 self.this = this
7940 if not hasattr(self,"thisown"): self.thisown = 0
7941 self.__class__ = Window
7942_core_.Window_swigregister(WindowPtr)
7943
7944def PreWindow(*args, **kwargs):
7945 """
7946 PreWindow() -> Window
7947
7948 Precreate a Window for 2-phase creation.
7949 """
7950 val = _core_.new_PreWindow(*args, **kwargs)
7951 val.thisown = 1
7952 return val
7953
7954def Window_NewControlId(*args, **kwargs):
7955 """
7956 Window_NewControlId() -> int
7957
7958 Generate a control id for the controls which were not given one.
7959 """
7960 return _core_.Window_NewControlId(*args, **kwargs)
7961
7962def Window_NextControlId(*args, **kwargs):
7963 """
7964 Window_NextControlId(int winid) -> int
7965
7966 Get the id of the control following the one with the given
79fccf9d 7967 autogenerated) id
d55e5bfc
RD
7968 """
7969 return _core_.Window_NextControlId(*args, **kwargs)
7970
7971def Window_PrevControlId(*args, **kwargs):
7972 """
7973 Window_PrevControlId(int winid) -> int
7974
7975 Get the id of the control preceding the one with the given
79fccf9d 7976 autogenerated) id
d55e5bfc
RD
7977 """
7978 return _core_.Window_PrevControlId(*args, **kwargs)
7979
7980def Window_FindFocus(*args, **kwargs):
7981 """
7982 Window_FindFocus() -> Window
7983
7984 Returns the window or control that currently has the keyboard focus,
7985 or None.
7986 """
7987 return _core_.Window_FindFocus(*args, **kwargs)
7988
7989def Window_GetCapture(*args, **kwargs):
7990 """
7991 Window_GetCapture() -> Window
7992
7993 Returns the window which currently captures the mouse or None
7994 """
7995 return _core_.Window_GetCapture(*args, **kwargs)
7996
7997def Window_GetClassDefaultAttributes(*args, **kwargs):
7998 """
7999 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8000
79fccf9d
RD
8001 Get the default attributes for this class. This is useful if you want
8002 to use the same font or colour in your own control as in a standard
8003 control -- which is a much better idea than hard coding specific
caef1a4d
RD
8004 colours or fonts which might look completely out of place on the
8005 user's system, especially if it uses themes.
d55e5bfc
RD
8006
8007 The variant parameter is only relevant under Mac currently and is
79fccf9d 8008 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
8009 the returned font. See `wx.Window.SetWindowVariant` for more about
8010 this.
d55e5bfc
RD
8011 """
8012 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
8013
8014def DLG_PNT(win, point_or_x, y=None):
8015 """
8016 Convenience function for converting a Point or (x,y) in
8017 dialog units to pixel units.
8018 """
8019 if y is None:
8020 return win.ConvertDialogPointToPixels(point_or_x)
8021 else:
8022 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
8023
8024def DLG_SZE(win, size_width, height=None):
8025 """
8026 Convenience function for converting a Size or (w,h) in
8027 dialog units to pixel units.
8028 """
8029 if height is None:
8030 return win.ConvertDialogSizeToPixels(size_width)
8031 else:
8032 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
8033
8034
8035def FindWindowById(*args, **kwargs):
8036 """
8037 FindWindowById(long id, Window parent=None) -> Window
8038
8039 Find the first window in the application with the given id. If parent
8040 is None, the search will start from all top-level frames and dialog
8041 boxes; if non-None, the search will be limited to the given window
8042 hierarchy. The search is recursive in both cases.
8043 """
8044 return _core_.FindWindowById(*args, **kwargs)
8045
8046def FindWindowByName(*args, **kwargs):
8047 """
8048 FindWindowByName(String name, Window parent=None) -> Window
8049
8050 Find a window by its name (as given in a window constructor or Create
8051 function call). If parent is None, the search will start from all
8052 top-level frames and dialog boxes; if non-None, the search will be
8053 limited to the given window hierarchy. The search is recursive in both
8054 cases.
8055
8056 If no window with such name is found, wx.FindWindowByLabel is called.
8057 """
8058 return _core_.FindWindowByName(*args, **kwargs)
8059
8060def FindWindowByLabel(*args, **kwargs):
8061 """
8062 FindWindowByLabel(String label, Window parent=None) -> Window
8063
8064 Find a window by its label. Depending on the type of window, the label
8065 may be a window title or panel item label. If parent is None, the
8066 search will start from all top-level frames and dialog boxes; if
8067 non-None, the search will be limited to the given window
8068 hierarchy. The search is recursive in both cases.
8069 """
8070 return _core_.FindWindowByLabel(*args, **kwargs)
8071
8072def Window_FromHWND(*args, **kwargs):
8073 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
8074 return _core_.Window_FromHWND(*args, **kwargs)
8075#---------------------------------------------------------------------------
8076
8077class Validator(EvtHandler):
093d3ff1 8078 """Proxy of C++ Validator class"""
d55e5bfc
RD
8079 def __repr__(self):
8080 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8081 def __init__(self, *args, **kwargs):
8082 """__init__(self) -> Validator"""
8083 newobj = _core_.new_Validator(*args, **kwargs)
8084 self.this = newobj.this
8085 self.thisown = 1
8086 del newobj.thisown
8087 self._setOORInfo(self)
8088
8089 def Clone(*args, **kwargs):
8090 """Clone(self) -> Validator"""
8091 return _core_.Validator_Clone(*args, **kwargs)
8092
8093 def Validate(*args, **kwargs):
8094 """Validate(self, Window parent) -> bool"""
8095 return _core_.Validator_Validate(*args, **kwargs)
8096
8097 def TransferToWindow(*args, **kwargs):
8098 """TransferToWindow(self) -> bool"""
8099 return _core_.Validator_TransferToWindow(*args, **kwargs)
8100
8101 def TransferFromWindow(*args, **kwargs):
8102 """TransferFromWindow(self) -> bool"""
8103 return _core_.Validator_TransferFromWindow(*args, **kwargs)
8104
8105 def GetWindow(*args, **kwargs):
8106 """GetWindow(self) -> Window"""
8107 return _core_.Validator_GetWindow(*args, **kwargs)
8108
8109 def SetWindow(*args, **kwargs):
8110 """SetWindow(self, Window window)"""
8111 return _core_.Validator_SetWindow(*args, **kwargs)
8112
8113 def IsSilent(*args, **kwargs):
c24da6d6 8114 """IsSilent() -> bool"""
d55e5bfc
RD
8115 return _core_.Validator_IsSilent(*args, **kwargs)
8116
8117 IsSilent = staticmethod(IsSilent)
8118 def SetBellOnError(*args, **kwargs):
c24da6d6 8119 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
8120 return _core_.Validator_SetBellOnError(*args, **kwargs)
8121
8122 SetBellOnError = staticmethod(SetBellOnError)
8123
8124class ValidatorPtr(Validator):
8125 def __init__(self, this):
8126 self.this = this
8127 if not hasattr(self,"thisown"): self.thisown = 0
8128 self.__class__ = Validator
8129_core_.Validator_swigregister(ValidatorPtr)
8130
8131def Validator_IsSilent(*args, **kwargs):
8132 """Validator_IsSilent() -> bool"""
8133 return _core_.Validator_IsSilent(*args, **kwargs)
8134
8135def Validator_SetBellOnError(*args, **kwargs):
8136 """Validator_SetBellOnError(int doIt=True)"""
8137 return _core_.Validator_SetBellOnError(*args, **kwargs)
8138
8139class PyValidator(Validator):
093d3ff1 8140 """Proxy of C++ PyValidator class"""
d55e5bfc
RD
8141 def __repr__(self):
8142 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8143 def __init__(self, *args, **kwargs):
8144 """__init__(self) -> PyValidator"""
8145 newobj = _core_.new_PyValidator(*args, **kwargs)
8146 self.this = newobj.this
8147 self.thisown = 1
8148 del newobj.thisown
8149
8150 self._setCallbackInfo(self, PyValidator, 1)
8151 self._setOORInfo(self)
8152
8153 def _setCallbackInfo(*args, **kwargs):
8154 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
8155 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
8156
8157
8158class PyValidatorPtr(PyValidator):
8159 def __init__(self, this):
8160 self.this = this
8161 if not hasattr(self,"thisown"): self.thisown = 0
8162 self.__class__ = PyValidator
8163_core_.PyValidator_swigregister(PyValidatorPtr)
8164
8165#---------------------------------------------------------------------------
8166
8167class Menu(EvtHandler):
093d3ff1 8168 """Proxy of C++ Menu class"""
d55e5bfc
RD
8169 def __repr__(self):
8170 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8171 def __init__(self, *args, **kwargs):
8172 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
8173 newobj = _core_.new_Menu(*args, **kwargs)
8174 self.this = newobj.this
8175 self.thisown = 1
8176 del newobj.thisown
8177 self._setOORInfo(self)
8178
8179 def Append(*args, **kwargs):
8180 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8181 return _core_.Menu_Append(*args, **kwargs)
8182
8183 def AppendSeparator(*args, **kwargs):
8184 """AppendSeparator(self) -> MenuItem"""
8185 return _core_.Menu_AppendSeparator(*args, **kwargs)
8186
8187 def AppendCheckItem(*args, **kwargs):
8188 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8189 return _core_.Menu_AppendCheckItem(*args, **kwargs)
8190
8191 def AppendRadioItem(*args, **kwargs):
8192 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8193 return _core_.Menu_AppendRadioItem(*args, **kwargs)
8194
8195 def AppendMenu(*args, **kwargs):
8196 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8197 return _core_.Menu_AppendMenu(*args, **kwargs)
8198
8199 def AppendItem(*args, **kwargs):
8200 """AppendItem(self, MenuItem item) -> MenuItem"""
8201 return _core_.Menu_AppendItem(*args, **kwargs)
8202
8203 def Break(*args, **kwargs):
8204 """Break(self)"""
8205 return _core_.Menu_Break(*args, **kwargs)
8206
8207 def InsertItem(*args, **kwargs):
8208 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
8209 return _core_.Menu_InsertItem(*args, **kwargs)
8210
8211 def Insert(*args, **kwargs):
8212 """
8213 Insert(self, size_t pos, int id, String text, String help=EmptyString,
8214 int kind=ITEM_NORMAL) -> MenuItem
8215 """
8216 return _core_.Menu_Insert(*args, **kwargs)
8217
8218 def InsertSeparator(*args, **kwargs):
8219 """InsertSeparator(self, size_t pos) -> MenuItem"""
8220 return _core_.Menu_InsertSeparator(*args, **kwargs)
8221
8222 def InsertCheckItem(*args, **kwargs):
8223 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8224 return _core_.Menu_InsertCheckItem(*args, **kwargs)
8225
8226 def InsertRadioItem(*args, **kwargs):
8227 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8228 return _core_.Menu_InsertRadioItem(*args, **kwargs)
8229
8230 def InsertMenu(*args, **kwargs):
8231 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8232 return _core_.Menu_InsertMenu(*args, **kwargs)
8233
8234 def PrependItem(*args, **kwargs):
8235 """PrependItem(self, MenuItem item) -> MenuItem"""
8236 return _core_.Menu_PrependItem(*args, **kwargs)
8237
8238 def Prepend(*args, **kwargs):
8239 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8240 return _core_.Menu_Prepend(*args, **kwargs)
8241
8242 def PrependSeparator(*args, **kwargs):
8243 """PrependSeparator(self) -> MenuItem"""
8244 return _core_.Menu_PrependSeparator(*args, **kwargs)
8245
8246 def PrependCheckItem(*args, **kwargs):
8247 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8248 return _core_.Menu_PrependCheckItem(*args, **kwargs)
8249
8250 def PrependRadioItem(*args, **kwargs):
8251 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8252 return _core_.Menu_PrependRadioItem(*args, **kwargs)
8253
8254 def PrependMenu(*args, **kwargs):
8255 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8256 return _core_.Menu_PrependMenu(*args, **kwargs)
8257
8258 def Remove(*args, **kwargs):
8259 """Remove(self, int id) -> MenuItem"""
8260 return _core_.Menu_Remove(*args, **kwargs)
8261
8262 def RemoveItem(*args, **kwargs):
8263 """RemoveItem(self, MenuItem item) -> MenuItem"""
8264 return _core_.Menu_RemoveItem(*args, **kwargs)
8265
8266 def Delete(*args, **kwargs):
8267 """Delete(self, int id) -> bool"""
8268 return _core_.Menu_Delete(*args, **kwargs)
8269
8270 def DeleteItem(*args, **kwargs):
8271 """DeleteItem(self, MenuItem item) -> bool"""
8272 return _core_.Menu_DeleteItem(*args, **kwargs)
8273
8274 def Destroy(*args, **kwargs):
8275 """
8276 Destroy(self)
8277
8278 Deletes the C++ object this Python object is a proxy for.
8279 """
8280 return _core_.Menu_Destroy(*args, **kwargs)
8281
8282 def DestroyId(*args, **kwargs):
8283 """
8284 DestroyId(self, int id) -> bool
8285
8286 Deletes the C++ object this Python object is a proxy for.
8287 """
8288 return _core_.Menu_DestroyId(*args, **kwargs)
8289
8290 def DestroyItem(*args, **kwargs):
8291 """
8292 DestroyItem(self, MenuItem item) -> bool
8293
8294 Deletes the C++ object this Python object is a proxy for.
8295 """
8296 return _core_.Menu_DestroyItem(*args, **kwargs)
8297
8298 def GetMenuItemCount(*args, **kwargs):
8299 """GetMenuItemCount(self) -> size_t"""
8300 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
8301
8302 def GetMenuItems(*args, **kwargs):
8303 """GetMenuItems(self) -> PyObject"""
8304 return _core_.Menu_GetMenuItems(*args, **kwargs)
8305
8306 def FindItem(*args, **kwargs):
8307 """FindItem(self, String item) -> int"""
8308 return _core_.Menu_FindItem(*args, **kwargs)
8309
8310 def FindItemById(*args, **kwargs):
8311 """FindItemById(self, int id) -> MenuItem"""
8312 return _core_.Menu_FindItemById(*args, **kwargs)
8313
8314 def FindItemByPosition(*args, **kwargs):
8315 """FindItemByPosition(self, size_t position) -> MenuItem"""
8316 return _core_.Menu_FindItemByPosition(*args, **kwargs)
8317
8318 def Enable(*args, **kwargs):
8319 """Enable(self, int id, bool enable)"""
8320 return _core_.Menu_Enable(*args, **kwargs)
8321
8322 def IsEnabled(*args, **kwargs):
8323 """IsEnabled(self, int id) -> bool"""
8324 return _core_.Menu_IsEnabled(*args, **kwargs)
8325
8326 def Check(*args, **kwargs):
8327 """Check(self, int id, bool check)"""
8328 return _core_.Menu_Check(*args, **kwargs)
8329
8330 def IsChecked(*args, **kwargs):
8331 """IsChecked(self, int id) -> bool"""
8332 return _core_.Menu_IsChecked(*args, **kwargs)
8333
8334 def SetLabel(*args, **kwargs):
8335 """SetLabel(self, int id, String label)"""
8336 return _core_.Menu_SetLabel(*args, **kwargs)
8337
8338 def GetLabel(*args, **kwargs):
8339 """GetLabel(self, int id) -> String"""
8340 return _core_.Menu_GetLabel(*args, **kwargs)
8341
8342 def SetHelpString(*args, **kwargs):
8343 """SetHelpString(self, int id, String helpString)"""
8344 return _core_.Menu_SetHelpString(*args, **kwargs)
8345
8346 def GetHelpString(*args, **kwargs):
8347 """GetHelpString(self, int id) -> String"""
8348 return _core_.Menu_GetHelpString(*args, **kwargs)
8349
8350 def SetTitle(*args, **kwargs):
8351 """SetTitle(self, String title)"""
8352 return _core_.Menu_SetTitle(*args, **kwargs)
8353
8354 def GetTitle(*args, **kwargs):
8355 """GetTitle(self) -> String"""
8356 return _core_.Menu_GetTitle(*args, **kwargs)
8357
8358 def SetEventHandler(*args, **kwargs):
8359 """SetEventHandler(self, EvtHandler handler)"""
8360 return _core_.Menu_SetEventHandler(*args, **kwargs)
8361
8362 def GetEventHandler(*args, **kwargs):
8363 """GetEventHandler(self) -> EvtHandler"""
8364 return _core_.Menu_GetEventHandler(*args, **kwargs)
8365
8366 def SetInvokingWindow(*args, **kwargs):
8367 """SetInvokingWindow(self, Window win)"""
8368 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
8369
8370 def GetInvokingWindow(*args, **kwargs):
8371 """GetInvokingWindow(self) -> Window"""
8372 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
8373
8374 def GetStyle(*args, **kwargs):
8375 """GetStyle(self) -> long"""
8376 return _core_.Menu_GetStyle(*args, **kwargs)
8377
8378 def UpdateUI(*args, **kwargs):
8379 """UpdateUI(self, EvtHandler source=None)"""
8380 return _core_.Menu_UpdateUI(*args, **kwargs)
8381
8382 def GetMenuBar(*args, **kwargs):
8383 """GetMenuBar(self) -> MenuBar"""
8384 return _core_.Menu_GetMenuBar(*args, **kwargs)
8385
8386 def Attach(*args, **kwargs):
8387 """Attach(self, wxMenuBarBase menubar)"""
8388 return _core_.Menu_Attach(*args, **kwargs)
8389
8390 def Detach(*args, **kwargs):
8391 """Detach(self)"""
8392 return _core_.Menu_Detach(*args, **kwargs)
8393
8394 def IsAttached(*args, **kwargs):
8395 """IsAttached(self) -> bool"""
8396 return _core_.Menu_IsAttached(*args, **kwargs)
8397
8398 def SetParent(*args, **kwargs):
8399 """SetParent(self, Menu parent)"""
8400 return _core_.Menu_SetParent(*args, **kwargs)
8401
8402 def GetParent(*args, **kwargs):
8403 """GetParent(self) -> Menu"""
8404 return _core_.Menu_GetParent(*args, **kwargs)
8405
8406
8407class MenuPtr(Menu):
8408 def __init__(self, this):
8409 self.this = this
8410 if not hasattr(self,"thisown"): self.thisown = 0
8411 self.__class__ = Menu
8412_core_.Menu_swigregister(MenuPtr)
8413DefaultValidator = cvar.DefaultValidator
8414
8415#---------------------------------------------------------------------------
8416
8417class MenuBar(Window):
093d3ff1 8418 """Proxy of C++ MenuBar class"""
d55e5bfc
RD
8419 def __repr__(self):
8420 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8421 def __init__(self, *args, **kwargs):
8422 """__init__(self, long style=0) -> MenuBar"""
8423 newobj = _core_.new_MenuBar(*args, **kwargs)
8424 self.this = newobj.this
8425 self.thisown = 1
8426 del newobj.thisown
8427 self._setOORInfo(self)
8428
8429 def Append(*args, **kwargs):
8430 """Append(self, Menu menu, String title) -> bool"""
8431 return _core_.MenuBar_Append(*args, **kwargs)
8432
8433 def Insert(*args, **kwargs):
8434 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
8435 return _core_.MenuBar_Insert(*args, **kwargs)
8436
8437 def GetMenuCount(*args, **kwargs):
8438 """GetMenuCount(self) -> size_t"""
8439 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
8440
8441 def GetMenu(*args, **kwargs):
8442 """GetMenu(self, size_t pos) -> Menu"""
8443 return _core_.MenuBar_GetMenu(*args, **kwargs)
8444
8445 def Replace(*args, **kwargs):
8446 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
8447 return _core_.MenuBar_Replace(*args, **kwargs)
8448
8449 def Remove(*args, **kwargs):
8450 """Remove(self, size_t pos) -> Menu"""
8451 return _core_.MenuBar_Remove(*args, **kwargs)
8452
8453 def EnableTop(*args, **kwargs):
8454 """EnableTop(self, size_t pos, bool enable)"""
8455 return _core_.MenuBar_EnableTop(*args, **kwargs)
8456
8457 def IsEnabledTop(*args, **kwargs):
8458 """IsEnabledTop(self, size_t pos) -> bool"""
8459 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
8460
8461 def SetLabelTop(*args, **kwargs):
8462 """SetLabelTop(self, size_t pos, String label)"""
8463 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
8464
8465 def GetLabelTop(*args, **kwargs):
8466 """GetLabelTop(self, size_t pos) -> String"""
8467 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
8468
8469 def FindMenuItem(*args, **kwargs):
8470 """FindMenuItem(self, String menu, String item) -> int"""
8471 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
8472
8473 def FindItemById(*args, **kwargs):
8474 """FindItemById(self, int id) -> MenuItem"""
8475 return _core_.MenuBar_FindItemById(*args, **kwargs)
8476
8477 def FindMenu(*args, **kwargs):
8478 """FindMenu(self, String title) -> int"""
8479 return _core_.MenuBar_FindMenu(*args, **kwargs)
8480
8481 def Enable(*args, **kwargs):
8482 """Enable(self, int id, bool enable)"""
8483 return _core_.MenuBar_Enable(*args, **kwargs)
8484
8485 def Check(*args, **kwargs):
8486 """Check(self, int id, bool check)"""
8487 return _core_.MenuBar_Check(*args, **kwargs)
8488
8489 def IsChecked(*args, **kwargs):
8490 """IsChecked(self, int id) -> bool"""
8491 return _core_.MenuBar_IsChecked(*args, **kwargs)
8492
8493 def IsEnabled(*args, **kwargs):
8494 """IsEnabled(self, int id) -> bool"""
8495 return _core_.MenuBar_IsEnabled(*args, **kwargs)
8496
8497 def SetLabel(*args, **kwargs):
8498 """SetLabel(self, int id, String label)"""
8499 return _core_.MenuBar_SetLabel(*args, **kwargs)
8500
8501 def GetLabel(*args, **kwargs):
8502 """GetLabel(self, int id) -> String"""
8503 return _core_.MenuBar_GetLabel(*args, **kwargs)
8504
8505 def SetHelpString(*args, **kwargs):
8506 """SetHelpString(self, int id, String helpString)"""
8507 return _core_.MenuBar_SetHelpString(*args, **kwargs)
8508
8509 def GetHelpString(*args, **kwargs):
8510 """GetHelpString(self, int id) -> String"""
8511 return _core_.MenuBar_GetHelpString(*args, **kwargs)
8512
8513 def GetFrame(*args, **kwargs):
8514 """GetFrame(self) -> wxFrame"""
8515 return _core_.MenuBar_GetFrame(*args, **kwargs)
8516
8517 def IsAttached(*args, **kwargs):
8518 """IsAttached(self) -> bool"""
8519 return _core_.MenuBar_IsAttached(*args, **kwargs)
8520
8521 def Attach(*args, **kwargs):
8522 """Attach(self, wxFrame frame)"""
8523 return _core_.MenuBar_Attach(*args, **kwargs)
8524
8525 def Detach(*args, **kwargs):
8526 """Detach(self)"""
8527 return _core_.MenuBar_Detach(*args, **kwargs)
8528
8529
8530class MenuBarPtr(MenuBar):
8531 def __init__(self, this):
8532 self.this = this
8533 if not hasattr(self,"thisown"): self.thisown = 0
8534 self.__class__ = MenuBar
8535_core_.MenuBar_swigregister(MenuBarPtr)
8536
8537#---------------------------------------------------------------------------
8538
8539class MenuItem(Object):
093d3ff1 8540 """Proxy of C++ MenuItem class"""
d55e5bfc
RD
8541 def __repr__(self):
8542 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8543 def __init__(self, *args, **kwargs):
8544 """
8545 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
8546 String help=EmptyString, int kind=ITEM_NORMAL,
8547 Menu subMenu=None) -> MenuItem
8548 """
8549 newobj = _core_.new_MenuItem(*args, **kwargs)
8550 self.this = newobj.this
8551 self.thisown = 1
8552 del newobj.thisown
8553 def GetMenu(*args, **kwargs):
8554 """GetMenu(self) -> Menu"""
8555 return _core_.MenuItem_GetMenu(*args, **kwargs)
8556
8557 def SetMenu(*args, **kwargs):
8558 """SetMenu(self, Menu menu)"""
8559 return _core_.MenuItem_SetMenu(*args, **kwargs)
8560
8561 def SetId(*args, **kwargs):
8562 """SetId(self, int id)"""
8563 return _core_.MenuItem_SetId(*args, **kwargs)
8564
8565 def GetId(*args, **kwargs):
8566 """GetId(self) -> int"""
8567 return _core_.MenuItem_GetId(*args, **kwargs)
8568
8569 def IsSeparator(*args, **kwargs):
8570 """IsSeparator(self) -> bool"""
8571 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8572
8573 def SetText(*args, **kwargs):
8574 """SetText(self, String str)"""
8575 return _core_.MenuItem_SetText(*args, **kwargs)
8576
8577 def GetLabel(*args, **kwargs):
8578 """GetLabel(self) -> String"""
8579 return _core_.MenuItem_GetLabel(*args, **kwargs)
8580
8581 def GetText(*args, **kwargs):
8582 """GetText(self) -> String"""
8583 return _core_.MenuItem_GetText(*args, **kwargs)
8584
8585 def GetLabelFromText(*args, **kwargs):
c24da6d6 8586 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
8587 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8588
8589 GetLabelFromText = staticmethod(GetLabelFromText)
8590 def GetKind(*args, **kwargs):
8591 """GetKind(self) -> int"""
8592 return _core_.MenuItem_GetKind(*args, **kwargs)
8593
8594 def SetKind(*args, **kwargs):
8595 """SetKind(self, int kind)"""
8596 return _core_.MenuItem_SetKind(*args, **kwargs)
8597
8598 def SetCheckable(*args, **kwargs):
8599 """SetCheckable(self, bool checkable)"""
8600 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8601
8602 def IsCheckable(*args, **kwargs):
8603 """IsCheckable(self) -> bool"""
8604 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8605
8606 def IsSubMenu(*args, **kwargs):
8607 """IsSubMenu(self) -> bool"""
8608 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8609
8610 def SetSubMenu(*args, **kwargs):
8611 """SetSubMenu(self, Menu menu)"""
8612 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8613
8614 def GetSubMenu(*args, **kwargs):
8615 """GetSubMenu(self) -> Menu"""
8616 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8617
8618 def Enable(*args, **kwargs):
8619 """Enable(self, bool enable=True)"""
8620 return _core_.MenuItem_Enable(*args, **kwargs)
8621
8622 def IsEnabled(*args, **kwargs):
8623 """IsEnabled(self) -> bool"""
8624 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8625
8626 def Check(*args, **kwargs):
8627 """Check(self, bool check=True)"""
8628 return _core_.MenuItem_Check(*args, **kwargs)
8629
8630 def IsChecked(*args, **kwargs):
8631 """IsChecked(self) -> bool"""
8632 return _core_.MenuItem_IsChecked(*args, **kwargs)
8633
8634 def Toggle(*args, **kwargs):
8635 """Toggle(self)"""
8636 return _core_.MenuItem_Toggle(*args, **kwargs)
8637
8638 def SetHelp(*args, **kwargs):
8639 """SetHelp(self, String str)"""
8640 return _core_.MenuItem_SetHelp(*args, **kwargs)
8641
8642 def GetHelp(*args, **kwargs):
8643 """GetHelp(self) -> String"""
8644 return _core_.MenuItem_GetHelp(*args, **kwargs)
8645
8646 def GetAccel(*args, **kwargs):
8647 """GetAccel(self) -> AcceleratorEntry"""
8648 return _core_.MenuItem_GetAccel(*args, **kwargs)
8649
8650 def SetAccel(*args, **kwargs):
8651 """SetAccel(self, AcceleratorEntry accel)"""
8652 return _core_.MenuItem_SetAccel(*args, **kwargs)
8653
8654 def SetFont(*args, **kwargs):
8655 """SetFont(self, Font font)"""
8656 return _core_.MenuItem_SetFont(*args, **kwargs)
8657
8658 def GetFont(*args, **kwargs):
8659 """GetFont(self) -> Font"""
8660 return _core_.MenuItem_GetFont(*args, **kwargs)
8661
8662 def SetTextColour(*args, **kwargs):
8663 """SetTextColour(self, Colour colText)"""
8664 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8665
8666 def GetTextColour(*args, **kwargs):
8667 """GetTextColour(self) -> Colour"""
8668 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8669
8670 def SetBackgroundColour(*args, **kwargs):
8671 """SetBackgroundColour(self, Colour colBack)"""
8672 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8673
8674 def GetBackgroundColour(*args, **kwargs):
8675 """GetBackgroundColour(self) -> Colour"""
8676 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8677
8678 def SetBitmaps(*args, **kwargs):
8679 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8680 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8681
8682 def SetDisabledBitmap(*args, **kwargs):
8683 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8684 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8685
8686 def GetDisabledBitmap(*args, **kwargs):
8687 """GetDisabledBitmap(self) -> Bitmap"""
8688 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8689
8690 def SetMarginWidth(*args, **kwargs):
8691 """SetMarginWidth(self, int nWidth)"""
8692 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8693
8694 def GetMarginWidth(*args, **kwargs):
8695 """GetMarginWidth(self) -> int"""
8696 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8697
8698 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 8699 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
8700 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8701
8702 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8703 def IsOwnerDrawn(*args, **kwargs):
8704 """IsOwnerDrawn(self) -> bool"""
8705 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8706
8707 def SetOwnerDrawn(*args, **kwargs):
8708 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8709 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8710
8711 def ResetOwnerDrawn(*args, **kwargs):
8712 """ResetOwnerDrawn(self)"""
8713 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8714
8715 def SetBitmap(*args, **kwargs):
8716 """SetBitmap(self, Bitmap bitmap)"""
8717 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8718
8719 def GetBitmap(*args, **kwargs):
8720 """GetBitmap(self) -> Bitmap"""
8721 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8722
8723
8724class MenuItemPtr(MenuItem):
8725 def __init__(self, this):
8726 self.this = this
8727 if not hasattr(self,"thisown"): self.thisown = 0
8728 self.__class__ = MenuItem
8729_core_.MenuItem_swigregister(MenuItemPtr)
8730
8731def MenuItem_GetLabelFromText(*args, **kwargs):
8732 """MenuItem_GetLabelFromText(String text) -> String"""
8733 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8734
8735def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8736 """MenuItem_GetDefaultMarginWidth() -> int"""
8737 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8738
8739#---------------------------------------------------------------------------
8740
8741class Control(Window):
8742 """
8743 This is the base class for a control or 'widget'.
8744
79fccf9d
RD
8745 A control is generally a small window which processes user input
8746 and/or displays one or more item of data.
d55e5bfc
RD
8747 """
8748 def __repr__(self):
8749 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8750 def __init__(self, *args, **kwargs):
8751 """
248ed943
RD
8752 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8753 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8754 String name=ControlNameStr) -> Control
8755
79fccf9d
RD
8756 Create a Control. Normally you should only call this from a subclass'
8757 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
8758 """
8759 newobj = _core_.new_Control(*args, **kwargs)
8760 self.this = newobj.this
8761 self.thisown = 1
8762 del newobj.thisown
8763 self._setOORInfo(self)
8764
8765 def Create(*args, **kwargs):
8766 """
248ed943
RD
8767 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8768 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8769 String name=ControlNameStr) -> bool
8770
8771 Do the 2nd phase and create the GUI control.
8772 """
8773 return _core_.Control_Create(*args, **kwargs)
8774
8775 def Command(*args, **kwargs):
8776 """
8777 Command(self, CommandEvent event)
8778
79fccf9d
RD
8779 Simulates the effect of the user issuing a command to the item.
8780
8781 :see: `wx.CommandEvent`
8782
d55e5bfc
RD
8783 """
8784 return _core_.Control_Command(*args, **kwargs)
8785
8786 def GetLabel(*args, **kwargs):
8787 """
8788 GetLabel(self) -> String
8789
8790 Return a control's text.
8791 """
8792 return _core_.Control_GetLabel(*args, **kwargs)
8793
8794 def SetLabel(*args, **kwargs):
8795 """
8796 SetLabel(self, String label)
8797
8798 Sets the item's text.
8799 """
8800 return _core_.Control_SetLabel(*args, **kwargs)
8801
a001823c 8802 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 8803 """
a001823c 8804 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 8805
a001823c
RD
8806 Get the default attributes for this class. This is useful if you want
8807 to use the same font or colour in your own control as in a standard
8808 control -- which is a much better idea than hard coding specific
8809 colours or fonts which might look completely out of place on the
8810 user's system, especially if it uses themes.
f8167d6e 8811
a001823c
RD
8812 The variant parameter is only relevant under Mac currently and is
8813 ignore under other platforms. Under Mac, it will change the size of
8814 the returned font. See `wx.Window.SetWindowVariant` for more about
8815 this.
f8167d6e 8816 """
d55e5bfc
RD
8817 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8818
8819 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8820
8821class ControlPtr(Control):
8822 def __init__(self, this):
8823 self.this = this
8824 if not hasattr(self,"thisown"): self.thisown = 0
8825 self.__class__ = Control
8826_core_.Control_swigregister(ControlPtr)
8827ControlNameStr = cvar.ControlNameStr
8828
8829def PreControl(*args, **kwargs):
8830 """
8831 PreControl() -> Control
8832
8833 Precreate a Control control for 2-phase creation
8834 """
8835 val = _core_.new_PreControl(*args, **kwargs)
8836 val.thisown = 1
8837 return val
8838
8839def Control_GetClassDefaultAttributes(*args, **kwargs):
a001823c
RD
8840 """
8841 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8842
8843 Get the default attributes for this class. This is useful if you want
8844 to use the same font or colour in your own control as in a standard
8845 control -- which is a much better idea than hard coding specific
8846 colours or fonts which might look completely out of place on the
8847 user's system, especially if it uses themes.
8848
8849 The variant parameter is only relevant under Mac currently and is
8850 ignore under other platforms. Under Mac, it will change the size of
8851 the returned font. See `wx.Window.SetWindowVariant` for more about
8852 this.
8853 """
d55e5bfc
RD
8854 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8855
8856#---------------------------------------------------------------------------
8857
8858class ItemContainer(object):
8859 """
8860 wx.ItemContainer defines an interface which is implemented by all
79fccf9d
RD
8861 controls which have string subitems, each of which may be selected,
8862 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8863 `wx.ComboBox` which implements an extended interface deriving from
8864 this one.
d55e5bfc 8865
79fccf9d
RD
8866 It defines the methods for accessing the control's items and although
8867 each of the derived classes implements them differently, they still
8868 all conform to the same interface.
d55e5bfc 8869
79fccf9d
RD
8870 The items in a wx.ItemContainer have (non empty) string labels and,
8871 optionally, client data associated with them.
d55e5bfc
RD
8872
8873 """
8874 def __init__(self): raise RuntimeError, "No constructor defined"
8875 def __repr__(self):
8876 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8877 def Append(*args, **kwargs):
8878 """
8879 Append(self, String item, PyObject clientData=None) -> int
8880
79fccf9d
RD
8881 Adds the item to the control, associating the given data with the item
8882 if not None. The return value is the index of the newly added item
8883 which may be different from the last one if the control is sorted (e.g.
8884 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
8885 """
8886 return _core_.ItemContainer_Append(*args, **kwargs)
8887
8888 def AppendItems(*args, **kwargs):
8889 """
f5b96ee1 8890 AppendItems(self, List strings)
d55e5bfc 8891
79fccf9d
RD
8892 Apend several items at once to the control. Notice that calling this
8893 method may be much faster than appending the items one by one if you
8894 need to add a lot of items.
d55e5bfc
RD
8895 """
8896 return _core_.ItemContainer_AppendItems(*args, **kwargs)
8897
8898 def Insert(*args, **kwargs):
8899 """
8900 Insert(self, String item, int pos, PyObject clientData=None) -> int
8901
79fccf9d 8902 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
8903 optionally associating some data object with the item.
8904 """
8905 return _core_.ItemContainer_Insert(*args, **kwargs)
8906
8907 def Clear(*args, **kwargs):
8908 """
8909 Clear(self)
8910
8911 Removes all items from the control.
8912 """
8913 return _core_.ItemContainer_Clear(*args, **kwargs)
8914
8915 def Delete(*args, **kwargs):
8916 """
8917 Delete(self, int n)
8918
79fccf9d
RD
8919 Deletes the item at the zero-based index 'n' from the control. Note
8920 that it is an error (signalled by a `wx.PyAssertionError` exception if
8921 enabled) to remove an item with the index negative or greater or equal
8922 than the number of items in the control.
d55e5bfc
RD
8923 """
8924 return _core_.ItemContainer_Delete(*args, **kwargs)
8925
8926 def GetCount(*args, **kwargs):
8927 """
8928 GetCount(self) -> int
8929
8930 Returns the number of items in the control.
8931 """
8932 return _core_.ItemContainer_GetCount(*args, **kwargs)
8933
8934 def IsEmpty(*args, **kwargs):
8935 """
8936 IsEmpty(self) -> bool
8937
8938 Returns True if the control is empty or False if it has some items.
8939 """
8940 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
8941
8942 def GetString(*args, **kwargs):
8943 """
8944 GetString(self, int n) -> String
8945
8946 Returns the label of the item with the given index.
8947 """
8948 return _core_.ItemContainer_GetString(*args, **kwargs)
8949
8950 def GetStrings(*args, **kwargs):
8951 """GetStrings(self) -> wxArrayString"""
8952 return _core_.ItemContainer_GetStrings(*args, **kwargs)
8953
8954 def SetString(*args, **kwargs):
8955 """
8956 SetString(self, int n, String s)
8957
8958 Sets the label for the given item.
8959 """
8960 return _core_.ItemContainer_SetString(*args, **kwargs)
8961
8962 def FindString(*args, **kwargs):
8963 """
8964 FindString(self, String s) -> int
8965
8966 Finds an item whose label matches the given string. Returns the
79fccf9d
RD
8967 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8968 found.
d55e5bfc
RD
8969 """
8970 return _core_.ItemContainer_FindString(*args, **kwargs)
8971
8972 def Select(*args, **kwargs):
8973 """
8974 Select(self, int n)
8975
8976 Sets the item at index 'n' to be the selected item.
8977 """
8978 return _core_.ItemContainer_Select(*args, **kwargs)
8979
8980 SetSelection = Select
8981 def GetSelection(*args, **kwargs):
8982 """
8983 GetSelection(self) -> int
8984
79fccf9d
RD
8985 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8986 is selected.
d55e5bfc
RD
8987 """
8988 return _core_.ItemContainer_GetSelection(*args, **kwargs)
8989
8990 def GetStringSelection(*args, **kwargs):
8991 """
8992 GetStringSelection(self) -> String
8993
79fccf9d
RD
8994 Returns the label of the selected item or an empty string if no item
8995 is selected.
d55e5bfc
RD
8996 """
8997 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
8998
8999 def GetClientData(*args, **kwargs):
9000 """
9001 GetClientData(self, int n) -> PyObject
9002
9003 Returns the client data associated with the given item, (if any.)
9004 """
9005 return _core_.ItemContainer_GetClientData(*args, **kwargs)
9006
9007 def SetClientData(*args, **kwargs):
9008 """
9009 SetClientData(self, int n, PyObject clientData)
9010
9011 Associate the given client data with the item at position n.
9012 """
9013 return _core_.ItemContainer_SetClientData(*args, **kwargs)
9014
9015
9016class ItemContainerPtr(ItemContainer):
9017 def __init__(self, this):
9018 self.this = this
9019 if not hasattr(self,"thisown"): self.thisown = 0
9020 self.__class__ = ItemContainer
9021_core_.ItemContainer_swigregister(ItemContainerPtr)
9022
9023#---------------------------------------------------------------------------
9024
9025class ControlWithItems(Control,ItemContainer):
9026 """
79fccf9d
RD
9027 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
9028 wx.Control class, and is used for the base class of various controls
9029 that have items.
d55e5bfc
RD
9030 """
9031 def __init__(self): raise RuntimeError, "No constructor defined"
9032 def __repr__(self):
9033 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9034
9035class ControlWithItemsPtr(ControlWithItems):
9036 def __init__(self, this):
9037 self.this = this
9038 if not hasattr(self,"thisown"): self.thisown = 0
9039 self.__class__ = ControlWithItems
9040_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
9041
9042#---------------------------------------------------------------------------
9043
9044class SizerItem(Object):
248ed943
RD
9045 """
9046 The wx.SizerItem class is used to track the position, size and other
9047 attributes of each item managed by a `wx.Sizer`. In normal usage user
9048 code should never need to deal directly with a wx.SizerItem, but
9049 custom classes derived from `wx.PySizer` will probably need to use the
9050 collection of wx.SizerItems held by wx.Sizer when calculating layout.
9051
9052 :see: `wx.Sizer`, `wx.GBSizerItem`
9053 """
d55e5bfc
RD
9054 def __repr__(self):
9055 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9056 def __init__(self, *args, **kwargs):
248ed943
RD
9057 """
9058 __init__(self) -> SizerItem
9059
9060 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
9061 size will need to be set before this item can be used in a Sizer.
9062
9063 You will probably never need to create a wx.SizerItem directly as they
9064 are created automatically when the sizer's Add, Insert or Prepend
9065 methods are called.
9066
9067 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
9068 """
d55e5bfc
RD
9069 newobj = _core_.new_SizerItem(*args, **kwargs)
9070 self.this = newobj.this
9071 self.thisown = 1
9072 del newobj.thisown
9073 def DeleteWindows(*args, **kwargs):
248ed943
RD
9074 """
9075 DeleteWindows(self)
9076
9077 Destroy the window or the windows in a subsizer, depending on the type
9078 of item.
9079 """
d55e5bfc
RD
9080 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
9081
9082 def DetachSizer(*args, **kwargs):
248ed943
RD
9083 """
9084 DetachSizer(self)
9085
9086 Enable deleting the SizerItem without destroying the contained sizer.
9087 """
d55e5bfc
RD
9088 return _core_.SizerItem_DetachSizer(*args, **kwargs)
9089
9090 def GetSize(*args, **kwargs):
248ed943
RD
9091 """
9092 GetSize(self) -> Size
9093
9094 Get the current size of the item, as set in the last Layout.
9095 """
d55e5bfc
RD
9096 return _core_.SizerItem_GetSize(*args, **kwargs)
9097
9098 def CalcMin(*args, **kwargs):
248ed943
RD
9099 """
9100 CalcMin(self) -> Size
9101
9102 Calculates the minimum desired size for the item, including any space
9103 needed by borders.
9104 """
d55e5bfc
RD
9105 return _core_.SizerItem_CalcMin(*args, **kwargs)
9106
9107 def SetDimension(*args, **kwargs):
248ed943
RD
9108 """
9109 SetDimension(self, Point pos, Size size)
9110
9111 Set the position and size of the space allocated for this item by the
9112 sizer, and adjust the position and size of the item (window or
9113 subsizer) to be within that space taking alignment and borders into
9114 account.
9115 """
d55e5bfc
RD
9116 return _core_.SizerItem_SetDimension(*args, **kwargs)
9117
9118 def GetMinSize(*args, **kwargs):
248ed943
RD
9119 """
9120 GetMinSize(self) -> Size
9121
9122 Get the minimum size needed for the item.
9123 """
d55e5bfc
RD
9124 return _core_.SizerItem_GetMinSize(*args, **kwargs)
9125
a001823c
RD
9126 def GetMinSizeWithBorder(*args, **kwargs):
9127 """
9128 GetMinSizeWithBorder(self) -> Size
9129
9130 Get the minimum size needed for the item with space for the borders
9131 added, if needed.
9132 """
9133 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
9134
d55e5bfc
RD
9135 def SetInitSize(*args, **kwargs):
9136 """SetInitSize(self, int x, int y)"""
9137 return _core_.SizerItem_SetInitSize(*args, **kwargs)
9138
9139 def SetRatioWH(*args, **kwargs):
248ed943
RD
9140 """
9141 SetRatioWH(self, int width, int height)
9142
9143 Set the ratio item attribute.
9144 """
d55e5bfc
RD
9145 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
9146
9147 def SetRatioSize(*args, **kwargs):
248ed943
RD
9148 """
9149 SetRatioSize(self, Size size)
9150
9151 Set the ratio item attribute.
9152 """
d55e5bfc
RD
9153 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
9154
9155 def SetRatio(*args, **kwargs):
248ed943
RD
9156 """
9157 SetRatio(self, float ratio)
9158
9159 Set the ratio item attribute.
9160 """
d55e5bfc
RD
9161 return _core_.SizerItem_SetRatio(*args, **kwargs)
9162
9163 def GetRatio(*args, **kwargs):
248ed943
RD
9164 """
9165 GetRatio(self) -> float
9166
9167 Set the ratio item attribute.
9168 """
d55e5bfc
RD
9169 return _core_.SizerItem_GetRatio(*args, **kwargs)
9170
c1cb24a4
RD
9171 def GetRect(*args, **kwargs):
9172 """
9173 GetRect(self) -> Rect
9174
9175 Returns the rectangle that the sizer item should occupy
9176 """
9177 return _core_.SizerItem_GetRect(*args, **kwargs)
9178
d55e5bfc 9179 def IsWindow(*args, **kwargs):
248ed943
RD
9180 """
9181 IsWindow(self) -> bool
9182
9183 Is this sizer item a window?
9184 """
d55e5bfc
RD
9185 return _core_.SizerItem_IsWindow(*args, **kwargs)
9186
9187 def IsSizer(*args, **kwargs):
248ed943
RD
9188 """
9189 IsSizer(self) -> bool
9190
9191 Is this sizer item a subsizer?
9192 """
d55e5bfc
RD
9193 return _core_.SizerItem_IsSizer(*args, **kwargs)
9194
9195 def IsSpacer(*args, **kwargs):
248ed943
RD
9196 """
9197 IsSpacer(self) -> bool
9198
9199 Is this sizer item a spacer?
9200 """
d55e5bfc
RD
9201 return _core_.SizerItem_IsSpacer(*args, **kwargs)
9202
9203 def SetProportion(*args, **kwargs):
248ed943
RD
9204 """
9205 SetProportion(self, int proportion)
9206
9207 Set the proportion value for this item.
9208 """
d55e5bfc
RD
9209 return _core_.SizerItem_SetProportion(*args, **kwargs)
9210
9211 def GetProportion(*args, **kwargs):
248ed943
RD
9212 """
9213 GetProportion(self) -> int
9214
9215 Get the proportion value for this item.
9216 """
d55e5bfc
RD
9217 return _core_.SizerItem_GetProportion(*args, **kwargs)
9218
248ed943
RD
9219 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9220 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 9221 def SetFlag(*args, **kwargs):
248ed943
RD
9222 """
9223 SetFlag(self, int flag)
9224
9225 Set the flag value for this item.
9226 """
d55e5bfc
RD
9227 return _core_.SizerItem_SetFlag(*args, **kwargs)
9228
9229 def GetFlag(*args, **kwargs):
248ed943
RD
9230 """
9231 GetFlag(self) -> int
9232
9233 Get the flag value for this item.
9234 """
d55e5bfc
RD
9235 return _core_.SizerItem_GetFlag(*args, **kwargs)
9236
9237 def SetBorder(*args, **kwargs):
248ed943
RD
9238 """
9239 SetBorder(self, int border)
9240
9241 Set the border value for this item.
9242 """
d55e5bfc
RD
9243 return _core_.SizerItem_SetBorder(*args, **kwargs)
9244
9245 def GetBorder(*args, **kwargs):
248ed943
RD
9246 """
9247 GetBorder(self) -> int
9248
9249 Get the border value for this item.
9250 """
d55e5bfc
RD
9251 return _core_.SizerItem_GetBorder(*args, **kwargs)
9252
9253 def GetWindow(*args, **kwargs):
248ed943
RD
9254 """
9255 GetWindow(self) -> Window
9256
9257 Get the window (if any) that is managed by this sizer item.
9258 """
d55e5bfc
RD
9259 return _core_.SizerItem_GetWindow(*args, **kwargs)
9260
9261 def SetWindow(*args, **kwargs):
248ed943
RD
9262 """
9263 SetWindow(self, Window window)
9264
9265 Set the window to be managed by this sizer item.
9266 """
d55e5bfc
RD
9267 return _core_.SizerItem_SetWindow(*args, **kwargs)
9268
9269 def GetSizer(*args, **kwargs):
248ed943
RD
9270 """
9271 GetSizer(self) -> Sizer
9272
9273 Get the subsizer (if any) that is managed by this sizer item.
9274 """
d55e5bfc
RD
9275 return _core_.SizerItem_GetSizer(*args, **kwargs)
9276
9277 def SetSizer(*args, **kwargs):
248ed943
RD
9278 """
9279 SetSizer(self, Sizer sizer)
9280
9281 Set the subsizer to be managed by this sizer item.
9282 """
d55e5bfc
RD
9283 return _core_.SizerItem_SetSizer(*args, **kwargs)
9284
9285 def GetSpacer(*args, **kwargs):
248ed943
RD
9286 """
9287 GetSpacer(self) -> Size
9288
9289 Get the size of the spacer managed by this sizer item.
9290 """
d55e5bfc
RD
9291 return _core_.SizerItem_GetSpacer(*args, **kwargs)
9292
9293 def SetSpacer(*args, **kwargs):
248ed943
RD
9294 """
9295 SetSpacer(self, Size size)
9296
9297 Set the size of the spacer to be managed by this sizer item.
9298 """
d55e5bfc
RD
9299 return _core_.SizerItem_SetSpacer(*args, **kwargs)
9300
9301 def Show(*args, **kwargs):
248ed943
RD
9302 """
9303 Show(self, bool show)
9304
9305 Set the show item attribute, which sizers use to determine if the item
9306 is to be made part of the layout or not. If the item is tracking a
9307 window then it is shown or hidden as needed.
9308 """
d55e5bfc
RD
9309 return _core_.SizerItem_Show(*args, **kwargs)
9310
9311 def IsShown(*args, **kwargs):
248ed943
RD
9312 """
9313 IsShown(self) -> bool
9314
9315 Is the item to be shown in the layout?
9316 """
d55e5bfc
RD
9317 return _core_.SizerItem_IsShown(*args, **kwargs)
9318
9319 def GetPosition(*args, **kwargs):
248ed943
RD
9320 """
9321 GetPosition(self) -> Point
9322
9323 Returns the current position of the item, as set in the last Layout.
9324 """
d55e5bfc
RD
9325 return _core_.SizerItem_GetPosition(*args, **kwargs)
9326
9327 def GetUserData(*args, **kwargs):
248ed943
RD
9328 """
9329 GetUserData(self) -> PyObject
9330
9331 Returns the userData associated with this sizer item, or None if there
9332 isn't any.
9333 """
d55e5bfc
RD
9334 return _core_.SizerItem_GetUserData(*args, **kwargs)
9335
9336
9337class SizerItemPtr(SizerItem):
9338 def __init__(self, this):
9339 self.this = this
9340 if not hasattr(self,"thisown"): self.thisown = 0
9341 self.__class__ = SizerItem
9342_core_.SizerItem_swigregister(SizerItemPtr)
9343
248ed943 9344def SizerItemWindow(*args, **kwargs):
d55e5bfc 9345 """
248ed943
RD
9346 SizerItemWindow(Window window, int proportion, int flag, int border,
9347 PyObject userData=None) -> SizerItem
9348
9349 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 9350 """
248ed943 9351 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
9352 val.thisown = 1
9353 return val
9354
248ed943 9355def SizerItemSpacer(*args, **kwargs):
d55e5bfc 9356 """
248ed943
RD
9357 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9358 PyObject userData=None) -> SizerItem
9359
9360 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 9361 """
248ed943 9362 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
9363 val.thisown = 1
9364 return val
9365
9366def SizerItemSizer(*args, **kwargs):
9367 """
9368 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9369 PyObject userData=None) -> SizerItem
9370
9371 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
9372 """
9373 val = _core_.new_SizerItemSizer(*args, **kwargs)
9374 val.thisown = 1
9375 return val
9376
9377class Sizer(Object):
248ed943
RD
9378 """
9379 wx.Sizer is the abstract base class used for laying out subwindows in
9380 a window. You cannot use wx.Sizer directly; instead, you will have to
9381 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9382 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9383 and `wx.GridBagSizer`.
9384
9385 The concept implemented by sizers in wxWidgets is closely related to
9386 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9387 toolkit or the Qt toolkit. It is based upon the idea of the individual
9388 subwindows reporting their minimal required size and their ability to
9389 get stretched if the size of the parent window has changed. This will
9390 most often mean that the programmer does not set the original size of
9391 a dialog in the beginning, rather the dialog will assigned a sizer and
9392 this sizer will be queried about the recommended size. The sizer in
9393 turn will query its children, which can be normal windows or contorls,
9394 empty space or other sizers, so that a hierarchy of sizers can be
9395 constructed. Note that wxSizer does not derive from wxWindow and thus
9396 do not interfere with tab ordering and requires very little resources
9397 compared to a real window on screen.
9398
9399 What makes sizers so well fitted for use in wxWidgets is the fact that
9400 every control reports its own minimal size and the algorithm can
9401 handle differences in font sizes or different window (dialog item)
9402 sizes on different platforms without problems. If for example the
9403 standard font as well as the overall design of Mac widgets requires
9404 more space than on Windows, then the initial size of a dialog using a
9405 sizer will automatically be bigger on Mac than on Windows.
9406 """
d55e5bfc
RD
9407 def __init__(self): raise RuntimeError, "No constructor defined"
9408 def __repr__(self):
9409 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9410 def _setOORInfo(*args, **kwargs):
9411 """_setOORInfo(self, PyObject _self)"""
9412 return _core_.Sizer__setOORInfo(*args, **kwargs)
9413
9414 def Add(*args, **kwargs):
9415 """
248ed943 9416 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9417 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9418
9419 Appends a child item to the sizer.
d55e5bfc
RD
9420 """
9421 return _core_.Sizer_Add(*args, **kwargs)
9422
9423 def Insert(*args, **kwargs):
9424 """
248ed943 9425 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9426 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9427
9428 Inserts a new item into the list of items managed by this sizer before
9429 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
9430 """
9431 return _core_.Sizer_Insert(*args, **kwargs)
9432
9433 def Prepend(*args, **kwargs):
9434 """
248ed943 9435 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9436 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9437
9438 Adds a new item to the begining of the list of sizer items managed by
9439 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
9440 """
9441 return _core_.Sizer_Prepend(*args, **kwargs)
9442
9443 def Remove(*args, **kwargs):
248ed943
RD
9444 """
9445 Remove(self, item) -> bool
9446
9447 Removes an item from the sizer and destroys it. This method does not
9448 cause any layout or resizing to take place, call `Layout` to update
9449 the layout on screen after removing a child from the sizer. The
9450 *item* parameter can be either a window, a sizer, or the zero-based
9451 index of an item to remove. Returns True if the child item was found
9452 and removed.
9453 """
d55e5bfc
RD
9454 return _core_.Sizer_Remove(*args, **kwargs)
9455
1a6bba1e 9456 def Detach(*args, **kwargs):
248ed943
RD
9457 """
9458 Detach(self, item) -> bool
9459
9460 Detaches an item from the sizer without destroying it. This method
9461 does not cause any layout or resizing to take place, call `Layout` to
9462 do so. The *item* parameter can be either a window, a sizer, or the
9463 zero-based index of the item to be detached. Returns True if the child item
9464 was found and detached.
9465 """
1a6bba1e
RD
9466 return _core_.Sizer_Detach(*args, **kwargs)
9467
c1cb24a4
RD
9468 def GetItem(*args, **kwargs):
9469 """
9470 GetItem(self, item) -> wx.SizerItem
9471
9472 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9473 parameter can be either a window, a sizer, or the zero-based index of
9474 the item to be detached.
9475 """
9476 return _core_.Sizer_GetItem(*args, **kwargs)
9477
d55e5bfc
RD
9478 def _SetItemMinSize(*args, **kwargs):
9479 """_SetItemMinSize(self, PyObject item, Size size)"""
9480 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
9481
248ed943
RD
9482 def SetItemMinSize(self, item, *args):
9483 """
9484 SetItemMinSize(self, item, Size size)
9485
9486 Sets the minimum size that will be allocated for an item in the sizer.
9487 The *item* parameter can be either a window, a sizer, or the
9488 zero-based index of the item. If a window or sizer is given then it
9489 will be searched for recursivly in subsizers if neccessary.
9490 """
9491 if len(args) == 2:
9492 # for backward compatibility accept separate width,height args too
9493 return self._SetItemMinSize(item, args)
9494 else:
9495 return self._SetItemMinSize(item, args[0])
9496
d55e5bfc 9497 def AddItem(*args, **kwargs):
248ed943
RD
9498 """
9499 AddItem(self, SizerItem item)
9500
9501 Adds a `wx.SizerItem` to the sizer.
9502 """
d55e5bfc
RD
9503 return _core_.Sizer_AddItem(*args, **kwargs)
9504
9505 def InsertItem(*args, **kwargs):
248ed943
RD
9506 """
9507 InsertItem(self, int index, SizerItem item)
9508
9509 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9510 """
d55e5bfc
RD
9511 return _core_.Sizer_InsertItem(*args, **kwargs)
9512
9513 def PrependItem(*args, **kwargs):
248ed943
RD
9514 """
9515 PrependItem(self, SizerItem item)
9516
9517 Prepends a `wx.SizerItem` to the sizer.
9518 """
d55e5bfc
RD
9519 return _core_.Sizer_PrependItem(*args, **kwargs)
9520
248ed943 9521 def AddMany(self, items):
c24da6d6
RD
9522 """
9523 AddMany is a convenience method for adding several items
9524 to a sizer at one time. Simply pass it a list of tuples,
9525 where each tuple consists of the parameters that you
9526 would normally pass to the `Add` method.
9527 """
248ed943
RD
9528 for item in items:
9529 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9530 item = (item, )
9531 self.Add(*item)
d55e5bfc
RD
9532
9533 # for backwards compatibility only, please do not use in new code
c24da6d6
RD
9534 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
9535 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
9536 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
9537 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
9538 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
9539 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
9540 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
9541 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
9542 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
9543 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
9544 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
9545 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d55e5bfc
RD
9546
9547
d55e5bfc 9548 def SetDimension(*args, **kwargs):
248ed943
RD
9549 """
9550 SetDimension(self, int x, int y, int width, int height)
9551
9552 Call this to force the sizer to take the given dimension and thus
9553 force the items owned by the sizer to resize themselves according to
9554 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9555 methods.
9556 """
d55e5bfc
RD
9557 return _core_.Sizer_SetDimension(*args, **kwargs)
9558
9559 def SetMinSize(*args, **kwargs):
248ed943
RD
9560 """
9561 SetMinSize(self, Size size)
9562
9563 Call this to give the sizer a minimal size. Normally, the sizer will
9564 calculate its minimal size based purely on how much space its children
9565 need. After calling this method `GetMinSize` will return either the
9566 minimal size as requested by its children or the minimal size set
9567 here, depending on which is bigger.
9568 """
d55e5bfc
RD
9569 return _core_.Sizer_SetMinSize(*args, **kwargs)
9570
9571 def GetSize(*args, **kwargs):
248ed943
RD
9572 """
9573 GetSize(self) -> Size
9574
9575 Returns the current size of the space managed by the sizer.
9576 """
d55e5bfc
RD
9577 return _core_.Sizer_GetSize(*args, **kwargs)
9578
9579 def GetPosition(*args, **kwargs):
248ed943
RD
9580 """
9581 GetPosition(self) -> Point
9582
9583 Returns the current position of the sizer's managed space.
9584 """
d55e5bfc
RD
9585 return _core_.Sizer_GetPosition(*args, **kwargs)
9586
9587 def GetMinSize(*args, **kwargs):
248ed943
RD
9588 """
9589 GetMinSize(self) -> Size
9590
9591 Returns the minimal size of the sizer. This is either the combined
9592 minimal size of all the children and their borders or the minimal size
9593 set by SetMinSize, depending on which is bigger.
9594 """
d55e5bfc
RD
9595 return _core_.Sizer_GetMinSize(*args, **kwargs)
9596
9597 def GetSizeTuple(self):
1a6bba1e 9598 return self.GetSize().Get()
d55e5bfc 9599 def GetPositionTuple(self):
1a6bba1e 9600 return self.GetPosition().Get()
d55e5bfc 9601 def GetMinSizeTuple(self):
1a6bba1e 9602 return self.GetMinSize().Get()
d55e5bfc
RD
9603
9604 def RecalcSizes(*args, **kwargs):
248ed943
RD
9605 """
9606 RecalcSizes(self)
9607
9608 Using the sizes calculated by `CalcMin` reposition and resize all the
9609 items managed by this sizer. You should not need to call this directly as
9610 it is called by `Layout`.
9611 """
d55e5bfc
RD
9612 return _core_.Sizer_RecalcSizes(*args, **kwargs)
9613
9614 def CalcMin(*args, **kwargs):
248ed943
RD
9615 """
9616 CalcMin(self) -> Size
9617
9618 This method is where the sizer will do the actual calculation of its
9619 children's minimal sizes. You should not need to call this directly as
9620 it is called by `Layout`.
9621 """
d55e5bfc
RD
9622 return _core_.Sizer_CalcMin(*args, **kwargs)
9623
9624 def Layout(*args, **kwargs):
248ed943
RD
9625 """
9626 Layout(self)
9627
9628 This method will force the recalculation and layout of the items
9629 controlled by the sizer using the current space allocated to the
9630 sizer. Normally this is called automatically from the owning window's
9631 EVT_SIZE handler, but it is also useful to call it from user code when
9632 one of the items in a sizer change size, or items are added or
9633 removed.
9634 """
d55e5bfc
RD
9635 return _core_.Sizer_Layout(*args, **kwargs)
9636
9637 def Fit(*args, **kwargs):
248ed943
RD
9638 """
9639 Fit(self, Window window) -> Size
9640
9641 Tell the sizer to resize the *window* to match the sizer's minimal
9642 size. This is commonly done in the constructor of the window itself in
9643 order to set its initial size to match the needs of the children as
9644 determined by the sizer. Returns the new size.
9645
9646 For a top level window this is the total window size, not the client size.
9647 """
d55e5bfc
RD
9648 return _core_.Sizer_Fit(*args, **kwargs)
9649
9650 def FitInside(*args, **kwargs):
248ed943
RD
9651 """
9652 FitInside(self, Window window)
9653
9654 Tell the sizer to resize the *virtual size* of the *window* to match the
9655 sizer's minimal size. This will not alter the on screen size of the
9656 window, but may cause the addition/removal/alteration of scrollbars
9657 required to view the virtual area in windows which manage it.
9658
9659 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9660
9661 """
d55e5bfc
RD
9662 return _core_.Sizer_FitInside(*args, **kwargs)
9663
9664 def SetSizeHints(*args, **kwargs):
248ed943
RD
9665 """
9666 SetSizeHints(self, Window window)
9667
9668 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9669 match the sizer's minimal size. This is commonly done in the
9670 constructor of the window itself if the window is resizable (as are
9671 many dialogs under Unix and frames on probably all platforms) in order
9672 to prevent the window from being sized smaller than the minimal size
9673 required by the sizer.
9674 """
d55e5bfc
RD
9675 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9676
9677 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9678 """
9679 SetVirtualSizeHints(self, Window window)
9680
9681 Tell the sizer to set the minimal size of the window virtual area to
9682 match the sizer's minimal size. For windows with managed scrollbars
9683 this will set them appropriately.
9684
9685 :see: `wx.ScrolledWindow.SetScrollbars`
9686
9687 """
d55e5bfc
RD
9688 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9689
9690 def Clear(*args, **kwargs):
248ed943
RD
9691 """
9692 Clear(self, bool deleteWindows=False)
9693
9694 Clear all items from the sizer, optionally destroying the window items
9695 as well.
9696 """
d55e5bfc
RD
9697 return _core_.Sizer_Clear(*args, **kwargs)
9698
9699 def DeleteWindows(*args, **kwargs):
248ed943
RD
9700 """
9701 DeleteWindows(self)
9702
9703 Destroy all windows managed by the sizer.
9704 """
d55e5bfc
RD
9705 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9706
9707 def GetChildren(*args, **kwargs):
248ed943 9708 """
51b83b37 9709 GetChildren(self) -> list
248ed943
RD
9710
9711 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9712 """
d55e5bfc
RD
9713 return _core_.Sizer_GetChildren(*args, **kwargs)
9714
9715 def Show(*args, **kwargs):
248ed943 9716 """
ae8162c8 9717 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 9718
248ed943
RD
9719 Shows or hides an item managed by the sizer. To make a sizer item
9720 disappear or reappear, use Show followed by `Layout`. The *item*
9721 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD
9722 the item. Use the recursive parameter to show or hide an item in a
9723 subsizer. Returns True if the item was found.
248ed943
RD
9724 """
9725 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
9726
9727 def IsShown(*args, **kwargs):
248ed943
RD
9728 """
9729 IsShown(self, item)
9730
9731 Determines if the item is currently shown. sizer. To make a sizer
9732 item disappear or reappear, use Show followed by `Layout`. The *item*
9733 parameter can be either a window, a sizer, or the zero-based index of
9734 the item.
9735 """
d55e5bfc
RD
9736 return _core_.Sizer_IsShown(*args, **kwargs)
9737
629e65c2 9738 def Hide(self, item, recursive=False):
248ed943 9739 """
629e65c2 9740 A convenience method for Show(item, False, recursive).
248ed943 9741 """
06759a38 9742 return self.Show(item, False, recursive)
248ed943 9743
d55e5bfc 9744 def ShowItems(*args, **kwargs):
248ed943
RD
9745 """
9746 ShowItems(self, bool show)
9747
84f85550 9748 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9749 """
d55e5bfc
RD
9750 return _core_.Sizer_ShowItems(*args, **kwargs)
9751
9752
9753class SizerPtr(Sizer):
9754 def __init__(self, this):
9755 self.this = this
9756 if not hasattr(self,"thisown"): self.thisown = 0
9757 self.__class__ = Sizer
9758_core_.Sizer_swigregister(SizerPtr)
9759
9760class PySizer(Sizer):
248ed943
RD
9761 """
9762 wx.PySizer is a special version of `wx.Sizer` that has been
9763 instrumented to allow the C++ virtual methods to be overloaded in
9764 Python derived classes. You would derive from this class if you are
9765 wanting to implement a custom sizer in Python code. Simply implement
9766 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9767 For example::
9768
9769 class MySizer(wx.PySizer):
9770 def __init__(self):
9771 wx.PySizer.__init__(self)
9772
9773 def CalcMin(self):
9774 for item in self.GetChildren():
9775 # calculate the total minimum width and height needed
9776 # by all items in the sizer according to this sizer's
9777 # layout algorithm.
9778 ...
9779 return wx.Size(width, height)
9780
9781 def RecalcSizes(self):
9782 # find the space allotted to this sizer
9783 pos = self.GetPosition()
9784 size = self.GetSize()
9785 for item in self.GetChildren():
9786 # Recalculate (if necessary) the position and size of
9787 # each item and then call item.SetDimension to do the
9788 # actual positioning and sizing of the items within the
9789 # space alloted to this sizer.
9790 ...
9791 item.SetDimension(itemPos, itemSize)
9792
9793
9794 When `Layout` is called it first calls `CalcMin` followed by
9795 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 9796 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
9797
9798 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9799
9800
9801 """
d55e5bfc
RD
9802 def __repr__(self):
9803 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9804 def __init__(self, *args, **kwargs):
248ed943
RD
9805 """
9806 __init__(self) -> PySizer
9807
9808 Creates a wx.PySizer. Must be called from the __init__ in the derived
9809 class.
9810 """
d55e5bfc
RD
9811 newobj = _core_.new_PySizer(*args, **kwargs)
9812 self.this = newobj.this
9813 self.thisown = 1
9814 del newobj.thisown
9815 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
9816
9817 def _setCallbackInfo(*args, **kwargs):
9818 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
9819 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
9820
9821
9822class PySizerPtr(PySizer):
9823 def __init__(self, this):
9824 self.this = this
9825 if not hasattr(self,"thisown"): self.thisown = 0
9826 self.__class__ = PySizer
9827_core_.PySizer_swigregister(PySizerPtr)
9828
9829#---------------------------------------------------------------------------
9830
9831class BoxSizer(Sizer):
248ed943
RD
9832 """
9833 The basic idea behind a box sizer is that windows will most often be
9834 laid out in rather simple basic geometry, typically in a row or a
9835 column or nested hierarchies of either. A wx.BoxSizer will lay out
9836 its items in a simple row or column, depending on the orientation
9837 parameter passed to the constructor.
9838 """
d55e5bfc
RD
9839 def __repr__(self):
9840 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9841 def __init__(self, *args, **kwargs):
248ed943
RD
9842 """
9843 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9844
9845 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9846 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9847 sizer.
9848 """
d55e5bfc
RD
9849 newobj = _core_.new_BoxSizer(*args, **kwargs)
9850 self.this = newobj.this
9851 self.thisown = 1
9852 del newobj.thisown
9853 self._setOORInfo(self)
9854
9855 def GetOrientation(*args, **kwargs):
248ed943
RD
9856 """
9857 GetOrientation(self) -> int
9858
9859 Returns the current orientation of the sizer.
9860 """
d55e5bfc
RD
9861 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
9862
9863 def SetOrientation(*args, **kwargs):
248ed943
RD
9864 """
9865 SetOrientation(self, int orient)
d55e5bfc 9866
248ed943
RD
9867 Resets the orientation of the sizer.
9868 """
9869 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
9870
9871
9872class BoxSizerPtr(BoxSizer):
9873 def __init__(self, this):
9874 self.this = this
9875 if not hasattr(self,"thisown"): self.thisown = 0
9876 self.__class__ = BoxSizer
9877_core_.BoxSizer_swigregister(BoxSizerPtr)
9878
9879#---------------------------------------------------------------------------
9880
9881class StaticBoxSizer(BoxSizer):
248ed943
RD
9882 """
9883 wx.StaticBoxSizer derives from and functions identically to the
9884 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9885 manages. Note that this static box must be created separately and
9886 passed to the sizer constructor.
9887 """
d55e5bfc
RD
9888 def __repr__(self):
9889 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9890 def __init__(self, *args, **kwargs):
248ed943
RD
9891 """
9892 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9893
9894 Constructor. It takes an associated static box and the orientation
9895 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9896 ``wx.HORIZONTAL``.
9897 """
d55e5bfc
RD
9898 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
9899 self.this = newobj.this
9900 self.thisown = 1
9901 del newobj.thisown
9902 self._setOORInfo(self)
9903
9904 def GetStaticBox(*args, **kwargs):
248ed943
RD
9905 """
9906 GetStaticBox(self) -> StaticBox
d55e5bfc 9907
248ed943
RD
9908 Returns the static box associated with this sizer.
9909 """
9910 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
9911
9912
9913class StaticBoxSizerPtr(StaticBoxSizer):
9914 def __init__(self, this):
9915 self.this = this
9916 if not hasattr(self,"thisown"): self.thisown = 0
9917 self.__class__ = StaticBoxSizer
9918_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
9919
9920#---------------------------------------------------------------------------
9921
9922class GridSizer(Sizer):
248ed943
RD
9923 """
9924 A grid sizer is a sizer which lays out its children in a
9925 two-dimensional table with all cells having the same size. In other
9926 words, the width of each cell within the grid is the width of the
9927 widest item added to the sizer and the height of each grid cell is the
9928 height of the tallest item. An optional vertical and/or horizontal
9929 gap between items can also be specified (in pixels.)
9930
9931 Items are placed in the cells of the grid in the order they are added,
9932 in row-major order. In other words, the first row is filled first,
9933 then the second, and so on until all items have been added. (If
9934 neccessary, additional rows will be added as items are added.) If you
9935 need to have greater control over the cells that items are placed in
9936 then use the `wx.GridBagSizer`.
9937
9938 """
d55e5bfc
RD
9939 def __repr__(self):
9940 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9941 def __init__(self, *args, **kwargs):
248ed943
RD
9942 """
9943 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9944
9945 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9946 of columns and rows in the sizer - if either of the parameters is
9947 zero, it will be calculated to from the total number of children in
9948 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9949 define extra space between all children.
9950 """
d55e5bfc
RD
9951 newobj = _core_.new_GridSizer(*args, **kwargs)
9952 self.this = newobj.this
9953 self.thisown = 1
9954 del newobj.thisown
9955 self._setOORInfo(self)
9956
d55e5bfc 9957 def SetCols(*args, **kwargs):
248ed943
RD
9958 """
9959 SetCols(self, int cols)
9960
9961 Sets the number of columns in the sizer.
9962 """
d55e5bfc
RD
9963 return _core_.GridSizer_SetCols(*args, **kwargs)
9964
9965 def SetRows(*args, **kwargs):
248ed943
RD
9966 """
9967 SetRows(self, int rows)
9968
9969 Sets the number of rows in the sizer.
9970 """
d55e5bfc
RD
9971 return _core_.GridSizer_SetRows(*args, **kwargs)
9972
9973 def SetVGap(*args, **kwargs):
248ed943
RD
9974 """
9975 SetVGap(self, int gap)
9976
9977 Sets the vertical gap (in pixels) between the cells in the sizer.
9978 """
d55e5bfc
RD
9979 return _core_.GridSizer_SetVGap(*args, **kwargs)
9980
9981 def SetHGap(*args, **kwargs):
248ed943
RD
9982 """
9983 SetHGap(self, int gap)
9984
9985 Sets the horizontal gap (in pixels) between cells in the sizer
9986 """
d55e5bfc
RD
9987 return _core_.GridSizer_SetHGap(*args, **kwargs)
9988
9989 def GetCols(*args, **kwargs):
248ed943
RD
9990 """
9991 GetCols(self) -> int
9992
9993 Returns the number of columns in the sizer.
9994 """
d55e5bfc
RD
9995 return _core_.GridSizer_GetCols(*args, **kwargs)
9996
9997 def GetRows(*args, **kwargs):
248ed943
RD
9998 """
9999 GetRows(self) -> int
10000
10001 Returns the number of rows in the sizer.
10002 """
d55e5bfc
RD
10003 return _core_.GridSizer_GetRows(*args, **kwargs)
10004
10005 def GetVGap(*args, **kwargs):
248ed943
RD
10006 """
10007 GetVGap(self) -> int
10008
10009 Returns the vertical gap (in pixels) between the cells in the sizer.
10010 """
d55e5bfc
RD
10011 return _core_.GridSizer_GetVGap(*args, **kwargs)
10012
10013 def GetHGap(*args, **kwargs):
248ed943
RD
10014 """
10015 GetHGap(self) -> int
10016
10017 Returns the horizontal gap (in pixels) between cells in the sizer.
10018 """
d55e5bfc
RD
10019 return _core_.GridSizer_GetHGap(*args, **kwargs)
10020
10021
10022class GridSizerPtr(GridSizer):
10023 def __init__(self, this):
10024 self.this = this
10025 if not hasattr(self,"thisown"): self.thisown = 0
10026 self.__class__ = GridSizer
10027_core_.GridSizer_swigregister(GridSizerPtr)
10028
10029#---------------------------------------------------------------------------
10030
10031FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
10032FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
10033FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
10034class FlexGridSizer(GridSizer):
248ed943
RD
10035 """
10036 A flex grid sizer is a sizer which lays out its children in a
10037 two-dimensional table with all table cells in one row having the same
10038 height and all cells in one column having the same width, but all
10039 rows or all columns are not necessarily the same height or width as in
10040 the `wx.GridSizer`.
10041
10042 wx.FlexGridSizer can also size items equally in one direction but
10043 unequally ("flexibly") in the other. If the sizer is only flexible
10044 in one direction (this can be changed using `SetFlexibleDirection`), it
10045 needs to be decided how the sizer should grow in the other ("non
10046 flexible") direction in order to fill the available space. The
10047 `SetNonFlexibleGrowMode` method serves this purpose.
10048
10049
10050 """
d55e5bfc
RD
10051 def __repr__(self):
10052 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10053 def __init__(self, *args, **kwargs):
248ed943
RD
10054 """
10055 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
10056
10057 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
10058 number of columns and rows in the sizer - if either of the parameters
10059 is zero, it will be calculated to from the total number of children in
10060 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10061 define extra space between all children.
10062 """
d55e5bfc
RD
10063 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
10064 self.this = newobj.this
10065 self.thisown = 1
10066 del newobj.thisown
10067 self._setOORInfo(self)
10068
248ed943
RD
10069 def AddGrowableRow(*args, **kwargs):
10070 """
10071 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 10072
248ed943
RD
10073 Specifies that row *idx* (starting from zero) should be grown if there
10074 is extra space available to the sizer.
d55e5bfc 10075
248ed943
RD
10076 The *proportion* parameter has the same meaning as the stretch factor
10077 for the box sizers except that if all proportions are 0, then all
10078 columns are resized equally (instead of not being resized at all).
10079 """
d55e5bfc
RD
10080 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
10081
10082 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
10083 """
10084 RemoveGrowableRow(self, size_t idx)
10085
10086 Specifies that row *idx* is no longer growable.
10087 """
d55e5bfc
RD
10088 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
10089
10090 def AddGrowableCol(*args, **kwargs):
248ed943
RD
10091 """
10092 AddGrowableCol(self, size_t idx, int proportion=0)
10093
10094 Specifies that column *idx* (starting from zero) should be grown if
10095 there is extra space available to the sizer.
10096
10097 The *proportion* parameter has the same meaning as the stretch factor
10098 for the box sizers except that if all proportions are 0, then all
10099 columns are resized equally (instead of not being resized at all).
10100 """
d55e5bfc
RD
10101 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
10102
10103 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
10104 """
10105 RemoveGrowableCol(self, size_t idx)
10106
10107 Specifies that column *idx* is no longer growable.
10108 """
d55e5bfc
RD
10109 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
10110
10111 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
10112 """
10113 SetFlexibleDirection(self, int direction)
10114
10115 Specifies whether the sizer should flexibly resize its columns, rows,
10116 or both. Argument *direction* can be one of the following values. Any
10117 other value is ignored.
10118
10119 ============== =======================================
10120 wx.VERTICAL Rows are flexibly sized.
10121 wx.HORIZONTAL Columns are flexibly sized.
10122 wx.BOTH Both rows and columns are flexibly sized
10123 (this is the default value).
10124 ============== =======================================
10125
10126 Note that this method does not trigger relayout.
10127
10128 """
d55e5bfc
RD
10129 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
10130
10131 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
10132 """
10133 GetFlexibleDirection(self) -> int
10134
10135 Returns a value that specifies whether the sizer
10136 flexibly resizes its columns, rows, or both (default).
10137
10138 :see: `SetFlexibleDirection`
10139 """
d55e5bfc
RD
10140 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
10141
10142 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10143 """
10144 SetNonFlexibleGrowMode(self, int mode)
10145
10146 Specifies how the sizer should grow in the non-flexible direction if
10147 there is one (so `SetFlexibleDirection` must have been called
10148 previously). Argument *mode* can be one of the following values:
10149
10150 ========================== =================================================
10151 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
10152 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
10153 `AddGrowableCol` and `AddGrowableRow`. In this
10154 case equal sizing applies to minimum sizes of
10155 columns or rows (this is the default value).
10156 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
10157 the non flexible direction, whether they are
10158 growable or not in the flexbile direction.
10159 ========================== =================================================
10160
10161 Note that this method does not trigger relayout.
10162
10163
10164 """
d55e5bfc
RD
10165 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
10166
10167 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
10168 """
10169 GetNonFlexibleGrowMode(self) -> int
10170
10171 Returns the value that specifies how the sizer grows in the
10172 non-flexible direction if there is one.
10173
10174 :see: `SetNonFlexibleGrowMode`
10175 """
d55e5bfc
RD
10176 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
10177
10178 def GetRowHeights(*args, **kwargs):
a8eff060
RD
10179 """
10180 GetRowHeights(self) -> list
10181
10182 Returns a list of integers representing the heights of each of the
10183 rows in the sizer.
10184 """
d55e5bfc
RD
10185 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
10186
10187 def GetColWidths(*args, **kwargs):
a8eff060
RD
10188 """
10189 GetColWidths(self) -> list
10190
10191 Returns a list of integers representing the widths of each of the
10192 columns in the sizer.
10193 """
d55e5bfc
RD
10194 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
10195
10196
10197class FlexGridSizerPtr(FlexGridSizer):
10198 def __init__(self, this):
10199 self.this = this
10200 if not hasattr(self,"thisown"): self.thisown = 0
10201 self.__class__ = FlexGridSizer
10202_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
10203
62d32a5f
RD
10204class StdDialogButtonSizer(BoxSizer):
10205 """
10206 A special sizer that knows how to order and position standard buttons
10207 in order to conform to the current platform's standards. You simply
10208 need to add each `wx.Button` to the sizer, and be sure to create the
10209 buttons using the standard ID's. Then call `Finalize` and the sizer
10210 will take care of the rest.
10211
10212 """
10213 def __repr__(self):
10214 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10215 def __init__(self, *args, **kwargs):
10216 """__init__(self) -> StdDialogButtonSizer"""
10217 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
10218 self.this = newobj.this
10219 self.thisown = 1
10220 del newobj.thisown
10221 def AddButton(*args, **kwargs):
10222 """
10223 AddButton(self, wxButton button)
10224
10225 Use this to add the buttons to this sizer. Do not use the `Add`
10226 method in the base class.
10227 """
10228 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
10229
10230 def Finalise(*args, **kwargs):
10231 """
10232 Finalise(self)
10233
10234 This funciton needs to be called after all the buttons have been added
10235 to the sizer. It will reorder them and position them in a platform
10236 specifc manner.
10237 """
10238 return _core_.StdDialogButtonSizer_Finalise(*args, **kwargs)
51b83b37
RD
10239
10240 def SetAffirmativeButton(*args, **kwargs):
10241 """SetAffirmativeButton(self, wxButton button)"""
10242 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
10243
10244 def SetNegativeButton(*args, **kwargs):
10245 """SetNegativeButton(self, wxButton button)"""
10246 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
10247
10248 def SetCancelButton(*args, **kwargs):
10249 """SetCancelButton(self, wxButton button)"""
10250 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD
10251
10252 def GetAffirmativeButton(*args, **kwargs):
10253 """GetAffirmativeButton(self) -> wxButton"""
10254 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
10255
10256 def GetApplyButton(*args, **kwargs):
10257 """GetApplyButton(self) -> wxButton"""
10258 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
10259
10260 def GetNegativeButton(*args, **kwargs):
10261 """GetNegativeButton(self) -> wxButton"""
10262 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
10263
10264 def GetCancelButton(*args, **kwargs):
10265 """GetCancelButton(self) -> wxButton"""
10266 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
10267
10268 def GetHelpButton(*args, **kwargs):
10269 """GetHelpButton(self) -> wxButton"""
10270 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
10271
10272
10273class StdDialogButtonSizerPtr(StdDialogButtonSizer):
10274 def __init__(self, this):
10275 self.this = this
10276 if not hasattr(self,"thisown"): self.thisown = 0
10277 self.__class__ = StdDialogButtonSizer
10278_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
10279
d55e5bfc
RD
10280#---------------------------------------------------------------------------
10281
10282class GBPosition(object):
248ed943
RD
10283 """
10284 This class represents the position of an item in a virtual grid of
10285 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10286 typemaps that will automatically convert from a 2-element sequence of
10287 integers to a wx.GBPosition, so you can use the more pythonic
10288 representation of the position nearly transparently in Python code.
10289 """
d55e5bfc
RD
10290 def __repr__(self):
10291 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10292 def __init__(self, *args, **kwargs):
248ed943
RD
10293 """
10294 __init__(self, int row=0, int col=0) -> GBPosition
10295
10296 This class represents the position of an item in a virtual grid of
10297 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10298 typemaps that will automatically convert from a 2-element sequence of
10299 integers to a wx.GBPosition, so you can use the more pythonic
10300 representation of the position nearly transparently in Python code.
10301 """
d55e5bfc
RD
10302 newobj = _core_.new_GBPosition(*args, **kwargs)
10303 self.this = newobj.this
10304 self.thisown = 1
10305 del newobj.thisown
10306 def GetRow(*args, **kwargs):
10307 """GetRow(self) -> int"""
10308 return _core_.GBPosition_GetRow(*args, **kwargs)
10309
10310 def GetCol(*args, **kwargs):
10311 """GetCol(self) -> int"""
10312 return _core_.GBPosition_GetCol(*args, **kwargs)
10313
10314 def SetRow(*args, **kwargs):
10315 """SetRow(self, int row)"""
10316 return _core_.GBPosition_SetRow(*args, **kwargs)
10317
10318 def SetCol(*args, **kwargs):
10319 """SetCol(self, int col)"""
10320 return _core_.GBPosition_SetCol(*args, **kwargs)
10321
10322 def __eq__(*args, **kwargs):
10323 """__eq__(self, GBPosition other) -> bool"""
10324 return _core_.GBPosition___eq__(*args, **kwargs)
10325
10326 def __ne__(*args, **kwargs):
10327 """__ne__(self, GBPosition other) -> bool"""
10328 return _core_.GBPosition___ne__(*args, **kwargs)
10329
10330 def Set(*args, **kwargs):
10331 """Set(self, int row=0, int col=0)"""
10332 return _core_.GBPosition_Set(*args, **kwargs)
10333
10334 def Get(*args, **kwargs):
10335 """Get(self) -> PyObject"""
10336 return _core_.GBPosition_Get(*args, **kwargs)
10337
79fccf9d 10338 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
10339 def __str__(self): return str(self.Get())
10340 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10341 def __len__(self): return len(self.Get())
10342 def __getitem__(self, index): return self.Get()[index]
10343 def __setitem__(self, index, val):
10344 if index == 0: self.SetRow(val)
10345 elif index == 1: self.SetCol(val)
10346 else: raise IndexError
10347 def __nonzero__(self): return self.Get() != (0,0)
10348 __safe_for_unpickling__ = True
10349 def __reduce__(self): return (wx.GBPosition, self.Get())
10350
10351 row = property(GetRow, SetRow)
10352 col = property(GetCol, SetCol)
10353
10354
10355class GBPositionPtr(GBPosition):
10356 def __init__(self, this):
10357 self.this = this
10358 if not hasattr(self,"thisown"): self.thisown = 0
10359 self.__class__ = GBPosition
10360_core_.GBPosition_swigregister(GBPositionPtr)
10361
10362class GBSpan(object):
248ed943
RD
10363 """
10364 This class is used to hold the row and column spanning attributes of
10365 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10366 automatically convert from a 2-element sequence of integers to a
10367 wx.GBSpan, so you can use the more pythonic representation of the span
10368 nearly transparently in Python code.
10369
10370 """
d55e5bfc
RD
10371 def __repr__(self):
10372 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10373 def __init__(self, *args, **kwargs):
248ed943
RD
10374 """
10375 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10376
10377 Construct a new wxGBSpan, optionally setting the rowspan and
10378 colspan. The default is (1,1). (Meaning that the item occupies one
10379 cell in each direction.
10380 """
d55e5bfc
RD
10381 newobj = _core_.new_GBSpan(*args, **kwargs)
10382 self.this = newobj.this
10383 self.thisown = 1
10384 del newobj.thisown
10385 def GetRowspan(*args, **kwargs):
10386 """GetRowspan(self) -> int"""
10387 return _core_.GBSpan_GetRowspan(*args, **kwargs)
10388
10389 def GetColspan(*args, **kwargs):
10390 """GetColspan(self) -> int"""
10391 return _core_.GBSpan_GetColspan(*args, **kwargs)
10392
10393 def SetRowspan(*args, **kwargs):
10394 """SetRowspan(self, int rowspan)"""
10395 return _core_.GBSpan_SetRowspan(*args, **kwargs)
10396
10397 def SetColspan(*args, **kwargs):
10398 """SetColspan(self, int colspan)"""
10399 return _core_.GBSpan_SetColspan(*args, **kwargs)
10400
10401 def __eq__(*args, **kwargs):
10402 """__eq__(self, GBSpan other) -> bool"""
10403 return _core_.GBSpan___eq__(*args, **kwargs)
10404
10405 def __ne__(*args, **kwargs):
10406 """__ne__(self, GBSpan other) -> bool"""
10407 return _core_.GBSpan___ne__(*args, **kwargs)
10408
10409 def Set(*args, **kwargs):
10410 """Set(self, int rowspan=1, int colspan=1)"""
10411 return _core_.GBSpan_Set(*args, **kwargs)
10412
10413 def Get(*args, **kwargs):
10414 """Get(self) -> PyObject"""
10415 return _core_.GBSpan_Get(*args, **kwargs)
10416
79fccf9d 10417 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
10418 def __str__(self): return str(self.Get())
10419 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10420 def __len__(self): return len(self.Get())
10421 def __getitem__(self, index): return self.Get()[index]
10422 def __setitem__(self, index, val):
10423 if index == 0: self.SetRowspan(val)
10424 elif index == 1: self.SetColspan(val)
10425 else: raise IndexError
10426 def __nonzero__(self): return self.Get() != (0,0)
10427 __safe_for_unpickling__ = True
10428 def __reduce__(self): return (wx.GBSpan, self.Get())
10429
10430 rowspan = property(GetRowspan, SetRowspan)
10431 colspan = property(GetColspan, SetColspan)
10432
10433
10434class GBSpanPtr(GBSpan):
10435 def __init__(self, this):
10436 self.this = this
10437 if not hasattr(self,"thisown"): self.thisown = 0
10438 self.__class__ = GBSpan
10439_core_.GBSpan_swigregister(GBSpanPtr)
10440
10441class GBSizerItem(SizerItem):
248ed943
RD
10442 """
10443 The wx.GBSizerItem class is used to track the additional data about
10444 items in a `wx.GridBagSizer` such as the item's position in the grid
10445 and how many rows or columns it spans.
10446
10447 """
d55e5bfc
RD
10448 def __repr__(self):
10449 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10450 def __init__(self, *args, **kwargs):
248ed943
RD
10451 """
10452 __init__(self) -> GBSizerItem
10453
10454 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10455 size will need to be set, as well as a position and span before this
10456 item can be used in a Sizer.
10457
10458 You will probably never need to create a wx.GBSizerItem directly as they
10459 are created automatically when the sizer's Add method is called.
10460 """
d55e5bfc
RD
10461 newobj = _core_.new_GBSizerItem(*args, **kwargs)
10462 self.this = newobj.this
10463 self.thisown = 1
10464 del newobj.thisown
10465 def GetPos(*args, **kwargs):
248ed943
RD
10466 """
10467 GetPos(self) -> GBPosition
10468
10469 Get the grid position of the item
10470 """
d55e5bfc
RD
10471 return _core_.GBSizerItem_GetPos(*args, **kwargs)
10472
10473 def GetPosTuple(self): return self.GetPos().Get()
10474 def GetSpan(*args, **kwargs):
248ed943
RD
10475 """
10476 GetSpan(self) -> GBSpan
10477
10478 Get the row and column spanning of the item
10479 """
d55e5bfc
RD
10480 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
10481
10482 def GetSpanTuple(self): return self.GetSpan().Get()
10483 def SetPos(*args, **kwargs):
248ed943
RD
10484 """
10485 SetPos(self, GBPosition pos) -> bool
10486
10487 If the item is already a member of a sizer then first ensure that
10488 there is no other item that would intersect with this one at the new
10489 position, then set the new position. Returns True if the change is
10490 successful and after the next Layout() the item will be moved.
10491 """
d55e5bfc
RD
10492 return _core_.GBSizerItem_SetPos(*args, **kwargs)
10493
10494 def SetSpan(*args, **kwargs):
248ed943
RD
10495 """
10496 SetSpan(self, GBSpan span) -> bool
10497
10498 If the item is already a member of a sizer then first ensure that
10499 there is no other item that would intersect with this one with its new
10500 spanning size, then set the new spanning. Returns True if the change
10501 is successful and after the next Layout() the item will be resized.
10502
10503 """
d55e5bfc
RD
10504 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
10505
248ed943 10506 def Intersects(*args, **kwargs):
d55e5bfc
RD
10507 """
10508 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10509
10510 Returns True if this item and the other item instersect.
d55e5bfc 10511 """
248ed943
RD
10512 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10513
10514 def IntersectsPos(*args, **kwargs):
10515 """
10516 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10517
10518 Returns True if the given pos/span would intersect with this item.
10519 """
10520 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
10521
10522 def GetEndPos(*args, **kwargs):
248ed943
RD
10523 """
10524 GetEndPos(self) -> GBPosition
10525
10526 Get the row and column of the endpoint of this item.
10527 """
d55e5bfc
RD
10528 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
10529
10530 def GetGBSizer(*args, **kwargs):
248ed943
RD
10531 """
10532 GetGBSizer(self) -> GridBagSizer
10533
10534 Get the sizer this item is a member of.
10535 """
d55e5bfc
RD
10536 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
10537
10538 def SetGBSizer(*args, **kwargs):
248ed943
RD
10539 """
10540 SetGBSizer(self, GridBagSizer sizer)
10541
10542 Set the sizer this item is a member of.
10543 """
d55e5bfc
RD
10544 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
10545
10546
10547class GBSizerItemPtr(GBSizerItem):
10548 def __init__(self, this):
10549 self.this = this
10550 if not hasattr(self,"thisown"): self.thisown = 0
10551 self.__class__ = GBSizerItem
10552_core_.GBSizerItem_swigregister(GBSizerItemPtr)
10553DefaultSpan = cvar.DefaultSpan
10554
10555def GBSizerItemWindow(*args, **kwargs):
10556 """
10557 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10558 int border, PyObject userData=None) -> GBSizerItem
10559
10560 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
10561 """
10562 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
10563 val.thisown = 1
10564 return val
10565
10566def GBSizerItemSizer(*args, **kwargs):
10567 """
10568 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10569 int border, PyObject userData=None) -> GBSizerItem
10570
10571 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
10572 """
10573 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
10574 val.thisown = 1
10575 return val
10576
10577def GBSizerItemSpacer(*args, **kwargs):
10578 """
10579 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10580 int flag, int border, PyObject userData=None) -> GBSizerItem
10581
10582 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
10583 """
10584 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
10585 val.thisown = 1
10586 return val
10587
10588class GridBagSizer(FlexGridSizer):
248ed943
RD
10589 """
10590 A `wx.Sizer` that can lay out items in a virtual grid like a
10591 `wx.FlexGridSizer` but in this case explicit positioning of the items
10592 is allowed using `wx.GBPosition`, and items can optionally span more
10593 than one row and/or column using `wx.GBSpan`. The total size of the
10594 virtual grid is determined by the largest row and column that items are
10595 positioned at, adjusted for spanning.
10596
10597 """
d55e5bfc
RD
10598 def __repr__(self):
10599 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10600 def __init__(self, *args, **kwargs):
248ed943
RD
10601 """
10602 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10603
10604 Constructor, with optional parameters to specify the gap between the
10605 rows and columns.
10606 """
d55e5bfc
RD
10607 newobj = _core_.new_GridBagSizer(*args, **kwargs)
10608 self.this = newobj.this
10609 self.thisown = 1
10610 del newobj.thisown
c9c2cf70
RD
10611 self._setOORInfo(self)
10612
d55e5bfc
RD
10613 def Add(*args, **kwargs):
10614 """
248ed943 10615 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 10616 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
10617
10618 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10619 more than one row or column as specified with *span*. The remaining
10620 args behave similarly to `wx.Sizer.Add`.
10621
10622 Returns True if the item was successfully placed at the given cell
10623 position, False if something was already there.
10624
d55e5bfc
RD
10625 """
10626 return _core_.GridBagSizer_Add(*args, **kwargs)
10627
10628 def AddItem(*args, **kwargs):
248ed943 10629 """
c1cb24a4 10630 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
10631
10632 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10633 the item was successfully placed at its given cell position, False if
10634 something was already there.
10635 """
d55e5bfc
RD
10636 return _core_.GridBagSizer_AddItem(*args, **kwargs)
10637
84f85550
RD
10638 def GetCellSize(*args, **kwargs):
10639 """
10640 GetCellSize(self, int row, int col) -> Size
10641
10642 Get the size of the specified cell, including hgap and
10643 vgap. Only valid after a Layout.
10644 """
10645 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10646
d55e5bfc 10647 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10648 """
10649 GetEmptyCellSize(self) -> Size
10650
10651 Get the size used for cells in the grid with no item.
10652 """
d55e5bfc
RD
10653 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
10654
10655 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10656 """
10657 SetEmptyCellSize(self, Size sz)
10658
10659 Set the size used for cells in the grid with no item.
10660 """
d55e5bfc
RD
10661 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
10662
10663 def GetItemPosition(*args):
10664 """
248ed943
RD
10665 GetItemPosition(self, item) -> GBPosition
10666
10667 Get the grid position of the specified *item* where *item* is either a
10668 window or subsizer that is a member of this sizer, or a zero-based
10669 index of an item.
d55e5bfc
RD
10670 """
10671 return _core_.GridBagSizer_GetItemPosition(*args)
10672
10673 def SetItemPosition(*args):
10674 """
248ed943
RD
10675 SetItemPosition(self, item, GBPosition pos) -> bool
10676
10677 Set the grid position of the specified *item* where *item* is either a
10678 window or subsizer that is a member of this sizer, or a zero-based
10679 index of an item. Returns True on success. If the move is not
10680 allowed (because an item is already there) then False is returned.
10681
d55e5bfc
RD
10682 """
10683 return _core_.GridBagSizer_SetItemPosition(*args)
10684
10685 def GetItemSpan(*args):
10686 """
248ed943
RD
10687 GetItemSpan(self, item) -> GBSpan
10688
10689 Get the row/col spanning of the specified *item* where *item* is
10690 either a window or subsizer that is a member of this sizer, or a
10691 zero-based index of an item.
d55e5bfc
RD
10692 """
10693 return _core_.GridBagSizer_GetItemSpan(*args)
10694
10695 def SetItemSpan(*args):
10696 """
248ed943
RD
10697 SetItemSpan(self, item, GBSpan span) -> bool
10698
10699 Set the row/col spanning of the specified *item* where *item* is
10700 either a window or subsizer that is a member of this sizer, or a
10701 zero-based index of an item. Returns True on success. If the move is
10702 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
10703 """
10704 return _core_.GridBagSizer_SetItemSpan(*args)
10705
10706 def FindItem(*args):
10707 """
248ed943
RD
10708 FindItem(self, item) -> GBSizerItem
10709
10710 Find the sizer item for the given window or subsizer, returns None if
10711 not found. (non-recursive)
d55e5bfc
RD
10712 """
10713 return _core_.GridBagSizer_FindItem(*args)
10714
10715 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10716 """
10717 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10718
10719 Return the sizer item for the given grid cell, or None if there is no
10720 item at that position. (non-recursive)
10721 """
d55e5bfc
RD
10722 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10723
10724 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10725 """
10726 FindItemAtPoint(self, Point pt) -> GBSizerItem
10727
10728 Return the sizer item located at the point given in *pt*, or None if
10729 there is no item at that point. The (x,y) coordinates in pt correspond
10730 to the client coordinates of the window using the sizer for
10731 layout. (non-recursive)
10732 """
d55e5bfc
RD
10733 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10734
248ed943
RD
10735 def CheckForIntersection(*args, **kwargs):
10736 """
10737 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10738
248ed943
RD
10739 Look at all items and see if any intersect (or would overlap) the
10740 given *item*. Returns True if so, False if there would be no overlap.
10741 If an *excludeItem* is given then it will not be checked for
10742 intersection, for example it may be the item we are checking the
10743 position of.
d55e5bfc 10744
248ed943
RD
10745 """
10746 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10747
248ed943 10748 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10749 """
248ed943
RD
10750 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10751
10752 Look at all items and see if any intersect (or would overlap) the
10753 given position and span. Returns True if so, False if there would be
10754 no overlap. If an *excludeItem* is given then it will not be checked
10755 for intersection, for example it may be the item we are checking the
10756 position of.
d55e5bfc 10757 """
248ed943 10758 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
10759
10760
10761class GridBagSizerPtr(GridBagSizer):
10762 def __init__(self, this):
10763 self.this = this
10764 if not hasattr(self,"thisown"): self.thisown = 0
10765 self.__class__ = GridBagSizer
10766_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10767
10768#---------------------------------------------------------------------------
10769
10770Left = _core_.Left
10771Top = _core_.Top
10772Right = _core_.Right
10773Bottom = _core_.Bottom
10774Width = _core_.Width
10775Height = _core_.Height
10776Centre = _core_.Centre
10777Center = _core_.Center
10778CentreX = _core_.CentreX
10779CentreY = _core_.CentreY
10780Unconstrained = _core_.Unconstrained
10781AsIs = _core_.AsIs
10782PercentOf = _core_.PercentOf
10783Above = _core_.Above
10784Below = _core_.Below
10785LeftOf = _core_.LeftOf
10786RightOf = _core_.RightOf
10787SameAs = _core_.SameAs
10788Absolute = _core_.Absolute
10789class IndividualLayoutConstraint(Object):
10790 """
79fccf9d
RD
10791 Objects of this class are stored in the `wx.LayoutConstraints` class as
10792 one of eight possible constraints that a window can be involved in.
10793 You will never need to create an instance of
10794 wx.IndividualLayoutConstraint, rather you should create a
10795 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10796 that it contains.
d55e5bfc
RD
10797 """
10798 def __init__(self): raise RuntimeError, "No constructor defined"
10799 def __repr__(self):
10800 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10801 def Set(*args, **kwargs):
79fccf9d
RD
10802 """
10803 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10804
10805 Sets the properties of the constraint. Normally called by one of the
10806 convenience functions such as Above, RightOf, SameAs.
10807 """
d55e5bfc
RD
10808 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
10809
10810 def LeftOf(*args, **kwargs):
10811 """
10812 LeftOf(self, Window sibling, int marg=0)
10813
79fccf9d
RD
10814 Constrains this edge to be to the left of the given window, with an
10815 optional margin. Implicitly, this is relative to the left edge of the
10816 other window.
d55e5bfc
RD
10817 """
10818 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
10819
10820 def RightOf(*args, **kwargs):
10821 """
10822 RightOf(self, Window sibling, int marg=0)
10823
79fccf9d
RD
10824 Constrains this edge to be to the right of the given window, with an
10825 optional margin. Implicitly, this is relative to the right edge of the
10826 other window.
d55e5bfc
RD
10827 """
10828 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
10829
10830 def Above(*args, **kwargs):
10831 """
10832 Above(self, Window sibling, int marg=0)
10833
79fccf9d
RD
10834 Constrains this edge to be above the given window, with an optional
10835 margin. Implicitly, this is relative to the top edge of the other
10836 window.
d55e5bfc
RD
10837 """
10838 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
10839
10840 def Below(*args, **kwargs):
10841 """
10842 Below(self, Window sibling, int marg=0)
10843
79fccf9d
RD
10844 Constrains this edge to be below the given window, with an optional
10845 margin. Implicitly, this is relative to the bottom edge of the other
10846 window.
d55e5bfc
RD
10847 """
10848 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
10849
10850 def SameAs(*args, **kwargs):
10851 """
10852 SameAs(self, Window otherW, int edge, int marg=0)
10853
79fccf9d
RD
10854 Constrains this edge or dimension to be to the same as the edge of the
10855 given window, with an optional margin.
d55e5bfc
RD
10856 """
10857 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
10858
10859 def PercentOf(*args, **kwargs):
10860 """
10861 PercentOf(self, Window otherW, int wh, int per)
10862
79fccf9d
RD
10863 Constrains this edge or dimension to be to a percentage of the given
10864 window, with an optional margin.
d55e5bfc
RD
10865 """
10866 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
10867
10868 def Absolute(*args, **kwargs):
10869 """
10870 Absolute(self, int val)
10871
79fccf9d 10872 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
10873 """
10874 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
10875
10876 def Unconstrained(*args, **kwargs):
10877 """
10878 Unconstrained(self)
10879
79fccf9d
RD
10880 Sets this edge or dimension to be unconstrained, that is, dependent on
10881 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
10882 """
10883 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
10884
10885 def AsIs(*args, **kwargs):
10886 """
10887 AsIs(self)
10888
79fccf9d
RD
10889 Sets this edge or constraint to be whatever the window's value is at
10890 the moment. If either of the width and height constraints are *as is*,
10891 the window will not be resized, but moved instead. This is important
10892 when considering panel items which are intended to have a default
10893 size, such as a button, which may take its size from the size of the
10894 button label.
d55e5bfc
RD
10895 """
10896 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
10897
10898 def GetOtherWindow(*args, **kwargs):
10899 """GetOtherWindow(self) -> Window"""
10900 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
10901
10902 def GetMyEdge(*args, **kwargs):
10903 """GetMyEdge(self) -> int"""
10904 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
10905
10906 def SetEdge(*args, **kwargs):
10907 """SetEdge(self, int which)"""
10908 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
10909
10910 def SetValue(*args, **kwargs):
10911 """SetValue(self, int v)"""
10912 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
10913
10914 def GetMargin(*args, **kwargs):
10915 """GetMargin(self) -> int"""
10916 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
10917
10918 def SetMargin(*args, **kwargs):
10919 """SetMargin(self, int m)"""
10920 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
10921
10922 def GetValue(*args, **kwargs):
10923 """GetValue(self) -> int"""
10924 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
10925
10926 def GetPercent(*args, **kwargs):
10927 """GetPercent(self) -> int"""
10928 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
10929
10930 def GetOtherEdge(*args, **kwargs):
10931 """GetOtherEdge(self) -> int"""
10932 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
10933
10934 def GetDone(*args, **kwargs):
10935 """GetDone(self) -> bool"""
10936 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
10937
10938 def SetDone(*args, **kwargs):
10939 """SetDone(self, bool d)"""
10940 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
10941
10942 def GetRelationship(*args, **kwargs):
10943 """GetRelationship(self) -> int"""
10944 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
10945
10946 def SetRelationship(*args, **kwargs):
10947 """SetRelationship(self, int r)"""
10948 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
10949
10950 def ResetIfWin(*args, **kwargs):
10951 """
10952 ResetIfWin(self, Window otherW) -> bool
10953
10954 Reset constraint if it mentions otherWin
10955 """
10956 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
10957
10958 def SatisfyConstraint(*args, **kwargs):
10959 """
10960 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
10961
10962 Try to satisfy constraint
10963 """
10964 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
10965
10966 def GetEdge(*args, **kwargs):
10967 """
10968 GetEdge(self, int which, Window thisWin, Window other) -> int
10969
10970 Get the value of this edge or dimension, or if this
10971 is not determinable, -1.
10972 """
10973 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
10974
10975
10976class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10977 def __init__(self, this):
10978 self.this = this
10979 if not hasattr(self,"thisown"): self.thisown = 0
10980 self.__class__ = IndividualLayoutConstraint
10981_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
10982
10983class LayoutConstraints(Object):
10984 """
79fccf9d
RD
10985 **Note:** constraints are now deprecated and you should use sizers
10986 instead.
d55e5bfc 10987
79fccf9d
RD
10988 Objects of this class can be associated with a window to define its
10989 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
10990
10991 The class consists of the following eight constraints of class
10992 wx.IndividualLayoutConstraint, some or all of which should be accessed
10993 directly to set the appropriate constraints.
10994
10995 * left: represents the left hand edge of the window
10996 * right: represents the right hand edge of the window
10997 * top: represents the top edge of the window
10998 * bottom: represents the bottom edge of the window
10999 * width: represents the width of the window
11000 * height: represents the height of the window
11001 * centreX: represents the horizontal centre point of the window
11002 * centreY: represents the vertical centre point of the window
11003
79fccf9d
RD
11004 Most constraints are initially set to have the relationship
11005 wxUnconstrained, which means that their values should be calculated by
11006 looking at known constraints. The exceptions are width and height,
11007 which are set to wxAsIs to ensure that if the user does not specify a
11008 constraint, the existing width and height will be used, to be
11009 compatible with panel items which often have take a default size. If
11010 the constraint is ``wx.AsIs``, the dimension will not be changed.
11011
11012 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
11013
11014 """
11015 def __repr__(self):
11016 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11017 left = property(_core_.LayoutConstraints_left_get)
11018 top = property(_core_.LayoutConstraints_top_get)
11019 right = property(_core_.LayoutConstraints_right_get)
11020 bottom = property(_core_.LayoutConstraints_bottom_get)
11021 width = property(_core_.LayoutConstraints_width_get)
11022 height = property(_core_.LayoutConstraints_height_get)
11023 centreX = property(_core_.LayoutConstraints_centreX_get)
11024 centreY = property(_core_.LayoutConstraints_centreY_get)
11025 def __init__(self, *args, **kwargs):
11026 """__init__(self) -> LayoutConstraints"""
11027 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
11028 self.this = newobj.this
11029 self.thisown = 1
11030 del newobj.thisown
11031 def SatisfyConstraints(*args, **kwargs):
11032 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
11033 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
11034
11035 def AreSatisfied(*args, **kwargs):
11036 """AreSatisfied(self) -> bool"""
11037 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
11038
11039
11040class LayoutConstraintsPtr(LayoutConstraints):
11041 def __init__(self, this):
11042 self.this = this
11043 if not hasattr(self,"thisown"): self.thisown = 0
11044 self.__class__ = LayoutConstraints
11045_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
11046
11047#----------------------------------------------------------------------------
11048
11049# Use Python's bool constants if available, make some if not
11050try:
11051 True
11052except NameError:
11053 __builtins__.True = 1==1
11054 __builtins__.False = 1==0
11055 def bool(value): return not not value
11056 __builtins__.bool = bool
11057
11058
11059
11060# workarounds for bad wxRTTI names
11061__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
11062__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
11063__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
11064
11065
11066#----------------------------------------------------------------------------
11067# Load version numbers from __version__... Ensure that major and minor
0f63ec68 11068# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD
11069
11070from __version__ import *
11071__version__ = VERSION_STRING
11072
0f63ec68
RD
11073assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
11074assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD
11075if RELEASE_VERSION != _core_.RELEASE_VERSION:
11076 import warnings
0f63ec68 11077 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD
11078
11079#----------------------------------------------------------------------------
11080
62d32a5f
RD
11081# Set the default string<-->unicode conversion encoding from the
11082# locale. This encoding is used when string or unicode objects need
11083# to be converted in order to pass them to wxWidgets. Please be aware
11084# that the default encoding within the same locale may be slightly
11085# different on different platforms. For example, please see
11086# http://www.alanwood.net/demos/charsetdiffs.html for differences
11087# between the common latin/roman encodings.
5cbf236d
RD
11088import locale
11089default = locale.getdefaultlocale()[1]
11090if default:
11091 wx.SetDefaultPyEncoding(default)
11092del default
11093del locale
11094
11095#----------------------------------------------------------------------------
11096
d55e5bfc
RD
11097class PyDeadObjectError(AttributeError):
11098 pass
11099
11100class _wxPyDeadObject(object):
11101 """
11102 Instances of wx objects that are OOR capable will have their __class__
11103 changed to this class when the C++ object is deleted. This should help
11104 prevent crashes due to referencing a bogus C++ pointer.
11105 """
11106 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
11107 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
11108
11109 def __repr__(self):
11110 if not hasattr(self, "_name"):
11111 self._name = "[unknown]"
11112 return self.reprStr % self._name
11113
11114 def __getattr__(self, *args):
11115 if not hasattr(self, "_name"):
11116 self._name = "[unknown]"
11117 raise PyDeadObjectError(self.attrStr % self._name)
11118
11119 def __nonzero__(self):
11120 return 0
11121
11122
11123
11124class PyUnbornObjectError(AttributeError):
11125 pass
11126
11127class _wxPyUnbornObject(object):
11128 """
11129 Some stock objects are created when the wx._core module is
11130 imported, but their C++ instance is not created until the wx.App
11131 object is created and initialized. These object instances will
11132 temporarily have their __class__ changed to this class so an
11133 exception will be raised if they are used before the C++ instance
11134 is ready.
11135 """
11136
11137 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
11138 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
11139
11140 def __repr__(self):
11141 #if not hasattr(self, "_name"):
11142 # self._name = "[unknown]"
11143 return self.reprStr #% self._name
11144
11145 def __getattr__(self, *args):
11146 #if not hasattr(self, "_name"):
11147 # self._name = "[unknown]"
11148 raise PyUnbornObjectError(self.attrStr) # % self._name )
11149
11150 def __nonzero__(self):
11151 return 0
11152
11153
11154#----------------------------------------------------------------------------
d55e5bfc
RD
11155
11156def CallAfter(callable, *args, **kw):
11157 """
11158 Call the specified function after the current and pending event
11159 handlers have been completed. This is also good for making GUI
0439c23b
RD
11160 method calls from non-GUI threads. Any extra positional or
11161 keyword args are passed on to the callable when it is called.
11162
11163 :see: `wx.FutureCall`
d55e5bfc
RD
11164 """
11165 app = wx.GetApp()
a001823c 11166 assert app is not None, 'No wx.App created yet'
d55e5bfc 11167
891bb194
RD
11168 if not hasattr(app, "_CallAfterId"):
11169 app._CallAfterId = wx.NewEventType()
11170 app.Connect(-1, -1, app._CallAfterId,
11171 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 11172 evt = wx.PyEvent()
891bb194 11173 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD
11174 evt.callable = callable
11175 evt.args = args
11176 evt.kw = kw
11177 wx.PostEvent(app, evt)
11178
d55e5bfc
RD
11179#----------------------------------------------------------------------------
11180
11181
11182class FutureCall:
11183 """
8ac8dba0 11184 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD
11185 object once after the given amount of milliseconds, passing any
11186 positional or keyword args. The return value of the callable is
0439c23b 11187 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
11188
11189 If you don't need to get the return value or restart the timer
11190 then there is no need to hold a reference to this object. It will
11191 hold a reference to itself while the timer is running (the timer
11192 has a reference to self.Notify) but the cycle will be broken when
11193 the timer completes, automatically cleaning up the wx.FutureCall
11194 object.
0439c23b
RD
11195
11196 :see: `wx.CallAfter`
d55e5bfc
RD
11197 """
11198 def __init__(self, millis, callable, *args, **kwargs):
11199 self.millis = millis
11200 self.callable = callable
11201 self.SetArgs(*args, **kwargs)
11202 self.runCount = 0
11203 self.running = False
11204 self.hasRun = False
11205 self.result = None
11206 self.timer = None
11207 self.Start()
11208
11209 def __del__(self):
11210 self.Stop()
11211
11212
11213 def Start(self, millis=None, *args, **kwargs):
11214 """
11215 (Re)start the timer
11216 """
11217 self.hasRun = False
11218 if millis is not None:
11219 self.millis = millis
11220 if args or kwargs:
11221 self.SetArgs(*args, **kwargs)
11222 self.Stop()
11223 self.timer = wx.PyTimer(self.Notify)
11224 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
11225 self.running = True
11226 Restart = Start
11227
11228
11229 def Stop(self):
11230 """
11231 Stop and destroy the timer.
11232 """
11233 if self.timer is not None:
11234 self.timer.Stop()
11235 self.timer = None
11236
11237
11238 def GetInterval(self):
11239 if self.timer is not None:
11240 return self.timer.GetInterval()
11241 else:
11242 return 0
11243
11244
11245 def IsRunning(self):
11246 return self.timer is not None and self.timer.IsRunning()
11247
11248
11249 def SetArgs(self, *args, **kwargs):
11250 """
11251 (Re)set the args passed to the callable object. This is
11252 useful in conjunction with Restart if you want to schedule a
11253 new call to the same callable object but with different
11254 parameters.
11255 """
11256 self.args = args
11257 self.kwargs = kwargs
11258
11259
11260 def HasRun(self):
11261 return self.hasRun
11262
11263 def GetResult(self):
11264 return self.result
11265
11266 def Notify(self):
11267 """
11268 The timer has expired so call the callable.
11269 """
11270 if self.callable and getattr(self.callable, 'im_self', True):
11271 self.runCount += 1
11272 self.running = False
11273 self.result = self.callable(*self.args, **self.kwargs)
11274 self.hasRun = True
11275 if not self.running:
11276 # if it wasn't restarted, then cleanup
11277 wx.CallAfter(self.Stop)
11278
11279
11280
11281#----------------------------------------------------------------------------
11282# Control which items in this module should be documented by epydoc.
11283# We allow only classes and functions, which will help reduce the size
11284# of the docs by filtering out the zillions of constants, EVT objects,
11285# and etc that don't make much sense by themselves, but are instead
11286# documented (or will be) as part of the classes/functions/methods
11287# where they should be used.
11288
c24da6d6
RD
11289class __DocFilter:
11290 """
11291 A filter for epydoc that only allows non-Ptr classes and
11292 fucntions, in order to reduce the clutter in the API docs.
11293 """
11294 def __init__(self, globals):
11295 self._globals = globals
11296
11297 def __call__(self, name):
11298 import types
11299 obj = self._globals.get(name, None)
11300 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11301 return False
11302 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11303 return False
11304 return True
d55e5bfc
RD
11305
11306#----------------------------------------------------------------------------
11307#----------------------------------------------------------------------------
11308
11309# Import other modules in this package that should show up in the
11310# "core" wx namespace
11311from _gdi import *
11312from _windows import *
11313from _controls import *
11314from _misc import *
11315
11316
11317# Fixup the stock objects since they can't be used yet. (They will be
11318# restored in wx.PyApp.OnInit.)
11319_core_._wxPyFixStockObjects()
11320
11321#----------------------------------------------------------------------------
11322#----------------------------------------------------------------------------
11323
11324