]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
Allow the frame (if there is one) to resize the toolbar after Realize
[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
57133d5c 88DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
6d88e192 89DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
d55e5bfc
RD
90TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
91WANTS_CHARS = _core_.WANTS_CHARS
92POPUP_WINDOW = _core_.POPUP_WINDOW
93CENTER_FRAME = _core_.CENTER_FRAME
94CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
95CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
d55e5bfc
RD
96CLIP_CHILDREN = _core_.CLIP_CHILDREN
97CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
98ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
99RETAINED = _core_.RETAINED
100BACKINGSTORE = _core_.BACKINGSTORE
101COLOURED = _core_.COLOURED
102FIXED_LENGTH = _core_.FIXED_LENGTH
103LB_NEEDED_SB = _core_.LB_NEEDED_SB
104LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
105LB_SORT = _core_.LB_SORT
106LB_SINGLE = _core_.LB_SINGLE
107LB_MULTIPLE = _core_.LB_MULTIPLE
108LB_EXTENDED = _core_.LB_EXTENDED
109LB_OWNERDRAW = _core_.LB_OWNERDRAW
110LB_HSCROLL = _core_.LB_HSCROLL
111PROCESS_ENTER = _core_.PROCESS_ENTER
112PASSWORD = _core_.PASSWORD
113CB_SIMPLE = _core_.CB_SIMPLE
114CB_DROPDOWN = _core_.CB_DROPDOWN
115CB_SORT = _core_.CB_SORT
116CB_READONLY = _core_.CB_READONLY
117RA_HORIZONTAL = _core_.RA_HORIZONTAL
118RA_VERTICAL = _core_.RA_VERTICAL
119RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
120RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 121RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
d55e5bfc
RD
122RB_GROUP = _core_.RB_GROUP
123RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD
124SB_HORIZONTAL = _core_.SB_HORIZONTAL
125SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 126RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
RD
127ST_SIZEGRIP = _core_.ST_SIZEGRIP
128ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
129FLOOD_SURFACE = _core_.FLOOD_SURFACE
130FLOOD_BORDER = _core_.FLOOD_BORDER
131ODDEVEN_RULE = _core_.ODDEVEN_RULE
132WINDING_RULE = _core_.WINDING_RULE
133TOOL_TOP = _core_.TOOL_TOP
134TOOL_BOTTOM = _core_.TOOL_BOTTOM
135TOOL_LEFT = _core_.TOOL_LEFT
136TOOL_RIGHT = _core_.TOOL_RIGHT
137OK = _core_.OK
138YES_NO = _core_.YES_NO
139CANCEL = _core_.CANCEL
140YES = _core_.YES
141NO = _core_.NO
142NO_DEFAULT = _core_.NO_DEFAULT
143YES_DEFAULT = _core_.YES_DEFAULT
144ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
145ICON_HAND = _core_.ICON_HAND
146ICON_QUESTION = _core_.ICON_QUESTION
147ICON_INFORMATION = _core_.ICON_INFORMATION
148ICON_STOP = _core_.ICON_STOP
149ICON_ASTERISK = _core_.ICON_ASTERISK
150ICON_MASK = _core_.ICON_MASK
151ICON_WARNING = _core_.ICON_WARNING
152ICON_ERROR = _core_.ICON_ERROR
153FORWARD = _core_.FORWARD
154BACKWARD = _core_.BACKWARD
155RESET = _core_.RESET
156HELP = _core_.HELP
157MORE = _core_.MORE
158SETUP = _core_.SETUP
159SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
160SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
161SIZE_AUTO = _core_.SIZE_AUTO
162SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
163SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
9d7dfdff 164SIZE_FORCE = _core_.SIZE_FORCE
d55e5bfc
RD
165PORTRAIT = _core_.PORTRAIT
166LANDSCAPE = _core_.LANDSCAPE
167PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
168PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
169PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
170PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
171ID_ANY = _core_.ID_ANY
172ID_SEPARATOR = _core_.ID_SEPARATOR
9d7dfdff 173ID_NONE = _core_.ID_NONE
d55e5bfc
RD
174ID_LOWEST = _core_.ID_LOWEST
175ID_OPEN = _core_.ID_OPEN
176ID_CLOSE = _core_.ID_CLOSE
177ID_NEW = _core_.ID_NEW
178ID_SAVE = _core_.ID_SAVE
179ID_SAVEAS = _core_.ID_SAVEAS
180ID_REVERT = _core_.ID_REVERT
181ID_EXIT = _core_.ID_EXIT
182ID_UNDO = _core_.ID_UNDO
183ID_REDO = _core_.ID_REDO
184ID_HELP = _core_.ID_HELP
185ID_PRINT = _core_.ID_PRINT
186ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
187ID_PREVIEW = _core_.ID_PREVIEW
188ID_ABOUT = _core_.ID_ABOUT
189ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
190ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
191ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
192ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
193ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
194ID_PREFERENCES = _core_.ID_PREFERENCES
195ID_CUT = _core_.ID_CUT
196ID_COPY = _core_.ID_COPY
197ID_PASTE = _core_.ID_PASTE
198ID_CLEAR = _core_.ID_CLEAR
199ID_FIND = _core_.ID_FIND
200ID_DUPLICATE = _core_.ID_DUPLICATE
201ID_SELECTALL = _core_.ID_SELECTALL
202ID_DELETE = _core_.ID_DELETE
203ID_REPLACE = _core_.ID_REPLACE
204ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
205ID_PROPERTIES = _core_.ID_PROPERTIES
206ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
207ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
208ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
209ID_VIEW_LIST = _core_.ID_VIEW_LIST
210ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
211ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
212ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
213ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
214ID_FILE1 = _core_.ID_FILE1
215ID_FILE2 = _core_.ID_FILE2
216ID_FILE3 = _core_.ID_FILE3
217ID_FILE4 = _core_.ID_FILE4
218ID_FILE5 = _core_.ID_FILE5
219ID_FILE6 = _core_.ID_FILE6
220ID_FILE7 = _core_.ID_FILE7
221ID_FILE8 = _core_.ID_FILE8
222ID_FILE9 = _core_.ID_FILE9
223ID_OK = _core_.ID_OK
224ID_CANCEL = _core_.ID_CANCEL
225ID_APPLY = _core_.ID_APPLY
226ID_YES = _core_.ID_YES
227ID_NO = _core_.ID_NO
228ID_STATIC = _core_.ID_STATIC
229ID_FORWARD = _core_.ID_FORWARD
230ID_BACKWARD = _core_.ID_BACKWARD
231ID_DEFAULT = _core_.ID_DEFAULT
232ID_MORE = _core_.ID_MORE
233ID_SETUP = _core_.ID_SETUP
234ID_RESET = _core_.ID_RESET
235ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
236ID_YESTOALL = _core_.ID_YESTOALL
237ID_NOTOALL = _core_.ID_NOTOALL
238ID_ABORT = _core_.ID_ABORT
239ID_RETRY = _core_.ID_RETRY
240ID_IGNORE = _core_.ID_IGNORE
0f63ec68
RD
241ID_ADD = _core_.ID_ADD
242ID_REMOVE = _core_.ID_REMOVE
243ID_UP = _core_.ID_UP
244ID_DOWN = _core_.ID_DOWN
245ID_HOME = _core_.ID_HOME
246ID_REFRESH = _core_.ID_REFRESH
247ID_STOP = _core_.ID_STOP
248ID_INDEX = _core_.ID_INDEX
249ID_BOLD = _core_.ID_BOLD
250ID_ITALIC = _core_.ID_ITALIC
251ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
252ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
253ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
254ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
255ID_UNDERLINE = _core_.ID_UNDERLINE
256ID_INDENT = _core_.ID_INDENT
257ID_UNINDENT = _core_.ID_UNINDENT
258ID_ZOOM_100 = _core_.ID_ZOOM_100
259ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
260ID_ZOOM_IN = _core_.ID_ZOOM_IN
261ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
262ID_UNDELETE = _core_.ID_UNDELETE
263ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
d55e5bfc
RD
264ID_HIGHEST = _core_.ID_HIGHEST
265OPEN = _core_.OPEN
266SAVE = _core_.SAVE
267HIDE_READONLY = _core_.HIDE_READONLY
268OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
269FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
270MULTIPLE = _core_.MULTIPLE
271CHANGE_DIR = _core_.CHANGE_DIR
272ACCEL_ALT = _core_.ACCEL_ALT
273ACCEL_CTRL = _core_.ACCEL_CTRL
274ACCEL_SHIFT = _core_.ACCEL_SHIFT
275ACCEL_NORMAL = _core_.ACCEL_NORMAL
276PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
277PD_APP_MODAL = _core_.PD_APP_MODAL
278PD_CAN_ABORT = _core_.PD_CAN_ABORT
279PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
280PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
281PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
62d32a5f
RD
282PD_SMOOTH = _core_.PD_SMOOTH
283PD_CAN_SKIP = _core_.PD_CAN_SKIP
d55e5bfc
RD
284DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
285DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
286MENU_TEAROFF = _core_.MENU_TEAROFF
287MB_DOCKABLE = _core_.MB_DOCKABLE
288NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
289FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
290LI_HORIZONTAL = _core_.LI_HORIZONTAL
291LI_VERTICAL = _core_.LI_VERTICAL
292WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
293WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
294WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
295WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
296WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
297WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
298MM_TEXT = _core_.MM_TEXT
299MM_LOMETRIC = _core_.MM_LOMETRIC
300MM_HIMETRIC = _core_.MM_HIMETRIC
301MM_LOENGLISH = _core_.MM_LOENGLISH
302MM_HIENGLISH = _core_.MM_HIENGLISH
303MM_TWIPS = _core_.MM_TWIPS
304MM_ISOTROPIC = _core_.MM_ISOTROPIC
305MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
306MM_POINTS = _core_.MM_POINTS
307MM_METRIC = _core_.MM_METRIC
308CENTRE = _core_.CENTRE
309CENTER = _core_.CENTER
310HORIZONTAL = _core_.HORIZONTAL
311VERTICAL = _core_.VERTICAL
312BOTH = _core_.BOTH
313LEFT = _core_.LEFT
314RIGHT = _core_.RIGHT
315UP = _core_.UP
316DOWN = _core_.DOWN
317TOP = _core_.TOP
318BOTTOM = _core_.BOTTOM
319NORTH = _core_.NORTH
320SOUTH = _core_.SOUTH
321WEST = _core_.WEST
322EAST = _core_.EAST
323ALL = _core_.ALL
324ALIGN_NOT = _core_.ALIGN_NOT
325ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
326ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
327ALIGN_LEFT = _core_.ALIGN_LEFT
328ALIGN_TOP = _core_.ALIGN_TOP
329ALIGN_RIGHT = _core_.ALIGN_RIGHT
330ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
331ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
332ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
333ALIGN_CENTER = _core_.ALIGN_CENTER
334ALIGN_CENTRE = _core_.ALIGN_CENTRE
335ALIGN_MASK = _core_.ALIGN_MASK
336STRETCH_NOT = _core_.STRETCH_NOT
337SHRINK = _core_.SHRINK
338GROW = _core_.GROW
339EXPAND = _core_.EXPAND
340SHAPED = _core_.SHAPED
341FIXED_MINSIZE = _core_.FIXED_MINSIZE
342TILE = _core_.TILE
343ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
344BORDER_DEFAULT = _core_.BORDER_DEFAULT
345BORDER_NONE = _core_.BORDER_NONE
346BORDER_STATIC = _core_.BORDER_STATIC
347BORDER_SIMPLE = _core_.BORDER_SIMPLE
348BORDER_RAISED = _core_.BORDER_RAISED
349BORDER_SUNKEN = _core_.BORDER_SUNKEN
350BORDER_DOUBLE = _core_.BORDER_DOUBLE
351BORDER_MASK = _core_.BORDER_MASK
0f63ec68
RD
352BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
353BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
354BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD
355DEFAULT = _core_.DEFAULT
356DECORATIVE = _core_.DECORATIVE
357ROMAN = _core_.ROMAN
358SCRIPT = _core_.SCRIPT
359SWISS = _core_.SWISS
360MODERN = _core_.MODERN
361TELETYPE = _core_.TELETYPE
362VARIABLE = _core_.VARIABLE
363FIXED = _core_.FIXED
364NORMAL = _core_.NORMAL
365LIGHT = _core_.LIGHT
366BOLD = _core_.BOLD
367ITALIC = _core_.ITALIC
368SLANT = _core_.SLANT
369SOLID = _core_.SOLID
370DOT = _core_.DOT
371LONG_DASH = _core_.LONG_DASH
372SHORT_DASH = _core_.SHORT_DASH
373DOT_DASH = _core_.DOT_DASH
374USER_DASH = _core_.USER_DASH
375TRANSPARENT = _core_.TRANSPARENT
376STIPPLE = _core_.STIPPLE
d04418a7
RD
377STIPPLE_MASK = _core_.STIPPLE_MASK
378STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
d55e5bfc
RD
379BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
380CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
381FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
382CROSS_HATCH = _core_.CROSS_HATCH
383HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
384VERTICAL_HATCH = _core_.VERTICAL_HATCH
385JOIN_BEVEL = _core_.JOIN_BEVEL
386JOIN_MITER = _core_.JOIN_MITER
387JOIN_ROUND = _core_.JOIN_ROUND
388CAP_ROUND = _core_.CAP_ROUND
389CAP_PROJECTING = _core_.CAP_PROJECTING
390CAP_BUTT = _core_.CAP_BUTT
391CLEAR = _core_.CLEAR
392XOR = _core_.XOR
393INVERT = _core_.INVERT
394OR_REVERSE = _core_.OR_REVERSE
395AND_REVERSE = _core_.AND_REVERSE
396COPY = _core_.COPY
397AND = _core_.AND
398AND_INVERT = _core_.AND_INVERT
399NO_OP = _core_.NO_OP
400NOR = _core_.NOR
401EQUIV = _core_.EQUIV
402SRC_INVERT = _core_.SRC_INVERT
403OR_INVERT = _core_.OR_INVERT
404NAND = _core_.NAND
405OR = _core_.OR
406SET = _core_.SET
407WXK_BACK = _core_.WXK_BACK
408WXK_TAB = _core_.WXK_TAB
409WXK_RETURN = _core_.WXK_RETURN
410WXK_ESCAPE = _core_.WXK_ESCAPE
411WXK_SPACE = _core_.WXK_SPACE
412WXK_DELETE = _core_.WXK_DELETE
413WXK_START = _core_.WXK_START
414WXK_LBUTTON = _core_.WXK_LBUTTON
415WXK_RBUTTON = _core_.WXK_RBUTTON
416WXK_CANCEL = _core_.WXK_CANCEL
417WXK_MBUTTON = _core_.WXK_MBUTTON
418WXK_CLEAR = _core_.WXK_CLEAR
419WXK_SHIFT = _core_.WXK_SHIFT
420WXK_ALT = _core_.WXK_ALT
421WXK_CONTROL = _core_.WXK_CONTROL
422WXK_MENU = _core_.WXK_MENU
423WXK_PAUSE = _core_.WXK_PAUSE
424WXK_CAPITAL = _core_.WXK_CAPITAL
425WXK_PRIOR = _core_.WXK_PRIOR
426WXK_NEXT = _core_.WXK_NEXT
427WXK_END = _core_.WXK_END
428WXK_HOME = _core_.WXK_HOME
429WXK_LEFT = _core_.WXK_LEFT
430WXK_UP = _core_.WXK_UP
431WXK_RIGHT = _core_.WXK_RIGHT
432WXK_DOWN = _core_.WXK_DOWN
433WXK_SELECT = _core_.WXK_SELECT
434WXK_PRINT = _core_.WXK_PRINT
435WXK_EXECUTE = _core_.WXK_EXECUTE
436WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
437WXK_INSERT = _core_.WXK_INSERT
438WXK_HELP = _core_.WXK_HELP
439WXK_NUMPAD0 = _core_.WXK_NUMPAD0
440WXK_NUMPAD1 = _core_.WXK_NUMPAD1
441WXK_NUMPAD2 = _core_.WXK_NUMPAD2
442WXK_NUMPAD3 = _core_.WXK_NUMPAD3
443WXK_NUMPAD4 = _core_.WXK_NUMPAD4
444WXK_NUMPAD5 = _core_.WXK_NUMPAD5
445WXK_NUMPAD6 = _core_.WXK_NUMPAD6
446WXK_NUMPAD7 = _core_.WXK_NUMPAD7
447WXK_NUMPAD8 = _core_.WXK_NUMPAD8
448WXK_NUMPAD9 = _core_.WXK_NUMPAD9
449WXK_MULTIPLY = _core_.WXK_MULTIPLY
450WXK_ADD = _core_.WXK_ADD
451WXK_SEPARATOR = _core_.WXK_SEPARATOR
452WXK_SUBTRACT = _core_.WXK_SUBTRACT
453WXK_DECIMAL = _core_.WXK_DECIMAL
454WXK_DIVIDE = _core_.WXK_DIVIDE
455WXK_F1 = _core_.WXK_F1
456WXK_F2 = _core_.WXK_F2
457WXK_F3 = _core_.WXK_F3
458WXK_F4 = _core_.WXK_F4
459WXK_F5 = _core_.WXK_F5
460WXK_F6 = _core_.WXK_F6
461WXK_F7 = _core_.WXK_F7
462WXK_F8 = _core_.WXK_F8
463WXK_F9 = _core_.WXK_F9
464WXK_F10 = _core_.WXK_F10
465WXK_F11 = _core_.WXK_F11
466WXK_F12 = _core_.WXK_F12
467WXK_F13 = _core_.WXK_F13
468WXK_F14 = _core_.WXK_F14
469WXK_F15 = _core_.WXK_F15
470WXK_F16 = _core_.WXK_F16
471WXK_F17 = _core_.WXK_F17
472WXK_F18 = _core_.WXK_F18
473WXK_F19 = _core_.WXK_F19
474WXK_F20 = _core_.WXK_F20
475WXK_F21 = _core_.WXK_F21
476WXK_F22 = _core_.WXK_F22
477WXK_F23 = _core_.WXK_F23
478WXK_F24 = _core_.WXK_F24
479WXK_NUMLOCK = _core_.WXK_NUMLOCK
480WXK_SCROLL = _core_.WXK_SCROLL
481WXK_PAGEUP = _core_.WXK_PAGEUP
482WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
483WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
484WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
485WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
486WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
487WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
488WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
489WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
490WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
491WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
492WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
493WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
494WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
495WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
496WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
497WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
498WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
499WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
500WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
501WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
502WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
503WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
504WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
505WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
506WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
507WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
508WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
509WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
510WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
511WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
512WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD
513WXK_COMMAND = _core_.WXK_COMMAND
514WXK_SPECIAL1 = _core_.WXK_SPECIAL1
515WXK_SPECIAL2 = _core_.WXK_SPECIAL2
516WXK_SPECIAL3 = _core_.WXK_SPECIAL3
517WXK_SPECIAL4 = _core_.WXK_SPECIAL4
518WXK_SPECIAL5 = _core_.WXK_SPECIAL5
519WXK_SPECIAL6 = _core_.WXK_SPECIAL6
520WXK_SPECIAL7 = _core_.WXK_SPECIAL7
521WXK_SPECIAL8 = _core_.WXK_SPECIAL8
522WXK_SPECIAL9 = _core_.WXK_SPECIAL9
523WXK_SPECIAL10 = _core_.WXK_SPECIAL10
524WXK_SPECIAL11 = _core_.WXK_SPECIAL11
525WXK_SPECIAL12 = _core_.WXK_SPECIAL12
526WXK_SPECIAL13 = _core_.WXK_SPECIAL13
527WXK_SPECIAL14 = _core_.WXK_SPECIAL14
528WXK_SPECIAL15 = _core_.WXK_SPECIAL15
529WXK_SPECIAL16 = _core_.WXK_SPECIAL16
530WXK_SPECIAL17 = _core_.WXK_SPECIAL17
531WXK_SPECIAL18 = _core_.WXK_SPECIAL18
532WXK_SPECIAL19 = _core_.WXK_SPECIAL19
533WXK_SPECIAL20 = _core_.WXK_SPECIAL20
d55e5bfc
RD
534PAPER_NONE = _core_.PAPER_NONE
535PAPER_LETTER = _core_.PAPER_LETTER
536PAPER_LEGAL = _core_.PAPER_LEGAL
537PAPER_A4 = _core_.PAPER_A4
538PAPER_CSHEET = _core_.PAPER_CSHEET
539PAPER_DSHEET = _core_.PAPER_DSHEET
540PAPER_ESHEET = _core_.PAPER_ESHEET
541PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
542PAPER_TABLOID = _core_.PAPER_TABLOID
543PAPER_LEDGER = _core_.PAPER_LEDGER
544PAPER_STATEMENT = _core_.PAPER_STATEMENT
545PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
546PAPER_A3 = _core_.PAPER_A3
547PAPER_A4SMALL = _core_.PAPER_A4SMALL
548PAPER_A5 = _core_.PAPER_A5
549PAPER_B4 = _core_.PAPER_B4
550PAPER_B5 = _core_.PAPER_B5
551PAPER_FOLIO = _core_.PAPER_FOLIO
552PAPER_QUARTO = _core_.PAPER_QUARTO
553PAPER_10X14 = _core_.PAPER_10X14
554PAPER_11X17 = _core_.PAPER_11X17
555PAPER_NOTE = _core_.PAPER_NOTE
556PAPER_ENV_9 = _core_.PAPER_ENV_9
557PAPER_ENV_10 = _core_.PAPER_ENV_10
558PAPER_ENV_11 = _core_.PAPER_ENV_11
559PAPER_ENV_12 = _core_.PAPER_ENV_12
560PAPER_ENV_14 = _core_.PAPER_ENV_14
561PAPER_ENV_DL = _core_.PAPER_ENV_DL
562PAPER_ENV_C5 = _core_.PAPER_ENV_C5
563PAPER_ENV_C3 = _core_.PAPER_ENV_C3
564PAPER_ENV_C4 = _core_.PAPER_ENV_C4
565PAPER_ENV_C6 = _core_.PAPER_ENV_C6
566PAPER_ENV_C65 = _core_.PAPER_ENV_C65
567PAPER_ENV_B4 = _core_.PAPER_ENV_B4
568PAPER_ENV_B5 = _core_.PAPER_ENV_B5
569PAPER_ENV_B6 = _core_.PAPER_ENV_B6
570PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
571PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
572PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
573PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
574PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
575PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
576PAPER_ISO_B4 = _core_.PAPER_ISO_B4
577PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
578PAPER_9X11 = _core_.PAPER_9X11
579PAPER_10X11 = _core_.PAPER_10X11
580PAPER_15X11 = _core_.PAPER_15X11
581PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
582PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
583PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
584PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
585PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
586PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
587PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
588PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
589PAPER_A_PLUS = _core_.PAPER_A_PLUS
590PAPER_B_PLUS = _core_.PAPER_B_PLUS
591PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
592PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
593PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
594PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
595PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
596PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
597PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
598PAPER_A2 = _core_.PAPER_A2
599PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
600PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
034e3677
RD
601PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
602PAPER_A6 = _core_.PAPER_A6
603PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
604PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
605PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
606PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
607PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
608PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
609PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
610PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
611PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
612PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
613PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
614PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
615PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
616PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
617PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
618PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
619PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
620PAPER_B6_JIS = _core_.PAPER_B6_JIS
621PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
622PAPER_12X11 = _core_.PAPER_12X11
623PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
624PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
625PAPER_P16K = _core_.PAPER_P16K
626PAPER_P32K = _core_.PAPER_P32K
627PAPER_P32KBIG = _core_.PAPER_P32KBIG
628PAPER_PENV_1 = _core_.PAPER_PENV_1
629PAPER_PENV_2 = _core_.PAPER_PENV_2
630PAPER_PENV_3 = _core_.PAPER_PENV_3
631PAPER_PENV_4 = _core_.PAPER_PENV_4
632PAPER_PENV_5 = _core_.PAPER_PENV_5
633PAPER_PENV_6 = _core_.PAPER_PENV_6
634PAPER_PENV_7 = _core_.PAPER_PENV_7
635PAPER_PENV_8 = _core_.PAPER_PENV_8
636PAPER_PENV_9 = _core_.PAPER_PENV_9
637PAPER_PENV_10 = _core_.PAPER_PENV_10
638PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
639PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
640PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
641PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
642PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
643PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
644PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
645PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
646PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
647PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
648PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
649PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
650PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
d55e5bfc
RD
651DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
652DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
653DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
654ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
655ITEM_NORMAL = _core_.ITEM_NORMAL
656ITEM_CHECK = _core_.ITEM_CHECK
657ITEM_RADIO = _core_.ITEM_RADIO
658ITEM_MAX = _core_.ITEM_MAX
659HT_NOWHERE = _core_.HT_NOWHERE
660HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
661HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
662HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
663HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
664HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
665HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
666HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
667HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
668HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
669HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
670HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
671HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
672HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
673HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
674HT_MAX = _core_.HT_MAX
675MOD_NONE = _core_.MOD_NONE
676MOD_ALT = _core_.MOD_ALT
677MOD_CONTROL = _core_.MOD_CONTROL
9d7dfdff 678MOD_ALTGR = _core_.MOD_ALTGR
d55e5bfc 679MOD_SHIFT = _core_.MOD_SHIFT
9d7dfdff 680MOD_META = _core_.MOD_META
d55e5bfc 681MOD_WIN = _core_.MOD_WIN
9d7dfdff
RD
682MOD_CMD = _core_.MOD_CMD
683MOD_ALL = _core_.MOD_ALL
d55e5bfc
RD
684UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
685UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
686UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
687#---------------------------------------------------------------------------
688
689class Object(object):
690 """
691 The base class for most wx objects, although in wxPython not
692 much functionality is needed nor exposed.
693 """
694 def __init__(self): raise RuntimeError, "No constructor defined"
695 def __repr__(self):
696 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
697 def GetClassName(*args, **kwargs):
698 """
699 GetClassName(self) -> String
700
701 Returns the class name of the C++ class using wxRTTI.
702 """
703 return _core_.Object_GetClassName(*args, **kwargs)
704
705 def Destroy(*args, **kwargs):
706 """
707 Destroy(self)
708
709 Deletes the C++ object this Python object is a proxy for.
710 """
711 return _core_.Object_Destroy(*args, **kwargs)
712
713
714class ObjectPtr(Object):
715 def __init__(self, this):
716 self.this = this
717 if not hasattr(self,"thisown"): self.thisown = 0
718 self.__class__ = Object
719_core_.Object_swigregister(ObjectPtr)
720_wxPySetDictionary = _core_._wxPySetDictionary
721
722_wxPyFixStockObjects = _core_._wxPyFixStockObjects
723
724cvar = _core_.cvar
725EmptyString = cvar.EmptyString
726
727#---------------------------------------------------------------------------
728
729BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
730BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
731BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
732BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
733BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
734BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
735BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
736BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
737BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
738BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
739BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
740BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
741BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
742BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
743BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
744BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
745BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
746BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
747BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
748BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
749CURSOR_NONE = _core_.CURSOR_NONE
750CURSOR_ARROW = _core_.CURSOR_ARROW
751CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
752CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
753CURSOR_CHAR = _core_.CURSOR_CHAR
754CURSOR_CROSS = _core_.CURSOR_CROSS
755CURSOR_HAND = _core_.CURSOR_HAND
756CURSOR_IBEAM = _core_.CURSOR_IBEAM
757CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
758CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
759CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
760CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
761CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
762CURSOR_PENCIL = _core_.CURSOR_PENCIL
763CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
764CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
765CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
766CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
767CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
768CURSOR_SIZENS = _core_.CURSOR_SIZENS
769CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
770CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
771CURSOR_SIZING = _core_.CURSOR_SIZING
772CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
773CURSOR_WAIT = _core_.CURSOR_WAIT
774CURSOR_WATCH = _core_.CURSOR_WATCH
775CURSOR_BLANK = _core_.CURSOR_BLANK
776CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
777CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
778CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
779CURSOR_MAX = _core_.CURSOR_MAX
780#---------------------------------------------------------------------------
781
782class Size(object):
783 """
79fccf9d 784 wx.Size is a useful data structure used to represent the size of
093d3ff1
RD
785 something. It simply contians integer width and height
786 proprtites. In most places in wxPython where a wx.Size is
787 expected a (width, height) tuple can be used instead.
d55e5bfc
RD
788 """
789 def __repr__(self):
790 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
791 width = property(_core_.Size_width_get, _core_.Size_width_set)
792 height = property(_core_.Size_height_get, _core_.Size_height_set)
793 x = width; y = height
794 def __init__(self, *args, **kwargs):
795 """
796 __init__(self, int w=0, int h=0) -> Size
797
798 Creates a size object.
799 """
800 newobj = _core_.new_Size(*args, **kwargs)
801 self.this = newobj.this
802 self.thisown = 1
803 del newobj.thisown
804 def __del__(self, destroy=_core_.delete_Size):
805 """__del__(self)"""
806 try:
807 if self.thisown: destroy(self)
808 except: pass
809
810 def __eq__(*args, **kwargs):
811 """
812 __eq__(self, Size sz) -> bool
813
814 Test for equality of wx.Size objects.
815 """
816 return _core_.Size___eq__(*args, **kwargs)
817
818 def __ne__(*args, **kwargs):
819 """
820 __ne__(self, Size sz) -> bool
821
822 Test for inequality.
823 """
824 return _core_.Size___ne__(*args, **kwargs)
825
826 def __add__(*args, **kwargs):
827 """
828 __add__(self, Size sz) -> Size
829
830 Add sz's proprties to this and return the result.
831 """
832 return _core_.Size___add__(*args, **kwargs)
833
834 def __sub__(*args, **kwargs):
835 """
836 __sub__(self, Size sz) -> Size
837
838 Subtract sz's properties from this and return the result.
839 """
840 return _core_.Size___sub__(*args, **kwargs)
841
842 def IncTo(*args, **kwargs):
843 """
844 IncTo(self, Size sz)
845
846 Increments this object so that both of its dimensions are not less
847 than the corresponding dimensions of the size.
848 """
849 return _core_.Size_IncTo(*args, **kwargs)
850
851 def DecTo(*args, **kwargs):
852 """
853 DecTo(self, Size sz)
854
855 Decrements this object so that both of its dimensions are not greater
856 than the corresponding dimensions of the size.
857 """
858 return _core_.Size_DecTo(*args, **kwargs)
859
860 def Set(*args, **kwargs):
861 """
862 Set(self, int w, int h)
863
864 Set both width and height.
865 """
866 return _core_.Size_Set(*args, **kwargs)
867
868 def SetWidth(*args, **kwargs):
869 """SetWidth(self, int w)"""
870 return _core_.Size_SetWidth(*args, **kwargs)
871
872 def SetHeight(*args, **kwargs):
873 """SetHeight(self, int h)"""
874 return _core_.Size_SetHeight(*args, **kwargs)
875
876 def GetWidth(*args, **kwargs):
877 """GetWidth(self) -> int"""
878 return _core_.Size_GetWidth(*args, **kwargs)
879
880 def GetHeight(*args, **kwargs):
881 """GetHeight(self) -> int"""
882 return _core_.Size_GetHeight(*args, **kwargs)
883
884 def IsFullySpecified(*args, **kwargs):
885 """
886 IsFullySpecified(self) -> bool
887
888 Returns True if both components of the size are non-default values.
889 """
890 return _core_.Size_IsFullySpecified(*args, **kwargs)
891
892 def SetDefaults(*args, **kwargs):
893 """
894 SetDefaults(self, Size size)
895
79fccf9d
RD
896 Combine this size with the other one replacing the default components
897 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD
898 """
899 return _core_.Size_SetDefaults(*args, **kwargs)
900
901 def Get(*args, **kwargs):
902 """
903 Get() -> (width,height)
904
905 Returns the width and height properties as a tuple.
906 """
907 return _core_.Size_Get(*args, **kwargs)
908
79fccf9d 909 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
910 def __str__(self): return str(self.Get())
911 def __repr__(self): return 'wx.Size'+str(self.Get())
912 def __len__(self): return len(self.Get())
913 def __getitem__(self, index): return self.Get()[index]
914 def __setitem__(self, index, val):
915 if index == 0: self.width = val
916 elif index == 1: self.height = val
917 else: raise IndexError
918 def __nonzero__(self): return self.Get() != (0,0)
919 __safe_for_unpickling__ = True
920 def __reduce__(self): return (wx.Size, self.Get())
921
922
923class SizePtr(Size):
924 def __init__(self, this):
925 self.this = this
926 if not hasattr(self,"thisown"): self.thisown = 0
927 self.__class__ = Size
928_core_.Size_swigregister(SizePtr)
929
930#---------------------------------------------------------------------------
931
932class RealPoint(object):
933 """
79fccf9d
RD
934 A data structure for representing a point or position with floating
935 point x and y properties. In wxPython most places that expect a
936 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc
RD
937 """
938 def __repr__(self):
939 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
940 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
941 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
942 def __init__(self, *args, **kwargs):
943 """
944 __init__(self, double x=0.0, double y=0.0) -> RealPoint
945
946 Create a wx.RealPoint object
947 """
948 newobj = _core_.new_RealPoint(*args, **kwargs)
949 self.this = newobj.this
950 self.thisown = 1
951 del newobj.thisown
952 def __del__(self, destroy=_core_.delete_RealPoint):
953 """__del__(self)"""
954 try:
955 if self.thisown: destroy(self)
956 except: pass
957
958 def __eq__(*args, **kwargs):
959 """
960 __eq__(self, RealPoint pt) -> bool
961
962 Test for equality of wx.RealPoint objects.
963 """
964 return _core_.RealPoint___eq__(*args, **kwargs)
965
966 def __ne__(*args, **kwargs):
967 """
968 __ne__(self, RealPoint pt) -> bool
969
970 Test for inequality of wx.RealPoint objects.
971 """
972 return _core_.RealPoint___ne__(*args, **kwargs)
973
974 def __add__(*args, **kwargs):
975 """
976 __add__(self, RealPoint pt) -> RealPoint
977
978 Add pt's proprties to this and return the result.
979 """
980 return _core_.RealPoint___add__(*args, **kwargs)
981
982 def __sub__(*args, **kwargs):
983 """
984 __sub__(self, RealPoint pt) -> RealPoint
985
986 Subtract pt's proprties from this and return the result
987 """
988 return _core_.RealPoint___sub__(*args, **kwargs)
989
990 def Set(*args, **kwargs):
991 """
992 Set(self, double x, double y)
993
994 Set both the x and y properties
995 """
996 return _core_.RealPoint_Set(*args, **kwargs)
997
998 def Get(*args, **kwargs):
999 """
1000 Get() -> (x,y)
1001
1002 Return the x and y properties as a tuple.
1003 """
1004 return _core_.RealPoint_Get(*args, **kwargs)
1005
79fccf9d 1006 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1007 def __str__(self): return str(self.Get())
1008 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
1009 def __len__(self): return len(self.Get())
1010 def __getitem__(self, index): return self.Get()[index]
1011 def __setitem__(self, index, val):
1012 if index == 0: self.x = val
1013 elif index == 1: self.y = val
1014 else: raise IndexError
1015 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1016 __safe_for_unpickling__ = True
1017 def __reduce__(self): return (wx.RealPoint, self.Get())
1018
1019
1020class RealPointPtr(RealPoint):
1021 def __init__(self, this):
1022 self.this = this
1023 if not hasattr(self,"thisown"): self.thisown = 0
1024 self.__class__ = RealPoint
1025_core_.RealPoint_swigregister(RealPointPtr)
1026
1027#---------------------------------------------------------------------------
1028
1029class Point(object):
1030 """
79fccf9d
RD
1031 A data structure for representing a point or position with integer x
1032 and y properties. Most places in wxPython that expect a wx.Point can
1033 also accept a (x,y) tuple.
d55e5bfc
RD
1034 """
1035 def __repr__(self):
1036 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1037 x = property(_core_.Point_x_get, _core_.Point_x_set)
1038 y = property(_core_.Point_y_get, _core_.Point_y_set)
1039 def __init__(self, *args, **kwargs):
1040 """
1041 __init__(self, int x=0, int y=0) -> Point
1042
1043 Create a wx.Point object
1044 """
1045 newobj = _core_.new_Point(*args, **kwargs)
1046 self.this = newobj.this
1047 self.thisown = 1
1048 del newobj.thisown
1049 def __del__(self, destroy=_core_.delete_Point):
1050 """__del__(self)"""
1051 try:
1052 if self.thisown: destroy(self)
1053 except: pass
1054
1055 def __eq__(*args, **kwargs):
1056 """
1057 __eq__(self, Point pt) -> bool
1058
1059 Test for equality of wx.Point objects.
1060 """
1061 return _core_.Point___eq__(*args, **kwargs)
1062
1063 def __ne__(*args, **kwargs):
1064 """
1065 __ne__(self, Point pt) -> bool
1066
1067 Test for inequality of wx.Point objects.
1068 """
1069 return _core_.Point___ne__(*args, **kwargs)
1070
1071 def __add__(*args, **kwargs):
1072 """
1073 __add__(self, Point pt) -> Point
1074
1075 Add pt's proprties to this and return the result.
1076 """
1077 return _core_.Point___add__(*args, **kwargs)
1078
1079 def __sub__(*args, **kwargs):
1080 """
1081 __sub__(self, Point pt) -> Point
1082
1083 Subtract pt's proprties from this and return the result
1084 """
1085 return _core_.Point___sub__(*args, **kwargs)
1086
1087 def __iadd__(*args, **kwargs):
1088 """
1089 __iadd__(self, Point pt) -> Point
1090
1091 Add pt to this object.
1092 """
1093 return _core_.Point___iadd__(*args, **kwargs)
1094
1095 def __isub__(*args, **kwargs):
1096 """
1097 __isub__(self, Point pt) -> Point
1098
1099 Subtract pt from this object.
1100 """
1101 return _core_.Point___isub__(*args, **kwargs)
1102
1103 def Set(*args, **kwargs):
1104 """
1105 Set(self, long x, long y)
1106
1107 Set both the x and y properties
1108 """
1109 return _core_.Point_Set(*args, **kwargs)
1110
1111 def Get(*args, **kwargs):
1112 """
1113 Get() -> (x,y)
1114
1115 Return the x and y properties as a tuple.
1116 """
1117 return _core_.Point_Get(*args, **kwargs)
1118
79fccf9d 1119 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1120 def __str__(self): return str(self.Get())
1121 def __repr__(self): return 'wx.Point'+str(self.Get())
1122 def __len__(self): return len(self.Get())
1123 def __getitem__(self, index): return self.Get()[index]
1124 def __setitem__(self, index, val):
1125 if index == 0: self.x = val
1126 elif index == 1: self.y = val
1127 else: raise IndexError
1128 def __nonzero__(self): return self.Get() != (0,0)
1129 __safe_for_unpickling__ = True
1130 def __reduce__(self): return (wx.Point, self.Get())
1131
1132
1133class PointPtr(Point):
1134 def __init__(self, this):
1135 self.this = this
1136 if not hasattr(self,"thisown"): self.thisown = 0
1137 self.__class__ = Point
1138_core_.Point_swigregister(PointPtr)
1139
1140#---------------------------------------------------------------------------
1141
1142class Rect(object):
1143 """
79fccf9d
RD
1144 A class for representing and manipulating rectangles. It has x, y,
1145 width and height properties. In wxPython most palces that expect a
1146 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc
RD
1147 """
1148 def __repr__(self):
1149 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1150 def __init__(self, *args, **kwargs):
1151 """
1152 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1153
1154 Create a new Rect object.
1155 """
1156 newobj = _core_.new_Rect(*args, **kwargs)
1157 self.this = newobj.this
1158 self.thisown = 1
1159 del newobj.thisown
1160 def __del__(self, destroy=_core_.delete_Rect):
1161 """__del__(self)"""
1162 try:
1163 if self.thisown: destroy(self)
1164 except: pass
1165
1166 def GetX(*args, **kwargs):
1167 """GetX(self) -> int"""
1168 return _core_.Rect_GetX(*args, **kwargs)
1169
1170 def SetX(*args, **kwargs):
1171 """SetX(self, int x)"""
1172 return _core_.Rect_SetX(*args, **kwargs)
1173
1174 def GetY(*args, **kwargs):
1175 """GetY(self) -> int"""
1176 return _core_.Rect_GetY(*args, **kwargs)
1177
1178 def SetY(*args, **kwargs):
1179 """SetY(self, int y)"""
1180 return _core_.Rect_SetY(*args, **kwargs)
1181
1182 def GetWidth(*args, **kwargs):
1183 """GetWidth(self) -> int"""
1184 return _core_.Rect_GetWidth(*args, **kwargs)
1185
1186 def SetWidth(*args, **kwargs):
1187 """SetWidth(self, int w)"""
1188 return _core_.Rect_SetWidth(*args, **kwargs)
1189
1190 def GetHeight(*args, **kwargs):
1191 """GetHeight(self) -> int"""
1192 return _core_.Rect_GetHeight(*args, **kwargs)
1193
1194 def SetHeight(*args, **kwargs):
1195 """SetHeight(self, int h)"""
1196 return _core_.Rect_SetHeight(*args, **kwargs)
1197
1198 def GetPosition(*args, **kwargs):
1199 """GetPosition(self) -> Point"""
1200 return _core_.Rect_GetPosition(*args, **kwargs)
1201
1202 def SetPosition(*args, **kwargs):
1203 """SetPosition(self, Point p)"""
1204 return _core_.Rect_SetPosition(*args, **kwargs)
1205
1206 def GetSize(*args, **kwargs):
1207 """GetSize(self) -> Size"""
1208 return _core_.Rect_GetSize(*args, **kwargs)
1209
1210 def SetSize(*args, **kwargs):
1211 """SetSize(self, Size s)"""
1212 return _core_.Rect_SetSize(*args, **kwargs)
1213
aff4cc5c
RD
1214 def IsEmpty(*args, **kwargs):
1215 """IsEmpty(self) -> bool"""
1216 return _core_.Rect_IsEmpty(*args, **kwargs)
1217
d55e5bfc
RD
1218 def GetTopLeft(*args, **kwargs):
1219 """GetTopLeft(self) -> Point"""
1220 return _core_.Rect_GetTopLeft(*args, **kwargs)
1221
1222 def SetTopLeft(*args, **kwargs):
1223 """SetTopLeft(self, Point p)"""
1224 return _core_.Rect_SetTopLeft(*args, **kwargs)
1225
1226 def GetBottomRight(*args, **kwargs):
1227 """GetBottomRight(self) -> Point"""
1228 return _core_.Rect_GetBottomRight(*args, **kwargs)
1229
1230 def SetBottomRight(*args, **kwargs):
1231 """SetBottomRight(self, Point p)"""
1232 return _core_.Rect_SetBottomRight(*args, **kwargs)
1233
1234 def GetLeft(*args, **kwargs):
1235 """GetLeft(self) -> int"""
1236 return _core_.Rect_GetLeft(*args, **kwargs)
1237
1238 def GetTop(*args, **kwargs):
1239 """GetTop(self) -> int"""
1240 return _core_.Rect_GetTop(*args, **kwargs)
1241
1242 def GetBottom(*args, **kwargs):
1243 """GetBottom(self) -> int"""
1244 return _core_.Rect_GetBottom(*args, **kwargs)
1245
1246 def GetRight(*args, **kwargs):
1247 """GetRight(self) -> int"""
1248 return _core_.Rect_GetRight(*args, **kwargs)
1249
1250 def SetLeft(*args, **kwargs):
1251 """SetLeft(self, int left)"""
1252 return _core_.Rect_SetLeft(*args, **kwargs)
1253
1254 def SetRight(*args, **kwargs):
1255 """SetRight(self, int right)"""
1256 return _core_.Rect_SetRight(*args, **kwargs)
1257
1258 def SetTop(*args, **kwargs):
1259 """SetTop(self, int top)"""
1260 return _core_.Rect_SetTop(*args, **kwargs)
1261
1262 def SetBottom(*args, **kwargs):
1263 """SetBottom(self, int bottom)"""
1264 return _core_.Rect_SetBottom(*args, **kwargs)
1265
1266 position = property(GetPosition, SetPosition)
1267 size = property(GetSize, SetSize)
1268 left = property(GetLeft, SetLeft)
1269 right = property(GetRight, SetRight)
1270 top = property(GetTop, SetTop)
1271 bottom = property(GetBottom, SetBottom)
1272
1273 def Inflate(*args, **kwargs):
1274 """
1275 Inflate(self, int dx, int dy) -> Rect
1276
091fdbfa
RD
1277 Increases the size of the rectangle.
1278
1279 The left border is moved farther left and the right border is moved
1280 farther right by ``dx``. The upper border is moved farther up and the
1281 bottom border is moved farther down by ``dy``. (Note the the width and
1282 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1283 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1284 opposite happens: the rectangle size decreases in the respective
1285 direction.
1286
1287 The change is made to the rectangle inplace, if instead you need a
1288 copy that is inflated, preserving the original then make the copy
1289 first::
1290
1291 copy = wx.Rect(*original)
1292 copy.Inflate(10,15)
1293
1294
d55e5bfc
RD
1295 """
1296 return _core_.Rect_Inflate(*args, **kwargs)
1297
1298 def Deflate(*args, **kwargs):
1299 """
1300 Deflate(self, int dx, int dy) -> Rect
1301
091fdbfa
RD
1302 Decrease the rectangle size. This method is the opposite of `Inflate`
1303 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1304 `Inflate` for a full description.
d55e5bfc
RD
1305 """
1306 return _core_.Rect_Deflate(*args, **kwargs)
1307
1308 def OffsetXY(*args, **kwargs):
1309 """
1310 OffsetXY(self, int dx, int dy)
1311
79fccf9d
RD
1312 Moves the rectangle by the specified offset. If dx is positive, the
1313 rectangle is moved to the right, if dy is positive, it is moved to the
1314 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1315 """
1316 return _core_.Rect_OffsetXY(*args, **kwargs)
1317
1318 def Offset(*args, **kwargs):
1319 """
1320 Offset(self, Point pt)
1321
1322 Same as OffsetXY but uses dx,dy from Point
1323 """
1324 return _core_.Rect_Offset(*args, **kwargs)
1325
1326 def Intersect(*args, **kwargs):
1327 """
1328 Intersect(self, Rect rect) -> Rect
1329
b519803b 1330 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD
1331 """
1332 return _core_.Rect_Intersect(*args, **kwargs)
1333
b519803b
RD
1334 def Union(*args, **kwargs):
1335 """
1336 Union(self, Rect rect) -> Rect
1337
1338 Returns the union of this rectangle and rect.
1339 """
1340 return _core_.Rect_Union(*args, **kwargs)
1341
d55e5bfc
RD
1342 def __add__(*args, **kwargs):
1343 """
1344 __add__(self, Rect rect) -> Rect
1345
1346 Add the properties of rect to this rectangle and return the result.
1347 """
1348 return _core_.Rect___add__(*args, **kwargs)
1349
1350 def __iadd__(*args, **kwargs):
1351 """
1352 __iadd__(self, Rect rect) -> Rect
1353
1354 Add the properties of rect to this rectangle, updating this rectangle.
1355 """
1356 return _core_.Rect___iadd__(*args, **kwargs)
1357
1358 def __eq__(*args, **kwargs):
1359 """
1360 __eq__(self, Rect rect) -> bool
1361
1362 Test for equality.
1363 """
1364 return _core_.Rect___eq__(*args, **kwargs)
1365
1366 def __ne__(*args, **kwargs):
1367 """
1368 __ne__(self, Rect rect) -> bool
1369
1370 Test for inequality.
1371 """
1372 return _core_.Rect___ne__(*args, **kwargs)
1373
1374 def InsideXY(*args, **kwargs):
1375 """
1376 InsideXY(self, int x, int y) -> bool
1377
1378 Return True if the point is (not strcitly) inside the rect.
1379 """
1380 return _core_.Rect_InsideXY(*args, **kwargs)
1381
1382 def Inside(*args, **kwargs):
1383 """
1384 Inside(self, Point pt) -> bool
1385
1386 Return True if the point is (not strcitly) inside the rect.
1387 """
1388 return _core_.Rect_Inside(*args, **kwargs)
1389
1390 def Intersects(*args, **kwargs):
1391 """
1392 Intersects(self, Rect rect) -> bool
1393
1394 Returns True if the rectangles have a non empty intersection.
1395 """
1396 return _core_.Rect_Intersects(*args, **kwargs)
1397
1398 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1399 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1400 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1401 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1402 def Set(*args, **kwargs):
1403 """
1404 Set(self, int x=0, int y=0, int width=0, int height=0)
1405
1406 Set all rectangle properties.
1407 """
1408 return _core_.Rect_Set(*args, **kwargs)
1409
1410 def Get(*args, **kwargs):
1411 """
1412 Get() -> (x,y,width,height)
1413
1414 Return the rectangle properties as a tuple.
1415 """
1416 return _core_.Rect_Get(*args, **kwargs)
1417
79fccf9d 1418 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1419 def __str__(self): return str(self.Get())
1420 def __repr__(self): return 'wx.Rect'+str(self.Get())
1421 def __len__(self): return len(self.Get())
1422 def __getitem__(self, index): return self.Get()[index]
1423 def __setitem__(self, index, val):
1424 if index == 0: self.x = val
1425 elif index == 1: self.y = val
1426 elif index == 2: self.width = val
1427 elif index == 3: self.height = val
1428 else: raise IndexError
1429 def __nonzero__(self): return self.Get() != (0,0,0,0)
1430 __safe_for_unpickling__ = True
1431 def __reduce__(self): return (wx.Rect, self.Get())
1432
1433
1434class RectPtr(Rect):
1435 def __init__(self, this):
1436 self.this = this
1437 if not hasattr(self,"thisown"): self.thisown = 0
1438 self.__class__ = Rect
1439_core_.Rect_swigregister(RectPtr)
1440
1441def RectPP(*args, **kwargs):
1442 """
1443 RectPP(Point topLeft, Point bottomRight) -> Rect
1444
1445 Create a new Rect object from Points representing two corners.
1446 """
1447 val = _core_.new_RectPP(*args, **kwargs)
1448 val.thisown = 1
1449 return val
1450
1451def RectPS(*args, **kwargs):
1452 """
1453 RectPS(Point pos, Size size) -> Rect
1454
1455 Create a new Rect from a position and size.
1456 """
1457 val = _core_.new_RectPS(*args, **kwargs)
1458 val.thisown = 1
1459 return val
1460
c1cb24a4
RD
1461def RectS(*args, **kwargs):
1462 """
1463 RectS(Size size) -> Rect
1464
1465 Create a new Rect from a size only.
1466 """
1467 val = _core_.new_RectS(*args, **kwargs)
1468 val.thisown = 1
1469 return val
1470
d55e5bfc
RD
1471
1472def IntersectRect(*args, **kwargs):
1473 """
1474 IntersectRect(Rect r1, Rect r2) -> Rect
1475
1476 Calculate and return the intersection of r1 and r2.
1477 """
1478 return _core_.IntersectRect(*args, **kwargs)
1479#---------------------------------------------------------------------------
1480
1481class Point2D(object):
79fccf9d
RD
1482 """
1483 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1484 with floating point values.
1485 """
d55e5bfc
RD
1486 def __repr__(self):
1487 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1488 def __init__(self, *args, **kwargs):
1489 """
1490 __init__(self, double x=0.0, double y=0.0) -> Point2D
1491
1492 Create a w.Point2D object.
1493 """
1494 newobj = _core_.new_Point2D(*args, **kwargs)
1495 self.this = newobj.this
1496 self.thisown = 1
1497 del newobj.thisown
1498 def GetFloor(*args, **kwargs):
a8eff060
RD
1499 """
1500 GetFloor() -> (x,y)
1501
1502 Convert to integer
1503 """
d55e5bfc
RD
1504 return _core_.Point2D_GetFloor(*args, **kwargs)
1505
1506 def GetRounded(*args, **kwargs):
a8eff060
RD
1507 """
1508 GetRounded() -> (x,y)
1509
1510 Convert to integer
1511 """
d55e5bfc
RD
1512 return _core_.Point2D_GetRounded(*args, **kwargs)
1513
1514 def GetVectorLength(*args, **kwargs):
1515 """GetVectorLength(self) -> double"""
1516 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1517
1518 def GetVectorAngle(*args, **kwargs):
1519 """GetVectorAngle(self) -> double"""
1520 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1521
1522 def SetVectorLength(*args, **kwargs):
1523 """SetVectorLength(self, double length)"""
1524 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1525
1526 def SetVectorAngle(*args, **kwargs):
1527 """SetVectorAngle(self, double degrees)"""
1528 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1529
1530 def SetPolarCoordinates(self, angle, length):
1531 self.SetVectorLength(length)
1532 self.SetVectorAngle(angle)
1533 def Normalize(self):
1534 self.SetVectorLength(1.0)
1535
1536 def GetDistance(*args, **kwargs):
1537 """GetDistance(self, Point2D pt) -> double"""
1538 return _core_.Point2D_GetDistance(*args, **kwargs)
1539
1540 def GetDistanceSquare(*args, **kwargs):
1541 """GetDistanceSquare(self, Point2D pt) -> double"""
1542 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1543
1544 def GetDotProduct(*args, **kwargs):
1545 """GetDotProduct(self, Point2D vec) -> double"""
1546 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1547
1548 def GetCrossProduct(*args, **kwargs):
1549 """GetCrossProduct(self, Point2D vec) -> double"""
1550 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1551
1552 def __neg__(*args, **kwargs):
1553 """
1554 __neg__(self) -> Point2D
1555
1556 the reflection of this point
1557 """
1558 return _core_.Point2D___neg__(*args, **kwargs)
1559
1560 def __iadd__(*args, **kwargs):
1561 """__iadd__(self, Point2D pt) -> Point2D"""
1562 return _core_.Point2D___iadd__(*args, **kwargs)
1563
1564 def __isub__(*args, **kwargs):
1565 """__isub__(self, Point2D pt) -> Point2D"""
1566 return _core_.Point2D___isub__(*args, **kwargs)
1567
1568 def __imul__(*args, **kwargs):
1569 """__imul__(self, Point2D pt) -> Point2D"""
1570 return _core_.Point2D___imul__(*args, **kwargs)
1571
1572 def __idiv__(*args, **kwargs):
1573 """__idiv__(self, Point2D pt) -> Point2D"""
1574 return _core_.Point2D___idiv__(*args, **kwargs)
1575
1576 def __eq__(*args, **kwargs):
1577 """
1578 __eq__(self, Point2D pt) -> bool
1579
1580 Test for equality
1581 """
1582 return _core_.Point2D___eq__(*args, **kwargs)
1583
1584 def __ne__(*args, **kwargs):
1585 """
1586 __ne__(self, Point2D pt) -> bool
1587
1588 Test for inequality
1589 """
1590 return _core_.Point2D___ne__(*args, **kwargs)
1591
1592 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1593 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1594 def Set(*args, **kwargs):
1595 """Set(self, double x=0, double y=0)"""
1596 return _core_.Point2D_Set(*args, **kwargs)
1597
1598 def Get(*args, **kwargs):
1599 """
1600 Get() -> (x,y)
1601
1602 Return x and y properties as a tuple.
1603 """
1604 return _core_.Point2D_Get(*args, **kwargs)
1605
79fccf9d 1606 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1607 def __str__(self): return str(self.Get())
1608 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1609 def __len__(self): return len(self.Get())
1610 def __getitem__(self, index): return self.Get()[index]
1611 def __setitem__(self, index, val):
1612 if index == 0: self.x = val
1613 elif index == 1: self.y = val
1614 else: raise IndexError
1615 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1616 __safe_for_unpickling__ = True
1617 def __reduce__(self): return (wx.Point2D, self.Get())
1618
1619
1620class Point2DPtr(Point2D):
1621 def __init__(self, this):
1622 self.this = this
1623 if not hasattr(self,"thisown"): self.thisown = 0
1624 self.__class__ = Point2D
1625_core_.Point2D_swigregister(Point2DPtr)
1626
1627def Point2DCopy(*args, **kwargs):
1628 """
1629 Point2DCopy(Point2D pt) -> Point2D
1630
1631 Create a w.Point2D object.
1632 """
1633 val = _core_.new_Point2DCopy(*args, **kwargs)
1634 val.thisown = 1
1635 return val
1636
1637def Point2DFromPoint(*args, **kwargs):
1638 """
1639 Point2DFromPoint(Point pt) -> Point2D
1640
1641 Create a w.Point2D object.
1642 """
1643 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1644 val.thisown = 1
1645 return val
1646
1647#---------------------------------------------------------------------------
1648
1649FromStart = _core_.FromStart
1650FromCurrent = _core_.FromCurrent
1651FromEnd = _core_.FromEnd
1652class InputStream(object):
093d3ff1 1653 """Proxy of C++ InputStream class"""
d55e5bfc
RD
1654 def __repr__(self):
1655 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1656 def __init__(self, *args, **kwargs):
1657 """__init__(self, PyObject p) -> InputStream"""
1658 newobj = _core_.new_InputStream(*args, **kwargs)
1659 self.this = newobj.this
1660 self.thisown = 1
1661 del newobj.thisown
8fb0e70a
RD
1662 def __del__(self, destroy=_core_.delete_InputStream):
1663 """__del__(self)"""
1664 try:
1665 if self.thisown: destroy(self)
1666 except: pass
1667
d55e5bfc
RD
1668 def close(*args, **kwargs):
1669 """close(self)"""
1670 return _core_.InputStream_close(*args, **kwargs)
1671
1672 def flush(*args, **kwargs):
1673 """flush(self)"""
1674 return _core_.InputStream_flush(*args, **kwargs)
1675
1676 def eof(*args, **kwargs):
1677 """eof(self) -> bool"""
1678 return _core_.InputStream_eof(*args, **kwargs)
1679
1680 def read(*args, **kwargs):
1681 """read(self, int size=-1) -> PyObject"""
1682 return _core_.InputStream_read(*args, **kwargs)
1683
1684 def readline(*args, **kwargs):
1685 """readline(self, int size=-1) -> PyObject"""
1686 return _core_.InputStream_readline(*args, **kwargs)
1687
1688 def readlines(*args, **kwargs):
1689 """readlines(self, int sizehint=-1) -> PyObject"""
1690 return _core_.InputStream_readlines(*args, **kwargs)
1691
1692 def seek(*args, **kwargs):
1693 """seek(self, int offset, int whence=0)"""
1694 return _core_.InputStream_seek(*args, **kwargs)
1695
1696 def tell(*args, **kwargs):
1697 """tell(self) -> int"""
1698 return _core_.InputStream_tell(*args, **kwargs)
1699
1700 def Peek(*args, **kwargs):
1701 """Peek(self) -> char"""
1702 return _core_.InputStream_Peek(*args, **kwargs)
1703
1704 def GetC(*args, **kwargs):
1705 """GetC(self) -> char"""
1706 return _core_.InputStream_GetC(*args, **kwargs)
1707
1708 def LastRead(*args, **kwargs):
1709 """LastRead(self) -> size_t"""
1710 return _core_.InputStream_LastRead(*args, **kwargs)
1711
1712 def CanRead(*args, **kwargs):
1713 """CanRead(self) -> bool"""
1714 return _core_.InputStream_CanRead(*args, **kwargs)
1715
1716 def Eof(*args, **kwargs):
1717 """Eof(self) -> bool"""
1718 return _core_.InputStream_Eof(*args, **kwargs)
1719
1720 def Ungetch(*args, **kwargs):
1721 """Ungetch(self, char c) -> bool"""
1722 return _core_.InputStream_Ungetch(*args, **kwargs)
1723
1724 def SeekI(*args, **kwargs):
1725 """SeekI(self, long pos, int mode=FromStart) -> long"""
1726 return _core_.InputStream_SeekI(*args, **kwargs)
1727
1728 def TellI(*args, **kwargs):
1729 """TellI(self) -> long"""
1730 return _core_.InputStream_TellI(*args, **kwargs)
1731
1732
1733class InputStreamPtr(InputStream):
1734 def __init__(self, this):
1735 self.this = this
1736 if not hasattr(self,"thisown"): self.thisown = 0
1737 self.__class__ = InputStream
1738_core_.InputStream_swigregister(InputStreamPtr)
1739DefaultPosition = cvar.DefaultPosition
1740DefaultSize = cvar.DefaultSize
1741
1742class OutputStream(object):
093d3ff1 1743 """Proxy of C++ OutputStream class"""
d55e5bfc
RD
1744 def __init__(self): raise RuntimeError, "No constructor defined"
1745 def __repr__(self):
1746 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1747 def write(*args, **kwargs):
1748 """write(self, PyObject obj)"""
1749 return _core_.OutputStream_write(*args, **kwargs)
1750
1751
1752class OutputStreamPtr(OutputStream):
1753 def __init__(self, this):
1754 self.this = this
1755 if not hasattr(self,"thisown"): self.thisown = 0
1756 self.__class__ = OutputStream
1757_core_.OutputStream_swigregister(OutputStreamPtr)
1758
1759#---------------------------------------------------------------------------
1760
1761class FSFile(Object):
093d3ff1 1762 """Proxy of C++ FSFile class"""
d55e5bfc
RD
1763 def __repr__(self):
1764 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1765 def __init__(self, *args, **kwargs):
1766 """
1767 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1768 DateTime modif) -> FSFile
1769 """
1770 newobj = _core_.new_FSFile(*args, **kwargs)
1771 self.this = newobj.this
1772 self.thisown = 1
1773 del newobj.thisown
e2950dbb 1774 self.thisown = 0 # It will normally be deleted by the user of the wx.FileSystem
4cf4100f 1775
d55e5bfc
RD
1776 def __del__(self, destroy=_core_.delete_FSFile):
1777 """__del__(self)"""
1778 try:
1779 if self.thisown: destroy(self)
1780 except: pass
1781
1782 def GetStream(*args, **kwargs):
1783 """GetStream(self) -> InputStream"""
1784 return _core_.FSFile_GetStream(*args, **kwargs)
1785
1786 def GetMimeType(*args, **kwargs):
1787 """GetMimeType(self) -> String"""
1788 return _core_.FSFile_GetMimeType(*args, **kwargs)
1789
1790 def GetLocation(*args, **kwargs):
1791 """GetLocation(self) -> String"""
1792 return _core_.FSFile_GetLocation(*args, **kwargs)
1793
1794 def GetAnchor(*args, **kwargs):
1795 """GetAnchor(self) -> String"""
1796 return _core_.FSFile_GetAnchor(*args, **kwargs)
1797
1798 def GetModificationTime(*args, **kwargs):
1799 """GetModificationTime(self) -> DateTime"""
1800 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1801
1802
1803class FSFilePtr(FSFile):
1804 def __init__(self, this):
1805 self.this = this
1806 if not hasattr(self,"thisown"): self.thisown = 0
1807 self.__class__ = FSFile
1808_core_.FSFile_swigregister(FSFilePtr)
1809
1810class CPPFileSystemHandler(object):
093d3ff1 1811 """Proxy of C++ CPPFileSystemHandler class"""
d55e5bfc
RD
1812 def __init__(self): raise RuntimeError, "No constructor defined"
1813 def __repr__(self):
1814 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1815
1816class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1817 def __init__(self, this):
1818 self.this = this
1819 if not hasattr(self,"thisown"): self.thisown = 0
1820 self.__class__ = CPPFileSystemHandler
1821_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1822
1823class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1824 """Proxy of C++ FileSystemHandler class"""
d55e5bfc
RD
1825 def __repr__(self):
1826 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1827 def __init__(self, *args, **kwargs):
1828 """__init__(self) -> FileSystemHandler"""
1829 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1830 self.this = newobj.this
1831 self.thisown = 1
1832 del newobj.thisown
1833 self._setCallbackInfo(self, FileSystemHandler)
1834
1835 def _setCallbackInfo(*args, **kwargs):
1836 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1837 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1838
1839 def CanOpen(*args, **kwargs):
1840 """CanOpen(self, String location) -> bool"""
1841 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1842
1843 def OpenFile(*args, **kwargs):
1844 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1845 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1846
1847 def FindFirst(*args, **kwargs):
1848 """FindFirst(self, String spec, int flags=0) -> String"""
1849 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1850
1851 def FindNext(*args, **kwargs):
1852 """FindNext(self) -> String"""
1853 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1854
1855 def GetProtocol(*args, **kwargs):
1856 """GetProtocol(self, String location) -> String"""
1857 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1858
1859 def GetLeftLocation(*args, **kwargs):
1860 """GetLeftLocation(self, String location) -> String"""
1861 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1862
1863 def GetAnchor(*args, **kwargs):
1864 """GetAnchor(self, String location) -> String"""
1865 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1866
1867 def GetRightLocation(*args, **kwargs):
1868 """GetRightLocation(self, String location) -> String"""
1869 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1870
1871 def GetMimeTypeFromExt(*args, **kwargs):
1872 """GetMimeTypeFromExt(self, String location) -> String"""
1873 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1874
1875
1876class FileSystemHandlerPtr(FileSystemHandler):
1877 def __init__(self, this):
1878 self.this = this
1879 if not hasattr(self,"thisown"): self.thisown = 0
1880 self.__class__ = FileSystemHandler
1881_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1882
1883class FileSystem(Object):
093d3ff1 1884 """Proxy of C++ FileSystem class"""
d55e5bfc
RD
1885 def __repr__(self):
1886 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1887 def __init__(self, *args, **kwargs):
1888 """__init__(self) -> FileSystem"""
1889 newobj = _core_.new_FileSystem(*args, **kwargs)
1890 self.this = newobj.this
1891 self.thisown = 1
1892 del newobj.thisown
1893 def __del__(self, destroy=_core_.delete_FileSystem):
1894 """__del__(self)"""
1895 try:
1896 if self.thisown: destroy(self)
1897 except: pass
1898
1899 def ChangePathTo(*args, **kwargs):
1900 """ChangePathTo(self, String location, bool is_dir=False)"""
1901 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1902
1903 def GetPath(*args, **kwargs):
1904 """GetPath(self) -> String"""
1905 return _core_.FileSystem_GetPath(*args, **kwargs)
1906
1907 def OpenFile(*args, **kwargs):
1908 """OpenFile(self, String location) -> FSFile"""
1909 return _core_.FileSystem_OpenFile(*args, **kwargs)
1910
1911 def FindFirst(*args, **kwargs):
1912 """FindFirst(self, String spec, int flags=0) -> String"""
1913 return _core_.FileSystem_FindFirst(*args, **kwargs)
1914
1915 def FindNext(*args, **kwargs):
1916 """FindNext(self) -> String"""
1917 return _core_.FileSystem_FindNext(*args, **kwargs)
1918
1919 def AddHandler(*args, **kwargs):
c24da6d6 1920 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1921 return _core_.FileSystem_AddHandler(*args, **kwargs)
1922
1923 AddHandler = staticmethod(AddHandler)
1924 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1925 """CleanUpHandlers()"""
d55e5bfc
RD
1926 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1927
1928 CleanUpHandlers = staticmethod(CleanUpHandlers)
1929 def FileNameToURL(*args, **kwargs):
c24da6d6 1930 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1931 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1932
1933 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD
1934 def URLToFileName(*args, **kwargs):
1935 """URLToFileName(String url) -> String"""
1936 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1937
1938 URLToFileName = staticmethod(URLToFileName)
d55e5bfc
RD
1939
1940class FileSystemPtr(FileSystem):
1941 def __init__(self, this):
1942 self.this = this
1943 if not hasattr(self,"thisown"): self.thisown = 0
1944 self.__class__ = FileSystem
1945_core_.FileSystem_swigregister(FileSystemPtr)
1946
1947def FileSystem_AddHandler(*args, **kwargs):
1948 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1949 return _core_.FileSystem_AddHandler(*args, **kwargs)
1950
1951def FileSystem_CleanUpHandlers(*args, **kwargs):
1952 """FileSystem_CleanUpHandlers()"""
1953 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1954
1955def FileSystem_FileNameToURL(*args, **kwargs):
1956 """FileSystem_FileNameToURL(String filename) -> String"""
1957 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1958
d55e5bfc
RD
1959def FileSystem_URLToFileName(*args, **kwargs):
1960 """FileSystem_URLToFileName(String url) -> String"""
1961 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1962
d55e5bfc 1963class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1964 """Proxy of C++ InternetFSHandler class"""
d55e5bfc
RD
1965 def __repr__(self):
1966 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1967 def __init__(self, *args, **kwargs):
1968 """__init__(self) -> InternetFSHandler"""
1969 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1970 self.this = newobj.this
1971 self.thisown = 1
1972 del newobj.thisown
1973 def CanOpen(*args, **kwargs):
1974 """CanOpen(self, String location) -> bool"""
1975 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1976
1977 def OpenFile(*args, **kwargs):
1978 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1979 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1980
1981
1982class InternetFSHandlerPtr(InternetFSHandler):
1983 def __init__(self, this):
1984 self.this = this
1985 if not hasattr(self,"thisown"): self.thisown = 0
1986 self.__class__ = InternetFSHandler
1987_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1988
1989class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1990 """Proxy of C++ ZipFSHandler class"""
d55e5bfc
RD
1991 def __repr__(self):
1992 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1993 def __init__(self, *args, **kwargs):
1994 """__init__(self) -> ZipFSHandler"""
1995 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1996 self.this = newobj.this
1997 self.thisown = 1
1998 del newobj.thisown
1999 def CanOpen(*args, **kwargs):
2000 """CanOpen(self, String location) -> bool"""
2001 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
2002
2003 def OpenFile(*args, **kwargs):
2004 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2005 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
2006
2007 def FindFirst(*args, **kwargs):
2008 """FindFirst(self, String spec, int flags=0) -> String"""
2009 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
2010
2011 def FindNext(*args, **kwargs):
2012 """FindNext(self) -> String"""
2013 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
2014
2015
2016class ZipFSHandlerPtr(ZipFSHandler):
2017 def __init__(self, this):
2018 self.this = this
2019 if not hasattr(self,"thisown"): self.thisown = 0
2020 self.__class__ = ZipFSHandler
2021_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
2022
2023
2024def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
2025 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
2026 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
2027
2028def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
2029 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
2030 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
2031
2032def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
2033 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
2034 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD
2035def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
2036 """
2037 Add 'file' to the memory filesystem. The dataItem parameter can
2038 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
2039 arbitrary data. If a bitmap or image is used then the imgType
2040 parameter should specify what kind of image file it should be
2041 written as, wx.BITMAP_TYPE_PNG, etc.
2042 """
2043 if isinstance(dataItem, wx.Image):
2044 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
2045 elif isinstance(dataItem, wx.Bitmap):
2046 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
2047 elif type(dataItem) == str:
2048 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
2049 else:
2050 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD
2051
2052class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 2053 """Proxy of C++ MemoryFSHandler class"""
d55e5bfc
RD
2054 def __repr__(self):
2055 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2056 def __init__(self, *args, **kwargs):
2057 """__init__(self) -> MemoryFSHandler"""
2058 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
2059 self.this = newobj.this
2060 self.thisown = 1
2061 del newobj.thisown
2062 def RemoveFile(*args, **kwargs):
c24da6d6 2063 """RemoveFile(String filename)"""
d55e5bfc
RD
2064 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2065
2066 RemoveFile = staticmethod(RemoveFile)
2067 AddFile = staticmethod(MemoryFSHandler_AddFile)
2068 def CanOpen(*args, **kwargs):
2069 """CanOpen(self, String location) -> bool"""
2070 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2071
2072 def OpenFile(*args, **kwargs):
2073 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2074 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2075
2076 def FindFirst(*args, **kwargs):
2077 """FindFirst(self, String spec, int flags=0) -> String"""
2078 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2079
2080 def FindNext(*args, **kwargs):
2081 """FindNext(self) -> String"""
2082 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2083
2084
2085class MemoryFSHandlerPtr(MemoryFSHandler):
2086 def __init__(self, this):
2087 self.this = this
2088 if not hasattr(self,"thisown"): self.thisown = 0
2089 self.__class__ = MemoryFSHandler
2090_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
2091
2092def MemoryFSHandler_RemoveFile(*args, **kwargs):
2093 """MemoryFSHandler_RemoveFile(String filename)"""
2094 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2095
57133d5c
RD
2096IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
2097IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
2098IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
d55e5bfc
RD
2099#---------------------------------------------------------------------------
2100
2101class ImageHandler(Object):
27fb7603
RD
2102 """
2103 This is the base class for implementing image file loading/saving, and
2104 image creation from data. It is used within `wx.Image` and is not
2105 normally seen by the application.
2106 """
d55e5bfc
RD
2107 def __init__(self): raise RuntimeError, "No constructor defined"
2108 def __repr__(self):
2109 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2110 def GetName(*args, **kwargs):
2111 """GetName(self) -> String"""
2112 return _core_.ImageHandler_GetName(*args, **kwargs)
2113
2114 def GetExtension(*args, **kwargs):
2115 """GetExtension(self) -> String"""
2116 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2117
2118 def GetType(*args, **kwargs):
2119 """GetType(self) -> long"""
2120 return _core_.ImageHandler_GetType(*args, **kwargs)
2121
2122 def GetMimeType(*args, **kwargs):
2123 """GetMimeType(self) -> String"""
2124 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2125
2126 def CanRead(*args, **kwargs):
2127 """CanRead(self, String name) -> bool"""
2128 return _core_.ImageHandler_CanRead(*args, **kwargs)
2129
2130 def SetName(*args, **kwargs):
2131 """SetName(self, String name)"""
2132 return _core_.ImageHandler_SetName(*args, **kwargs)
2133
2134 def SetExtension(*args, **kwargs):
2135 """SetExtension(self, String extension)"""
2136 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2137
2138 def SetType(*args, **kwargs):
2139 """SetType(self, long type)"""
2140 return _core_.ImageHandler_SetType(*args, **kwargs)
2141
2142 def SetMimeType(*args, **kwargs):
2143 """SetMimeType(self, String mimetype)"""
2144 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2145
2146
2147class ImageHandlerPtr(ImageHandler):
2148 def __init__(self, this):
2149 self.this = this
2150 if not hasattr(self,"thisown"): self.thisown = 0
2151 self.__class__ = ImageHandler
2152_core_.ImageHandler_swigregister(ImageHandlerPtr)
2153
9d7dfdff
RD
2154class PyImageHandler(ImageHandler):
2155 """
2156 This is the base class for implementing image file loading/saving, and
2157 image creation from data, all written in Python. To create a custom
2158 image handler derive a new class from wx.PyImageHandler and provide
2159 the following methods::
2160
2161 def DoCanRead(self, stream) --> bool
2162 '''Check if this handler can read the image on the stream'''
2163
2164 def LoadFile(self, image, stream, verbose, index) --> bool
2165 '''Load image data from the stream and load it into image.'''
2166
2167 def SaveFile(self, image, stream, verbose) --> bool
2168 '''Save the iamge data in image to the stream using
2169 this handler's image file format.'''
2170
2171 def GetImageCount(self, stream) --> int
2172 '''If this image format can hold more than one image,
2173 how many does the image on the stream have?'''
2174
2175 To activate your handler create an instance of it and pass it to
2176 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2177 `SetExtension` from your constructor.
2178
2179 """
2180 def __repr__(self):
2181 return "<%s.%s; proxy of C++ wxPyImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2182 def __init__(self, *args, **kwargs):
2183 """
2184 __init__(self) -> PyImageHandler
2185
2186 This is the base class for implementing image file loading/saving, and
2187 image creation from data, all written in Python. To create a custom
2188 image handler derive a new class from wx.PyImageHandler and provide
2189 the following methods::
2190
2191 def DoCanRead(self, stream) --> bool
2192 '''Check if this handler can read the image on the stream'''
2193
2194 def LoadFile(self, image, stream, verbose, index) --> bool
2195 '''Load image data from the stream and load it into image.'''
2196
2197 def SaveFile(self, image, stream, verbose) --> bool
2198 '''Save the iamge data in image to the stream using
2199 this handler's image file format.'''
2200
2201 def GetImageCount(self, stream) --> int
2202 '''If this image format can hold more than one image,
2203 how many does the image on the stream have?'''
2204
2205 To activate your handler create an instance of it and pass it to
2206 `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
2207 `SetExtension` from your constructor.
2208
2209 """
2210 newobj = _core_.new_PyImageHandler(*args, **kwargs)
2211 self.this = newobj.this
2212 self.thisown = 1
2213 del newobj.thisown
2214 self._SetSelf(self)
2215
2216 def _SetSelf(*args, **kwargs):
2217 """_SetSelf(self, PyObject self)"""
2218 return _core_.PyImageHandler__SetSelf(*args, **kwargs)
2219
2220
2221class PyImageHandlerPtr(PyImageHandler):
2222 def __init__(self, this):
2223 self.this = this
2224 if not hasattr(self,"thisown"): self.thisown = 0
2225 self.__class__ = PyImageHandler
2226_core_.PyImageHandler_swigregister(PyImageHandlerPtr)
2227
d55e5bfc 2228class ImageHistogram(object):
093d3ff1 2229 """Proxy of C++ ImageHistogram class"""
d55e5bfc
RD
2230 def __repr__(self):
2231 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2232 def __init__(self, *args, **kwargs):
2233 """__init__(self) -> ImageHistogram"""
2234 newobj = _core_.new_ImageHistogram(*args, **kwargs)
2235 self.this = newobj.this
2236 self.thisown = 1
2237 del newobj.thisown
2238 def MakeKey(*args, **kwargs):
2239 """
7a27cf7c 2240 MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD
2241
2242 Get the key in the histogram for the given RGB values
2243 """
2244 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2245
2246 MakeKey = staticmethod(MakeKey)
2247 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2248 """
2249 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2250
2251 Find first colour that is not used in the image and has higher RGB
2252 values than startR, startG, startB. Returns a tuple consisting of a
2253 success flag and rgb values.
2254 """
d55e5bfc
RD
2255 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2256
f1cbd8fa
RD
2257 def GetCount(*args, **kwargs):
2258 """
2259 GetCount(self, unsigned long key) -> unsigned long
2260
2261 Returns the pixel count for the given key. Use `MakeKey` to create a
2262 key value from a RGB tripple.
2263 """
2264 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2265
2266 def GetCountRGB(*args, **kwargs):
2267 """
7a27cf7c 2268 GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
f1cbd8fa
RD
2269
2270 Returns the pixel count for the given RGB values.
2271 """
2272 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2273
2274 def GetCountColour(*args, **kwargs):
2275 """
2276 GetCountColour(self, Colour colour) -> unsigned long
2277
2278 Returns the pixel count for the given `wx.Colour` value.
2279 """
2280 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2281
d55e5bfc
RD
2282
2283class ImageHistogramPtr(ImageHistogram):
2284 def __init__(self, this):
2285 self.this = this
2286 if not hasattr(self,"thisown"): self.thisown = 0
2287 self.__class__ = ImageHistogram
2288_core_.ImageHistogram_swigregister(ImageHistogramPtr)
2289
2290def ImageHistogram_MakeKey(*args, **kwargs):
2291 """
7a27cf7c 2292 ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
d55e5bfc
RD
2293
2294 Get the key in the histogram for the given RGB values
2295 """
2296 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2297
2f91e3df 2298class Image_RGBValue(object):
9d7dfdff
RD
2299 """
2300 An object that contains values for red, green and blue which represent
2301 the value of a color. It is used by `wx.Image.HSVtoRGB` and
2302 `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
2303 color space.
2304 """
2f91e3df
KO
2305 def __repr__(self):
2306 return "<%s.%s; proxy of C++ wxImage_RGBValue instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2307 def __init__(self, *args, **kwargs):
9d7dfdff
RD
2308 """
2309 __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
2310
2311 Constructor.
2312 """
2f91e3df
KO
2313 newobj = _core_.new_Image_RGBValue(*args, **kwargs)
2314 self.this = newobj.this
2315 self.thisown = 1
2316 del newobj.thisown
2317 red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
2318 green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
2319 blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
2320
2321class Image_RGBValuePtr(Image_RGBValue):
2322 def __init__(self, this):
2323 self.this = this
2324 if not hasattr(self,"thisown"): self.thisown = 0
2325 self.__class__ = Image_RGBValue
2326_core_.Image_RGBValue_swigregister(Image_RGBValuePtr)
2327
2328class Image_HSVValue(object):
9d7dfdff
RD
2329 """
2330 An object that contains values for hue, saturation and value which
2331 represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
2332 `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
2333 color space.
2334 """
2f91e3df
KO
2335 def __repr__(self):
2336 return "<%s.%s; proxy of C++ wxImage_HSVValue instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2337 def __init__(self, *args, **kwargs):
9d7dfdff
RD
2338 """
2339 __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
2340
2341 Constructor.
2342 """
2f91e3df
KO
2343 newobj = _core_.new_Image_HSVValue(*args, **kwargs)
2344 self.this = newobj.this
2345 self.thisown = 1
2346 del newobj.thisown
2347 hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
2348 saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
2349 value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
2350
2351class Image_HSVValuePtr(Image_HSVValue):
2352 def __init__(self, this):
2353 self.this = this
2354 if not hasattr(self,"thisown"): self.thisown = 0
2355 self.__class__ = Image_HSVValue
2356_core_.Image_HSVValue_swigregister(Image_HSVValuePtr)
2357
d55e5bfc 2358class Image(Object):
7a27cf7c
RD
2359 """
2360 A platform-independent image class. An image can be created from
2361 data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
2362 variety of formats. Functions are available to set and get image
2363 bits, so it can be used for basic image manipulation.
2364
2365 A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
2366 platform-specific `wx.Bitmap` object must be created from it using the
2367 `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
2368 device context, using `wx.DC.DrawBitmap`.
2369
2370 One colour value of the image may be used as a mask colour which will
2371 lead to the automatic creation of a `wx.Mask` object associated to the
2372 bitmap object.
2373
2374 wx.Image supports alpha channel data, that is in addition to a byte
2375 for the red, green and blue colour components for each pixel it also
2376 stores a byte representing the pixel opacity. An alpha value of 0
2377 corresponds to a transparent pixel (null opacity) while a value of 255
2378 means that the pixel is 100% opaque.
2379
2380 Unlike RGB data, not all images have an alpha channel and before using
2381 `GetAlpha` you should check if this image contains an alpha channel
2382 with `HasAlpha`. Note that currently only images loaded from PNG files
2383 with transparency information will have an alpha channel.
2384 """
d55e5bfc
RD
2385 def __repr__(self):
2386 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2387 def __init__(self, *args, **kwargs):
7a27cf7c
RD
2388 """
2389 __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
2390
2391 Loads an image from a file.
2392 """
d55e5bfc
RD
2393 newobj = _core_.new_Image(*args, **kwargs)
2394 self.this = newobj.this
2395 self.thisown = 1
2396 del newobj.thisown
2397 def __del__(self, destroy=_core_.delete_Image):
2398 """__del__(self)"""
2399 try:
2400 if self.thisown: destroy(self)
2401 except: pass
2402
2403 def Create(*args, **kwargs):
7a27cf7c
RD
2404 """
2405 Create(self, int width, int height, bool clear=True)
2406
2407 Creates a fresh image. If clear is ``True``, the new image will be
2408 initialized to black. Otherwise, the image data will be uninitialized.
2409 """
d55e5bfc
RD
2410 return _core_.Image_Create(*args, **kwargs)
2411
2412 def Destroy(*args, **kwargs):
2413 """
2414 Destroy(self)
2415
7a27cf7c 2416 Destroys the image data.
d55e5bfc
RD
2417 """
2418 return _core_.Image_Destroy(*args, **kwargs)
2419
2420 def Scale(*args, **kwargs):
7a27cf7c
RD
2421 """
2422 Scale(self, int width, int height) -> Image
2423
2424 Returns a scaled version of the image. This is also useful for scaling
2425 bitmaps in general as the only other way to scale bitmaps is to blit a
2426 `wx.MemoryDC` into another `wx.MemoryDC`.
2427 """
d55e5bfc
RD
2428 return _core_.Image_Scale(*args, **kwargs)
2429
2430 def ShrinkBy(*args, **kwargs):
7a27cf7c
RD
2431 """
2432 ShrinkBy(self, int xFactor, int yFactor) -> Image
2433
2434 Return a version of the image scaled smaller by the given factors.
2435 """
d55e5bfc
RD
2436 return _core_.Image_ShrinkBy(*args, **kwargs)
2437
2438 def Rescale(*args, **kwargs):
7a27cf7c
RD
2439 """
2440 Rescale(self, int width, int height) -> Image
2441
2442 Changes the size of the image in-place by scaling it: after a call to
2443 this function, the image will have the given width and height.
2444
2445 Returns the (modified) image itself.
2446 """
d55e5bfc
RD
2447 return _core_.Image_Rescale(*args, **kwargs)
2448
aff4cc5c 2449 def Resize(*args, **kwargs):
7a27cf7c
RD
2450 """
2451 Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2452
2453 Changes the size of the image in-place without scaling it, by adding
2454 either a border with the given colour or cropping as necessary. The
2455 image is pasted into a new image with the given size and background
2456 colour at the position pos relative to the upper left of the new
2457 image. If red = green = blue = -1 then use either the current mask
2458 colour if set or find, use, and set a suitable mask colour for any
2459 newly exposed areas.
2460
2461 Returns the (modified) image itself.
2462 """
aff4cc5c
RD
2463 return _core_.Image_Resize(*args, **kwargs)
2464
d55e5bfc 2465 def SetRGB(*args, **kwargs):
7a27cf7c
RD
2466 """
2467 SetRGB(self, int x, int y, byte r, byte g, byte b)
2468
2469 Sets the pixel at the given coordinate. This routine performs
2470 bounds-checks for the coordinate so it can be considered a safe way to
2471 manipulate the data, but in some cases this might be too slow so that
2472 the data will have to be set directly. In that case you will have to
2473 get access to the image data using the `GetData` method.
2474 """
d55e5bfc
RD
2475 return _core_.Image_SetRGB(*args, **kwargs)
2476
aff4cc5c 2477 def SetRGBRect(*args, **kwargs):
7a27cf7c
RD
2478 """
2479 SetRGBRect(self, Rect rect, byte r, byte g, byte b)
2480
2481 Sets the colour of the pixels within the given rectangle. This routine
2482 performs bounds-checks for the rectangle so it can be considered a
2483 safe way to manipulate the data.
2484 """
aff4cc5c
RD
2485 return _core_.Image_SetRGBRect(*args, **kwargs)
2486
d55e5bfc 2487 def GetRed(*args, **kwargs):
7a27cf7c
RD
2488 """
2489 GetRed(self, int x, int y) -> byte
2490
2491 Returns the red intensity at the given coordinate.
2492 """
d55e5bfc
RD
2493 return _core_.Image_GetRed(*args, **kwargs)
2494
2495 def GetGreen(*args, **kwargs):
7a27cf7c
RD
2496 """
2497 GetGreen(self, int x, int y) -> byte
2498
2499 Returns the green intensity at the given coordinate.
2500 """
d55e5bfc
RD
2501 return _core_.Image_GetGreen(*args, **kwargs)
2502
2503 def GetBlue(*args, **kwargs):
7a27cf7c
RD
2504 """
2505 GetBlue(self, int x, int y) -> byte
2506
2507 Returns the blue intensity at the given coordinate.
2508 """
d55e5bfc
RD
2509 return _core_.Image_GetBlue(*args, **kwargs)
2510
2511 def SetAlpha(*args, **kwargs):
7a27cf7c
RD
2512 """
2513 SetAlpha(self, int x, int y, byte alpha)
2514
2515 Sets the alpha value for the given pixel. This function should only be
2516 called if the image has alpha channel data, use `HasAlpha` to check
2517 for this.
2518 """
d55e5bfc
RD
2519 return _core_.Image_SetAlpha(*args, **kwargs)
2520
2521 def GetAlpha(*args, **kwargs):
7a27cf7c
RD
2522 """
2523 GetAlpha(self, int x, int y) -> byte
2524
2525 Returns the alpha value for the given pixel. This function may only be
2526 called for the images with alpha channel, use `HasAlpha` to check for
2527 this.
2528
2529 The returned value is the *opacity* of the image, i.e. the value of 0
2530 corresponds to the fully transparent pixels while the value of 255 to
2531 the fully opaque pixels.
2532 """
d55e5bfc
RD
2533 return _core_.Image_GetAlpha(*args, **kwargs)
2534
2535 def HasAlpha(*args, **kwargs):
7a27cf7c
RD
2536 """
2537 HasAlpha(self) -> bool
2538
2539 Returns true if this image has alpha channel, false otherwise.
2540 """
d55e5bfc
RD
2541 return _core_.Image_HasAlpha(*args, **kwargs)
2542
68350608
RD
2543 def InitAlpha(*args, **kwargs):
2544 """
2545 InitAlpha(self)
2546
2547 Initializes the image alpha channel data. It is an error to call it if
2548 the image already has alpha data. If it doesn't, alpha data will be by
2549 default initialized to all pixels being fully opaque. But if the image
2550 has a a mask colour, all mask pixels will be completely transparent.
2551 """
2552 return _core_.Image_InitAlpha(*args, **kwargs)
2553
57133d5c
RD
2554 def IsTransparent(*args, **kwargs):
2555 """
7a27cf7c 2556 IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
57133d5c 2557
7a27cf7c
RD
2558 Returns ``True`` if this pixel is masked or has an alpha value less
2559 than the spcified threshold.
57133d5c
RD
2560 """
2561 return _core_.Image_IsTransparent(*args, **kwargs)
2562
d55e5bfc 2563 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2564 """
2565 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2566
2567 Find first colour that is not used in the image and has higher RGB
2568 values than startR, startG, startB. Returns a tuple consisting of a
2569 success flag and rgb values.
2570 """
d55e5bfc
RD
2571 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2572
4cf4100f
RD
2573 def ConvertAlphaToMask(*args, **kwargs):
2574 """
57133d5c 2575 ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
4cf4100f 2576
7a27cf7c
RD
2577 If the image has alpha channel, this method converts it to mask. All
2578 pixels with alpha value less than ``threshold`` are replaced with the
2579 mask colour and the alpha channel is removed. The mask colour is
2580 chosen automatically using `FindFirstUnusedColour`.
4cf4100f
RD
2581
2582 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2583 nothing.
2584 """
2585 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2586
8fb0e70a
RD
2587 def ConvertColourToAlpha(*args, **kwargs):
2588 """
7a27cf7c 2589 ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
8fb0e70a
RD
2590
2591 This method converts an image where the original alpha information is
2592 only available as a shades of a colour (actually shades of grey)
2593 typically when you draw anti-aliased text into a bitmap. The DC
2594 drawing routines draw grey values on the black background although
2595 they actually mean to draw white with differnt alpha values. This
2596 method reverses it, assuming a black (!) background and white text.
2597 The method will then fill up the whole image with the colour given.
2598 """
2599 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2600
d55e5bfc 2601 def SetMaskFromImage(*args, **kwargs):
7a27cf7c
RD
2602 """
2603 SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
2604
2605 Sets the image's mask so that the pixels that have RGB value of
2606 ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
2607 by first finding an unused colour in the image, setting this colour as
2608 the mask colour and then using this colour to draw all pixels in the
2609 image who corresponding pixel in mask has given RGB value.
2610
2611 Returns ``False`` if ``mask`` does not have same dimensions as the
2612 image or if there is no unused colour left. Returns ``True`` if the
2613 mask was successfully applied.
2614
2615 Note that this method involves computing the histogram, which is
2616 computationally intensive operation.
2617 """
d55e5bfc
RD
2618 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2619
2620 def CanRead(*args, **kwargs):
7a27cf7c
RD
2621 """
2622 CanRead(String filename) -> bool
2623
2624 Returns True if the image handlers can read this file.
2625 """
d55e5bfc
RD
2626 return _core_.Image_CanRead(*args, **kwargs)
2627
2628 CanRead = staticmethod(CanRead)
2629 def GetImageCount(*args, **kwargs):
7a27cf7c
RD
2630 """
2631 GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
2632
2633 If the image file contains more than one image and the image handler
2634 is capable of retrieving these individually, this function will return
2635 the number of available images.
2636 """
d55e5bfc
RD
2637 return _core_.Image_GetImageCount(*args, **kwargs)
2638
2639 GetImageCount = staticmethod(GetImageCount)
2640 def LoadFile(*args, **kwargs):
7a27cf7c
RD
2641 """
2642 LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2643
2644 Loads an image from a file. If no handler type is provided, the
2645 library will try to autodetect the format.
2646 """
d55e5bfc
RD
2647 return _core_.Image_LoadFile(*args, **kwargs)
2648
2649 def LoadMimeFile(*args, **kwargs):
7a27cf7c
RD
2650 """
2651 LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
2652
2653 Loads an image from a file, specifying the image type with a MIME type
2654 string.
2655 """
d55e5bfc
RD
2656 return _core_.Image_LoadMimeFile(*args, **kwargs)
2657
2658 def SaveFile(*args, **kwargs):
7a27cf7c
RD
2659 """
2660 SaveFile(self, String name, int type) -> bool
2661
2662 Saves an image in the named file.
2663 """
d55e5bfc
RD
2664 return _core_.Image_SaveFile(*args, **kwargs)
2665
2666 def SaveMimeFile(*args, **kwargs):
7a27cf7c
RD
2667 """
2668 SaveMimeFile(self, String name, String mimetype) -> bool
2669
2670 Saves an image in the named file.
2671 """
d55e5bfc
RD
2672 return _core_.Image_SaveMimeFile(*args, **kwargs)
2673
2674 def CanReadStream(*args, **kwargs):
7a27cf7c
RD
2675 """
2676 CanReadStream(InputStream stream) -> bool
2677
2678 Returns True if the image handlers can read an image file from the
2679 data currently on the input stream, or a readable Python file-like
2680 object.
2681 """
d55e5bfc
RD
2682 return _core_.Image_CanReadStream(*args, **kwargs)
2683
2684 CanReadStream = staticmethod(CanReadStream)
2685 def LoadStream(*args, **kwargs):
7a27cf7c
RD
2686 """
2687 LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
2688
2689 Loads an image from an input stream or a readable Python file-like
2690 object. If no handler type is provided, the library will try to
2691 autodetect the format.
2692 """
d55e5bfc
RD
2693 return _core_.Image_LoadStream(*args, **kwargs)
2694
2695 def LoadMimeStream(*args, **kwargs):
7a27cf7c
RD
2696 """
2697 LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
2698
2699 Loads an image from an input stream or a readable Python file-like
2700 object, using a MIME type string to specify the image file format.
2701 """
d55e5bfc
RD
2702 return _core_.Image_LoadMimeStream(*args, **kwargs)
2703
2704 def Ok(*args, **kwargs):
7a27cf7c
RD
2705 """
2706 Ok(self) -> bool
2707
2708 Returns true if image data is present.
2709 """
d55e5bfc
RD
2710 return _core_.Image_Ok(*args, **kwargs)
2711
2712 def GetWidth(*args, **kwargs):
7a27cf7c
RD
2713 """
2714 GetWidth(self) -> int
2715
2716 Gets the width of the image in pixels.
2717 """
d55e5bfc
RD
2718 return _core_.Image_GetWidth(*args, **kwargs)
2719
2720 def GetHeight(*args, **kwargs):
7a27cf7c
RD
2721 """
2722 GetHeight(self) -> int
2723
2724 Gets the height of the image in pixels.
2725 """
d55e5bfc
RD
2726 return _core_.Image_GetHeight(*args, **kwargs)
2727
2728 def GetSize(*args, **kwargs):
7a27cf7c
RD
2729 """
2730 GetSize(self) -> Size
2731
2732 Returns the size of the image in pixels.
2733 """
d55e5bfc
RD
2734 return _core_.Image_GetSize(*args, **kwargs)
2735
2736 def GetSubImage(*args, **kwargs):
7a27cf7c
RD
2737 """
2738 GetSubImage(self, Rect rect) -> Image
2739
2740 Returns a sub image of the current one as long as the rect belongs
2741 entirely to the image.
2742 """
d55e5bfc
RD
2743 return _core_.Image_GetSubImage(*args, **kwargs)
2744
aff4cc5c 2745 def Size(*args, **kwargs):
7a27cf7c
RD
2746 """
2747 Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
2748
2749 Returns a resized version of this image without scaling it by adding
2750 either a border with the given colour or cropping as necessary. The
2751 image is pasted into a new image with the given size and background
2752 colour at the position ``pos`` relative to the upper left of the new
2753 image. If red = green = blue = -1 then use either the current mask
2754 colour if set or find, use, and set a suitable mask colour for any
2755 newly exposed areas.
2756 """
aff4cc5c
RD
2757 return _core_.Image_Size(*args, **kwargs)
2758
d55e5bfc 2759 def Copy(*args, **kwargs):
7a27cf7c
RD
2760 """
2761 Copy(self) -> Image
2762
2763 Returns an identical copy of the image.
2764 """
d55e5bfc
RD
2765 return _core_.Image_Copy(*args, **kwargs)
2766
2767 def Paste(*args, **kwargs):
7a27cf7c
RD
2768 """
2769 Paste(self, Image image, int x, int y)
2770
2771 Pastes ``image`` into this instance and takes care of the mask colour
2772 and any out of bounds problems.
2773 """
d55e5bfc
RD
2774 return _core_.Image_Paste(*args, **kwargs)
2775
2776 def GetData(*args, **kwargs):
ea939623
RD
2777 """
2778 GetData(self) -> PyObject
2779
2780 Returns a string containing a copy of the RGB bytes of the image.
2781 """
d55e5bfc
RD
2782 return _core_.Image_GetData(*args, **kwargs)
2783
2784 def SetData(*args, **kwargs):
ea939623
RD
2785 """
2786 SetData(self, buffer data)
2787
2788 Resets the Image's RGB data from a buffer of RGB bytes. Accepts
2789 either a string or a buffer object holding the data and the length of
2790 the data must be width*height*3.
2791 """
d55e5bfc
RD
2792 return _core_.Image_SetData(*args, **kwargs)
2793
2794 def GetDataBuffer(*args, **kwargs):
ea939623
RD
2795 """
2796 GetDataBuffer(self) -> PyObject
2797
2798 Returns a writable Python buffer object that is pointing at the RGB
7a27cf7c
RD
2799 image data buffer inside the wx.Image. You need to ensure that you do
2800 not use this buffer object after the image has been destroyed.
ea939623 2801 """
d55e5bfc
RD
2802 return _core_.Image_GetDataBuffer(*args, **kwargs)
2803
2804 def SetDataBuffer(*args, **kwargs):
ea939623
RD
2805 """
2806 SetDataBuffer(self, buffer data)
2807
2808 Sets the internal image data pointer to point at a Python buffer
7a27cf7c
RD
2809 object. This can save making an extra copy of the data but you must
2810 ensure that the buffer object lives longer than the wx.Image does.
ea939623 2811 """
d55e5bfc
RD
2812 return _core_.Image_SetDataBuffer(*args, **kwargs)
2813
2814 def GetAlphaData(*args, **kwargs):
ea939623
RD
2815 """
2816 GetAlphaData(self) -> PyObject
2817
2818 Returns a string containing a copy of the alpha bytes of the image.
2819 """
d55e5bfc
RD
2820 return _core_.Image_GetAlphaData(*args, **kwargs)
2821
2822 def SetAlphaData(*args, **kwargs):
ea939623
RD
2823 """
2824 SetAlphaData(self, buffer alpha)
2825
2826 Resets the Image's alpha data from a buffer of bytes. Accepts either
2827 a string or a buffer object holding the data and the length of the
2828 data must be width*height.
2829 """
d55e5bfc
RD
2830 return _core_.Image_SetAlphaData(*args, **kwargs)
2831
2832 def GetAlphaBuffer(*args, **kwargs):
2833 """GetAlphaBuffer(self) -> PyObject"""
2834 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2835
2836 def SetAlphaBuffer(*args, **kwargs):
ea939623 2837 """SetAlphaBuffer(self, buffer alpha)"""
d55e5bfc
RD
2838 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2839
2840 def SetMaskColour(*args, **kwargs):
7a27cf7c
RD
2841 """
2842 SetMaskColour(self, byte r, byte g, byte b)
2843
2844 Sets the mask colour for this image (and tells the image to use the
2845 mask).
2846 """
d55e5bfc
RD
2847 return _core_.Image_SetMaskColour(*args, **kwargs)
2848
aff4cc5c
RD
2849 def GetOrFindMaskColour(*args, **kwargs):
2850 """
2851 GetOrFindMaskColour() -> (r,g,b)
2852
2853 Get the current mask colour or find a suitable colour.
2854 """
2855 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2856
d55e5bfc 2857 def GetMaskRed(*args, **kwargs):
7a27cf7c
RD
2858 """
2859 GetMaskRed(self) -> byte
2860
2861 Gets the red component of the mask colour.
2862 """
d55e5bfc
RD
2863 return _core_.Image_GetMaskRed(*args, **kwargs)
2864
2865 def GetMaskGreen(*args, **kwargs):
7a27cf7c
RD
2866 """
2867 GetMaskGreen(self) -> byte
2868
2869 Gets the green component of the mask colour.
2870 """
d55e5bfc
RD
2871 return _core_.Image_GetMaskGreen(*args, **kwargs)
2872
2873 def GetMaskBlue(*args, **kwargs):
7a27cf7c
RD
2874 """
2875 GetMaskBlue(self) -> byte
2876
2877 Gets the blue component of the mask colour.
2878 """
d55e5bfc
RD
2879 return _core_.Image_GetMaskBlue(*args, **kwargs)
2880
2881 def SetMask(*args, **kwargs):
7a27cf7c
RD
2882 """
2883 SetMask(self, bool mask=True)
2884
2885 Specifies whether there is a mask or not. The area of the mask is
2886 determined by the current mask colour.
2887 """
d55e5bfc
RD
2888 return _core_.Image_SetMask(*args, **kwargs)
2889
2890 def HasMask(*args, **kwargs):
7a27cf7c
RD
2891 """
2892 HasMask(self) -> bool
2893
2894 Returns ``True`` if there is a mask active, ``False`` otherwise.
2895 """
d55e5bfc
RD
2896 return _core_.Image_HasMask(*args, **kwargs)
2897
2898 def Rotate(*args, **kwargs):
2899 """
2900 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2901 Point offset_after_rotation=None) -> Image
7a27cf7c
RD
2902
2903 Rotates the image about the given point, by ``angle`` radians. Passing
2904 ``True`` to ``interpolating`` results in better image quality, but is
2905 slower. If the image has a mask, then the mask colour is used for the
2906 uncovered pixels in the rotated image background. Otherwise, black
2907 will be used as the fill colour.
2908
2909 Returns the rotated image, leaving this image intact.
d55e5bfc
RD
2910 """
2911 return _core_.Image_Rotate(*args, **kwargs)
2912
2913 def Rotate90(*args, **kwargs):
7a27cf7c
RD
2914 """
2915 Rotate90(self, bool clockwise=True) -> Image
2916
2917 Returns a copy of the image rotated 90 degrees in the direction
2918 indicated by ``clockwise``.
2919 """
d55e5bfc
RD
2920 return _core_.Image_Rotate90(*args, **kwargs)
2921
2922 def Mirror(*args, **kwargs):
7a27cf7c
RD
2923 """
2924 Mirror(self, bool horizontally=True) -> Image
2925
2926 Returns a mirrored copy of the image. The parameter ``horizontally``
2927 indicates the orientation.
2928 """
d55e5bfc
RD
2929 return _core_.Image_Mirror(*args, **kwargs)
2930
2931 def Replace(*args, **kwargs):
2932 """
7a27cf7c
RD
2933 Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
2934
2935 Replaces the colour specified by ``(r1,g1,b1)`` by the colour
2936 ``(r2,g2,b2)``.
d55e5bfc
RD
2937 """
2938 return _core_.Image_Replace(*args, **kwargs)
2939
2940 def ConvertToMono(*args, **kwargs):
7a27cf7c
RD
2941 """
2942 ConvertToMono(self, byte r, byte g, byte b) -> Image
2943
2944 Returns monochromatic version of the image. The returned image has
2945 white colour where the original has ``(r,g,b)`` colour and black
2946 colour everywhere else.
2947 """
d55e5bfc
RD
2948 return _core_.Image_ConvertToMono(*args, **kwargs)
2949
2950 def SetOption(*args, **kwargs):
7a27cf7c
RD
2951 """
2952 SetOption(self, String name, String value)
2953
2954 Sets an image handler defined option. For example, when saving as a
2955 JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
2956 number between 0 and 100 (0 is terrible, 100 is very good).
2957 """
d55e5bfc
RD
2958 return _core_.Image_SetOption(*args, **kwargs)
2959
2960 def SetOptionInt(*args, **kwargs):
7a27cf7c
RD
2961 """
2962 SetOptionInt(self, String name, int value)
2963
2964 Sets an image option as an integer.
2965 """
d55e5bfc
RD
2966 return _core_.Image_SetOptionInt(*args, **kwargs)
2967
2968 def GetOption(*args, **kwargs):
7a27cf7c
RD
2969 """
2970 GetOption(self, String name) -> String
2971
2972 Gets the value of an image handler option.
2973 """
d55e5bfc
RD
2974 return _core_.Image_GetOption(*args, **kwargs)
2975
2976 def GetOptionInt(*args, **kwargs):
7a27cf7c
RD
2977 """
2978 GetOptionInt(self, String name) -> int
2979
2980 Gets the value of an image handler option as an integer. If the given
2981 option is not present, the function returns 0.
2982 """
d55e5bfc
RD
2983 return _core_.Image_GetOptionInt(*args, **kwargs)
2984
2985 def HasOption(*args, **kwargs):
7a27cf7c
RD
2986 """
2987 HasOption(self, String name) -> bool
2988
2989 Returns true if the given option is present.
2990 """
d55e5bfc
RD
2991 return _core_.Image_HasOption(*args, **kwargs)
2992
2993 def CountColours(*args, **kwargs):
2994 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2995 return _core_.Image_CountColours(*args, **kwargs)
2996
2997 def ComputeHistogram(*args, **kwargs):
2998 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2999 return _core_.Image_ComputeHistogram(*args, **kwargs)
3000
3001 def AddHandler(*args, **kwargs):
c24da6d6 3002 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
3003 return _core_.Image_AddHandler(*args, **kwargs)
3004
3005 AddHandler = staticmethod(AddHandler)
3006 def InsertHandler(*args, **kwargs):
c24da6d6 3007 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
3008 return _core_.Image_InsertHandler(*args, **kwargs)
3009
3010 InsertHandler = staticmethod(InsertHandler)
3011 def RemoveHandler(*args, **kwargs):
c24da6d6 3012 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
3013 return _core_.Image_RemoveHandler(*args, **kwargs)
3014
3015 RemoveHandler = staticmethod(RemoveHandler)
3016 def GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD
3017 """
3018 GetImageExtWildcard() -> String
3019
3020 Iterates all registered wxImageHandler objects, and returns a string
3021 containing file extension masks suitable for passing to file open/save
3022 dialog boxes.
3023 """
d55e5bfc
RD
3024 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3025
3026 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
3027 def ConvertToBitmap(*args, **kwargs):
1fbf26be 3028 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD
3029 return _core_.Image_ConvertToBitmap(*args, **kwargs)
3030
3031 def ConvertToMonoBitmap(*args, **kwargs):
7a27cf7c 3032 """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
d55e5bfc
RD
3033 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
3034
2f91e3df
KO
3035 def RotateHue(*args, **kwargs):
3036 """
3037 RotateHue(self, double angle)
3038
3039 Rotates the hue of each pixel of the image. Hue is a double in the
3040 range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
3041 """
3042 return _core_.Image_RotateHue(*args, **kwargs)
3043
3044 def RGBtoHSV(*args, **kwargs):
9d7dfdff
RD
3045 """
3046 RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3047
3048 Converts a color in RGB color space to HSV color space.
3049 """
2f91e3df
KO
3050 return _core_.Image_RGBtoHSV(*args, **kwargs)
3051
3052 RGBtoHSV = staticmethod(RGBtoHSV)
3053 def HSVtoRGB(*args, **kwargs):
9d7dfdff
RD
3054 """
3055 HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3056
3057 Converts a color in HSV color space to RGB color space.
3058 """
2f91e3df
KO
3059 return _core_.Image_HSVtoRGB(*args, **kwargs)
3060
3061 HSVtoRGB = staticmethod(HSVtoRGB)
d55e5bfc
RD
3062 def __nonzero__(self): return self.Ok()
3063
3064class ImagePtr(Image):
3065 def __init__(self, this):
3066 self.this = this
3067 if not hasattr(self,"thisown"): self.thisown = 0
3068 self.__class__ = Image
3069_core_.Image_swigregister(ImagePtr)
3070
3071def ImageFromMime(*args, **kwargs):
7a27cf7c
RD
3072 """
3073 ImageFromMime(String name, String mimetype, int index=-1) -> Image
3074
3075 Loads an image from a file, using a MIME type string (such as
3076 'image/jpeg') to specify image type.
3077 """
d55e5bfc
RD
3078 val = _core_.new_ImageFromMime(*args, **kwargs)
3079 val.thisown = 1
3080 return val
3081
3082def ImageFromStream(*args, **kwargs):
7a27cf7c
RD
3083 """
3084 ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
3085
3086 Loads an image from an input stream, or any readable Python file-like
3087 object.
3088 """
d55e5bfc
RD
3089 val = _core_.new_ImageFromStream(*args, **kwargs)
3090 val.thisown = 1
3091 return val
3092
3093def ImageFromStreamMime(*args, **kwargs):
7a27cf7c
RD
3094 """
3095 ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
3096
3097 Loads an image from an input stream, or any readable Python file-like
3098 object, specifying the image format with a MIME type string.
3099 """
d55e5bfc
RD
3100 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
3101 val.thisown = 1
3102 return val
3103
c24da6d6 3104def EmptyImage(*args, **kwargs):
ea939623
RD
3105 """
3106 EmptyImage(int width=0, int height=0, bool clear=True) -> Image
3107
3108 Construct an empty image of a given size, optionally setting all
3109 pixels to black.
3110 """
c24da6d6 3111 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
3112 val.thisown = 1
3113 return val
3114
3115def ImageFromBitmap(*args, **kwargs):
ea939623
RD
3116 """
3117 ImageFromBitmap(Bitmap bitmap) -> Image
3118
3119 Construct an Image from a `wx.Bitmap`.
3120 """
d55e5bfc
RD
3121 val = _core_.new_ImageFromBitmap(*args, **kwargs)
3122 val.thisown = 1
3123 return val
3124
3125def ImageFromData(*args, **kwargs):
ea939623
RD
3126 """
3127 ImageFromData(int width, int height, buffer data) -> Image
3128
3129 Construct an Image from a buffer of RGB bytes. Accepts either a
3130 string or a buffer object holding the data and the length of the data
3131 must be width*height*3.
3132 """
d55e5bfc
RD
3133 val = _core_.new_ImageFromData(*args, **kwargs)
3134 val.thisown = 1
3135 return val
3136
c9c2cf70 3137def ImageFromDataWithAlpha(*args, **kwargs):
ea939623
RD
3138 """
3139 ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
3140
3141 Construct an Image from a buffer of RGB bytes with an Alpha channel.
3142 Accepts either a string or a buffer object holding the data and the
7a27cf7c
RD
3143 length of the data must be width*height*3 bytes, and the length of the
3144 alpha data must be width*height bytes.
ea939623 3145 """
c9c2cf70
RD
3146 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
3147 val.thisown = 1
3148 return val
3149
d55e5bfc 3150def Image_CanRead(*args, **kwargs):
7a27cf7c
RD
3151 """
3152 Image_CanRead(String filename) -> bool
3153
3154 Returns True if the image handlers can read this file.
3155 """
d55e5bfc
RD
3156 return _core_.Image_CanRead(*args, **kwargs)
3157
3158def Image_GetImageCount(*args, **kwargs):
7a27cf7c
RD
3159 """
3160 Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
3161
3162 If the image file contains more than one image and the image handler
3163 is capable of retrieving these individually, this function will return
3164 the number of available images.
3165 """
d55e5bfc
RD
3166 return _core_.Image_GetImageCount(*args, **kwargs)
3167
3168def Image_CanReadStream(*args, **kwargs):
7a27cf7c
RD
3169 """
3170 Image_CanReadStream(InputStream stream) -> bool
3171
3172 Returns True if the image handlers can read an image file from the
3173 data currently on the input stream, or a readable Python file-like
3174 object.
3175 """
d55e5bfc
RD
3176 return _core_.Image_CanReadStream(*args, **kwargs)
3177
3178def Image_AddHandler(*args, **kwargs):
3179 """Image_AddHandler(ImageHandler handler)"""
3180 return _core_.Image_AddHandler(*args, **kwargs)
3181
3182def Image_InsertHandler(*args, **kwargs):
3183 """Image_InsertHandler(ImageHandler handler)"""
3184 return _core_.Image_InsertHandler(*args, **kwargs)
3185
3186def Image_RemoveHandler(*args, **kwargs):
3187 """Image_RemoveHandler(String name) -> bool"""
3188 return _core_.Image_RemoveHandler(*args, **kwargs)
3189
3190def Image_GetImageExtWildcard(*args, **kwargs):
7a27cf7c
RD
3191 """
3192 Image_GetImageExtWildcard() -> String
3193
3194 Iterates all registered wxImageHandler objects, and returns a string
3195 containing file extension masks suitable for passing to file open/save
3196 dialog boxes.
3197 """
d55e5bfc
RD
3198 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
3199
2f91e3df 3200def Image_RGBtoHSV(*args, **kwargs):
9d7dfdff
RD
3201 """
3202 Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
3203
3204 Converts a color in RGB color space to HSV color space.
3205 """
2f91e3df
KO
3206 return _core_.Image_RGBtoHSV(*args, **kwargs)
3207
3208def Image_HSVtoRGB(*args, **kwargs):
9d7dfdff
RD
3209 """
3210 Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
3211
3212 Converts a color in HSV color space to RGB color space.
3213 """
2f91e3df
KO
3214 return _core_.Image_HSVtoRGB(*args, **kwargs)
3215
a07a67e6
RD
3216def InitAllImageHandlers():
3217 """
3218 The former functionality of InitAllImageHanders is now done internal to
3219 the _core_ extension module and so this function has become a simple NOP.
3220 """
3221 pass
d55e5bfc 3222
d55e5bfc
RD
3223IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
3224IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD
3225PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
3226PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
3227PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD
3228BMP_24BPP = _core_.BMP_24BPP
3229BMP_8BPP = _core_.BMP_8BPP
3230BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
3231BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
3232BMP_8BPP_RED = _core_.BMP_8BPP_RED
3233BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
3234BMP_4BPP = _core_.BMP_4BPP
3235BMP_1BPP = _core_.BMP_1BPP
3236BMP_1BPP_BW = _core_.BMP_1BPP_BW
3237class BMPHandler(ImageHandler):
27fb7603 3238 """A `wx.ImageHandler` for \*.bmp bitmap files."""
d55e5bfc
RD
3239 def __repr__(self):
3240 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3241 def __init__(self, *args, **kwargs):
27fb7603
RD
3242 """
3243 __init__(self) -> BMPHandler
3244
3245 A `wx.ImageHandler` for \*.bmp bitmap files.
3246 """
d55e5bfc
RD
3247 newobj = _core_.new_BMPHandler(*args, **kwargs)
3248 self.this = newobj.this
3249 self.thisown = 1
3250 del newobj.thisown
3251
3252class BMPHandlerPtr(BMPHandler):
3253 def __init__(self, this):
3254 self.this = this
3255 if not hasattr(self,"thisown"): self.thisown = 0
3256 self.__class__ = BMPHandler
3257_core_.BMPHandler_swigregister(BMPHandlerPtr)
3258NullImage = cvar.NullImage
68350608 3259IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD
3260IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
3261IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
3262IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
3263IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD
3264IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
3265IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 3266IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 3267IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD
3268IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
3269IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
3270IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
3271IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD
3272IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
3273IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD
3274
3275class ICOHandler(BMPHandler):
27fb7603 3276 """A `wx.ImageHandler` for \*.ico icon files."""
d55e5bfc
RD
3277 def __repr__(self):
3278 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3279 def __init__(self, *args, **kwargs):
27fb7603
RD
3280 """
3281 __init__(self) -> ICOHandler
3282
3283 A `wx.ImageHandler` for \*.ico icon files.
3284 """
d55e5bfc
RD
3285 newobj = _core_.new_ICOHandler(*args, **kwargs)
3286 self.this = newobj.this
3287 self.thisown = 1
3288 del newobj.thisown
3289
3290class ICOHandlerPtr(ICOHandler):
3291 def __init__(self, this):
3292 self.this = this
3293 if not hasattr(self,"thisown"): self.thisown = 0
3294 self.__class__ = ICOHandler
3295_core_.ICOHandler_swigregister(ICOHandlerPtr)
3296
3297class CURHandler(ICOHandler):
27fb7603 3298 """A `wx.ImageHandler` for \*.cur cursor files."""
d55e5bfc
RD
3299 def __repr__(self):
3300 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3301 def __init__(self, *args, **kwargs):
27fb7603
RD
3302 """
3303 __init__(self) -> CURHandler
3304
3305 A `wx.ImageHandler` for \*.cur cursor files.
3306 """
d55e5bfc
RD
3307 newobj = _core_.new_CURHandler(*args, **kwargs)
3308 self.this = newobj.this
3309 self.thisown = 1
3310 del newobj.thisown
3311
3312class CURHandlerPtr(CURHandler):
3313 def __init__(self, this):
3314 self.this = this
3315 if not hasattr(self,"thisown"): self.thisown = 0
3316 self.__class__ = CURHandler
3317_core_.CURHandler_swigregister(CURHandlerPtr)
3318
3319class ANIHandler(CURHandler):
27fb7603 3320 """A `wx.ImageHandler` for \*.ani animated cursor files."""
d55e5bfc
RD
3321 def __repr__(self):
3322 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3323 def __init__(self, *args, **kwargs):
27fb7603
RD
3324 """
3325 __init__(self) -> ANIHandler
3326
3327 A `wx.ImageHandler` for \*.ani animated cursor files.
3328 """
d55e5bfc
RD
3329 newobj = _core_.new_ANIHandler(*args, **kwargs)
3330 self.this = newobj.this
3331 self.thisown = 1
3332 del newobj.thisown
3333
3334class ANIHandlerPtr(ANIHandler):
3335 def __init__(self, this):
3336 self.this = this
3337 if not hasattr(self,"thisown"): self.thisown = 0
3338 self.__class__ = ANIHandler
3339_core_.ANIHandler_swigregister(ANIHandlerPtr)
3340
3341class PNGHandler(ImageHandler):
27fb7603 3342 """A `wx.ImageHandler` for PNG image files."""
d55e5bfc
RD
3343 def __repr__(self):
3344 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3345 def __init__(self, *args, **kwargs):
27fb7603
RD
3346 """
3347 __init__(self) -> PNGHandler
3348
3349 A `wx.ImageHandler` for PNG image files.
3350 """
d55e5bfc
RD
3351 newobj = _core_.new_PNGHandler(*args, **kwargs)
3352 self.this = newobj.this
3353 self.thisown = 1
3354 del newobj.thisown
3355
3356class PNGHandlerPtr(PNGHandler):
3357 def __init__(self, this):
3358 self.this = this
3359 if not hasattr(self,"thisown"): self.thisown = 0
3360 self.__class__ = PNGHandler
3361_core_.PNGHandler_swigregister(PNGHandlerPtr)
3362
3363class GIFHandler(ImageHandler):
27fb7603 3364 """A `wx.ImageHandler` for GIF image files."""
d55e5bfc
RD
3365 def __repr__(self):
3366 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3367 def __init__(self, *args, **kwargs):
27fb7603
RD
3368 """
3369 __init__(self) -> GIFHandler
3370
3371 A `wx.ImageHandler` for GIF image files.
3372 """
d55e5bfc
RD
3373 newobj = _core_.new_GIFHandler(*args, **kwargs)
3374 self.this = newobj.this
3375 self.thisown = 1
3376 del newobj.thisown
3377
3378class GIFHandlerPtr(GIFHandler):
3379 def __init__(self, this):
3380 self.this = this
3381 if not hasattr(self,"thisown"): self.thisown = 0
3382 self.__class__ = GIFHandler
3383_core_.GIFHandler_swigregister(GIFHandlerPtr)
3384
3385class PCXHandler(ImageHandler):
27fb7603 3386 """A `wx.ImageHandler` for PCX imager files."""
d55e5bfc
RD
3387 def __repr__(self):
3388 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3389 def __init__(self, *args, **kwargs):
27fb7603
RD
3390 """
3391 __init__(self) -> PCXHandler
3392
3393 A `wx.ImageHandler` for PCX imager files.
3394 """
d55e5bfc
RD
3395 newobj = _core_.new_PCXHandler(*args, **kwargs)
3396 self.this = newobj.this
3397 self.thisown = 1
3398 del newobj.thisown
3399
3400class PCXHandlerPtr(PCXHandler):
3401 def __init__(self, this):
3402 self.this = this
3403 if not hasattr(self,"thisown"): self.thisown = 0
3404 self.__class__ = PCXHandler
3405_core_.PCXHandler_swigregister(PCXHandlerPtr)
3406
3407class JPEGHandler(ImageHandler):
27fb7603 3408 """A `wx.ImageHandler` for JPEG/JPG image files."""
d55e5bfc
RD
3409 def __repr__(self):
3410 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3411 def __init__(self, *args, **kwargs):
27fb7603
RD
3412 """
3413 __init__(self) -> JPEGHandler
3414
3415 A `wx.ImageHandler` for JPEG/JPG image files.
3416 """
d55e5bfc
RD
3417 newobj = _core_.new_JPEGHandler(*args, **kwargs)
3418 self.this = newobj.this
3419 self.thisown = 1
3420 del newobj.thisown
3421
3422class JPEGHandlerPtr(JPEGHandler):
3423 def __init__(self, this):
3424 self.this = this
3425 if not hasattr(self,"thisown"): self.thisown = 0
3426 self.__class__ = JPEGHandler
3427_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
3428
3429class PNMHandler(ImageHandler):
27fb7603 3430 """A `wx.ImageHandler` for PNM image files."""
d55e5bfc
RD
3431 def __repr__(self):
3432 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3433 def __init__(self, *args, **kwargs):
27fb7603
RD
3434 """
3435 __init__(self) -> PNMHandler
3436
3437 A `wx.ImageHandler` for PNM image files.
3438 """
d55e5bfc
RD
3439 newobj = _core_.new_PNMHandler(*args, **kwargs)
3440 self.this = newobj.this
3441 self.thisown = 1
3442 del newobj.thisown
3443
3444class PNMHandlerPtr(PNMHandler):
3445 def __init__(self, this):
3446 self.this = this
3447 if not hasattr(self,"thisown"): self.thisown = 0
3448 self.__class__ = PNMHandler
3449_core_.PNMHandler_swigregister(PNMHandlerPtr)
3450
3451class XPMHandler(ImageHandler):
27fb7603 3452 """A `wx.ImageHandler` for XPM image."""
d55e5bfc
RD
3453 def __repr__(self):
3454 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3455 def __init__(self, *args, **kwargs):
27fb7603
RD
3456 """
3457 __init__(self) -> XPMHandler
3458
3459 A `wx.ImageHandler` for XPM image.
3460 """
d55e5bfc
RD
3461 newobj = _core_.new_XPMHandler(*args, **kwargs)
3462 self.this = newobj.this
3463 self.thisown = 1
3464 del newobj.thisown
3465
3466class XPMHandlerPtr(XPMHandler):
3467 def __init__(self, this):
3468 self.this = this
3469 if not hasattr(self,"thisown"): self.thisown = 0
3470 self.__class__ = XPMHandler
3471_core_.XPMHandler_swigregister(XPMHandlerPtr)
3472
3473class TIFFHandler(ImageHandler):
27fb7603 3474 """A `wx.ImageHandler` for TIFF image files."""
d55e5bfc
RD
3475 def __repr__(self):
3476 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3477 def __init__(self, *args, **kwargs):
27fb7603
RD
3478 """
3479 __init__(self) -> TIFFHandler
3480
3481 A `wx.ImageHandler` for TIFF image files.
3482 """
d55e5bfc
RD
3483 newobj = _core_.new_TIFFHandler(*args, **kwargs)
3484 self.this = newobj.this
3485 self.thisown = 1
3486 del newobj.thisown
3487
3488class TIFFHandlerPtr(TIFFHandler):
3489 def __init__(self, this):
3490 self.this = this
3491 if not hasattr(self,"thisown"): self.thisown = 0
3492 self.__class__ = TIFFHandler
3493_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
3494
c0de73ae
RD
3495QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
3496QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
3497class Quantize(object):
3498 """Performs quantization, or colour reduction, on a wxImage."""
3499 def __init__(self): raise RuntimeError, "No constructor defined"
3500 def __repr__(self):
3501 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3502 def Quantize(*args, **kwargs):
3503 """
3504 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3505
3506 Reduce the colours in the source image and put the result into the
3507 destination image, setting the palette in the destination if
3508 needed. Both images may be the same, to overwrite the source image.
3509 """
3510 return _core_.Quantize_Quantize(*args, **kwargs)
3511
3512 Quantize = staticmethod(Quantize)
3513
3514class QuantizePtr(Quantize):
3515 def __init__(self, this):
3516 self.this = this
3517 if not hasattr(self,"thisown"): self.thisown = 0
3518 self.__class__ = Quantize
3519_core_.Quantize_swigregister(QuantizePtr)
3520
3521def Quantize_Quantize(*args, **kwargs):
3522 """
3523 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
3524
3525 Reduce the colours in the source image and put the result into the
3526 destination image, setting the palette in the destination if
3527 needed. Both images may be the same, to overwrite the source image.
3528 """
3529 return _core_.Quantize_Quantize(*args, **kwargs)
3530
d55e5bfc
RD
3531#---------------------------------------------------------------------------
3532
3533class EvtHandler(Object):
093d3ff1 3534 """Proxy of C++ EvtHandler class"""
d55e5bfc
RD
3535 def __repr__(self):
3536 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3537 def __init__(self, *args, **kwargs):
3538 """__init__(self) -> EvtHandler"""
3539 newobj = _core_.new_EvtHandler(*args, **kwargs)
3540 self.this = newobj.this
3541 self.thisown = 1
3542 del newobj.thisown
3543 def GetNextHandler(*args, **kwargs):
3544 """GetNextHandler(self) -> EvtHandler"""
3545 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
3546
3547 def GetPreviousHandler(*args, **kwargs):
3548 """GetPreviousHandler(self) -> EvtHandler"""
3549 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
3550
3551 def SetNextHandler(*args, **kwargs):
3552 """SetNextHandler(self, EvtHandler handler)"""
3553 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
3554
3555 def SetPreviousHandler(*args, **kwargs):
3556 """SetPreviousHandler(self, EvtHandler handler)"""
3557 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
3558
3559 def GetEvtHandlerEnabled(*args, **kwargs):
3560 """GetEvtHandlerEnabled(self) -> bool"""
3561 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
3562
3563 def SetEvtHandlerEnabled(*args, **kwargs):
3564 """SetEvtHandlerEnabled(self, bool enabled)"""
3565 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
3566
3567 def ProcessEvent(*args, **kwargs):
3568 """ProcessEvent(self, Event event) -> bool"""
3569 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
3570
3571 def AddPendingEvent(*args, **kwargs):
3572 """AddPendingEvent(self, Event event)"""
3573 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
3574
3575 def ProcessPendingEvents(*args, **kwargs):
3576 """ProcessPendingEvents(self)"""
3577 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
3578
3579 def Connect(*args, **kwargs):
3580 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
3581 return _core_.EvtHandler_Connect(*args, **kwargs)
3582
3583 def Disconnect(*args, **kwargs):
3584 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
3585 return _core_.EvtHandler_Disconnect(*args, **kwargs)
3586
3587 def _setOORInfo(*args, **kwargs):
093d3ff1 3588 """_setOORInfo(self, PyObject _self, bool incref=True)"""
d55e5bfc
RD
3589 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
3590
3591 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3592 """
3593 Bind an event to an event handler.
3594
caef1a4d
RD
3595 :param event: One of the EVT_* objects that specifies the
3596 type of event to bind,
d55e5bfc 3597
caef1a4d
RD
3598 :param handler: A callable object to be invoked when the
3599 event is delivered to self. Pass None to
3600 disconnect an event handler.
d55e5bfc 3601
caef1a4d
RD
3602 :param source: Sometimes the event originates from a
3603 different window than self, but you still
3604 want to catch it in self. (For example, a
3605 button event delivered to a frame.) By
3606 passing the source of the event, the event
3607 handling system is able to differentiate
3608 between the same event type from different
3609 controls.
d55e5bfc 3610
caef1a4d
RD
3611 :param id: Used to spcify the event source by ID instead
3612 of instance.
3613
3614 :param id2: Used when it is desirable to bind a handler
3615 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
3616 """
3617 if source is not None:
3618 id = source.GetId()
3619 event.Bind(self, id, id2, handler)
3620
c24da6d6
RD
3621 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
3622 """
3623 Disconencts the event handler binding for event from self.
3624 Returns True if successful.
3625 """
3626 if source is not None:
3627 id = source.GetId()
3628 return event.Unbind(self, id, id2)
d55e5bfc
RD
3629
3630
3631class EvtHandlerPtr(EvtHandler):
3632 def __init__(self, this):
3633 self.this = this
3634 if not hasattr(self,"thisown"): self.thisown = 0
3635 self.__class__ = EvtHandler
3636_core_.EvtHandler_swigregister(EvtHandlerPtr)
3637
3638#---------------------------------------------------------------------------
3639
3640class PyEventBinder(object):
3641 """
3642 Instances of this class are used to bind specific events to event
3643 handlers.
3644 """
3645 def __init__(self, evtType, expectedIDs=0):
3646 if expectedIDs not in [0, 1, 2]:
3647 raise ValueError, "Invalid number of expectedIDs"
3648 self.expectedIDs = expectedIDs
3649
3650 if type(evtType) == list or type(evtType) == tuple:
3651 self.evtType = evtType
3652 else:
3653 self.evtType = [evtType]
3654
3655
3656 def Bind(self, target, id1, id2, function):
3657 """Bind this set of event types to target."""
3658 for et in self.evtType:
3659 target.Connect(id1, id2, et, function)
3660
c24da6d6
RD
3661
3662 def Unbind(self, target, id1, id2):
3663 """Remove an event binding."""
3664 success = 0
3665 for et in self.evtType:
3666 success += target.Disconnect(id1, id2, et)
3667 return success != 0
3668
d55e5bfc
RD
3669
3670 def __call__(self, *args):
3671 """
3672 For backwards compatibility with the old EVT_* functions.
3673 Should be called with either (window, func), (window, ID,
3674 func) or (window, ID1, ID2, func) parameters depending on the
3675 type of the event.
3676 """
3677 assert len(args) == 2 + self.expectedIDs
3678 id1 = wx.ID_ANY
3679 id2 = wx.ID_ANY
3680 target = args[0]
3681 if self.expectedIDs == 0:
3682 func = args[1]
3683 elif self.expectedIDs == 1:
3684 id1 = args[1]
3685 func = args[2]
3686 elif self.expectedIDs == 2:
3687 id1 = args[1]
3688 id2 = args[2]
3689 func = args[3]
3690 else:
3691 raise ValueError, "Unexpected number of IDs"
3692
3693 self.Bind(target, id1, id2, func)
3694
3695
3696# These two are square pegs that don't fit the PyEventBinder hole...
3697def EVT_COMMAND(win, id, cmd, func):
3698 win.Connect(id, -1, cmd, func)
3699def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3700 win.Connect(id1, id2, cmd, func)
3701
3702
3703#---------------------------------------------------------------------------
3704
3705#---------------------------------------------------------------------------
3706
3707EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3708EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3709
3710def NewEventType(*args, **kwargs):
3711 """NewEventType() -> wxEventType"""
3712 return _core_.NewEventType(*args, **kwargs)
3713wxEVT_NULL = _core_.wxEVT_NULL
3714wxEVT_FIRST = _core_.wxEVT_FIRST
3715wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3716wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3717wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3718wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3719wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3720wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3721wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3722wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3723wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3724wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3725wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3726wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3727wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3728wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3729wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3730wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3731wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3732wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3733wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3734wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3735wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3736wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3737wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3738wxEVT_MOTION = _core_.wxEVT_MOTION
3739wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3740wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3741wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3742wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3743wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3744wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3745wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3746wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3747wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3748wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3749wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3750wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3751wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3752wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3753wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3754wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3755wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3756wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3757wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3758wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3759wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3760wxEVT_CHAR = _core_.wxEVT_CHAR
3761wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3762wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3763wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3764wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3765wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3766wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3767wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3768wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3769wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3770wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3771wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3772wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3773wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3774wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
db67f999
RD
3775wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
3776wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
d55e5bfc
RD
3777wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3778wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3779wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3780wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3781wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3782wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3783wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3784wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3785wxEVT_SIZE = _core_.wxEVT_SIZE
3786wxEVT_MOVE = _core_.wxEVT_MOVE
3787wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3788wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3789wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3790wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3791wxEVT_POWER = _core_.wxEVT_POWER
3792wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3793wxEVT_CREATE = _core_.wxEVT_CREATE
3794wxEVT_DESTROY = _core_.wxEVT_DESTROY
3795wxEVT_SHOW = _core_.wxEVT_SHOW
3796wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3797wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3798wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3799wxEVT_PAINT = _core_.wxEVT_PAINT
3800wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3801wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3802wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3803wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3804wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3805wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3806wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3807wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3808wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3809wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3810wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3811wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3812wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3813wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3814wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3815wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3816wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3817wxEVT_IDLE = _core_.wxEVT_IDLE
3818wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3819wxEVT_SIZING = _core_.wxEVT_SIZING
3820wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3821wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
d55e5bfc
RD
3822wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3823wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3824wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3825wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3826wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3827wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3828wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3829#
3830# Create some event binders
3831EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3832EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3833EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3834EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3835EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3836EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3837EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3838EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3839EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3840EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3841EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3842EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3843EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3844EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3845EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3846EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3847EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3848EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3849EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3850EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3851EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3852EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3853EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3854EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
88c6b281 3855EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD
3856EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3857EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3858EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3859EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3860EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3861EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3862EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3863EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3864EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3865EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3866EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3867EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3868EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3869EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3870EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3871EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3872
3873EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3874EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3875EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3876EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3877EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3878EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3879EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3880EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3881EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3882EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3883EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3884EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3885EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3886
3887EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3888 wxEVT_LEFT_UP,
3889 wxEVT_MIDDLE_DOWN,
3890 wxEVT_MIDDLE_UP,
3891 wxEVT_RIGHT_DOWN,
3892 wxEVT_RIGHT_UP,
3893 wxEVT_MOTION,
3894 wxEVT_LEFT_DCLICK,
3895 wxEVT_MIDDLE_DCLICK,
3896 wxEVT_RIGHT_DCLICK,
3897 wxEVT_ENTER_WINDOW,
3898 wxEVT_LEAVE_WINDOW,
3899 wxEVT_MOUSEWHEEL
3900 ])
3901
3902
3903# Scrolling from wxWindow (sent to wxScrolledWindow)
3904EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3905 wxEVT_SCROLLWIN_BOTTOM,
3906 wxEVT_SCROLLWIN_LINEUP,
3907 wxEVT_SCROLLWIN_LINEDOWN,
3908 wxEVT_SCROLLWIN_PAGEUP,
3909 wxEVT_SCROLLWIN_PAGEDOWN,
3910 wxEVT_SCROLLWIN_THUMBTRACK,
3911 wxEVT_SCROLLWIN_THUMBRELEASE,
3912 ])
3913
3914EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3915EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3916EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3917EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3918EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3919EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3920EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3921EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3922
27fb7603 3923# Scrolling from wx.Slider and wx.ScrollBar
d55e5bfc
RD
3924EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3925 wxEVT_SCROLL_BOTTOM,
3926 wxEVT_SCROLL_LINEUP,
3927 wxEVT_SCROLL_LINEDOWN,
3928 wxEVT_SCROLL_PAGEUP,
3929 wxEVT_SCROLL_PAGEDOWN,
3930 wxEVT_SCROLL_THUMBTRACK,
3931 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3932 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD
3933 ])
3934
3935EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3936EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3937EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3938EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3939EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3940EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3941EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3942EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
db67f999
RD
3943EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
3944EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
3945
27fb7603 3946# Scrolling from wx.Slider and wx.ScrollBar, with an id
d55e5bfc
RD
3947EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3948 wxEVT_SCROLL_BOTTOM,
3949 wxEVT_SCROLL_LINEUP,
3950 wxEVT_SCROLL_LINEDOWN,
3951 wxEVT_SCROLL_PAGEUP,
3952 wxEVT_SCROLL_PAGEDOWN,
3953 wxEVT_SCROLL_THUMBTRACK,
3954 wxEVT_SCROLL_THUMBRELEASE,
db67f999 3955 wxEVT_SCROLL_CHANGED,
d55e5bfc
RD
3956 ], 1)
3957
3958EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3959EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3960EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3961EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3962EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3963EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3964EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3965EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
db67f999
RD
3966EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
3967EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
d55e5bfc
RD
3968
3969EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3970EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3971EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3972EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3973EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3974EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3975EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3976EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3977EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3978EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3979
3980EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3981EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3982EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3983EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3984EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3985EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3986EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3987EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3988EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3989
3990
3991EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3992EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3993EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3994EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3995EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3996EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3997EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3998
3999EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
4000
4001EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
4002EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
4003
4004EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
4005
4006
4007
4008#---------------------------------------------------------------------------
4009
4010class Event(Object):
27fb7603
RD
4011 """
4012 An event is a structure holding information about an event passed to a
4013 callback or member function. wx.Event is an abstract base class for
4014 other event classes
4015 """
d55e5bfc
RD
4016 def __init__(self): raise RuntimeError, "No constructor defined"
4017 def __repr__(self):
4018 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4019 def __del__(self, destroy=_core_.delete_Event):
4020 """__del__(self)"""
4021 try:
4022 if self.thisown: destroy(self)
4023 except: pass
4024
4025 def SetEventType(*args, **kwargs):
27fb7603
RD
4026 """
4027 SetEventType(self, wxEventType typ)
4028
4029 Sets the specific type of the event.
4030 """
d55e5bfc
RD
4031 return _core_.Event_SetEventType(*args, **kwargs)
4032
4033 def GetEventType(*args, **kwargs):
27fb7603
RD
4034 """
4035 GetEventType(self) -> wxEventType
4036
4037 Returns the identifier of the given event type, such as
4038 ``wxEVT_COMMAND_BUTTON_CLICKED``.
4039 """
d55e5bfc
RD
4040 return _core_.Event_GetEventType(*args, **kwargs)
4041
4042 def GetEventObject(*args, **kwargs):
27fb7603
RD
4043 """
4044 GetEventObject(self) -> Object
4045
4046 Returns the object (usually a window) associated with the event, if
4047 any.
4048 """
d55e5bfc
RD
4049 return _core_.Event_GetEventObject(*args, **kwargs)
4050
4051 def SetEventObject(*args, **kwargs):
27fb7603
RD
4052 """
4053 SetEventObject(self, Object obj)
4054
4055 Sets the originating object, or in other words, obj is normally the
4056 object that is sending the event.
4057 """
d55e5bfc
RD
4058 return _core_.Event_SetEventObject(*args, **kwargs)
4059
4060 def GetTimestamp(*args, **kwargs):
4061 """GetTimestamp(self) -> long"""
4062 return _core_.Event_GetTimestamp(*args, **kwargs)
4063
4064 def SetTimestamp(*args, **kwargs):
4065 """SetTimestamp(self, long ts=0)"""
4066 return _core_.Event_SetTimestamp(*args, **kwargs)
4067
4068 def GetId(*args, **kwargs):
27fb7603
RD
4069 """
4070 GetId(self) -> int
4071
4072 Returns the identifier associated with this event, such as a button
4073 command id.
4074 """
d55e5bfc
RD
4075 return _core_.Event_GetId(*args, **kwargs)
4076
4077 def SetId(*args, **kwargs):
27fb7603
RD
4078 """
4079 SetId(self, int Id)
4080
4081 Set's the ID for the event. This is usually the ID of the window that
4082 is sending the event, but it can also be a command id from a menu
4083 item, etc.
4084 """
d55e5bfc
RD
4085 return _core_.Event_SetId(*args, **kwargs)
4086
4087 def IsCommandEvent(*args, **kwargs):
27fb7603
RD
4088 """
4089 IsCommandEvent(self) -> bool
4090
4091 Returns true if the event is or is derived from `wx.CommandEvent` else
4092 it returns false. Note: Exists only for optimization purposes.
4093 """
d55e5bfc
RD
4094 return _core_.Event_IsCommandEvent(*args, **kwargs)
4095
4096 def Skip(*args, **kwargs):
51b83b37
RD
4097 """
4098 Skip(self, bool skip=True)
4099
4100 Called by an event handler, it controls whether additional event
4101 handlers bound to this event will be called after the current event
4102 handler returns. Skip(false) (the default setting) will prevent
4103 additional event handlers from being called and control will be
4104 returned to the sender of the event immediately after the current
4105 handler has finished. Skip(True) will cause the event processing
4106 system to continue searching for a handler function for this event.
4107
4108 """
d55e5bfc
RD
4109 return _core_.Event_Skip(*args, **kwargs)
4110
4111 def GetSkipped(*args, **kwargs):
27fb7603
RD
4112 """
4113 GetSkipped(self) -> bool
4114
4115 Returns true if the event handler should be skipped, false otherwise.
4116 :see: `Skip`
4117 """
d55e5bfc
RD
4118 return _core_.Event_GetSkipped(*args, **kwargs)
4119
4120 def ShouldPropagate(*args, **kwargs):
27fb7603
RD
4121 """
4122 ShouldPropagate(self) -> bool
4123
4124 Test if this event should be propagated to the parent window or not,
4125 i.e. if the propagation level is currently greater than 0.
4126 """
d55e5bfc
RD
4127 return _core_.Event_ShouldPropagate(*args, **kwargs)
4128
4129 def StopPropagation(*args, **kwargs):
27fb7603
RD
4130 """
4131 StopPropagation(self) -> int
4132
4133 Stop the event from propagating to its parent window. Returns the old
4134 propagation level value which may be later passed to
4135 `ResumePropagation` to allow propagating the event again.
4136 """
d55e5bfc
RD
4137 return _core_.Event_StopPropagation(*args, **kwargs)
4138
4139 def ResumePropagation(*args, **kwargs):
27fb7603
RD
4140 """
4141 ResumePropagation(self, int propagationLevel)
4142
4143 Resume the event propagation by restoring the propagation level. (For
4144 example, you can use the value returned by an earlier call to
4145 `StopPropagation`.)
4146
4147 """
d55e5bfc
RD
4148 return _core_.Event_ResumePropagation(*args, **kwargs)
4149
4150 def Clone(*args, **kwargs):
4151 """Clone(self) -> Event"""
4152 return _core_.Event_Clone(*args, **kwargs)
4153
4154
4155class EventPtr(Event):
4156 def __init__(self, this):
4157 self.this = this
4158 if not hasattr(self,"thisown"): self.thisown = 0
4159 self.__class__ = Event
4160_core_.Event_swigregister(EventPtr)
4161
4162#---------------------------------------------------------------------------
4163
4164class PropagationDisabler(object):
27fb7603
RD
4165 """
4166 Helper class to temporarily change an event not to propagate. Simply
4167 create an instance of this class and then whe it is destroyed the
4168 propogation of the event will be restored.
4169 """
d55e5bfc
RD
4170 def __repr__(self):
4171 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4172 def __init__(self, *args, **kwargs):
27fb7603
RD
4173 """
4174 __init__(self, Event event) -> PropagationDisabler
4175
4176 Helper class to temporarily change an event not to propagate. Simply
4177 create an instance of this class and then whe it is destroyed the
4178 propogation of the event will be restored.
4179 """
d55e5bfc
RD
4180 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
4181 self.this = newobj.this
4182 self.thisown = 1
4183 del newobj.thisown
4184 def __del__(self, destroy=_core_.delete_PropagationDisabler):
4185 """__del__(self)"""
4186 try:
4187 if self.thisown: destroy(self)
4188 except: pass
4189
4190
4191class PropagationDisablerPtr(PropagationDisabler):
4192 def __init__(self, this):
4193 self.this = this
4194 if not hasattr(self,"thisown"): self.thisown = 0
4195 self.__class__ = PropagationDisabler
4196_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
4197
4198class PropagateOnce(object):
27fb7603
RD
4199 """
4200 A helper class that will temporarily lower propagation level of an
4201 event. Simply create an instance of this class and then whe it is
4202 destroyed the propogation of the event will be restored.
4203 """
d55e5bfc
RD
4204 def __repr__(self):
4205 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4206 def __init__(self, *args, **kwargs):
27fb7603
RD
4207 """
4208 __init__(self, Event event) -> PropagateOnce
4209
4210 A helper class that will temporarily lower propagation level of an
4211 event. Simply create an instance of this class and then whe it is
4212 destroyed the propogation of the event will be restored.
4213 """
d55e5bfc
RD
4214 newobj = _core_.new_PropagateOnce(*args, **kwargs)
4215 self.this = newobj.this
4216 self.thisown = 1
4217 del newobj.thisown
4218 def __del__(self, destroy=_core_.delete_PropagateOnce):
4219 """__del__(self)"""
4220 try:
4221 if self.thisown: destroy(self)
4222 except: pass
4223
4224
4225class PropagateOncePtr(PropagateOnce):
4226 def __init__(self, this):
4227 self.this = this
4228 if not hasattr(self,"thisown"): self.thisown = 0
4229 self.__class__ = PropagateOnce
4230_core_.PropagateOnce_swigregister(PropagateOncePtr)
4231
4232#---------------------------------------------------------------------------
4233
4234class CommandEvent(Event):
27fb7603
RD
4235 """
4236 This event class contains information about command events, which
4237 originate from a variety of simple controls, as well as menus and
4238 toolbars.
4239 """
d55e5bfc
RD
4240 def __repr__(self):
4241 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4242 def __init__(self, *args, **kwargs):
27fb7603
RD
4243 """
4244 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
4245
4246 This event class contains information about command events, which
4247 originate from a variety of simple controls, as well as menus and
4248 toolbars.
4249 """
d55e5bfc
RD
4250 newobj = _core_.new_CommandEvent(*args, **kwargs)
4251 self.this = newobj.this
4252 self.thisown = 1
4253 del newobj.thisown
4254 def GetSelection(*args, **kwargs):
27fb7603
RD
4255 """
4256 GetSelection(self) -> int
4257
4258 Returns item index for a listbox or choice selection event (not valid
4259 for a deselection).
4260 """
d55e5bfc
RD
4261 return _core_.CommandEvent_GetSelection(*args, **kwargs)
4262
4263 def SetString(*args, **kwargs):
4264 """SetString(self, String s)"""
4265 return _core_.CommandEvent_SetString(*args, **kwargs)
4266
4267 def GetString(*args, **kwargs):
27fb7603
RD
4268 """
4269 GetString(self) -> String
4270
4271 Returns item string for a listbox or choice selection event (not valid
4272 for a deselection).
4273 """
d55e5bfc
RD
4274 return _core_.CommandEvent_GetString(*args, **kwargs)
4275
4276 def IsChecked(*args, **kwargs):
27fb7603
RD
4277 """
4278 IsChecked(self) -> bool
4279
4280 This method can be used with checkbox and menu events: for the
4281 checkboxes, the method returns true for a selection event and false
4282 for a deselection one. For the menu events, this method indicates if
4283 the menu item just has become checked or unchecked (and thus only
4284 makes sense for checkable menu items).
4285 """
d55e5bfc
RD
4286 return _core_.CommandEvent_IsChecked(*args, **kwargs)
4287
4288 Checked = IsChecked
4289 def IsSelection(*args, **kwargs):
27fb7603
RD
4290 """
4291 IsSelection(self) -> bool
4292
4293 For a listbox or similar event, returns true if it is a selection,
4294 false if it is a deselection.
4295 """
d55e5bfc
RD
4296 return _core_.CommandEvent_IsSelection(*args, **kwargs)
4297
4298 def SetExtraLong(*args, **kwargs):
4299 """SetExtraLong(self, long extraLong)"""
4300 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
4301
4302 def GetExtraLong(*args, **kwargs):
27fb7603
RD
4303 """
4304 GetExtraLong(self) -> long
4305
5ba5649b
RD
4306 Returns extra information dependant on the event objects type. If the
4307 event comes from a listbox selection, it is a boolean determining
4308 whether the event was a selection (true) or a deselection (false). A
4309 listbox deselection only occurs for multiple-selection boxes, and in
4310 this case the index and string values are indeterminate and the
4311 listbox must be examined by the application.
27fb7603 4312 """
d55e5bfc
RD
4313 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
4314
4315 def SetInt(*args, **kwargs):
4316 """SetInt(self, int i)"""
4317 return _core_.CommandEvent_SetInt(*args, **kwargs)
4318
4319 def GetInt(*args, **kwargs):
27fb7603
RD
4320 """
4321 GetInt(self) -> long
4322
5ba5649b
RD
4323 Returns the integer identifier corresponding to a listbox, choice or
4324 radiobox selection (only if the event was a selection, not a
4325 deselection), or a boolean value representing the value of a checkbox.
27fb7603 4326 """
d55e5bfc
RD
4327 return _core_.CommandEvent_GetInt(*args, **kwargs)
4328
4329 def Clone(*args, **kwargs):
4330 """Clone(self) -> Event"""
4331 return _core_.CommandEvent_Clone(*args, **kwargs)
4332
4333
4334class CommandEventPtr(CommandEvent):
4335 def __init__(self, this):
4336 self.this = this
4337 if not hasattr(self,"thisown"): self.thisown = 0
4338 self.__class__ = CommandEvent
4339_core_.CommandEvent_swigregister(CommandEventPtr)
4340
4341#---------------------------------------------------------------------------
4342
4343class NotifyEvent(CommandEvent):
27fb7603
RD
4344 """
4345 An instance of this class (or one of its derived classes) is sent from
4346 a control when the control's state is being changed and the control
4347 allows that change to be prevented from happening. The event handler
4348 can call `Veto` or `Allow` to tell the control what to do.
4349 """
d55e5bfc
RD
4350 def __repr__(self):
4351 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4352 def __init__(self, *args, **kwargs):
27fb7603
RD
4353 """
4354 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
4355
4356 An instance of this class (or one of its derived classes) is sent from
4357 a control when the control's state is being changed and the control
4358 allows that change to be prevented from happening. The event handler
4359 can call `Veto` or `Allow` to tell the control what to do.
4360 """
d55e5bfc
RD
4361 newobj = _core_.new_NotifyEvent(*args, **kwargs)
4362 self.this = newobj.this
4363 self.thisown = 1
4364 del newobj.thisown
4365 def Veto(*args, **kwargs):
27fb7603
RD
4366 """
4367 Veto(self)
4368
4369 Prevents the change announced by this event from happening.
4370
4371 It is in general a good idea to notify the user about the reasons for
4372 vetoing the change because otherwise the applications behaviour (which
4373 just refuses to do what the user wants) might be quite surprising.
4374 """
d55e5bfc
RD
4375 return _core_.NotifyEvent_Veto(*args, **kwargs)
4376
4377 def Allow(*args, **kwargs):
27fb7603
RD
4378 """
4379 Allow(self)
4380
4381 This is the opposite of `Veto`: it explicitly allows the event to be
4382 processed. For most events it is not necessary to call this method as
4383 the events are allowed anyhow but some are forbidden by default (this
4384 will be mentioned in the corresponding event description).
4385 """
d55e5bfc
RD
4386 return _core_.NotifyEvent_Allow(*args, **kwargs)
4387
4388 def IsAllowed(*args, **kwargs):
27fb7603
RD
4389 """
4390 IsAllowed(self) -> bool
4391
4392 Returns true if the change is allowed (`Veto` hasn't been called) or
4393 false otherwise (if it was).
4394 """
d55e5bfc
RD
4395 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
4396
4397
4398class NotifyEventPtr(NotifyEvent):
4399 def __init__(self, this):
4400 self.this = this
4401 if not hasattr(self,"thisown"): self.thisown = 0
4402 self.__class__ = NotifyEvent
4403_core_.NotifyEvent_swigregister(NotifyEventPtr)
4404
4405#---------------------------------------------------------------------------
4406
4407class ScrollEvent(CommandEvent):
27fb7603
RD
4408 """
4409 A scroll event holds information about events sent from stand-alone
4410 scrollbars and sliders. Note that scrolled windows do not send
4411 instnaces of this event class, but send the `wx.ScrollWinEvent`
4412 instead.
4413 """
d55e5bfc
RD
4414 def __repr__(self):
4415 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4416 def __init__(self, *args, **kwargs):
4417 """
4418 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
4419 int orient=0) -> ScrollEvent
4420 """
4421 newobj = _core_.new_ScrollEvent(*args, **kwargs)
4422 self.this = newobj.this
4423 self.thisown = 1
4424 del newobj.thisown
4425 def GetOrientation(*args, **kwargs):
27fb7603
RD
4426 """
4427 GetOrientation(self) -> int
4428
4429 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4430 the scrollbar.
4431 """
d55e5bfc
RD
4432 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
4433
4434 def GetPosition(*args, **kwargs):
27fb7603
RD
4435 """
4436 GetPosition(self) -> int
4437
4438 Returns the position of the scrollbar.
4439 """
d55e5bfc
RD
4440 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
4441
4442 def SetOrientation(*args, **kwargs):
4443 """SetOrientation(self, int orient)"""
4444 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
4445
4446 def SetPosition(*args, **kwargs):
4447 """SetPosition(self, int pos)"""
4448 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
4449
4450
4451class ScrollEventPtr(ScrollEvent):
4452 def __init__(self, this):
4453 self.this = this
4454 if not hasattr(self,"thisown"): self.thisown = 0
4455 self.__class__ = ScrollEvent
4456_core_.ScrollEvent_swigregister(ScrollEventPtr)
4457
4458#---------------------------------------------------------------------------
4459
4460class ScrollWinEvent(Event):
27fb7603
RD
4461 """
4462 A wx.ScrollWinEvent holds information about scrolling and is sent from
4463 scrolling windows.
4464 """
d55e5bfc
RD
4465 def __repr__(self):
4466 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4467 def __init__(self, *args, **kwargs):
27fb7603
RD
4468 """
4469 __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
4470
4471 A wx.ScrollWinEvent holds information about scrolling and is sent from
4472 scrolling windows.
4473 """
d55e5bfc
RD
4474 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
4475 self.this = newobj.this
4476 self.thisown = 1
4477 del newobj.thisown
4478 def GetOrientation(*args, **kwargs):
27fb7603
RD
4479 """
4480 GetOrientation(self) -> int
4481
4482 Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
4483 the scrollbar.
4484 """
d55e5bfc
RD
4485 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
4486
4487 def GetPosition(*args, **kwargs):
27fb7603
RD
4488 """
4489 GetPosition(self) -> int
4490
4491 Returns the position of the scrollbar for the thumb track and release
4492 events. Note that this field can't be used for the other events, you
4493 need to query the window itself for the current position in that case.
4494 """
d55e5bfc
RD
4495 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
4496
4497 def SetOrientation(*args, **kwargs):
4498 """SetOrientation(self, int orient)"""
4499 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
4500
4501 def SetPosition(*args, **kwargs):
4502 """SetPosition(self, int pos)"""
4503 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
4504
4505
4506class ScrollWinEventPtr(ScrollWinEvent):
4507 def __init__(self, this):
4508 self.this = this
4509 if not hasattr(self,"thisown"): self.thisown = 0
4510 self.__class__ = ScrollWinEvent
4511_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
4512
4513#---------------------------------------------------------------------------
4514
4515MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
4516MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
4517MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
4518MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
4519MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
4520class MouseEvent(Event):
27fb7603
RD
4521 """
4522 This event class contains information about the events generated by
4523 the mouse: they include mouse buttons press and release events and
4524 mouse move events.
4525
4526 All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
4527 the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
4528 ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
4529 a middle button so a portable application should avoid relying on the
4530 events from it.
4531
4532 Note the difference between methods like `LeftDown` and `LeftIsDown`:
4533 the former returns true when the event corresponds to the left mouse
4534 button click while the latter returns true if the left mouse button is
4535 currently being pressed. For example, when the user is dragging the
4536 mouse you can use `LeftIsDown` to test whether the left mouse button
4537 is (still) depressed. Also, by convention, if `LeftDown` returns true,
4538 `LeftIsDown` will also return true in wxWidgets whatever the
4539 underlying GUI behaviour is (which is platform-dependent). The same
4540 applies, of course, to other mouse buttons as well.
4541 """
d55e5bfc
RD
4542 def __repr__(self):
4543 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4544 def __init__(self, *args, **kwargs):
27fb7603
RD
4545 """
4546 __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent
4547
4548 Constructs a wx.MouseEvent. Valid event types are:
4549
4550 * wxEVT_ENTER_WINDOW
4551 * wxEVT_LEAVE_WINDOW
4552 * wxEVT_LEFT_DOWN
4553 * wxEVT_LEFT_UP
4554 * wxEVT_LEFT_DCLICK
4555 * wxEVT_MIDDLE_DOWN
4556 * wxEVT_MIDDLE_UP
4557 * wxEVT_MIDDLE_DCLICK
4558 * wxEVT_RIGHT_DOWN
4559 * wxEVT_RIGHT_UP
4560 * wxEVT_RIGHT_DCLICK
4561 * wxEVT_MOTION
4562 * wxEVT_MOUSEWHEEL
4563 """
d55e5bfc
RD
4564 newobj = _core_.new_MouseEvent(*args, **kwargs)
4565 self.this = newobj.this
4566 self.thisown = 1
4567 del newobj.thisown
4568 def IsButton(*args, **kwargs):
27fb7603
RD
4569 """
4570 IsButton(self) -> bool
4571
4572 Returns true if the event was a mouse button event (not necessarily a
4573 button down event - that may be tested using `ButtonDown`).
4574 """
d55e5bfc
RD
4575 return _core_.MouseEvent_IsButton(*args, **kwargs)
4576
4577 def ButtonDown(*args, **kwargs):
27fb7603
RD
4578 """
4579 ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
4580
5ba5649b
RD
4581 If the argument is omitted, this returns true if the event was any
4582 mouse button down event. Otherwise the argument specifies which
4583 button-down event shold be checked for (see `Button` for the possible
4584 values).
27fb7603 4585 """
d55e5bfc
RD
4586 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
4587
4588 def ButtonDClick(*args, **kwargs):
27fb7603
RD
4589 """
4590 ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
4591
4592 If the argument is omitted, this returns true if the event was any
4593 mouse double click event. Otherwise the argument specifies which
4594 double click event to check for (see `Button` for the possible
4595 values).
4596 """
d55e5bfc
RD
4597 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
4598
4599 def ButtonUp(*args, **kwargs):
27fb7603
RD
4600 """
4601 ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
4602
4603 If the argument is omitted, this returns true if the event was any
5ba5649b
RD
4604 mouse button up event. Otherwise the argument specifies which button
4605 up event to check for (see `Button` for the possible values).
27fb7603 4606 """
d55e5bfc
RD
4607 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
4608
4609 def Button(*args, **kwargs):
27fb7603
RD
4610 """
4611 Button(self, int button) -> bool
4612
4613 Returns true if the identified mouse button is changing state. Valid
4614 values of button are:
4615
4616 ==================== =====================================
4617 wx.MOUSE_BTN_LEFT check if left button was pressed
4618 wx.MOUSE_BTN_MIDDLE check if middle button was pressed
4619 wx.MOUSE_BTN_RIGHT check if right button was pressed
4620 wx.MOUSE_BTN_ANY check if any button was pressed
4621 ==================== =====================================
4622
4623 """
d55e5bfc
RD
4624 return _core_.MouseEvent_Button(*args, **kwargs)
4625
4626 def ButtonIsDown(*args, **kwargs):
4627 """ButtonIsDown(self, int but) -> bool"""
4628 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
4629
4630 def GetButton(*args, **kwargs):
27fb7603
RD
4631 """
4632 GetButton(self) -> int
4633
4634 Returns the mouse button which generated this event or
4635 wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
4636 leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
4637 the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
4638 and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
4639 right buttons respectively.
4640 """
d55e5bfc
RD
4641 return _core_.MouseEvent_GetButton(*args, **kwargs)
4642
4643 def ControlDown(*args, **kwargs):
27fb7603
RD
4644 """
4645 ControlDown(self) -> bool
4646
4647 Returns true if the control key was down at the time of the event.
4648 """
d55e5bfc
RD
4649 return _core_.MouseEvent_ControlDown(*args, **kwargs)
4650
4651 def MetaDown(*args, **kwargs):
27fb7603
RD
4652 """
4653 MetaDown(self) -> bool
4654
4655 Returns true if the Meta key was down at the time of the event.
4656 """
d55e5bfc
RD
4657 return _core_.MouseEvent_MetaDown(*args, **kwargs)
4658
4659 def AltDown(*args, **kwargs):
27fb7603
RD
4660 """
4661 AltDown(self) -> bool
4662
4663 Returns true if the Alt key was down at the time of the event.
4664 """
d55e5bfc
RD
4665 return _core_.MouseEvent_AltDown(*args, **kwargs)
4666
4667 def ShiftDown(*args, **kwargs):
27fb7603
RD
4668 """
4669 ShiftDown(self) -> bool
4670
4671 Returns true if the Shift key was down at the time of the event.
4672 """
d55e5bfc
RD
4673 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
4674
412d302d
RD
4675 def CmdDown(*args, **kwargs):
4676 """
4677 CmdDown(self) -> bool
4678
4679 "Cmd" is a pseudo key which is the same as Control for PC and Unix
4680 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 4681 Macs. It often makes sense to use it instead of, say, `ControlDown`
412d302d 4682 because Cmd key is used for the same thing under Mac as Ctrl
27fb7603 4683 elsewhere. The Ctrl key still exists, it's just not used for this
412d302d
RD
4684 purpose. So for non-Mac platforms this is the same as `ControlDown`
4685 and Macs this is the same as `MetaDown`.
4686 """
4687 return _core_.MouseEvent_CmdDown(*args, **kwargs)
4688
d55e5bfc 4689 def LeftDown(*args, **kwargs):
27fb7603
RD
4690 """
4691 LeftDown(self) -> bool
4692
4693 Returns true if the left mouse button state changed to down.
4694 """
d55e5bfc
RD
4695 return _core_.MouseEvent_LeftDown(*args, **kwargs)
4696
4697 def MiddleDown(*args, **kwargs):
27fb7603
RD
4698 """
4699 MiddleDown(self) -> bool
4700
4701 Returns true if the middle mouse button state changed to down.
4702 """
d55e5bfc
RD
4703 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
4704
4705 def RightDown(*args, **kwargs):
27fb7603
RD
4706 """
4707 RightDown(self) -> bool
4708
4709 Returns true if the right mouse button state changed to down.
4710 """
d55e5bfc
RD
4711 return _core_.MouseEvent_RightDown(*args, **kwargs)
4712
4713 def LeftUp(*args, **kwargs):
27fb7603
RD
4714 """
4715 LeftUp(self) -> bool
4716
4717 Returns true if the left mouse button state changed to up.
4718 """
d55e5bfc
RD
4719 return _core_.MouseEvent_LeftUp(*args, **kwargs)
4720
4721 def MiddleUp(*args, **kwargs):
27fb7603
RD
4722 """
4723 MiddleUp(self) -> bool
4724
4725 Returns true if the middle mouse button state changed to up.
4726 """
d55e5bfc
RD
4727 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
4728
4729 def RightUp(*args, **kwargs):
27fb7603
RD
4730 """
4731 RightUp(self) -> bool
4732
4733 Returns true if the right mouse button state changed to up.
4734 """
d55e5bfc
RD
4735 return _core_.MouseEvent_RightUp(*args, **kwargs)
4736
4737 def LeftDClick(*args, **kwargs):
27fb7603
RD
4738 """
4739 LeftDClick(self) -> bool
4740
4741 Returns true if the event was a left button double click.
4742 """
d55e5bfc
RD
4743 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
4744
4745 def MiddleDClick(*args, **kwargs):
27fb7603
RD
4746 """
4747 MiddleDClick(self) -> bool
4748
4749 Returns true if the event was a middle button double click.
4750 """
d55e5bfc
RD
4751 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
4752
4753 def RightDClick(*args, **kwargs):
27fb7603
RD
4754 """
4755 RightDClick(self) -> bool
4756
4757 Returns true if the event was a right button double click.
4758 """
d55e5bfc
RD
4759 return _core_.MouseEvent_RightDClick(*args, **kwargs)
4760
4761 def LeftIsDown(*args, **kwargs):
27fb7603
RD
4762 """
4763 LeftIsDown(self) -> bool
4764
4765 Returns true if the left mouse button is currently down, independent
4766 of the current event type.
4767
4768 Please notice that it is not the same as LeftDown which returns true
4769 if the left mouse button was just pressed. Rather, it describes the
4770 state of the mouse button before the event happened.
4771
4772 This event is usually used in the mouse event handlers which process
4773 "move mouse" messages to determine whether the user is (still)
4774 dragging the mouse.
4775 """
d55e5bfc
RD
4776 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
4777
4778 def MiddleIsDown(*args, **kwargs):
27fb7603
RD
4779 """
4780 MiddleIsDown(self) -> bool
4781
4782 Returns true if the middle mouse button is currently down, independent
4783 of the current event type.
4784 """
d55e5bfc
RD
4785 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
4786
4787 def RightIsDown(*args, **kwargs):
27fb7603
RD
4788 """
4789 RightIsDown(self) -> bool
4790
4791 Returns true if the right mouse button is currently down, independent
4792 of the current event type.
4793 """
d55e5bfc
RD
4794 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
4795
4796 def Dragging(*args, **kwargs):
27fb7603
RD
4797 """
4798 Dragging(self) -> bool
4799
4800 Returns true if this was a dragging event (motion while a button is
4801 depressed).
4802 """
d55e5bfc
RD
4803 return _core_.MouseEvent_Dragging(*args, **kwargs)
4804
4805 def Moving(*args, **kwargs):
27fb7603
RD
4806 """
4807 Moving(self) -> bool
4808
4809 Returns true if this was a motion event and no mouse buttons were
4810 pressed. If any mouse button is held pressed, then this method returns
4811 false and Dragging returns true.
4812 """
d55e5bfc
RD
4813 return _core_.MouseEvent_Moving(*args, **kwargs)
4814
4815 def Entering(*args, **kwargs):
27fb7603
RD
4816 """
4817 Entering(self) -> bool
4818
4819 Returns true if the mouse was entering the window.
4820 """
d55e5bfc
RD
4821 return _core_.MouseEvent_Entering(*args, **kwargs)
4822
4823 def Leaving(*args, **kwargs):
27fb7603
RD
4824 """
4825 Leaving(self) -> bool
4826
4827 Returns true if the mouse was leaving the window.
4828 """
d55e5bfc
RD
4829 return _core_.MouseEvent_Leaving(*args, **kwargs)
4830
4831 def GetPosition(*args, **kwargs):
4832 """
4833 GetPosition(self) -> Point
4834
27fb7603
RD
4835 Returns the pixel position of the mouse in window coordinates when the
4836 event happened.
d55e5bfc
RD
4837 """
4838 return _core_.MouseEvent_GetPosition(*args, **kwargs)
4839
4840 def GetPositionTuple(*args, **kwargs):
4841 """
4842 GetPositionTuple() -> (x,y)
4843
27fb7603
RD
4844 Returns the pixel position of the mouse in window coordinates when the
4845 event happened.
d55e5bfc
RD
4846 """
4847 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
4848
4849 def GetLogicalPosition(*args, **kwargs):
27fb7603
RD
4850 """
4851 GetLogicalPosition(self, DC dc) -> Point
4852
4853 Returns the logical mouse position in pixels (i.e. translated
4854 according to the translation set for the DC, which usually indicates
4855 that the window has been scrolled).
4856 """
d55e5bfc
RD
4857 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
4858
4859 def GetX(*args, **kwargs):
27fb7603
RD
4860 """
4861 GetX(self) -> int
4862
4863 Returns X coordinate of the physical mouse event position.
4864 """
d55e5bfc
RD
4865 return _core_.MouseEvent_GetX(*args, **kwargs)
4866
4867 def GetY(*args, **kwargs):
27fb7603
RD
4868 """
4869 GetY(self) -> int
4870
4871 Returns Y coordinate of the physical mouse event position.
4872 """
d55e5bfc
RD
4873 return _core_.MouseEvent_GetY(*args, **kwargs)
4874
4875 def GetWheelRotation(*args, **kwargs):
27fb7603
RD
4876 """
4877 GetWheelRotation(self) -> int
4878
4879 Get wheel rotation, positive or negative indicates direction of
4880 rotation. Current devices all send an event when rotation is equal to
4881 +/-WheelDelta, but this allows for finer resolution devices to be
4882 created in the future. Because of this you shouldn't assume that one
4883 event is equal to 1 line or whatever, but you should be able to either
4884 do partial line scrolling or wait until +/-WheelDelta rotation values
4885 have been accumulated before scrolling.
4886 """
d55e5bfc
RD
4887 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
4888
4889 def GetWheelDelta(*args, **kwargs):
27fb7603
RD
4890 """
4891 GetWheelDelta(self) -> int
4892
4893 Get wheel delta, normally 120. This is the threshold for action to be
4894 taken, and one such action (for example, scrolling one increment)
4895 should occur for each delta.
4896 """
d55e5bfc
RD
4897 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
4898
4899 def GetLinesPerAction(*args, **kwargs):
27fb7603
RD
4900 """
4901 GetLinesPerAction(self) -> int
4902
4903 Returns the configured number of lines (or whatever) to be scrolled
4904 per wheel action. Defaults to three.
4905 """
d55e5bfc
RD
4906 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
4907
4908 def IsPageScroll(*args, **kwargs):
27fb7603
RD
4909 """
4910 IsPageScroll(self) -> bool
4911
4912 Returns true if the system has been setup to do page scrolling with
4913 the mouse wheel instead of line scrolling.
4914 """
d55e5bfc
RD
4915 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
4916
4917 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
4918 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
4919 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
4920 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
4921 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
4922 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
4923 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
4924 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
4925 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
4926 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
4927 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
4928 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
4929
4930class MouseEventPtr(MouseEvent):
4931 def __init__(self, this):
4932 self.this = this
4933 if not hasattr(self,"thisown"): self.thisown = 0
4934 self.__class__ = MouseEvent
4935_core_.MouseEvent_swigregister(MouseEventPtr)
4936
4937#---------------------------------------------------------------------------
4938
4939class SetCursorEvent(Event):
5ba5649b
RD
4940 """
4941 A SetCursorEvent is generated when the mouse cursor is about to be set
4942 as a result of mouse motion. This event gives the application the
4943 chance to perform specific mouse cursor processing based on the
4944 current position of the mouse within the window. Use the `SetCursor`
4945 method to specify the cursor you want to be displayed.
4946 """
d55e5bfc
RD
4947 def __repr__(self):
4948 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4949 def __init__(self, *args, **kwargs):
5ba5649b
RD
4950 """
4951 __init__(self, int x=0, int y=0) -> SetCursorEvent
4952
4953 Construct a new `wx.SetCursorEvent`.
4954 """
d55e5bfc
RD
4955 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
4956 self.this = newobj.this
4957 self.thisown = 1
4958 del newobj.thisown
4959 def GetX(*args, **kwargs):
5ba5649b
RD
4960 """
4961 GetX(self) -> int
4962
4963 Returns the X coordinate of the mouse in client coordinates.
4964 """
d55e5bfc
RD
4965 return _core_.SetCursorEvent_GetX(*args, **kwargs)
4966
4967 def GetY(*args, **kwargs):
5ba5649b
RD
4968 """
4969 GetY(self) -> int
4970
4971 Returns the Y coordinate of the mouse in client coordinates.
4972 """
d55e5bfc
RD
4973 return _core_.SetCursorEvent_GetY(*args, **kwargs)
4974
4975 def SetCursor(*args, **kwargs):
5ba5649b
RD
4976 """
4977 SetCursor(self, Cursor cursor)
4978
4979 Sets the cursor associated with this event.
4980 """
d55e5bfc
RD
4981 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
4982
4983 def GetCursor(*args, **kwargs):
5ba5649b
RD
4984 """
4985 GetCursor(self) -> Cursor
4986
4987 Returns a reference to the cursor specified by this event.
4988 """
d55e5bfc
RD
4989 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
4990
4991 def HasCursor(*args, **kwargs):
5ba5649b
RD
4992 """
4993 HasCursor(self) -> bool
4994
4995 Returns true if the cursor specified by this event is a valid cursor.
4996 """
d55e5bfc
RD
4997 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
4998
4999
5000class SetCursorEventPtr(SetCursorEvent):
5001 def __init__(self, this):
5002 self.this = this
5003 if not hasattr(self,"thisown"): self.thisown = 0
5004 self.__class__ = SetCursorEvent
5005_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
5006
5007#---------------------------------------------------------------------------
5008
5009class KeyEvent(Event):
5ba5649b
RD
5010 """
5011 This event class contains information about keypress and character
5012 events. These events are only sent to the widget that currently has
5013 the keyboard focus.
5014
5015 Notice that there are three different kinds of keyboard events in
5016 wxWidgets: key down and up events and char events. The difference
5017 between the first two is clear - the first corresponds to a key press
5018 and the second to a key release - otherwise they are identical. Just
5019 note that if the key is maintained in a pressed state you will
5020 typically get a lot of (automatically generated) down events but only
5021 one up so it is wrong to assume that there is one up event
5022 corresponding to each down one.
5023
5024 Both key events provide untranslated key codes while the char event
5025 carries the translated one. The untranslated code for alphanumeric
5026 keys is always an upper case value. For the other keys it is one of
5027 WXK_XXX values from the keycodes table. The translated key is, in
5028 general, the character the user expects to appear as the result of the
5029 key combination when typing the text into a text entry zone, for
5030 example.
5031
5032 A few examples to clarify this (all assume that CAPS LOCK is unpressed
5033 and the standard US keyboard): when the 'A' key is pressed, the key
5034 down event key code is equal to ASCII A == 65. But the char event key
5035 code is ASCII a == 97. On the other hand, if you press both SHIFT and
5036 'A' keys simultaneously , the key code in key down event will still be
5037 just 'A' while the char event key code parameter will now be 'A' as
5038 well.
5039
5040 Although in this simple case it is clear that the correct key code
5041 could be found in the key down event handler by checking the value
5042 returned by `ShiftDown`, in general you should use EVT_CHAR for this
5043 as for non alphanumeric keys or non-US keyboard layouts the
5044 translation is keyboard-layout dependent and can only be done properly
5045 by the system itself.
5046
5047 Another kind of translation is done when the control key is pressed:
5048 for example, for CTRL-A key press the key down event still carries the
5049 same key code 'A' as usual but the char event will have key code of 1,
5050 the ASCII value of this key combination.
5051
5052 You may discover how the other keys on your system behave
5053 interactively by running the KeyEvents sample in the wxPython demo and
5054 pressing some keys while the blue box at the top has the keyboard
5055 focus.
5056
5057 **Note**: If a key down event is caught and the event handler does not
5058 call event.Skip() then the coresponding char event will not
5059 happen. This is by design and enables the programs that handle both
5060 types of events to be a bit simpler.
5061
5062 **Note for Windows programmers**: The key and char events in wxWidgets
5063 are similar to but slightly different from Windows WM_KEYDOWN and
5064 WM_CHAR events. In particular, Alt-x combination will generate a char
5065 event in wxWidgets (unless it is used as an accelerator).
5066
5067 **Tip**: be sure to call event.Skip() for events that you don't
5068 process in key event function, otherwise menu shortcuts may cease to
5069 work under Windows.
5070
5071 """
d55e5bfc
RD
5072 def __repr__(self):
5073 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5074 def __init__(self, *args, **kwargs):
5ba5649b
RD
5075 """
5076 __init__(self, wxEventType eventType=wxEVT_NULL) -> KeyEvent
5077
5078 Construct a new `wx.KeyEvent`. Valid event types are:
5079 *
5080 """
d55e5bfc
RD
5081 newobj = _core_.new_KeyEvent(*args, **kwargs)
5082 self.this = newobj.this
5083 self.thisown = 1
5084 del newobj.thisown
5085 def ControlDown(*args, **kwargs):
5ba5649b
RD
5086 """
5087 ControlDown(self) -> bool
5088
5089 Returns ``True`` if the Control key was down at the time of the event.
5090 """
d55e5bfc
RD
5091 return _core_.KeyEvent_ControlDown(*args, **kwargs)
5092
5093 def MetaDown(*args, **kwargs):
5ba5649b
RD
5094 """
5095 MetaDown(self) -> bool
5096
5097 Returns ``True`` if the Meta key was down at the time of the event.
5098 """
d55e5bfc
RD
5099 return _core_.KeyEvent_MetaDown(*args, **kwargs)
5100
5101 def AltDown(*args, **kwargs):
5ba5649b
RD
5102 """
5103 AltDown(self) -> bool
5104
5105 Returns ``True`` if the Alt key was down at the time of the event.
5106 """
d55e5bfc
RD
5107 return _core_.KeyEvent_AltDown(*args, **kwargs)
5108
5109 def ShiftDown(*args, **kwargs):
5ba5649b
RD
5110 """
5111 ShiftDown(self) -> bool
5112
5113 Returns ``True`` if the Shift key was down at the time of the event.
5114 """
d55e5bfc
RD
5115 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
5116
412d302d
RD
5117 def CmdDown(*args, **kwargs):
5118 """
5119 CmdDown(self) -> bool
5120
5121 "Cmd" is a pseudo key which is the same as Control for PC and Unix
5122 platforms but the special "Apple" (a.k.a as "Command") key on
5ba5649b 5123 Macs. It makes often sense to use it instead of, say, `ControlDown`
412d302d
RD
5124 because Cmd key is used for the same thing under Mac as Ctrl
5125 elsewhere. The Ctrl still exists, it's just not used for this
5126 purpose. So for non-Mac platforms this is the same as `ControlDown`
5127 and Macs this is the same as `MetaDown`.
5128 """
5129 return _core_.KeyEvent_CmdDown(*args, **kwargs)
5130
d55e5bfc 5131 def HasModifiers(*args, **kwargs):
5ba5649b
RD
5132 """
5133 HasModifiers(self) -> bool
5134
5135 Returns true if either CTRL or ALT keys was down at the time of the
5136 key event. Note that this function does not take into account neither
5137 SHIFT nor META key states (the reason for ignoring the latter is that
5138 it is common for NUMLOCK key to be configured as META under X but the
5139 key presses even while NUMLOCK is on should be still processed
5140 normally).
5141 """
d55e5bfc
RD
5142 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
5143
5144 def GetKeyCode(*args, **kwargs):
5ba5649b
RD
5145 """
5146 GetKeyCode(self) -> int
5147
5148 Returns the virtual key code. ASCII events return normal ASCII values,
5149 while non-ASCII events return values such as WXK_LEFT for the left
5150 cursor key. See `wx.KeyEvent` for a full list of the virtual key
5151 codes.
5152
5153 Note that in Unicode build, the returned value is meaningful only if
5154 the user entered a character that can be represented in current
5155 locale's default charset. You can obtain the corresponding Unicode
5156 character using `GetUnicodeKey`.
5157 """
d55e5bfc
RD
5158 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
5159
5160 KeyCode = GetKeyCode
19272049 5161 def GetUnicodeKey(*args, **kwargs):
5ba5649b
RD
5162 """
5163 GetUnicodeKey(self) -> int
5164
5165 Returns the Unicode character corresponding to this key event. This
5166 function is only meaningfule in a Unicode build of wxPython.
5167 """
19272049 5168 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 5169
19272049 5170 GetUniChar = GetUnicodeKey
d55e5bfc 5171 def GetRawKeyCode(*args, **kwargs):
5ba5649b
RD
5172 """
5173 GetRawKeyCode(self) -> unsigned int
5174
5175 Returns the raw key code for this event. This is a platform-dependent
5176 scan code which should only be used in advanced
5177 applications. Currently the raw key codes are not supported by all
5178 ports.
5179 """
d55e5bfc
RD
5180 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
5181
5182 def GetRawKeyFlags(*args, **kwargs):
5ba5649b
RD
5183 """
5184 GetRawKeyFlags(self) -> unsigned int
5185
5186 Returns the low level key flags for this event. The flags are
5187 platform-dependent and should only be used in advanced applications.
5188 Currently the raw key flags are not supported by all ports.
5189 """
d55e5bfc
RD
5190 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
5191
5192 def GetPosition(*args, **kwargs):
5193 """
5194 GetPosition(self) -> Point
5195
5ba5649b 5196 Find the position of the event, if applicable.
d55e5bfc
RD
5197 """
5198 return _core_.KeyEvent_GetPosition(*args, **kwargs)
5199
5200 def GetPositionTuple(*args, **kwargs):
5201 """
5202 GetPositionTuple() -> (x,y)
5203
5ba5649b 5204 Find the position of the event, if applicable.
d55e5bfc
RD
5205 """
5206 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
5207
5208 def GetX(*args, **kwargs):
5ba5649b
RD
5209 """
5210 GetX(self) -> int
5211
5212 Returns the X position (in client coordinates) of the event, if
5213 applicable.
5214 """
d55e5bfc
RD
5215 return _core_.KeyEvent_GetX(*args, **kwargs)
5216
5217 def GetY(*args, **kwargs):
5ba5649b
RD
5218 """
5219 GetY(self) -> int
5220
5221 Returns the Y position (in client coordinates) of the event, if
5222 applicable.
5223 """
d55e5bfc
RD
5224 return _core_.KeyEvent_GetY(*args, **kwargs)
5225
5226 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
5227 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
5228 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
5229 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
5230 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
5231 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
5232 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
5233 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
5234 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
5235 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
5236
5237class KeyEventPtr(KeyEvent):
5238 def __init__(self, this):
5239 self.this = this
5240 if not hasattr(self,"thisown"): self.thisown = 0
5241 self.__class__ = KeyEvent
5242_core_.KeyEvent_swigregister(KeyEventPtr)
5243
5244#---------------------------------------------------------------------------
5245
5246class SizeEvent(Event):
5ba5649b
RD
5247 """
5248 A size event holds information about size change events. The EVT_SIZE
5249 handler function will be called when the window it is bound to has
5250 been resized.
5251
5252 Note that the size passed is of the whole window: call
5253 `wx.Window.GetClientSize` for the area which may be used by the
5254 application.
5255
5256 When a window is resized, usually only a small part of the window is
5257 damaged and and that area is all that is in the update region for the
5258 next paint event. However, if your drawing depends on the size of the
5259 window, you may need to clear the DC explicitly and repaint the whole
5260 window. In which case, you may need to call `wx.Window.Refresh` to
5261 invalidate the entire window.
5262
5263 """
d55e5bfc
RD
5264 def __repr__(self):
5265 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5266 def __init__(self, *args, **kwargs):
5ba5649b
RD
5267 """
5268 __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
5269
5270 Construct a new ``wx.SizeEvent``.
5271 """
d55e5bfc
RD
5272 newobj = _core_.new_SizeEvent(*args, **kwargs)
5273 self.this = newobj.this
5274 self.thisown = 1
5275 del newobj.thisown
5276 def GetSize(*args, **kwargs):
5ba5649b
RD
5277 """
5278 GetSize(self) -> Size
5279
5280 Returns the entire size of the window generating the size change
5281 event.
5282 """
d55e5bfc
RD
5283 return _core_.SizeEvent_GetSize(*args, **kwargs)
5284
5285 def GetRect(*args, **kwargs):
5286 """GetRect(self) -> Rect"""
5287 return _core_.SizeEvent_GetRect(*args, **kwargs)
5288
5289 def SetRect(*args, **kwargs):
5290 """SetRect(self, Rect rect)"""
5291 return _core_.SizeEvent_SetRect(*args, **kwargs)
5292
5293 def SetSize(*args, **kwargs):
5294 """SetSize(self, Size size)"""
5295 return _core_.SizeEvent_SetSize(*args, **kwargs)
5296
5297 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
5298 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
5299
5300class SizeEventPtr(SizeEvent):
5301 def __init__(self, this):
5302 self.this = this
5303 if not hasattr(self,"thisown"): self.thisown = 0
5304 self.__class__ = SizeEvent
5305_core_.SizeEvent_swigregister(SizeEventPtr)
5306
5307#---------------------------------------------------------------------------
5308
5309class MoveEvent(Event):
5ba5649b
RD
5310 """
5311 This event object is sent for EVT_MOVE event bindings when a window is
5312 moved to a new position.
5313 """
d55e5bfc
RD
5314 def __repr__(self):
5315 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5316 def __init__(self, *args, **kwargs):
5ba5649b
RD
5317 """
5318 __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
5319
5320 Constructor.
5321 """
d55e5bfc
RD
5322 newobj = _core_.new_MoveEvent(*args, **kwargs)
5323 self.this = newobj.this
5324 self.thisown = 1
5325 del newobj.thisown
5326 def GetPosition(*args, **kwargs):
5ba5649b
RD
5327 """
5328 GetPosition(self) -> Point
5329
5330 Returns the position of the window generating the move change event.
5331 """
d55e5bfc
RD
5332 return _core_.MoveEvent_GetPosition(*args, **kwargs)
5333
5334 def GetRect(*args, **kwargs):
5335 """GetRect(self) -> Rect"""
5336 return _core_.MoveEvent_GetRect(*args, **kwargs)
5337
5338 def SetRect(*args, **kwargs):
5339 """SetRect(self, Rect rect)"""
5340 return _core_.MoveEvent_SetRect(*args, **kwargs)
5341
5342 def SetPosition(*args, **kwargs):
5343 """SetPosition(self, Point pos)"""
5344 return _core_.MoveEvent_SetPosition(*args, **kwargs)
5345
fef4c27a
RD
5346 m_pos = property(GetPosition, SetPosition)
5347 m_rect = property(GetRect, SetRect)
5348
d55e5bfc
RD
5349
5350class MoveEventPtr(MoveEvent):
5351 def __init__(self, this):
5352 self.this = this
5353 if not hasattr(self,"thisown"): self.thisown = 0
5354 self.__class__ = MoveEvent
5355_core_.MoveEvent_swigregister(MoveEventPtr)
5356
5357#---------------------------------------------------------------------------
5358
5359class PaintEvent(Event):
5ba5649b
RD
5360 """
5361 A paint event is sent when a window's contents needs to be repainted.
5362 Note that in an EVT_PAINT handler the application must *always* create
5363 a `wx.PaintDC` object, even if you do not use it. Otherwise MS
5364 Windows assumes that the window has not been painted yet and will send
5365 the event again, causing endless refreshes.
5366
5367 You can optimize painting by retrieving the rectangles that have been
5368 damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
5369 and only repainting these rectangles. The rectangles are in terms of
5370 the client area, and are unscrolled, so you will need to do some
5371 calculations using the current view position to obtain logical,
5372 scrolled units.
5373
5374 """
d55e5bfc
RD
5375 def __repr__(self):
5376 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5377 def __init__(self, *args, **kwargs):
5378 """__init__(self, int Id=0) -> PaintEvent"""
5379 newobj = _core_.new_PaintEvent(*args, **kwargs)
5380 self.this = newobj.this
5381 self.thisown = 1
5382 del newobj.thisown
5383
5384class PaintEventPtr(PaintEvent):
5385 def __init__(self, this):
5386 self.this = this
5387 if not hasattr(self,"thisown"): self.thisown = 0
5388 self.__class__ = PaintEvent
5389_core_.PaintEvent_swigregister(PaintEventPtr)
5390
5391class NcPaintEvent(Event):
093d3ff1 5392 """Proxy of C++ NcPaintEvent class"""
d55e5bfc
RD
5393 def __repr__(self):
5394 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5395 def __init__(self, *args, **kwargs):
5396 """__init__(self, int winid=0) -> NcPaintEvent"""
5397 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
5398 self.this = newobj.this
5399 self.thisown = 1
5400 del newobj.thisown
5401
5402class NcPaintEventPtr(NcPaintEvent):
5403 def __init__(self, this):
5404 self.this = this
5405 if not hasattr(self,"thisown"): self.thisown = 0
5406 self.__class__ = NcPaintEvent
5407_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
5408
5409#---------------------------------------------------------------------------
5410
5411class EraseEvent(Event):
5ba5649b
RD
5412 """
5413 An erase event is sent whenever the background of a window needs to be
5414 repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
5415 binder. On some platforms, such as GTK+, this event is simulated
5416 (simply generated just before the paint event) and may cause flicker.
5417
5418 To paint a custom background use the `GetDC` method and use the returned
5419 device context if it is not ``None``, otherwise create a temporary
5420 `wx.ClientDC` and draw on that.
5421
5422 """
d55e5bfc
RD
5423 def __repr__(self):
5424 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5425 def __init__(self, *args, **kwargs):
5ba5649b
RD
5426 """
5427 __init__(self, int Id=0, DC dc=None) -> EraseEvent
5428
5429 Constructor
5430 """
d55e5bfc
RD
5431 newobj = _core_.new_EraseEvent(*args, **kwargs)
5432 self.this = newobj.this
5433 self.thisown = 1
5434 del newobj.thisown
5435 def GetDC(*args, **kwargs):
5ba5649b
RD
5436 """
5437 GetDC(self) -> DC
5438
5439 Returns the device context the event handler should draw upon. If
5440 ``None`` is returned then create a temporary `wx.ClientDC` and use
5441 that instead.
5442 """
d55e5bfc
RD
5443 return _core_.EraseEvent_GetDC(*args, **kwargs)
5444
5445
5446class EraseEventPtr(EraseEvent):
5447 def __init__(self, this):
5448 self.this = this
5449 if not hasattr(self,"thisown"): self.thisown = 0
5450 self.__class__ = EraseEvent
5451_core_.EraseEvent_swigregister(EraseEventPtr)
5452
5453#---------------------------------------------------------------------------
5454
5455class FocusEvent(Event):
5ba5649b
RD
5456 """
5457 A focus event is sent when a window's focus changes. The window losing
5458 focus receives an EVT_KILL_FOCUS event while the window gaining it
5459 gets an EVT_SET_FOCUS event.
5460
5461 Notice that the set focus event happens both when the user gives focus
5462 to the window (whether using the mouse or keyboard) and when it is
5463 done from the program itself using `wx.Window.SetFocus`.
5464
5465 """
d55e5bfc
RD
5466 def __repr__(self):
5467 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5468 def __init__(self, *args, **kwargs):
5ba5649b
RD
5469 """
5470 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent
5471
5472 Constructor
5473 """
d55e5bfc
RD
5474 newobj = _core_.new_FocusEvent(*args, **kwargs)
5475 self.this = newobj.this
5476 self.thisown = 1
5477 del newobj.thisown
5478 def GetWindow(*args, **kwargs):
5ba5649b
RD
5479 """
5480 GetWindow(self) -> Window
5481
5482 Returns the other window associated with this event, that is the
5483 window which had the focus before for the EVT_SET_FOCUS event and the
5484 window which is going to receive focus for the wxEVT_KILL_FOCUS event.
5485
5486 Warning: the window returned may be None!
5487 """
d55e5bfc
RD
5488 return _core_.FocusEvent_GetWindow(*args, **kwargs)
5489
5490 def SetWindow(*args, **kwargs):
5491 """SetWindow(self, Window win)"""
5492 return _core_.FocusEvent_SetWindow(*args, **kwargs)
5493
5494
5495class FocusEventPtr(FocusEvent):
5496 def __init__(self, this):
5497 self.this = this
5498 if not hasattr(self,"thisown"): self.thisown = 0
5499 self.__class__ = FocusEvent
5500_core_.FocusEvent_swigregister(FocusEventPtr)
5501
5502#---------------------------------------------------------------------------
5503
5504class ChildFocusEvent(CommandEvent):
5ba5649b
RD
5505 """
5506 wx.ChildFocusEvent notifies the parent that a child has received the
5507 focus. Unlike `wx.FocusEvent` it is propagated up the window
5508 heirarchy.
5509 """
d55e5bfc
RD
5510 def __repr__(self):
5511 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5512 def __init__(self, *args, **kwargs):
5ba5649b
RD
5513 """
5514 __init__(self, Window win=None) -> ChildFocusEvent
5515
5516 Constructor
5517 """
d55e5bfc
RD
5518 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
5519 self.this = newobj.this
5520 self.thisown = 1
5521 del newobj.thisown
5522 def GetWindow(*args, **kwargs):
5ba5649b
RD
5523 """
5524 GetWindow(self) -> Window
5525
5526 The window which has just received the focus.
5527 """
d55e5bfc
RD
5528 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
5529
5530
5531class ChildFocusEventPtr(ChildFocusEvent):
5532 def __init__(self, this):
5533 self.this = this
5534 if not hasattr(self,"thisown"): self.thisown = 0
5535 self.__class__ = ChildFocusEvent
5536_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
5537
5538#---------------------------------------------------------------------------
5539
5540class ActivateEvent(Event):
5ba5649b
RD
5541 """
5542 An activate event is sent when a top-level window or the entire
5543 application is being activated or deactivated.
5544
5545 A top-level window (a dialog or frame) receives an activate event when
5546 is being activated or deactivated. This is indicated visually by the
5547 title bar changing colour, and a subwindow gaining the keyboard focus.
5548 An application is activated or deactivated when one of its frames
5549 becomes activated, or a frame becomes inactivate resulting in all
5550 application frames being inactive.
5551
5552 Please note that usually you should call event.Skip() in your handlers
5553 for these events so the default handlers will still be called, as not
5554 doing so can result in strange effects.
5555
5556 """
d55e5bfc
RD
5557 def __repr__(self):
5558 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5559 def __init__(self, *args, **kwargs):
5ba5649b
RD
5560 """
5561 __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
5562
5563 Constructor
5564 """
d55e5bfc
RD
5565 newobj = _core_.new_ActivateEvent(*args, **kwargs)
5566 self.this = newobj.this
5567 self.thisown = 1
5568 del newobj.thisown
5569 def GetActive(*args, **kwargs):
5ba5649b
RD
5570 """
5571 GetActive(self) -> bool
5572
5573 Returns true if the application or window is being activated, false
5574 otherwise.
5575 """
d55e5bfc
RD
5576 return _core_.ActivateEvent_GetActive(*args, **kwargs)
5577
5578
5579class ActivateEventPtr(ActivateEvent):
5580 def __init__(self, this):
5581 self.this = this
5582 if not hasattr(self,"thisown"): self.thisown = 0
5583 self.__class__ = ActivateEvent
5584_core_.ActivateEvent_swigregister(ActivateEventPtr)
5585
5586#---------------------------------------------------------------------------
5587
5588class InitDialogEvent(Event):
5ba5649b
RD
5589 """
5590 A wx.InitDialogEvent is sent as a dialog is being initialised, or for
5591 any window when `wx.Window.InitDialog` is called. Handlers for this
5592 event can transfer data to the window, or anything else that should be
5593 done before the user begins editing the form. The default handler
5594 calls `wx.Window.TransferDataToWindow`.
5595 """
d55e5bfc
RD
5596 def __repr__(self):
5597 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5598 def __init__(self, *args, **kwargs):
5ba5649b
RD
5599 """
5600 __init__(self, int Id=0) -> InitDialogEvent
5601
5602 Constructor
5603 """
d55e5bfc
RD
5604 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
5605 self.this = newobj.this
5606 self.thisown = 1
5607 del newobj.thisown
5608
5609class InitDialogEventPtr(InitDialogEvent):
5610 def __init__(self, this):
5611 self.this = this
5612 if not hasattr(self,"thisown"): self.thisown = 0
5613 self.__class__ = InitDialogEvent
5614_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
5615
5616#---------------------------------------------------------------------------
5617
5618class MenuEvent(Event):
5ba5649b
RD
5619 """
5620 This class is used for a variety of menu-related events. Note that
5621 these do not include menu command events, which are handled by sending
5622 `wx.CommandEvent` objects.
5623
5624 The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
5625 text in the first field of the status bar.
5626 """
d55e5bfc
RD
5627 def __repr__(self):
5628 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5629 def __init__(self, *args, **kwargs):
5ba5649b
RD
5630 """
5631 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
5632
5633 Constructor
5634 """
d55e5bfc
RD
5635 newobj = _core_.new_MenuEvent(*args, **kwargs)
5636 self.this = newobj.this
5637 self.thisown = 1
5638 del newobj.thisown
5639 def GetMenuId(*args, **kwargs):
5ba5649b
RD
5640 """
5641 GetMenuId(self) -> int
5642
5643 Returns the menu identifier associated with the event. This method
5644 should be only used with the HIGHLIGHT events.
5645 """
d55e5bfc
RD
5646 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
5647
5648 def IsPopup(*args, **kwargs):
5ba5649b
RD
5649 """
5650 IsPopup(self) -> bool
5651
5652 Returns ``True`` if the menu which is being opened or closed is a
5653 popup menu, ``False`` if it is a normal one. This method should only
5654 be used with the OPEN and CLOSE events.
5655 """
d55e5bfc
RD
5656 return _core_.MenuEvent_IsPopup(*args, **kwargs)
5657
5658 def GetMenu(*args, **kwargs):
5ba5649b
RD
5659 """
5660 GetMenu(self) -> Menu
5661
5662 Returns the menu which is being opened or closed. This method should
5663 only be used with the OPEN and CLOSE events.
5664 """
d55e5bfc
RD
5665 return _core_.MenuEvent_GetMenu(*args, **kwargs)
5666
5667
5668class MenuEventPtr(MenuEvent):
5669 def __init__(self, this):
5670 self.this = this
5671 if not hasattr(self,"thisown"): self.thisown = 0
5672 self.__class__ = MenuEvent
5673_core_.MenuEvent_swigregister(MenuEventPtr)
5674
5675#---------------------------------------------------------------------------
5676
5677class CloseEvent(Event):
5ba5649b
RD
5678 """
5679 This event class contains information about window and session close
5680 events.
5681
5682 The handler function for EVT_CLOSE is called when the user has tried
5683 to close a a frame or dialog box using the window manager controls or
5684 the system menu. It can also be invoked by the application itself
5685 programmatically, for example by calling the `wx.Window.Close`
5686 function.
5687
5688 You should check whether the application is forcing the deletion of
5689 the window using `CanVeto`. If it returns ``False``, you must destroy
5690 the window using `wx.Window.Destroy`. If the return value is ``True``,
5691 it is up to you whether you respond by destroying the window or not.
5692 For example you may wish to display a message dialog prompting to save
5693 files or to cancel the close.
5694
5695 If you don't destroy the window, you should call `Veto` to let the
5696 calling code know that you did not destroy the window. This allows the
5697 `wx.Window.Close` function to return ``True`` or ``False`` depending
5698 on whether the close instruction was honored or not.
5699 """
d55e5bfc
RD
5700 def __repr__(self):
5701 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5702 def __init__(self, *args, **kwargs):
5ba5649b
RD
5703 """
5704 __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent
5705
5706 Constructor.
5707 """
d55e5bfc
RD
5708 newobj = _core_.new_CloseEvent(*args, **kwargs)
5709 self.this = newobj.this
5710 self.thisown = 1
5711 del newobj.thisown
5712 def SetLoggingOff(*args, **kwargs):
5ba5649b
RD
5713 """
5714 SetLoggingOff(self, bool logOff)
5715
5716 Sets the 'logging off' flag.
5717 """
d55e5bfc
RD
5718 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
5719
5720 def GetLoggingOff(*args, **kwargs):
5ba5649b
RD
5721 """
5722 GetLoggingOff(self) -> bool
5723
034e3677
RD
5724 Returns ``True`` if the user is logging off or ``False`` if the
5725 system is shutting down. This method can only be called for end
5726 session and query end session events, it doesn't make sense for close
5727 window event.
5ba5649b 5728 """
d55e5bfc
RD
5729 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
5730
5731 def Veto(*args, **kwargs):
5ba5649b
RD
5732 """
5733 Veto(self, bool veto=True)
5734
5735 Call this from your event handler to veto a system shutdown or to
5736 signal to the calling application that a window close did not happen.
5737
5738 You can only veto a shutdown or close if `CanVeto` returns true.
5739 """
d55e5bfc
RD
5740 return _core_.CloseEvent_Veto(*args, **kwargs)
5741
5ba5649b
RD
5742 def GetVeto(*args, **kwargs):
5743 """GetVeto(self) -> bool"""
5744 return _core_.CloseEvent_GetVeto(*args, **kwargs)
5745
d55e5bfc 5746 def SetCanVeto(*args, **kwargs):
5ba5649b
RD
5747 """
5748 SetCanVeto(self, bool canVeto)
5749
5750 Sets the 'can veto' flag.
5751 """
d55e5bfc
RD
5752 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
5753
5754 def CanVeto(*args, **kwargs):
5ba5649b
RD
5755 """
5756 CanVeto(self) -> bool
d55e5bfc 5757
5ba5649b
RD
5758 Returns true if you can veto a system shutdown or a window close
5759 event. Vetoing a window close event is not possible if the calling
5760 code wishes to force the application to exit, and so this function
5761 must be called to check this.
5762 """
5763 return _core_.CloseEvent_CanVeto(*args, **kwargs)
d55e5bfc
RD
5764
5765
5766class CloseEventPtr(CloseEvent):
5767 def __init__(self, this):
5768 self.this = this
5769 if not hasattr(self,"thisown"): self.thisown = 0
5770 self.__class__ = CloseEvent
5771_core_.CloseEvent_swigregister(CloseEventPtr)
5772
5773#---------------------------------------------------------------------------
5774
5775class ShowEvent(Event):
5ba5649b 5776 """An EVT_SHOW event is sent when a window is shown or hidden."""
d55e5bfc
RD
5777 def __repr__(self):
5778 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5779 def __init__(self, *args, **kwargs):
5ba5649b
RD
5780 """
5781 __init__(self, int winid=0, bool show=False) -> ShowEvent
5782
5783 An EVT_SHOW event is sent when a window is shown or hidden.
5784 """
d55e5bfc
RD
5785 newobj = _core_.new_ShowEvent(*args, **kwargs)
5786 self.this = newobj.this
5787 self.thisown = 1
5788 del newobj.thisown
5789 def SetShow(*args, **kwargs):
5790 """SetShow(self, bool show)"""
5791 return _core_.ShowEvent_SetShow(*args, **kwargs)
5792
5793 def GetShow(*args, **kwargs):
5794 """GetShow(self) -> bool"""
5795 return _core_.ShowEvent_GetShow(*args, **kwargs)
5796
5797
5798class ShowEventPtr(ShowEvent):
5799 def __init__(self, this):
5800 self.this = this
5801 if not hasattr(self,"thisown"): self.thisown = 0
5802 self.__class__ = ShowEvent
5803_core_.ShowEvent_swigregister(ShowEventPtr)
5804
5805#---------------------------------------------------------------------------
5806
5807class IconizeEvent(Event):
5ba5649b
RD
5808 """
5809 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5810 restored.
5811 """
d55e5bfc
RD
5812 def __repr__(self):
5813 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5814 def __init__(self, *args, **kwargs):
5ba5649b
RD
5815 """
5816 __init__(self, int id=0, bool iconized=True) -> IconizeEvent
5817
5818 An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
5819 restored.
5820 """
d55e5bfc
RD
5821 newobj = _core_.new_IconizeEvent(*args, **kwargs)
5822 self.this = newobj.this
5823 self.thisown = 1
5824 del newobj.thisown
5825 def Iconized(*args, **kwargs):
5ba5649b
RD
5826 """
5827 Iconized(self) -> bool
5828
5829 Returns ``True`` if the frame has been iconized, ``False`` if it has
5830 been restored.
5831 """
d55e5bfc
RD
5832 return _core_.IconizeEvent_Iconized(*args, **kwargs)
5833
5834
5835class IconizeEventPtr(IconizeEvent):
5836 def __init__(self, this):
5837 self.this = this
5838 if not hasattr(self,"thisown"): self.thisown = 0
5839 self.__class__ = IconizeEvent
5840_core_.IconizeEvent_swigregister(IconizeEventPtr)
5841
5842#---------------------------------------------------------------------------
5843
5844class MaximizeEvent(Event):
5ba5649b 5845 """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
d55e5bfc
RD
5846 def __repr__(self):
5847 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5848 def __init__(self, *args, **kwargs):
5ba5649b
RD
5849 """
5850 __init__(self, int id=0) -> MaximizeEvent
5851
5852 An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
5853 """
d55e5bfc
RD
5854 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
5855 self.this = newobj.this
5856 self.thisown = 1
5857 del newobj.thisown
5858
5859class MaximizeEventPtr(MaximizeEvent):
5860 def __init__(self, this):
5861 self.this = this
5862 if not hasattr(self,"thisown"): self.thisown = 0
5863 self.__class__ = MaximizeEvent
5864_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
5865
5866#---------------------------------------------------------------------------
5867
5868class DropFilesEvent(Event):
5ba5649b
RD
5869 """
5870 This class is used for drop files events, that is, when files have
5871 been dropped onto the window. This functionality is only available
5872 under Windows. The window must have previously been enabled for
5873 dropping by calling `wx.Window.DragAcceptFiles`.
5874
5875 Important note: this is a separate implementation to the more general
5876 drag and drop implementation using `wx.FileDropTarget`, and etc. This
5877 implementation uses the older, Windows message-based approach of
5878 dropping files.
5879
5880 Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
5881 events.
5882
5883 """
d55e5bfc
RD
5884 def __init__(self): raise RuntimeError, "No constructor defined"
5885 def __repr__(self):
5886 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5887 def GetPosition(*args, **kwargs):
5ba5649b
RD
5888 """
5889 GetPosition(self) -> Point
5890
5891 Returns the position at which the files were dropped.
5892 """
d55e5bfc
RD
5893 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
5894
5895 def GetNumberOfFiles(*args, **kwargs):
5ba5649b
RD
5896 """
5897 GetNumberOfFiles(self) -> int
5898
5899 Returns the number of files dropped.
5900 """
d55e5bfc
RD
5901 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
5902
5903 def GetFiles(*args, **kwargs):
5ba5649b
RD
5904 """
5905 GetFiles(self) -> PyObject
5906
5907 Returns a list of the filenames that were dropped.
5908 """
d55e5bfc
RD
5909 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
5910
5911
5912class DropFilesEventPtr(DropFilesEvent):
5913 def __init__(self, this):
5914 self.this = this
5915 if not hasattr(self,"thisown"): self.thisown = 0
5916 self.__class__ = DropFilesEvent
5917_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
5918
5919#---------------------------------------------------------------------------
5920
5921UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
5922UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
5923class UpdateUIEvent(CommandEvent):
5ba5649b
RD
5924 """
5925 This class is used for EVT_UPDATE_UI pseudo-events which are sent by
5926 wxWidgets to give an application the chance to update various user
5927 interface elements.
5928
5929 Without update UI events, an application has to work hard to
5930 check/uncheck, enable/disable, and set the text for elements such as
5931 menu items and toolbar buttons. The code for doing this has to be
5932 mixed up with the code that is invoked when an action is invoked for a
5933 menu item or button.
5934
5935 With update UI events, you define an event handler to look at the
5936 state of the application and change UI elements accordingly. wxWidgets
5937 will call your handler functions in idle time, so you don't have to
5938 worry where to call this code. In addition to being a clearer and more
5939 declarative method, it also means you don't have to worry whether
5940 you're updating a toolbar or menubar identifier. The same handler can
5941 update a menu item and toolbar button, if the ID values are the same.
5942
5943 Instead of directly manipulating the menu or button, you call
5944 functions in the event object, such as `Check`. wxWidgets will
5945 determine whether such a call has been made, and which UI element to
5946 update.
5947
5948 These events will work for popup menus as well as menubars. Just
5949 before a menu is popped up, `wx.Menu.UpdateUI` is called to process
5950 any UI events for the window that owns the menu.
5951
5952 If you find that the overhead of UI update processing is affecting
5953 your application, you can do one or both of the following:
5954
5955 1. Call `wx.UpdateUIEvent.SetMode` with a value of
5956 wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
5957 wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
5958 receive update events. No other windows will receive update
5959 events.
5960
5961 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
5962 value to set the delay between updates. You may need to call
5963 `wx.Window.UpdateWindowUI` at critical points, for example when
5964 a dialog is about to be shown, in case the user sees a slight
5965 delay before windows are updated.
5966
5967 Note that although events are sent in idle time, defining a EVT_IDLE
5968 handler for a window does not affect this because the events are sent
5969 from an internal idle handler.
5970
5971 wxWidgets tries to optimize update events on some platforms. On
5972 Windows and GTK+, events for menubar items are only sent when the menu
5973 is about to be shown, and not in idle time.
5974
5975 """
d55e5bfc
RD
5976 def __repr__(self):
5977 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5978 def __init__(self, *args, **kwargs):
5ba5649b
RD
5979 """
5980 __init__(self, int commandId=0) -> UpdateUIEvent
5981
5982 Constructor
5983 """
d55e5bfc
RD
5984 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
5985 self.this = newobj.this
5986 self.thisown = 1
5987 del newobj.thisown
5988 def GetChecked(*args, **kwargs):
5ba5649b
RD
5989 """
5990 GetChecked(self) -> bool
5991
5992 Returns ``True`` if the UI element should be checked.
5993 """
d55e5bfc
RD
5994 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
5995
5996 def GetEnabled(*args, **kwargs):
5ba5649b
RD
5997 """
5998 GetEnabled(self) -> bool
5999
6000 Returns ``True`` if the UI element should be enabled.
6001 """
d55e5bfc
RD
6002 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
6003
6004 def GetText(*args, **kwargs):
5ba5649b
RD
6005 """
6006 GetText(self) -> String
6007
6008 Returns the text that should be set for the UI element.
6009 """
d55e5bfc
RD
6010 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
6011
6012 def GetSetText(*args, **kwargs):
5ba5649b
RD
6013 """
6014 GetSetText(self) -> bool
6015
6016 Returns ``True`` if the application has called `SetText`. For
6017 wxWidgets internal use only.
6018 """
d55e5bfc
RD
6019 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
6020
6021 def GetSetChecked(*args, **kwargs):
5ba5649b
RD
6022 """
6023 GetSetChecked(self) -> bool
6024
6025 Returns ``True`` if the application has called `Check`. For wxWidgets
6026 internal use only.
6027 """
d55e5bfc
RD
6028 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
6029
6030 def GetSetEnabled(*args, **kwargs):
5ba5649b
RD
6031 """
6032 GetSetEnabled(self) -> bool
6033
6034 Returns ``True`` if the application has called `Enable`. For wxWidgets
6035 internal use only.
6036 """
d55e5bfc
RD
6037 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
6038
6039 def Check(*args, **kwargs):
5ba5649b
RD
6040 """
6041 Check(self, bool check)
6042
6043 Check or uncheck the UI element.
6044 """
d55e5bfc
RD
6045 return _core_.UpdateUIEvent_Check(*args, **kwargs)
6046
6047 def Enable(*args, **kwargs):
5ba5649b
RD
6048 """
6049 Enable(self, bool enable)
6050
6051 Enable or disable the UI element.
6052 """
d55e5bfc
RD
6053 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
6054
6055 def SetText(*args, **kwargs):
5ba5649b
RD
6056 """
6057 SetText(self, String text)
6058
6059 Sets the text for this UI element.
6060 """
d55e5bfc
RD
6061 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
6062
6063 def SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6064 """
6065 SetUpdateInterval(long updateInterval)
6066
6067 Sets the interval between updates in milliseconds. Set to -1 to
6068 disable updates, or to 0 to update as frequently as possible. The
6069 default is 0.
6070
6071 Use this to reduce the overhead of UI update events if your
6072 application has a lot of windows. If you set the value to -1 or
6073 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6074 at appropriate points in your application, such as when a dialog is
6075 about to be shown.
6076 """
d55e5bfc
RD
6077 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6078
6079 SetUpdateInterval = staticmethod(SetUpdateInterval)
6080 def GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6081 """
6082 GetUpdateInterval() -> long
6083
6084 Returns the current interval between updates in milliseconds. -1
6085 disables updates, 0 updates as frequently as possible.
6086 """
d55e5bfc
RD
6087 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6088
6089 GetUpdateInterval = staticmethod(GetUpdateInterval)
6090 def CanUpdate(*args, **kwargs):
5ba5649b
RD
6091 """
6092 CanUpdate(Window win) -> bool
6093
6094 Returns ``True`` if it is appropriate to update (send UI update events
6095 to) this window.
6096
6097 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6098 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6099 events were last sent in idle time, and the update interval, to
6100 determine whether events should be sent to this window now. By default
6101 this will always return true because the update mode is initially
6102 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6103 events will be sent as often as possible. You can reduce the frequency
6104 that events are sent by changing the mode and/or setting an update
6105 interval.
6106
6107 """
d55e5bfc
RD
6108 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6109
6110 CanUpdate = staticmethod(CanUpdate)
6111 def ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
6112 """
6113 ResetUpdateTime()
6114
6115 Used internally to reset the last-updated time to the current time. It
6116 is assumed that update events are normally sent in idle time, so this
6117 is called at the end of idle processing.
6118 """
d55e5bfc
RD
6119 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6120
6121 ResetUpdateTime = staticmethod(ResetUpdateTime)
6122 def SetMode(*args, **kwargs):
5ba5649b
RD
6123 """
6124 SetMode(int mode)
6125
6126 Specify how wxWidgets will send update events: to all windows, or only
6127 to those which specify that they will process the events.
6128
6129 The mode may be one of the following values:
6130
6131 ============================= ==========================================
6132 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6133 is the default setting.
6134 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6135 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6136 style set.
6137 ============================= ==========================================
6138
6139 """
d55e5bfc
RD
6140 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6141
6142 SetMode = staticmethod(SetMode)
6143 def GetMode(*args, **kwargs):
5ba5649b
RD
6144 """
6145 GetMode() -> int
6146
6147 Returns a value specifying how wxWidgets will send update events: to
6148 all windows, or only to those which specify that they will process the
6149 events.
6150 """
d55e5bfc
RD
6151 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6152
6153 GetMode = staticmethod(GetMode)
6154
6155class UpdateUIEventPtr(UpdateUIEvent):
6156 def __init__(self, this):
6157 self.this = this
6158 if not hasattr(self,"thisown"): self.thisown = 0
6159 self.__class__ = UpdateUIEvent
6160_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
6161
6162def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6163 """
6164 UpdateUIEvent_SetUpdateInterval(long updateInterval)
6165
6166 Sets the interval between updates in milliseconds. Set to -1 to
6167 disable updates, or to 0 to update as frequently as possible. The
6168 default is 0.
6169
6170 Use this to reduce the overhead of UI update events if your
6171 application has a lot of windows. If you set the value to -1 or
6172 greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
6173 at appropriate points in your application, such as when a dialog is
6174 about to be shown.
6175 """
d55e5bfc
RD
6176 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
6177
6178def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
5ba5649b
RD
6179 """
6180 UpdateUIEvent_GetUpdateInterval() -> long
6181
6182 Returns the current interval between updates in milliseconds. -1
6183 disables updates, 0 updates as frequently as possible.
6184 """
d55e5bfc
RD
6185 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
6186
6187def UpdateUIEvent_CanUpdate(*args, **kwargs):
5ba5649b
RD
6188 """
6189 UpdateUIEvent_CanUpdate(Window win) -> bool
6190
6191 Returns ``True`` if it is appropriate to update (send UI update events
6192 to) this window.
6193
6194 This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
6195 the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
6196 events were last sent in idle time, and the update interval, to
6197 determine whether events should be sent to this window now. By default
6198 this will always return true because the update mode is initially
6199 wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
6200 events will be sent as often as possible. You can reduce the frequency
6201 that events are sent by changing the mode and/or setting an update
6202 interval.
6203
6204 """
d55e5bfc
RD
6205 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
6206
6207def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
5ba5649b
RD
6208 """
6209 UpdateUIEvent_ResetUpdateTime()
6210
6211 Used internally to reset the last-updated time to the current time. It
6212 is assumed that update events are normally sent in idle time, so this
6213 is called at the end of idle processing.
6214 """
d55e5bfc
RD
6215 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
6216
6217def UpdateUIEvent_SetMode(*args, **kwargs):
5ba5649b
RD
6218 """
6219 UpdateUIEvent_SetMode(int mode)
6220
6221 Specify how wxWidgets will send update events: to all windows, or only
6222 to those which specify that they will process the events.
6223
6224 The mode may be one of the following values:
6225
6226 ============================= ==========================================
6227 wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
6228 is the default setting.
6229 wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
6230 have the wx.WS_EX_PROCESS_UI_UPDATES extra
6231 style set.
6232 ============================= ==========================================
6233
6234 """
d55e5bfc
RD
6235 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
6236
6237def UpdateUIEvent_GetMode(*args, **kwargs):
5ba5649b
RD
6238 """
6239 UpdateUIEvent_GetMode() -> int
6240
6241 Returns a value specifying how wxWidgets will send update events: to
6242 all windows, or only to those which specify that they will process the
6243 events.
6244 """
d55e5bfc
RD
6245 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
6246
6247#---------------------------------------------------------------------------
6248
6249class SysColourChangedEvent(Event):
5ba5649b
RD
6250 """
6251 This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
6252 when the user changes the colour settings using the control
6253 panel. This is only applicable under Windows.
6254
6255 The default event handler for this event propagates the event to child
6256 windows, since Windows only sends the events to top-level windows. If
6257 intercepting this event for a top-level window, remember to call
6258 `Skip` so the the base class handler will still be executed, or to
6259 pass the event on to the window's children explicitly.
6260
6261 """
d55e5bfc
RD
6262 def __repr__(self):
6263 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6264 def __init__(self, *args, **kwargs):
5ba5649b
RD
6265 """
6266 __init__(self) -> SysColourChangedEvent
6267
6268 Constructor
6269 """
d55e5bfc
RD
6270 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
6271 self.this = newobj.this
6272 self.thisown = 1
6273 del newobj.thisown
6274
6275class SysColourChangedEventPtr(SysColourChangedEvent):
6276 def __init__(self, this):
6277 self.this = this
6278 if not hasattr(self,"thisown"): self.thisown = 0
6279 self.__class__ = SysColourChangedEvent
6280_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
6281
6282#---------------------------------------------------------------------------
6283
6284class MouseCaptureChangedEvent(Event):
5ba5649b
RD
6285 """
6286 An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
6287 a window that loses its mouse capture. This is called even if
6288 `wx.Window.ReleaseMouse` was called by the application code. Handling
6289 this event allows an application to cater for unexpected capture
6290 releases which might otherwise confuse mouse handling code.
6291
6292 This event is implemented under Windows only.
6293 """
d55e5bfc
RD
6294 def __repr__(self):
6295 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6296 def __init__(self, *args, **kwargs):
5ba5649b
RD
6297 """
6298 __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
6299
6300 Constructor
6301 """
d55e5bfc
RD
6302 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
6303 self.this = newobj.this
6304 self.thisown = 1
6305 del newobj.thisown
6306 def GetCapturedWindow(*args, **kwargs):
5ba5649b
RD
6307 """
6308 GetCapturedWindow(self) -> Window
6309
6310 Returns the window that gained the capture, or ``None`` if it was a
6311 non-wxWidgets window.
6312 """
d55e5bfc
RD
6313 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
6314
6315
6316class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
6317 def __init__(self, this):
6318 self.this = this
6319 if not hasattr(self,"thisown"): self.thisown = 0
6320 self.__class__ = MouseCaptureChangedEvent
6321_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
6322
6323#---------------------------------------------------------------------------
6324
6325class DisplayChangedEvent(Event):
5ba5649b
RD
6326 """
6327 An EVT_DISPLAY_CHANGED event is sent to all windows when the display
6328 resolution has changed.
6329
6330 This event is implemented under Windows only.
6331 """
d55e5bfc
RD
6332 def __repr__(self):
6333 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6334 def __init__(self, *args, **kwargs):
6335 """__init__(self) -> DisplayChangedEvent"""
6336 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
6337 self.this = newobj.this
6338 self.thisown = 1
6339 del newobj.thisown
6340
6341class DisplayChangedEventPtr(DisplayChangedEvent):
6342 def __init__(self, this):
6343 self.this = this
6344 if not hasattr(self,"thisown"): self.thisown = 0
6345 self.__class__ = DisplayChangedEvent
6346_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
6347
6348#---------------------------------------------------------------------------
6349
6350class PaletteChangedEvent(Event):
5ba5649b
RD
6351 """
6352 An EVT_PALETTE_CHANGED event is sent when the system palette has
6353 changed, thereby giving each window a chance to redo their own to
6354 match.
6355
6356 This event is implemented under Windows only.
6357 """
d55e5bfc
RD
6358 def __repr__(self):
6359 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6360 def __init__(self, *args, **kwargs):
5ba5649b
RD
6361 """
6362 __init__(self, int id=0) -> PaletteChangedEvent
6363
6364 An EVT_PALETTE_CHANGED event is sent when the system palette has
6365 changed, thereby giving each window a chance to redo their own to
6366 match.
6367
6368 This event is implemented under Windows only.
6369 """
d55e5bfc
RD
6370 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
6371 self.this = newobj.this
6372 self.thisown = 1
6373 del newobj.thisown
6374 def SetChangedWindow(*args, **kwargs):
6375 """SetChangedWindow(self, Window win)"""
6376 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
6377
6378 def GetChangedWindow(*args, **kwargs):
6379 """GetChangedWindow(self) -> Window"""
6380 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
6381
6382
6383class PaletteChangedEventPtr(PaletteChangedEvent):
6384 def __init__(self, this):
6385 self.this = this
6386 if not hasattr(self,"thisown"): self.thisown = 0
6387 self.__class__ = PaletteChangedEvent
6388_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
6389
6390#---------------------------------------------------------------------------
6391
6392class QueryNewPaletteEvent(Event):
5ba5649b
RD
6393 """
6394 An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
6395 focus and should re-do its palette.
6396
6397 This event is implemented under Windows only.
6398 """
d55e5bfc
RD
6399 def __repr__(self):
6400 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6401 def __init__(self, *args, **kwargs):
5ba5649b
RD
6402 """
6403 __init__(self, int winid=0) -> QueryNewPaletteEvent
6404
6405 Constructor.
6406 """
d55e5bfc
RD
6407 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
6408 self.this = newobj.this
6409 self.thisown = 1
6410 del newobj.thisown
6411 def SetPaletteRealized(*args, **kwargs):
5ba5649b
RD
6412 """
6413 SetPaletteRealized(self, bool realized)
6414
6415 App should set this if it changes the palette.
6416 """
d55e5bfc
RD
6417 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
6418
6419 def GetPaletteRealized(*args, **kwargs):
6420 """GetPaletteRealized(self) -> bool"""
6421 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
6422
6423
6424class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
6425 def __init__(self, this):
6426 self.this = this
6427 if not hasattr(self,"thisown"): self.thisown = 0
6428 self.__class__ = QueryNewPaletteEvent
6429_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
6430
6431#---------------------------------------------------------------------------
6432
6433class NavigationKeyEvent(Event):
5ba5649b
RD
6434 """
6435 EVT_NAVIGATION_KEY events are used to control moving the focus between
6436 widgets, otherwise known as tab-traversal. You woudl normally not
6437 catch navigation events in applications as there are already
6438 appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
6439 it useful to send navigation events in certain situations to change
6440 the focus in certain ways, although it's probably easier to just call
6441 `wx.Window.Navigate`.
6442 """
d55e5bfc
RD
6443 def __repr__(self):
6444 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6445 def __init__(self, *args, **kwargs):
6446 """__init__(self) -> NavigationKeyEvent"""
6447 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
6448 self.this = newobj.this
6449 self.thisown = 1
6450 del newobj.thisown
6451 def GetDirection(*args, **kwargs):
5ba5649b
RD
6452 """
6453 GetDirection(self) -> bool
6454
6455 Returns ``True`` if the direction is forward, ``False`` otherwise.
6456 """
d55e5bfc
RD
6457 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
6458
6459 def SetDirection(*args, **kwargs):
5ba5649b
RD
6460 """
6461 SetDirection(self, bool forward)
6462
6463 Specify the direction that the navigation should take. Usually the
6464 difference between using Tab and Shift-Tab.
6465 """
d55e5bfc
RD
6466 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
6467
6468 def IsWindowChange(*args, **kwargs):
5ba5649b
RD
6469 """
6470 IsWindowChange(self) -> bool
6471
6472 Returns ``True`` if window change is allowed.
6473 """
d55e5bfc
RD
6474 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
6475
6476 def SetWindowChange(*args, **kwargs):
5ba5649b
RD
6477 """
6478 SetWindowChange(self, bool ischange)
6479
6480 Specify if the navigation should be able to change parent windows.
6481 For example, changing notebook pages, etc. This is usually implemented
6482 by using Control-Tab.
6483 """
d55e5bfc
RD
6484 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
6485
68350608 6486 def IsFromTab(*args, **kwargs):
5ba5649b
RD
6487 """
6488 IsFromTab(self) -> bool
6489
6490 Returns ``True`` if the navigation event is originated from the Tab
6491 key.
6492 """
68350608
RD
6493 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
6494
6495 def SetFromTab(*args, **kwargs):
5ba5649b
RD
6496 """
6497 SetFromTab(self, bool bIs)
6498
6499 Set to true under MSW if the event was generated using the tab key.
6500 This is required for proper navogation over radio buttons.
6501 """
68350608
RD
6502 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
6503
908b74cd 6504 def SetFlags(*args, **kwargs):
5ba5649b
RD
6505 """
6506 SetFlags(self, long flags)
6507
6508 Set the navigation flags to a combination of the following:
6509
6510 * wx.NavigationKeyEvent.IsBackward
6511 * wx.NavigationKeyEvent.IsForward
6512 * wx.NavigationKeyEvent.WinChange
6513 * wx.NavigationKeyEvent.FromTab
6514
6515 """
908b74cd
RD
6516 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
6517
d55e5bfc 6518 def GetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6519 """
6520 GetCurrentFocus(self) -> Window
6521
6522 Returns the child window which currenty has the focus. May be
6523 ``None``.
6524 """
d55e5bfc
RD
6525 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
6526
6527 def SetCurrentFocus(*args, **kwargs):
5ba5649b
RD
6528 """
6529 SetCurrentFocus(self, Window win)
6530
6531 Set the window that has the focus.
6532 """
d55e5bfc
RD
6533 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
6534
b0f7404b 6535 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
6536 IsForward = _core_.NavigationKeyEvent_IsForward
6537 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 6538 FromTab = _core_.NavigationKeyEvent_FromTab
d55e5bfc
RD
6539
6540class NavigationKeyEventPtr(NavigationKeyEvent):
6541 def __init__(self, this):
6542 self.this = this
6543 if not hasattr(self,"thisown"): self.thisown = 0
6544 self.__class__ = NavigationKeyEvent
6545_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
6546
6547#---------------------------------------------------------------------------
6548
6549class WindowCreateEvent(CommandEvent):
5ba5649b
RD
6550 """
6551 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6552 underlying GUI object) exists.
6553 """
d55e5bfc
RD
6554 def __repr__(self):
6555 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6556 def __init__(self, *args, **kwargs):
5ba5649b
RD
6557 """
6558 __init__(self, Window win=None) -> WindowCreateEvent
6559
6560 The EVT_WINDOW_CREATE event is sent as soon as the window object (the
6561 underlying GUI object) exists.
6562 """
d55e5bfc
RD
6563 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
6564 self.this = newobj.this
6565 self.thisown = 1
6566 del newobj.thisown
6567 def GetWindow(*args, **kwargs):
5ba5649b
RD
6568 """
6569 GetWindow(self) -> Window
6570
6571 Returns the window that this event refers to.
6572 """
d55e5bfc
RD
6573 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
6574
6575
6576class WindowCreateEventPtr(WindowCreateEvent):
6577 def __init__(self, this):
6578 self.this = this
6579 if not hasattr(self,"thisown"): self.thisown = 0
6580 self.__class__ = WindowCreateEvent
6581_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
6582
6583class WindowDestroyEvent(CommandEvent):
5ba5649b 6584 """
9d7dfdff
RD
6585 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6586 when the GUI window is destroyed.
6587
6588 When a class derived from `wx.Window` is destroyed its destructor will
6589 have already run by the time this event is sent. Therefore this event
6590 will not usually be received at all by the window itself. Since it is
6591 received after the destructor has run, an object should not try to
6592 handle its own wx.WindowDestroyEvent, but it can be used to get
6593 notification of the destruction of another window.
5ba5649b 6594 """
d55e5bfc
RD
6595 def __repr__(self):
6596 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6597 def __init__(self, *args, **kwargs):
5ba5649b
RD
6598 """
6599 __init__(self, Window win=None) -> WindowDestroyEvent
6600
9d7dfdff
RD
6601 The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
6602 when the GUI window is destroyed.
6603
6604 When a class derived from `wx.Window` is destroyed its destructor will
6605 have already run by the time this event is sent. Therefore this event
6606 will not usually be received at all by the window itself. Since it is
6607 received after the destructor has run, an object should not try to
6608 handle its own wx.WindowDestroyEvent, but it can be used to get
6609 notification of the destruction of another window.
5ba5649b 6610 """
d55e5bfc
RD
6611 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
6612 self.this = newobj.this
6613 self.thisown = 1
6614 del newobj.thisown
6615 def GetWindow(*args, **kwargs):
5ba5649b
RD
6616 """
6617 GetWindow(self) -> Window
6618
6619 Returns the window that this event refers to.
6620 """
d55e5bfc
RD
6621 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
6622
6623
6624class WindowDestroyEventPtr(WindowDestroyEvent):
6625 def __init__(self, this):
6626 self.this = this
6627 if not hasattr(self,"thisown"): self.thisown = 0
6628 self.__class__ = WindowDestroyEvent
6629_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
6630
6631#---------------------------------------------------------------------------
6632
6633class ContextMenuEvent(CommandEvent):
5ba5649b
RD
6634 """
6635 This class is used for context menu events (EVT_CONTECT_MENU,) sent to
6636 give the application a chance to show a context (popup) menu.
6637 """
d55e5bfc
RD
6638 def __repr__(self):
6639 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6640 def __init__(self, *args, **kwargs):
5ba5649b
RD
6641 """
6642 __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
6643
6644 Constructor.
6645 """
d55e5bfc
RD
6646 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
6647 self.this = newobj.this
6648 self.thisown = 1
6649 del newobj.thisown
6650 def GetPosition(*args, **kwargs):
5ba5649b
RD
6651 """
6652 GetPosition(self) -> Point
6653
6654 Returns the position (in screen coordinants) at which the menu should
6655 be shown.
6656 """
d55e5bfc
RD
6657 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
6658
6659 def SetPosition(*args, **kwargs):
5ba5649b
RD
6660 """
6661 SetPosition(self, Point pos)
6662
6663 Sets the position at which the menu should be shown.
6664 """
d55e5bfc
RD
6665 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
6666
6667
6668class ContextMenuEventPtr(ContextMenuEvent):
6669 def __init__(self, this):
6670 self.this = this
6671 if not hasattr(self,"thisown"): self.thisown = 0
6672 self.__class__ = ContextMenuEvent
6673_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
6674
6675#---------------------------------------------------------------------------
6676
6677IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
6678IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
6679class IdleEvent(Event):
5ba5649b
RD
6680 """
6681 This class is used for EVT_IDLE events, which are generated and sent
6682 when the application *becomes* idle. In other words, the when the
6683 event queue becomes empty then idle events are sent to all windows (by
6684 default) and as long as none of them call `RequestMore` then there are
6685 no more idle events until after the system event queue has some normal
6686 events and then becomes empty again.
6687
6688 By default, idle events are sent to all windows. If this is causing a
6689 significant overhead in your application, you can call
6690 `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
6691 set the wx.WS_EX_PROCESS_IDLE extra window style for every window
6692 which should receive idle events. Then idle events will only be sent
6693 to those windows and not to any others.
6694 """
d55e5bfc
RD
6695 def __repr__(self):
6696 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6697 def __init__(self, *args, **kwargs):
5ba5649b
RD
6698 """
6699 __init__(self) -> IdleEvent
6700
6701 Constructor
6702 """
d55e5bfc
RD
6703 newobj = _core_.new_IdleEvent(*args, **kwargs)
6704 self.this = newobj.this
6705 self.thisown = 1
6706 del newobj.thisown
6707 def RequestMore(*args, **kwargs):
5ba5649b
RD
6708 """
6709 RequestMore(self, bool needMore=True)
6710
6711 Tells wxWidgets that more processing is required. This function can be
6712 called by an EVT_IDLE handler for a window to indicate that the
6713 application should forward the EVT_IDLE event once more to the
6714 application windows. If no window calls this function during its
6715 EVT_IDLE handler, then the application will remain in a passive event
6716 loop until a new event is posted to the application by the windowing
6717 system.
6718 """
d55e5bfc
RD
6719 return _core_.IdleEvent_RequestMore(*args, **kwargs)
6720
6721 def MoreRequested(*args, **kwargs):
5ba5649b
RD
6722 """
6723 MoreRequested(self) -> bool
6724
6725 Returns ``True`` if the OnIdle function processing this event
6726 requested more processing time.
6727 """
d55e5bfc
RD
6728 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
6729
6730 def SetMode(*args, **kwargs):
5ba5649b
RD
6731 """
6732 SetMode(int mode)
6733
6734 Static method for specifying how wxWidgets will send idle events: to
6735 all windows, or only to those which specify that they will process the
6736 events.
6737
6738 The mode can be one of the following values:
6739
6740 ========================= ========================================
6741 wx.IDLE_PROCESS_ALL Send idle events to all windows
6742 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6743 the wx.WS_EX_PROCESS_IDLE extra style
6744 flag set.
6745 ========================= ========================================
6746
6747 """
d55e5bfc
RD
6748 return _core_.IdleEvent_SetMode(*args, **kwargs)
6749
6750 SetMode = staticmethod(SetMode)
6751 def GetMode(*args, **kwargs):
5ba5649b
RD
6752 """
6753 GetMode() -> int
6754
6755 Static method returning a value specifying how wxWidgets will send
6756 idle events: to all windows, or only to those which specify that they
6757 will process the events.
6758 """
d55e5bfc
RD
6759 return _core_.IdleEvent_GetMode(*args, **kwargs)
6760
6761 GetMode = staticmethod(GetMode)
6762 def CanSend(*args, **kwargs):
5ba5649b
RD
6763 """
6764 CanSend(Window win) -> bool
6765
6766 Returns ``True`` if it is appropriate to send idle events to this
6767 window.
6768
6769 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6770 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6771 events should be sent to this window now. By default this will always
6772 return ``True`` because the update mode is initially
6773 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6774 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6775 """
d55e5bfc
RD
6776 return _core_.IdleEvent_CanSend(*args, **kwargs)
6777
6778 CanSend = staticmethod(CanSend)
6779
6780class IdleEventPtr(IdleEvent):
6781 def __init__(self, this):
6782 self.this = this
6783 if not hasattr(self,"thisown"): self.thisown = 0
6784 self.__class__ = IdleEvent
6785_core_.IdleEvent_swigregister(IdleEventPtr)
6786
6787def IdleEvent_SetMode(*args, **kwargs):
5ba5649b
RD
6788 """
6789 IdleEvent_SetMode(int mode)
6790
6791 Static method for specifying how wxWidgets will send idle events: to
6792 all windows, or only to those which specify that they will process the
6793 events.
6794
6795 The mode can be one of the following values:
6796
6797 ========================= ========================================
6798 wx.IDLE_PROCESS_ALL Send idle events to all windows
6799 wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
6800 the wx.WS_EX_PROCESS_IDLE extra style
6801 flag set.
6802 ========================= ========================================
6803
6804 """
d55e5bfc
RD
6805 return _core_.IdleEvent_SetMode(*args, **kwargs)
6806
6807def IdleEvent_GetMode(*args, **kwargs):
5ba5649b
RD
6808 """
6809 IdleEvent_GetMode() -> int
6810
6811 Static method returning a value specifying how wxWidgets will send
6812 idle events: to all windows, or only to those which specify that they
6813 will process the events.
6814 """
d55e5bfc
RD
6815 return _core_.IdleEvent_GetMode(*args, **kwargs)
6816
6817def IdleEvent_CanSend(*args, **kwargs):
5ba5649b
RD
6818 """
6819 IdleEvent_CanSend(Window win) -> bool
6820
6821 Returns ``True`` if it is appropriate to send idle events to this
6822 window.
6823
6824 This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
6825 the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
6826 events should be sent to this window now. By default this will always
6827 return ``True`` because the update mode is initially
6828 wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
6829 to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
6830 """
d55e5bfc
RD
6831 return _core_.IdleEvent_CanSend(*args, **kwargs)
6832
6833#---------------------------------------------------------------------------
6834
6835class PyEvent(Event):
5ba5649b
RD
6836 """
6837 wx.PyEvent can be used as a base class for implementing custom event
6838 types in Python. You should derived from this class instead of
6839 `wx.Event` because this class is Python-aware and is able to transport
6840 its Python bits safely through the wxWidgets event system and have
6841 them still be there when the event handler is invoked.
6842
6843 :see: `wx.PyCommandEvent`
6844
6845 """
d55e5bfc
RD
6846 def __repr__(self):
6847 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6848 def __init__(self, *args, **kwargs):
5ba5649b 6849 """__init__(self, int winid=0, wxEventType eventType=wxEVT_NULL) -> PyEvent"""
d55e5bfc
RD
6850 newobj = _core_.new_PyEvent(*args, **kwargs)
6851 self.this = newobj.this
6852 self.thisown = 1
6853 del newobj.thisown
5ba5649b 6854 self._SetSelf(self)
d55e5bfc
RD
6855
6856 def __del__(self, destroy=_core_.delete_PyEvent):
6857 """__del__(self)"""
6858 try:
6859 if self.thisown: destroy(self)
6860 except: pass
6861
5ba5649b
RD
6862 def _SetSelf(*args, **kwargs):
6863 """_SetSelf(self, PyObject self)"""
6864 return _core_.PyEvent__SetSelf(*args, **kwargs)
d55e5bfc 6865
5ba5649b
RD
6866 def _GetSelf(*args, **kwargs):
6867 """_GetSelf(self) -> PyObject"""
6868 return _core_.PyEvent__GetSelf(*args, **kwargs)
d55e5bfc
RD
6869
6870
6871class PyEventPtr(PyEvent):
6872 def __init__(self, this):
6873 self.this = this
6874 if not hasattr(self,"thisown"): self.thisown = 0
6875 self.__class__ = PyEvent
6876_core_.PyEvent_swigregister(PyEventPtr)
6877
6878class PyCommandEvent(CommandEvent):
5ba5649b
RD
6879 """
6880 wx.PyCommandEvent can be used as a base class for implementing custom
6881 event types in Python, where the event shoudl travel up to parent
6882 windows looking for a handler. You should derived from this class
6883 instead of `wx.CommandEvent` because this class is Python-aware and is
6884 able to transport its Python bits safely through the wxWidgets event
6885 system and have them still be there when the event handler is invoked.
6886
6887 :see: `wx.PyEvent`
6888
6889 """
d55e5bfc
RD
6890 def __repr__(self):
6891 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6892 def __init__(self, *args, **kwargs):
5ba5649b 6893 """__init__(self, wxEventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
d55e5bfc
RD
6894 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
6895 self.this = newobj.this
6896 self.thisown = 1
6897 del newobj.thisown
5ba5649b 6898 self._SetSelf(self)
d55e5bfc
RD
6899
6900 def __del__(self, destroy=_core_.delete_PyCommandEvent):
6901 """__del__(self)"""
6902 try:
6903 if self.thisown: destroy(self)
6904 except: pass
6905
5ba5649b
RD
6906 def _SetSelf(*args, **kwargs):
6907 """_SetSelf(self, PyObject self)"""
6908 return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
d55e5bfc 6909
5ba5649b
RD
6910 def _GetSelf(*args, **kwargs):
6911 """_GetSelf(self) -> PyObject"""
6912 return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
d55e5bfc
RD
6913
6914
6915class PyCommandEventPtr(PyCommandEvent):
6916 def __init__(self, this):
6917 self.this = this
6918 if not hasattr(self,"thisown"): self.thisown = 0
6919 self.__class__ = PyCommandEvent
6920_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
6921
53aa7709 6922class DateEvent(CommandEvent):
5ba5649b
RD
6923 """
6924 This event class holds information about a date change event and is
6925 used together with `wx.DatePickerCtrl`. It also serves as a base class
6926 for `wx.calendar.CalendarEvent`. Bind these event types with
6927 EVT_DATE_CHANGED.
6928 """
53aa7709
RD
6929 def __repr__(self):
6930 return "<%s.%s; proxy of C++ wxDateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6931 def __init__(self, *args, **kwargs):
6932 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
6933 newobj = _core_.new_DateEvent(*args, **kwargs)
6934 self.this = newobj.this
6935 self.thisown = 1
6936 del newobj.thisown
6937 def GetDate(*args, **kwargs):
5ba5649b
RD
6938 """
6939 GetDate(self) -> DateTime
6940
6941 Returns the date.
6942 """
53aa7709
RD
6943 return _core_.DateEvent_GetDate(*args, **kwargs)
6944
6945 def SetDate(*args, **kwargs):
5ba5649b
RD
6946 """
6947 SetDate(self, DateTime date)
6948
6949 Sets the date carried by the event, normally only used by the library
6950 internally.
6951 """
53aa7709
RD
6952 return _core_.DateEvent_SetDate(*args, **kwargs)
6953
6954
6955class DateEventPtr(DateEvent):
6956 def __init__(self, this):
6957 self.this = this
6958 if not hasattr(self,"thisown"): self.thisown = 0
6959 self.__class__ = DateEvent
6960_core_.DateEvent_swigregister(DateEventPtr)
6961
6962wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
6963EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
6964
d55e5bfc
RD
6965#---------------------------------------------------------------------------
6966
6967PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
6968PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
6969PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
6970PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
6971PRINT_WINDOWS = _core_.PRINT_WINDOWS
6972PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
6973class PyApp(EvtHandler):
c24da6d6
RD
6974 """
6975 The ``wx.PyApp`` class is an *implementation detail*, please use the
6976 `wx.App` class (or some other derived class) instead.
6977 """
d55e5bfc
RD
6978 def __repr__(self):
6979 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
6980 def __init__(self, *args, **kwargs):
6981 """
6982 __init__(self) -> PyApp
6983
6984 Create a new application object, starting the bootstrap process.
6985 """
6986 newobj = _core_.new_PyApp(*args, **kwargs)
6987 self.this = newobj.this
6988 self.thisown = 1
6989 del newobj.thisown
70b7a5fe
RD
6990 self._setCallbackInfo(self, PyApp, False)
6991 self._setOORInfo(self, False)
d55e5bfc
RD
6992
6993 def __del__(self, destroy=_core_.delete_PyApp):
6994 """__del__(self)"""
6995 try:
6996 if self.thisown: destroy(self)
6997 except: pass
6998
6999 def _setCallbackInfo(*args, **kwargs):
70b7a5fe 7000 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
d55e5bfc
RD
7001 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
7002
7003 def GetAppName(*args, **kwargs):
7004 """
7005 GetAppName(self) -> String
7006
7007 Get the application name.
7008 """
7009 return _core_.PyApp_GetAppName(*args, **kwargs)
7010
7011 def SetAppName(*args, **kwargs):
7012 """
7013 SetAppName(self, String name)
7014
c24da6d6
RD
7015 Set the application name. This value may be used automatically by
7016 `wx.Config` and such.
d55e5bfc
RD
7017 """
7018 return _core_.PyApp_SetAppName(*args, **kwargs)
7019
7020 def GetClassName(*args, **kwargs):
7021 """
7022 GetClassName(self) -> String
7023
7024 Get the application's class name.
7025 """
7026 return _core_.PyApp_GetClassName(*args, **kwargs)
7027
7028 def SetClassName(*args, **kwargs):
7029 """
7030 SetClassName(self, String name)
7031
c24da6d6
RD
7032 Set the application's class name. This value may be used for
7033 X-resources if applicable for the platform
d55e5bfc
RD
7034 """
7035 return _core_.PyApp_SetClassName(*args, **kwargs)
7036
7037 def GetVendorName(*args, **kwargs):
7038 """
7039 GetVendorName(self) -> String
7040
7041 Get the application's vendor name.
7042 """
7043 return _core_.PyApp_GetVendorName(*args, **kwargs)
7044
7045 def SetVendorName(*args, **kwargs):
7046 """
7047 SetVendorName(self, String name)
7048
c24da6d6
RD
7049 Set the application's vendor name. This value may be used
7050 automatically by `wx.Config` and such.
d55e5bfc
RD
7051 """
7052 return _core_.PyApp_SetVendorName(*args, **kwargs)
7053
7054 def GetTraits(*args, **kwargs):
7055 """
7056 GetTraits(self) -> wxAppTraits
7057
c24da6d6
RD
7058 Return (and create if necessary) the app traits object to which we
7059 delegate for everything which either should be configurable by the
7060 user (then he can change the default behaviour simply by overriding
7061 CreateTraits() and returning his own traits object) or which is
7062 GUI/console dependent as then wx.AppTraits allows us to abstract the
7063 differences behind the common facade.
7064
7065 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
7066 """
7067 return _core_.PyApp_GetTraits(*args, **kwargs)
7068
7069 def ProcessPendingEvents(*args, **kwargs):
7070 """
7071 ProcessPendingEvents(self)
7072
c24da6d6
RD
7073 Process all events in the Pending Events list -- it is necessary to
7074 call this function to process posted events. This normally happens
7075 during each event loop iteration.
d55e5bfc
RD
7076 """
7077 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
7078
7079 def Yield(*args, **kwargs):
7080 """
7081 Yield(self, bool onlyIfNeeded=False) -> bool
7082
c24da6d6
RD
7083 Process all currently pending events right now, instead of waiting
7084 until return to the event loop. It is an error to call ``Yield``
7085 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 7086
c24da6d6 7087 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD
7088 reentrancies (i.e. when called from an event handler it may
7089 result in calling the same event handler again), use with
7090 extreme care or, better, don't use at all!
d55e5bfc 7091
c24da6d6 7092 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 7093
d55e5bfc
RD
7094 """
7095 return _core_.PyApp_Yield(*args, **kwargs)
7096
7097 def WakeUpIdle(*args, **kwargs):
7098 """
7099 WakeUpIdle(self)
7100
c24da6d6
RD
7101 Make sure that idle events are sent again.
7102 :see: `wx.WakeUpIdle`
d55e5bfc
RD
7103 """
7104 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
7105
84f85550
RD
7106 def IsMainLoopRunning(*args, **kwargs):
7107 """
7108 IsMainLoopRunning() -> bool
7109
7110 Returns True if we're running the main loop, i.e. if the events can
7111 currently be dispatched.
7112 """
7113 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7114
7115 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD
7116 def MainLoop(*args, **kwargs):
7117 """
7118 MainLoop(self) -> int
7119
c24da6d6
RD
7120 Execute the main GUI loop, the function doesn't normally return until
7121 all top level windows have been closed and destroyed.
d55e5bfc
RD
7122 """
7123 return _core_.PyApp_MainLoop(*args, **kwargs)
7124
7125 def Exit(*args, **kwargs):
7126 """
7127 Exit(self)
7128
7129 Exit the main loop thus terminating the application.
c24da6d6 7130 :see: `wx.Exit`
d55e5bfc
RD
7131 """
7132 return _core_.PyApp_Exit(*args, **kwargs)
7133
7134 def ExitMainLoop(*args, **kwargs):
7135 """
7136 ExitMainLoop(self)
7137
c24da6d6
RD
7138 Exit the main GUI loop during the next iteration of the main
7139 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
7140 """
7141 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
7142
7143 def Pending(*args, **kwargs):
7144 """
7145 Pending(self) -> bool
7146
7147 Returns True if there are unprocessed events in the event queue.
7148 """
7149 return _core_.PyApp_Pending(*args, **kwargs)
7150
7151 def Dispatch(*args, **kwargs):
7152 """
7153 Dispatch(self) -> bool
7154
7155 Process the first event in the event queue (blocks until an event
7156 appears if there are none currently)
7157 """
7158 return _core_.PyApp_Dispatch(*args, **kwargs)
7159
7160 def ProcessIdle(*args, **kwargs):
7161 """
7162 ProcessIdle(self) -> bool
7163
c24da6d6
RD
7164 Called from the MainLoop when the application becomes idle (there are
7165 no pending events) and sends a `wx.IdleEvent` to all interested
7166 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
7167 """
7168 return _core_.PyApp_ProcessIdle(*args, **kwargs)
7169
7170 def SendIdleEvents(*args, **kwargs):
7171 """
7172 SendIdleEvents(self, Window win, IdleEvent event) -> bool
7173
c24da6d6
RD
7174 Send idle event to window and all subwindows. Returns True if more
7175 idle time is requested.
d55e5bfc
RD
7176 """
7177 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
7178
7179 def IsActive(*args, **kwargs):
7180 """
7181 IsActive(self) -> bool
7182
7183 Return True if our app has focus.
7184 """
7185 return _core_.PyApp_IsActive(*args, **kwargs)
7186
7187 def SetTopWindow(*args, **kwargs):
7188 """
7189 SetTopWindow(self, Window win)
7190
c24da6d6 7191 Set the *main* top level window
d55e5bfc
RD
7192 """
7193 return _core_.PyApp_SetTopWindow(*args, **kwargs)
7194
7195 def GetTopWindow(*args, **kwargs):
7196 """
7197 GetTopWindow(self) -> Window
7198
c24da6d6
RD
7199 Return the *main* top level window (if it hadn't been set previously
7200 with SetTopWindow(), will return just some top level window and, if
7201 there not any, will return None)
d55e5bfc
RD
7202 """
7203 return _core_.PyApp_GetTopWindow(*args, **kwargs)
7204
7205 def SetExitOnFrameDelete(*args, **kwargs):
7206 """
7207 SetExitOnFrameDelete(self, bool flag)
7208
c24da6d6
RD
7209 Control the exit behaviour: by default, the program will exit the main
7210 loop (and so, usually, terminate) when the last top-level program
7211 window is deleted. Beware that if you disable this behaviour (with
7212 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
7213 explicitly from somewhere.
d55e5bfc
RD
7214 """
7215 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
7216
7217 def GetExitOnFrameDelete(*args, **kwargs):
7218 """
7219 GetExitOnFrameDelete(self) -> bool
7220
7221 Get the current exit behaviour setting.
7222 """
7223 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
7224
7225 def SetUseBestVisual(*args, **kwargs):
7226 """
7227 SetUseBestVisual(self, bool flag)
7228
c24da6d6
RD
7229 Set whether the app should try to use the best available visual on
7230 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
7231 """
7232 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
7233
7234 def GetUseBestVisual(*args, **kwargs):
7235 """
7236 GetUseBestVisual(self) -> bool
7237
7238 Get current UseBestVisual setting.
7239 """
7240 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
7241
7242 def SetPrintMode(*args, **kwargs):
7243 """SetPrintMode(self, int mode)"""
7244 return _core_.PyApp_SetPrintMode(*args, **kwargs)
7245
7246 def GetPrintMode(*args, **kwargs):
7247 """GetPrintMode(self) -> int"""
7248 return _core_.PyApp_GetPrintMode(*args, **kwargs)
7249
7250 def SetAssertMode(*args, **kwargs):
7251 """
7252 SetAssertMode(self, int mode)
7253
79fccf9d 7254 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
7255 """
7256 return _core_.PyApp_SetAssertMode(*args, **kwargs)
7257
7258 def GetAssertMode(*args, **kwargs):
7259 """
7260 GetAssertMode(self) -> int
7261
7262 Get the current OnAssert behaviour setting.
7263 """
7264 return _core_.PyApp_GetAssertMode(*args, **kwargs)
7265
7266 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7267 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
7268 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7269
7270 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
7271 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7272 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
7273 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7274
7275 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
7276 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7277 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
7278 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7279
7280 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
7281 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7282 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
7283 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7284
7285 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
7286 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7287 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
7288 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7289
7290 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
7291 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 7292 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
7293 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7294
7295 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
7296 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 7297 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
7298 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7299
7300 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
7301 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 7302 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
7303 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7304
7305 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
7306 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 7307 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
7308 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7309
7310 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
7311 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 7312 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
7313 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7314
7315 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
7316 def _BootstrapApp(*args, **kwargs):
7317 """
7318 _BootstrapApp(self)
7319
7320 For internal use only
7321 """
7322 return _core_.PyApp__BootstrapApp(*args, **kwargs)
7323
7324 def GetComCtl32Version(*args, **kwargs):
7325 """
c24da6d6 7326 GetComCtl32Version() -> int
d55e5bfc 7327
c24da6d6
RD
7328 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7329 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
7330 """
7331 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7332
7333 GetComCtl32Version = staticmethod(GetComCtl32Version)
7334
7335class PyAppPtr(PyApp):
7336 def __init__(self, this):
7337 self.this = this
7338 if not hasattr(self,"thisown"): self.thisown = 0
7339 self.__class__ = PyApp
7340_core_.PyApp_swigregister(PyAppPtr)
7341
84f85550
RD
7342def PyApp_IsMainLoopRunning(*args, **kwargs):
7343 """
7344 PyApp_IsMainLoopRunning() -> bool
7345
7346 Returns True if we're running the main loop, i.e. if the events can
7347 currently be dispatched.
7348 """
7349 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
7350
d55e5bfc
RD
7351def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
7352 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
7353 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
7354
7355def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
7356 """PyApp_GetMacAboutMenuItemId() -> long"""
7357 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
7358
7359def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
7360 """PyApp_GetMacPreferencesMenuItemId() -> long"""
7361 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
7362
7363def PyApp_GetMacExitMenuItemId(*args, **kwargs):
7364 """PyApp_GetMacExitMenuItemId() -> long"""
7365 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
7366
7367def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
7368 """PyApp_GetMacHelpMenuTitleName() -> String"""
7369 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
7370
7371def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
7372 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
7373 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
7374
7375def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
7376 """PyApp_SetMacAboutMenuItemId(long val)"""
7377 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
7378
7379def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
7380 """PyApp_SetMacPreferencesMenuItemId(long val)"""
7381 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
7382
7383def PyApp_SetMacExitMenuItemId(*args, **kwargs):
7384 """PyApp_SetMacExitMenuItemId(long val)"""
7385 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
7386
7387def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
7388 """PyApp_SetMacHelpMenuTitleName(String val)"""
7389 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
7390
7391def PyApp_GetComCtl32Version(*args, **kwargs):
7392 """
7393 PyApp_GetComCtl32Version() -> int
7394
c24da6d6
RD
7395 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
7396 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
7397 """
7398 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
7399
7400#---------------------------------------------------------------------------
7401
7402
7403def Exit(*args, **kwargs):
7404 """
7405 Exit()
7406
7407 Force an exit of the application. Convenience for wx.GetApp().Exit()
7408 """
7409 return _core_.Exit(*args, **kwargs)
7410
7411def Yield(*args, **kwargs):
7412 """
7413 Yield() -> bool
7414
7415 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
7416 """
7417 return _core_.Yield(*args, **kwargs)
7418
7419def YieldIfNeeded(*args, **kwargs):
7420 """
7421 YieldIfNeeded() -> bool
7422
7423 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
7424 """
7425 return _core_.YieldIfNeeded(*args, **kwargs)
7426
7427def SafeYield(*args, **kwargs):
7428 """
7429 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
7430
c24da6d6
RD
7431 This function is similar to `wx.Yield`, except that it disables the
7432 user input to all program windows before calling `wx.Yield` and
7433 re-enables it again afterwards. If ``win`` is not None, this window
7434 will remain enabled, allowing the implementation of some limited user
7435 interaction.
d55e5bfc 7436
c24da6d6 7437 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
7438 """
7439 return _core_.SafeYield(*args, **kwargs)
7440
7441def WakeUpIdle(*args, **kwargs):
7442 """
7443 WakeUpIdle()
7444
c24da6d6
RD
7445 Cause the message queue to become empty again, so idle events will be
7446 sent.
d55e5bfc
RD
7447 """
7448 return _core_.WakeUpIdle(*args, **kwargs)
7449
7450def PostEvent(*args, **kwargs):
7451 """
7452 PostEvent(EvtHandler dest, Event event)
7453
c24da6d6
RD
7454 Send an event to a window or other wx.EvtHandler to be processed
7455 later.
d55e5bfc
RD
7456 """
7457 return _core_.PostEvent(*args, **kwargs)
7458
7459def App_CleanUp(*args, **kwargs):
7460 """
7461 App_CleanUp()
7462
79fccf9d 7463 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 7464 Python shuts down.
d55e5bfc
RD
7465 """
7466 return _core_.App_CleanUp(*args, **kwargs)
7467
7468def GetApp(*args, **kwargs):
7469 """
7470 GetApp() -> PyApp
7471
7472 Return a reference to the current wx.App object.
7473 """
7474 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD
7475
7476def SetDefaultPyEncoding(*args, **kwargs):
7477 """
7478 SetDefaultPyEncoding(string encoding)
7479
7480 Sets the encoding that wxPython will use when it needs to convert a
7481 Python string or unicode object to or from a wxString.
62d32a5f
RD
7482
7483 The default encoding is the value of ``locale.getdefaultlocale()[1]``
7484 but please be aware that the default encoding within the same locale
7485 may be slightly different on different platforms. For example, please
7486 see http://www.alanwood.net/demos/charsetdiffs.html for differences
7487 between the common latin/roman encodings.
5cbf236d
RD
7488 """
7489 return _core_.SetDefaultPyEncoding(*args, **kwargs)
7490
7491def GetDefaultPyEncoding(*args, **kwargs):
7492 """
7493 GetDefaultPyEncoding() -> string
7494
7495 Gets the current encoding that wxPython will use when it needs to
7496 convert a Python string or unicode object to or from a wxString.
7497 """
7498 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d55e5bfc
RD
7499#----------------------------------------------------------------------
7500
7501class PyOnDemandOutputWindow:
7502 """
7503 A class that can be used for redirecting Python's stdout and
7504 stderr streams. It will do nothing until something is wrriten to
7505 the stream at which point it will create a Frame with a text area
7506 and write the text there.
7507 """
7508 def __init__(self, title = "wxPython: stdout/stderr"):
7509 self.frame = None
7510 self.title = title
412d302d
RD
7511 self.pos = wx.DefaultPosition
7512 self.size = (450, 300)
d55e5bfc
RD
7513 self.parent = None
7514
7515 def SetParent(self, parent):
7516 """Set the window to be used as the popup Frame's parent."""
7517 self.parent = parent
7518
7519
7520 def CreateOutputWindow(self, st):
412d302d
RD
7521 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
7522 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 7523 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 7524 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 7525 self.text.AppendText(st)
d55e5bfc
RD
7526 self.frame.Show(True)
7527 EVT_CLOSE(self.frame, self.OnCloseWindow)
7528
7529
7530 def OnCloseWindow(self, event):
7531 if self.frame is not None:
7532 self.frame.Destroy()
7533 self.frame = None
7534 self.text = None
7535
7536
7537 # These methods provide the file-like output behaviour.
7538 def write(self, text):
7539 """
7540 Create the output window if needed and write the string to it.
7541 If not called in the context of the gui thread then uses
7542 CallAfter to do the work there.
7543 """
7544 if self.frame is None:
7545 if not wx.Thread_IsMain():
7546 wx.CallAfter(self.CreateOutputWindow, text)
7547 else:
7548 self.CreateOutputWindow(text)
7549 else:
7550 if not wx.Thread_IsMain():
7551 wx.CallAfter(self.text.AppendText, text)
7552 else:
7553 self.text.AppendText(text)
7554
7555
7556 def close(self):
7557 if self.frame is not None:
7558 wx.CallAfter(self.frame.Close)
7559
7560
19272049
RD
7561 def flush(self):
7562 pass
7563
7564
d55e5bfc
RD
7565
7566#----------------------------------------------------------------------
7567
7568_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
7569
7570class App(wx.PyApp):
7571 """
c24da6d6
RD
7572 The ``wx.App`` class represents the application and is used to:
7573
7574 * bootstrap the wxPython system and initialize the underlying
7575 gui toolkit
7576 * set and get application-wide properties
7577 * implement the windowing system main message or event loop,
7578 and to dispatch events to window instances
7579 * etc.
7580
7581 Every application must have a ``wx.App`` instance, and all
7582 creation of UI objects should be delayed until after the
7583 ``wx.App`` object has been created in order to ensure that the gui
7584 platform and wxWidgets have been fully initialized.
7585
7586 Normally you would derive from this class and implement an
7587 ``OnInit`` method that creates a frame and then calls
7588 ``self.SetTopWindow(frame)``.
7589
7590 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 7591 directly.
d55e5bfc 7592 """
c24da6d6 7593
d55e5bfc
RD
7594 outputWindowClass = PyOnDemandOutputWindow
7595
c24da6d6
RD
7596 def __init__(self, redirect=_defRedirect, filename=None,
7597 useBestVisual=False, clearSigInt=True):
7598 """
7599 Construct a ``wx.App`` object.
7600
7601 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
7602 redirected? Defaults to True on Windows and Mac, False
7603 otherwise. If `filename` is None then output will be
7604 redirected to a window that pops up as needed. (You can
7605 control what kind of window is created for the output by
7606 resetting the class variable ``outputWindowClass`` to a
7607 class of your choosing.)
7608
7609 :param filename: The name of a file to redirect output to, if
7610 redirect is True.
7611
7612 :param useBestVisual: Should the app try to use the best
7613 available visual provided by the system (only relevant on
7614 systems that have more than one visual.) This parameter
7615 must be used instead of calling `SetUseBestVisual` later
7616 on because it must be set before the underlying GUI
7617 toolkit is initialized.
7618
7619 :param clearSigInt: Should SIGINT be cleared? This allows the
7620 app to terminate upon a Ctrl-C in the console like other
7621 GUI apps will.
7622
7623 :note: You should override OnInit to do applicaition
7624 initialization to ensure that the system, toolkit and
7625 wxWidgets are fully initialized.
7626 """
d55e5bfc
RD
7627 wx.PyApp.__init__(self)
7628
7629 if wx.Platform == "__WXMAC__":
7630 try:
7631 import MacOS
7632 if not MacOS.WMAvailable():
7633 print """\
7634This program needs access to the screen. Please run with 'pythonw',
7635not 'python', and only when you are logged in on the main display of
7636your Mac."""
7637 _sys.exit(1)
b1f29bf7
RD
7638 except SystemExit:
7639 raise
d55e5bfc
RD
7640 except:
7641 pass
7642
7643 # This has to be done before OnInit
7644 self.SetUseBestVisual(useBestVisual)
7645
7646 # Set the default handler for SIGINT. This fixes a problem
7647 # where if Ctrl-C is pressed in the console that started this
7648 # app then it will not appear to do anything, (not even send
7649 # KeyboardInterrupt???) but will later segfault on exit. By
7650 # setting the default handler then the app will exit, as
7651 # expected (depending on platform.)
c24da6d6
RD
7652 if clearSigInt:
7653 try:
7654 import signal
7655 signal.signal(signal.SIGINT, signal.SIG_DFL)
7656 except:
7657 pass
d55e5bfc
RD
7658
7659 # Save and redirect the stdio to a window?
7660 self.stdioWin = None
7661 self.saveStdio = (_sys.stdout, _sys.stderr)
7662 if redirect:
7663 self.RedirectStdio(filename)
7664
8fb0e70a
RD
7665 # Use Python's install prefix as the default
7666 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
7667
d55e5bfc
RD
7668 # This finishes the initialization of wxWindows and then calls
7669 # the OnInit that should be present in the derived class
7670 self._BootstrapApp()
7671
7672
66af7a75
RD
7673 def __del__(self, destroy=wx.PyApp.__del__):
7674 self.RestoreStdio() # Just in case the MainLoop was overridden
7675 destroy(self)
d55e5bfc 7676
70b7a5fe
RD
7677 def Destroy(self):
7678 wx.PyApp.Destroy(self)
7679 self.thisown = 0
d55e5bfc
RD
7680
7681 def SetTopWindow(self, frame):
7682 """Set the \"main\" top level window"""
7683 if self.stdioWin:
7684 self.stdioWin.SetParent(frame)
7685 wx.PyApp.SetTopWindow(self, frame)
7686
7687
7688 def MainLoop(self):
7689 """Execute the main GUI event loop"""
7690 wx.PyApp.MainLoop(self)
7691 self.RestoreStdio()
7692
7693
7694 def RedirectStdio(self, filename=None):
7695 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
7696 if filename:
7697 _sys.stdout = _sys.stderr = open(filename, 'a')
7698 else:
7699 self.stdioWin = self.outputWindowClass()
7700 _sys.stdout = _sys.stderr = self.stdioWin
7701
7702
7703 def RestoreStdio(self):
66af7a75
RD
7704 try:
7705 _sys.stdout, _sys.stderr = self.saveStdio
7706 except:
7707 pass
d55e5bfc
RD
7708
7709
412d302d
RD
7710 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
7711 """
7712 Set the title, position and/or size of the output window if
f5b96ee1
RD
7713 the stdio has been redirected. This should be called before
7714 any output would cause the output window to be created.
412d302d
RD
7715 """
7716 if self.stdioWin:
7717 if title is not None:
7718 self.stdioWin.title = title
7719 if pos is not None:
7720 self.stdioWin.pos = pos
7721 if size is not None:
7722 self.stdioWin.size = size
7723
7724
7725
d55e5bfc 7726
c24da6d6 7727# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
7728App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
7729App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
7730App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
7731App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
7732App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
7733App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
7734App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
7735App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
7736App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
7737App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
7738App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
7739
7740#----------------------------------------------------------------------------
7741
7742class PySimpleApp(wx.App):
7743 """
7744 A simple application class. You can just create one of these and
7745 then then make your top level windows later, and not have to worry
c24da6d6 7746 about OnInit. For example::
d55e5bfc 7747
c24da6d6
RD
7748 app = wx.PySimpleApp()
7749 frame = wx.Frame(None, title='Hello World')
7750 frame.Show()
7751 app.MainLoop()
7752
7753 :see: `wx.App`
7754 """
7755
7756 def __init__(self, redirect=False, filename=None,
7757 useBestVisual=False, clearSigInt=True):
7758 """
7759 :see: `wx.App.__init__`
7760 """
7761 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
7762
7763 def OnInit(self):
d55e5bfc
RD
7764 return True
7765
7766
c24da6d6 7767
d55e5bfc
RD
7768# Is anybody using this one?
7769class PyWidgetTester(wx.App):
7770 def __init__(self, size = (250, 100)):
7771 self.size = size
7772 wx.App.__init__(self, 0)
7773
7774 def OnInit(self):
7775 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
7776 self.SetTopWindow(self.frame)
7777 return True
7778
c24da6d6
RD
7779 def SetWidget(self, widgetClass, *args, **kwargs):
7780 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
7781 self.frame.Show(True)
7782
7783#----------------------------------------------------------------------------
7784# DO NOT hold any other references to this object. This is how we
c24da6d6 7785# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 7786# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 7787# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
7788
7789class __wxPyCleanup:
7790 def __init__(self):
7791 self.cleanup = _core_.App_CleanUp
7792 def __del__(self):
7793 self.cleanup()
7794
7795_sys.__wxPythonCleanup = __wxPyCleanup()
7796
7797## # another possible solution, but it gets called too early...
c24da6d6
RD
7798## import atexit
7799## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
7800
7801
7802#----------------------------------------------------------------------------
7803
7804#---------------------------------------------------------------------------
7805
ae8162c8 7806class EventLoop(object):
093d3ff1 7807 """Proxy of C++ EventLoop class"""
ae8162c8
RD
7808 def __repr__(self):
7809 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7810 def __init__(self, *args, **kwargs):
7811 """__init__(self) -> EventLoop"""
7812 newobj = _core_.new_EventLoop(*args, **kwargs)
7813 self.this = newobj.this
7814 self.thisown = 1
7815 del newobj.thisown
7816 def __del__(self, destroy=_core_.delete_EventLoop):
7817 """__del__(self)"""
7818 try:
7819 if self.thisown: destroy(self)
7820 except: pass
7821
7822 def Run(*args, **kwargs):
7823 """Run(self) -> int"""
7824 return _core_.EventLoop_Run(*args, **kwargs)
7825
7826 def Exit(*args, **kwargs):
7827 """Exit(self, int rc=0)"""
7828 return _core_.EventLoop_Exit(*args, **kwargs)
7829
7830 def Pending(*args, **kwargs):
7831 """Pending(self) -> bool"""
7832 return _core_.EventLoop_Pending(*args, **kwargs)
7833
7834 def Dispatch(*args, **kwargs):
7835 """Dispatch(self) -> bool"""
7836 return _core_.EventLoop_Dispatch(*args, **kwargs)
7837
7838 def IsRunning(*args, **kwargs):
7839 """IsRunning(self) -> bool"""
7840 return _core_.EventLoop_IsRunning(*args, **kwargs)
7841
7842 def GetActive(*args, **kwargs):
7843 """GetActive() -> EventLoop"""
7844 return _core_.EventLoop_GetActive(*args, **kwargs)
7845
7846 GetActive = staticmethod(GetActive)
7847 def SetActive(*args, **kwargs):
7848 """SetActive(EventLoop loop)"""
7849 return _core_.EventLoop_SetActive(*args, **kwargs)
7850
7851 SetActive = staticmethod(SetActive)
7852
7853class EventLoopPtr(EventLoop):
7854 def __init__(self, this):
7855 self.this = this
7856 if not hasattr(self,"thisown"): self.thisown = 0
7857 self.__class__ = EventLoop
7858_core_.EventLoop_swigregister(EventLoopPtr)
7859
7860def EventLoop_GetActive(*args, **kwargs):
7861 """EventLoop_GetActive() -> EventLoop"""
7862 return _core_.EventLoop_GetActive(*args, **kwargs)
7863
7864def EventLoop_SetActive(*args, **kwargs):
7865 """EventLoop_SetActive(EventLoop loop)"""
7866 return _core_.EventLoop_SetActive(*args, **kwargs)
7867
7868#---------------------------------------------------------------------------
7869
d55e5bfc 7870class AcceleratorEntry(object):
c24da6d6
RD
7871 """
7872 A class used to define items in an `wx.AcceleratorTable`. wxPython
7873 programs can choose to use wx.AcceleratorEntry objects, but using a
7874 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 7875 as well. See `__init__` for of the tuple values.
c24da6d6
RD
7876
7877 :see: `wx.AcceleratorTable`
7878 """
d55e5bfc
RD
7879 def __repr__(self):
7880 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7881 def __init__(self, *args, **kwargs):
c24da6d6
RD
7882 """
7883 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
7884
7885 Construct a wx.AcceleratorEntry.
c24da6d6 7886 """
d55e5bfc
RD
7887 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
7888 self.this = newobj.this
7889 self.thisown = 1
7890 del newobj.thisown
7891 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
7892 """__del__(self)"""
7893 try:
7894 if self.thisown: destroy(self)
7895 except: pass
7896
7897 def Set(*args, **kwargs):
c24da6d6
RD
7898 """
7899 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 7900
c24da6d6
RD
7901 (Re)set the attributes of a wx.AcceleratorEntry.
7902 :see `__init__`
7903 """
7904 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
7905
7906 def GetFlags(*args, **kwargs):
c24da6d6
RD
7907 """
7908 GetFlags(self) -> int
7909
7910 Get the AcceleratorEntry's flags.
7911 """
d55e5bfc
RD
7912 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
7913
7914 def GetKeyCode(*args, **kwargs):
c24da6d6
RD
7915 """
7916 GetKeyCode(self) -> int
7917
7918 Get the AcceleratorEntry's keycode.
7919 """
d55e5bfc
RD
7920 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
7921
7922 def GetCommand(*args, **kwargs):
c24da6d6
RD
7923 """
7924 GetCommand(self) -> int
7925
7926 Get the AcceleratorEntry's command ID.
7927 """
d55e5bfc
RD
7928 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
7929
7930
7931class AcceleratorEntryPtr(AcceleratorEntry):
7932 def __init__(self, this):
7933 self.this = this
7934 if not hasattr(self,"thisown"): self.thisown = 0
7935 self.__class__ = AcceleratorEntry
7936_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
7937
7938class AcceleratorTable(Object):
c24da6d6
RD
7939 """
7940 An accelerator table allows the application to specify a table of
7941 keyboard shortcuts for menus or other commands. On Windows, menu or
7942 button commands are supported; on GTK, only menu commands are
7943 supported.
c24da6d6 7944 """
d55e5bfc
RD
7945 def __repr__(self):
7946 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7947 def __init__(self, *args, **kwargs):
7948 """
7949 __init__(entries) -> AcceleratorTable
7950
c24da6d6
RD
7951 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
7952 items or or of 3-tuples (flags, keyCode, cmdID)
7953
7954 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
7955 """
7956 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
7957 self.this = newobj.this
7958 self.thisown = 1
7959 del newobj.thisown
7960 def __del__(self, destroy=_core_.delete_AcceleratorTable):
7961 """__del__(self)"""
7962 try:
7963 if self.thisown: destroy(self)
7964 except: pass
7965
7966 def Ok(*args, **kwargs):
7967 """Ok(self) -> bool"""
7968 return _core_.AcceleratorTable_Ok(*args, **kwargs)
7969
7970
7971class AcceleratorTablePtr(AcceleratorTable):
7972 def __init__(self, this):
7973 self.this = this
7974 if not hasattr(self,"thisown"): self.thisown = 0
7975 self.__class__ = AcceleratorTable
7976_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
7977
7978
7979def GetAccelFromString(*args, **kwargs):
7980 """GetAccelFromString(String label) -> AcceleratorEntry"""
7981 return _core_.GetAccelFromString(*args, **kwargs)
7982#---------------------------------------------------------------------------
7983
7984class VisualAttributes(object):
7985 """struct containing all the visual attributes of a control"""
7986 def __repr__(self):
7987 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7988 def __init__(self, *args, **kwargs):
7989 """
7990 __init__(self) -> VisualAttributes
7991
7992 struct containing all the visual attributes of a control
7993 """
7994 newobj = _core_.new_VisualAttributes(*args, **kwargs)
7995 self.this = newobj.this
7996 self.thisown = 1
7997 del newobj.thisown
7998 def __del__(self, destroy=_core_.delete_VisualAttributes):
7999 """__del__(self)"""
8000 try:
8001 if self.thisown: destroy(self)
8002 except: pass
8003
8004 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
8005 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
8006 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
8007
8008class VisualAttributesPtr(VisualAttributes):
8009 def __init__(self, this):
8010 self.this = this
8011 if not hasattr(self,"thisown"): self.thisown = 0
8012 self.__class__ = VisualAttributes
8013_core_.VisualAttributes_swigregister(VisualAttributesPtr)
8014NullAcceleratorTable = cvar.NullAcceleratorTable
8015PanelNameStr = cvar.PanelNameStr
8016
8017WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
8018WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
8019WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
8020WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
8021WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
8022class Window(EvtHandler):
8023 """
8024 wx.Window is the base class for all windows and represents any visible
8025 object on the screen. All controls, top level windows and so on are
8026 wx.Windows. Sizers and device contexts are not however, as they don't
8027 appear on screen themselves.
8028
8029 """
8030 def __repr__(self):
8031 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8032 def __init__(self, *args, **kwargs):
8033 """
8034 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8035 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
8036
8037 Construct and show a generic Window.
8038 """
8039 newobj = _core_.new_Window(*args, **kwargs)
8040 self.this = newobj.this
8041 self.thisown = 1
8042 del newobj.thisown
8043 self._setOORInfo(self)
8044
8045 def Create(*args, **kwargs):
8046 """
8047 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8048 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
8049
8050 Create the GUI part of the Window for 2-phase creation mode.
8051 """
8052 return _core_.Window_Create(*args, **kwargs)
8053
8054 def Close(*args, **kwargs):
8055 """
8056 Close(self, bool force=False) -> bool
8057
8058 This function simply generates a EVT_CLOSE event whose handler usually
8059 tries to close the window. It doesn't close the window itself,
8060 however. If force is False (the default) then the window's close
8061 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
8062 """
8063 return _core_.Window_Close(*args, **kwargs)
8064
8065 def Destroy(*args, **kwargs):
8066 """
8067 Destroy(self) -> bool
8068
8069 Destroys the window safely. Frames and dialogs are not destroyed
8070 immediately when this function is called -- they are added to a list
8071 of windows to be deleted on idle time, when all the window's events
8072 have been processed. This prevents problems with events being sent to
8073 non-existent windows.
8074
8075 Returns True if the window has either been successfully deleted, or it
8076 has been added to the list of windows pending real deletion.
8077 """
8078 return _core_.Window_Destroy(*args, **kwargs)
8079
8080 def DestroyChildren(*args, **kwargs):
8081 """
8082 DestroyChildren(self) -> bool
8083
79fccf9d
RD
8084 Destroys all children of a window. Called automatically by the
8085 destructor.
d55e5bfc
RD
8086 """
8087 return _core_.Window_DestroyChildren(*args, **kwargs)
8088
8089 def IsBeingDeleted(*args, **kwargs):
8090 """
8091 IsBeingDeleted(self) -> bool
8092
8093 Is the window in the process of being deleted?
8094 """
8095 return _core_.Window_IsBeingDeleted(*args, **kwargs)
8096
d55e5bfc
RD
8097 def SetLabel(*args, **kwargs):
8098 """
8099 SetLabel(self, String label)
8100
8101 Set the text which the window shows in its label if applicable.
8102 """
8103 return _core_.Window_SetLabel(*args, **kwargs)
8104
8105 def GetLabel(*args, **kwargs):
8106 """
8107 GetLabel(self) -> String
8108
79fccf9d
RD
8109 Generic way of getting a label from any window, for identification
8110 purposes. The interpretation of this function differs from class to
8111 class. For frames and dialogs, the value returned is the title. For
8112 buttons or static text controls, it is the button text. This function
8113 can be useful for meta-programs such as testing tools or special-needs
8114 access programs)which need to identify windows by name.
d55e5bfc
RD
8115 """
8116 return _core_.Window_GetLabel(*args, **kwargs)
8117
8118 def SetName(*args, **kwargs):
8119 """
8120 SetName(self, String name)
8121
79fccf9d
RD
8122 Sets the window's name. The window name is used for ressource setting
8123 in X, it is not the same as the window title/label
d55e5bfc
RD
8124 """
8125 return _core_.Window_SetName(*args, **kwargs)
8126
8127 def GetName(*args, **kwargs):
8128 """
8129 GetName(self) -> String
8130
79fccf9d
RD
8131 Returns the windows name. This name is not guaranteed to be unique;
8132 it is up to the programmer to supply an appropriate name in the window
8133 constructor or via wx.Window.SetName.
d55e5bfc
RD
8134 """
8135 return _core_.Window_GetName(*args, **kwargs)
8136
8137 def SetWindowVariant(*args, **kwargs):
8138 """
8139 SetWindowVariant(self, int variant)
8140
79fccf9d
RD
8141 Sets the variant of the window/font size to use for this window, if
8142 the platform supports variants, for example, wxMac.
d55e5bfc
RD
8143 """
8144 return _core_.Window_SetWindowVariant(*args, **kwargs)
8145
8146 def GetWindowVariant(*args, **kwargs):
8147 """GetWindowVariant(self) -> int"""
8148 return _core_.Window_GetWindowVariant(*args, **kwargs)
8149
8150 def SetId(*args, **kwargs):
8151 """
8152 SetId(self, int winid)
8153
8154 Sets the identifier of the window. Each window has an integer
8155 identifier. If the application has not provided one, an identifier
8156 will be generated. Normally, the identifier should be provided on
8157 creation and should not be modified subsequently.
8158 """
8159 return _core_.Window_SetId(*args, **kwargs)
8160
8161 def GetId(*args, **kwargs):
8162 """
8163 GetId(self) -> int
8164
8165 Returns the identifier of the window. Each window has an integer
8166 identifier. If the application has not provided one (or the default Id
8167 -1 is used) then an unique identifier with a negative value will be
8168 generated.
8169 """
8170 return _core_.Window_GetId(*args, **kwargs)
8171
8172 def NewControlId(*args, **kwargs):
8173 """
c24da6d6 8174 NewControlId() -> int
d55e5bfc
RD
8175
8176 Generate a control id for the controls which were not given one.
8177 """
8178 return _core_.Window_NewControlId(*args, **kwargs)
8179
8180 NewControlId = staticmethod(NewControlId)
8181 def NextControlId(*args, **kwargs):
8182 """
c24da6d6 8183 NextControlId(int winid) -> int
d55e5bfc
RD
8184
8185 Get the id of the control following the one with the given
79fccf9d 8186 autogenerated) id
d55e5bfc
RD
8187 """
8188 return _core_.Window_NextControlId(*args, **kwargs)
8189
8190 NextControlId = staticmethod(NextControlId)
8191 def PrevControlId(*args, **kwargs):
8192 """
c24da6d6 8193 PrevControlId(int winid) -> int
d55e5bfc
RD
8194
8195 Get the id of the control preceding the one with the given
79fccf9d 8196 autogenerated) id
d55e5bfc
RD
8197 """
8198 return _core_.Window_PrevControlId(*args, **kwargs)
8199
8200 PrevControlId = staticmethod(PrevControlId)
8201 def SetSize(*args, **kwargs):
8202 """
8203 SetSize(self, Size size)
8204
8205 Sets the size of the window in pixels.
8206 """
8207 return _core_.Window_SetSize(*args, **kwargs)
8208
8209 def SetDimensions(*args, **kwargs):
8210 """
8211 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
8212
8213 Sets the position and size of the window in pixels. The sizeFlags
8214 parameter indicates the interpretation of the other params if they are
62d32a5f
RD
8215 equal to -1.
8216
8217 ======================== ======================================
8218 wx.SIZE_AUTO A -1 indicates that a class-specific
8219 default should be used.
8220 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
8221 -1 values are supplied.
8222 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
8223 interpreted as real dimensions, not
8224 default values.
8225 ======================== ======================================
8226
d55e5bfc
RD
8227 """
8228 return _core_.Window_SetDimensions(*args, **kwargs)
8229
8230 def SetRect(*args, **kwargs):
8231 """
8232 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
8233
8234 Sets the position and size of the window in pixels using a wx.Rect.
8235 """
8236 return _core_.Window_SetRect(*args, **kwargs)
8237
8238 def SetSizeWH(*args, **kwargs):
8239 """
8240 SetSizeWH(self, int width, int height)
8241
8242 Sets the size of the window in pixels.
8243 """
8244 return _core_.Window_SetSizeWH(*args, **kwargs)
8245
8246 def Move(*args, **kwargs):
8247 """
8248 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
8249
8250 Moves the window to the given position.
8251 """
8252 return _core_.Window_Move(*args, **kwargs)
8253
8254 SetPosition = Move
8255 def MoveXY(*args, **kwargs):
8256 """
8257 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
8258
8259 Moves the window to the given position.
8260 """
8261 return _core_.Window_MoveXY(*args, **kwargs)
8262
f8167d6e
RD
8263 def SetBestFittingSize(*args, **kwargs):
8264 """
8265 SetBestFittingSize(self, Size size=DefaultSize)
8266
8267 A 'Smart' SetSize that will fill in default size components with the
8268 window's *best size* values. Also set's the minsize for use with sizers.
8269 """
8270 return _core_.Window_SetBestFittingSize(*args, **kwargs)
8271
d55e5bfc
RD
8272 def Raise(*args, **kwargs):
8273 """
8274 Raise(self)
8275
9d7dfdff
RD
8276 Raises the window to the top of the window hierarchy. In current
8277 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD
8278 """
8279 return _core_.Window_Raise(*args, **kwargs)
8280
8281 def Lower(*args, **kwargs):
8282 """
8283 Lower(self)
8284
9d7dfdff
RD
8285 Lowers the window to the bottom of the window hierarchy. In current
8286 version of wxWidgets this works both for manage and child windows.
d55e5bfc
RD
8287 """
8288 return _core_.Window_Lower(*args, **kwargs)
8289
8290 def SetClientSize(*args, **kwargs):
8291 """
8292 SetClientSize(self, Size size)
8293
8294 This sets the size of the window client area in pixels. Using this
8295 function to size a window tends to be more device-independent than
8296 wx.Window.SetSize, since the application need not worry about what
8297 dimensions the border or title bar have when trying to fit the window
8298 around panel items, for example.
8299 """
8300 return _core_.Window_SetClientSize(*args, **kwargs)
8301
8302 def SetClientSizeWH(*args, **kwargs):
8303 """
8304 SetClientSizeWH(self, int width, int height)
8305
8306 This sets the size of the window client area in pixels. Using this
8307 function to size a window tends to be more device-independent than
8308 wx.Window.SetSize, since the application need not worry about what
8309 dimensions the border or title bar have when trying to fit the window
8310 around panel items, for example.
8311 """
8312 return _core_.Window_SetClientSizeWH(*args, **kwargs)
8313
8314 def SetClientRect(*args, **kwargs):
8315 """
8316 SetClientRect(self, Rect rect)
8317
8318 This sets the size of the window client area in pixels. Using this
8319 function to size a window tends to be more device-independent than
8320 wx.Window.SetSize, since the application need not worry about what
8321 dimensions the border or title bar have when trying to fit the window
8322 around panel items, for example.
8323 """
8324 return _core_.Window_SetClientRect(*args, **kwargs)
8325
8326 def GetPosition(*args, **kwargs):
8327 """
8328 GetPosition(self) -> Point
8329
8330 Get the window's position.
8331 """
8332 return _core_.Window_GetPosition(*args, **kwargs)
8333
8334 def GetPositionTuple(*args, **kwargs):
8335 """
8336 GetPositionTuple() -> (x,y)
8337
8338 Get the window's position.
8339 """
8340 return _core_.Window_GetPositionTuple(*args, **kwargs)
8341
8342 def GetSize(*args, **kwargs):
8343 """
8344 GetSize(self) -> Size
8345
8346 Get the window size.
8347 """
8348 return _core_.Window_GetSize(*args, **kwargs)
8349
8350 def GetSizeTuple(*args, **kwargs):
8351 """
8352 GetSizeTuple() -> (width, height)
8353
8354 Get the window size.
8355 """
8356 return _core_.Window_GetSizeTuple(*args, **kwargs)
8357
8358 def GetRect(*args, **kwargs):
8359 """
8360 GetRect(self) -> Rect
8361
8362 Returns the size and position of the window as a wx.Rect object.
8363 """
8364 return _core_.Window_GetRect(*args, **kwargs)
8365
8366 def GetClientSize(*args, **kwargs):
8367 """
8368 GetClientSize(self) -> Size
8369
8370 This gets the size of the window's 'client area' in pixels. The client
8371 area is the area which may be drawn on by the programmer, excluding
8372 title bar, border, scrollbars, etc.
8373 """
8374 return _core_.Window_GetClientSize(*args, **kwargs)
8375
8376 def GetClientSizeTuple(*args, **kwargs):
8377 """
8378 GetClientSizeTuple() -> (width, height)
8379
8380 This gets the size of the window's 'client area' in pixels. The client
8381 area is the area which may be drawn on by the programmer, excluding
8382 title bar, border, scrollbars, etc.
8383 """
8384 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
8385
8386 def GetClientAreaOrigin(*args, **kwargs):
8387 """
8388 GetClientAreaOrigin(self) -> Point
8389
8390 Get the origin of the client area of the window relative to the
8391 window's top left corner (the client area may be shifted because of
8392 the borders, scrollbars, other decorations...)
8393 """
8394 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
8395
8396 def GetClientRect(*args, **kwargs):
8397 """
8398 GetClientRect(self) -> Rect
8399
629f3c1b 8400 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
8401 """
8402 return _core_.Window_GetClientRect(*args, **kwargs)
8403
8404 def GetBestSize(*args, **kwargs):
8405 """
8406 GetBestSize(self) -> Size
8407
248ed943 8408 This function returns the best acceptable minimal size for the
79fccf9d
RD
8409 window, if applicable. For example, for a static text control, it will
8410 be the minimal size such that the control label is not truncated. For
8411 windows containing subwindows (suzh aswx.Panel), the size returned by
8412 this function will be the same as the size the window would have had
8413 after calling Fit.
d55e5bfc
RD
8414 """
8415 return _core_.Window_GetBestSize(*args, **kwargs)
8416
8417 def GetBestSizeTuple(*args, **kwargs):
8418 """
8419 GetBestSizeTuple() -> (width, height)
8420
248ed943 8421 This function returns the best acceptable minimal size for the
79fccf9d
RD
8422 window, if applicable. For example, for a static text control, it will
8423 be the minimal size such that the control label is not truncated. For
8424 windows containing subwindows (suzh aswx.Panel), the size returned by
8425 this function will be the same as the size the window would have had
8426 after calling Fit.
d55e5bfc
RD
8427 """
8428 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
8429
a001823c
RD
8430 def InvalidateBestSize(*args, **kwargs):
8431 """
8432 InvalidateBestSize(self)
8433
8434 Reset the cached best size value so it will be recalculated the next
8435 time it is needed.
8436 """
8437 return _core_.Window_InvalidateBestSize(*args, **kwargs)
8438
e2813725
RD
8439 def CacheBestSize(*args, **kwargs):
8440 """
8441 CacheBestSize(self, Size size)
8442
8443 Cache the best size so it doesn't need to be calculated again, (at least until
8444 some properties of the window change.)
8445 """
8446 return _core_.Window_CacheBestSize(*args, **kwargs)
8447
a001823c
RD
8448 def GetBestFittingSize(*args, **kwargs):
8449 """
8450 GetBestFittingSize(self) -> Size
8451
8452 This function will merge the window's best size into the window's
8453 minimum size, giving priority to the min size components, and returns
8454 the results.
8455
8456 """
8457 return _core_.Window_GetBestFittingSize(*args, **kwargs)
8458
d55e5bfc
RD
8459 def GetAdjustedBestSize(*args, **kwargs):
8460 """
8461 GetAdjustedBestSize(self) -> Size
8462
8463 This method is similar to GetBestSize, except in one
8464 thing. GetBestSize should return the minimum untruncated size of the
8465 window, while this method will return the largest of BestSize and any
8466 user specified minimum size. ie. it is the minimum size the window
8467 should currently be drawn at, not the minimal size it can possibly
8468 tolerate.
8469 """
8470 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
8471
8472 def Center(*args, **kwargs):
8473 """
8474 Center(self, int direction=BOTH)
8475
8476 Centers the window. The parameter specifies the direction for
8477 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
8478 also include wx.CENTER_ON_SCREEN flag if you want to center the window
8479 on the entire screen and not on its parent window. If it is a
8480 top-level window and has no parent then it will always be centered
8481 relative to the screen.
8482 """
8483 return _core_.Window_Center(*args, **kwargs)
8484
8485 Centre = Center
8486 def CenterOnScreen(*args, **kwargs):
8487 """
8488 CenterOnScreen(self, int dir=BOTH)
8489
8490 Center on screen (only works for top level windows)
8491 """
8492 return _core_.Window_CenterOnScreen(*args, **kwargs)
8493
8494 CentreOnScreen = CenterOnScreen
8495 def CenterOnParent(*args, **kwargs):
8496 """
8497 CenterOnParent(self, int dir=BOTH)
8498
8499 Center with respect to the the parent window
8500 """
8501 return _core_.Window_CenterOnParent(*args, **kwargs)
8502
8503 CentreOnParent = CenterOnParent
8504 def Fit(*args, **kwargs):
8505 """
8506 Fit(self)
8507
8508 Sizes the window so that it fits around its subwindows. This function
8509 won't do anything if there are no subwindows and will only really work
8510 correctly if sizers are used for the subwindows layout. Also, if the
8511 window has exactly one subwindow it is better (faster and the result
8512 is more precise as Fit adds some margin to account for fuzziness of
8513 its calculations) to call window.SetClientSize(child.GetSize())
8514 instead of calling Fit.
8515 """
8516 return _core_.Window_Fit(*args, **kwargs)
8517
8518 def FitInside(*args, **kwargs):
8519 """
8520 FitInside(self)
8521
8522 Similar to Fit, but sizes the interior (virtual) size of a
8523 window. Mainly useful with scrolled windows to reset scrollbars after
8524 sizing changes that do not trigger a size event, and/or scrolled
8525 windows without an interior sizer. This function similarly won't do
8526 anything if there are no subwindows.
8527 """
8528 return _core_.Window_FitInside(*args, **kwargs)
8529
03837c5c 8530 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD
8531 """
8532 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
8533 int incH=-1)
d55e5bfc
RD
8534
8535 Allows specification of minimum and maximum window sizes, and window
8536 size increments. If a pair of values is not set (or set to -1), the
8537 default values will be used. If this function is called, the user
908b74cd
RD
8538 will not be able to size the window outside the given bounds (if it is
8539 a top-level window.) Sizers will also inspect the minimum window size
8540 and will use that value if set when calculating layout.
8541
8542 The resizing increments are only significant under Motif or Xt.
d55e5bfc 8543 """
03837c5c 8544 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 8545
03837c5c
RD
8546 def SetSizeHintsSz(*args, **kwargs):
8547 """
8548 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
8549
8550 Allows specification of minimum and maximum window sizes, and window
8551 size increments. If a pair of values is not set (or set to -1), the
8552 default values will be used. If this function is called, the user
8553 will not be able to size the window outside the given bounds (if it is
8554 a top-level window.) Sizers will also inspect the minimum window size
8555 and will use that value if set when calculating layout.
8556
8557 The resizing increments are only significant under Motif or Xt.
8558 """
8559 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
8560
8561 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 8562 """
908b74cd 8563 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
8564
8565 Allows specification of minimum and maximum virtual window sizes. If a
8566 pair of values is not set (or set to -1), the default values will be
8567 used. If this function is called, the user will not be able to size
8568 the virtual area of the window outside the given bounds.
8569 """
03837c5c
RD
8570 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
8571
8572 def SetVirtualSizeHintsSz(*args, **kwargs):
8573 """
8574 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
8575
8576 Allows specification of minimum and maximum virtual window sizes. If a
8577 pair of values is not set (or set to -1), the default values will be
8578 used. If this function is called, the user will not be able to size
8579 the virtual area of the window outside the given bounds.
8580 """
8581 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 8582
908b74cd
RD
8583 def GetMaxSize(*args, **kwargs):
8584 """GetMaxSize(self) -> Size"""
8585 return _core_.Window_GetMaxSize(*args, **kwargs)
8586
8587 def GetMinSize(*args, **kwargs):
8588 """GetMinSize(self) -> Size"""
8589 return _core_.Window_GetMinSize(*args, **kwargs)
8590
8591 def SetMinSize(*args, **kwargs):
8592 """
8593 SetMinSize(self, Size minSize)
8594
8595 A more convenient method than `SetSizeHints` for setting just the
8596 min size.
8597 """
8598 return _core_.Window_SetMinSize(*args, **kwargs)
8599
8600 def SetMaxSize(*args, **kwargs):
8601 """
8602 SetMaxSize(self, Size maxSize)
8603
8604 A more convenient method than `SetSizeHints` for setting just the
8605 max size.
8606 """
8607 return _core_.Window_SetMaxSize(*args, **kwargs)
8608
d55e5bfc
RD
8609 def GetMinWidth(*args, **kwargs):
8610 """GetMinWidth(self) -> int"""
8611 return _core_.Window_GetMinWidth(*args, **kwargs)
8612
8613 def GetMinHeight(*args, **kwargs):
8614 """GetMinHeight(self) -> int"""
8615 return _core_.Window_GetMinHeight(*args, **kwargs)
8616
8617 def GetMaxWidth(*args, **kwargs):
8618 """GetMaxWidth(self) -> int"""
8619 return _core_.Window_GetMaxWidth(*args, **kwargs)
8620
8621 def GetMaxHeight(*args, **kwargs):
8622 """GetMaxHeight(self) -> int"""
8623 return _core_.Window_GetMaxHeight(*args, **kwargs)
8624
d55e5bfc
RD
8625 def SetVirtualSize(*args, **kwargs):
8626 """
8627 SetVirtualSize(self, Size size)
8628
8629 Set the the virtual size of a window in pixels. For most windows this
8630 is just the client area of the window, but for some like scrolled
8631 windows it is more or less independent of the screen window size.
8632 """
8633 return _core_.Window_SetVirtualSize(*args, **kwargs)
8634
8635 def SetVirtualSizeWH(*args, **kwargs):
8636 """
8637 SetVirtualSizeWH(self, int w, int h)
8638
8639 Set the the virtual size of a window in pixels. For most windows this
8640 is just the client area of the window, but for some like scrolled
8641 windows it is more or less independent of the screen window size.
8642 """
8643 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
8644
8645 def GetVirtualSize(*args, **kwargs):
8646 """
8647 GetVirtualSize(self) -> Size
8648
8649 Get the the virtual size of the window in pixels. For most windows
8650 this is just the client area of the window, but for some like scrolled
8651 windows it is more or less independent of the screen window size.
8652 """
8653 return _core_.Window_GetVirtualSize(*args, **kwargs)
8654
8655 def GetVirtualSizeTuple(*args, **kwargs):
8656 """
8657 GetVirtualSizeTuple() -> (width, height)
8658
8659 Get the the virtual size of the window in pixels. For most windows
8660 this is just the client area of the window, but for some like scrolled
8661 windows it is more or less independent of the screen window size.
8662 """
8663 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
8664
8665 def GetBestVirtualSize(*args, **kwargs):
8666 """
8667 GetBestVirtualSize(self) -> Size
8668
8669 Return the largest of ClientSize and BestSize (as determined by a
8670 sizer, interior children, or other means)
8671 """
8672 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
8673
8674 def Show(*args, **kwargs):
8675 """
8676 Show(self, bool show=True) -> bool
8677
8678 Shows or hides the window. You may need to call Raise for a top level
8679 window if you want to bring it to top, although this is not needed if
8680 Show is called immediately after the frame creation. Returns True if
8681 the window has been shown or hidden or False if nothing was done
8682 because it already was in the requested state.
8683 """
8684 return _core_.Window_Show(*args, **kwargs)
8685
8686 def Hide(*args, **kwargs):
8687 """
8688 Hide(self) -> bool
8689
8690 Equivalent to calling Show(False).
8691 """
8692 return _core_.Window_Hide(*args, **kwargs)
8693
8694 def Enable(*args, **kwargs):
8695 """
8696 Enable(self, bool enable=True) -> bool
8697
8698 Enable or disable the window for user input. Note that when a parent
8699 window is disabled, all of its children are disabled as well and they
8700 are reenabled again when the parent is. Returns true if the window
8701 has been enabled or disabled, false if nothing was done, i.e. if the
8702 window had already been in the specified state.
8703 """
8704 return _core_.Window_Enable(*args, **kwargs)
8705
8706 def Disable(*args, **kwargs):
8707 """
8708 Disable(self) -> bool
8709
8710 Disables the window, same as Enable(false).
8711 """
8712 return _core_.Window_Disable(*args, **kwargs)
8713
8714 def IsShown(*args, **kwargs):
8715 """
8716 IsShown(self) -> bool
8717
8718 Returns true if the window is shown, false if it has been hidden.
8719 """
8720 return _core_.Window_IsShown(*args, **kwargs)
8721
8722 def IsEnabled(*args, **kwargs):
8723 """
8724 IsEnabled(self) -> bool
8725
8726 Returns true if the window is enabled for input, false otherwise.
8727 """
8728 return _core_.Window_IsEnabled(*args, **kwargs)
8729
8730 def SetWindowStyleFlag(*args, **kwargs):
8731 """
8732 SetWindowStyleFlag(self, long style)
8733
79fccf9d
RD
8734 Sets the style of the window. Please note that some styles cannot be
8735 changed after the window creation and that Refresh() might need to be
8736 called after changing the others for the change to take place
8737 immediately.
d55e5bfc
RD
8738 """
8739 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
8740
8741 def GetWindowStyleFlag(*args, **kwargs):
8742 """
8743 GetWindowStyleFlag(self) -> long
8744
8745 Gets the window style that was passed to the constructor or Create
8746 method.
8747 """
8748 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
8749
8750 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
8751 def HasFlag(*args, **kwargs):
8752 """
8753 HasFlag(self, int flag) -> bool
8754
8755 Test if the given style is set for this window.
8756 """
8757 return _core_.Window_HasFlag(*args, **kwargs)
8758
8759 def IsRetained(*args, **kwargs):
8760 """
8761 IsRetained(self) -> bool
8762
8763 Returns true if the window is retained, false otherwise. Retained
8764 windows are only available on X platforms.
8765 """
8766 return _core_.Window_IsRetained(*args, **kwargs)
8767
8768 def SetExtraStyle(*args, **kwargs):
8769 """
8770 SetExtraStyle(self, long exStyle)
8771
8772 Sets the extra style bits for the window. Extra styles are the less
8773 often used style bits which can't be set with the constructor or with
8774 SetWindowStyleFlag()
8775 """
8776 return _core_.Window_SetExtraStyle(*args, **kwargs)
8777
8778 def GetExtraStyle(*args, **kwargs):
8779 """
8780 GetExtraStyle(self) -> long
8781
8782 Returns the extra style bits for the window.
8783 """
8784 return _core_.Window_GetExtraStyle(*args, **kwargs)
8785
8786 def MakeModal(*args, **kwargs):
8787 """
8788 MakeModal(self, bool modal=True)
8789
8790 Disables all other windows in the application so that the user can
8791 only interact with this window. Passing False will reverse this
8792 effect.
8793 """
8794 return _core_.Window_MakeModal(*args, **kwargs)
8795
8796 def SetThemeEnabled(*args, **kwargs):
8797 """
8798 SetThemeEnabled(self, bool enableTheme)
8799
8800 This function tells a window if it should use the system's "theme"
8801 code to draw the windows' background instead if its own background
8802 drawing code. This will only have an effect on platforms that support
8803 the notion of themes in user defined windows. One such platform is
8804 GTK+ where windows can have (very colourful) backgrounds defined by a
8805 user's selected theme.
8806
8807 Dialogs, notebook pages and the status bar have this flag set to true
8808 by default so that the default look and feel is simulated best.
8809 """
8810 return _core_.Window_SetThemeEnabled(*args, **kwargs)
8811
8812 def GetThemeEnabled(*args, **kwargs):
8813 """
8814 GetThemeEnabled(self) -> bool
8815
8816 Return the themeEnabled flag.
8817 """
8818 return _core_.Window_GetThemeEnabled(*args, **kwargs)
8819
8820 def SetFocus(*args, **kwargs):
8821 """
8822 SetFocus(self)
8823
8824 Set's the focus to this window, allowing it to receive keyboard input.
8825 """
8826 return _core_.Window_SetFocus(*args, **kwargs)
8827
8828 def SetFocusFromKbd(*args, **kwargs):
8829 """
8830 SetFocusFromKbd(self)
8831
8832 Set focus to this window as the result of a keyboard action. Normally
8833 only called internally.
8834 """
8835 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
8836
8837 def FindFocus(*args, **kwargs):
8838 """
c24da6d6 8839 FindFocus() -> Window
d55e5bfc
RD
8840
8841 Returns the window or control that currently has the keyboard focus,
8842 or None.
8843 """
8844 return _core_.Window_FindFocus(*args, **kwargs)
8845
8846 FindFocus = staticmethod(FindFocus)
8847 def AcceptsFocus(*args, **kwargs):
8848 """
8849 AcceptsFocus(self) -> bool
8850
8851 Can this window have focus?
8852 """
8853 return _core_.Window_AcceptsFocus(*args, **kwargs)
8854
8855 def AcceptsFocusFromKeyboard(*args, **kwargs):
8856 """
8857 AcceptsFocusFromKeyboard(self) -> bool
8858
8859 Can this window be given focus by keyboard navigation? if not, the
8860 only way to give it focus (provided it accepts it at all) is to click
8861 it.
8862 """
8863 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
8864
8865 def GetDefaultItem(*args, **kwargs):
8866 """
8867 GetDefaultItem(self) -> Window
8868
8869 Get the default child of this parent, i.e. the one which is activated
8870 by pressing <Enter> such as the OK button on a wx.Dialog.
8871 """
8872 return _core_.Window_GetDefaultItem(*args, **kwargs)
8873
8874 def SetDefaultItem(*args, **kwargs):
8875 """
8876 SetDefaultItem(self, Window child) -> Window
8877
8878 Set this child as default, return the old default.
8879 """
8880 return _core_.Window_SetDefaultItem(*args, **kwargs)
8881
8882 def SetTmpDefaultItem(*args, **kwargs):
8883 """
8884 SetTmpDefaultItem(self, Window win)
8885
8886 Set this child as temporary default
8887 """
8888 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
8889
908b74cd
RD
8890 def Navigate(*args, **kwargs):
8891 """
8892 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
8893
a8eff060
RD
8894 Does keyboard navigation from this window to another, by sending a
8895 `wx.NavigationKeyEvent`.
908b74cd
RD
8896 """
8897 return _core_.Window_Navigate(*args, **kwargs)
8898
bf26d883
RD
8899 def MoveAfterInTabOrder(*args, **kwargs):
8900 """
8901 MoveAfterInTabOrder(self, Window win)
8902
8903 Moves this window in the tab navigation order after the specified
8904 sibling window. This means that when the user presses the TAB key on
8905 that other window, the focus switches to this window.
8906
8907 The default tab order is the same as creation order. This function
8908 and `MoveBeforeInTabOrder` allow to change it after creating all the
8909 windows.
8910
8911 """
8912 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
8913
8914 def MoveBeforeInTabOrder(*args, **kwargs):
8915 """
8916 MoveBeforeInTabOrder(self, Window win)
8917
8918 Same as `MoveAfterInTabOrder` except that it inserts this window just
8919 before win instead of putting it right after it.
8920 """
8921 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
8922
d55e5bfc
RD
8923 def GetChildren(*args, **kwargs):
8924 """
8925 GetChildren(self) -> PyObject
8926
8927 Returns a list of the window's children. NOTE: Currently this is a
8928 copy of the child window list maintained by the window, so the return
8929 value of this function is only valid as long as the window's children
8930 do not change.
8931 """
8932 return _core_.Window_GetChildren(*args, **kwargs)
8933
8934 def GetParent(*args, **kwargs):
8935 """
8936 GetParent(self) -> Window
8937
8938 Returns the parent window of this window, or None if there isn't one.
8939 """
8940 return _core_.Window_GetParent(*args, **kwargs)
8941
8942 def GetGrandParent(*args, **kwargs):
8943 """
8944 GetGrandParent(self) -> Window
8945
79fccf9d
RD
8946 Returns the parent of the parent of this window, or None if there
8947 isn't one.
d55e5bfc
RD
8948 """
8949 return _core_.Window_GetGrandParent(*args, **kwargs)
8950
8951 def IsTopLevel(*args, **kwargs):
8952 """
8953 IsTopLevel(self) -> bool
8954
8955 Returns true if the given window is a top-level one. Currently all
8956 frames and dialogs are always considered to be top-level windows (even
8957 if they have a parent window).
8958 """
8959 return _core_.Window_IsTopLevel(*args, **kwargs)
8960
8961 def Reparent(*args, **kwargs):
8962 """
8963 Reparent(self, Window newParent) -> bool
8964
8965 Reparents the window, i.e the window will be removed from its current
8966 parent window (e.g. a non-standard toolbar in a wxFrame) and then
8967 re-inserted into another. Available on Windows and GTK. Returns True
8968 if the parent was changed, False otherwise (error or newParent ==
8969 oldParent)
8970 """
8971 return _core_.Window_Reparent(*args, **kwargs)
8972
8973 def AddChild(*args, **kwargs):
8974 """
8975 AddChild(self, Window child)
8976
8977 Adds a child window. This is called automatically by window creation
8978 functions so should not be required by the application programmer.
8979 """
8980 return _core_.Window_AddChild(*args, **kwargs)
8981
8982 def RemoveChild(*args, **kwargs):
8983 """
8984 RemoveChild(self, Window child)
8985
8986 Removes a child window. This is called automatically by window
8987 deletion functions so should not be required by the application
8988 programmer.
8989 """
8990 return _core_.Window_RemoveChild(*args, **kwargs)
8991
8992 def FindWindowById(*args, **kwargs):
8993 """
8994 FindWindowById(self, long winid) -> Window
8995
8996 Find a chld of this window by window ID
8997 """
8998 return _core_.Window_FindWindowById(*args, **kwargs)
8999
9000 def FindWindowByName(*args, **kwargs):
9001 """
9002 FindWindowByName(self, String name) -> Window
9003
9004 Find a child of this window by name
9005 """
9006 return _core_.Window_FindWindowByName(*args, **kwargs)
9007
9008 def GetEventHandler(*args, **kwargs):
9009 """
9010 GetEventHandler(self) -> EvtHandler
9011
9012 Returns the event handler for this window. By default, the window is
9013 its own event handler.
9014 """
9015 return _core_.Window_GetEventHandler(*args, **kwargs)
9016
9017 def SetEventHandler(*args, **kwargs):
9018 """
9019 SetEventHandler(self, EvtHandler handler)
9020
9021 Sets the event handler for this window. An event handler is an object
9022 that is capable of processing the events sent to a window. By default,
9023 the window is its own event handler, but an application may wish to
9024 substitute another, for example to allow central implementation of
9025 event-handling for a variety of different window classes.
9026
79fccf9d 9027 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
9028 up a chain of event handlers, where an event not handled by one event
9029 handler is handed to the next one in the chain.
9030 """
9031 return _core_.Window_SetEventHandler(*args, **kwargs)
9032
9033 def PushEventHandler(*args, **kwargs):
9034 """
9035 PushEventHandler(self, EvtHandler handler)
9036
9037 Pushes this event handler onto the event handler stack for the window.
9038 An event handler is an object that is capable of processing the events
9039 sent to a window. By default, the window is its own event handler, but
9040 an application may wish to substitute another, for example to allow
9041 central implementation of event-handling for a variety of different
9042 window classes.
9043
9044 wx.Window.PushEventHandler allows an application to set up a chain of
9045 event handlers, where an event not handled by one event handler is
79fccf9d 9046 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
9047 remove the event handler.
9048 """
9049 return _core_.Window_PushEventHandler(*args, **kwargs)
9050
9051 def PopEventHandler(*args, **kwargs):
9052 """
9053 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
9054
9055 Removes and returns the top-most event handler on the event handler
9056 stack. If deleteHandler is True then the wx.EvtHandler object will be
9057 destroyed after it is popped.
9058 """
9059 return _core_.Window_PopEventHandler(*args, **kwargs)
9060
9061 def RemoveEventHandler(*args, **kwargs):
9062 """
9063 RemoveEventHandler(self, EvtHandler handler) -> bool
9064
79fccf9d
RD
9065 Find the given handler in the event handler chain and remove (but not
9066 delete) it from the event handler chain, return True if it was found
9067 and False otherwise (this also results in an assert failure so this
9068 function should only be called when the handler is supposed to be
9069 there.)
d55e5bfc
RD
9070 """
9071 return _core_.Window_RemoveEventHandler(*args, **kwargs)
9072
9073 def SetValidator(*args, **kwargs):
9074 """
9075 SetValidator(self, Validator validator)
9076
9077 Deletes the current validator (if any) and sets the window validator,
9078 having called wx.Validator.Clone to create a new validator of this
9079 type.
9080 """
9081 return _core_.Window_SetValidator(*args, **kwargs)
9082
9083 def GetValidator(*args, **kwargs):
9084 """
9085 GetValidator(self) -> Validator
9086
9087 Returns a pointer to the current validator for the window, or None if
9088 there is none.
9089 """
9090 return _core_.Window_GetValidator(*args, **kwargs)
9091
9092 def Validate(*args, **kwargs):
9093 """
9094 Validate(self) -> bool
9095
9096 Validates the current values of the child controls using their
79fccf9d
RD
9097 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9098 style flag set, the method will also call Validate() of all child
9099 windows. Returns false if any of the validations failed.
d55e5bfc
RD
9100 """
9101 return _core_.Window_Validate(*args, **kwargs)
9102
9103 def TransferDataToWindow(*args, **kwargs):
9104 """
9105 TransferDataToWindow(self) -> bool
9106
79fccf9d
RD
9107 Transfers values to child controls from data areas specified by their
9108 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
9109 style flag set, the method will also call TransferDataToWindow() of
9110 all child windows.
d55e5bfc
RD
9111 """
9112 return _core_.Window_TransferDataToWindow(*args, **kwargs)
9113
9114 def TransferDataFromWindow(*args, **kwargs):
9115 """
9116 TransferDataFromWindow(self) -> bool
9117
79fccf9d
RD
9118 Transfers values from child controls to data areas specified by their
9119 validators. Returns false if a transfer failed. If the window has
9120 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
9121 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
9122 """
9123 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
9124
9125 def InitDialog(*args, **kwargs):
9126 """
9127 InitDialog(self)
9128
79fccf9d
RD
9129 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
9130 to the dialog via validators.
d55e5bfc
RD
9131 """
9132 return _core_.Window_InitDialog(*args, **kwargs)
9133
9134 def SetAcceleratorTable(*args, **kwargs):
9135 """
9136 SetAcceleratorTable(self, AcceleratorTable accel)
9137
9138 Sets the accelerator table for this window.
9139 """
9140 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
9141
9142 def GetAcceleratorTable(*args, **kwargs):
9143 """
9144 GetAcceleratorTable(self) -> AcceleratorTable
9145
9146 Gets the accelerator table for this window.
9147 """
9148 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
9149
9150 def RegisterHotKey(*args, **kwargs):
9151 """
9152 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
9153
9154 Registers a system wide hotkey. Every time the user presses the hotkey
9155 registered here, this window will receive a hotkey event. It will
9156 receive the event even if the application is in the background and
9157 does not have the input focus because the user is working with some
9158 other application. To bind an event handler function to this hotkey
9159 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
9160 hotkey was registered successfully.
9161 """
9162 return _core_.Window_RegisterHotKey(*args, **kwargs)
9163
9164 def UnregisterHotKey(*args, **kwargs):
9165 """
9166 UnregisterHotKey(self, int hotkeyId) -> bool
9167
9168 Unregisters a system wide hotkey.
9169 """
9170 return _core_.Window_UnregisterHotKey(*args, **kwargs)
9171
9172 def ConvertDialogPointToPixels(*args, **kwargs):
9173 """
9174 ConvertDialogPointToPixels(self, Point pt) -> Point
9175
9176 Converts a point or size from dialog units to pixels. Dialog units
9177 are used for maintaining a dialog's proportions even if the font
9178 changes. For the x dimension, the dialog units are multiplied by the
9179 average character width and then divided by 4. For the y dimension,
9180 the dialog units are multiplied by the average character height and
9181 then divided by 8.
9182 """
9183 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
9184
9185 def ConvertDialogSizeToPixels(*args, **kwargs):
9186 """
9187 ConvertDialogSizeToPixels(self, Size sz) -> Size
9188
9189 Converts a point or size from dialog units to pixels. Dialog units
9190 are used for maintaining a dialog's proportions even if the font
9191 changes. For the x dimension, the dialog units are multiplied by the
9192 average character width and then divided by 4. For the y dimension,
9193 the dialog units are multiplied by the average character height and
9194 then divided by 8.
9195 """
9196 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
9197
9198 def DLG_PNT(*args, **kwargs):
9199 """
9200 DLG_PNT(self, Point pt) -> Point
9201
9202 Converts a point or size from dialog units to pixels. Dialog units
9203 are used for maintaining a dialog's proportions even if the font
9204 changes. For the x dimension, the dialog units are multiplied by the
9205 average character width and then divided by 4. For the y dimension,
9206 the dialog units are multiplied by the average character height and
9207 then divided by 8.
9208 """
9209 return _core_.Window_DLG_PNT(*args, **kwargs)
9210
9211 def DLG_SZE(*args, **kwargs):
9212 """
9213 DLG_SZE(self, Size sz) -> Size
9214
9215 Converts a point or size from dialog units to pixels. Dialog units
9216 are used for maintaining a dialog's proportions even if the font
9217 changes. For the x dimension, the dialog units are multiplied by the
9218 average character width and then divided by 4. For the y dimension,
9219 the dialog units are multiplied by the average character height and
9220 then divided by 8.
9221 """
9222 return _core_.Window_DLG_SZE(*args, **kwargs)
9223
9224 def ConvertPixelPointToDialog(*args, **kwargs):
9225 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
9226 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
9227
9228 def ConvertPixelSizeToDialog(*args, **kwargs):
9229 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
9230 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
9231
9232 def WarpPointer(*args, **kwargs):
9233 """
9234 WarpPointer(self, int x, int y)
9235
9236 Moves the pointer to the given position on the window.
9237
9238 NOTE: This function is not supported under Mac because Apple Human
9239 Interface Guidelines forbid moving the mouse cursor programmatically.
9240 """
9241 return _core_.Window_WarpPointer(*args, **kwargs)
9242
9243 def CaptureMouse(*args, **kwargs):
9244 """
9245 CaptureMouse(self)
9246
9247 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
9248 release the capture.
9249
9250 Note that wxWindows maintains the stack of windows having captured the
9251 mouse and when the mouse is released the capture returns to the window
9252 which had had captured it previously and it is only really released if
9253 there were no previous window. In particular, this means that you must
9254 release the mouse as many times as you capture it.
9255 """
9256 return _core_.Window_CaptureMouse(*args, **kwargs)
9257
9258 def ReleaseMouse(*args, **kwargs):
9259 """
9260 ReleaseMouse(self)
9261
9262 Releases mouse input captured with wx.Window.CaptureMouse.
9263 """
9264 return _core_.Window_ReleaseMouse(*args, **kwargs)
9265
9266 def GetCapture(*args, **kwargs):
9267 """
c24da6d6 9268 GetCapture() -> Window
d55e5bfc
RD
9269
9270 Returns the window which currently captures the mouse or None
9271 """
9272 return _core_.Window_GetCapture(*args, **kwargs)
9273
9274 GetCapture = staticmethod(GetCapture)
9275 def HasCapture(*args, **kwargs):
9276 """
9277 HasCapture(self) -> bool
9278
9279 Returns true if this window has the current mouse capture.
9280 """
9281 return _core_.Window_HasCapture(*args, **kwargs)
9282
9283 def Refresh(*args, **kwargs):
9284 """
9285 Refresh(self, bool eraseBackground=True, Rect rect=None)
9286
9287 Mark the specified rectangle (or the whole window) as "dirty" so it
9288 will be repainted. Causes an EVT_PAINT event to be generated and sent
9289 to the window.
9290 """
9291 return _core_.Window_Refresh(*args, **kwargs)
9292
9293 def RefreshRect(*args, **kwargs):
9294 """
fef4c27a 9295 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD
9296
9297 Redraws the contents of the given rectangle: the area inside it will
9298 be repainted. This is the same as Refresh but has a nicer syntax.
9299 """
9300 return _core_.Window_RefreshRect(*args, **kwargs)
9301
9302 def Update(*args, **kwargs):
9303 """
9304 Update(self)
9305
9306 Calling this method immediately repaints the invalidated area of the
9307 window instead of waiting for the EVT_PAINT event to happen, (normally
9308 this would usually only happen when the flow of control returns to the
9309 event loop.) Notice that this function doesn't refresh the window and
9310 does nothing if the window has been already repainted. Use Refresh
9311 first if you want to immediately redraw the window (or some portion of
9312 it) unconditionally.
9313 """
9314 return _core_.Window_Update(*args, **kwargs)
9315
9316 def ClearBackground(*args, **kwargs):
9317 """
9318 ClearBackground(self)
9319
9320 Clears the window by filling it with the current background
9321 colour. Does not cause an erase background event to be generated.
9322 """
9323 return _core_.Window_ClearBackground(*args, **kwargs)
9324
9325 def Freeze(*args, **kwargs):
9326 """
9327 Freeze(self)
9328
79fccf9d
RD
9329 Freezes the window or, in other words, prevents any updates from
9330 taking place on screen, the window is not redrawn at all. Thaw must be
9331 called to reenable window redrawing. Calls to Freeze/Thaw may be
9332 nested, with the actual Thaw being delayed until all the nesting has
9333 been undone.
d55e5bfc
RD
9334
9335 This method is useful for visual appearance optimization (for example,
9336 it is a good idea to use it before inserting large amount of text into
9337 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
9338 for all controls so it is mostly just a hint to wxWindows and not a
9339 mandatory directive.
9340 """
9341 return _core_.Window_Freeze(*args, **kwargs)
9342
9343 def Thaw(*args, **kwargs):
9344 """
9345 Thaw(self)
9346
9347 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD
9348 Freeze/Thaw may be nested, so Thaw must be called the same number of
9349 times that Freeze was before the window will be updated.
d55e5bfc
RD
9350 """
9351 return _core_.Window_Thaw(*args, **kwargs)
9352
9353 def PrepareDC(*args, **kwargs):
9354 """
9355 PrepareDC(self, DC dc)
9356
9357 Call this function to prepare the device context for drawing a
9358 scrolled image. It sets the device origin according to the current
9359 scroll position.
9360 """
9361 return _core_.Window_PrepareDC(*args, **kwargs)
9362
9363 def GetUpdateRegion(*args, **kwargs):
9364 """
9365 GetUpdateRegion(self) -> Region
9366
9367 Returns the region specifying which parts of the window have been
9368 damaged. Should only be called within an EVT_PAINT handler.
9369 """
9370 return _core_.Window_GetUpdateRegion(*args, **kwargs)
9371
9372 def GetUpdateClientRect(*args, **kwargs):
9373 """
9374 GetUpdateClientRect(self) -> Rect
9375
9376 Get the update rectangle region bounding box in client coords.
9377 """
9378 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
9379
9380 def IsExposed(*args, **kwargs):
9381 """
9382 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
9383
9384 Returns true if the given point or rectangle area has been exposed
9385 since the last repaint. Call this in an paint event handler to
9386 optimize redrawing by only redrawing those areas, which have been
9387 exposed.
9388 """
9389 return _core_.Window_IsExposed(*args, **kwargs)
9390
9391 def IsExposedPoint(*args, **kwargs):
9392 """
9393 IsExposedPoint(self, Point pt) -> bool
9394
9395 Returns true if the given point or rectangle area has been exposed
9396 since the last repaint. Call this in an paint event handler to
9397 optimize redrawing by only redrawing those areas, which have been
9398 exposed.
9399 """
9400 return _core_.Window_IsExposedPoint(*args, **kwargs)
9401
9402 def IsExposedRect(*args, **kwargs):
9403 """
9404 IsExposedRect(self, Rect rect) -> bool
9405
9406 Returns true if the given point or rectangle area has been exposed
9407 since the last repaint. Call this in an paint event handler to
9408 optimize redrawing by only redrawing those areas, which have been
9409 exposed.
9410 """
9411 return _core_.Window_IsExposedRect(*args, **kwargs)
9412
9413 def GetDefaultAttributes(*args, **kwargs):
9414 """
9415 GetDefaultAttributes(self) -> VisualAttributes
9416
79fccf9d
RD
9417 Get the default attributes for an instance of this class. This is
9418 useful if you want to use the same font or colour in your own control
9419 as in a standard control -- which is a much better idea than hard
9420 coding specific colours or fonts which might look completely out of
caef1a4d 9421 place on the user's system, especially if it uses themes.
d55e5bfc
RD
9422 """
9423 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
9424
9425 def GetClassDefaultAttributes(*args, **kwargs):
9426 """
c24da6d6 9427 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 9428
79fccf9d
RD
9429 Get the default attributes for this class. This is useful if you want
9430 to use the same font or colour in your own control as in a standard
9431 control -- which is a much better idea than hard coding specific
caef1a4d
RD
9432 colours or fonts which might look completely out of place on the
9433 user's system, especially if it uses themes.
d55e5bfc
RD
9434
9435 The variant parameter is only relevant under Mac currently and is
79fccf9d 9436 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
9437 the returned font. See `wx.Window.SetWindowVariant` for more about
9438 this.
d55e5bfc
RD
9439 """
9440 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
9441
9442 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
9443 def SetBackgroundColour(*args, **kwargs):
9444 """
9445 SetBackgroundColour(self, Colour colour) -> bool
9446
9447 Sets the background colour of the window. Returns True if the colour
9448 was changed. The background colour is usually painted by the default
9449 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
9450 automatically under GTK. Using `wx.NullColour` will reset the window
9451 to the default background colour.
d55e5bfc 9452
caef1a4d 9453 Note that setting the background colour may not cause an immediate
f8167d6e 9454 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
9455 calling this function.
9456
f8167d6e
RD
9457 Using this function will disable attempts to use themes for this
9458 window, if the system supports them. Use with care since usually the
9459 themes represent the appearance chosen by the user to be used for all
9460 applications on the system.
d55e5bfc
RD
9461 """
9462 return _core_.Window_SetBackgroundColour(*args, **kwargs)
9463
412d302d
RD
9464 def SetOwnBackgroundColour(*args, **kwargs):
9465 """SetOwnBackgroundColour(self, Colour colour)"""
9466 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD
9467
9468 def SetForegroundColour(*args, **kwargs):
9469 """
9470 SetForegroundColour(self, Colour colour) -> bool
9471
9472 Sets the foreground colour of the window. Returns True is the colour
9473 was changed. The interpretation of foreground colour is dependent on
9474 the window class; it may be the text colour or other colour, or it may
9475 not be used at all.
9476 """
9477 return _core_.Window_SetForegroundColour(*args, **kwargs)
9478
fa47d7a7
VS
9479 def SetOwnForegroundColour(*args, **kwargs):
9480 """SetOwnForegroundColour(self, Colour colour)"""
9481 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
9482
9483 def GetBackgroundColour(*args, **kwargs):
9484 """
9485 GetBackgroundColour(self) -> Colour
9486
9487 Returns the background colour of the window.
9488 """
9489 return _core_.Window_GetBackgroundColour(*args, **kwargs)
9490
9491 def GetForegroundColour(*args, **kwargs):
9492 """
9493 GetForegroundColour(self) -> Colour
9494
9495 Returns the foreground colour of the window. The interpretation of
9496 foreground colour is dependent on the window class; it may be the text
9497 colour or other colour, or it may not be used at all.
9498 """
9499 return _core_.Window_GetForegroundColour(*args, **kwargs)
9500
dcb8fc74
RD
9501 def InheritsBackgroundColour(*args, **kwargs):
9502 """InheritsBackgroundColour(self) -> bool"""
9503 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
9504
9505 def UseBgCol(*args, **kwargs):
9506 """UseBgCol(self) -> bool"""
9507 return _core_.Window_UseBgCol(*args, **kwargs)
9508
0f63ec68
RD
9509 def SetBackgroundStyle(*args, **kwargs):
9510 """
9511 SetBackgroundStyle(self, int style) -> bool
9512
9513 Returns the background style of the window. The background style
9514 indicates how the background of the window is drawn.
9515
9516 ====================== ========================================
9517 wx.BG_STYLE_SYSTEM The background colour or pattern should
9518 be determined by the system
9519 wx.BG_STYLE_COLOUR The background should be a solid colour
9520 wx.BG_STYLE_CUSTOM The background will be implemented by the
9521 application.
9522 ====================== ========================================
9523
9524 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
9525 a custom background, such as a tiled bitmap. Currently the style has
9526 no effect on other platforms.
9527
9528 :see: `GetBackgroundStyle`, `SetBackgroundColour`
9529 """
9530 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
9531
9532 def GetBackgroundStyle(*args, **kwargs):
9533 """
9534 GetBackgroundStyle(self) -> int
9535
9536 Returns the background style of the window.
9537
9538 :see: `SetBackgroundStyle`
9539 """
9540 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
9541
51b83b37
RD
9542 def HasTransparentBackground(*args, **kwargs):
9543 """
9544 HasTransparentBackground(self) -> bool
9545
9546 Returns True if this window's background is transparent (as, for
9547 example, for `wx.StaticText`) and should show the parent window's
9548 background.
9549
9550 This method is mostly used internally by the library itself and you
9551 normally shouldn't have to call it. You may, however, have to override
9552 it in your custom control classes to ensure that background is painted
9553 correctly.
9554 """
9555 return _core_.Window_HasTransparentBackground(*args, **kwargs)
9556
d55e5bfc
RD
9557 def SetCursor(*args, **kwargs):
9558 """
9559 SetCursor(self, Cursor cursor) -> bool
9560
9561 Sets the window's cursor. Notice that the window cursor also sets it
9562 for the children of the window implicitly.
9563
9564 The cursor may be wx.NullCursor in which case the window cursor will
9565 be reset back to default.
9566 """
9567 return _core_.Window_SetCursor(*args, **kwargs)
9568
9569 def GetCursor(*args, **kwargs):
9570 """
9571 GetCursor(self) -> Cursor
9572
9573 Return the cursor associated with this window.
9574 """
9575 return _core_.Window_GetCursor(*args, **kwargs)
9576
9577 def SetFont(*args, **kwargs):
9578 """
9579 SetFont(self, Font font) -> bool
9580
9581 Sets the font for this window.
9582 """
9583 return _core_.Window_SetFont(*args, **kwargs)
9584
fa47d7a7
VS
9585 def SetOwnFont(*args, **kwargs):
9586 """SetOwnFont(self, Font font)"""
9587 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
9588
9589 def GetFont(*args, **kwargs):
9590 """
9591 GetFont(self) -> Font
9592
9593 Returns the default font used for this window.
9594 """
9595 return _core_.Window_GetFont(*args, **kwargs)
9596
9597 def SetCaret(*args, **kwargs):
9598 """
9599 SetCaret(self, Caret caret)
9600
9601 Sets the caret associated with the window.
9602 """
9603 return _core_.Window_SetCaret(*args, **kwargs)
9604
9605 def GetCaret(*args, **kwargs):
9606 """
9607 GetCaret(self) -> Caret
9608
9609 Returns the caret associated with the window.
9610 """
9611 return _core_.Window_GetCaret(*args, **kwargs)
9612
9613 def GetCharHeight(*args, **kwargs):
9614 """
9615 GetCharHeight(self) -> int
9616
9617 Get the (average) character size for the current font.
9618 """
9619 return _core_.Window_GetCharHeight(*args, **kwargs)
9620
9621 def GetCharWidth(*args, **kwargs):
9622 """
9623 GetCharWidth(self) -> int
9624
9625 Get the (average) character size for the current font.
9626 """
9627 return _core_.Window_GetCharWidth(*args, **kwargs)
9628
9629 def GetTextExtent(*args, **kwargs):
a8eff060
RD
9630 """
9631 GetTextExtent(String string) -> (width, height)
9632
9633 Get the width and height of the text using the current font.
9634 """
d55e5bfc
RD
9635 return _core_.Window_GetTextExtent(*args, **kwargs)
9636
9637 def GetFullTextExtent(*args, **kwargs):
9638 """
9639 GetFullTextExtent(String string, Font font=None) ->
9640 (width, height, descent, externalLeading)
9641
9642 Get the width, height, decent and leading of the text using the
9643 current or specified font.
9644 """
9645 return _core_.Window_GetFullTextExtent(*args, **kwargs)
9646
9647 def ClientToScreenXY(*args, **kwargs):
9648 """
9649 ClientToScreenXY(int x, int y) -> (x,y)
9650
9651 Converts to screen coordinates from coordinates relative to this window.
9652 """
9653 return _core_.Window_ClientToScreenXY(*args, **kwargs)
9654
9655 def ScreenToClientXY(*args, **kwargs):
9656 """
9657 ScreenToClientXY(int x, int y) -> (x,y)
9658
9659 Converts from screen to client window coordinates.
9660 """
9661 return _core_.Window_ScreenToClientXY(*args, **kwargs)
9662
9663 def ClientToScreen(*args, **kwargs):
9664 """
9665 ClientToScreen(self, Point pt) -> Point
9666
9667 Converts to screen coordinates from coordinates relative to this window.
9668 """
9669 return _core_.Window_ClientToScreen(*args, **kwargs)
9670
9671 def ScreenToClient(*args, **kwargs):
9672 """
9673 ScreenToClient(self, Point pt) -> Point
9674
9675 Converts from screen to client window coordinates.
9676 """
9677 return _core_.Window_ScreenToClient(*args, **kwargs)
9678
9679 def HitTestXY(*args, **kwargs):
9680 """
9681 HitTestXY(self, int x, int y) -> int
9682
9683 Test where the given (in client coords) point lies
9684 """
9685 return _core_.Window_HitTestXY(*args, **kwargs)
9686
9687 def HitTest(*args, **kwargs):
9688 """
9689 HitTest(self, Point pt) -> int
9690
9691 Test where the given (in client coords) point lies
9692 """
9693 return _core_.Window_HitTest(*args, **kwargs)
9694
9695 def GetBorder(*args):
9696 """
9697 GetBorder(self, long flags) -> int
9698 GetBorder(self) -> int
9699
9700 Get border for the flags of this window
9701 """
9702 return _core_.Window_GetBorder(*args)
9703
9704 def UpdateWindowUI(*args, **kwargs):
9705 """
9706 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
9707
9708 This function sends EVT_UPDATE_UI events to the window. The particular
9709 implementation depends on the window; for example a wx.ToolBar will
9710 send an update UI event for each toolbar button, and a wx.Frame will
9711 send an update UI event for each menubar menu item. You can call this
9712 function from your application to ensure that your UI is up-to-date at
9713 a particular point in time (as far as your EVT_UPDATE_UI handlers are
9714 concerned). This may be necessary if you have called
5ba5649b 9715 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
d55e5bfc
RD
9716 limit the overhead that wxWindows incurs by sending update UI events
9717 in idle time.
d55e5bfc
RD
9718 """
9719 return _core_.Window_UpdateWindowUI(*args, **kwargs)
9720
9721 def PopupMenuXY(*args, **kwargs):
9722 """
7a0b95b0 9723 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 9724
7a0b95b0
RD
9725 Pops up the given menu at the specified coordinates, relative to this window,
9726 and returns control when the user has dismissed the menu. If a menu item is
9727 selected, the corresponding menu event is generated and will be processed as
9728 usual. If the default position is given then the current position of the
9729 mouse cursor will be used.
d55e5bfc
RD
9730 """
9731 return _core_.Window_PopupMenuXY(*args, **kwargs)
9732
9733 def PopupMenu(*args, **kwargs):
9734 """
7a0b95b0 9735 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 9736
7a0b95b0
RD
9737 Pops up the given menu at the specified coordinates, relative to this window,
9738 and returns control when the user has dismissed the menu. If a menu item is
9739 selected, the corresponding menu event is generated and will be processed as
9740 usual. If the default position is given then the current position of the
9741 mouse cursor will be used.
d55e5bfc
RD
9742 """
9743 return _core_.Window_PopupMenu(*args, **kwargs)
9744
9745 def GetHandle(*args, **kwargs):
9746 """
9747 GetHandle(self) -> long
9748
9749 Returns the platform-specific handle (as a long integer) of the
9750 physical window. Currently on wxMac it returns the handle of the
9751 toplevel parent of the window.
9752 """
9753 return _core_.Window_GetHandle(*args, **kwargs)
9754
629e65c2
RD
9755 def AssociateHandle(*args, **kwargs):
9756 """
9757 AssociateHandle(self, long handle)
9758
9759 Associate the window with a new native handle
9760 """
9761 return _core_.Window_AssociateHandle(*args, **kwargs)
9762
9763 def DissociateHandle(*args, **kwargs):
9764 """
9765 DissociateHandle(self)
9766
9767 Dissociate the current native handle from the window
9768 """
9769 return _core_.Window_DissociateHandle(*args, **kwargs)
9770
d55e5bfc
RD
9771 def OnPaint(*args, **kwargs):
9772 """OnPaint(self, PaintEvent event)"""
9773 return _core_.Window_OnPaint(*args, **kwargs)
9774
9775 def HasScrollbar(*args, **kwargs):
9776 """
9777 HasScrollbar(self, int orient) -> bool
9778
9779 Does the window have the scrollbar for this orientation?
9780 """
9781 return _core_.Window_HasScrollbar(*args, **kwargs)
9782
9783 def SetScrollbar(*args, **kwargs):
9784 """
79fccf9d 9785 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
9786 bool refresh=True)
9787
9788 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
9789 """
9790 return _core_.Window_SetScrollbar(*args, **kwargs)
9791
9792 def SetScrollPos(*args, **kwargs):
9793 """
9794 SetScrollPos(self, int orientation, int pos, bool refresh=True)
9795
9796 Sets the position of one of the built-in scrollbars.
9797 """
9798 return _core_.Window_SetScrollPos(*args, **kwargs)
9799
9800 def GetScrollPos(*args, **kwargs):
9801 """
9802 GetScrollPos(self, int orientation) -> int
9803
9804 Returns the built-in scrollbar position.
9805 """
9806 return _core_.Window_GetScrollPos(*args, **kwargs)
9807
9808 def GetScrollThumb(*args, **kwargs):
9809 """
9810 GetScrollThumb(self, int orientation) -> int
9811
9812 Returns the built-in scrollbar thumb size.
9813 """
9814 return _core_.Window_GetScrollThumb(*args, **kwargs)
9815
9816 def GetScrollRange(*args, **kwargs):
9817 """
9818 GetScrollRange(self, int orientation) -> int
9819
9820 Returns the built-in scrollbar range.
9821 """
9822 return _core_.Window_GetScrollRange(*args, **kwargs)
9823
9824 def ScrollWindow(*args, **kwargs):
9825 """
9826 ScrollWindow(self, int dx, int dy, Rect rect=None)
9827
9828 Physically scrolls the pixels in the window and move child windows
9829 accordingly. Use this function to optimise your scrolling
9830 implementations, to minimise the area that must be redrawn. Note that
9831 it is rarely required to call this function from a user program.
d55e5bfc
RD
9832 """
9833 return _core_.Window_ScrollWindow(*args, **kwargs)
9834
9835 def ScrollLines(*args, **kwargs):
9836 """
9837 ScrollLines(self, int lines) -> bool
9838
9839 If the platform and window class supports it, scrolls the window by
9840 the given number of lines down, if lines is positive, or up if lines
9841 is negative. Returns True if the window was scrolled, False if it was
9842 already on top/bottom and nothing was done.
9843 """
9844 return _core_.Window_ScrollLines(*args, **kwargs)
9845
9846 def ScrollPages(*args, **kwargs):
9847 """
9848 ScrollPages(self, int pages) -> bool
9849
79fccf9d 9850 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
9851 the given number of pages down, if pages is positive, or up if pages
9852 is negative. Returns True if the window was scrolled, False if it was
9853 already on top/bottom and nothing was done.
9854 """
9855 return _core_.Window_ScrollPages(*args, **kwargs)
9856
9857 def LineUp(*args, **kwargs):
9858 """
9859 LineUp(self) -> bool
9860
9861 This is just a wrapper for ScrollLines(-1).
9862 """
9863 return _core_.Window_LineUp(*args, **kwargs)
9864
9865 def LineDown(*args, **kwargs):
9866 """
9867 LineDown(self) -> bool
9868
9869 This is just a wrapper for ScrollLines(1).
9870 """
9871 return _core_.Window_LineDown(*args, **kwargs)
9872
9873 def PageUp(*args, **kwargs):
9874 """
9875 PageUp(self) -> bool
9876
9877 This is just a wrapper for ScrollPages(-1).
9878 """
9879 return _core_.Window_PageUp(*args, **kwargs)
9880
9881 def PageDown(*args, **kwargs):
9882 """
9883 PageDown(self) -> bool
9884
9885 This is just a wrapper for ScrollPages(1).
9886 """
9887 return _core_.Window_PageDown(*args, **kwargs)
9888
9889 def SetHelpText(*args, **kwargs):
9890 """
9891 SetHelpText(self, String text)
9892
9893 Sets the help text to be used as context-sensitive help for this
9894 window. Note that the text is actually stored by the current
9895 wxHelpProvider implementation, and not in the window object itself.
9896 """
9897 return _core_.Window_SetHelpText(*args, **kwargs)
9898
9899 def SetHelpTextForId(*args, **kwargs):
9900 """
9901 SetHelpTextForId(self, String text)
9902
9903 Associate this help text with all windows with the same id as this
9904 one.
9905 """
9906 return _core_.Window_SetHelpTextForId(*args, **kwargs)
9907
9908 def GetHelpText(*args, **kwargs):
9909 """
9910 GetHelpText(self) -> String
9911
9912 Gets the help text to be used as context-sensitive help for this
9913 window. Note that the text is actually stored by the current
9914 wxHelpProvider implementation, and not in the window object itself.
9915 """
9916 return _core_.Window_GetHelpText(*args, **kwargs)
9917
9918 def SetToolTipString(*args, **kwargs):
9919 """
9920 SetToolTipString(self, String tip)
9921
9922 Attach a tooltip to the window.
9923 """
9924 return _core_.Window_SetToolTipString(*args, **kwargs)
9925
9926 def SetToolTip(*args, **kwargs):
9927 """
9928 SetToolTip(self, ToolTip tip)
9929
9930 Attach a tooltip to the window.
9931 """
9932 return _core_.Window_SetToolTip(*args, **kwargs)
9933
9934 def GetToolTip(*args, **kwargs):
9935 """
9936 GetToolTip(self) -> ToolTip
9937
9938 get the associated tooltip or None if none
9939 """
9940 return _core_.Window_GetToolTip(*args, **kwargs)
9941
9942 def SetDropTarget(*args, **kwargs):
9943 """
9944 SetDropTarget(self, DropTarget dropTarget)
9945
9946 Associates a drop target with this window. If the window already has
9947 a drop target, it is deleted.
9948 """
9949 return _core_.Window_SetDropTarget(*args, **kwargs)
9950
9951 def GetDropTarget(*args, **kwargs):
9952 """
9953 GetDropTarget(self) -> DropTarget
9954
9955 Returns the associated drop target, which may be None.
9956 """
9957 return _core_.Window_GetDropTarget(*args, **kwargs)
9958
9959 def DragAcceptFiles(*args, **kwargs):
9960 """
9961 DragAcceptFiles(self, bool accept)
9962
9963 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
5ba5649b 9964 Only functional on Windows.
d55e5bfc
RD
9965 """
9966 return _core_.Window_DragAcceptFiles(*args, **kwargs)
9967
9968 def SetConstraints(*args, **kwargs):
9969 """
9970 SetConstraints(self, LayoutConstraints constraints)
9971
9972 Sets the window to have the given layout constraints. If an existing
9973 layout constraints object is already owned by the window, it will be
9974 deleted. Pass None to disassociate and delete the window's current
9975 constraints.
9976
9977 You must call SetAutoLayout to tell a window to use the constraints
9978 automatically in its default EVT_SIZE handler; otherwise, you must
9979 handle EVT_SIZE yourself and call Layout() explicitly. When setting
9980 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
9981 effect.
9982 """
9983 return _core_.Window_SetConstraints(*args, **kwargs)
9984
9985 def GetConstraints(*args, **kwargs):
9986 """
9987 GetConstraints(self) -> LayoutConstraints
9988
9989 Returns a pointer to the window's layout constraints, or None if there
9990 are none.
9991 """
9992 return _core_.Window_GetConstraints(*args, **kwargs)
9993
9994 def SetAutoLayout(*args, **kwargs):
9995 """
9996 SetAutoLayout(self, bool autoLayout)
9997
9998 Determines whether the Layout function will be called automatically
9999 when the window is resized. It is called implicitly by SetSizer but
10000 if you use SetConstraints you should call it manually or otherwise the
10001 window layout won't be correctly updated when its size changes.
10002 """
10003 return _core_.Window_SetAutoLayout(*args, **kwargs)
10004
10005 def GetAutoLayout(*args, **kwargs):
10006 """
10007 GetAutoLayout(self) -> bool
10008
10009 Returns the current autoLayout setting
10010 """
10011 return _core_.Window_GetAutoLayout(*args, **kwargs)
10012
10013 def Layout(*args, **kwargs):
10014 """
10015 Layout(self) -> bool
10016
10017 Invokes the constraint-based layout algorithm or the sizer-based
10018 algorithm for this window. See SetAutoLayout: when auto layout is on,
10019 this function gets called automatically by the default EVT_SIZE
10020 handler when the window is resized.
10021 """
10022 return _core_.Window_Layout(*args, **kwargs)
10023
10024 def SetSizer(*args, **kwargs):
10025 """
10026 SetSizer(self, Sizer sizer, bool deleteOld=True)
10027
10028 Sets the window to have the given layout sizer. The window will then
10029 own the object, and will take care of its deletion. If an existing
10030 layout sizer object is already owned by the window, it will be deleted
10031 if the deleteOld parameter is true. Note that this function will also
10032 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 10033 non-None, and False otherwise.
d55e5bfc
RD
10034 """
10035 return _core_.Window_SetSizer(*args, **kwargs)
10036
10037 def SetSizerAndFit(*args, **kwargs):
10038 """
10039 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
10040
10041 The same as SetSizer, except it also sets the size hints for the
10042 window based on the sizer's minimum size.
10043 """
10044 return _core_.Window_SetSizerAndFit(*args, **kwargs)
10045
10046 def GetSizer(*args, **kwargs):
10047 """
10048 GetSizer(self) -> Sizer
10049
10050 Return the sizer associated with the window by a previous call to
10051 SetSizer or None if there isn't one.
10052 """
10053 return _core_.Window_GetSizer(*args, **kwargs)
10054
10055 def SetContainingSizer(*args, **kwargs):
10056 """
10057 SetContainingSizer(self, Sizer sizer)
10058
10059 This normally does not need to be called by application code. It is
10060 called internally when a window is added to a sizer, and is used so
10061 the window can remove itself from the sizer when it is destroyed.
10062 """
10063 return _core_.Window_SetContainingSizer(*args, **kwargs)
10064
10065 def GetContainingSizer(*args, **kwargs):
10066 """
10067 GetContainingSizer(self) -> Sizer
10068
10069 Return the sizer that this window is a member of, if any, otherwise None.
10070 """
10071 return _core_.Window_GetContainingSizer(*args, **kwargs)
10072
10073 def InheritAttributes(*args, **kwargs):
10074 """
10075 InheritAttributes(self)
10076
79fccf9d
RD
10077 This function is (or should be, in case of custom controls) called
10078 during window creation to intelligently set up the window visual
10079 attributes, that is the font and the foreground and background
10080 colours.
10081
10082 By 'intelligently' the following is meant: by default, all windows use
10083 their own default attributes. However if some of the parent's
10084 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 10085 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD
10086 explicitly set for this window itself, then this window takes the same
10087 value as used by the parent. In addition, if the window overrides
10088 ShouldInheritColours to return false, the colours will not be changed
10089 no matter what and only the font might.
10090
ec9b55ca
RD
10091 This rather complicated logic is necessary in order to accommodate the
10092 different usage scenarios. The most common one is when all default
79fccf9d
RD
10093 attributes are used and in this case, nothing should be inherited as
10094 in modern GUIs different controls use different fonts (and colours)
10095 than their siblings so they can't inherit the same value from the
10096 parent. However it was also deemed desirable to allow to simply change
10097 the attributes of all children at once by just changing the font or
10098 colour of their common parent, hence in this case we do inherit the
10099 parents attributes.
10100
d55e5bfc
RD
10101 """
10102 return _core_.Window_InheritAttributes(*args, **kwargs)
10103
10104 def ShouldInheritColours(*args, **kwargs):
10105 """
10106 ShouldInheritColours(self) -> bool
10107
10108 Return true from here to allow the colours of this window to be
79fccf9d
RD
10109 changed by InheritAttributes, returning false forbids inheriting them
10110 from the parent window.
d55e5bfc 10111
79fccf9d
RD
10112 The base class version returns false, but this method is overridden in
10113 wxControl where it returns true.
d55e5bfc
RD
10114 """
10115 return _core_.Window_ShouldInheritColours(*args, **kwargs)
10116
10117 def PostCreate(self, pre):
10118 """
10119 Phase 3 of the 2-phase create <wink!>
10120 Call this method after precreating the window with the 2-phase create method.
10121 """
10122 self.this = pre.this
10123 self.thisown = pre.thisown
10124 pre.thisown = 0
10125 if hasattr(self, '_setOORInfo'):
10126 self._setOORInfo(self)
10127 if hasattr(self, '_setCallbackInfo'):
10128 self._setCallbackInfo(self, self.__class__)
10129
10130
10131class WindowPtr(Window):
10132 def __init__(self, this):
10133 self.this = this
10134 if not hasattr(self,"thisown"): self.thisown = 0
10135 self.__class__ = Window
10136_core_.Window_swigregister(WindowPtr)
10137
10138def PreWindow(*args, **kwargs):
10139 """
10140 PreWindow() -> Window
10141
10142 Precreate a Window for 2-phase creation.
10143 """
10144 val = _core_.new_PreWindow(*args, **kwargs)
10145 val.thisown = 1
10146 return val
10147
10148def Window_NewControlId(*args, **kwargs):
10149 """
10150 Window_NewControlId() -> int
10151
10152 Generate a control id for the controls which were not given one.
10153 """
10154 return _core_.Window_NewControlId(*args, **kwargs)
10155
10156def Window_NextControlId(*args, **kwargs):
10157 """
10158 Window_NextControlId(int winid) -> int
10159
10160 Get the id of the control following the one with the given
79fccf9d 10161 autogenerated) id
d55e5bfc
RD
10162 """
10163 return _core_.Window_NextControlId(*args, **kwargs)
10164
10165def Window_PrevControlId(*args, **kwargs):
10166 """
10167 Window_PrevControlId(int winid) -> int
10168
10169 Get the id of the control preceding the one with the given
79fccf9d 10170 autogenerated) id
d55e5bfc
RD
10171 """
10172 return _core_.Window_PrevControlId(*args, **kwargs)
10173
10174def Window_FindFocus(*args, **kwargs):
10175 """
10176 Window_FindFocus() -> Window
10177
10178 Returns the window or control that currently has the keyboard focus,
10179 or None.
10180 """
10181 return _core_.Window_FindFocus(*args, **kwargs)
10182
10183def Window_GetCapture(*args, **kwargs):
10184 """
10185 Window_GetCapture() -> Window
10186
10187 Returns the window which currently captures the mouse or None
10188 """
10189 return _core_.Window_GetCapture(*args, **kwargs)
10190
10191def Window_GetClassDefaultAttributes(*args, **kwargs):
10192 """
10193 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
10194
79fccf9d
RD
10195 Get the default attributes for this class. This is useful if you want
10196 to use the same font or colour in your own control as in a standard
10197 control -- which is a much better idea than hard coding specific
caef1a4d
RD
10198 colours or fonts which might look completely out of place on the
10199 user's system, especially if it uses themes.
d55e5bfc
RD
10200
10201 The variant parameter is only relevant under Mac currently and is
79fccf9d 10202 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
10203 the returned font. See `wx.Window.SetWindowVariant` for more about
10204 this.
d55e5bfc
RD
10205 """
10206 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
10207
10208def DLG_PNT(win, point_or_x, y=None):
10209 """
10210 Convenience function for converting a Point or (x,y) in
10211 dialog units to pixel units.
10212 """
10213 if y is None:
10214 return win.ConvertDialogPointToPixels(point_or_x)
10215 else:
10216 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
10217
10218def DLG_SZE(win, size_width, height=None):
10219 """
10220 Convenience function for converting a Size or (w,h) in
10221 dialog units to pixel units.
10222 """
10223 if height is None:
10224 return win.ConvertDialogSizeToPixels(size_width)
10225 else:
10226 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
10227
10228
10229def FindWindowById(*args, **kwargs):
10230 """
10231 FindWindowById(long id, Window parent=None) -> Window
10232
10233 Find the first window in the application with the given id. If parent
10234 is None, the search will start from all top-level frames and dialog
10235 boxes; if non-None, the search will be limited to the given window
10236 hierarchy. The search is recursive in both cases.
10237 """
10238 return _core_.FindWindowById(*args, **kwargs)
10239
10240def FindWindowByName(*args, **kwargs):
10241 """
10242 FindWindowByName(String name, Window parent=None) -> Window
10243
10244 Find a window by its name (as given in a window constructor or Create
10245 function call). If parent is None, the search will start from all
10246 top-level frames and dialog boxes; if non-None, the search will be
10247 limited to the given window hierarchy. The search is recursive in both
10248 cases.
10249
10250 If no window with such name is found, wx.FindWindowByLabel is called.
10251 """
10252 return _core_.FindWindowByName(*args, **kwargs)
10253
10254def FindWindowByLabel(*args, **kwargs):
10255 """
10256 FindWindowByLabel(String label, Window parent=None) -> Window
10257
10258 Find a window by its label. Depending on the type of window, the label
10259 may be a window title or panel item label. If parent is None, the
10260 search will start from all top-level frames and dialog boxes; if
10261 non-None, the search will be limited to the given window
10262 hierarchy. The search is recursive in both cases.
10263 """
10264 return _core_.FindWindowByLabel(*args, **kwargs)
10265
10266def Window_FromHWND(*args, **kwargs):
10267 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
10268 return _core_.Window_FromHWND(*args, **kwargs)
3215336e
RD
10269
10270def GetTopLevelWindows(*args, **kwargs):
10271 """
10272 GetTopLevelWindows() -> PyObject
10273
10274 Returns a list of the the application's top-level windows, (frames,
10275 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
10276 by wxWidgets, and so it is only valid as long as no top-level windows
10277 are closed or new top-level windows are created.
10278
10279 """
10280 return _core_.GetTopLevelWindows(*args, **kwargs)
d55e5bfc
RD
10281#---------------------------------------------------------------------------
10282
10283class Validator(EvtHandler):
093d3ff1 10284 """Proxy of C++ Validator class"""
d55e5bfc
RD
10285 def __repr__(self):
10286 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10287 def __init__(self, *args, **kwargs):
10288 """__init__(self) -> Validator"""
10289 newobj = _core_.new_Validator(*args, **kwargs)
10290 self.this = newobj.this
10291 self.thisown = 1
10292 del newobj.thisown
10293 self._setOORInfo(self)
10294
10295 def Clone(*args, **kwargs):
10296 """Clone(self) -> Validator"""
10297 return _core_.Validator_Clone(*args, **kwargs)
10298
10299 def Validate(*args, **kwargs):
10300 """Validate(self, Window parent) -> bool"""
10301 return _core_.Validator_Validate(*args, **kwargs)
10302
10303 def TransferToWindow(*args, **kwargs):
10304 """TransferToWindow(self) -> bool"""
10305 return _core_.Validator_TransferToWindow(*args, **kwargs)
10306
10307 def TransferFromWindow(*args, **kwargs):
10308 """TransferFromWindow(self) -> bool"""
10309 return _core_.Validator_TransferFromWindow(*args, **kwargs)
10310
10311 def GetWindow(*args, **kwargs):
10312 """GetWindow(self) -> Window"""
10313 return _core_.Validator_GetWindow(*args, **kwargs)
10314
10315 def SetWindow(*args, **kwargs):
10316 """SetWindow(self, Window window)"""
10317 return _core_.Validator_SetWindow(*args, **kwargs)
10318
10319 def IsSilent(*args, **kwargs):
c24da6d6 10320 """IsSilent() -> bool"""
d55e5bfc
RD
10321 return _core_.Validator_IsSilent(*args, **kwargs)
10322
10323 IsSilent = staticmethod(IsSilent)
10324 def SetBellOnError(*args, **kwargs):
c24da6d6 10325 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
10326 return _core_.Validator_SetBellOnError(*args, **kwargs)
10327
10328 SetBellOnError = staticmethod(SetBellOnError)
10329
10330class ValidatorPtr(Validator):
10331 def __init__(self, this):
10332 self.this = this
10333 if not hasattr(self,"thisown"): self.thisown = 0
10334 self.__class__ = Validator
10335_core_.Validator_swigregister(ValidatorPtr)
10336
10337def Validator_IsSilent(*args, **kwargs):
10338 """Validator_IsSilent() -> bool"""
10339 return _core_.Validator_IsSilent(*args, **kwargs)
10340
10341def Validator_SetBellOnError(*args, **kwargs):
10342 """Validator_SetBellOnError(int doIt=True)"""
10343 return _core_.Validator_SetBellOnError(*args, **kwargs)
10344
10345class PyValidator(Validator):
093d3ff1 10346 """Proxy of C++ PyValidator class"""
d55e5bfc
RD
10347 def __repr__(self):
10348 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10349 def __init__(self, *args, **kwargs):
10350 """__init__(self) -> PyValidator"""
10351 newobj = _core_.new_PyValidator(*args, **kwargs)
10352 self.this = newobj.this
10353 self.thisown = 1
10354 del newobj.thisown
10355
10356 self._setCallbackInfo(self, PyValidator, 1)
10357 self._setOORInfo(self)
10358
10359 def _setCallbackInfo(*args, **kwargs):
10360 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
10361 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
10362
10363
10364class PyValidatorPtr(PyValidator):
10365 def __init__(self, this):
10366 self.this = this
10367 if not hasattr(self,"thisown"): self.thisown = 0
10368 self.__class__ = PyValidator
10369_core_.PyValidator_swigregister(PyValidatorPtr)
10370
10371#---------------------------------------------------------------------------
10372
10373class Menu(EvtHandler):
093d3ff1 10374 """Proxy of C++ Menu class"""
d55e5bfc
RD
10375 def __repr__(self):
10376 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10377 def __init__(self, *args, **kwargs):
10378 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
10379 newobj = _core_.new_Menu(*args, **kwargs)
10380 self.this = newobj.this
10381 self.thisown = 1
10382 del newobj.thisown
10383 self._setOORInfo(self)
10384
10385 def Append(*args, **kwargs):
10386 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
10387 return _core_.Menu_Append(*args, **kwargs)
10388
10389 def AppendSeparator(*args, **kwargs):
10390 """AppendSeparator(self) -> MenuItem"""
10391 return _core_.Menu_AppendSeparator(*args, **kwargs)
10392
10393 def AppendCheckItem(*args, **kwargs):
10394 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10395 return _core_.Menu_AppendCheckItem(*args, **kwargs)
10396
10397 def AppendRadioItem(*args, **kwargs):
10398 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10399 return _core_.Menu_AppendRadioItem(*args, **kwargs)
10400
10401 def AppendMenu(*args, **kwargs):
10402 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10403 return _core_.Menu_AppendMenu(*args, **kwargs)
10404
10405 def AppendItem(*args, **kwargs):
10406 """AppendItem(self, MenuItem item) -> MenuItem"""
10407 return _core_.Menu_AppendItem(*args, **kwargs)
10408
10409 def Break(*args, **kwargs):
10410 """Break(self)"""
10411 return _core_.Menu_Break(*args, **kwargs)
10412
10413 def InsertItem(*args, **kwargs):
10414 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
10415 return _core_.Menu_InsertItem(*args, **kwargs)
10416
10417 def Insert(*args, **kwargs):
10418 """
10419 Insert(self, size_t pos, int id, String text, String help=EmptyString,
10420 int kind=ITEM_NORMAL) -> MenuItem
10421 """
10422 return _core_.Menu_Insert(*args, **kwargs)
10423
10424 def InsertSeparator(*args, **kwargs):
10425 """InsertSeparator(self, size_t pos) -> MenuItem"""
10426 return _core_.Menu_InsertSeparator(*args, **kwargs)
10427
10428 def InsertCheckItem(*args, **kwargs):
10429 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10430 return _core_.Menu_InsertCheckItem(*args, **kwargs)
10431
10432 def InsertRadioItem(*args, **kwargs):
10433 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
10434 return _core_.Menu_InsertRadioItem(*args, **kwargs)
10435
10436 def InsertMenu(*args, **kwargs):
10437 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10438 return _core_.Menu_InsertMenu(*args, **kwargs)
10439
10440 def PrependItem(*args, **kwargs):
10441 """PrependItem(self, MenuItem item) -> MenuItem"""
10442 return _core_.Menu_PrependItem(*args, **kwargs)
10443
10444 def Prepend(*args, **kwargs):
10445 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
10446 return _core_.Menu_Prepend(*args, **kwargs)
10447
10448 def PrependSeparator(*args, **kwargs):
10449 """PrependSeparator(self) -> MenuItem"""
10450 return _core_.Menu_PrependSeparator(*args, **kwargs)
10451
10452 def PrependCheckItem(*args, **kwargs):
10453 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10454 return _core_.Menu_PrependCheckItem(*args, **kwargs)
10455
10456 def PrependRadioItem(*args, **kwargs):
10457 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
10458 return _core_.Menu_PrependRadioItem(*args, **kwargs)
10459
10460 def PrependMenu(*args, **kwargs):
10461 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
10462 return _core_.Menu_PrependMenu(*args, **kwargs)
10463
10464 def Remove(*args, **kwargs):
10465 """Remove(self, int id) -> MenuItem"""
10466 return _core_.Menu_Remove(*args, **kwargs)
10467
10468 def RemoveItem(*args, **kwargs):
10469 """RemoveItem(self, MenuItem item) -> MenuItem"""
10470 return _core_.Menu_RemoveItem(*args, **kwargs)
10471
10472 def Delete(*args, **kwargs):
10473 """Delete(self, int id) -> bool"""
10474 return _core_.Menu_Delete(*args, **kwargs)
10475
10476 def DeleteItem(*args, **kwargs):
10477 """DeleteItem(self, MenuItem item) -> bool"""
10478 return _core_.Menu_DeleteItem(*args, **kwargs)
10479
10480 def Destroy(*args, **kwargs):
10481 """
10482 Destroy(self)
10483
10484 Deletes the C++ object this Python object is a proxy for.
10485 """
10486 return _core_.Menu_Destroy(*args, **kwargs)
10487
10488 def DestroyId(*args, **kwargs):
10489 """
10490 DestroyId(self, int id) -> bool
10491
10492 Deletes the C++ object this Python object is a proxy for.
10493 """
10494 return _core_.Menu_DestroyId(*args, **kwargs)
10495
10496 def DestroyItem(*args, **kwargs):
10497 """
10498 DestroyItem(self, MenuItem item) -> bool
10499
10500 Deletes the C++ object this Python object is a proxy for.
10501 """
10502 return _core_.Menu_DestroyItem(*args, **kwargs)
10503
10504 def GetMenuItemCount(*args, **kwargs):
10505 """GetMenuItemCount(self) -> size_t"""
10506 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
10507
10508 def GetMenuItems(*args, **kwargs):
10509 """GetMenuItems(self) -> PyObject"""
10510 return _core_.Menu_GetMenuItems(*args, **kwargs)
10511
10512 def FindItem(*args, **kwargs):
10513 """FindItem(self, String item) -> int"""
10514 return _core_.Menu_FindItem(*args, **kwargs)
10515
10516 def FindItemById(*args, **kwargs):
10517 """FindItemById(self, int id) -> MenuItem"""
10518 return _core_.Menu_FindItemById(*args, **kwargs)
10519
10520 def FindItemByPosition(*args, **kwargs):
10521 """FindItemByPosition(self, size_t position) -> MenuItem"""
10522 return _core_.Menu_FindItemByPosition(*args, **kwargs)
10523
10524 def Enable(*args, **kwargs):
10525 """Enable(self, int id, bool enable)"""
10526 return _core_.Menu_Enable(*args, **kwargs)
10527
10528 def IsEnabled(*args, **kwargs):
10529 """IsEnabled(self, int id) -> bool"""
10530 return _core_.Menu_IsEnabled(*args, **kwargs)
10531
10532 def Check(*args, **kwargs):
10533 """Check(self, int id, bool check)"""
10534 return _core_.Menu_Check(*args, **kwargs)
10535
10536 def IsChecked(*args, **kwargs):
10537 """IsChecked(self, int id) -> bool"""
10538 return _core_.Menu_IsChecked(*args, **kwargs)
10539
10540 def SetLabel(*args, **kwargs):
10541 """SetLabel(self, int id, String label)"""
10542 return _core_.Menu_SetLabel(*args, **kwargs)
10543
10544 def GetLabel(*args, **kwargs):
10545 """GetLabel(self, int id) -> String"""
10546 return _core_.Menu_GetLabel(*args, **kwargs)
10547
10548 def SetHelpString(*args, **kwargs):
10549 """SetHelpString(self, int id, String helpString)"""
10550 return _core_.Menu_SetHelpString(*args, **kwargs)
10551
10552 def GetHelpString(*args, **kwargs):
10553 """GetHelpString(self, int id) -> String"""
10554 return _core_.Menu_GetHelpString(*args, **kwargs)
10555
10556 def SetTitle(*args, **kwargs):
10557 """SetTitle(self, String title)"""
10558 return _core_.Menu_SetTitle(*args, **kwargs)
10559
10560 def GetTitle(*args, **kwargs):
10561 """GetTitle(self) -> String"""
10562 return _core_.Menu_GetTitle(*args, **kwargs)
10563
10564 def SetEventHandler(*args, **kwargs):
10565 """SetEventHandler(self, EvtHandler handler)"""
10566 return _core_.Menu_SetEventHandler(*args, **kwargs)
10567
10568 def GetEventHandler(*args, **kwargs):
10569 """GetEventHandler(self) -> EvtHandler"""
10570 return _core_.Menu_GetEventHandler(*args, **kwargs)
10571
10572 def SetInvokingWindow(*args, **kwargs):
10573 """SetInvokingWindow(self, Window win)"""
10574 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
10575
10576 def GetInvokingWindow(*args, **kwargs):
10577 """GetInvokingWindow(self) -> Window"""
10578 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
10579
10580 def GetStyle(*args, **kwargs):
10581 """GetStyle(self) -> long"""
10582 return _core_.Menu_GetStyle(*args, **kwargs)
10583
10584 def UpdateUI(*args, **kwargs):
10585 """UpdateUI(self, EvtHandler source=None)"""
10586 return _core_.Menu_UpdateUI(*args, **kwargs)
10587
10588 def GetMenuBar(*args, **kwargs):
10589 """GetMenuBar(self) -> MenuBar"""
10590 return _core_.Menu_GetMenuBar(*args, **kwargs)
10591
10592 def Attach(*args, **kwargs):
10593 """Attach(self, wxMenuBarBase menubar)"""
10594 return _core_.Menu_Attach(*args, **kwargs)
10595
10596 def Detach(*args, **kwargs):
10597 """Detach(self)"""
10598 return _core_.Menu_Detach(*args, **kwargs)
10599
10600 def IsAttached(*args, **kwargs):
10601 """IsAttached(self) -> bool"""
10602 return _core_.Menu_IsAttached(*args, **kwargs)
10603
10604 def SetParent(*args, **kwargs):
10605 """SetParent(self, Menu parent)"""
10606 return _core_.Menu_SetParent(*args, **kwargs)
10607
10608 def GetParent(*args, **kwargs):
10609 """GetParent(self) -> Menu"""
10610 return _core_.Menu_GetParent(*args, **kwargs)
10611
10612
10613class MenuPtr(Menu):
10614 def __init__(self, this):
10615 self.this = this
10616 if not hasattr(self,"thisown"): self.thisown = 0
10617 self.__class__ = Menu
10618_core_.Menu_swigregister(MenuPtr)
10619DefaultValidator = cvar.DefaultValidator
10620
10621#---------------------------------------------------------------------------
10622
10623class MenuBar(Window):
093d3ff1 10624 """Proxy of C++ MenuBar class"""
d55e5bfc
RD
10625 def __repr__(self):
10626 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10627 def __init__(self, *args, **kwargs):
10628 """__init__(self, long style=0) -> MenuBar"""
10629 newobj = _core_.new_MenuBar(*args, **kwargs)
10630 self.this = newobj.this
10631 self.thisown = 1
10632 del newobj.thisown
10633 self._setOORInfo(self)
10634
10635 def Append(*args, **kwargs):
10636 """Append(self, Menu menu, String title) -> bool"""
10637 return _core_.MenuBar_Append(*args, **kwargs)
10638
10639 def Insert(*args, **kwargs):
10640 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
10641 return _core_.MenuBar_Insert(*args, **kwargs)
10642
10643 def GetMenuCount(*args, **kwargs):
10644 """GetMenuCount(self) -> size_t"""
10645 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
10646
10647 def GetMenu(*args, **kwargs):
10648 """GetMenu(self, size_t pos) -> Menu"""
10649 return _core_.MenuBar_GetMenu(*args, **kwargs)
10650
10651 def Replace(*args, **kwargs):
10652 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
10653 return _core_.MenuBar_Replace(*args, **kwargs)
10654
10655 def Remove(*args, **kwargs):
10656 """Remove(self, size_t pos) -> Menu"""
10657 return _core_.MenuBar_Remove(*args, **kwargs)
10658
10659 def EnableTop(*args, **kwargs):
10660 """EnableTop(self, size_t pos, bool enable)"""
10661 return _core_.MenuBar_EnableTop(*args, **kwargs)
10662
10663 def IsEnabledTop(*args, **kwargs):
10664 """IsEnabledTop(self, size_t pos) -> bool"""
10665 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
10666
10667 def SetLabelTop(*args, **kwargs):
10668 """SetLabelTop(self, size_t pos, String label)"""
10669 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
10670
10671 def GetLabelTop(*args, **kwargs):
10672 """GetLabelTop(self, size_t pos) -> String"""
10673 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
10674
10675 def FindMenuItem(*args, **kwargs):
10676 """FindMenuItem(self, String menu, String item) -> int"""
10677 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
10678
10679 def FindItemById(*args, **kwargs):
10680 """FindItemById(self, int id) -> MenuItem"""
10681 return _core_.MenuBar_FindItemById(*args, **kwargs)
10682
10683 def FindMenu(*args, **kwargs):
10684 """FindMenu(self, String title) -> int"""
10685 return _core_.MenuBar_FindMenu(*args, **kwargs)
10686
10687 def Enable(*args, **kwargs):
10688 """Enable(self, int id, bool enable)"""
10689 return _core_.MenuBar_Enable(*args, **kwargs)
10690
10691 def Check(*args, **kwargs):
10692 """Check(self, int id, bool check)"""
10693 return _core_.MenuBar_Check(*args, **kwargs)
10694
10695 def IsChecked(*args, **kwargs):
10696 """IsChecked(self, int id) -> bool"""
10697 return _core_.MenuBar_IsChecked(*args, **kwargs)
10698
10699 def IsEnabled(*args, **kwargs):
10700 """IsEnabled(self, int id) -> bool"""
10701 return _core_.MenuBar_IsEnabled(*args, **kwargs)
10702
10703 def SetLabel(*args, **kwargs):
10704 """SetLabel(self, int id, String label)"""
10705 return _core_.MenuBar_SetLabel(*args, **kwargs)
10706
10707 def GetLabel(*args, **kwargs):
10708 """GetLabel(self, int id) -> String"""
10709 return _core_.MenuBar_GetLabel(*args, **kwargs)
10710
10711 def SetHelpString(*args, **kwargs):
10712 """SetHelpString(self, int id, String helpString)"""
10713 return _core_.MenuBar_SetHelpString(*args, **kwargs)
10714
10715 def GetHelpString(*args, **kwargs):
10716 """GetHelpString(self, int id) -> String"""
10717 return _core_.MenuBar_GetHelpString(*args, **kwargs)
10718
10719 def GetFrame(*args, **kwargs):
10720 """GetFrame(self) -> wxFrame"""
10721 return _core_.MenuBar_GetFrame(*args, **kwargs)
10722
10723 def IsAttached(*args, **kwargs):
10724 """IsAttached(self) -> bool"""
10725 return _core_.MenuBar_IsAttached(*args, **kwargs)
10726
10727 def Attach(*args, **kwargs):
10728 """Attach(self, wxFrame frame)"""
10729 return _core_.MenuBar_Attach(*args, **kwargs)
10730
10731 def Detach(*args, **kwargs):
10732 """Detach(self)"""
10733 return _core_.MenuBar_Detach(*args, **kwargs)
10734
db67f999
RD
10735 def SetAutoWindowMenu(*args, **kwargs):
10736 """SetAutoWindowMenu(bool enable)"""
10737 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10738
10739 SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
10740 def GetAutoWindowMenu(*args, **kwargs):
10741 """GetAutoWindowMenu() -> bool"""
10742 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10743
10744 GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
d55e5bfc
RD
10745
10746class MenuBarPtr(MenuBar):
10747 def __init__(self, this):
10748 self.this = this
10749 if not hasattr(self,"thisown"): self.thisown = 0
10750 self.__class__ = MenuBar
10751_core_.MenuBar_swigregister(MenuBarPtr)
10752
db67f999
RD
10753def MenuBar_SetAutoWindowMenu(*args, **kwargs):
10754 """MenuBar_SetAutoWindowMenu(bool enable)"""
10755 return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
10756
10757def MenuBar_GetAutoWindowMenu(*args, **kwargs):
10758 """MenuBar_GetAutoWindowMenu() -> bool"""
10759 return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
10760
d55e5bfc
RD
10761#---------------------------------------------------------------------------
10762
10763class MenuItem(Object):
093d3ff1 10764 """Proxy of C++ MenuItem class"""
d55e5bfc
RD
10765 def __repr__(self):
10766 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10767 def __init__(self, *args, **kwargs):
10768 """
10769 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
10770 String help=EmptyString, int kind=ITEM_NORMAL,
10771 Menu subMenu=None) -> MenuItem
10772 """
10773 newobj = _core_.new_MenuItem(*args, **kwargs)
10774 self.this = newobj.this
10775 self.thisown = 1
10776 del newobj.thisown
10777 def GetMenu(*args, **kwargs):
10778 """GetMenu(self) -> Menu"""
10779 return _core_.MenuItem_GetMenu(*args, **kwargs)
10780
10781 def SetMenu(*args, **kwargs):
10782 """SetMenu(self, Menu menu)"""
10783 return _core_.MenuItem_SetMenu(*args, **kwargs)
10784
10785 def SetId(*args, **kwargs):
10786 """SetId(self, int id)"""
10787 return _core_.MenuItem_SetId(*args, **kwargs)
10788
10789 def GetId(*args, **kwargs):
10790 """GetId(self) -> int"""
10791 return _core_.MenuItem_GetId(*args, **kwargs)
10792
10793 def IsSeparator(*args, **kwargs):
10794 """IsSeparator(self) -> bool"""
10795 return _core_.MenuItem_IsSeparator(*args, **kwargs)
10796
10797 def SetText(*args, **kwargs):
10798 """SetText(self, String str)"""
10799 return _core_.MenuItem_SetText(*args, **kwargs)
10800
10801 def GetLabel(*args, **kwargs):
10802 """GetLabel(self) -> String"""
10803 return _core_.MenuItem_GetLabel(*args, **kwargs)
10804
10805 def GetText(*args, **kwargs):
10806 """GetText(self) -> String"""
10807 return _core_.MenuItem_GetText(*args, **kwargs)
10808
10809 def GetLabelFromText(*args, **kwargs):
c24da6d6 10810 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
10811 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10812
10813 GetLabelFromText = staticmethod(GetLabelFromText)
10814 def GetKind(*args, **kwargs):
10815 """GetKind(self) -> int"""
10816 return _core_.MenuItem_GetKind(*args, **kwargs)
10817
10818 def SetKind(*args, **kwargs):
10819 """SetKind(self, int kind)"""
10820 return _core_.MenuItem_SetKind(*args, **kwargs)
10821
10822 def SetCheckable(*args, **kwargs):
10823 """SetCheckable(self, bool checkable)"""
10824 return _core_.MenuItem_SetCheckable(*args, **kwargs)
10825
10826 def IsCheckable(*args, **kwargs):
10827 """IsCheckable(self) -> bool"""
10828 return _core_.MenuItem_IsCheckable(*args, **kwargs)
10829
10830 def IsSubMenu(*args, **kwargs):
10831 """IsSubMenu(self) -> bool"""
10832 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
10833
10834 def SetSubMenu(*args, **kwargs):
10835 """SetSubMenu(self, Menu menu)"""
10836 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
10837
10838 def GetSubMenu(*args, **kwargs):
10839 """GetSubMenu(self) -> Menu"""
10840 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
10841
10842 def Enable(*args, **kwargs):
10843 """Enable(self, bool enable=True)"""
10844 return _core_.MenuItem_Enable(*args, **kwargs)
10845
10846 def IsEnabled(*args, **kwargs):
10847 """IsEnabled(self) -> bool"""
10848 return _core_.MenuItem_IsEnabled(*args, **kwargs)
10849
10850 def Check(*args, **kwargs):
10851 """Check(self, bool check=True)"""
10852 return _core_.MenuItem_Check(*args, **kwargs)
10853
10854 def IsChecked(*args, **kwargs):
10855 """IsChecked(self) -> bool"""
10856 return _core_.MenuItem_IsChecked(*args, **kwargs)
10857
10858 def Toggle(*args, **kwargs):
10859 """Toggle(self)"""
10860 return _core_.MenuItem_Toggle(*args, **kwargs)
10861
10862 def SetHelp(*args, **kwargs):
10863 """SetHelp(self, String str)"""
10864 return _core_.MenuItem_SetHelp(*args, **kwargs)
10865
10866 def GetHelp(*args, **kwargs):
10867 """GetHelp(self) -> String"""
10868 return _core_.MenuItem_GetHelp(*args, **kwargs)
10869
10870 def GetAccel(*args, **kwargs):
10871 """GetAccel(self) -> AcceleratorEntry"""
10872 return _core_.MenuItem_GetAccel(*args, **kwargs)
10873
10874 def SetAccel(*args, **kwargs):
10875 """SetAccel(self, AcceleratorEntry accel)"""
10876 return _core_.MenuItem_SetAccel(*args, **kwargs)
10877
10878 def SetFont(*args, **kwargs):
10879 """SetFont(self, Font font)"""
10880 return _core_.MenuItem_SetFont(*args, **kwargs)
10881
10882 def GetFont(*args, **kwargs):
10883 """GetFont(self) -> Font"""
10884 return _core_.MenuItem_GetFont(*args, **kwargs)
10885
10886 def SetTextColour(*args, **kwargs):
10887 """SetTextColour(self, Colour colText)"""
10888 return _core_.MenuItem_SetTextColour(*args, **kwargs)
10889
10890 def GetTextColour(*args, **kwargs):
10891 """GetTextColour(self) -> Colour"""
10892 return _core_.MenuItem_GetTextColour(*args, **kwargs)
10893
10894 def SetBackgroundColour(*args, **kwargs):
10895 """SetBackgroundColour(self, Colour colBack)"""
10896 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
10897
10898 def GetBackgroundColour(*args, **kwargs):
10899 """GetBackgroundColour(self) -> Colour"""
10900 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
10901
10902 def SetBitmaps(*args, **kwargs):
10903 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
10904 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
10905
10906 def SetDisabledBitmap(*args, **kwargs):
10907 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
10908 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
10909
10910 def GetDisabledBitmap(*args, **kwargs):
10911 """GetDisabledBitmap(self) -> Bitmap"""
10912 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
10913
10914 def SetMarginWidth(*args, **kwargs):
10915 """SetMarginWidth(self, int nWidth)"""
10916 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
10917
10918 def GetMarginWidth(*args, **kwargs):
10919 """GetMarginWidth(self) -> int"""
10920 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
10921
10922 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 10923 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
10924 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10925
10926 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
10927 def IsOwnerDrawn(*args, **kwargs):
10928 """IsOwnerDrawn(self) -> bool"""
10929 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
10930
10931 def SetOwnerDrawn(*args, **kwargs):
10932 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
10933 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
10934
10935 def ResetOwnerDrawn(*args, **kwargs):
10936 """ResetOwnerDrawn(self)"""
10937 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
10938
10939 def SetBitmap(*args, **kwargs):
10940 """SetBitmap(self, Bitmap bitmap)"""
10941 return _core_.MenuItem_SetBitmap(*args, **kwargs)
10942
10943 def GetBitmap(*args, **kwargs):
10944 """GetBitmap(self) -> Bitmap"""
10945 return _core_.MenuItem_GetBitmap(*args, **kwargs)
10946
10947
10948class MenuItemPtr(MenuItem):
10949 def __init__(self, this):
10950 self.this = this
10951 if not hasattr(self,"thisown"): self.thisown = 0
10952 self.__class__ = MenuItem
10953_core_.MenuItem_swigregister(MenuItemPtr)
10954
10955def MenuItem_GetLabelFromText(*args, **kwargs):
10956 """MenuItem_GetLabelFromText(String text) -> String"""
10957 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
10958
10959def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
10960 """MenuItem_GetDefaultMarginWidth() -> int"""
10961 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
10962
10963#---------------------------------------------------------------------------
10964
10965class Control(Window):
10966 """
10967 This is the base class for a control or 'widget'.
10968
79fccf9d
RD
10969 A control is generally a small window which processes user input
10970 and/or displays one or more item of data.
d55e5bfc
RD
10971 """
10972 def __repr__(self):
10973 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10974 def __init__(self, *args, **kwargs):
10975 """
248ed943
RD
10976 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
10977 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
10978 String name=ControlNameStr) -> Control
10979
79fccf9d
RD
10980 Create a Control. Normally you should only call this from a subclass'
10981 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
10982 """
10983 newobj = _core_.new_Control(*args, **kwargs)
10984 self.this = newobj.this
10985 self.thisown = 1
10986 del newobj.thisown
10987 self._setOORInfo(self)
10988
10989 def Create(*args, **kwargs):
10990 """
248ed943
RD
10991 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
10992 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
10993 String name=ControlNameStr) -> bool
10994
10995 Do the 2nd phase and create the GUI control.
10996 """
10997 return _core_.Control_Create(*args, **kwargs)
10998
10999 def Command(*args, **kwargs):
11000 """
11001 Command(self, CommandEvent event)
11002
79fccf9d
RD
11003 Simulates the effect of the user issuing a command to the item.
11004
11005 :see: `wx.CommandEvent`
11006
d55e5bfc
RD
11007 """
11008 return _core_.Control_Command(*args, **kwargs)
11009
11010 def GetLabel(*args, **kwargs):
11011 """
11012 GetLabel(self) -> String
11013
11014 Return a control's text.
11015 """
11016 return _core_.Control_GetLabel(*args, **kwargs)
11017
11018 def SetLabel(*args, **kwargs):
11019 """
11020 SetLabel(self, String label)
11021
11022 Sets the item's text.
11023 """
11024 return _core_.Control_SetLabel(*args, **kwargs)
11025
a001823c 11026 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 11027 """
a001823c 11028 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 11029
a001823c
RD
11030 Get the default attributes for this class. This is useful if you want
11031 to use the same font or colour in your own control as in a standard
11032 control -- which is a much better idea than hard coding specific
11033 colours or fonts which might look completely out of place on the
11034 user's system, especially if it uses themes.
f8167d6e 11035
a001823c
RD
11036 The variant parameter is only relevant under Mac currently and is
11037 ignore under other platforms. Under Mac, it will change the size of
11038 the returned font. See `wx.Window.SetWindowVariant` for more about
11039 this.
f8167d6e 11040 """
d55e5bfc
RD
11041 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11042
11043 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
11044
11045class ControlPtr(Control):
11046 def __init__(self, this):
11047 self.this = this
11048 if not hasattr(self,"thisown"): self.thisown = 0
11049 self.__class__ = Control
11050_core_.Control_swigregister(ControlPtr)
11051ControlNameStr = cvar.ControlNameStr
11052
11053def PreControl(*args, **kwargs):
11054 """
11055 PreControl() -> Control
11056
11057 Precreate a Control control for 2-phase creation
11058 """
11059 val = _core_.new_PreControl(*args, **kwargs)
11060 val.thisown = 1
11061 return val
11062
11063def Control_GetClassDefaultAttributes(*args, **kwargs):
a001823c
RD
11064 """
11065 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
11066
11067 Get the default attributes for this class. This is useful if you want
11068 to use the same font or colour in your own control as in a standard
11069 control -- which is a much better idea than hard coding specific
11070 colours or fonts which might look completely out of place on the
11071 user's system, especially if it uses themes.
11072
11073 The variant parameter is only relevant under Mac currently and is
11074 ignore under other platforms. Under Mac, it will change the size of
11075 the returned font. See `wx.Window.SetWindowVariant` for more about
11076 this.
11077 """
d55e5bfc
RD
11078 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
11079
11080#---------------------------------------------------------------------------
11081
11082class ItemContainer(object):
11083 """
53aa7709
RD
11084 The wx.ItemContainer class defines an interface which is implemented
11085 by all controls which have string subitems, each of which may be
11086 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
11087 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 11088 this one.
d55e5bfc 11089
79fccf9d
RD
11090 It defines the methods for accessing the control's items and although
11091 each of the derived classes implements them differently, they still
11092 all conform to the same interface.
d55e5bfc 11093
79fccf9d
RD
11094 The items in a wx.ItemContainer have (non empty) string labels and,
11095 optionally, client data associated with them.
d55e5bfc
RD
11096
11097 """
11098 def __init__(self): raise RuntimeError, "No constructor defined"
11099 def __repr__(self):
11100 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11101 def Append(*args, **kwargs):
11102 """
11103 Append(self, String item, PyObject clientData=None) -> int
11104
79fccf9d
RD
11105 Adds the item to the control, associating the given data with the item
11106 if not None. The return value is the index of the newly added item
11107 which may be different from the last one if the control is sorted (e.g.
11108 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
11109 """
11110 return _core_.ItemContainer_Append(*args, **kwargs)
11111
11112 def AppendItems(*args, **kwargs):
11113 """
f5b96ee1 11114 AppendItems(self, List strings)
d55e5bfc 11115
79fccf9d
RD
11116 Apend several items at once to the control. Notice that calling this
11117 method may be much faster than appending the items one by one if you
11118 need to add a lot of items.
d55e5bfc
RD
11119 """
11120 return _core_.ItemContainer_AppendItems(*args, **kwargs)
11121
11122 def Insert(*args, **kwargs):
11123 """
11124 Insert(self, String item, int pos, PyObject clientData=None) -> int
11125
79fccf9d 11126 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
11127 optionally associating some data object with the item.
11128 """
11129 return _core_.ItemContainer_Insert(*args, **kwargs)
11130
11131 def Clear(*args, **kwargs):
11132 """
11133 Clear(self)
11134
11135 Removes all items from the control.
11136 """
11137 return _core_.ItemContainer_Clear(*args, **kwargs)
11138
11139 def Delete(*args, **kwargs):
11140 """
11141 Delete(self, int n)
11142
79fccf9d
RD
11143 Deletes the item at the zero-based index 'n' from the control. Note
11144 that it is an error (signalled by a `wx.PyAssertionError` exception if
11145 enabled) to remove an item with the index negative or greater or equal
11146 than the number of items in the control.
d55e5bfc
RD
11147 """
11148 return _core_.ItemContainer_Delete(*args, **kwargs)
11149
53aa7709
RD
11150 def GetClientData(*args, **kwargs):
11151 """
11152 GetClientData(self, int n) -> PyObject
11153
11154 Returns the client data associated with the given item, (if any.)
11155 """
11156 return _core_.ItemContainer_GetClientData(*args, **kwargs)
11157
11158 def SetClientData(*args, **kwargs):
11159 """
11160 SetClientData(self, int n, PyObject clientData)
11161
11162 Associate the given client data with the item at position n.
11163 """
11164 return _core_.ItemContainer_SetClientData(*args, **kwargs)
11165
d55e5bfc
RD
11166 def GetCount(*args, **kwargs):
11167 """
11168 GetCount(self) -> int
11169
11170 Returns the number of items in the control.
11171 """
11172 return _core_.ItemContainer_GetCount(*args, **kwargs)
11173
11174 def IsEmpty(*args, **kwargs):
11175 """
11176 IsEmpty(self) -> bool
11177
11178 Returns True if the control is empty or False if it has some items.
11179 """
11180 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
11181
11182 def GetString(*args, **kwargs):
11183 """
11184 GetString(self, int n) -> String
11185
11186 Returns the label of the item with the given index.
11187 """
11188 return _core_.ItemContainer_GetString(*args, **kwargs)
11189
11190 def GetStrings(*args, **kwargs):
11191 """GetStrings(self) -> wxArrayString"""
11192 return _core_.ItemContainer_GetStrings(*args, **kwargs)
11193
11194 def SetString(*args, **kwargs):
11195 """
11196 SetString(self, int n, String s)
11197
11198 Sets the label for the given item.
11199 """
11200 return _core_.ItemContainer_SetString(*args, **kwargs)
11201
11202 def FindString(*args, **kwargs):
11203 """
11204 FindString(self, String s) -> int
11205
11206 Finds an item whose label matches the given string. Returns the
79fccf9d
RD
11207 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
11208 found.
d55e5bfc
RD
11209 """
11210 return _core_.ItemContainer_FindString(*args, **kwargs)
11211
53aa7709 11212 def SetSelection(*args, **kwargs):
d55e5bfc 11213 """
53aa7709 11214 SetSelection(self, int n)
d55e5bfc
RD
11215
11216 Sets the item at index 'n' to be the selected item.
11217 """
53aa7709 11218 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 11219
d55e5bfc
RD
11220 def GetSelection(*args, **kwargs):
11221 """
11222 GetSelection(self) -> int
11223
79fccf9d
RD
11224 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
11225 is selected.
d55e5bfc
RD
11226 """
11227 return _core_.ItemContainer_GetSelection(*args, **kwargs)
11228
53aa7709
RD
11229 def SetStringSelection(*args, **kwargs):
11230 """SetStringSelection(self, String s) -> bool"""
11231 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
11232
d55e5bfc
RD
11233 def GetStringSelection(*args, **kwargs):
11234 """
11235 GetStringSelection(self) -> String
11236
79fccf9d
RD
11237 Returns the label of the selected item or an empty string if no item
11238 is selected.
d55e5bfc
RD
11239 """
11240 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
11241
53aa7709 11242 def Select(*args, **kwargs):
d55e5bfc 11243 """
53aa7709 11244 Select(self, int n)
d55e5bfc 11245
53aa7709
RD
11246 This is the same as `SetSelection` and exists only because it is
11247 slightly more natural for controls which support multiple selection.
d55e5bfc 11248 """
53aa7709 11249 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc
RD
11250
11251
11252class ItemContainerPtr(ItemContainer):
11253 def __init__(self, this):
11254 self.this = this
11255 if not hasattr(self,"thisown"): self.thisown = 0
11256 self.__class__ = ItemContainer
11257_core_.ItemContainer_swigregister(ItemContainerPtr)
11258
11259#---------------------------------------------------------------------------
11260
11261class ControlWithItems(Control,ItemContainer):
11262 """
79fccf9d
RD
11263 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
11264 wx.Control class, and is used for the base class of various controls
11265 that have items.
d55e5bfc
RD
11266 """
11267 def __init__(self): raise RuntimeError, "No constructor defined"
11268 def __repr__(self):
11269 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11270
11271class ControlWithItemsPtr(ControlWithItems):
11272 def __init__(self, this):
11273 self.this = this
11274 if not hasattr(self,"thisown"): self.thisown = 0
11275 self.__class__ = ControlWithItems
11276_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
11277
11278#---------------------------------------------------------------------------
11279
11280class SizerItem(Object):
248ed943
RD
11281 """
11282 The wx.SizerItem class is used to track the position, size and other
11283 attributes of each item managed by a `wx.Sizer`. In normal usage user
11284 code should never need to deal directly with a wx.SizerItem, but
11285 custom classes derived from `wx.PySizer` will probably need to use the
11286 collection of wx.SizerItems held by wx.Sizer when calculating layout.
11287
11288 :see: `wx.Sizer`, `wx.GBSizerItem`
11289 """
d55e5bfc
RD
11290 def __repr__(self):
11291 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11292 def __init__(self, *args, **kwargs):
248ed943
RD
11293 """
11294 __init__(self) -> SizerItem
11295
11296 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
11297 size will need to be set before this item can be used in a Sizer.
11298
11299 You will probably never need to create a wx.SizerItem directly as they
11300 are created automatically when the sizer's Add, Insert or Prepend
11301 methods are called.
11302
11303 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
11304 """
d55e5bfc
RD
11305 newobj = _core_.new_SizerItem(*args, **kwargs)
11306 self.this = newobj.this
11307 self.thisown = 1
11308 del newobj.thisown
11309 def DeleteWindows(*args, **kwargs):
248ed943
RD
11310 """
11311 DeleteWindows(self)
11312
11313 Destroy the window or the windows in a subsizer, depending on the type
11314 of item.
11315 """
d55e5bfc
RD
11316 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
11317
11318 def DetachSizer(*args, **kwargs):
248ed943
RD
11319 """
11320 DetachSizer(self)
11321
11322 Enable deleting the SizerItem without destroying the contained sizer.
11323 """
d55e5bfc
RD
11324 return _core_.SizerItem_DetachSizer(*args, **kwargs)
11325
11326 def GetSize(*args, **kwargs):
248ed943
RD
11327 """
11328 GetSize(self) -> Size
11329
11330 Get the current size of the item, as set in the last Layout.
11331 """
d55e5bfc
RD
11332 return _core_.SizerItem_GetSize(*args, **kwargs)
11333
11334 def CalcMin(*args, **kwargs):
248ed943
RD
11335 """
11336 CalcMin(self) -> Size
11337
11338 Calculates the minimum desired size for the item, including any space
11339 needed by borders.
11340 """
d55e5bfc
RD
11341 return _core_.SizerItem_CalcMin(*args, **kwargs)
11342
11343 def SetDimension(*args, **kwargs):
248ed943
RD
11344 """
11345 SetDimension(self, Point pos, Size size)
11346
11347 Set the position and size of the space allocated for this item by the
11348 sizer, and adjust the position and size of the item (window or
11349 subsizer) to be within that space taking alignment and borders into
11350 account.
11351 """
d55e5bfc
RD
11352 return _core_.SizerItem_SetDimension(*args, **kwargs)
11353
11354 def GetMinSize(*args, **kwargs):
248ed943
RD
11355 """
11356 GetMinSize(self) -> Size
11357
11358 Get the minimum size needed for the item.
11359 """
d55e5bfc
RD
11360 return _core_.SizerItem_GetMinSize(*args, **kwargs)
11361
a001823c
RD
11362 def GetMinSizeWithBorder(*args, **kwargs):
11363 """
11364 GetMinSizeWithBorder(self) -> Size
11365
11366 Get the minimum size needed for the item with space for the borders
11367 added, if needed.
11368 """
11369 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
11370
d55e5bfc
RD
11371 def SetInitSize(*args, **kwargs):
11372 """SetInitSize(self, int x, int y)"""
11373 return _core_.SizerItem_SetInitSize(*args, **kwargs)
11374
11375 def SetRatioWH(*args, **kwargs):
248ed943
RD
11376 """
11377 SetRatioWH(self, int width, int height)
11378
11379 Set the ratio item attribute.
11380 """
d55e5bfc
RD
11381 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
11382
11383 def SetRatioSize(*args, **kwargs):
248ed943
RD
11384 """
11385 SetRatioSize(self, Size size)
11386
11387 Set the ratio item attribute.
11388 """
d55e5bfc
RD
11389 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
11390
11391 def SetRatio(*args, **kwargs):
248ed943
RD
11392 """
11393 SetRatio(self, float ratio)
11394
11395 Set the ratio item attribute.
11396 """
d55e5bfc
RD
11397 return _core_.SizerItem_SetRatio(*args, **kwargs)
11398
11399 def GetRatio(*args, **kwargs):
248ed943
RD
11400 """
11401 GetRatio(self) -> float
11402
11403 Set the ratio item attribute.
11404 """
d55e5bfc
RD
11405 return _core_.SizerItem_GetRatio(*args, **kwargs)
11406
c1cb24a4
RD
11407 def GetRect(*args, **kwargs):
11408 """
11409 GetRect(self) -> Rect
11410
11411 Returns the rectangle that the sizer item should occupy
11412 """
11413 return _core_.SizerItem_GetRect(*args, **kwargs)
11414
d55e5bfc 11415 def IsWindow(*args, **kwargs):
248ed943
RD
11416 """
11417 IsWindow(self) -> bool
11418
11419 Is this sizer item a window?
11420 """
d55e5bfc
RD
11421 return _core_.SizerItem_IsWindow(*args, **kwargs)
11422
11423 def IsSizer(*args, **kwargs):
248ed943
RD
11424 """
11425 IsSizer(self) -> bool
11426
11427 Is this sizer item a subsizer?
11428 """
d55e5bfc
RD
11429 return _core_.SizerItem_IsSizer(*args, **kwargs)
11430
11431 def IsSpacer(*args, **kwargs):
248ed943
RD
11432 """
11433 IsSpacer(self) -> bool
11434
11435 Is this sizer item a spacer?
11436 """
d55e5bfc
RD
11437 return _core_.SizerItem_IsSpacer(*args, **kwargs)
11438
11439 def SetProportion(*args, **kwargs):
248ed943
RD
11440 """
11441 SetProportion(self, int proportion)
11442
11443 Set the proportion value for this item.
11444 """
d55e5bfc
RD
11445 return _core_.SizerItem_SetProportion(*args, **kwargs)
11446
11447 def GetProportion(*args, **kwargs):
248ed943
RD
11448 """
11449 GetProportion(self) -> int
11450
11451 Get the proportion value for this item.
11452 """
d55e5bfc
RD
11453 return _core_.SizerItem_GetProportion(*args, **kwargs)
11454
248ed943
RD
11455 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
11456 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 11457 def SetFlag(*args, **kwargs):
248ed943
RD
11458 """
11459 SetFlag(self, int flag)
11460
11461 Set the flag value for this item.
11462 """
d55e5bfc
RD
11463 return _core_.SizerItem_SetFlag(*args, **kwargs)
11464
11465 def GetFlag(*args, **kwargs):
248ed943
RD
11466 """
11467 GetFlag(self) -> int
11468
11469 Get the flag value for this item.
11470 """
d55e5bfc
RD
11471 return _core_.SizerItem_GetFlag(*args, **kwargs)
11472
11473 def SetBorder(*args, **kwargs):
248ed943
RD
11474 """
11475 SetBorder(self, int border)
11476
11477 Set the border value for this item.
11478 """
d55e5bfc
RD
11479 return _core_.SizerItem_SetBorder(*args, **kwargs)
11480
11481 def GetBorder(*args, **kwargs):
248ed943
RD
11482 """
11483 GetBorder(self) -> int
11484
11485 Get the border value for this item.
11486 """
d55e5bfc
RD
11487 return _core_.SizerItem_GetBorder(*args, **kwargs)
11488
11489 def GetWindow(*args, **kwargs):
248ed943
RD
11490 """
11491 GetWindow(self) -> Window
11492
11493 Get the window (if any) that is managed by this sizer item.
11494 """
d55e5bfc
RD
11495 return _core_.SizerItem_GetWindow(*args, **kwargs)
11496
11497 def SetWindow(*args, **kwargs):
248ed943
RD
11498 """
11499 SetWindow(self, Window window)
11500
11501 Set the window to be managed by this sizer item.
11502 """
d55e5bfc
RD
11503 return _core_.SizerItem_SetWindow(*args, **kwargs)
11504
11505 def GetSizer(*args, **kwargs):
248ed943
RD
11506 """
11507 GetSizer(self) -> Sizer
11508
11509 Get the subsizer (if any) that is managed by this sizer item.
11510 """
d55e5bfc
RD
11511 return _core_.SizerItem_GetSizer(*args, **kwargs)
11512
11513 def SetSizer(*args, **kwargs):
248ed943
RD
11514 """
11515 SetSizer(self, Sizer sizer)
11516
11517 Set the subsizer to be managed by this sizer item.
11518 """
d55e5bfc
RD
11519 return _core_.SizerItem_SetSizer(*args, **kwargs)
11520
11521 def GetSpacer(*args, **kwargs):
248ed943
RD
11522 """
11523 GetSpacer(self) -> Size
11524
11525 Get the size of the spacer managed by this sizer item.
11526 """
d55e5bfc
RD
11527 return _core_.SizerItem_GetSpacer(*args, **kwargs)
11528
11529 def SetSpacer(*args, **kwargs):
248ed943
RD
11530 """
11531 SetSpacer(self, Size size)
11532
11533 Set the size of the spacer to be managed by this sizer item.
11534 """
d55e5bfc
RD
11535 return _core_.SizerItem_SetSpacer(*args, **kwargs)
11536
11537 def Show(*args, **kwargs):
248ed943
RD
11538 """
11539 Show(self, bool show)
11540
11541 Set the show item attribute, which sizers use to determine if the item
11542 is to be made part of the layout or not. If the item is tracking a
11543 window then it is shown or hidden as needed.
11544 """
d55e5bfc
RD
11545 return _core_.SizerItem_Show(*args, **kwargs)
11546
11547 def IsShown(*args, **kwargs):
248ed943
RD
11548 """
11549 IsShown(self) -> bool
11550
11551 Is the item to be shown in the layout?
11552 """
d55e5bfc
RD
11553 return _core_.SizerItem_IsShown(*args, **kwargs)
11554
11555 def GetPosition(*args, **kwargs):
248ed943
RD
11556 """
11557 GetPosition(self) -> Point
11558
11559 Returns the current position of the item, as set in the last Layout.
11560 """
d55e5bfc
RD
11561 return _core_.SizerItem_GetPosition(*args, **kwargs)
11562
11563 def GetUserData(*args, **kwargs):
248ed943
RD
11564 """
11565 GetUserData(self) -> PyObject
11566
11567 Returns the userData associated with this sizer item, or None if there
11568 isn't any.
11569 """
d55e5bfc
RD
11570 return _core_.SizerItem_GetUserData(*args, **kwargs)
11571
11572
11573class SizerItemPtr(SizerItem):
11574 def __init__(self, this):
11575 self.this = this
11576 if not hasattr(self,"thisown"): self.thisown = 0
11577 self.__class__ = SizerItem
11578_core_.SizerItem_swigregister(SizerItemPtr)
11579
248ed943 11580def SizerItemWindow(*args, **kwargs):
d55e5bfc 11581 """
248ed943
RD
11582 SizerItemWindow(Window window, int proportion, int flag, int border,
11583 PyObject userData=None) -> SizerItem
11584
11585 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 11586 """
248ed943 11587 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
11588 val.thisown = 1
11589 return val
11590
248ed943 11591def SizerItemSpacer(*args, **kwargs):
d55e5bfc 11592 """
248ed943
RD
11593 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
11594 PyObject userData=None) -> SizerItem
11595
11596 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 11597 """
248ed943 11598 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
11599 val.thisown = 1
11600 return val
11601
11602def SizerItemSizer(*args, **kwargs):
11603 """
11604 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
11605 PyObject userData=None) -> SizerItem
11606
11607 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
11608 """
11609 val = _core_.new_SizerItemSizer(*args, **kwargs)
11610 val.thisown = 1
11611 return val
11612
11613class Sizer(Object):
248ed943
RD
11614 """
11615 wx.Sizer is the abstract base class used for laying out subwindows in
11616 a window. You cannot use wx.Sizer directly; instead, you will have to
11617 use one of the sizer classes derived from it such as `wx.BoxSizer`,
11618 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
11619 and `wx.GridBagSizer`.
11620
11621 The concept implemented by sizers in wxWidgets is closely related to
11622 layout tools in other GUI toolkits, such as Java's AWT, the GTK
11623 toolkit or the Qt toolkit. It is based upon the idea of the individual
11624 subwindows reporting their minimal required size and their ability to
11625 get stretched if the size of the parent window has changed. This will
11626 most often mean that the programmer does not set the original size of
11627 a dialog in the beginning, rather the dialog will assigned a sizer and
11628 this sizer will be queried about the recommended size. The sizer in
11629 turn will query its children, which can be normal windows or contorls,
11630 empty space or other sizers, so that a hierarchy of sizers can be
11631 constructed. Note that wxSizer does not derive from wxWindow and thus
11632 do not interfere with tab ordering and requires very little resources
11633 compared to a real window on screen.
11634
11635 What makes sizers so well fitted for use in wxWidgets is the fact that
11636 every control reports its own minimal size and the algorithm can
11637 handle differences in font sizes or different window (dialog item)
11638 sizes on different platforms without problems. If for example the
11639 standard font as well as the overall design of Mac widgets requires
11640 more space than on Windows, then the initial size of a dialog using a
11641 sizer will automatically be bigger on Mac than on Windows.
11642 """
d55e5bfc
RD
11643 def __init__(self): raise RuntimeError, "No constructor defined"
11644 def __repr__(self):
11645 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11646 def _setOORInfo(*args, **kwargs):
11647 """_setOORInfo(self, PyObject _self)"""
11648 return _core_.Sizer__setOORInfo(*args, **kwargs)
11649
11650 def Add(*args, **kwargs):
11651 """
248ed943 11652 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11653 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11654
11655 Appends a child item to the sizer.
d55e5bfc
RD
11656 """
11657 return _core_.Sizer_Add(*args, **kwargs)
11658
11659 def Insert(*args, **kwargs):
11660 """
248ed943 11661 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11662 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11663
11664 Inserts a new item into the list of items managed by this sizer before
11665 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
11666 """
11667 return _core_.Sizer_Insert(*args, **kwargs)
11668
11669 def Prepend(*args, **kwargs):
11670 """
248ed943 11671 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 11672 PyObject userData=None) -> wx.SizerItem
248ed943
RD
11673
11674 Adds a new item to the begining of the list of sizer items managed by
11675 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
11676 """
11677 return _core_.Sizer_Prepend(*args, **kwargs)
11678
11679 def Remove(*args, **kwargs):
248ed943
RD
11680 """
11681 Remove(self, item) -> bool
11682
11683 Removes an item from the sizer and destroys it. This method does not
11684 cause any layout or resizing to take place, call `Layout` to update
11685 the layout on screen after removing a child from the sizer. The
11686 *item* parameter can be either a window, a sizer, or the zero-based
11687 index of an item to remove. Returns True if the child item was found
11688 and removed.
11689 """
d55e5bfc
RD
11690 return _core_.Sizer_Remove(*args, **kwargs)
11691
1a6bba1e 11692 def Detach(*args, **kwargs):
248ed943
RD
11693 """
11694 Detach(self, item) -> bool
11695
11696 Detaches an item from the sizer without destroying it. This method
11697 does not cause any layout or resizing to take place, call `Layout` to
11698 do so. The *item* parameter can be either a window, a sizer, or the
11699 zero-based index of the item to be detached. Returns True if the child item
11700 was found and detached.
11701 """
1a6bba1e
RD
11702 return _core_.Sizer_Detach(*args, **kwargs)
11703
c1cb24a4
RD
11704 def GetItem(*args, **kwargs):
11705 """
11706 GetItem(self, item) -> wx.SizerItem
11707
11708 Returns the `wx.SizerItem` which holds the *item* given. The *item*
11709 parameter can be either a window, a sizer, or the zero-based index of
4d170c95 11710 the item to be found.
c1cb24a4
RD
11711 """
11712 return _core_.Sizer_GetItem(*args, **kwargs)
11713
d55e5bfc
RD
11714 def _SetItemMinSize(*args, **kwargs):
11715 """_SetItemMinSize(self, PyObject item, Size size)"""
11716 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
11717
248ed943
RD
11718 def SetItemMinSize(self, item, *args):
11719 """
11720 SetItemMinSize(self, item, Size size)
11721
11722 Sets the minimum size that will be allocated for an item in the sizer.
11723 The *item* parameter can be either a window, a sizer, or the
11724 zero-based index of the item. If a window or sizer is given then it
11725 will be searched for recursivly in subsizers if neccessary.
11726 """
11727 if len(args) == 2:
11728 # for backward compatibility accept separate width,height args too
11729 return self._SetItemMinSize(item, args)
11730 else:
11731 return self._SetItemMinSize(item, args[0])
11732
d55e5bfc 11733 def AddItem(*args, **kwargs):
248ed943
RD
11734 """
11735 AddItem(self, SizerItem item)
11736
11737 Adds a `wx.SizerItem` to the sizer.
11738 """
d55e5bfc
RD
11739 return _core_.Sizer_AddItem(*args, **kwargs)
11740
11741 def InsertItem(*args, **kwargs):
248ed943
RD
11742 """
11743 InsertItem(self, int index, SizerItem item)
11744
11745 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
11746 """
d55e5bfc
RD
11747 return _core_.Sizer_InsertItem(*args, **kwargs)
11748
11749 def PrependItem(*args, **kwargs):
248ed943
RD
11750 """
11751 PrependItem(self, SizerItem item)
11752
11753 Prepends a `wx.SizerItem` to the sizer.
11754 """
d55e5bfc
RD
11755 return _core_.Sizer_PrependItem(*args, **kwargs)
11756
248ed943 11757 def AddMany(self, items):
c24da6d6
RD
11758 """
11759 AddMany is a convenience method for adding several items
11760 to a sizer at one time. Simply pass it a list of tuples,
11761 where each tuple consists of the parameters that you
11762 would normally pass to the `Add` method.
11763 """
248ed943
RD
11764 for item in items:
11765 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
11766 item = (item, )
11767 self.Add(*item)
d55e5bfc
RD
11768
11769 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD
11770 def AddWindow(self, *args, **kw):
11771 """Compatibility alias for `Add`."""
11772 return self.Add(*args, **kw)
11773 def AddSizer(self, *args, **kw):
11774 """Compatibility alias for `Add`."""
11775 return self.Add(*args, **kw)
11776 def AddSpacer(self, *args, **kw):
11777 """Compatibility alias for `Add`."""
11778 return self.Add(*args, **kw)
11779
11780 def PrependWindow(self, *args, **kw):
11781 """Compatibility alias for `Prepend`."""
11782 return self.Prepend(*args, **kw)
11783 def PrependSizer(self, *args, **kw):
11784 """Compatibility alias for `Prepend`."""
11785 return self.Prepend(*args, **kw)
11786 def PrependSpacer(self, *args, **kw):
11787 """Compatibility alias for `Prepend`."""
11788 return self.Prepend(*args, **kw)
11789
11790 def InsertWindow(self, *args, **kw):
11791 """Compatibility alias for `Insert`."""
11792 return self.Insert(*args, **kw)
11793 def InsertSizer(self, *args, **kw):
11794 """Compatibility alias for `Insert`."""
11795 return self.Insert(*args, **kw)
11796 def InsertSpacer(self, *args, **kw):
11797 """Compatibility alias for `Insert`."""
11798 return self.Insert(*args, **kw)
11799
11800 def RemoveWindow(self, *args, **kw):
11801 """Compatibility alias for `Remove`."""
11802 return self.Remove(*args, **kw)
11803 def RemoveSizer(self, *args, **kw):
11804 """Compatibility alias for `Remove`."""
11805 return self.Remove(*args, **kw)
11806 def RemovePos(self, *args, **kw):
11807 """Compatibility alias for `Remove`."""
11808 return self.Remove(*args, **kw)
d55e5bfc
RD
11809
11810
d55e5bfc 11811 def SetDimension(*args, **kwargs):
248ed943
RD
11812 """
11813 SetDimension(self, int x, int y, int width, int height)
11814
11815 Call this to force the sizer to take the given dimension and thus
11816 force the items owned by the sizer to resize themselves according to
11817 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
11818 methods.
11819 """
d55e5bfc
RD
11820 return _core_.Sizer_SetDimension(*args, **kwargs)
11821
11822 def SetMinSize(*args, **kwargs):
248ed943
RD
11823 """
11824 SetMinSize(self, Size size)
11825
11826 Call this to give the sizer a minimal size. Normally, the sizer will
11827 calculate its minimal size based purely on how much space its children
11828 need. After calling this method `GetMinSize` will return either the
11829 minimal size as requested by its children or the minimal size set
11830 here, depending on which is bigger.
11831 """
d55e5bfc
RD
11832 return _core_.Sizer_SetMinSize(*args, **kwargs)
11833
11834 def GetSize(*args, **kwargs):
248ed943
RD
11835 """
11836 GetSize(self) -> Size
11837
11838 Returns the current size of the space managed by the sizer.
11839 """
d55e5bfc
RD
11840 return _core_.Sizer_GetSize(*args, **kwargs)
11841
11842 def GetPosition(*args, **kwargs):
248ed943
RD
11843 """
11844 GetPosition(self) -> Point
11845
11846 Returns the current position of the sizer's managed space.
11847 """
d55e5bfc
RD
11848 return _core_.Sizer_GetPosition(*args, **kwargs)
11849
11850 def GetMinSize(*args, **kwargs):
248ed943
RD
11851 """
11852 GetMinSize(self) -> Size
11853
11854 Returns the minimal size of the sizer. This is either the combined
11855 minimal size of all the children and their borders or the minimal size
11856 set by SetMinSize, depending on which is bigger.
11857 """
d55e5bfc
RD
11858 return _core_.Sizer_GetMinSize(*args, **kwargs)
11859
11860 def GetSizeTuple(self):
1a6bba1e 11861 return self.GetSize().Get()
d55e5bfc 11862 def GetPositionTuple(self):
1a6bba1e 11863 return self.GetPosition().Get()
d55e5bfc 11864 def GetMinSizeTuple(self):
1a6bba1e 11865 return self.GetMinSize().Get()
d55e5bfc
RD
11866
11867 def RecalcSizes(*args, **kwargs):
248ed943
RD
11868 """
11869 RecalcSizes(self)
11870
11871 Using the sizes calculated by `CalcMin` reposition and resize all the
11872 items managed by this sizer. You should not need to call this directly as
11873 it is called by `Layout`.
11874 """
d55e5bfc
RD
11875 return _core_.Sizer_RecalcSizes(*args, **kwargs)
11876
11877 def CalcMin(*args, **kwargs):
248ed943
RD
11878 """
11879 CalcMin(self) -> Size
11880
11881 This method is where the sizer will do the actual calculation of its
11882 children's minimal sizes. You should not need to call this directly as
11883 it is called by `Layout`.
11884 """
d55e5bfc
RD
11885 return _core_.Sizer_CalcMin(*args, **kwargs)
11886
11887 def Layout(*args, **kwargs):
248ed943
RD
11888 """
11889 Layout(self)
11890
11891 This method will force the recalculation and layout of the items
11892 controlled by the sizer using the current space allocated to the
11893 sizer. Normally this is called automatically from the owning window's
11894 EVT_SIZE handler, but it is also useful to call it from user code when
11895 one of the items in a sizer change size, or items are added or
11896 removed.
11897 """
d55e5bfc
RD
11898 return _core_.Sizer_Layout(*args, **kwargs)
11899
11900 def Fit(*args, **kwargs):
248ed943
RD
11901 """
11902 Fit(self, Window window) -> Size
11903
11904 Tell the sizer to resize the *window* to match the sizer's minimal
11905 size. This is commonly done in the constructor of the window itself in
11906 order to set its initial size to match the needs of the children as
11907 determined by the sizer. Returns the new size.
11908
11909 For a top level window this is the total window size, not the client size.
11910 """
d55e5bfc
RD
11911 return _core_.Sizer_Fit(*args, **kwargs)
11912
11913 def FitInside(*args, **kwargs):
248ed943
RD
11914 """
11915 FitInside(self, Window window)
11916
11917 Tell the sizer to resize the *virtual size* of the *window* to match the
11918 sizer's minimal size. This will not alter the on screen size of the
11919 window, but may cause the addition/removal/alteration of scrollbars
11920 required to view the virtual area in windows which manage it.
11921
11922 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
11923
11924 """
d55e5bfc
RD
11925 return _core_.Sizer_FitInside(*args, **kwargs)
11926
11927 def SetSizeHints(*args, **kwargs):
248ed943
RD
11928 """
11929 SetSizeHints(self, Window window)
11930
11931 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
11932 match the sizer's minimal size. This is commonly done in the
11933 constructor of the window itself if the window is resizable (as are
11934 many dialogs under Unix and frames on probably all platforms) in order
11935 to prevent the window from being sized smaller than the minimal size
11936 required by the sizer.
11937 """
d55e5bfc
RD
11938 return _core_.Sizer_SetSizeHints(*args, **kwargs)
11939
11940 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
11941 """
11942 SetVirtualSizeHints(self, Window window)
11943
11944 Tell the sizer to set the minimal size of the window virtual area to
11945 match the sizer's minimal size. For windows with managed scrollbars
11946 this will set them appropriately.
11947
11948 :see: `wx.ScrolledWindow.SetScrollbars`
11949
11950 """
d55e5bfc
RD
11951 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
11952
11953 def Clear(*args, **kwargs):
248ed943
RD
11954 """
11955 Clear(self, bool deleteWindows=False)
11956
11957 Clear all items from the sizer, optionally destroying the window items
11958 as well.
11959 """
d55e5bfc
RD
11960 return _core_.Sizer_Clear(*args, **kwargs)
11961
11962 def DeleteWindows(*args, **kwargs):
248ed943
RD
11963 """
11964 DeleteWindows(self)
11965
11966 Destroy all windows managed by the sizer.
11967 """
d55e5bfc
RD
11968 return _core_.Sizer_DeleteWindows(*args, **kwargs)
11969
11970 def GetChildren(*args, **kwargs):
248ed943 11971 """
51b83b37 11972 GetChildren(self) -> list
248ed943
RD
11973
11974 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
11975 """
d55e5bfc
RD
11976 return _core_.Sizer_GetChildren(*args, **kwargs)
11977
11978 def Show(*args, **kwargs):
248ed943 11979 """
ae8162c8 11980 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 11981
248ed943
RD
11982 Shows or hides an item managed by the sizer. To make a sizer item
11983 disappear or reappear, use Show followed by `Layout`. The *item*
11984 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD
11985 the item. Use the recursive parameter to show or hide an item in a
11986 subsizer. Returns True if the item was found.
248ed943
RD
11987 """
11988 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
11989
11990 def IsShown(*args, **kwargs):
248ed943
RD
11991 """
11992 IsShown(self, item)
11993
11994 Determines if the item is currently shown. sizer. To make a sizer
11995 item disappear or reappear, use Show followed by `Layout`. The *item*
11996 parameter can be either a window, a sizer, or the zero-based index of
11997 the item.
11998 """
d55e5bfc
RD
11999 return _core_.Sizer_IsShown(*args, **kwargs)
12000
629e65c2 12001 def Hide(self, item, recursive=False):
248ed943 12002 """
27fb7603 12003 A convenience method for `Show` (item, False, recursive).
248ed943 12004 """
06759a38 12005 return self.Show(item, False, recursive)
248ed943 12006
d55e5bfc 12007 def ShowItems(*args, **kwargs):
248ed943
RD
12008 """
12009 ShowItems(self, bool show)
12010
84f85550 12011 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 12012 """
d55e5bfc
RD
12013 return _core_.Sizer_ShowItems(*args, **kwargs)
12014
12015
12016class SizerPtr(Sizer):
12017 def __init__(self, this):
12018 self.this = this
12019 if not hasattr(self,"thisown"): self.thisown = 0
12020 self.__class__ = Sizer
12021_core_.Sizer_swigregister(SizerPtr)
12022
12023class PySizer(Sizer):
248ed943
RD
12024 """
12025 wx.PySizer is a special version of `wx.Sizer` that has been
12026 instrumented to allow the C++ virtual methods to be overloaded in
12027 Python derived classes. You would derive from this class if you are
12028 wanting to implement a custom sizer in Python code. Simply implement
12029 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
12030 For example::
12031
12032 class MySizer(wx.PySizer):
12033 def __init__(self):
12034 wx.PySizer.__init__(self)
12035
12036 def CalcMin(self):
12037 for item in self.GetChildren():
12038 # calculate the total minimum width and height needed
12039 # by all items in the sizer according to this sizer's
12040 # layout algorithm.
12041 ...
12042 return wx.Size(width, height)
12043
12044 def RecalcSizes(self):
12045 # find the space allotted to this sizer
12046 pos = self.GetPosition()
12047 size = self.GetSize()
12048 for item in self.GetChildren():
12049 # Recalculate (if necessary) the position and size of
12050 # each item and then call item.SetDimension to do the
12051 # actual positioning and sizing of the items within the
12052 # space alloted to this sizer.
12053 ...
12054 item.SetDimension(itemPos, itemSize)
12055
12056
12057 When `Layout` is called it first calls `CalcMin` followed by
12058 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 12059 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD
12060
12061 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
12062
12063
12064 """
d55e5bfc
RD
12065 def __repr__(self):
12066 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12067 def __init__(self, *args, **kwargs):
248ed943
RD
12068 """
12069 __init__(self) -> PySizer
12070
12071 Creates a wx.PySizer. Must be called from the __init__ in the derived
12072 class.
12073 """
d55e5bfc
RD
12074 newobj = _core_.new_PySizer(*args, **kwargs)
12075 self.this = newobj.this
12076 self.thisown = 1
12077 del newobj.thisown
12078 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
12079
12080 def _setCallbackInfo(*args, **kwargs):
12081 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
12082 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
12083
12084
12085class PySizerPtr(PySizer):
12086 def __init__(self, this):
12087 self.this = this
12088 if not hasattr(self,"thisown"): self.thisown = 0
12089 self.__class__ = PySizer
12090_core_.PySizer_swigregister(PySizerPtr)
12091
12092#---------------------------------------------------------------------------
12093
12094class BoxSizer(Sizer):
248ed943
RD
12095 """
12096 The basic idea behind a box sizer is that windows will most often be
12097 laid out in rather simple basic geometry, typically in a row or a
12098 column or nested hierarchies of either. A wx.BoxSizer will lay out
12099 its items in a simple row or column, depending on the orientation
12100 parameter passed to the constructor.
12101 """
d55e5bfc
RD
12102 def __repr__(self):
12103 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12104 def __init__(self, *args, **kwargs):
248ed943
RD
12105 """
12106 __init__(self, int orient=HORIZONTAL) -> BoxSizer
12107
12108 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
12109 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
12110 sizer.
12111 """
d55e5bfc
RD
12112 newobj = _core_.new_BoxSizer(*args, **kwargs)
12113 self.this = newobj.this
12114 self.thisown = 1
12115 del newobj.thisown
12116 self._setOORInfo(self)
12117
12118 def GetOrientation(*args, **kwargs):
248ed943
RD
12119 """
12120 GetOrientation(self) -> int
12121
12122 Returns the current orientation of the sizer.
12123 """
d55e5bfc
RD
12124 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
12125
12126 def SetOrientation(*args, **kwargs):
248ed943
RD
12127 """
12128 SetOrientation(self, int orient)
d55e5bfc 12129
248ed943
RD
12130 Resets the orientation of the sizer.
12131 """
12132 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
12133
12134
12135class BoxSizerPtr(BoxSizer):
12136 def __init__(self, this):
12137 self.this = this
12138 if not hasattr(self,"thisown"): self.thisown = 0
12139 self.__class__ = BoxSizer
12140_core_.BoxSizer_swigregister(BoxSizerPtr)
12141
12142#---------------------------------------------------------------------------
12143
12144class StaticBoxSizer(BoxSizer):
248ed943
RD
12145 """
12146 wx.StaticBoxSizer derives from and functions identically to the
12147 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
12148 manages. Note that this static box must be created separately and
12149 passed to the sizer constructor.
12150 """
d55e5bfc
RD
12151 def __repr__(self):
12152 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12153 def __init__(self, *args, **kwargs):
248ed943
RD
12154 """
12155 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
12156
12157 Constructor. It takes an associated static box and the orientation
12158 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
12159 ``wx.HORIZONTAL``.
12160 """
d55e5bfc
RD
12161 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
12162 self.this = newobj.this
12163 self.thisown = 1
12164 del newobj.thisown
12165 self._setOORInfo(self)
12166
12167 def GetStaticBox(*args, **kwargs):
248ed943
RD
12168 """
12169 GetStaticBox(self) -> StaticBox
d55e5bfc 12170
248ed943
RD
12171 Returns the static box associated with this sizer.
12172 """
12173 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
12174
12175
12176class StaticBoxSizerPtr(StaticBoxSizer):
12177 def __init__(self, this):
12178 self.this = this
12179 if not hasattr(self,"thisown"): self.thisown = 0
12180 self.__class__ = StaticBoxSizer
12181_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
12182
12183#---------------------------------------------------------------------------
12184
12185class GridSizer(Sizer):
248ed943
RD
12186 """
12187 A grid sizer is a sizer which lays out its children in a
12188 two-dimensional table with all cells having the same size. In other
12189 words, the width of each cell within the grid is the width of the
12190 widest item added to the sizer and the height of each grid cell is the
12191 height of the tallest item. An optional vertical and/or horizontal
12192 gap between items can also be specified (in pixels.)
12193
12194 Items are placed in the cells of the grid in the order they are added,
12195 in row-major order. In other words, the first row is filled first,
12196 then the second, and so on until all items have been added. (If
12197 neccessary, additional rows will be added as items are added.) If you
12198 need to have greater control over the cells that items are placed in
12199 then use the `wx.GridBagSizer`.
12200
12201 """
d55e5bfc
RD
12202 def __repr__(self):
12203 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12204 def __init__(self, *args, **kwargs):
248ed943
RD
12205 """
12206 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
12207
12208 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
12209 of columns and rows in the sizer - if either of the parameters is
12210 zero, it will be calculated to from the total number of children in
12211 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12212 define extra space between all children.
12213 """
d55e5bfc
RD
12214 newobj = _core_.new_GridSizer(*args, **kwargs)
12215 self.this = newobj.this
12216 self.thisown = 1
12217 del newobj.thisown
12218 self._setOORInfo(self)
12219
d55e5bfc 12220 def SetCols(*args, **kwargs):
248ed943
RD
12221 """
12222 SetCols(self, int cols)
12223
12224 Sets the number of columns in the sizer.
12225 """
d55e5bfc
RD
12226 return _core_.GridSizer_SetCols(*args, **kwargs)
12227
12228 def SetRows(*args, **kwargs):
248ed943
RD
12229 """
12230 SetRows(self, int rows)
12231
12232 Sets the number of rows in the sizer.
12233 """
d55e5bfc
RD
12234 return _core_.GridSizer_SetRows(*args, **kwargs)
12235
12236 def SetVGap(*args, **kwargs):
248ed943
RD
12237 """
12238 SetVGap(self, int gap)
12239
12240 Sets the vertical gap (in pixels) between the cells in the sizer.
12241 """
d55e5bfc
RD
12242 return _core_.GridSizer_SetVGap(*args, **kwargs)
12243
12244 def SetHGap(*args, **kwargs):
248ed943
RD
12245 """
12246 SetHGap(self, int gap)
12247
12248 Sets the horizontal gap (in pixels) between cells in the sizer
12249 """
d55e5bfc
RD
12250 return _core_.GridSizer_SetHGap(*args, **kwargs)
12251
12252 def GetCols(*args, **kwargs):
248ed943
RD
12253 """
12254 GetCols(self) -> int
12255
12256 Returns the number of columns in the sizer.
12257 """
d55e5bfc
RD
12258 return _core_.GridSizer_GetCols(*args, **kwargs)
12259
12260 def GetRows(*args, **kwargs):
248ed943
RD
12261 """
12262 GetRows(self) -> int
12263
12264 Returns the number of rows in the sizer.
12265 """
d55e5bfc
RD
12266 return _core_.GridSizer_GetRows(*args, **kwargs)
12267
12268 def GetVGap(*args, **kwargs):
248ed943
RD
12269 """
12270 GetVGap(self) -> int
12271
12272 Returns the vertical gap (in pixels) between the cells in the sizer.
12273 """
d55e5bfc
RD
12274 return _core_.GridSizer_GetVGap(*args, **kwargs)
12275
12276 def GetHGap(*args, **kwargs):
248ed943
RD
12277 """
12278 GetHGap(self) -> int
12279
12280 Returns the horizontal gap (in pixels) between cells in the sizer.
12281 """
d55e5bfc
RD
12282 return _core_.GridSizer_GetHGap(*args, **kwargs)
12283
12284
12285class GridSizerPtr(GridSizer):
12286 def __init__(self, this):
12287 self.this = this
12288 if not hasattr(self,"thisown"): self.thisown = 0
12289 self.__class__ = GridSizer
12290_core_.GridSizer_swigregister(GridSizerPtr)
12291
12292#---------------------------------------------------------------------------
12293
12294FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
12295FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
12296FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
12297class FlexGridSizer(GridSizer):
248ed943
RD
12298 """
12299 A flex grid sizer is a sizer which lays out its children in a
12300 two-dimensional table with all table cells in one row having the same
12301 height and all cells in one column having the same width, but all
12302 rows or all columns are not necessarily the same height or width as in
12303 the `wx.GridSizer`.
12304
12305 wx.FlexGridSizer can also size items equally in one direction but
12306 unequally ("flexibly") in the other. If the sizer is only flexible
12307 in one direction (this can be changed using `SetFlexibleDirection`), it
12308 needs to be decided how the sizer should grow in the other ("non
12309 flexible") direction in order to fill the available space. The
12310 `SetNonFlexibleGrowMode` method serves this purpose.
12311
12312
12313 """
d55e5bfc
RD
12314 def __repr__(self):
12315 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12316 def __init__(self, *args, **kwargs):
248ed943
RD
12317 """
12318 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
12319
12320 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
12321 number of columns and rows in the sizer - if either of the parameters
12322 is zero, it will be calculated to from the total number of children in
12323 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
12324 define extra space between all children.
12325 """
d55e5bfc
RD
12326 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
12327 self.this = newobj.this
12328 self.thisown = 1
12329 del newobj.thisown
12330 self._setOORInfo(self)
12331
248ed943
RD
12332 def AddGrowableRow(*args, **kwargs):
12333 """
12334 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 12335
248ed943
RD
12336 Specifies that row *idx* (starting from zero) should be grown if there
12337 is extra space available to the sizer.
d55e5bfc 12338
248ed943
RD
12339 The *proportion* parameter has the same meaning as the stretch factor
12340 for the box sizers except that if all proportions are 0, then all
12341 columns are resized equally (instead of not being resized at all).
12342 """
d55e5bfc
RD
12343 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
12344
12345 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
12346 """
12347 RemoveGrowableRow(self, size_t idx)
12348
12349 Specifies that row *idx* is no longer growable.
12350 """
d55e5bfc
RD
12351 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
12352
12353 def AddGrowableCol(*args, **kwargs):
248ed943
RD
12354 """
12355 AddGrowableCol(self, size_t idx, int proportion=0)
12356
12357 Specifies that column *idx* (starting from zero) should be grown if
12358 there is extra space available to the sizer.
12359
12360 The *proportion* parameter has the same meaning as the stretch factor
12361 for the box sizers except that if all proportions are 0, then all
12362 columns are resized equally (instead of not being resized at all).
12363 """
d55e5bfc
RD
12364 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
12365
12366 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
12367 """
12368 RemoveGrowableCol(self, size_t idx)
12369
12370 Specifies that column *idx* is no longer growable.
12371 """
d55e5bfc
RD
12372 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
12373
12374 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
12375 """
12376 SetFlexibleDirection(self, int direction)
12377
12378 Specifies whether the sizer should flexibly resize its columns, rows,
12379 or both. Argument *direction* can be one of the following values. Any
12380 other value is ignored.
12381
12382 ============== =======================================
12383 wx.VERTICAL Rows are flexibly sized.
12384 wx.HORIZONTAL Columns are flexibly sized.
12385 wx.BOTH Both rows and columns are flexibly sized
12386 (this is the default value).
12387 ============== =======================================
12388
12389 Note that this method does not trigger relayout.
12390
12391 """
d55e5bfc
RD
12392 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
12393
12394 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
12395 """
12396 GetFlexibleDirection(self) -> int
12397
12398 Returns a value that specifies whether the sizer
12399 flexibly resizes its columns, rows, or both (default).
12400
12401 :see: `SetFlexibleDirection`
12402 """
d55e5bfc
RD
12403 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
12404
12405 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12406 """
12407 SetNonFlexibleGrowMode(self, int mode)
12408
12409 Specifies how the sizer should grow in the non-flexible direction if
12410 there is one (so `SetFlexibleDirection` must have been called
12411 previously). Argument *mode* can be one of the following values:
12412
12413 ========================== =================================================
12414 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
12415 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
12416 `AddGrowableCol` and `AddGrowableRow`. In this
12417 case equal sizing applies to minimum sizes of
12418 columns or rows (this is the default value).
12419 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
12420 the non flexible direction, whether they are
12421 growable or not in the flexbile direction.
12422 ========================== =================================================
12423
12424 Note that this method does not trigger relayout.
12425
12426
12427 """
d55e5bfc
RD
12428 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
12429
12430 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
12431 """
12432 GetNonFlexibleGrowMode(self) -> int
12433
12434 Returns the value that specifies how the sizer grows in the
12435 non-flexible direction if there is one.
12436
12437 :see: `SetNonFlexibleGrowMode`
12438 """
d55e5bfc
RD
12439 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
12440
12441 def GetRowHeights(*args, **kwargs):
a8eff060
RD
12442 """
12443 GetRowHeights(self) -> list
12444
12445 Returns a list of integers representing the heights of each of the
12446 rows in the sizer.
12447 """
d55e5bfc
RD
12448 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
12449
12450 def GetColWidths(*args, **kwargs):
a8eff060
RD
12451 """
12452 GetColWidths(self) -> list
12453
12454 Returns a list of integers representing the widths of each of the
12455 columns in the sizer.
12456 """
d55e5bfc
RD
12457 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
12458
12459
12460class FlexGridSizerPtr(FlexGridSizer):
12461 def __init__(self, this):
12462 self.this = this
12463 if not hasattr(self,"thisown"): self.thisown = 0
12464 self.__class__ = FlexGridSizer
12465_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
12466
62d32a5f
RD
12467class StdDialogButtonSizer(BoxSizer):
12468 """
12469 A special sizer that knows how to order and position standard buttons
12470 in order to conform to the current platform's standards. You simply
12471 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 12472 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD
12473 will take care of the rest.
12474
12475 """
12476 def __repr__(self):
12477 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12478 def __init__(self, *args, **kwargs):
12479 """__init__(self) -> StdDialogButtonSizer"""
12480 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
12481 self.this = newobj.this
12482 self.thisown = 1
12483 del newobj.thisown
12484 def AddButton(*args, **kwargs):
12485 """
12486 AddButton(self, wxButton button)
12487
12488 Use this to add the buttons to this sizer. Do not use the `Add`
12489 method in the base class.
12490 """
12491 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
12492
53aa7709 12493 def Realize(*args, **kwargs):
62d32a5f 12494 """
53aa7709 12495 Realize(self)
62d32a5f
RD
12496
12497 This funciton needs to be called after all the buttons have been added
12498 to the sizer. It will reorder them and position them in a platform
12499 specifc manner.
12500 """
53aa7709 12501 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD
12502
12503 def SetAffirmativeButton(*args, **kwargs):
12504 """SetAffirmativeButton(self, wxButton button)"""
12505 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
12506
12507 def SetNegativeButton(*args, **kwargs):
12508 """SetNegativeButton(self, wxButton button)"""
12509 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
12510
12511 def SetCancelButton(*args, **kwargs):
12512 """SetCancelButton(self, wxButton button)"""
12513 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD
12514
12515 def GetAffirmativeButton(*args, **kwargs):
12516 """GetAffirmativeButton(self) -> wxButton"""
12517 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
12518
12519 def GetApplyButton(*args, **kwargs):
12520 """GetApplyButton(self) -> wxButton"""
12521 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
12522
12523 def GetNegativeButton(*args, **kwargs):
12524 """GetNegativeButton(self) -> wxButton"""
12525 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
12526
12527 def GetCancelButton(*args, **kwargs):
12528 """GetCancelButton(self) -> wxButton"""
12529 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
12530
12531 def GetHelpButton(*args, **kwargs):
12532 """GetHelpButton(self) -> wxButton"""
12533 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
12534
12535
12536class StdDialogButtonSizerPtr(StdDialogButtonSizer):
12537 def __init__(self, this):
12538 self.this = this
12539 if not hasattr(self,"thisown"): self.thisown = 0
12540 self.__class__ = StdDialogButtonSizer
12541_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
12542
d55e5bfc
RD
12543#---------------------------------------------------------------------------
12544
12545class GBPosition(object):
248ed943
RD
12546 """
12547 This class represents the position of an item in a virtual grid of
12548 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12549 typemaps that will automatically convert from a 2-element sequence of
12550 integers to a wx.GBPosition, so you can use the more pythonic
12551 representation of the position nearly transparently in Python code.
12552 """
d55e5bfc
RD
12553 def __repr__(self):
12554 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12555 def __init__(self, *args, **kwargs):
248ed943
RD
12556 """
12557 __init__(self, int row=0, int col=0) -> GBPosition
12558
12559 This class represents the position of an item in a virtual grid of
12560 rows and columns managed by a `wx.GridBagSizer`. wxPython has
12561 typemaps that will automatically convert from a 2-element sequence of
12562 integers to a wx.GBPosition, so you can use the more pythonic
12563 representation of the position nearly transparently in Python code.
12564 """
d55e5bfc
RD
12565 newobj = _core_.new_GBPosition(*args, **kwargs)
12566 self.this = newobj.this
12567 self.thisown = 1
12568 del newobj.thisown
12569 def GetRow(*args, **kwargs):
12570 """GetRow(self) -> int"""
12571 return _core_.GBPosition_GetRow(*args, **kwargs)
12572
12573 def GetCol(*args, **kwargs):
12574 """GetCol(self) -> int"""
12575 return _core_.GBPosition_GetCol(*args, **kwargs)
12576
12577 def SetRow(*args, **kwargs):
12578 """SetRow(self, int row)"""
12579 return _core_.GBPosition_SetRow(*args, **kwargs)
12580
12581 def SetCol(*args, **kwargs):
12582 """SetCol(self, int col)"""
12583 return _core_.GBPosition_SetCol(*args, **kwargs)
12584
12585 def __eq__(*args, **kwargs):
12586 """__eq__(self, GBPosition other) -> bool"""
12587 return _core_.GBPosition___eq__(*args, **kwargs)
12588
12589 def __ne__(*args, **kwargs):
12590 """__ne__(self, GBPosition other) -> bool"""
12591 return _core_.GBPosition___ne__(*args, **kwargs)
12592
12593 def Set(*args, **kwargs):
12594 """Set(self, int row=0, int col=0)"""
12595 return _core_.GBPosition_Set(*args, **kwargs)
12596
12597 def Get(*args, **kwargs):
12598 """Get(self) -> PyObject"""
12599 return _core_.GBPosition_Get(*args, **kwargs)
12600
79fccf9d 12601 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
12602 def __str__(self): return str(self.Get())
12603 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
12604 def __len__(self): return len(self.Get())
12605 def __getitem__(self, index): return self.Get()[index]
12606 def __setitem__(self, index, val):
12607 if index == 0: self.SetRow(val)
12608 elif index == 1: self.SetCol(val)
12609 else: raise IndexError
12610 def __nonzero__(self): return self.Get() != (0,0)
12611 __safe_for_unpickling__ = True
12612 def __reduce__(self): return (wx.GBPosition, self.Get())
12613
12614 row = property(GetRow, SetRow)
12615 col = property(GetCol, SetCol)
12616
12617
12618class GBPositionPtr(GBPosition):
12619 def __init__(self, this):
12620 self.this = this
12621 if not hasattr(self,"thisown"): self.thisown = 0
12622 self.__class__ = GBPosition
12623_core_.GBPosition_swigregister(GBPositionPtr)
12624
12625class GBSpan(object):
248ed943
RD
12626 """
12627 This class is used to hold the row and column spanning attributes of
12628 items in a `wx.GridBagSizer`. wxPython has typemaps that will
12629 automatically convert from a 2-element sequence of integers to a
12630 wx.GBSpan, so you can use the more pythonic representation of the span
12631 nearly transparently in Python code.
12632
12633 """
d55e5bfc
RD
12634 def __repr__(self):
12635 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12636 def __init__(self, *args, **kwargs):
248ed943
RD
12637 """
12638 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
12639
12640 Construct a new wxGBSpan, optionally setting the rowspan and
12641 colspan. The default is (1,1). (Meaning that the item occupies one
12642 cell in each direction.
12643 """
d55e5bfc
RD
12644 newobj = _core_.new_GBSpan(*args, **kwargs)
12645 self.this = newobj.this
12646 self.thisown = 1
12647 del newobj.thisown
12648 def GetRowspan(*args, **kwargs):
12649 """GetRowspan(self) -> int"""
12650 return _core_.GBSpan_GetRowspan(*args, **kwargs)
12651
12652 def GetColspan(*args, **kwargs):
12653 """GetColspan(self) -> int"""
12654 return _core_.GBSpan_GetColspan(*args, **kwargs)
12655
12656 def SetRowspan(*args, **kwargs):
12657 """SetRowspan(self, int rowspan)"""
12658 return _core_.GBSpan_SetRowspan(*args, **kwargs)
12659
12660 def SetColspan(*args, **kwargs):
12661 """SetColspan(self, int colspan)"""
12662 return _core_.GBSpan_SetColspan(*args, **kwargs)
12663
12664 def __eq__(*args, **kwargs):
12665 """__eq__(self, GBSpan other) -> bool"""
12666 return _core_.GBSpan___eq__(*args, **kwargs)
12667
12668 def __ne__(*args, **kwargs):
12669 """__ne__(self, GBSpan other) -> bool"""
12670 return _core_.GBSpan___ne__(*args, **kwargs)
12671
12672 def Set(*args, **kwargs):
12673 """Set(self, int rowspan=1, int colspan=1)"""
12674 return _core_.GBSpan_Set(*args, **kwargs)
12675
12676 def Get(*args, **kwargs):
12677 """Get(self) -> PyObject"""
12678 return _core_.GBSpan_Get(*args, **kwargs)
12679
79fccf9d 12680 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
12681 def __str__(self): return str(self.Get())
12682 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
12683 def __len__(self): return len(self.Get())
12684 def __getitem__(self, index): return self.Get()[index]
12685 def __setitem__(self, index, val):
12686 if index == 0: self.SetRowspan(val)
12687 elif index == 1: self.SetColspan(val)
12688 else: raise IndexError
12689 def __nonzero__(self): return self.Get() != (0,0)
12690 __safe_for_unpickling__ = True
12691 def __reduce__(self): return (wx.GBSpan, self.Get())
12692
12693 rowspan = property(GetRowspan, SetRowspan)
12694 colspan = property(GetColspan, SetColspan)
12695
12696
12697class GBSpanPtr(GBSpan):
12698 def __init__(self, this):
12699 self.this = this
12700 if not hasattr(self,"thisown"): self.thisown = 0
12701 self.__class__ = GBSpan
12702_core_.GBSpan_swigregister(GBSpanPtr)
12703
12704class GBSizerItem(SizerItem):
248ed943
RD
12705 """
12706 The wx.GBSizerItem class is used to track the additional data about
12707 items in a `wx.GridBagSizer` such as the item's position in the grid
12708 and how many rows or columns it spans.
12709
12710 """
d55e5bfc
RD
12711 def __repr__(self):
12712 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12713 def __init__(self, *args, **kwargs):
248ed943
RD
12714 """
12715 __init__(self) -> GBSizerItem
12716
12717 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
12718 size will need to be set, as well as a position and span before this
12719 item can be used in a Sizer.
12720
12721 You will probably never need to create a wx.GBSizerItem directly as they
12722 are created automatically when the sizer's Add method is called.
12723 """
d55e5bfc
RD
12724 newobj = _core_.new_GBSizerItem(*args, **kwargs)
12725 self.this = newobj.this
12726 self.thisown = 1
12727 del newobj.thisown
12728 def GetPos(*args, **kwargs):
248ed943
RD
12729 """
12730 GetPos(self) -> GBPosition
12731
12732 Get the grid position of the item
12733 """
d55e5bfc
RD
12734 return _core_.GBSizerItem_GetPos(*args, **kwargs)
12735
12736 def GetPosTuple(self): return self.GetPos().Get()
12737 def GetSpan(*args, **kwargs):
248ed943
RD
12738 """
12739 GetSpan(self) -> GBSpan
12740
12741 Get the row and column spanning of the item
12742 """
d55e5bfc
RD
12743 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
12744
12745 def GetSpanTuple(self): return self.GetSpan().Get()
12746 def SetPos(*args, **kwargs):
248ed943
RD
12747 """
12748 SetPos(self, GBPosition pos) -> bool
12749
12750 If the item is already a member of a sizer then first ensure that
12751 there is no other item that would intersect with this one at the new
12752 position, then set the new position. Returns True if the change is
12753 successful and after the next Layout() the item will be moved.
12754 """
d55e5bfc
RD
12755 return _core_.GBSizerItem_SetPos(*args, **kwargs)
12756
12757 def SetSpan(*args, **kwargs):
248ed943
RD
12758 """
12759 SetSpan(self, GBSpan span) -> bool
12760
12761 If the item is already a member of a sizer then first ensure that
12762 there is no other item that would intersect with this one with its new
12763 spanning size, then set the new spanning. Returns True if the change
12764 is successful and after the next Layout() the item will be resized.
12765
12766 """
d55e5bfc
RD
12767 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
12768
248ed943 12769 def Intersects(*args, **kwargs):
d55e5bfc
RD
12770 """
12771 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
12772
12773 Returns True if this item and the other item instersect.
d55e5bfc 12774 """
248ed943
RD
12775 return _core_.GBSizerItem_Intersects(*args, **kwargs)
12776
12777 def IntersectsPos(*args, **kwargs):
12778 """
12779 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
12780
12781 Returns True if the given pos/span would intersect with this item.
12782 """
12783 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
12784
12785 def GetEndPos(*args, **kwargs):
248ed943
RD
12786 """
12787 GetEndPos(self) -> GBPosition
12788
12789 Get the row and column of the endpoint of this item.
12790 """
d55e5bfc
RD
12791 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
12792
12793 def GetGBSizer(*args, **kwargs):
248ed943
RD
12794 """
12795 GetGBSizer(self) -> GridBagSizer
12796
12797 Get the sizer this item is a member of.
12798 """
d55e5bfc
RD
12799 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
12800
12801 def SetGBSizer(*args, **kwargs):
248ed943
RD
12802 """
12803 SetGBSizer(self, GridBagSizer sizer)
12804
12805 Set the sizer this item is a member of.
12806 """
d55e5bfc
RD
12807 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
12808
12809
12810class GBSizerItemPtr(GBSizerItem):
12811 def __init__(self, this):
12812 self.this = this
12813 if not hasattr(self,"thisown"): self.thisown = 0
12814 self.__class__ = GBSizerItem
12815_core_.GBSizerItem_swigregister(GBSizerItemPtr)
12816DefaultSpan = cvar.DefaultSpan
12817
12818def GBSizerItemWindow(*args, **kwargs):
12819 """
12820 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
12821 int border, PyObject userData=None) -> GBSizerItem
12822
12823 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
12824 """
12825 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
12826 val.thisown = 1
12827 return val
12828
12829def GBSizerItemSizer(*args, **kwargs):
12830 """
12831 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
12832 int border, PyObject userData=None) -> GBSizerItem
12833
12834 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
12835 """
12836 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
12837 val.thisown = 1
12838 return val
12839
12840def GBSizerItemSpacer(*args, **kwargs):
12841 """
12842 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
12843 int flag, int border, PyObject userData=None) -> GBSizerItem
12844
12845 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
12846 """
12847 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
12848 val.thisown = 1
12849 return val
12850
12851class GridBagSizer(FlexGridSizer):
248ed943
RD
12852 """
12853 A `wx.Sizer` that can lay out items in a virtual grid like a
12854 `wx.FlexGridSizer` but in this case explicit positioning of the items
12855 is allowed using `wx.GBPosition`, and items can optionally span more
12856 than one row and/or column using `wx.GBSpan`. The total size of the
12857 virtual grid is determined by the largest row and column that items are
12858 positioned at, adjusted for spanning.
12859
12860 """
d55e5bfc
RD
12861 def __repr__(self):
12862 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
12863 def __init__(self, *args, **kwargs):
248ed943
RD
12864 """
12865 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
12866
12867 Constructor, with optional parameters to specify the gap between the
12868 rows and columns.
12869 """
d55e5bfc
RD
12870 newobj = _core_.new_GridBagSizer(*args, **kwargs)
12871 self.this = newobj.this
12872 self.thisown = 1
12873 del newobj.thisown
c9c2cf70
RD
12874 self._setOORInfo(self)
12875
d55e5bfc
RD
12876 def Add(*args, **kwargs):
12877 """
248ed943 12878 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 12879 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
12880
12881 Adds an item to the sizer at the grid cell *pos*, optionally spanning
12882 more than one row or column as specified with *span*. The remaining
12883 args behave similarly to `wx.Sizer.Add`.
12884
12885 Returns True if the item was successfully placed at the given cell
12886 position, False if something was already there.
12887
d55e5bfc
RD
12888 """
12889 return _core_.GridBagSizer_Add(*args, **kwargs)
12890
12891 def AddItem(*args, **kwargs):
248ed943 12892 """
c1cb24a4 12893 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
12894
12895 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
12896 the item was successfully placed at its given cell position, False if
12897 something was already there.
12898 """
d55e5bfc
RD
12899 return _core_.GridBagSizer_AddItem(*args, **kwargs)
12900
84f85550
RD
12901 def GetCellSize(*args, **kwargs):
12902 """
12903 GetCellSize(self, int row, int col) -> Size
12904
12905 Get the size of the specified cell, including hgap and
12906 vgap. Only valid after a Layout.
12907 """
12908 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
12909
d55e5bfc 12910 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
12911 """
12912 GetEmptyCellSize(self) -> Size
12913
12914 Get the size used for cells in the grid with no item.
12915 """
d55e5bfc
RD
12916 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
12917
12918 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
12919 """
12920 SetEmptyCellSize(self, Size sz)
12921
12922 Set the size used for cells in the grid with no item.
12923 """
d55e5bfc
RD
12924 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
12925
12926 def GetItemPosition(*args):
12927 """
248ed943
RD
12928 GetItemPosition(self, item) -> GBPosition
12929
12930 Get the grid position of the specified *item* where *item* is either a
12931 window or subsizer that is a member of this sizer, or a zero-based
12932 index of an item.
d55e5bfc
RD
12933 """
12934 return _core_.GridBagSizer_GetItemPosition(*args)
12935
12936 def SetItemPosition(*args):
12937 """
248ed943
RD
12938 SetItemPosition(self, item, GBPosition pos) -> bool
12939
12940 Set the grid position of the specified *item* where *item* is either a
12941 window or subsizer that is a member of this sizer, or a zero-based
12942 index of an item. Returns True on success. If the move is not
12943 allowed (because an item is already there) then False is returned.
12944
d55e5bfc
RD
12945 """
12946 return _core_.GridBagSizer_SetItemPosition(*args)
12947
12948 def GetItemSpan(*args):
12949 """
248ed943
RD
12950 GetItemSpan(self, item) -> GBSpan
12951
12952 Get the row/col spanning of the specified *item* where *item* is
12953 either a window or subsizer that is a member of this sizer, or a
12954 zero-based index of an item.
d55e5bfc
RD
12955 """
12956 return _core_.GridBagSizer_GetItemSpan(*args)
12957
12958 def SetItemSpan(*args):
12959 """
248ed943
RD
12960 SetItemSpan(self, item, GBSpan span) -> bool
12961
12962 Set the row/col spanning of the specified *item* where *item* is
12963 either a window or subsizer that is a member of this sizer, or a
12964 zero-based index of an item. Returns True on success. If the move is
12965 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
12966 """
12967 return _core_.GridBagSizer_SetItemSpan(*args)
12968
12969 def FindItem(*args):
12970 """
248ed943
RD
12971 FindItem(self, item) -> GBSizerItem
12972
12973 Find the sizer item for the given window or subsizer, returns None if
12974 not found. (non-recursive)
d55e5bfc
RD
12975 """
12976 return _core_.GridBagSizer_FindItem(*args)
12977
12978 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
12979 """
12980 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
12981
12982 Return the sizer item for the given grid cell, or None if there is no
12983 item at that position. (non-recursive)
12984 """
d55e5bfc
RD
12985 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
12986
12987 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
12988 """
12989 FindItemAtPoint(self, Point pt) -> GBSizerItem
12990
12991 Return the sizer item located at the point given in *pt*, or None if
12992 there is no item at that point. The (x,y) coordinates in pt correspond
12993 to the client coordinates of the window using the sizer for
12994 layout. (non-recursive)
12995 """
d55e5bfc
RD
12996 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
12997
248ed943
RD
12998 def CheckForIntersection(*args, **kwargs):
12999 """
13000 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 13001
248ed943
RD
13002 Look at all items and see if any intersect (or would overlap) the
13003 given *item*. Returns True if so, False if there would be no overlap.
13004 If an *excludeItem* is given then it will not be checked for
13005 intersection, for example it may be the item we are checking the
13006 position of.
d55e5bfc 13007
248ed943
RD
13008 """
13009 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 13010
248ed943 13011 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 13012 """
248ed943
RD
13013 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
13014
13015 Look at all items and see if any intersect (or would overlap) the
13016 given position and span. Returns True if so, False if there would be
13017 no overlap. If an *excludeItem* is given then it will not be checked
13018 for intersection, for example it may be the item we are checking the
13019 position of.
d55e5bfc 13020 """
248ed943 13021 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
13022
13023
13024class GridBagSizerPtr(GridBagSizer):
13025 def __init__(self, this):
13026 self.this = this
13027 if not hasattr(self,"thisown"): self.thisown = 0
13028 self.__class__ = GridBagSizer
13029_core_.GridBagSizer_swigregister(GridBagSizerPtr)
13030
13031#---------------------------------------------------------------------------
13032
13033Left = _core_.Left
13034Top = _core_.Top
13035Right = _core_.Right
13036Bottom = _core_.Bottom
13037Width = _core_.Width
13038Height = _core_.Height
13039Centre = _core_.Centre
13040Center = _core_.Center
13041CentreX = _core_.CentreX
13042CentreY = _core_.CentreY
13043Unconstrained = _core_.Unconstrained
13044AsIs = _core_.AsIs
13045PercentOf = _core_.PercentOf
13046Above = _core_.Above
13047Below = _core_.Below
13048LeftOf = _core_.LeftOf
13049RightOf = _core_.RightOf
13050SameAs = _core_.SameAs
13051Absolute = _core_.Absolute
13052class IndividualLayoutConstraint(Object):
13053 """
79fccf9d
RD
13054 Objects of this class are stored in the `wx.LayoutConstraints` class as
13055 one of eight possible constraints that a window can be involved in.
13056 You will never need to create an instance of
13057 wx.IndividualLayoutConstraint, rather you should create a
13058 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 13059 that it contains.
d55e5bfc
RD
13060 """
13061 def __init__(self): raise RuntimeError, "No constructor defined"
13062 def __repr__(self):
13063 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
13064 def Set(*args, **kwargs):
79fccf9d
RD
13065 """
13066 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
13067
13068 Sets the properties of the constraint. Normally called by one of the
13069 convenience functions such as Above, RightOf, SameAs.
13070 """
d55e5bfc
RD
13071 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
13072
13073 def LeftOf(*args, **kwargs):
13074 """
13075 LeftOf(self, Window sibling, int marg=0)
13076
79fccf9d
RD
13077 Constrains this edge to be to the left of the given window, with an
13078 optional margin. Implicitly, this is relative to the left edge of the
13079 other window.
d55e5bfc
RD
13080 """
13081 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
13082
13083 def RightOf(*args, **kwargs):
13084 """
13085 RightOf(self, Window sibling, int marg=0)
13086
79fccf9d
RD
13087 Constrains this edge to be to the right of the given window, with an
13088 optional margin. Implicitly, this is relative to the right edge of the
13089 other window.
d55e5bfc
RD
13090 """
13091 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
13092
13093 def Above(*args, **kwargs):
13094 """
13095 Above(self, Window sibling, int marg=0)
13096
79fccf9d
RD
13097 Constrains this edge to be above the given window, with an optional
13098 margin. Implicitly, this is relative to the top edge of the other
13099 window.
d55e5bfc
RD
13100 """
13101 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
13102
13103 def Below(*args, **kwargs):
13104 """
13105 Below(self, Window sibling, int marg=0)
13106
79fccf9d
RD
13107 Constrains this edge to be below the given window, with an optional
13108 margin. Implicitly, this is relative to the bottom edge of the other
13109 window.
d55e5bfc
RD
13110 """
13111 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
13112
13113 def SameAs(*args, **kwargs):
13114 """
13115 SameAs(self, Window otherW, int edge, int marg=0)
13116
79fccf9d
RD
13117 Constrains this edge or dimension to be to the same as the edge of the
13118 given window, with an optional margin.
d55e5bfc
RD
13119 """
13120 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
13121
13122 def PercentOf(*args, **kwargs):
13123 """
13124 PercentOf(self, Window otherW, int wh, int per)
13125
79fccf9d
RD
13126 Constrains this edge or dimension to be to a percentage of the given
13127 window, with an optional margin.
d55e5bfc
RD
13128 """
13129 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
13130
13131 def Absolute(*args, **kwargs):
13132 """
13133 Absolute(self, int val)
13134
79fccf9d 13135 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
13136 """
13137 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
13138
13139 def Unconstrained(*args, **kwargs):
13140 """
13141 Unconstrained(self)
13142
79fccf9d
RD
13143 Sets this edge or dimension to be unconstrained, that is, dependent on
13144 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
13145 """
13146 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
13147
13148 def AsIs(*args, **kwargs):
13149 """
13150 AsIs(self)
13151
79fccf9d
RD
13152 Sets this edge or constraint to be whatever the window's value is at
13153 the moment. If either of the width and height constraints are *as is*,
13154 the window will not be resized, but moved instead. This is important
13155 when considering panel items which are intended to have a default
13156 size, such as a button, which may take its size from the size of the
13157 button label.
d55e5bfc
RD
13158 """
13159 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
13160
13161 def GetOtherWindow(*args, **kwargs):
13162 """GetOtherWindow(self) -> Window"""
13163 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
13164
13165 def GetMyEdge(*args, **kwargs):
13166 """GetMyEdge(self) -> int"""
13167 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
13168
13169 def SetEdge(*args, **kwargs):
13170 """SetEdge(self, int which)"""
13171 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
13172
13173 def SetValue(*args, **kwargs):
13174 """SetValue(self, int v)"""
13175 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
13176
13177 def GetMargin(*args, **kwargs):
13178 """GetMargin(self) -> int"""
13179 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
13180
13181 def SetMargin(*args, **kwargs):
13182 """SetMargin(self, int m)"""
13183 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
13184
13185 def GetValue(*args, **kwargs):
13186 """GetValue(self) -> int"""
13187 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
13188
13189 def GetPercent(*args, **kwargs):
13190 """GetPercent(self) -> int"""
13191 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
13192
13193 def GetOtherEdge(*args, **kwargs):
13194 """GetOtherEdge(self) -> int"""
13195 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
13196
13197 def GetDone(*args, **kwargs):
13198 """GetDone(self) -> bool"""
13199 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
13200
13201 def SetDone(*args, **kwargs):
13202 """SetDone(self, bool d)"""
13203 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
13204
13205 def GetRelationship(*args, **kwargs):
13206 """GetRelationship(self) -> int"""
13207 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
13208
13209 def SetRelationship(*args, **kwargs):
13210 """SetRelationship(self, int r)"""
13211 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
13212
13213 def ResetIfWin(*args, **kwargs):
13214 """
13215 ResetIfWin(self, Window otherW) -> bool
13216
13217 Reset constraint if it mentions otherWin
13218 """
13219 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
13220
13221 def SatisfyConstraint(*args, **kwargs):
13222 """
13223 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
13224
13225 Try to satisfy constraint
13226 """
13227 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
13228
13229 def GetEdge(*args, **kwargs):
13230 """
13231 GetEdge(self, int which, Window thisWin, Window other) -> int
13232
13233 Get the value of this edge or dimension, or if this
13234 is not determinable, -1.
13235 """
13236 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
13237
13238
13239class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
13240 def __init__(self, this):
13241 self.this = this
13242 if not hasattr(self,"thisown"): self.thisown = 0
13243 self.__class__ = IndividualLayoutConstraint
13244_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
13245
13246class LayoutConstraints(Object):
13247 """
79fccf9d
RD
13248 **Note:** constraints are now deprecated and you should use sizers
13249 instead.
d55e5bfc 13250
79fccf9d
RD
13251 Objects of this class can be associated with a window to define its
13252 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
13253
13254 The class consists of the following eight constraints of class
13255 wx.IndividualLayoutConstraint, some or all of which should be accessed
13256 directly to set the appropriate constraints.
13257
13258 * left: represents the left hand edge of the window
13259 * right: represents the right hand edge of the window
13260 * top: represents the top edge of the window
13261 * bottom: represents the bottom edge of the window
13262 * width: represents the width of the window
13263 * height: represents the height of the window
13264 * centreX: represents the horizontal centre point of the window
13265 * centreY: represents the vertical centre point of the window
13266
79fccf9d
RD
13267 Most constraints are initially set to have the relationship
13268 wxUnconstrained, which means that their values should be calculated by
13269 looking at known constraints. The exceptions are width and height,
13270 which are set to wxAsIs to ensure that if the user does not specify a
13271 constraint, the existing width and height will be used, to be
13272 compatible with panel items which often have take a default size. If
13273 the constraint is ``wx.AsIs``, the dimension will not be changed.
13274
13275 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
13276
13277 """
13278 def __repr__(self):
13279 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
13280 left = property(_core_.LayoutConstraints_left_get)
13281 top = property(_core_.LayoutConstraints_top_get)
13282 right = property(_core_.LayoutConstraints_right_get)
13283 bottom = property(_core_.LayoutConstraints_bottom_get)
13284 width = property(_core_.LayoutConstraints_width_get)
13285 height = property(_core_.LayoutConstraints_height_get)
13286 centreX = property(_core_.LayoutConstraints_centreX_get)
13287 centreY = property(_core_.LayoutConstraints_centreY_get)
13288 def __init__(self, *args, **kwargs):
13289 """__init__(self) -> LayoutConstraints"""
13290 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
13291 self.this = newobj.this
13292 self.thisown = 1
13293 del newobj.thisown
13294 def SatisfyConstraints(*args, **kwargs):
13295 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
13296 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
13297
13298 def AreSatisfied(*args, **kwargs):
13299 """AreSatisfied(self) -> bool"""
13300 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
13301
13302
13303class LayoutConstraintsPtr(LayoutConstraints):
13304 def __init__(self, this):
13305 self.this = this
13306 if not hasattr(self,"thisown"): self.thisown = 0
13307 self.__class__ = LayoutConstraints
13308_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
13309
13310#----------------------------------------------------------------------------
13311
13312# Use Python's bool constants if available, make some if not
13313try:
13314 True
13315except NameError:
13316 __builtins__.True = 1==1
13317 __builtins__.False = 1==0
13318 def bool(value): return not not value
13319 __builtins__.bool = bool
13320
13321
13322
13323# workarounds for bad wxRTTI names
13324__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
13325__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
13326__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
13327
13328
13329#----------------------------------------------------------------------------
13330# Load version numbers from __version__... Ensure that major and minor
0f63ec68 13331# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD
13332
13333from __version__ import *
13334__version__ = VERSION_STRING
13335
0f63ec68
RD
13336assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
13337assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD
13338if RELEASE_VERSION != _core_.RELEASE_VERSION:
13339 import warnings
0f63ec68 13340 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD
13341
13342#----------------------------------------------------------------------------
13343
70b7a5fe
RD
13344# Set wxPython's default string<-->unicode conversion encoding from
13345# the locale, but only if Python's default hasn't been changed. (We
13346# assume that if the user has customized it already then that is the
13347# encoding we need to use as well.)
13348#
13349# The encoding selected here is used when string or unicode objects
13350# need to be converted in order to pass them to wxWidgets. Please be
13351# aware that the default encoding within the same locale may be
13352# slightly different on different platforms. For example, please see
62d32a5f
RD
13353# http://www.alanwood.net/demos/charsetdiffs.html for differences
13354# between the common latin/roman encodings.
396fb509
RD
13355
13356default = _sys.getdefaultencoding()
13357if default == 'ascii':
13358 import locale
13359 import codecs
13360 try:
13361 default = locale.getdefaultlocale()[1]
13362 codecs.lookup(default)
70b7a5fe 13363 except (ValueError, LookupError, TypeError):
396fb509
RD
13364 default = _sys.getdefaultencoding()
13365 del locale
13366 del codecs
5cbf236d
RD
13367if default:
13368 wx.SetDefaultPyEncoding(default)
13369del default
5cbf236d
RD
13370
13371#----------------------------------------------------------------------------
13372
d55e5bfc
RD
13373class PyDeadObjectError(AttributeError):
13374 pass
13375
13376class _wxPyDeadObject(object):
13377 """
13378 Instances of wx objects that are OOR capable will have their __class__
13379 changed to this class when the C++ object is deleted. This should help
13380 prevent crashes due to referencing a bogus C++ pointer.
13381 """
13382 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
13383 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
13384
13385 def __repr__(self):
13386 if not hasattr(self, "_name"):
13387 self._name = "[unknown]"
13388 return self.reprStr % self._name
13389
13390 def __getattr__(self, *args):
13391 if not hasattr(self, "_name"):
13392 self._name = "[unknown]"
13393 raise PyDeadObjectError(self.attrStr % self._name)
13394
13395 def __nonzero__(self):
13396 return 0
13397
13398
13399
13400class PyUnbornObjectError(AttributeError):
13401 pass
13402
13403class _wxPyUnbornObject(object):
13404 """
13405 Some stock objects are created when the wx._core module is
13406 imported, but their C++ instance is not created until the wx.App
13407 object is created and initialized. These object instances will
13408 temporarily have their __class__ changed to this class so an
13409 exception will be raised if they are used before the C++ instance
13410 is ready.
13411 """
13412
13413 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
13414 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
13415
13416 def __repr__(self):
13417 #if not hasattr(self, "_name"):
13418 # self._name = "[unknown]"
13419 return self.reprStr #% self._name
13420
13421 def __getattr__(self, *args):
13422 #if not hasattr(self, "_name"):
13423 # self._name = "[unknown]"
13424 raise PyUnbornObjectError(self.attrStr) # % self._name )
13425
13426 def __nonzero__(self):
13427 return 0
13428
13429
13430#----------------------------------------------------------------------------
d55e5bfc
RD
13431
13432def CallAfter(callable, *args, **kw):
13433 """
13434 Call the specified function after the current and pending event
13435 handlers have been completed. This is also good for making GUI
0439c23b
RD
13436 method calls from non-GUI threads. Any extra positional or
13437 keyword args are passed on to the callable when it is called.
13438
13439 :see: `wx.FutureCall`
d55e5bfc
RD
13440 """
13441 app = wx.GetApp()
a001823c 13442 assert app is not None, 'No wx.App created yet'
d55e5bfc 13443
891bb194
RD
13444 if not hasattr(app, "_CallAfterId"):
13445 app._CallAfterId = wx.NewEventType()
13446 app.Connect(-1, -1, app._CallAfterId,
13447 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 13448 evt = wx.PyEvent()
891bb194 13449 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD
13450 evt.callable = callable
13451 evt.args = args
13452 evt.kw = kw
13453 wx.PostEvent(app, evt)
13454
d55e5bfc
RD
13455#----------------------------------------------------------------------------
13456
13457
13458class FutureCall:
13459 """
8ac8dba0 13460 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD
13461 object once after the given amount of milliseconds, passing any
13462 positional or keyword args. The return value of the callable is
0439c23b 13463 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
13464
13465 If you don't need to get the return value or restart the timer
13466 then there is no need to hold a reference to this object. It will
13467 hold a reference to itself while the timer is running (the timer
13468 has a reference to self.Notify) but the cycle will be broken when
13469 the timer completes, automatically cleaning up the wx.FutureCall
13470 object.
0439c23b
RD
13471
13472 :see: `wx.CallAfter`
d55e5bfc
RD
13473 """
13474 def __init__(self, millis, callable, *args, **kwargs):
13475 self.millis = millis
13476 self.callable = callable
13477 self.SetArgs(*args, **kwargs)
13478 self.runCount = 0
13479 self.running = False
13480 self.hasRun = False
13481 self.result = None
13482 self.timer = None
13483 self.Start()
13484
13485 def __del__(self):
13486 self.Stop()
13487
13488
13489 def Start(self, millis=None, *args, **kwargs):
13490 """
13491 (Re)start the timer
13492 """
13493 self.hasRun = False
13494 if millis is not None:
13495 self.millis = millis
13496 if args or kwargs:
13497 self.SetArgs(*args, **kwargs)
13498 self.Stop()
13499 self.timer = wx.PyTimer(self.Notify)
13500 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
13501 self.running = True
13502 Restart = Start
13503
13504
13505 def Stop(self):
13506 """
13507 Stop and destroy the timer.
13508 """
13509 if self.timer is not None:
13510 self.timer.Stop()
13511 self.timer = None
13512
13513
13514 def GetInterval(self):
13515 if self.timer is not None:
13516 return self.timer.GetInterval()
13517 else:
13518 return 0
13519
13520
13521 def IsRunning(self):
13522 return self.timer is not None and self.timer.IsRunning()
13523
13524
13525 def SetArgs(self, *args, **kwargs):
13526 """
13527 (Re)set the args passed to the callable object. This is
13528 useful in conjunction with Restart if you want to schedule a
13529 new call to the same callable object but with different
13530 parameters.
13531 """
13532 self.args = args
13533 self.kwargs = kwargs
13534
13535
13536 def HasRun(self):
13537 return self.hasRun
13538
13539 def GetResult(self):
13540 return self.result
13541
13542 def Notify(self):
13543 """
13544 The timer has expired so call the callable.
13545 """
13546 if self.callable and getattr(self.callable, 'im_self', True):
13547 self.runCount += 1
13548 self.running = False
13549 self.result = self.callable(*self.args, **self.kwargs)
13550 self.hasRun = True
13551 if not self.running:
13552 # if it wasn't restarted, then cleanup
13553 wx.CallAfter(self.Stop)
13554
13555
13556
13557#----------------------------------------------------------------------------
13558# Control which items in this module should be documented by epydoc.
13559# We allow only classes and functions, which will help reduce the size
13560# of the docs by filtering out the zillions of constants, EVT objects,
13561# and etc that don't make much sense by themselves, but are instead
13562# documented (or will be) as part of the classes/functions/methods
13563# where they should be used.
13564
c24da6d6
RD
13565class __DocFilter:
13566 """
13567 A filter for epydoc that only allows non-Ptr classes and
13568 fucntions, in order to reduce the clutter in the API docs.
13569 """
13570 def __init__(self, globals):
13571 self._globals = globals
13572
13573 def __call__(self, name):
13574 import types
13575 obj = self._globals.get(name, None)
13576 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
13577 return False
13578 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
13579 return False
13580 return True
d55e5bfc
RD
13581
13582#----------------------------------------------------------------------------
13583#----------------------------------------------------------------------------
13584
13585# Import other modules in this package that should show up in the
13586# "core" wx namespace
13587from _gdi import *
13588from _windows import *
13589from _controls import *
13590from _misc import *
13591
13592
13593# Fixup the stock objects since they can't be used yet. (They will be
13594# restored in wx.PyApp.OnInit.)
13595_core_._wxPyFixStockObjects()
13596
13597#----------------------------------------------------------------------------
13598#----------------------------------------------------------------------------
13599
13600