]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Tests for UTF-8 and PUA characters and octal escapes
[wxWidgets.git] / wxPython / src / msw / _core.py
CommitLineData
d55e5bfc
RD		 1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
5
093d3ff1
RD		 6def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
7 if (name == "this"):
8 if isinstance(value, class_type):
9 self.__dict__[name] = value.this
10 if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown
11 del value.thisown
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
15 if (not static) or hasattr(self,name) or (name == "thisown"):
16 self.__dict__[name] = value
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
23def _swig_getattr(self,class_type,name):
24 method = class_type.__swig_getmethods__.get(name,None)
25 if method: return method(self)
26 raise AttributeError,name
27
28import types
29try:
30 _object = types.ObjectType
31 _newclass = 1
32except AttributeError:
33 class _object : pass
34 _newclass = 0
35del types
36
37
38def _swig_setattr_nondynamic_method(set):
39 def set_attr(self,name,value):
40 if hasattr(self,name) or (name in ("this", "thisown")):
41 set(self,name,value)
42 else:
43 raise AttributeError("You cannot add attributes to %s" % self)
44 return set_attr
45
46
d55e5bfc
RD		 47#// Give a reference to the dictionary of this module to the C++ extension
48#// code.
49_core_._wxPySetDictionary(vars())
50
51#// A little trick to make 'wx' be a reference to this module so wx.Names can
52#// be used here.
53import sys as _sys
54wx = _sys.modules[__name__]
55
c24da6d6
RD		 56
57#----------------------------------------------------------------------------
58
59def _deprecated(callable, msg=None):
60 """
61 Create a wrapper function that will raise a DeprecationWarning
62 before calling the callable.
63 """
64 if msg is None:
65 msg = "%s is deprecated" % callable
66 def deprecatedWrapper(*args, **kwargs):
67 import warnings
68 warnings.warn(msg, DeprecationWarning, stacklevel=2)
69 return callable(*args, **kwargs)
70 deprecatedWrapper.__doc__ = msg
71 return deprecatedWrapper
72
73
74#----------------------------------------------------------------------------
75
d55e5bfc
RD		 76NOT_FOUND = _core_.NOT_FOUND
77VSCROLL = _core_.VSCROLL
78HSCROLL = _core_.HSCROLL
79CAPTION = _core_.CAPTION
80DOUBLE_BORDER = _core_.DOUBLE_BORDER
81SUNKEN_BORDER = _core_.SUNKEN_BORDER
82RAISED_BORDER = _core_.RAISED_BORDER
83BORDER = _core_.BORDER
84SIMPLE_BORDER = _core_.SIMPLE_BORDER
85STATIC_BORDER = _core_.STATIC_BORDER
86TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
87NO_BORDER = _core_.NO_BORDER
88TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
89WANTS_CHARS = _core_.WANTS_CHARS
90POPUP_WINDOW = _core_.POPUP_WINDOW
91CENTER_FRAME = _core_.CENTER_FRAME
92CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
93CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
d55e5bfc
RD		 94CLIP_CHILDREN = _core_.CLIP_CHILDREN
95CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
96ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
97RETAINED = _core_.RETAINED
98BACKINGSTORE = _core_.BACKINGSTORE
99COLOURED = _core_.COLOURED
100FIXED_LENGTH = _core_.FIXED_LENGTH
101LB_NEEDED_SB = _core_.LB_NEEDED_SB
102LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
103LB_SORT = _core_.LB_SORT
104LB_SINGLE = _core_.LB_SINGLE
105LB_MULTIPLE = _core_.LB_MULTIPLE
106LB_EXTENDED = _core_.LB_EXTENDED
107LB_OWNERDRAW = _core_.LB_OWNERDRAW
108LB_HSCROLL = _core_.LB_HSCROLL
109PROCESS_ENTER = _core_.PROCESS_ENTER
110PASSWORD = _core_.PASSWORD
111CB_SIMPLE = _core_.CB_SIMPLE
112CB_DROPDOWN = _core_.CB_DROPDOWN
113CB_SORT = _core_.CB_SORT
114CB_READONLY = _core_.CB_READONLY
115RA_HORIZONTAL = _core_.RA_HORIZONTAL
116RA_VERTICAL = _core_.RA_VERTICAL
117RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
118RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
fef4c27a 119RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
d55e5bfc
RD		 120RB_GROUP = _core_.RB_GROUP
121RB_SINGLE = _core_.RB_SINGLE
d55e5bfc
RD		 122SB_HORIZONTAL = _core_.SB_HORIZONTAL
123SB_VERTICAL = _core_.SB_VERTICAL
fef4c27a 124RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
d55e5bfc
RD		 125ST_SIZEGRIP = _core_.ST_SIZEGRIP
126ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
127FLOOD_SURFACE = _core_.FLOOD_SURFACE
128FLOOD_BORDER = _core_.FLOOD_BORDER
129ODDEVEN_RULE = _core_.ODDEVEN_RULE
130WINDING_RULE = _core_.WINDING_RULE
131TOOL_TOP = _core_.TOOL_TOP
132TOOL_BOTTOM = _core_.TOOL_BOTTOM
133TOOL_LEFT = _core_.TOOL_LEFT
134TOOL_RIGHT = _core_.TOOL_RIGHT
135OK = _core_.OK
136YES_NO = _core_.YES_NO
137CANCEL = _core_.CANCEL
138YES = _core_.YES
139NO = _core_.NO
140NO_DEFAULT = _core_.NO_DEFAULT
141YES_DEFAULT = _core_.YES_DEFAULT
142ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
143ICON_HAND = _core_.ICON_HAND
144ICON_QUESTION = _core_.ICON_QUESTION
145ICON_INFORMATION = _core_.ICON_INFORMATION
146ICON_STOP = _core_.ICON_STOP
147ICON_ASTERISK = _core_.ICON_ASTERISK
148ICON_MASK = _core_.ICON_MASK
149ICON_WARNING = _core_.ICON_WARNING
150ICON_ERROR = _core_.ICON_ERROR
151FORWARD = _core_.FORWARD
152BACKWARD = _core_.BACKWARD
153RESET = _core_.RESET
154HELP = _core_.HELP
155MORE = _core_.MORE
156SETUP = _core_.SETUP
157SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
158SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
159SIZE_AUTO = _core_.SIZE_AUTO
160SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
161SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
162PORTRAIT = _core_.PORTRAIT
163LANDSCAPE = _core_.LANDSCAPE
164PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
165PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
166PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
167PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
168ID_ANY = _core_.ID_ANY
169ID_SEPARATOR = _core_.ID_SEPARATOR
170ID_LOWEST = _core_.ID_LOWEST
171ID_OPEN = _core_.ID_OPEN
172ID_CLOSE = _core_.ID_CLOSE
173ID_NEW = _core_.ID_NEW
174ID_SAVE = _core_.ID_SAVE
175ID_SAVEAS = _core_.ID_SAVEAS
176ID_REVERT = _core_.ID_REVERT
177ID_EXIT = _core_.ID_EXIT
178ID_UNDO = _core_.ID_UNDO
179ID_REDO = _core_.ID_REDO
180ID_HELP = _core_.ID_HELP
181ID_PRINT = _core_.ID_PRINT
182ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
183ID_PREVIEW = _core_.ID_PREVIEW
184ID_ABOUT = _core_.ID_ABOUT
185ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
186ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
187ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
188ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
189ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
190ID_PREFERENCES = _core_.ID_PREFERENCES
191ID_CUT = _core_.ID_CUT
192ID_COPY = _core_.ID_COPY
193ID_PASTE = _core_.ID_PASTE
194ID_CLEAR = _core_.ID_CLEAR
195ID_FIND = _core_.ID_FIND
196ID_DUPLICATE = _core_.ID_DUPLICATE
197ID_SELECTALL = _core_.ID_SELECTALL
198ID_DELETE = _core_.ID_DELETE
199ID_REPLACE = _core_.ID_REPLACE
200ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
201ID_PROPERTIES = _core_.ID_PROPERTIES
202ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
203ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
204ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
205ID_VIEW_LIST = _core_.ID_VIEW_LIST
206ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
207ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
208ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
209ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
210ID_FILE1 = _core_.ID_FILE1
211ID_FILE2 = _core_.ID_FILE2
212ID_FILE3 = _core_.ID_FILE3
213ID_FILE4 = _core_.ID_FILE4
214ID_FILE5 = _core_.ID_FILE5
215ID_FILE6 = _core_.ID_FILE6
216ID_FILE7 = _core_.ID_FILE7
217ID_FILE8 = _core_.ID_FILE8
218ID_FILE9 = _core_.ID_FILE9
219ID_OK = _core_.ID_OK
220ID_CANCEL = _core_.ID_CANCEL
221ID_APPLY = _core_.ID_APPLY
222ID_YES = _core_.ID_YES
223ID_NO = _core_.ID_NO
224ID_STATIC = _core_.ID_STATIC
225ID_FORWARD = _core_.ID_FORWARD
226ID_BACKWARD = _core_.ID_BACKWARD
227ID_DEFAULT = _core_.ID_DEFAULT
228ID_MORE = _core_.ID_MORE
229ID_SETUP = _core_.ID_SETUP
230ID_RESET = _core_.ID_RESET
231ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
232ID_YESTOALL = _core_.ID_YESTOALL
233ID_NOTOALL = _core_.ID_NOTOALL
234ID_ABORT = _core_.ID_ABORT
235ID_RETRY = _core_.ID_RETRY
236ID_IGNORE = _core_.ID_IGNORE
0f63ec68
RD		 237ID_ADD = _core_.ID_ADD
238ID_REMOVE = _core_.ID_REMOVE
239ID_UP = _core_.ID_UP
240ID_DOWN = _core_.ID_DOWN
241ID_HOME = _core_.ID_HOME
242ID_REFRESH = _core_.ID_REFRESH
243ID_STOP = _core_.ID_STOP
244ID_INDEX = _core_.ID_INDEX
245ID_BOLD = _core_.ID_BOLD
246ID_ITALIC = _core_.ID_ITALIC
247ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
248ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
249ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
250ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
251ID_UNDERLINE = _core_.ID_UNDERLINE
252ID_INDENT = _core_.ID_INDENT
253ID_UNINDENT = _core_.ID_UNINDENT
254ID_ZOOM_100 = _core_.ID_ZOOM_100
255ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
256ID_ZOOM_IN = _core_.ID_ZOOM_IN
257ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
258ID_UNDELETE = _core_.ID_UNDELETE
259ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
d55e5bfc
RD		 260ID_HIGHEST = _core_.ID_HIGHEST
261OPEN = _core_.OPEN
262SAVE = _core_.SAVE
263HIDE_READONLY = _core_.HIDE_READONLY
264OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
265FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
266MULTIPLE = _core_.MULTIPLE
267CHANGE_DIR = _core_.CHANGE_DIR
268ACCEL_ALT = _core_.ACCEL_ALT
269ACCEL_CTRL = _core_.ACCEL_CTRL
270ACCEL_SHIFT = _core_.ACCEL_SHIFT
271ACCEL_NORMAL = _core_.ACCEL_NORMAL
272PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
273PD_APP_MODAL = _core_.PD_APP_MODAL
274PD_CAN_ABORT = _core_.PD_CAN_ABORT
275PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
276PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
277PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
62d32a5f
RD		 278PD_SMOOTH = _core_.PD_SMOOTH
279PD_CAN_SKIP = _core_.PD_CAN_SKIP
d55e5bfc
RD		 280DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
281DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
282MENU_TEAROFF = _core_.MENU_TEAROFF
283MB_DOCKABLE = _core_.MB_DOCKABLE
284NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
285FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
286LI_HORIZONTAL = _core_.LI_HORIZONTAL
287LI_VERTICAL = _core_.LI_VERTICAL
288WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
289WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
290WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
291WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
292WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
293WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
294MM_TEXT = _core_.MM_TEXT
295MM_LOMETRIC = _core_.MM_LOMETRIC
296MM_HIMETRIC = _core_.MM_HIMETRIC
297MM_LOENGLISH = _core_.MM_LOENGLISH
298MM_HIENGLISH = _core_.MM_HIENGLISH
299MM_TWIPS = _core_.MM_TWIPS
300MM_ISOTROPIC = _core_.MM_ISOTROPIC
301MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
302MM_POINTS = _core_.MM_POINTS
303MM_METRIC = _core_.MM_METRIC
304CENTRE = _core_.CENTRE
305CENTER = _core_.CENTER
306HORIZONTAL = _core_.HORIZONTAL
307VERTICAL = _core_.VERTICAL
308BOTH = _core_.BOTH
309LEFT = _core_.LEFT
310RIGHT = _core_.RIGHT
311UP = _core_.UP
312DOWN = _core_.DOWN
313TOP = _core_.TOP
314BOTTOM = _core_.BOTTOM
315NORTH = _core_.NORTH
316SOUTH = _core_.SOUTH
317WEST = _core_.WEST
318EAST = _core_.EAST
319ALL = _core_.ALL
320ALIGN_NOT = _core_.ALIGN_NOT
321ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
322ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
323ALIGN_LEFT = _core_.ALIGN_LEFT
324ALIGN_TOP = _core_.ALIGN_TOP
325ALIGN_RIGHT = _core_.ALIGN_RIGHT
326ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
327ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
328ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
329ALIGN_CENTER = _core_.ALIGN_CENTER
330ALIGN_CENTRE = _core_.ALIGN_CENTRE
331ALIGN_MASK = _core_.ALIGN_MASK
332STRETCH_NOT = _core_.STRETCH_NOT
333SHRINK = _core_.SHRINK
334GROW = _core_.GROW
335EXPAND = _core_.EXPAND
336SHAPED = _core_.SHAPED
337FIXED_MINSIZE = _core_.FIXED_MINSIZE
338TILE = _core_.TILE
339ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
340BORDER_DEFAULT = _core_.BORDER_DEFAULT
341BORDER_NONE = _core_.BORDER_NONE
342BORDER_STATIC = _core_.BORDER_STATIC
343BORDER_SIMPLE = _core_.BORDER_SIMPLE
344BORDER_RAISED = _core_.BORDER_RAISED
345BORDER_SUNKEN = _core_.BORDER_SUNKEN
346BORDER_DOUBLE = _core_.BORDER_DOUBLE
347BORDER_MASK = _core_.BORDER_MASK
0f63ec68
RD		 348BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
349BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
350BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD		 351DEFAULT = _core_.DEFAULT
352DECORATIVE = _core_.DECORATIVE
353ROMAN = _core_.ROMAN
354SCRIPT = _core_.SCRIPT
355SWISS = _core_.SWISS
356MODERN = _core_.MODERN
357TELETYPE = _core_.TELETYPE
358VARIABLE = _core_.VARIABLE
359FIXED = _core_.FIXED
360NORMAL = _core_.NORMAL
361LIGHT = _core_.LIGHT
362BOLD = _core_.BOLD
363ITALIC = _core_.ITALIC
364SLANT = _core_.SLANT
365SOLID = _core_.SOLID
366DOT = _core_.DOT
367LONG_DASH = _core_.LONG_DASH
368SHORT_DASH = _core_.SHORT_DASH
369DOT_DASH = _core_.DOT_DASH
370USER_DASH = _core_.USER_DASH
371TRANSPARENT = _core_.TRANSPARENT
372STIPPLE = _core_.STIPPLE
373BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
374CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
375FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
376CROSS_HATCH = _core_.CROSS_HATCH
377HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
378VERTICAL_HATCH = _core_.VERTICAL_HATCH
379JOIN_BEVEL = _core_.JOIN_BEVEL
380JOIN_MITER = _core_.JOIN_MITER
381JOIN_ROUND = _core_.JOIN_ROUND
382CAP_ROUND = _core_.CAP_ROUND
383CAP_PROJECTING = _core_.CAP_PROJECTING
384CAP_BUTT = _core_.CAP_BUTT
385CLEAR = _core_.CLEAR
386XOR = _core_.XOR
387INVERT = _core_.INVERT
388OR_REVERSE = _core_.OR_REVERSE
389AND_REVERSE = _core_.AND_REVERSE
390COPY = _core_.COPY
391AND = _core_.AND
392AND_INVERT = _core_.AND_INVERT
393NO_OP = _core_.NO_OP
394NOR = _core_.NOR
395EQUIV = _core_.EQUIV
396SRC_INVERT = _core_.SRC_INVERT
397OR_INVERT = _core_.OR_INVERT
398NAND = _core_.NAND
399OR = _core_.OR
400SET = _core_.SET
401WXK_BACK = _core_.WXK_BACK
402WXK_TAB = _core_.WXK_TAB
403WXK_RETURN = _core_.WXK_RETURN
404WXK_ESCAPE = _core_.WXK_ESCAPE
405WXK_SPACE = _core_.WXK_SPACE
406WXK_DELETE = _core_.WXK_DELETE
407WXK_START = _core_.WXK_START
408WXK_LBUTTON = _core_.WXK_LBUTTON
409WXK_RBUTTON = _core_.WXK_RBUTTON
410WXK_CANCEL = _core_.WXK_CANCEL
411WXK_MBUTTON = _core_.WXK_MBUTTON
412WXK_CLEAR = _core_.WXK_CLEAR
413WXK_SHIFT = _core_.WXK_SHIFT
414WXK_ALT = _core_.WXK_ALT
415WXK_CONTROL = _core_.WXK_CONTROL
416WXK_MENU = _core_.WXK_MENU
417WXK_PAUSE = _core_.WXK_PAUSE
418WXK_CAPITAL = _core_.WXK_CAPITAL
419WXK_PRIOR = _core_.WXK_PRIOR
420WXK_NEXT = _core_.WXK_NEXT
421WXK_END = _core_.WXK_END
422WXK_HOME = _core_.WXK_HOME
423WXK_LEFT = _core_.WXK_LEFT
424WXK_UP = _core_.WXK_UP
425WXK_RIGHT = _core_.WXK_RIGHT
426WXK_DOWN = _core_.WXK_DOWN
427WXK_SELECT = _core_.WXK_SELECT
428WXK_PRINT = _core_.WXK_PRINT
429WXK_EXECUTE = _core_.WXK_EXECUTE
430WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
431WXK_INSERT = _core_.WXK_INSERT
432WXK_HELP = _core_.WXK_HELP
433WXK_NUMPAD0 = _core_.WXK_NUMPAD0
434WXK_NUMPAD1 = _core_.WXK_NUMPAD1
435WXK_NUMPAD2 = _core_.WXK_NUMPAD2
436WXK_NUMPAD3 = _core_.WXK_NUMPAD3
437WXK_NUMPAD4 = _core_.WXK_NUMPAD4
438WXK_NUMPAD5 = _core_.WXK_NUMPAD5
439WXK_NUMPAD6 = _core_.WXK_NUMPAD6
440WXK_NUMPAD7 = _core_.WXK_NUMPAD7
441WXK_NUMPAD8 = _core_.WXK_NUMPAD8
442WXK_NUMPAD9 = _core_.WXK_NUMPAD9
443WXK_MULTIPLY = _core_.WXK_MULTIPLY
444WXK_ADD = _core_.WXK_ADD
445WXK_SEPARATOR = _core_.WXK_SEPARATOR
446WXK_SUBTRACT = _core_.WXK_SUBTRACT
447WXK_DECIMAL = _core_.WXK_DECIMAL
448WXK_DIVIDE = _core_.WXK_DIVIDE
449WXK_F1 = _core_.WXK_F1
450WXK_F2 = _core_.WXK_F2
451WXK_F3 = _core_.WXK_F3
452WXK_F4 = _core_.WXK_F4
453WXK_F5 = _core_.WXK_F5
454WXK_F6 = _core_.WXK_F6
455WXK_F7 = _core_.WXK_F7
456WXK_F8 = _core_.WXK_F8
457WXK_F9 = _core_.WXK_F9
458WXK_F10 = _core_.WXK_F10
459WXK_F11 = _core_.WXK_F11
460WXK_F12 = _core_.WXK_F12
461WXK_F13 = _core_.WXK_F13
462WXK_F14 = _core_.WXK_F14
463WXK_F15 = _core_.WXK_F15
464WXK_F16 = _core_.WXK_F16
465WXK_F17 = _core_.WXK_F17
466WXK_F18 = _core_.WXK_F18
467WXK_F19 = _core_.WXK_F19
468WXK_F20 = _core_.WXK_F20
469WXK_F21 = _core_.WXK_F21
470WXK_F22 = _core_.WXK_F22
471WXK_F23 = _core_.WXK_F23
472WXK_F24 = _core_.WXK_F24
473WXK_NUMLOCK = _core_.WXK_NUMLOCK
474WXK_SCROLL = _core_.WXK_SCROLL
475WXK_PAGEUP = _core_.WXK_PAGEUP
476WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
477WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
478WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
479WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
480WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
481WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
482WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
483WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
484WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
485WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
486WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
487WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
488WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
489WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
490WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
491WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
492WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
493WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
494WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
495WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
496WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
497WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
498WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
499WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
500WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
501WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
502WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
503WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
504WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
505WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
506WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
88c6b281
RD		 507WXK_COMMAND = _core_.WXK_COMMAND
508WXK_SPECIAL1 = _core_.WXK_SPECIAL1
509WXK_SPECIAL2 = _core_.WXK_SPECIAL2
510WXK_SPECIAL3 = _core_.WXK_SPECIAL3
511WXK_SPECIAL4 = _core_.WXK_SPECIAL4
512WXK_SPECIAL5 = _core_.WXK_SPECIAL5
513WXK_SPECIAL6 = _core_.WXK_SPECIAL6
514WXK_SPECIAL7 = _core_.WXK_SPECIAL7
515WXK_SPECIAL8 = _core_.WXK_SPECIAL8
516WXK_SPECIAL9 = _core_.WXK_SPECIAL9
517WXK_SPECIAL10 = _core_.WXK_SPECIAL10
518WXK_SPECIAL11 = _core_.WXK_SPECIAL11
519WXK_SPECIAL12 = _core_.WXK_SPECIAL12
520WXK_SPECIAL13 = _core_.WXK_SPECIAL13
521WXK_SPECIAL14 = _core_.WXK_SPECIAL14
522WXK_SPECIAL15 = _core_.WXK_SPECIAL15
523WXK_SPECIAL16 = _core_.WXK_SPECIAL16
524WXK_SPECIAL17 = _core_.WXK_SPECIAL17
525WXK_SPECIAL18 = _core_.WXK_SPECIAL18
526WXK_SPECIAL19 = _core_.WXK_SPECIAL19
527WXK_SPECIAL20 = _core_.WXK_SPECIAL20
d55e5bfc
RD		 528PAPER_NONE = _core_.PAPER_NONE
529PAPER_LETTER = _core_.PAPER_LETTER
530PAPER_LEGAL = _core_.PAPER_LEGAL
531PAPER_A4 = _core_.PAPER_A4
532PAPER_CSHEET = _core_.PAPER_CSHEET
533PAPER_DSHEET = _core_.PAPER_DSHEET
534PAPER_ESHEET = _core_.PAPER_ESHEET
535PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
536PAPER_TABLOID = _core_.PAPER_TABLOID
537PAPER_LEDGER = _core_.PAPER_LEDGER
538PAPER_STATEMENT = _core_.PAPER_STATEMENT
539PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
540PAPER_A3 = _core_.PAPER_A3
541PAPER_A4SMALL = _core_.PAPER_A4SMALL
542PAPER_A5 = _core_.PAPER_A5
543PAPER_B4 = _core_.PAPER_B4
544PAPER_B5 = _core_.PAPER_B5
545PAPER_FOLIO = _core_.PAPER_FOLIO
546PAPER_QUARTO = _core_.PAPER_QUARTO
547PAPER_10X14 = _core_.PAPER_10X14
548PAPER_11X17 = _core_.PAPER_11X17
549PAPER_NOTE = _core_.PAPER_NOTE
550PAPER_ENV_9 = _core_.PAPER_ENV_9
551PAPER_ENV_10 = _core_.PAPER_ENV_10
552PAPER_ENV_11 = _core_.PAPER_ENV_11
553PAPER_ENV_12 = _core_.PAPER_ENV_12
554PAPER_ENV_14 = _core_.PAPER_ENV_14
555PAPER_ENV_DL = _core_.PAPER_ENV_DL
556PAPER_ENV_C5 = _core_.PAPER_ENV_C5
557PAPER_ENV_C3 = _core_.PAPER_ENV_C3
558PAPER_ENV_C4 = _core_.PAPER_ENV_C4
559PAPER_ENV_C6 = _core_.PAPER_ENV_C6
560PAPER_ENV_C65 = _core_.PAPER_ENV_C65
561PAPER_ENV_B4 = _core_.PAPER_ENV_B4
562PAPER_ENV_B5 = _core_.PAPER_ENV_B5
563PAPER_ENV_B6 = _core_.PAPER_ENV_B6
564PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
565PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
566PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
567PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
568PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
569PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
570PAPER_ISO_B4 = _core_.PAPER_ISO_B4
571PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
572PAPER_9X11 = _core_.PAPER_9X11
573PAPER_10X11 = _core_.PAPER_10X11
574PAPER_15X11 = _core_.PAPER_15X11
575PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
576PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
577PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
578PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
579PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
580PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
581PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
582PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
583PAPER_A_PLUS = _core_.PAPER_A_PLUS
584PAPER_B_PLUS = _core_.PAPER_B_PLUS
585PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
586PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
587PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
588PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
589PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
590PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
591PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
592PAPER_A2 = _core_.PAPER_A2
593PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
594PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
595DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
596DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
597DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
598ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
599ITEM_NORMAL = _core_.ITEM_NORMAL
600ITEM_CHECK = _core_.ITEM_CHECK
601ITEM_RADIO = _core_.ITEM_RADIO
602ITEM_MAX = _core_.ITEM_MAX
603HT_NOWHERE = _core_.HT_NOWHERE
604HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
605HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
606HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
607HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
608HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
609HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
610HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
611HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
612HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
613HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
614HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
615HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
616HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
617HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
618HT_MAX = _core_.HT_MAX
619MOD_NONE = _core_.MOD_NONE
620MOD_ALT = _core_.MOD_ALT
621MOD_CONTROL = _core_.MOD_CONTROL
622MOD_SHIFT = _core_.MOD_SHIFT
623MOD_WIN = _core_.MOD_WIN
624UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
625UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
626UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
627#---------------------------------------------------------------------------
628
629class Object(object):
630 """
631 The base class for most wx objects, although in wxPython not
632 much functionality is needed nor exposed.
633 """
634 def __init__(self): raise RuntimeError, "No constructor defined"
635 def __repr__(self):
636 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
637 def GetClassName(*args, **kwargs):
638 """
639 GetClassName(self) -> String
640
641 Returns the class name of the C++ class using wxRTTI.
642 """
643 return _core_.Object_GetClassName(*args, **kwargs)
644
645 def Destroy(*args, **kwargs):
646 """
647 Destroy(self)
648
649 Deletes the C++ object this Python object is a proxy for.
650 """
651 return _core_.Object_Destroy(*args, **kwargs)
652
653
654class ObjectPtr(Object):
655 def __init__(self, this):
656 self.this = this
657 if not hasattr(self,"thisown"): self.thisown = 0
658 self.__class__ = Object
659_core_.Object_swigregister(ObjectPtr)
660_wxPySetDictionary = _core_._wxPySetDictionary
661
662_wxPyFixStockObjects = _core_._wxPyFixStockObjects
663
664cvar = _core_.cvar
665EmptyString = cvar.EmptyString
666
667#---------------------------------------------------------------------------
668
669BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
670BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
671BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
672BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
673BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
674BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
675BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
676BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
677BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
678BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
679BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
680BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
681BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
682BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
683BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
684BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
685BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
686BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
687BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
688BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
689CURSOR_NONE = _core_.CURSOR_NONE
690CURSOR_ARROW = _core_.CURSOR_ARROW
691CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
692CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
693CURSOR_CHAR = _core_.CURSOR_CHAR
694CURSOR_CROSS = _core_.CURSOR_CROSS
695CURSOR_HAND = _core_.CURSOR_HAND
696CURSOR_IBEAM = _core_.CURSOR_IBEAM
697CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
698CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
699CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
700CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
701CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
702CURSOR_PENCIL = _core_.CURSOR_PENCIL
703CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
704CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
705CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
706CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
707CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
708CURSOR_SIZENS = _core_.CURSOR_SIZENS
709CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
710CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
711CURSOR_SIZING = _core_.CURSOR_SIZING
712CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
713CURSOR_WAIT = _core_.CURSOR_WAIT
714CURSOR_WATCH = _core_.CURSOR_WATCH
715CURSOR_BLANK = _core_.CURSOR_BLANK
716CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
717CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
718CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
719CURSOR_MAX = _core_.CURSOR_MAX
720#---------------------------------------------------------------------------
721
722class Size(object):
723 """
79fccf9d 724 wx.Size is a useful data structure used to represent the size of
093d3ff1
RD		 725 something. It simply contians integer width and height
726 proprtites. In most places in wxPython where a wx.Size is
727 expected a (width, height) tuple can be used instead.
d55e5bfc
RD		 728 """
729 def __repr__(self):
730 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
731 width = property(_core_.Size_width_get, _core_.Size_width_set)
732 height = property(_core_.Size_height_get, _core_.Size_height_set)
733 x = width; y = height
734 def __init__(self, *args, **kwargs):
735 """
736 __init__(self, int w=0, int h=0) -> Size
737
738 Creates a size object.
739 """
740 newobj = _core_.new_Size(*args, **kwargs)
741 self.this = newobj.this
742 self.thisown = 1
743 del newobj.thisown
744 def __del__(self, destroy=_core_.delete_Size):
745 """__del__(self)"""
746 try:
747 if self.thisown: destroy(self)
748 except: pass
749
750 def __eq__(*args, **kwargs):
751 """
752 __eq__(self, Size sz) -> bool
753
754 Test for equality of wx.Size objects.
755 """
756 return _core_.Size___eq__(*args, **kwargs)
757
758 def __ne__(*args, **kwargs):
759 """
760 __ne__(self, Size sz) -> bool
761
762 Test for inequality.
763 """
764 return _core_.Size___ne__(*args, **kwargs)
765
766 def __add__(*args, **kwargs):
767 """
768 __add__(self, Size sz) -> Size
769
770 Add sz's proprties to this and return the result.
771 """
772 return _core_.Size___add__(*args, **kwargs)
773
774 def __sub__(*args, **kwargs):
775 """
776 __sub__(self, Size sz) -> Size
777
778 Subtract sz's properties from this and return the result.
779 """
780 return _core_.Size___sub__(*args, **kwargs)
781
782 def IncTo(*args, **kwargs):
783 """
784 IncTo(self, Size sz)
785
786 Increments this object so that both of its dimensions are not less
787 than the corresponding dimensions of the size.
788 """
789 return _core_.Size_IncTo(*args, **kwargs)
790
791 def DecTo(*args, **kwargs):
792 """
793 DecTo(self, Size sz)
794
795 Decrements this object so that both of its dimensions are not greater
796 than the corresponding dimensions of the size.
797 """
798 return _core_.Size_DecTo(*args, **kwargs)
799
800 def Set(*args, **kwargs):
801 """
802 Set(self, int w, int h)
803
804 Set both width and height.
805 """
806 return _core_.Size_Set(*args, **kwargs)
807
808 def SetWidth(*args, **kwargs):
809 """SetWidth(self, int w)"""
810 return _core_.Size_SetWidth(*args, **kwargs)
811
812 def SetHeight(*args, **kwargs):
813 """SetHeight(self, int h)"""
814 return _core_.Size_SetHeight(*args, **kwargs)
815
816 def GetWidth(*args, **kwargs):
817 """GetWidth(self) -> int"""
818 return _core_.Size_GetWidth(*args, **kwargs)
819
820 def GetHeight(*args, **kwargs):
821 """GetHeight(self) -> int"""
822 return _core_.Size_GetHeight(*args, **kwargs)
823
824 def IsFullySpecified(*args, **kwargs):
825 """
826 IsFullySpecified(self) -> bool
827
828 Returns True if both components of the size are non-default values.
829 """
830 return _core_.Size_IsFullySpecified(*args, **kwargs)
831
832 def SetDefaults(*args, **kwargs):
833 """
834 SetDefaults(self, Size size)
835
79fccf9d
RD		 836 Combine this size with the other one replacing the default components
837 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD		 838 """
839 return _core_.Size_SetDefaults(*args, **kwargs)
840
841 def Get(*args, **kwargs):
842 """
843 Get() -> (width,height)
844
845 Returns the width and height properties as a tuple.
846 """
847 return _core_.Size_Get(*args, **kwargs)
848
79fccf9d 849 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 850 def __str__(self): return str(self.Get())
851 def __repr__(self): return 'wx.Size'+str(self.Get())
852 def __len__(self): return len(self.Get())
853 def __getitem__(self, index): return self.Get()[index]
854 def __setitem__(self, index, val):
855 if index == 0: self.width = val
856 elif index == 1: self.height = val
857 else: raise IndexError
858 def __nonzero__(self): return self.Get() != (0,0)
859 __safe_for_unpickling__ = True
860 def __reduce__(self): return (wx.Size, self.Get())
861
862
863class SizePtr(Size):
864 def __init__(self, this):
865 self.this = this
866 if not hasattr(self,"thisown"): self.thisown = 0
867 self.__class__ = Size
868_core_.Size_swigregister(SizePtr)
869
870#---------------------------------------------------------------------------
871
872class RealPoint(object):
873 """
79fccf9d
RD		 874 A data structure for representing a point or position with floating
875 point x and y properties. In wxPython most places that expect a
876 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc
RD		 877 """
878 def __repr__(self):
879 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
880 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
881 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
882 def __init__(self, *args, **kwargs):
883 """
884 __init__(self, double x=0.0, double y=0.0) -> RealPoint
885
886 Create a wx.RealPoint object
887 """
888 newobj = _core_.new_RealPoint(*args, **kwargs)
889 self.this = newobj.this
890 self.thisown = 1
891 del newobj.thisown
892 def __del__(self, destroy=_core_.delete_RealPoint):
893 """__del__(self)"""
894 try:
895 if self.thisown: destroy(self)
896 except: pass
897
898 def __eq__(*args, **kwargs):
899 """
900 __eq__(self, RealPoint pt) -> bool
901
902 Test for equality of wx.RealPoint objects.
903 """
904 return _core_.RealPoint___eq__(*args, **kwargs)
905
906 def __ne__(*args, **kwargs):
907 """
908 __ne__(self, RealPoint pt) -> bool
909
910 Test for inequality of wx.RealPoint objects.
911 """
912 return _core_.RealPoint___ne__(*args, **kwargs)
913
914 def __add__(*args, **kwargs):
915 """
916 __add__(self, RealPoint pt) -> RealPoint
917
918 Add pt's proprties to this and return the result.
919 """
920 return _core_.RealPoint___add__(*args, **kwargs)
921
922 def __sub__(*args, **kwargs):
923 """
924 __sub__(self, RealPoint pt) -> RealPoint
925
926 Subtract pt's proprties from this and return the result
927 """
928 return _core_.RealPoint___sub__(*args, **kwargs)
929
930 def Set(*args, **kwargs):
931 """
932 Set(self, double x, double y)
933
934 Set both the x and y properties
935 """
936 return _core_.RealPoint_Set(*args, **kwargs)
937
938 def Get(*args, **kwargs):
939 """
940 Get() -> (x,y)
941
942 Return the x and y properties as a tuple.
943 """
944 return _core_.RealPoint_Get(*args, **kwargs)
945
79fccf9d 946 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 947 def __str__(self): return str(self.Get())
948 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
949 def __len__(self): return len(self.Get())
950 def __getitem__(self, index): return self.Get()[index]
951 def __setitem__(self, index, val):
952 if index == 0: self.x = val
953 elif index == 1: self.y = val
954 else: raise IndexError
955 def __nonzero__(self): return self.Get() != (0.0, 0.0)
956 __safe_for_unpickling__ = True
957 def __reduce__(self): return (wx.RealPoint, self.Get())
958
959
960class RealPointPtr(RealPoint):
961 def __init__(self, this):
962 self.this = this
963 if not hasattr(self,"thisown"): self.thisown = 0
964 self.__class__ = RealPoint
965_core_.RealPoint_swigregister(RealPointPtr)
966
967#---------------------------------------------------------------------------
968
969class Point(object):
970 """
79fccf9d
RD		 971 A data structure for representing a point or position with integer x
972 and y properties. Most places in wxPython that expect a wx.Point can
973 also accept a (x,y) tuple.
d55e5bfc
RD		 974 """
975 def __repr__(self):
976 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
977 x = property(_core_.Point_x_get, _core_.Point_x_set)
978 y = property(_core_.Point_y_get, _core_.Point_y_set)
979 def __init__(self, *args, **kwargs):
980 """
981 __init__(self, int x=0, int y=0) -> Point
982
983 Create a wx.Point object
984 """
985 newobj = _core_.new_Point(*args, **kwargs)
986 self.this = newobj.this
987 self.thisown = 1
988 del newobj.thisown
989 def __del__(self, destroy=_core_.delete_Point):
990 """__del__(self)"""
991 try:
992 if self.thisown: destroy(self)
993 except: pass
994
995 def __eq__(*args, **kwargs):
996 """
997 __eq__(self, Point pt) -> bool
998
999 Test for equality of wx.Point objects.
1000 """
1001 return _core_.Point___eq__(*args, **kwargs)
1002
1003 def __ne__(*args, **kwargs):
1004 """
1005 __ne__(self, Point pt) -> bool
1006
1007 Test for inequality of wx.Point objects.
1008 """
1009 return _core_.Point___ne__(*args, **kwargs)
1010
1011 def __add__(*args, **kwargs):
1012 """
1013 __add__(self, Point pt) -> Point
1014
1015 Add pt's proprties to this and return the result.
1016 """
1017 return _core_.Point___add__(*args, **kwargs)
1018
1019 def __sub__(*args, **kwargs):
1020 """
1021 __sub__(self, Point pt) -> Point
1022
1023 Subtract pt's proprties from this and return the result
1024 """
1025 return _core_.Point___sub__(*args, **kwargs)
1026
1027 def __iadd__(*args, **kwargs):
1028 """
1029 __iadd__(self, Point pt) -> Point
1030
1031 Add pt to this object.
1032 """
1033 return _core_.Point___iadd__(*args, **kwargs)
1034
1035 def __isub__(*args, **kwargs):
1036 """
1037 __isub__(self, Point pt) -> Point
1038
1039 Subtract pt from this object.
1040 """
1041 return _core_.Point___isub__(*args, **kwargs)
1042
1043 def Set(*args, **kwargs):
1044 """
1045 Set(self, long x, long y)
1046
1047 Set both the x and y properties
1048 """
1049 return _core_.Point_Set(*args, **kwargs)
1050
1051 def Get(*args, **kwargs):
1052 """
1053 Get() -> (x,y)
1054
1055 Return the x and y properties as a tuple.
1056 """
1057 return _core_.Point_Get(*args, **kwargs)
1058
79fccf9d 1059 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1060 def __str__(self): return str(self.Get())
1061 def __repr__(self): return 'wx.Point'+str(self.Get())
1062 def __len__(self): return len(self.Get())
1063 def __getitem__(self, index): return self.Get()[index]
1064 def __setitem__(self, index, val):
1065 if index == 0: self.x = val
1066 elif index == 1: self.y = val
1067 else: raise IndexError
1068 def __nonzero__(self): return self.Get() != (0,0)
1069 __safe_for_unpickling__ = True
1070 def __reduce__(self): return (wx.Point, self.Get())
1071
1072
1073class PointPtr(Point):
1074 def __init__(self, this):
1075 self.this = this
1076 if not hasattr(self,"thisown"): self.thisown = 0
1077 self.__class__ = Point
1078_core_.Point_swigregister(PointPtr)
1079
1080#---------------------------------------------------------------------------
1081
1082class Rect(object):
1083 """
79fccf9d
RD		 1084 A class for representing and manipulating rectangles. It has x, y,
1085 width and height properties. In wxPython most palces that expect a
1086 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc
RD		 1087 """
1088 def __repr__(self):
1089 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1090 def __init__(self, *args, **kwargs):
1091 """
1092 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1093
1094 Create a new Rect object.
1095 """
1096 newobj = _core_.new_Rect(*args, **kwargs)
1097 self.this = newobj.this
1098 self.thisown = 1
1099 del newobj.thisown
1100 def __del__(self, destroy=_core_.delete_Rect):
1101 """__del__(self)"""
1102 try:
1103 if self.thisown: destroy(self)
1104 except: pass
1105
1106 def GetX(*args, **kwargs):
1107 """GetX(self) -> int"""
1108 return _core_.Rect_GetX(*args, **kwargs)
1109
1110 def SetX(*args, **kwargs):
1111 """SetX(self, int x)"""
1112 return _core_.Rect_SetX(*args, **kwargs)
1113
1114 def GetY(*args, **kwargs):
1115 """GetY(self) -> int"""
1116 return _core_.Rect_GetY(*args, **kwargs)
1117
1118 def SetY(*args, **kwargs):
1119 """SetY(self, int y)"""
1120 return _core_.Rect_SetY(*args, **kwargs)
1121
1122 def GetWidth(*args, **kwargs):
1123 """GetWidth(self) -> int"""
1124 return _core_.Rect_GetWidth(*args, **kwargs)
1125
1126 def SetWidth(*args, **kwargs):
1127 """SetWidth(self, int w)"""
1128 return _core_.Rect_SetWidth(*args, **kwargs)
1129
1130 def GetHeight(*args, **kwargs):
1131 """GetHeight(self) -> int"""
1132 return _core_.Rect_GetHeight(*args, **kwargs)
1133
1134 def SetHeight(*args, **kwargs):
1135 """SetHeight(self, int h)"""
1136 return _core_.Rect_SetHeight(*args, **kwargs)
1137
1138 def GetPosition(*args, **kwargs):
1139 """GetPosition(self) -> Point"""
1140 return _core_.Rect_GetPosition(*args, **kwargs)
1141
1142 def SetPosition(*args, **kwargs):
1143 """SetPosition(self, Point p)"""
1144 return _core_.Rect_SetPosition(*args, **kwargs)
1145
1146 def GetSize(*args, **kwargs):
1147 """GetSize(self) -> Size"""
1148 return _core_.Rect_GetSize(*args, **kwargs)
1149
1150 def SetSize(*args, **kwargs):
1151 """SetSize(self, Size s)"""
1152 return _core_.Rect_SetSize(*args, **kwargs)
1153
aff4cc5c
RD		 1154 def IsEmpty(*args, **kwargs):
1155 """IsEmpty(self) -> bool"""
1156 return _core_.Rect_IsEmpty(*args, **kwargs)
1157
d55e5bfc
RD		 1158 def GetTopLeft(*args, **kwargs):
1159 """GetTopLeft(self) -> Point"""
1160 return _core_.Rect_GetTopLeft(*args, **kwargs)
1161
1162 def SetTopLeft(*args, **kwargs):
1163 """SetTopLeft(self, Point p)"""
1164 return _core_.Rect_SetTopLeft(*args, **kwargs)
1165
1166 def GetBottomRight(*args, **kwargs):
1167 """GetBottomRight(self) -> Point"""
1168 return _core_.Rect_GetBottomRight(*args, **kwargs)
1169
1170 def SetBottomRight(*args, **kwargs):
1171 """SetBottomRight(self, Point p)"""
1172 return _core_.Rect_SetBottomRight(*args, **kwargs)
1173
1174 def GetLeft(*args, **kwargs):
1175 """GetLeft(self) -> int"""
1176 return _core_.Rect_GetLeft(*args, **kwargs)
1177
1178 def GetTop(*args, **kwargs):
1179 """GetTop(self) -> int"""
1180 return _core_.Rect_GetTop(*args, **kwargs)
1181
1182 def GetBottom(*args, **kwargs):
1183 """GetBottom(self) -> int"""
1184 return _core_.Rect_GetBottom(*args, **kwargs)
1185
1186 def GetRight(*args, **kwargs):
1187 """GetRight(self) -> int"""
1188 return _core_.Rect_GetRight(*args, **kwargs)
1189
1190 def SetLeft(*args, **kwargs):
1191 """SetLeft(self, int left)"""
1192 return _core_.Rect_SetLeft(*args, **kwargs)
1193
1194 def SetRight(*args, **kwargs):
1195 """SetRight(self, int right)"""
1196 return _core_.Rect_SetRight(*args, **kwargs)
1197
1198 def SetTop(*args, **kwargs):
1199 """SetTop(self, int top)"""
1200 return _core_.Rect_SetTop(*args, **kwargs)
1201
1202 def SetBottom(*args, **kwargs):
1203 """SetBottom(self, int bottom)"""
1204 return _core_.Rect_SetBottom(*args, **kwargs)
1205
1206 position = property(GetPosition, SetPosition)
1207 size = property(GetSize, SetSize)
1208 left = property(GetLeft, SetLeft)
1209 right = property(GetRight, SetRight)
1210 top = property(GetTop, SetTop)
1211 bottom = property(GetBottom, SetBottom)
1212
1213 def Inflate(*args, **kwargs):
1214 """
1215 Inflate(self, int dx, int dy) -> Rect
1216
091fdbfa
RD		 1217 Increases the size of the rectangle.
1218
1219 The left border is moved farther left and the right border is moved
1220 farther right by ``dx``. The upper border is moved farther up and the
1221 bottom border is moved farther down by ``dy``. (Note the the width and
1222 height of the rectangle thus change by ``2*dx`` and ``2*dy``,
1223 respectively.) If one or both of ``dx`` and ``dy`` are negative, the
1224 opposite happens: the rectangle size decreases in the respective
1225 direction.
1226
1227 The change is made to the rectangle inplace, if instead you need a
1228 copy that is inflated, preserving the original then make the copy
1229 first::
1230
1231 copy = wx.Rect(*original)
1232 copy.Inflate(10,15)
1233
1234
d55e5bfc
RD		 1235 """
1236 return _core_.Rect_Inflate(*args, **kwargs)
1237
1238 def Deflate(*args, **kwargs):
1239 """
1240 Deflate(self, int dx, int dy) -> Rect
1241
091fdbfa
RD		 1242 Decrease the rectangle size. This method is the opposite of `Inflate`
1243 in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
1244 `Inflate` for a full description.
d55e5bfc
RD		 1245 """
1246 return _core_.Rect_Deflate(*args, **kwargs)
1247
1248 def OffsetXY(*args, **kwargs):
1249 """
1250 OffsetXY(self, int dx, int dy)
1251
79fccf9d
RD		 1252 Moves the rectangle by the specified offset. If dx is positive, the
1253 rectangle is moved to the right, if dy is positive, it is moved to the
1254 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD		 1255 """
1256 return _core_.Rect_OffsetXY(*args, **kwargs)
1257
1258 def Offset(*args, **kwargs):
1259 """
1260 Offset(self, Point pt)
1261
1262 Same as OffsetXY but uses dx,dy from Point
1263 """
1264 return _core_.Rect_Offset(*args, **kwargs)
1265
1266 def Intersect(*args, **kwargs):
1267 """
1268 Intersect(self, Rect rect) -> Rect
1269
b519803b 1270 Returns the intersectsion of this rectangle and rect.
d55e5bfc
RD		 1271 """
1272 return _core_.Rect_Intersect(*args, **kwargs)
1273
b519803b
RD		 1274 def Union(*args, **kwargs):
1275 """
1276 Union(self, Rect rect) -> Rect
1277
1278 Returns the union of this rectangle and rect.
1279 """
1280 return _core_.Rect_Union(*args, **kwargs)
1281
d55e5bfc
RD		 1282 def __add__(*args, **kwargs):
1283 """
1284 __add__(self, Rect rect) -> Rect
1285
1286 Add the properties of rect to this rectangle and return the result.
1287 """
1288 return _core_.Rect___add__(*args, **kwargs)
1289
1290 def __iadd__(*args, **kwargs):
1291 """
1292 __iadd__(self, Rect rect) -> Rect
1293
1294 Add the properties of rect to this rectangle, updating this rectangle.
1295 """
1296 return _core_.Rect___iadd__(*args, **kwargs)
1297
1298 def __eq__(*args, **kwargs):
1299 """
1300 __eq__(self, Rect rect) -> bool
1301
1302 Test for equality.
1303 """
1304 return _core_.Rect___eq__(*args, **kwargs)
1305
1306 def __ne__(*args, **kwargs):
1307 """
1308 __ne__(self, Rect rect) -> bool
1309
1310 Test for inequality.
1311 """
1312 return _core_.Rect___ne__(*args, **kwargs)
1313
1314 def InsideXY(*args, **kwargs):
1315 """
1316 InsideXY(self, int x, int y) -> bool
1317
1318 Return True if the point is (not strcitly) inside the rect.
1319 """
1320 return _core_.Rect_InsideXY(*args, **kwargs)
1321
1322 def Inside(*args, **kwargs):
1323 """
1324 Inside(self, Point pt) -> bool
1325
1326 Return True if the point is (not strcitly) inside the rect.
1327 """
1328 return _core_.Rect_Inside(*args, **kwargs)
1329
1330 def Intersects(*args, **kwargs):
1331 """
1332 Intersects(self, Rect rect) -> bool
1333
1334 Returns True if the rectangles have a non empty intersection.
1335 """
1336 return _core_.Rect_Intersects(*args, **kwargs)
1337
1338 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1339 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1340 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1341 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1342 def Set(*args, **kwargs):
1343 """
1344 Set(self, int x=0, int y=0, int width=0, int height=0)
1345
1346 Set all rectangle properties.
1347 """
1348 return _core_.Rect_Set(*args, **kwargs)
1349
1350 def Get(*args, **kwargs):
1351 """
1352 Get() -> (x,y,width,height)
1353
1354 Return the rectangle properties as a tuple.
1355 """
1356 return _core_.Rect_Get(*args, **kwargs)
1357
79fccf9d 1358 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1359 def __str__(self): return str(self.Get())
1360 def __repr__(self): return 'wx.Rect'+str(self.Get())
1361 def __len__(self): return len(self.Get())
1362 def __getitem__(self, index): return self.Get()[index]
1363 def __setitem__(self, index, val):
1364 if index == 0: self.x = val
1365 elif index == 1: self.y = val
1366 elif index == 2: self.width = val
1367 elif index == 3: self.height = val
1368 else: raise IndexError
1369 def __nonzero__(self): return self.Get() != (0,0,0,0)
1370 __safe_for_unpickling__ = True
1371 def __reduce__(self): return (wx.Rect, self.Get())
1372
1373
1374class RectPtr(Rect):
1375 def __init__(self, this):
1376 self.this = this
1377 if not hasattr(self,"thisown"): self.thisown = 0
1378 self.__class__ = Rect
1379_core_.Rect_swigregister(RectPtr)
1380
1381def RectPP(*args, **kwargs):
1382 """
1383 RectPP(Point topLeft, Point bottomRight) -> Rect
1384
1385 Create a new Rect object from Points representing two corners.
1386 """
1387 val = _core_.new_RectPP(*args, **kwargs)
1388 val.thisown = 1
1389 return val
1390
1391def RectPS(*args, **kwargs):
1392 """
1393 RectPS(Point pos, Size size) -> Rect
1394
1395 Create a new Rect from a position and size.
1396 """
1397 val = _core_.new_RectPS(*args, **kwargs)
1398 val.thisown = 1
1399 return val
1400
c1cb24a4
RD		 1401def RectS(*args, **kwargs):
1402 """
1403 RectS(Size size) -> Rect
1404
1405 Create a new Rect from a size only.
1406 """
1407 val = _core_.new_RectS(*args, **kwargs)
1408 val.thisown = 1
1409 return val
1410
d55e5bfc
RD		 1411
1412def IntersectRect(*args, **kwargs):
1413 """
1414 IntersectRect(Rect r1, Rect r2) -> Rect
1415
1416 Calculate and return the intersection of r1 and r2.
1417 """
1418 return _core_.IntersectRect(*args, **kwargs)
1419#---------------------------------------------------------------------------
1420
1421class Point2D(object):
79fccf9d
RD		 1422 """
1423 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1424 with floating point values.
1425 """
d55e5bfc
RD		 1426 def __repr__(self):
1427 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1428 def __init__(self, *args, **kwargs):
1429 """
1430 __init__(self, double x=0.0, double y=0.0) -> Point2D
1431
1432 Create a w.Point2D object.
1433 """
1434 newobj = _core_.new_Point2D(*args, **kwargs)
1435 self.this = newobj.this
1436 self.thisown = 1
1437 del newobj.thisown
1438 def GetFloor(*args, **kwargs):
a8eff060
RD		 1439 """
1440 GetFloor() -> (x,y)
1441
1442 Convert to integer
1443 """
d55e5bfc
RD		 1444 return _core_.Point2D_GetFloor(*args, **kwargs)
1445
1446 def GetRounded(*args, **kwargs):
a8eff060
RD		 1447 """
1448 GetRounded() -> (x,y)
1449
1450 Convert to integer
1451 """
d55e5bfc
RD		 1452 return _core_.Point2D_GetRounded(*args, **kwargs)
1453
1454 def GetVectorLength(*args, **kwargs):
1455 """GetVectorLength(self) -> double"""
1456 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1457
1458 def GetVectorAngle(*args, **kwargs):
1459 """GetVectorAngle(self) -> double"""
1460 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1461
1462 def SetVectorLength(*args, **kwargs):
1463 """SetVectorLength(self, double length)"""
1464 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1465
1466 def SetVectorAngle(*args, **kwargs):
1467 """SetVectorAngle(self, double degrees)"""
1468 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1469
1470 def SetPolarCoordinates(self, angle, length):
1471 self.SetVectorLength(length)
1472 self.SetVectorAngle(angle)
1473 def Normalize(self):
1474 self.SetVectorLength(1.0)
1475
1476 def GetDistance(*args, **kwargs):
1477 """GetDistance(self, Point2D pt) -> double"""
1478 return _core_.Point2D_GetDistance(*args, **kwargs)
1479
1480 def GetDistanceSquare(*args, **kwargs):
1481 """GetDistanceSquare(self, Point2D pt) -> double"""
1482 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1483
1484 def GetDotProduct(*args, **kwargs):
1485 """GetDotProduct(self, Point2D vec) -> double"""
1486 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1487
1488 def GetCrossProduct(*args, **kwargs):
1489 """GetCrossProduct(self, Point2D vec) -> double"""
1490 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1491
1492 def __neg__(*args, **kwargs):
1493 """
1494 __neg__(self) -> Point2D
1495
1496 the reflection of this point
1497 """
1498 return _core_.Point2D___neg__(*args, **kwargs)
1499
1500 def __iadd__(*args, **kwargs):
1501 """__iadd__(self, Point2D pt) -> Point2D"""
1502 return _core_.Point2D___iadd__(*args, **kwargs)
1503
1504 def __isub__(*args, **kwargs):
1505 """__isub__(self, Point2D pt) -> Point2D"""
1506 return _core_.Point2D___isub__(*args, **kwargs)
1507
1508 def __imul__(*args, **kwargs):
1509 """__imul__(self, Point2D pt) -> Point2D"""
1510 return _core_.Point2D___imul__(*args, **kwargs)
1511
1512 def __idiv__(*args, **kwargs):
1513 """__idiv__(self, Point2D pt) -> Point2D"""
1514 return _core_.Point2D___idiv__(*args, **kwargs)
1515
1516 def __eq__(*args, **kwargs):
1517 """
1518 __eq__(self, Point2D pt) -> bool
1519
1520 Test for equality
1521 """
1522 return _core_.Point2D___eq__(*args, **kwargs)
1523
1524 def __ne__(*args, **kwargs):
1525 """
1526 __ne__(self, Point2D pt) -> bool
1527
1528 Test for inequality
1529 """
1530 return _core_.Point2D___ne__(*args, **kwargs)
1531
1532 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1533 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1534 def Set(*args, **kwargs):
1535 """Set(self, double x=0, double y=0)"""
1536 return _core_.Point2D_Set(*args, **kwargs)
1537
1538 def Get(*args, **kwargs):
1539 """
1540 Get() -> (x,y)
1541
1542 Return x and y properties as a tuple.
1543 """
1544 return _core_.Point2D_Get(*args, **kwargs)
1545
79fccf9d 1546 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 1547 def __str__(self): return str(self.Get())
1548 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1549 def __len__(self): return len(self.Get())
1550 def __getitem__(self, index): return self.Get()[index]
1551 def __setitem__(self, index, val):
1552 if index == 0: self.x = val
1553 elif index == 1: self.y = val
1554 else: raise IndexError
1555 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1556 __safe_for_unpickling__ = True
1557 def __reduce__(self): return (wx.Point2D, self.Get())
1558
1559
1560class Point2DPtr(Point2D):
1561 def __init__(self, this):
1562 self.this = this
1563 if not hasattr(self,"thisown"): self.thisown = 0
1564 self.__class__ = Point2D
1565_core_.Point2D_swigregister(Point2DPtr)
1566
1567def Point2DCopy(*args, **kwargs):
1568 """
1569 Point2DCopy(Point2D pt) -> Point2D
1570
1571 Create a w.Point2D object.
1572 """
1573 val = _core_.new_Point2DCopy(*args, **kwargs)
1574 val.thisown = 1
1575 return val
1576
1577def Point2DFromPoint(*args, **kwargs):
1578 """
1579 Point2DFromPoint(Point pt) -> Point2D
1580
1581 Create a w.Point2D object.
1582 """
1583 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1584 val.thisown = 1
1585 return val
1586
1587#---------------------------------------------------------------------------
1588
1589FromStart = _core_.FromStart
1590FromCurrent = _core_.FromCurrent
1591FromEnd = _core_.FromEnd
1592class InputStream(object):
093d3ff1 1593 """Proxy of C++ InputStream class"""
d55e5bfc
RD		 1594 def __repr__(self):
1595 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1596 def __init__(self, *args, **kwargs):
1597 """__init__(self, PyObject p) -> InputStream"""
1598 newobj = _core_.new_InputStream(*args, **kwargs)
1599 self.this = newobj.this
1600 self.thisown = 1
1601 del newobj.thisown
8fb0e70a
RD		 1602 def __del__(self, destroy=_core_.delete_InputStream):
1603 """__del__(self)"""
1604 try:
1605 if self.thisown: destroy(self)
1606 except: pass
1607
d55e5bfc
RD		 1608 def close(*args, **kwargs):
1609 """close(self)"""
1610 return _core_.InputStream_close(*args, **kwargs)
1611
1612 def flush(*args, **kwargs):
1613 """flush(self)"""
1614 return _core_.InputStream_flush(*args, **kwargs)
1615
1616 def eof(*args, **kwargs):
1617 """eof(self) -> bool"""
1618 return _core_.InputStream_eof(*args, **kwargs)
1619
1620 def read(*args, **kwargs):
1621 """read(self, int size=-1) -> PyObject"""
1622 return _core_.InputStream_read(*args, **kwargs)
1623
1624 def readline(*args, **kwargs):
1625 """readline(self, int size=-1) -> PyObject"""
1626 return _core_.InputStream_readline(*args, **kwargs)
1627
1628 def readlines(*args, **kwargs):
1629 """readlines(self, int sizehint=-1) -> PyObject"""
1630 return _core_.InputStream_readlines(*args, **kwargs)
1631
1632 def seek(*args, **kwargs):
1633 """seek(self, int offset, int whence=0)"""
1634 return _core_.InputStream_seek(*args, **kwargs)
1635
1636 def tell(*args, **kwargs):
1637 """tell(self) -> int"""
1638 return _core_.InputStream_tell(*args, **kwargs)
1639
1640 def Peek(*args, **kwargs):
1641 """Peek(self) -> char"""
1642 return _core_.InputStream_Peek(*args, **kwargs)
1643
1644 def GetC(*args, **kwargs):
1645 """GetC(self) -> char"""
1646 return _core_.InputStream_GetC(*args, **kwargs)
1647
1648 def LastRead(*args, **kwargs):
1649 """LastRead(self) -> size_t"""
1650 return _core_.InputStream_LastRead(*args, **kwargs)
1651
1652 def CanRead(*args, **kwargs):
1653 """CanRead(self) -> bool"""
1654 return _core_.InputStream_CanRead(*args, **kwargs)
1655
1656 def Eof(*args, **kwargs):
1657 """Eof(self) -> bool"""
1658 return _core_.InputStream_Eof(*args, **kwargs)
1659
1660 def Ungetch(*args, **kwargs):
1661 """Ungetch(self, char c) -> bool"""
1662 return _core_.InputStream_Ungetch(*args, **kwargs)
1663
1664 def SeekI(*args, **kwargs):
1665 """SeekI(self, long pos, int mode=FromStart) -> long"""
1666 return _core_.InputStream_SeekI(*args, **kwargs)
1667
1668 def TellI(*args, **kwargs):
1669 """TellI(self) -> long"""
1670 return _core_.InputStream_TellI(*args, **kwargs)
1671
1672
1673class InputStreamPtr(InputStream):
1674 def __init__(self, this):
1675 self.this = this
1676 if not hasattr(self,"thisown"): self.thisown = 0
1677 self.__class__ = InputStream
1678_core_.InputStream_swigregister(InputStreamPtr)
1679DefaultPosition = cvar.DefaultPosition
1680DefaultSize = cvar.DefaultSize
1681
1682class OutputStream(object):
093d3ff1 1683 """Proxy of C++ OutputStream class"""
d55e5bfc
RD		 1684 def __init__(self): raise RuntimeError, "No constructor defined"
1685 def __repr__(self):
1686 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1687 def write(*args, **kwargs):
1688 """write(self, PyObject obj)"""
1689 return _core_.OutputStream_write(*args, **kwargs)
1690
1691
1692class OutputStreamPtr(OutputStream):
1693 def __init__(self, this):
1694 self.this = this
1695 if not hasattr(self,"thisown"): self.thisown = 0
1696 self.__class__ = OutputStream
1697_core_.OutputStream_swigregister(OutputStreamPtr)
1698
1699#---------------------------------------------------------------------------
1700
1701class FSFile(Object):
093d3ff1 1702 """Proxy of C++ FSFile class"""
d55e5bfc
RD		 1703 def __repr__(self):
1704 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1705 def __init__(self, *args, **kwargs):
1706 """
1707 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1708 DateTime modif) -> FSFile
1709 """
1710 newobj = _core_.new_FSFile(*args, **kwargs)
1711 self.this = newobj.this
1712 self.thisown = 1
1713 del newobj.thisown
e2950dbb 1714 self.thisown = 0 # It will normally be deleted by the user of the wx.FileSystem
4cf4100f 1715
d55e5bfc
RD		 1716 def __del__(self, destroy=_core_.delete_FSFile):
1717 """__del__(self)"""
1718 try:
1719 if self.thisown: destroy(self)
1720 except: pass
1721
1722 def GetStream(*args, **kwargs):
1723 """GetStream(self) -> InputStream"""
1724 return _core_.FSFile_GetStream(*args, **kwargs)
1725
1726 def GetMimeType(*args, **kwargs):
1727 """GetMimeType(self) -> String"""
1728 return _core_.FSFile_GetMimeType(*args, **kwargs)
1729
1730 def GetLocation(*args, **kwargs):
1731 """GetLocation(self) -> String"""
1732 return _core_.FSFile_GetLocation(*args, **kwargs)
1733
1734 def GetAnchor(*args, **kwargs):
1735 """GetAnchor(self) -> String"""
1736 return _core_.FSFile_GetAnchor(*args, **kwargs)
1737
1738 def GetModificationTime(*args, **kwargs):
1739 """GetModificationTime(self) -> DateTime"""
1740 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1741
1742
1743class FSFilePtr(FSFile):
1744 def __init__(self, this):
1745 self.this = this
1746 if not hasattr(self,"thisown"): self.thisown = 0
1747 self.__class__ = FSFile
1748_core_.FSFile_swigregister(FSFilePtr)
1749
1750class CPPFileSystemHandler(object):
093d3ff1 1751 """Proxy of C++ CPPFileSystemHandler class"""
d55e5bfc
RD		 1752 def __init__(self): raise RuntimeError, "No constructor defined"
1753 def __repr__(self):
1754 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1755
1756class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1757 def __init__(self, this):
1758 self.this = this
1759 if not hasattr(self,"thisown"): self.thisown = 0
1760 self.__class__ = CPPFileSystemHandler
1761_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1762
1763class FileSystemHandler(CPPFileSystemHandler):
093d3ff1 1764 """Proxy of C++ FileSystemHandler class"""
d55e5bfc
RD		 1765 def __repr__(self):
1766 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1767 def __init__(self, *args, **kwargs):
1768 """__init__(self) -> FileSystemHandler"""
1769 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1770 self.this = newobj.this
1771 self.thisown = 1
1772 del newobj.thisown
1773 self._setCallbackInfo(self, FileSystemHandler)
1774
1775 def _setCallbackInfo(*args, **kwargs):
1776 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1777 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1778
1779 def CanOpen(*args, **kwargs):
1780 """CanOpen(self, String location) -> bool"""
1781 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1782
1783 def OpenFile(*args, **kwargs):
1784 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1785 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1786
1787 def FindFirst(*args, **kwargs):
1788 """FindFirst(self, String spec, int flags=0) -> String"""
1789 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1790
1791 def FindNext(*args, **kwargs):
1792 """FindNext(self) -> String"""
1793 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1794
1795 def GetProtocol(*args, **kwargs):
1796 """GetProtocol(self, String location) -> String"""
1797 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1798
1799 def GetLeftLocation(*args, **kwargs):
1800 """GetLeftLocation(self, String location) -> String"""
1801 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1802
1803 def GetAnchor(*args, **kwargs):
1804 """GetAnchor(self, String location) -> String"""
1805 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1806
1807 def GetRightLocation(*args, **kwargs):
1808 """GetRightLocation(self, String location) -> String"""
1809 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1810
1811 def GetMimeTypeFromExt(*args, **kwargs):
1812 """GetMimeTypeFromExt(self, String location) -> String"""
1813 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1814
1815
1816class FileSystemHandlerPtr(FileSystemHandler):
1817 def __init__(self, this):
1818 self.this = this
1819 if not hasattr(self,"thisown"): self.thisown = 0
1820 self.__class__ = FileSystemHandler
1821_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1822
1823class FileSystem(Object):
093d3ff1 1824 """Proxy of C++ FileSystem class"""
d55e5bfc
RD		 1825 def __repr__(self):
1826 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1827 def __init__(self, *args, **kwargs):
1828 """__init__(self) -> FileSystem"""
1829 newobj = _core_.new_FileSystem(*args, **kwargs)
1830 self.this = newobj.this
1831 self.thisown = 1
1832 del newobj.thisown
1833 def __del__(self, destroy=_core_.delete_FileSystem):
1834 """__del__(self)"""
1835 try:
1836 if self.thisown: destroy(self)
1837 except: pass
1838
1839 def ChangePathTo(*args, **kwargs):
1840 """ChangePathTo(self, String location, bool is_dir=False)"""
1841 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1842
1843 def GetPath(*args, **kwargs):
1844 """GetPath(self) -> String"""
1845 return _core_.FileSystem_GetPath(*args, **kwargs)
1846
1847 def OpenFile(*args, **kwargs):
1848 """OpenFile(self, String location) -> FSFile"""
1849 return _core_.FileSystem_OpenFile(*args, **kwargs)
1850
1851 def FindFirst(*args, **kwargs):
1852 """FindFirst(self, String spec, int flags=0) -> String"""
1853 return _core_.FileSystem_FindFirst(*args, **kwargs)
1854
1855 def FindNext(*args, **kwargs):
1856 """FindNext(self) -> String"""
1857 return _core_.FileSystem_FindNext(*args, **kwargs)
1858
1859 def AddHandler(*args, **kwargs):
c24da6d6 1860 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD		 1861 return _core_.FileSystem_AddHandler(*args, **kwargs)
1862
1863 AddHandler = staticmethod(AddHandler)
1864 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1865 """CleanUpHandlers()"""
d55e5bfc
RD		 1866 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1867
1868 CleanUpHandlers = staticmethod(CleanUpHandlers)
1869 def FileNameToURL(*args, **kwargs):
c24da6d6 1870 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD		 1871 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1872
1873 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD		 1874 def URLToFileName(*args, **kwargs):
1875 """URLToFileName(String url) -> String"""
1876 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1877
1878 URLToFileName = staticmethod(URLToFileName)
d55e5bfc
RD		 1879
1880class FileSystemPtr(FileSystem):
1881 def __init__(self, this):
1882 self.this = this
1883 if not hasattr(self,"thisown"): self.thisown = 0
1884 self.__class__ = FileSystem
1885_core_.FileSystem_swigregister(FileSystemPtr)
1886
1887def FileSystem_AddHandler(*args, **kwargs):
1888 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1889 return _core_.FileSystem_AddHandler(*args, **kwargs)
1890
1891def FileSystem_CleanUpHandlers(*args, **kwargs):
1892 """FileSystem_CleanUpHandlers()"""
1893 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1894
1895def FileSystem_FileNameToURL(*args, **kwargs):
1896 """FileSystem_FileNameToURL(String filename) -> String"""
1897 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1898
d55e5bfc
RD		 1899def FileSystem_URLToFileName(*args, **kwargs):
1900 """FileSystem_URLToFileName(String url) -> String"""
1901 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1902
d55e5bfc 1903class InternetFSHandler(CPPFileSystemHandler):
093d3ff1 1904 """Proxy of C++ InternetFSHandler class"""
d55e5bfc
RD		 1905 def __repr__(self):
1906 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1907 def __init__(self, *args, **kwargs):
1908 """__init__(self) -> InternetFSHandler"""
1909 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1910 self.this = newobj.this
1911 self.thisown = 1
1912 del newobj.thisown
1913 def CanOpen(*args, **kwargs):
1914 """CanOpen(self, String location) -> bool"""
1915 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1916
1917 def OpenFile(*args, **kwargs):
1918 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1919 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1920
1921
1922class InternetFSHandlerPtr(InternetFSHandler):
1923 def __init__(self, this):
1924 self.this = this
1925 if not hasattr(self,"thisown"): self.thisown = 0
1926 self.__class__ = InternetFSHandler
1927_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1928
1929class ZipFSHandler(CPPFileSystemHandler):
093d3ff1 1930 """Proxy of C++ ZipFSHandler class"""
d55e5bfc
RD		 1931 def __repr__(self):
1932 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1933 def __init__(self, *args, **kwargs):
1934 """__init__(self) -> ZipFSHandler"""
1935 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1936 self.this = newobj.this
1937 self.thisown = 1
1938 del newobj.thisown
1939 def CanOpen(*args, **kwargs):
1940 """CanOpen(self, String location) -> bool"""
1941 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1942
1943 def OpenFile(*args, **kwargs):
1944 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1945 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1946
1947 def FindFirst(*args, **kwargs):
1948 """FindFirst(self, String spec, int flags=0) -> String"""
1949 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1950
1951 def FindNext(*args, **kwargs):
1952 """FindNext(self) -> String"""
1953 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1954
1955
1956class ZipFSHandlerPtr(ZipFSHandler):
1957 def __init__(self, this):
1958 self.this = this
1959 if not hasattr(self,"thisown"): self.thisown = 0
1960 self.__class__ = ZipFSHandler
1961_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
1962
1963
1964def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1965 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1966 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1967
1968def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1969 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1970 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1971
1972def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1973 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1974 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD		 1975def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1976 """
1977 Add 'file' to the memory filesystem. The dataItem parameter can
1978 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1979 arbitrary data. If a bitmap or image is used then the imgType
1980 parameter should specify what kind of image file it should be
1981 written as, wx.BITMAP_TYPE_PNG, etc.
1982 """
1983 if isinstance(dataItem, wx.Image):
1984 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1985 elif isinstance(dataItem, wx.Bitmap):
1986 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1987 elif type(dataItem) == str:
1988 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1989 else:
1990 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD		 1991
1992class MemoryFSHandler(CPPFileSystemHandler):
093d3ff1 1993 """Proxy of C++ MemoryFSHandler class"""
d55e5bfc
RD		 1994 def __repr__(self):
1995 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1996 def __init__(self, *args, **kwargs):
1997 """__init__(self) -> MemoryFSHandler"""
1998 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
1999 self.this = newobj.this
2000 self.thisown = 1
2001 del newobj.thisown
2002 def RemoveFile(*args, **kwargs):
c24da6d6 2003 """RemoveFile(String filename)"""
d55e5bfc
RD		 2004 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2005
2006 RemoveFile = staticmethod(RemoveFile)
2007 AddFile = staticmethod(MemoryFSHandler_AddFile)
2008 def CanOpen(*args, **kwargs):
2009 """CanOpen(self, String location) -> bool"""
2010 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
2011
2012 def OpenFile(*args, **kwargs):
2013 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
2014 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
2015
2016 def FindFirst(*args, **kwargs):
2017 """FindFirst(self, String spec, int flags=0) -> String"""
2018 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
2019
2020 def FindNext(*args, **kwargs):
2021 """FindNext(self) -> String"""
2022 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
2023
2024
2025class MemoryFSHandlerPtr(MemoryFSHandler):
2026 def __init__(self, this):
2027 self.this = this
2028 if not hasattr(self,"thisown"): self.thisown = 0
2029 self.__class__ = MemoryFSHandler
2030_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
2031
2032def MemoryFSHandler_RemoveFile(*args, **kwargs):
2033 """MemoryFSHandler_RemoveFile(String filename)"""
2034 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
2035
2036#---------------------------------------------------------------------------
2037
2038class ImageHandler(Object):
093d3ff1 2039 """Proxy of C++ ImageHandler class"""
d55e5bfc
RD		 2040 def __init__(self): raise RuntimeError, "No constructor defined"
2041 def __repr__(self):
2042 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2043 def GetName(*args, **kwargs):
2044 """GetName(self) -> String"""
2045 return _core_.ImageHandler_GetName(*args, **kwargs)
2046
2047 def GetExtension(*args, **kwargs):
2048 """GetExtension(self) -> String"""
2049 return _core_.ImageHandler_GetExtension(*args, **kwargs)
2050
2051 def GetType(*args, **kwargs):
2052 """GetType(self) -> long"""
2053 return _core_.ImageHandler_GetType(*args, **kwargs)
2054
2055 def GetMimeType(*args, **kwargs):
2056 """GetMimeType(self) -> String"""
2057 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
2058
2059 def CanRead(*args, **kwargs):
2060 """CanRead(self, String name) -> bool"""
2061 return _core_.ImageHandler_CanRead(*args, **kwargs)
2062
2063 def SetName(*args, **kwargs):
2064 """SetName(self, String name)"""
2065 return _core_.ImageHandler_SetName(*args, **kwargs)
2066
2067 def SetExtension(*args, **kwargs):
2068 """SetExtension(self, String extension)"""
2069 return _core_.ImageHandler_SetExtension(*args, **kwargs)
2070
2071 def SetType(*args, **kwargs):
2072 """SetType(self, long type)"""
2073 return _core_.ImageHandler_SetType(*args, **kwargs)
2074
2075 def SetMimeType(*args, **kwargs):
2076 """SetMimeType(self, String mimetype)"""
2077 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
2078
2079
2080class ImageHandlerPtr(ImageHandler):
2081 def __init__(self, this):
2082 self.this = this
2083 if not hasattr(self,"thisown"): self.thisown = 0
2084 self.__class__ = ImageHandler
2085_core_.ImageHandler_swigregister(ImageHandlerPtr)
2086
2087class ImageHistogram(object):
093d3ff1 2088 """Proxy of C++ ImageHistogram class"""
d55e5bfc
RD		 2089 def __repr__(self):
2090 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2091 def __init__(self, *args, **kwargs):
2092 """__init__(self) -> ImageHistogram"""
2093 newobj = _core_.new_ImageHistogram(*args, **kwargs)
2094 self.this = newobj.this
2095 self.thisown = 1
2096 del newobj.thisown
2097 def MakeKey(*args, **kwargs):
2098 """
c24da6d6 2099 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
d55e5bfc
RD		 2100
2101 Get the key in the histogram for the given RGB values
2102 """
2103 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2104
2105 MakeKey = staticmethod(MakeKey)
2106 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2107 """
2108 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2109
2110 Find first colour that is not used in the image and has higher RGB
2111 values than startR, startG, startB. Returns a tuple consisting of a
2112 success flag and rgb values.
2113 """
d55e5bfc
RD		 2114 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2115
f1cbd8fa
RD		 2116 def GetCount(*args, **kwargs):
2117 """
2118 GetCount(self, unsigned long key) -> unsigned long
2119
2120 Returns the pixel count for the given key. Use `MakeKey` to create a
2121 key value from a RGB tripple.
2122 """
2123 return _core_.ImageHistogram_GetCount(*args, **kwargs)
2124
2125 def GetCountRGB(*args, **kwargs):
2126 """
2127 GetCountRGB(self, unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2128
2129 Returns the pixel count for the given RGB values.
2130 """
2131 return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
2132
2133 def GetCountColour(*args, **kwargs):
2134 """
2135 GetCountColour(self, Colour colour) -> unsigned long
2136
2137 Returns the pixel count for the given `wx.Colour` value.
2138 """
2139 return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
2140
d55e5bfc
RD		 2141
2142class ImageHistogramPtr(ImageHistogram):
2143 def __init__(self, this):
2144 self.this = this
2145 if not hasattr(self,"thisown"): self.thisown = 0
2146 self.__class__ = ImageHistogram
2147_core_.ImageHistogram_swigregister(ImageHistogramPtr)
2148
2149def ImageHistogram_MakeKey(*args, **kwargs):
2150 """
2151 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2152
2153 Get the key in the histogram for the given RGB values
2154 """
2155 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2156
2157class Image(Object):
093d3ff1 2158 """Proxy of C++ Image class"""
d55e5bfc
RD		 2159 def __repr__(self):
2160 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2161 def __init__(self, *args, **kwargs):
2162 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2163 newobj = _core_.new_Image(*args, **kwargs)
2164 self.this = newobj.this
2165 self.thisown = 1
2166 del newobj.thisown
2167 def __del__(self, destroy=_core_.delete_Image):
2168 """__del__(self)"""
2169 try:
2170 if self.thisown: destroy(self)
2171 except: pass
2172
2173 def Create(*args, **kwargs):
2174 """Create(self, int width, int height)"""
2175 return _core_.Image_Create(*args, **kwargs)
2176
2177 def Destroy(*args, **kwargs):
2178 """
2179 Destroy(self)
2180
2181 Deletes the C++ object this Python object is a proxy for.
2182 """
2183 return _core_.Image_Destroy(*args, **kwargs)
2184
2185 def Scale(*args, **kwargs):
2186 """Scale(self, int width, int height) -> Image"""
2187 return _core_.Image_Scale(*args, **kwargs)
2188
2189 def ShrinkBy(*args, **kwargs):
2190 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
2191 return _core_.Image_ShrinkBy(*args, **kwargs)
2192
2193 def Rescale(*args, **kwargs):
2194 """Rescale(self, int width, int height) -> Image"""
2195 return _core_.Image_Rescale(*args, **kwargs)
2196
aff4cc5c
RD		 2197 def Resize(*args, **kwargs):
2198 """Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image"""
2199 return _core_.Image_Resize(*args, **kwargs)
2200
d55e5bfc
RD		 2201 def SetRGB(*args, **kwargs):
2202 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
2203 return _core_.Image_SetRGB(*args, **kwargs)
2204
aff4cc5c
RD		 2205 def SetRGBRect(*args, **kwargs):
2206 """SetRGBRect(self, Rect rect, unsigned char r, unsigned char g, unsigned char b)"""
2207 return _core_.Image_SetRGBRect(*args, **kwargs)
2208
d55e5bfc
RD		 2209 def GetRed(*args, **kwargs):
2210 """GetRed(self, int x, int y) -> unsigned char"""
2211 return _core_.Image_GetRed(*args, **kwargs)
2212
2213 def GetGreen(*args, **kwargs):
2214 """GetGreen(self, int x, int y) -> unsigned char"""
2215 return _core_.Image_GetGreen(*args, **kwargs)
2216
2217 def GetBlue(*args, **kwargs):
2218 """GetBlue(self, int x, int y) -> unsigned char"""
2219 return _core_.Image_GetBlue(*args, **kwargs)
2220
2221 def SetAlpha(*args, **kwargs):
2222 """SetAlpha(self, int x, int y, unsigned char alpha)"""
2223 return _core_.Image_SetAlpha(*args, **kwargs)
2224
2225 def GetAlpha(*args, **kwargs):
2226 """GetAlpha(self, int x, int y) -> unsigned char"""
2227 return _core_.Image_GetAlpha(*args, **kwargs)
2228
2229 def HasAlpha(*args, **kwargs):
2230 """HasAlpha(self) -> bool"""
2231 return _core_.Image_HasAlpha(*args, **kwargs)
2232
68350608
RD		 2233 def InitAlpha(*args, **kwargs):
2234 """
2235 InitAlpha(self)
2236
2237 Initializes the image alpha channel data. It is an error to call it if
2238 the image already has alpha data. If it doesn't, alpha data will be by
2239 default initialized to all pixels being fully opaque. But if the image
2240 has a a mask colour, all mask pixels will be completely transparent.
2241 """
2242 return _core_.Image_InitAlpha(*args, **kwargs)
2243
d55e5bfc 2244 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD		 2245 """
2246 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2247
2248 Find first colour that is not used in the image and has higher RGB
2249 values than startR, startG, startB. Returns a tuple consisting of a
2250 success flag and rgb values.
2251 """
d55e5bfc
RD		 2252 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2253
4cf4100f
RD		 2254 def ConvertAlphaToMask(*args, **kwargs):
2255 """
2256 ConvertAlphaToMask(self, byte threshold=128) -> bool
2257
2258 If the image has alpha channel, this method converts it to mask. All pixels
2259 with alpha value less than ``threshold`` are replaced with mask colour and the
2260 alpha channel is removed. Mask colour is chosen automatically using
2261 `FindFirstUnusedColour`.
2262
2263 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2264 nothing.
2265 """
2266 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2267
8fb0e70a
RD		 2268 def ConvertColourToAlpha(*args, **kwargs):
2269 """
2270 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2271
2272 This method converts an image where the original alpha information is
2273 only available as a shades of a colour (actually shades of grey)
2274 typically when you draw anti-aliased text into a bitmap. The DC
2275 drawing routines draw grey values on the black background although
2276 they actually mean to draw white with differnt alpha values. This
2277 method reverses it, assuming a black (!) background and white text.
2278 The method will then fill up the whole image with the colour given.
2279 """
2280 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2281
d55e5bfc
RD		 2282 def SetMaskFromImage(*args, **kwargs):
2283 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
2284 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2285
2286 def CanRead(*args, **kwargs):
c24da6d6 2287 """CanRead(String name) -> bool"""
d55e5bfc
RD		 2288 return _core_.Image_CanRead(*args, **kwargs)
2289
2290 CanRead = staticmethod(CanRead)
2291 def GetImageCount(*args, **kwargs):
c24da6d6 2292 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
d55e5bfc
RD		 2293 return _core_.Image_GetImageCount(*args, **kwargs)
2294
2295 GetImageCount = staticmethod(GetImageCount)
2296 def LoadFile(*args, **kwargs):
2297 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2298 return _core_.Image_LoadFile(*args, **kwargs)
2299
2300 def LoadMimeFile(*args, **kwargs):
2301 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
2302 return _core_.Image_LoadMimeFile(*args, **kwargs)
2303
2304 def SaveFile(*args, **kwargs):
2305 """SaveFile(self, String name, int type) -> bool"""
2306 return _core_.Image_SaveFile(*args, **kwargs)
2307
2308 def SaveMimeFile(*args, **kwargs):
2309 """SaveMimeFile(self, String name, String mimetype) -> bool"""
2310 return _core_.Image_SaveMimeFile(*args, **kwargs)
2311
2312 def CanReadStream(*args, **kwargs):
c24da6d6 2313 """CanReadStream(InputStream stream) -> bool"""
d55e5bfc
RD		 2314 return _core_.Image_CanReadStream(*args, **kwargs)
2315
2316 CanReadStream = staticmethod(CanReadStream)
2317 def LoadStream(*args, **kwargs):
2318 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2319 return _core_.Image_LoadStream(*args, **kwargs)
2320
2321 def LoadMimeStream(*args, **kwargs):
2322 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
2323 return _core_.Image_LoadMimeStream(*args, **kwargs)
2324
2325 def Ok(*args, **kwargs):
2326 """Ok(self) -> bool"""
2327 return _core_.Image_Ok(*args, **kwargs)
2328
2329 def GetWidth(*args, **kwargs):
2330 """GetWidth(self) -> int"""
2331 return _core_.Image_GetWidth(*args, **kwargs)
2332
2333 def GetHeight(*args, **kwargs):
2334 """GetHeight(self) -> int"""
2335 return _core_.Image_GetHeight(*args, **kwargs)
2336
2337 def GetSize(*args, **kwargs):
2338 """GetSize(self) -> Size"""
2339 return _core_.Image_GetSize(*args, **kwargs)
2340
2341 def GetSubImage(*args, **kwargs):
2342 """GetSubImage(self, Rect rect) -> Image"""
2343 return _core_.Image_GetSubImage(*args, **kwargs)
2344
aff4cc5c
RD		 2345 def Size(*args, **kwargs):
2346 """Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image"""
2347 return _core_.Image_Size(*args, **kwargs)
2348
d55e5bfc
RD		 2349 def Copy(*args, **kwargs):
2350 """Copy(self) -> Image"""
2351 return _core_.Image_Copy(*args, **kwargs)
2352
2353 def Paste(*args, **kwargs):
2354 """Paste(self, Image image, int x, int y)"""
2355 return _core_.Image_Paste(*args, **kwargs)
2356
2357 def GetData(*args, **kwargs):
2358 """GetData(self) -> PyObject"""
2359 return _core_.Image_GetData(*args, **kwargs)
2360
2361 def SetData(*args, **kwargs):
2362 """SetData(self, PyObject data)"""
2363 return _core_.Image_SetData(*args, **kwargs)
2364
2365 def GetDataBuffer(*args, **kwargs):
2366 """GetDataBuffer(self) -> PyObject"""
2367 return _core_.Image_GetDataBuffer(*args, **kwargs)
2368
2369 def SetDataBuffer(*args, **kwargs):
2370 """SetDataBuffer(self, PyObject data)"""
2371 return _core_.Image_SetDataBuffer(*args, **kwargs)
2372
2373 def GetAlphaData(*args, **kwargs):
2374 """GetAlphaData(self) -> PyObject"""
2375 return _core_.Image_GetAlphaData(*args, **kwargs)
2376
2377 def SetAlphaData(*args, **kwargs):
2378 """SetAlphaData(self, PyObject data)"""
2379 return _core_.Image_SetAlphaData(*args, **kwargs)
2380
2381 def GetAlphaBuffer(*args, **kwargs):
2382 """GetAlphaBuffer(self) -> PyObject"""
2383 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2384
2385 def SetAlphaBuffer(*args, **kwargs):
2386 """SetAlphaBuffer(self, PyObject data)"""
2387 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2388
2389 def SetMaskColour(*args, **kwargs):
2390 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
2391 return _core_.Image_SetMaskColour(*args, **kwargs)
2392
aff4cc5c
RD		 2393 def GetOrFindMaskColour(*args, **kwargs):
2394 """
2395 GetOrFindMaskColour() -> (r,g,b)
2396
2397 Get the current mask colour or find a suitable colour.
2398 """
2399 return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
2400
d55e5bfc
RD		 2401 def GetMaskRed(*args, **kwargs):
2402 """GetMaskRed(self) -> unsigned char"""
2403 return _core_.Image_GetMaskRed(*args, **kwargs)
2404
2405 def GetMaskGreen(*args, **kwargs):
2406 """GetMaskGreen(self) -> unsigned char"""
2407 return _core_.Image_GetMaskGreen(*args, **kwargs)
2408
2409 def GetMaskBlue(*args, **kwargs):
2410 """GetMaskBlue(self) -> unsigned char"""
2411 return _core_.Image_GetMaskBlue(*args, **kwargs)
2412
2413 def SetMask(*args, **kwargs):
2414 """SetMask(self, bool mask=True)"""
2415 return _core_.Image_SetMask(*args, **kwargs)
2416
2417 def HasMask(*args, **kwargs):
2418 """HasMask(self) -> bool"""
2419 return _core_.Image_HasMask(*args, **kwargs)
2420
2421 def Rotate(*args, **kwargs):
2422 """
2423 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2424 Point offset_after_rotation=None) -> Image
2425 """
2426 return _core_.Image_Rotate(*args, **kwargs)
2427
2428 def Rotate90(*args, **kwargs):
2429 """Rotate90(self, bool clockwise=True) -> Image"""
2430 return _core_.Image_Rotate90(*args, **kwargs)
2431
2432 def Mirror(*args, **kwargs):
2433 """Mirror(self, bool horizontally=True) -> Image"""
2434 return _core_.Image_Mirror(*args, **kwargs)
2435
2436 def Replace(*args, **kwargs):
2437 """
2438 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
2439 unsigned char r2, unsigned char g2, unsigned char b2)
2440 """
2441 return _core_.Image_Replace(*args, **kwargs)
2442
2443 def ConvertToMono(*args, **kwargs):
2444 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
2445 return _core_.Image_ConvertToMono(*args, **kwargs)
2446
2447 def SetOption(*args, **kwargs):
2448 """SetOption(self, String name, String value)"""
2449 return _core_.Image_SetOption(*args, **kwargs)
2450
2451 def SetOptionInt(*args, **kwargs):
2452 """SetOptionInt(self, String name, int value)"""
2453 return _core_.Image_SetOptionInt(*args, **kwargs)
2454
2455 def GetOption(*args, **kwargs):
2456 """GetOption(self, String name) -> String"""
2457 return _core_.Image_GetOption(*args, **kwargs)
2458
2459 def GetOptionInt(*args, **kwargs):
2460 """GetOptionInt(self, String name) -> int"""
2461 return _core_.Image_GetOptionInt(*args, **kwargs)
2462
2463 def HasOption(*args, **kwargs):
2464 """HasOption(self, String name) -> bool"""
2465 return _core_.Image_HasOption(*args, **kwargs)
2466
2467 def CountColours(*args, **kwargs):
2468 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2469 return _core_.Image_CountColours(*args, **kwargs)
2470
2471 def ComputeHistogram(*args, **kwargs):
2472 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2473 return _core_.Image_ComputeHistogram(*args, **kwargs)
2474
2475 def AddHandler(*args, **kwargs):
c24da6d6 2476 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD		 2477 return _core_.Image_AddHandler(*args, **kwargs)
2478
2479 AddHandler = staticmethod(AddHandler)
2480 def InsertHandler(*args, **kwargs):
c24da6d6 2481 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD		 2482 return _core_.Image_InsertHandler(*args, **kwargs)
2483
2484 InsertHandler = staticmethod(InsertHandler)
2485 def RemoveHandler(*args, **kwargs):
c24da6d6 2486 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD		 2487 return _core_.Image_RemoveHandler(*args, **kwargs)
2488
2489 RemoveHandler = staticmethod(RemoveHandler)
2490 def GetImageExtWildcard(*args, **kwargs):
c24da6d6 2491 """GetImageExtWildcard() -> String"""
d55e5bfc
RD		 2492 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2493
2494 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2495 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2496 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD		 2497 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2498
2499 def ConvertToMonoBitmap(*args, **kwargs):
2500 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
2501 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2502
2503 def __nonzero__(self): return self.Ok()
2504
2505class ImagePtr(Image):
2506 def __init__(self, this):
2507 self.this = this
2508 if not hasattr(self,"thisown"): self.thisown = 0
2509 self.__class__ = Image
2510_core_.Image_swigregister(ImagePtr)
2511
2512def ImageFromMime(*args, **kwargs):
2513 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
2514 val = _core_.new_ImageFromMime(*args, **kwargs)
2515 val.thisown = 1
2516 return val
2517
2518def ImageFromStream(*args, **kwargs):
2519 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2520 val = _core_.new_ImageFromStream(*args, **kwargs)
2521 val.thisown = 1
2522 return val
2523
2524def ImageFromStreamMime(*args, **kwargs):
2525 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
2526 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2527 val.thisown = 1
2528 return val
2529
c24da6d6
RD		 2530def EmptyImage(*args, **kwargs):
2531 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2532 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD		 2533 val.thisown = 1
2534 return val
2535
2536def ImageFromBitmap(*args, **kwargs):
2537 """ImageFromBitmap(Bitmap bitmap) -> Image"""
2538 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2539 val.thisown = 1
2540 return val
2541
2542def ImageFromData(*args, **kwargs):
2543 """ImageFromData(int width, int height, unsigned char data) -> Image"""
2544 val = _core_.new_ImageFromData(*args, **kwargs)
2545 val.thisown = 1
2546 return val
2547
c9c2cf70
RD		 2548def ImageFromDataWithAlpha(*args, **kwargs):
2549 """ImageFromDataWithAlpha(int width, int height, unsigned char data, unsigned char alpha) -> Image"""
2550 val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
2551 val.thisown = 1
2552 return val
2553
d55e5bfc
RD		 2554def Image_CanRead(*args, **kwargs):
2555 """Image_CanRead(String name) -> bool"""
2556 return _core_.Image_CanRead(*args, **kwargs)
2557
2558def Image_GetImageCount(*args, **kwargs):
2559 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
2560 return _core_.Image_GetImageCount(*args, **kwargs)
2561
2562def Image_CanReadStream(*args, **kwargs):
2563 """Image_CanReadStream(InputStream stream) -> bool"""
2564 return _core_.Image_CanReadStream(*args, **kwargs)
2565
2566def Image_AddHandler(*args, **kwargs):
2567 """Image_AddHandler(ImageHandler handler)"""
2568 return _core_.Image_AddHandler(*args, **kwargs)
2569
2570def Image_InsertHandler(*args, **kwargs):
2571 """Image_InsertHandler(ImageHandler handler)"""
2572 return _core_.Image_InsertHandler(*args, **kwargs)
2573
2574def Image_RemoveHandler(*args, **kwargs):
2575 """Image_RemoveHandler(String name) -> bool"""
2576 return _core_.Image_RemoveHandler(*args, **kwargs)
2577
2578def Image_GetImageExtWildcard(*args, **kwargs):
2579 """Image_GetImageExtWildcard() -> String"""
2580 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2581
a07a67e6
RD		 2582def InitAllImageHandlers():
2583 """
2584 The former functionality of InitAllImageHanders is now done internal to
2585 the _core_ extension module and so this function has become a simple NOP.
2586 """
2587 pass
d55e5bfc 2588
d55e5bfc
RD		 2589IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2590IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
b9d6a5f3
RD		 2591PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
2592PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
2593PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
d55e5bfc
RD		 2594BMP_24BPP = _core_.BMP_24BPP
2595BMP_8BPP = _core_.BMP_8BPP
2596BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2597BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2598BMP_8BPP_RED = _core_.BMP_8BPP_RED
2599BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2600BMP_4BPP = _core_.BMP_4BPP
2601BMP_1BPP = _core_.BMP_1BPP
2602BMP_1BPP_BW = _core_.BMP_1BPP_BW
2603class BMPHandler(ImageHandler):
093d3ff1 2604 """Proxy of C++ BMPHandler class"""
d55e5bfc
RD		 2605 def __repr__(self):
2606 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2607 def __init__(self, *args, **kwargs):
2608 """__init__(self) -> BMPHandler"""
2609 newobj = _core_.new_BMPHandler(*args, **kwargs)
2610 self.this = newobj.this
2611 self.thisown = 1
2612 del newobj.thisown
2613
2614class BMPHandlerPtr(BMPHandler):
2615 def __init__(self, this):
2616 self.this = this
2617 if not hasattr(self,"thisown"): self.thisown = 0
2618 self.__class__ = BMPHandler
2619_core_.BMPHandler_swigregister(BMPHandlerPtr)
2620NullImage = cvar.NullImage
68350608 2621IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
d55e5bfc
RD		 2622IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2623IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2624IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2625IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
68350608
RD		 2626IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
2627IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
d55e5bfc 2628IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
24d7cbea 2629IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
68350608
RD		 2630IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
2631IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
2632IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
2633IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
b9d6a5f3
RD		 2634IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
2635IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
d55e5bfc
RD		 2636
2637class ICOHandler(BMPHandler):
093d3ff1 2638 """Proxy of C++ ICOHandler class"""
d55e5bfc
RD		 2639 def __repr__(self):
2640 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2641 def __init__(self, *args, **kwargs):
2642 """__init__(self) -> ICOHandler"""
2643 newobj = _core_.new_ICOHandler(*args, **kwargs)
2644 self.this = newobj.this
2645 self.thisown = 1
2646 del newobj.thisown
2647
2648class ICOHandlerPtr(ICOHandler):
2649 def __init__(self, this):
2650 self.this = this
2651 if not hasattr(self,"thisown"): self.thisown = 0
2652 self.__class__ = ICOHandler
2653_core_.ICOHandler_swigregister(ICOHandlerPtr)
2654
2655class CURHandler(ICOHandler):
093d3ff1 2656 """Proxy of C++ CURHandler class"""
d55e5bfc
RD		 2657 def __repr__(self):
2658 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2659 def __init__(self, *args, **kwargs):
2660 """__init__(self) -> CURHandler"""
2661 newobj = _core_.new_CURHandler(*args, **kwargs)
2662 self.this = newobj.this
2663 self.thisown = 1
2664 del newobj.thisown
2665
2666class CURHandlerPtr(CURHandler):
2667 def __init__(self, this):
2668 self.this = this
2669 if not hasattr(self,"thisown"): self.thisown = 0
2670 self.__class__ = CURHandler
2671_core_.CURHandler_swigregister(CURHandlerPtr)
2672
2673class ANIHandler(CURHandler):
093d3ff1 2674 """Proxy of C++ ANIHandler class"""
d55e5bfc
RD		 2675 def __repr__(self):
2676 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2677 def __init__(self, *args, **kwargs):
2678 """__init__(self) -> ANIHandler"""
2679 newobj = _core_.new_ANIHandler(*args, **kwargs)
2680 self.this = newobj.this
2681 self.thisown = 1
2682 del newobj.thisown
2683
2684class ANIHandlerPtr(ANIHandler):
2685 def __init__(self, this):
2686 self.this = this
2687 if not hasattr(self,"thisown"): self.thisown = 0
2688 self.__class__ = ANIHandler
2689_core_.ANIHandler_swigregister(ANIHandlerPtr)
2690
2691class PNGHandler(ImageHandler):
093d3ff1 2692 """Proxy of C++ PNGHandler class"""
d55e5bfc
RD		 2693 def __repr__(self):
2694 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2695 def __init__(self, *args, **kwargs):
2696 """__init__(self) -> PNGHandler"""
2697 newobj = _core_.new_PNGHandler(*args, **kwargs)
2698 self.this = newobj.this
2699 self.thisown = 1
2700 del newobj.thisown
2701
2702class PNGHandlerPtr(PNGHandler):
2703 def __init__(self, this):
2704 self.this = this
2705 if not hasattr(self,"thisown"): self.thisown = 0
2706 self.__class__ = PNGHandler
2707_core_.PNGHandler_swigregister(PNGHandlerPtr)
2708
2709class GIFHandler(ImageHandler):
093d3ff1 2710 """Proxy of C++ GIFHandler class"""
d55e5bfc
RD		 2711 def __repr__(self):
2712 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2713 def __init__(self, *args, **kwargs):
2714 """__init__(self) -> GIFHandler"""
2715 newobj = _core_.new_GIFHandler(*args, **kwargs)
2716 self.this = newobj.this
2717 self.thisown = 1
2718 del newobj.thisown
2719
2720class GIFHandlerPtr(GIFHandler):
2721 def __init__(self, this):
2722 self.this = this
2723 if not hasattr(self,"thisown"): self.thisown = 0
2724 self.__class__ = GIFHandler
2725_core_.GIFHandler_swigregister(GIFHandlerPtr)
2726
2727class PCXHandler(ImageHandler):
093d3ff1 2728 """Proxy of C++ PCXHandler class"""
d55e5bfc
RD		 2729 def __repr__(self):
2730 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2731 def __init__(self, *args, **kwargs):
2732 """__init__(self) -> PCXHandler"""
2733 newobj = _core_.new_PCXHandler(*args, **kwargs)
2734 self.this = newobj.this
2735 self.thisown = 1
2736 del newobj.thisown
2737
2738class PCXHandlerPtr(PCXHandler):
2739 def __init__(self, this):
2740 self.this = this
2741 if not hasattr(self,"thisown"): self.thisown = 0
2742 self.__class__ = PCXHandler
2743_core_.PCXHandler_swigregister(PCXHandlerPtr)
2744
2745class JPEGHandler(ImageHandler):
093d3ff1 2746 """Proxy of C++ JPEGHandler class"""
d55e5bfc
RD		 2747 def __repr__(self):
2748 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2749 def __init__(self, *args, **kwargs):
2750 """__init__(self) -> JPEGHandler"""
2751 newobj = _core_.new_JPEGHandler(*args, **kwargs)
2752 self.this = newobj.this
2753 self.thisown = 1
2754 del newobj.thisown
2755
2756class JPEGHandlerPtr(JPEGHandler):
2757 def __init__(self, this):
2758 self.this = this
2759 if not hasattr(self,"thisown"): self.thisown = 0
2760 self.__class__ = JPEGHandler
2761_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
2762
2763class PNMHandler(ImageHandler):
093d3ff1 2764 """Proxy of C++ PNMHandler class"""
d55e5bfc
RD		 2765 def __repr__(self):
2766 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2767 def __init__(self, *args, **kwargs):
2768 """__init__(self) -> PNMHandler"""
2769 newobj = _core_.new_PNMHandler(*args, **kwargs)
2770 self.this = newobj.this
2771 self.thisown = 1
2772 del newobj.thisown
2773
2774class PNMHandlerPtr(PNMHandler):
2775 def __init__(self, this):
2776 self.this = this
2777 if not hasattr(self,"thisown"): self.thisown = 0
2778 self.__class__ = PNMHandler
2779_core_.PNMHandler_swigregister(PNMHandlerPtr)
2780
2781class XPMHandler(ImageHandler):
093d3ff1 2782 """Proxy of C++ XPMHandler class"""
d55e5bfc
RD		 2783 def __repr__(self):
2784 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2785 def __init__(self, *args, **kwargs):
2786 """__init__(self) -> XPMHandler"""
2787 newobj = _core_.new_XPMHandler(*args, **kwargs)
2788 self.this = newobj.this
2789 self.thisown = 1
2790 del newobj.thisown
2791
2792class XPMHandlerPtr(XPMHandler):
2793 def __init__(self, this):
2794 self.this = this
2795 if not hasattr(self,"thisown"): self.thisown = 0
2796 self.__class__ = XPMHandler
2797_core_.XPMHandler_swigregister(XPMHandlerPtr)
2798
2799class TIFFHandler(ImageHandler):
093d3ff1 2800 """Proxy of C++ TIFFHandler class"""
d55e5bfc
RD		 2801 def __repr__(self):
2802 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2803 def __init__(self, *args, **kwargs):
2804 """__init__(self) -> TIFFHandler"""
2805 newobj = _core_.new_TIFFHandler(*args, **kwargs)
2806 self.this = newobj.this
2807 self.thisown = 1
2808 del newobj.thisown
2809
2810class TIFFHandlerPtr(TIFFHandler):
2811 def __init__(self, this):
2812 self.this = this
2813 if not hasattr(self,"thisown"): self.thisown = 0
2814 self.__class__ = TIFFHandler
2815_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
2816
c0de73ae
RD		 2817QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2818QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2819class Quantize(object):
2820 """Performs quantization, or colour reduction, on a wxImage."""
2821 def __init__(self): raise RuntimeError, "No constructor defined"
2822 def __repr__(self):
2823 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2824 def Quantize(*args, **kwargs):
2825 """
2826 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2827
2828 Reduce the colours in the source image and put the result into the
2829 destination image, setting the palette in the destination if
2830 needed. Both images may be the same, to overwrite the source image.
2831 """
2832 return _core_.Quantize_Quantize(*args, **kwargs)
2833
2834 Quantize = staticmethod(Quantize)
2835
2836class QuantizePtr(Quantize):
2837 def __init__(self, this):
2838 self.this = this
2839 if not hasattr(self,"thisown"): self.thisown = 0
2840 self.__class__ = Quantize
2841_core_.Quantize_swigregister(QuantizePtr)
2842
2843def Quantize_Quantize(*args, **kwargs):
2844 """
2845 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2846
2847 Reduce the colours in the source image and put the result into the
2848 destination image, setting the palette in the destination if
2849 needed. Both images may be the same, to overwrite the source image.
2850 """
2851 return _core_.Quantize_Quantize(*args, **kwargs)
2852
d55e5bfc
RD		 2853#---------------------------------------------------------------------------
2854
2855class EvtHandler(Object):
093d3ff1 2856 """Proxy of C++ EvtHandler class"""
d55e5bfc
RD		 2857 def __repr__(self):
2858 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2859 def __init__(self, *args, **kwargs):
2860 """__init__(self) -> EvtHandler"""
2861 newobj = _core_.new_EvtHandler(*args, **kwargs)
2862 self.this = newobj.this
2863 self.thisown = 1
2864 del newobj.thisown
2865 def GetNextHandler(*args, **kwargs):
2866 """GetNextHandler(self) -> EvtHandler"""
2867 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
2868
2869 def GetPreviousHandler(*args, **kwargs):
2870 """GetPreviousHandler(self) -> EvtHandler"""
2871 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
2872
2873 def SetNextHandler(*args, **kwargs):
2874 """SetNextHandler(self, EvtHandler handler)"""
2875 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
2876
2877 def SetPreviousHandler(*args, **kwargs):
2878 """SetPreviousHandler(self, EvtHandler handler)"""
2879 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
2880
2881 def GetEvtHandlerEnabled(*args, **kwargs):
2882 """GetEvtHandlerEnabled(self) -> bool"""
2883 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
2884
2885 def SetEvtHandlerEnabled(*args, **kwargs):
2886 """SetEvtHandlerEnabled(self, bool enabled)"""
2887 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
2888
2889 def ProcessEvent(*args, **kwargs):
2890 """ProcessEvent(self, Event event) -> bool"""
2891 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
2892
2893 def AddPendingEvent(*args, **kwargs):
2894 """AddPendingEvent(self, Event event)"""
2895 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
2896
2897 def ProcessPendingEvents(*args, **kwargs):
2898 """ProcessPendingEvents(self)"""
2899 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
2900
2901 def Connect(*args, **kwargs):
2902 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
2903 return _core_.EvtHandler_Connect(*args, **kwargs)
2904
2905 def Disconnect(*args, **kwargs):
2906 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
2907 return _core_.EvtHandler_Disconnect(*args, **kwargs)
2908
2909 def _setOORInfo(*args, **kwargs):
093d3ff1 2910 """_setOORInfo(self, PyObject _self, bool incref=True)"""
d55e5bfc
RD		 2911 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
2912
2913 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2914 """
2915 Bind an event to an event handler.
2916
caef1a4d
RD		 2917 :param event: One of the EVT_* objects that specifies the
2918 type of event to bind,
d55e5bfc 2919
caef1a4d
RD		 2920 :param handler: A callable object to be invoked when the
2921 event is delivered to self. Pass None to
2922 disconnect an event handler.
d55e5bfc 2923
caef1a4d
RD		 2924 :param source: Sometimes the event originates from a
2925 different window than self, but you still
2926 want to catch it in self. (For example, a
2927 button event delivered to a frame.) By
2928 passing the source of the event, the event
2929 handling system is able to differentiate
2930 between the same event type from different
2931 controls.
d55e5bfc 2932
caef1a4d
RD		 2933 :param id: Used to spcify the event source by ID instead
2934 of instance.
2935
2936 :param id2: Used when it is desirable to bind a handler
2937 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD		 2938 """
2939 if source is not None:
2940 id = source.GetId()
2941 event.Bind(self, id, id2, handler)
2942
c24da6d6
RD		 2943 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2944 """
2945 Disconencts the event handler binding for event from self.
2946 Returns True if successful.
2947 """
2948 if source is not None:
2949 id = source.GetId()
2950 return event.Unbind(self, id, id2)
d55e5bfc
RD		 2951
2952
2953class EvtHandlerPtr(EvtHandler):
2954 def __init__(self, this):
2955 self.this = this
2956 if not hasattr(self,"thisown"): self.thisown = 0
2957 self.__class__ = EvtHandler
2958_core_.EvtHandler_swigregister(EvtHandlerPtr)
2959
2960#---------------------------------------------------------------------------
2961
2962class PyEventBinder(object):
2963 """
2964 Instances of this class are used to bind specific events to event
2965 handlers.
2966 """
2967 def __init__(self, evtType, expectedIDs=0):
2968 if expectedIDs not in [0, 1, 2]:
2969 raise ValueError, "Invalid number of expectedIDs"
2970 self.expectedIDs = expectedIDs
2971
2972 if type(evtType) == list or type(evtType) == tuple:
2973 self.evtType = evtType
2974 else:
2975 self.evtType = [evtType]
2976
2977
2978 def Bind(self, target, id1, id2, function):
2979 """Bind this set of event types to target."""
2980 for et in self.evtType:
2981 target.Connect(id1, id2, et, function)
2982
c24da6d6
RD		 2983
2984 def Unbind(self, target, id1, id2):
2985 """Remove an event binding."""
2986 success = 0
2987 for et in self.evtType:
2988 success += target.Disconnect(id1, id2, et)
2989 return success != 0
2990
d55e5bfc
RD		 2991
2992 def __call__(self, *args):
2993 """
2994 For backwards compatibility with the old EVT_* functions.
2995 Should be called with either (window, func), (window, ID,
2996 func) or (window, ID1, ID2, func) parameters depending on the
2997 type of the event.
2998 """
2999 assert len(args) == 2 + self.expectedIDs
3000 id1 = wx.ID_ANY
3001 id2 = wx.ID_ANY
3002 target = args[0]
3003 if self.expectedIDs == 0:
3004 func = args[1]
3005 elif self.expectedIDs == 1:
3006 id1 = args[1]
3007 func = args[2]
3008 elif self.expectedIDs == 2:
3009 id1 = args[1]
3010 id2 = args[2]
3011 func = args[3]
3012 else:
3013 raise ValueError, "Unexpected number of IDs"
3014
3015 self.Bind(target, id1, id2, func)
3016
3017
3018# These two are square pegs that don't fit the PyEventBinder hole...
3019def EVT_COMMAND(win, id, cmd, func):
3020 win.Connect(id, -1, cmd, func)
3021def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
3022 win.Connect(id1, id2, cmd, func)
3023
3024
3025#---------------------------------------------------------------------------
3026
3027#---------------------------------------------------------------------------
3028
3029EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
3030EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
3031
3032def NewEventType(*args, **kwargs):
3033 """NewEventType() -> wxEventType"""
3034 return _core_.NewEventType(*args, **kwargs)
3035wxEVT_NULL = _core_.wxEVT_NULL
3036wxEVT_FIRST = _core_.wxEVT_FIRST
3037wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
3038wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
3039wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
3040wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
3041wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
3042wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
3043wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
3044wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
3045wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
3046wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
3047wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
3048wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
3049wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
3050wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
3051wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
3052wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
3053wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
3054wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
3055wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
3056wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
3057wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
3058wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
3059wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
3060wxEVT_MOTION = _core_.wxEVT_MOTION
3061wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
3062wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
3063wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
3064wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
3065wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
3066wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
3067wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
3068wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
3069wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
3070wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
3071wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
3072wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
3073wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
3074wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
3075wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
3076wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
3077wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
3078wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
3079wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
3080wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
3081wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
3082wxEVT_CHAR = _core_.wxEVT_CHAR
3083wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
3084wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
3085wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
3086wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
3087wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
3088wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
3089wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
3090wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
3091wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
3092wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
3093wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
3094wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
3095wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
3096wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
3097wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
3098wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
3099wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
3100wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
3101wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
3102wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
3103wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
3104wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
3105wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
3106wxEVT_SIZE = _core_.wxEVT_SIZE
3107wxEVT_MOVE = _core_.wxEVT_MOVE
3108wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
3109wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
3110wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
3111wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
3112wxEVT_POWER = _core_.wxEVT_POWER
3113wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
3114wxEVT_CREATE = _core_.wxEVT_CREATE
3115wxEVT_DESTROY = _core_.wxEVT_DESTROY
3116wxEVT_SHOW = _core_.wxEVT_SHOW
3117wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
3118wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
3119wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
3120wxEVT_PAINT = _core_.wxEVT_PAINT
3121wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
3122wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
3123wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
3124wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
3125wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
3126wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
3127wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
3128wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
3129wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
3130wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
3131wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
3132wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
3133wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
3134wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
3135wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
3136wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
3137wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
3138wxEVT_IDLE = _core_.wxEVT_IDLE
3139wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
3140wxEVT_SIZING = _core_.wxEVT_SIZING
3141wxEVT_MOVING = _core_.wxEVT_MOVING
88c6b281 3142wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
d55e5bfc
RD		 3143wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
3144wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
3145wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
3146wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
3147wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
3148wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
3149wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
3150#
3151# Create some event binders
3152EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
3153EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
3154EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
3155EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
3156EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
3157EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3158EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3159EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
3160EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
3161EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
3162EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
3163EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
3164EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
3165EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
3166EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
3167EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
3168EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
3169EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
3170EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
3171EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
3172EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
3173EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
3174EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
3175EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
88c6b281 3176EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
d55e5bfc
RD		 3177EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
3178EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3179EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3180EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3181EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3182EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3183EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3184EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3185EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3186EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3187EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3188EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3189EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3190EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3191EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3192EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3193
3194EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3195EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3196EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3197EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3198EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3199EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3200EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3201EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3202EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3203EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3204EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3205EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3206EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3207
3208EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3209 wxEVT_LEFT_UP,
3210 wxEVT_MIDDLE_DOWN,
3211 wxEVT_MIDDLE_UP,
3212 wxEVT_RIGHT_DOWN,
3213 wxEVT_RIGHT_UP,
3214 wxEVT_MOTION,
3215 wxEVT_LEFT_DCLICK,
3216 wxEVT_MIDDLE_DCLICK,
3217 wxEVT_RIGHT_DCLICK,
3218 wxEVT_ENTER_WINDOW,
3219 wxEVT_LEAVE_WINDOW,
3220 wxEVT_MOUSEWHEEL
3221 ])
3222
3223
3224# Scrolling from wxWindow (sent to wxScrolledWindow)
3225EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3226 wxEVT_SCROLLWIN_BOTTOM,
3227 wxEVT_SCROLLWIN_LINEUP,
3228 wxEVT_SCROLLWIN_LINEDOWN,
3229 wxEVT_SCROLLWIN_PAGEUP,
3230 wxEVT_SCROLLWIN_PAGEDOWN,
3231 wxEVT_SCROLLWIN_THUMBTRACK,
3232 wxEVT_SCROLLWIN_THUMBRELEASE,
3233 ])
3234
3235EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3236EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3237EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3238EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3239EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3240EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3241EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3242EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3243
3244# Scrolling from wxSlider and wxScrollBar
3245EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3246 wxEVT_SCROLL_BOTTOM,
3247 wxEVT_SCROLL_LINEUP,
3248 wxEVT_SCROLL_LINEDOWN,
3249 wxEVT_SCROLL_PAGEUP,
3250 wxEVT_SCROLL_PAGEDOWN,
3251 wxEVT_SCROLL_THUMBTRACK,
3252 wxEVT_SCROLL_THUMBRELEASE,
3253 wxEVT_SCROLL_ENDSCROLL,
3254 ])
3255
3256EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3257EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3258EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3259EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3260EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3261EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3262EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3263EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3264EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3265
3266# Scrolling from wxSlider and wxScrollBar, with an id
3267EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3268 wxEVT_SCROLL_BOTTOM,
3269 wxEVT_SCROLL_LINEUP,
3270 wxEVT_SCROLL_LINEDOWN,
3271 wxEVT_SCROLL_PAGEUP,
3272 wxEVT_SCROLL_PAGEDOWN,
3273 wxEVT_SCROLL_THUMBTRACK,
3274 wxEVT_SCROLL_THUMBRELEASE,
3275 wxEVT_SCROLL_ENDSCROLL,
3276 ], 1)
3277
3278EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3279EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3280EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3281EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3282EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3283EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3284EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3285EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3286EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3287
3288EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3289EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3290EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3291EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3292EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3293EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3294EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3295EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3296EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3297EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3298
3299EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3300EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3301EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3302EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3303EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3304EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3305EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3306EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3307EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3308
3309
3310EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3311EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3312EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3313EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3314EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3315EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3316EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3317
3318EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3319
3320EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3321EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3322
3323EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3324
3325
3326
3327#---------------------------------------------------------------------------
3328
3329class Event(Object):
093d3ff1 3330 """Proxy of C++ Event class"""
d55e5bfc
RD		 3331 def __init__(self): raise RuntimeError, "No constructor defined"
3332 def __repr__(self):
3333 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3334 def __del__(self, destroy=_core_.delete_Event):
3335 """__del__(self)"""
3336 try:
3337 if self.thisown: destroy(self)
3338 except: pass
3339
3340 def SetEventType(*args, **kwargs):
3341 """SetEventType(self, wxEventType typ)"""
3342 return _core_.Event_SetEventType(*args, **kwargs)
3343
3344 def GetEventType(*args, **kwargs):
3345 """GetEventType(self) -> wxEventType"""
3346 return _core_.Event_GetEventType(*args, **kwargs)
3347
3348 def GetEventObject(*args, **kwargs):
3349 """GetEventObject(self) -> Object"""
3350 return _core_.Event_GetEventObject(*args, **kwargs)
3351
3352 def SetEventObject(*args, **kwargs):
3353 """SetEventObject(self, Object obj)"""
3354 return _core_.Event_SetEventObject(*args, **kwargs)
3355
3356 def GetTimestamp(*args, **kwargs):
3357 """GetTimestamp(self) -> long"""
3358 return _core_.Event_GetTimestamp(*args, **kwargs)
3359
3360 def SetTimestamp(*args, **kwargs):
3361 """SetTimestamp(self, long ts=0)"""
3362 return _core_.Event_SetTimestamp(*args, **kwargs)
3363
3364 def GetId(*args, **kwargs):
3365 """GetId(self) -> int"""
3366 return _core_.Event_GetId(*args, **kwargs)
3367
3368 def SetId(*args, **kwargs):
3369 """SetId(self, int Id)"""
3370 return _core_.Event_SetId(*args, **kwargs)
3371
3372 def IsCommandEvent(*args, **kwargs):
3373 """IsCommandEvent(self) -> bool"""
3374 return _core_.Event_IsCommandEvent(*args, **kwargs)
3375
3376 def Skip(*args, **kwargs):
51b83b37
RD		 3377 """
3378 Skip(self, bool skip=True)
3379
3380 Called by an event handler, it controls whether additional event
3381 handlers bound to this event will be called after the current event
3382 handler returns. Skip(false) (the default setting) will prevent
3383 additional event handlers from being called and control will be
3384 returned to the sender of the event immediately after the current
3385 handler has finished. Skip(True) will cause the event processing
3386 system to continue searching for a handler function for this event.
3387
3388 """
d55e5bfc
RD		 3389 return _core_.Event_Skip(*args, **kwargs)
3390
3391 def GetSkipped(*args, **kwargs):
3392 """GetSkipped(self) -> bool"""
3393 return _core_.Event_GetSkipped(*args, **kwargs)
3394
3395 def ShouldPropagate(*args, **kwargs):
3396 """ShouldPropagate(self) -> bool"""
3397 return _core_.Event_ShouldPropagate(*args, **kwargs)
3398
3399 def StopPropagation(*args, **kwargs):
3400 """StopPropagation(self) -> int"""
3401 return _core_.Event_StopPropagation(*args, **kwargs)
3402
3403 def ResumePropagation(*args, **kwargs):
3404 """ResumePropagation(self, int propagationLevel)"""
3405 return _core_.Event_ResumePropagation(*args, **kwargs)
3406
3407 def Clone(*args, **kwargs):
3408 """Clone(self) -> Event"""
3409 return _core_.Event_Clone(*args, **kwargs)
3410
3411
3412class EventPtr(Event):
3413 def __init__(self, this):
3414 self.this = this
3415 if not hasattr(self,"thisown"): self.thisown = 0
3416 self.__class__ = Event
3417_core_.Event_swigregister(EventPtr)
3418
3419#---------------------------------------------------------------------------
3420
3421class PropagationDisabler(object):
093d3ff1 3422 """Proxy of C++ PropagationDisabler class"""
d55e5bfc
RD		 3423 def __repr__(self):
3424 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3425 def __init__(self, *args, **kwargs):
3426 """__init__(self, Event event) -> PropagationDisabler"""
3427 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
3428 self.this = newobj.this
3429 self.thisown = 1
3430 del newobj.thisown
3431 def __del__(self, destroy=_core_.delete_PropagationDisabler):
3432 """__del__(self)"""
3433 try:
3434 if self.thisown: destroy(self)
3435 except: pass
3436
3437
3438class PropagationDisablerPtr(PropagationDisabler):
3439 def __init__(self, this):
3440 self.this = this
3441 if not hasattr(self,"thisown"): self.thisown = 0
3442 self.__class__ = PropagationDisabler
3443_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
3444
3445class PropagateOnce(object):
093d3ff1 3446 """Proxy of C++ PropagateOnce class"""
d55e5bfc
RD		 3447 def __repr__(self):
3448 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3449 def __init__(self, *args, **kwargs):
3450 """__init__(self, Event event) -> PropagateOnce"""
3451 newobj = _core_.new_PropagateOnce(*args, **kwargs)
3452 self.this = newobj.this
3453 self.thisown = 1
3454 del newobj.thisown
3455 def __del__(self, destroy=_core_.delete_PropagateOnce):
3456 """__del__(self)"""
3457 try:
3458 if self.thisown: destroy(self)
3459 except: pass
3460
3461
3462class PropagateOncePtr(PropagateOnce):
3463 def __init__(self, this):
3464 self.this = this
3465 if not hasattr(self,"thisown"): self.thisown = 0
3466 self.__class__ = PropagateOnce
3467_core_.PropagateOnce_swigregister(PropagateOncePtr)
3468
3469#---------------------------------------------------------------------------
3470
3471class CommandEvent(Event):
093d3ff1 3472 """Proxy of C++ CommandEvent class"""
d55e5bfc
RD		 3473 def __repr__(self):
3474 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3475 def __init__(self, *args, **kwargs):
3476 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
3477 newobj = _core_.new_CommandEvent(*args, **kwargs)
3478 self.this = newobj.this
3479 self.thisown = 1
3480 del newobj.thisown
3481 def GetSelection(*args, **kwargs):
3482 """GetSelection(self) -> int"""
3483 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3484
3485 def SetString(*args, **kwargs):
3486 """SetString(self, String s)"""
3487 return _core_.CommandEvent_SetString(*args, **kwargs)
3488
3489 def GetString(*args, **kwargs):
3490 """GetString(self) -> String"""
3491 return _core_.CommandEvent_GetString(*args, **kwargs)
3492
3493 def IsChecked(*args, **kwargs):
3494 """IsChecked(self) -> bool"""
3495 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3496
3497 Checked = IsChecked
3498 def IsSelection(*args, **kwargs):
3499 """IsSelection(self) -> bool"""
3500 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3501
3502 def SetExtraLong(*args, **kwargs):
3503 """SetExtraLong(self, long extraLong)"""
3504 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3505
3506 def GetExtraLong(*args, **kwargs):
3507 """GetExtraLong(self) -> long"""
3508 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3509
3510 def SetInt(*args, **kwargs):
3511 """SetInt(self, int i)"""
3512 return _core_.CommandEvent_SetInt(*args, **kwargs)
3513
3514 def GetInt(*args, **kwargs):
3515 """GetInt(self) -> long"""
3516 return _core_.CommandEvent_GetInt(*args, **kwargs)
3517
3518 def Clone(*args, **kwargs):
3519 """Clone(self) -> Event"""
3520 return _core_.CommandEvent_Clone(*args, **kwargs)
3521
3522
3523class CommandEventPtr(CommandEvent):
3524 def __init__(self, this):
3525 self.this = this
3526 if not hasattr(self,"thisown"): self.thisown = 0
3527 self.__class__ = CommandEvent
3528_core_.CommandEvent_swigregister(CommandEventPtr)
3529
3530#---------------------------------------------------------------------------
3531
3532class NotifyEvent(CommandEvent):
093d3ff1 3533 """Proxy of C++ NotifyEvent class"""
d55e5bfc
RD		 3534 def __repr__(self):
3535 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3536 def __init__(self, *args, **kwargs):
3537 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
3538 newobj = _core_.new_NotifyEvent(*args, **kwargs)
3539 self.this = newobj.this
3540 self.thisown = 1
3541 del newobj.thisown
3542 def Veto(*args, **kwargs):
3543 """Veto(self)"""
3544 return _core_.NotifyEvent_Veto(*args, **kwargs)
3545
3546 def Allow(*args, **kwargs):
3547 """Allow(self)"""
3548 return _core_.NotifyEvent_Allow(*args, **kwargs)
3549
3550 def IsAllowed(*args, **kwargs):
3551 """IsAllowed(self) -> bool"""
3552 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
3553
3554
3555class NotifyEventPtr(NotifyEvent):
3556 def __init__(self, this):
3557 self.this = this
3558 if not hasattr(self,"thisown"): self.thisown = 0
3559 self.__class__ = NotifyEvent
3560_core_.NotifyEvent_swigregister(NotifyEventPtr)
3561
3562#---------------------------------------------------------------------------
3563
3564class ScrollEvent(CommandEvent):
093d3ff1 3565 """Proxy of C++ ScrollEvent class"""
d55e5bfc
RD		 3566 def __repr__(self):
3567 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3568 def __init__(self, *args, **kwargs):
3569 """
3570 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
3571 int orient=0) -> ScrollEvent
3572 """
3573 newobj = _core_.new_ScrollEvent(*args, **kwargs)
3574 self.this = newobj.this
3575 self.thisown = 1
3576 del newobj.thisown
3577 def GetOrientation(*args, **kwargs):
3578 """GetOrientation(self) -> int"""
3579 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
3580
3581 def GetPosition(*args, **kwargs):
3582 """GetPosition(self) -> int"""
3583 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
3584
3585 def SetOrientation(*args, **kwargs):
3586 """SetOrientation(self, int orient)"""
3587 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
3588
3589 def SetPosition(*args, **kwargs):
3590 """SetPosition(self, int pos)"""
3591 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
3592
3593
3594class ScrollEventPtr(ScrollEvent):
3595 def __init__(self, this):
3596 self.this = this
3597 if not hasattr(self,"thisown"): self.thisown = 0
3598 self.__class__ = ScrollEvent
3599_core_.ScrollEvent_swigregister(ScrollEventPtr)
3600
3601#---------------------------------------------------------------------------
3602
3603class ScrollWinEvent(Event):
093d3ff1 3604 """Proxy of C++ ScrollWinEvent class"""
d55e5bfc
RD		 3605 def __repr__(self):
3606 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3607 def __init__(self, *args, **kwargs):
3608 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
3609 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
3610 self.this = newobj.this
3611 self.thisown = 1
3612 del newobj.thisown
3613 def GetOrientation(*args, **kwargs):
3614 """GetOrientation(self) -> int"""
3615 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
3616
3617 def GetPosition(*args, **kwargs):
3618 """GetPosition(self) -> int"""
3619 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
3620
3621 def SetOrientation(*args, **kwargs):
3622 """SetOrientation(self, int orient)"""
3623 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
3624
3625 def SetPosition(*args, **kwargs):
3626 """SetPosition(self, int pos)"""
3627 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
3628
3629
3630class ScrollWinEventPtr(ScrollWinEvent):
3631 def __init__(self, this):
3632 self.this = this
3633 if not hasattr(self,"thisown"): self.thisown = 0
3634 self.__class__ = ScrollWinEvent
3635_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
3636
3637#---------------------------------------------------------------------------
3638
3639MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3640MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3641MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3642MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3643MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
3644class MouseEvent(Event):
093d3ff1 3645 """Proxy of C++ MouseEvent class"""
d55e5bfc
RD		 3646 def __repr__(self):
3647 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3648 def __init__(self, *args, **kwargs):
3649 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
3650 newobj = _core_.new_MouseEvent(*args, **kwargs)
3651 self.this = newobj.this
3652 self.thisown = 1
3653 del newobj.thisown
3654 def IsButton(*args, **kwargs):
3655 """IsButton(self) -> bool"""
3656 return _core_.MouseEvent_IsButton(*args, **kwargs)
3657
3658 def ButtonDown(*args, **kwargs):
3659 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
3660 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
3661
3662 def ButtonDClick(*args, **kwargs):
3663 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
3664 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
3665
3666 def ButtonUp(*args, **kwargs):
3667 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
3668 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
3669
3670 def Button(*args, **kwargs):
3671 """Button(self, int but) -> bool"""
3672 return _core_.MouseEvent_Button(*args, **kwargs)
3673
3674 def ButtonIsDown(*args, **kwargs):
3675 """ButtonIsDown(self, int but) -> bool"""
3676 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
3677
3678 def GetButton(*args, **kwargs):
3679 """GetButton(self) -> int"""
3680 return _core_.MouseEvent_GetButton(*args, **kwargs)
3681
3682 def ControlDown(*args, **kwargs):
3683 """ControlDown(self) -> bool"""
3684 return _core_.MouseEvent_ControlDown(*args, **kwargs)
3685
3686 def MetaDown(*args, **kwargs):
3687 """MetaDown(self) -> bool"""
3688 return _core_.MouseEvent_MetaDown(*args, **kwargs)
3689
3690 def AltDown(*args, **kwargs):
3691 """AltDown(self) -> bool"""
3692 return _core_.MouseEvent_AltDown(*args, **kwargs)
3693
3694 def ShiftDown(*args, **kwargs):
3695 """ShiftDown(self) -> bool"""
3696 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
3697
412d302d
RD		 3698 def CmdDown(*args, **kwargs):
3699 """
3700 CmdDown(self) -> bool
3701
3702 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3703 platforms but the special "Apple" (a.k.a as "Command") key on
3704 Macs: it makes often sense to use it instead of, say, `ControlDown`
3705 because Cmd key is used for the same thing under Mac as Ctrl
3706 elsewhere. The Ctrl still exists, it's just not used for this
3707 purpose. So for non-Mac platforms this is the same as `ControlDown`
3708 and Macs this is the same as `MetaDown`.
3709 """
3710 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3711
d55e5bfc
RD		 3712 def LeftDown(*args, **kwargs):
3713 """LeftDown(self) -> bool"""
3714 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3715
3716 def MiddleDown(*args, **kwargs):
3717 """MiddleDown(self) -> bool"""
3718 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3719
3720 def RightDown(*args, **kwargs):
3721 """RightDown(self) -> bool"""
3722 return _core_.MouseEvent_RightDown(*args, **kwargs)
3723
3724 def LeftUp(*args, **kwargs):
3725 """LeftUp(self) -> bool"""
3726 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3727
3728 def MiddleUp(*args, **kwargs):
3729 """MiddleUp(self) -> bool"""
3730 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3731
3732 def RightUp(*args, **kwargs):
3733 """RightUp(self) -> bool"""
3734 return _core_.MouseEvent_RightUp(*args, **kwargs)
3735
3736 def LeftDClick(*args, **kwargs):
3737 """LeftDClick(self) -> bool"""
3738 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3739
3740 def MiddleDClick(*args, **kwargs):
3741 """MiddleDClick(self) -> bool"""
3742 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3743
3744 def RightDClick(*args, **kwargs):
3745 """RightDClick(self) -> bool"""
3746 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3747
3748 def LeftIsDown(*args, **kwargs):
3749 """LeftIsDown(self) -> bool"""
3750 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3751
3752 def MiddleIsDown(*args, **kwargs):
3753 """MiddleIsDown(self) -> bool"""
3754 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3755
3756 def RightIsDown(*args, **kwargs):
3757 """RightIsDown(self) -> bool"""
3758 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3759
3760 def Dragging(*args, **kwargs):
3761 """Dragging(self) -> bool"""
3762 return _core_.MouseEvent_Dragging(*args, **kwargs)
3763
3764 def Moving(*args, **kwargs):
3765 """Moving(self) -> bool"""
3766 return _core_.MouseEvent_Moving(*args, **kwargs)
3767
3768 def Entering(*args, **kwargs):
3769 """Entering(self) -> bool"""
3770 return _core_.MouseEvent_Entering(*args, **kwargs)
3771
3772 def Leaving(*args, **kwargs):
3773 """Leaving(self) -> bool"""
3774 return _core_.MouseEvent_Leaving(*args, **kwargs)
3775
3776 def GetPosition(*args, **kwargs):
3777 """
3778 GetPosition(self) -> Point
3779
79fccf9d
RD		 3780 Returns the position of the mouse in window coordinates when the event
3781 happened.
d55e5bfc
RD		 3782 """
3783 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3784
3785 def GetPositionTuple(*args, **kwargs):
3786 """
3787 GetPositionTuple() -> (x,y)
3788
79fccf9d
RD		 3789 Returns the position of the mouse in window coordinates when the event
3790 happened.
d55e5bfc
RD		 3791 """
3792 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3793
3794 def GetLogicalPosition(*args, **kwargs):
3795 """GetLogicalPosition(self, DC dc) -> Point"""
3796 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3797
3798 def GetX(*args, **kwargs):
3799 """GetX(self) -> int"""
3800 return _core_.MouseEvent_GetX(*args, **kwargs)
3801
3802 def GetY(*args, **kwargs):
3803 """GetY(self) -> int"""
3804 return _core_.MouseEvent_GetY(*args, **kwargs)
3805
3806 def GetWheelRotation(*args, **kwargs):
3807 """GetWheelRotation(self) -> int"""
3808 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3809
3810 def GetWheelDelta(*args, **kwargs):
3811 """GetWheelDelta(self) -> int"""
3812 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3813
3814 def GetLinesPerAction(*args, **kwargs):
3815 """GetLinesPerAction(self) -> int"""
3816 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3817
3818 def IsPageScroll(*args, **kwargs):
3819 """IsPageScroll(self) -> bool"""
3820 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3821
3822 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3823 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3824 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3825 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3826 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3827 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3828 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3829 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3830 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3831 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3832 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3833 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3834
3835class MouseEventPtr(MouseEvent):
3836 def __init__(self, this):
3837 self.this = this
3838 if not hasattr(self,"thisown"): self.thisown = 0
3839 self.__class__ = MouseEvent
3840_core_.MouseEvent_swigregister(MouseEventPtr)
3841
3842#---------------------------------------------------------------------------
3843
3844class SetCursorEvent(Event):
093d3ff1 3845 """Proxy of C++ SetCursorEvent class"""
d55e5bfc
RD		 3846 def __repr__(self):
3847 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3848 def __init__(self, *args, **kwargs):
3849 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3850 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3851 self.this = newobj.this
3852 self.thisown = 1
3853 del newobj.thisown
3854 def GetX(*args, **kwargs):
3855 """GetX(self) -> int"""
3856 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3857
3858 def GetY(*args, **kwargs):
3859 """GetY(self) -> int"""
3860 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3861
3862 def SetCursor(*args, **kwargs):
3863 """SetCursor(self, Cursor cursor)"""
3864 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3865
3866 def GetCursor(*args, **kwargs):
3867 """GetCursor(self) -> Cursor"""
3868 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3869
3870 def HasCursor(*args, **kwargs):
3871 """HasCursor(self) -> bool"""
3872 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3873
3874
3875class SetCursorEventPtr(SetCursorEvent):
3876 def __init__(self, this):
3877 self.this = this
3878 if not hasattr(self,"thisown"): self.thisown = 0
3879 self.__class__ = SetCursorEvent
3880_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3881
3882#---------------------------------------------------------------------------
3883
3884class KeyEvent(Event):
093d3ff1 3885 """Proxy of C++ KeyEvent class"""
d55e5bfc
RD		 3886 def __repr__(self):
3887 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3888 def __init__(self, *args, **kwargs):
3889 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3890 newobj = _core_.new_KeyEvent(*args, **kwargs)
3891 self.this = newobj.this
3892 self.thisown = 1
3893 del newobj.thisown
3894 def ControlDown(*args, **kwargs):
3895 """ControlDown(self) -> bool"""
3896 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3897
3898 def MetaDown(*args, **kwargs):
3899 """MetaDown(self) -> bool"""
3900 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3901
3902 def AltDown(*args, **kwargs):
3903 """AltDown(self) -> bool"""
3904 return _core_.KeyEvent_AltDown(*args, **kwargs)
3905
3906 def ShiftDown(*args, **kwargs):
3907 """ShiftDown(self) -> bool"""
3908 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3909
412d302d
RD		 3910 def CmdDown(*args, **kwargs):
3911 """
3912 CmdDown(self) -> bool
3913
3914 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3915 platforms but the special "Apple" (a.k.a as "Command") key on
3916 Macs: it makes often sense to use it instead of, say, `ControlDown`
3917 because Cmd key is used for the same thing under Mac as Ctrl
3918 elsewhere. The Ctrl still exists, it's just not used for this
3919 purpose. So for non-Mac platforms this is the same as `ControlDown`
3920 and Macs this is the same as `MetaDown`.
3921 """
3922 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3923
d55e5bfc
RD		 3924 def HasModifiers(*args, **kwargs):
3925 """HasModifiers(self) -> bool"""
3926 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3927
3928 def GetKeyCode(*args, **kwargs):
3929 """GetKeyCode(self) -> int"""
3930 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3931
3932 KeyCode = GetKeyCode
19272049
RD		 3933 def GetUnicodeKey(*args, **kwargs):
3934 """GetUnicodeKey(self) -> int"""
3935 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 3936
19272049 3937 GetUniChar = GetUnicodeKey
d55e5bfc
RD		 3938 def GetRawKeyCode(*args, **kwargs):
3939 """GetRawKeyCode(self) -> unsigned int"""
3940 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3941
3942 def GetRawKeyFlags(*args, **kwargs):
3943 """GetRawKeyFlags(self) -> unsigned int"""
3944 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3945
3946 def GetPosition(*args, **kwargs):
3947 """
3948 GetPosition(self) -> Point
3949
3950 Find the position of the event.
3951 """
3952 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3953
3954 def GetPositionTuple(*args, **kwargs):
3955 """
3956 GetPositionTuple() -> (x,y)
3957
3958 Find the position of the event.
3959 """
3960 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3961
3962 def GetX(*args, **kwargs):
3963 """GetX(self) -> int"""
3964 return _core_.KeyEvent_GetX(*args, **kwargs)
3965
3966 def GetY(*args, **kwargs):
3967 """GetY(self) -> int"""
3968 return _core_.KeyEvent_GetY(*args, **kwargs)
3969
3970 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3971 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3972 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3973 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3974 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3975 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3976 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3977 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3978 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3979 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3980
3981class KeyEventPtr(KeyEvent):
3982 def __init__(self, this):
3983 self.this = this
3984 if not hasattr(self,"thisown"): self.thisown = 0
3985 self.__class__ = KeyEvent
3986_core_.KeyEvent_swigregister(KeyEventPtr)
3987
3988#---------------------------------------------------------------------------
3989
3990class SizeEvent(Event):
093d3ff1 3991 """Proxy of C++ SizeEvent class"""
d55e5bfc
RD		 3992 def __repr__(self):
3993 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3994 def __init__(self, *args, **kwargs):
3995 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3996 newobj = _core_.new_SizeEvent(*args, **kwargs)
3997 self.this = newobj.this
3998 self.thisown = 1
3999 del newobj.thisown
4000 def GetSize(*args, **kwargs):
4001 """GetSize(self) -> Size"""
4002 return _core_.SizeEvent_GetSize(*args, **kwargs)
4003
4004 def GetRect(*args, **kwargs):
4005 """GetRect(self) -> Rect"""
4006 return _core_.SizeEvent_GetRect(*args, **kwargs)
4007
4008 def SetRect(*args, **kwargs):
4009 """SetRect(self, Rect rect)"""
4010 return _core_.SizeEvent_SetRect(*args, **kwargs)
4011
4012 def SetSize(*args, **kwargs):
4013 """SetSize(self, Size size)"""
4014 return _core_.SizeEvent_SetSize(*args, **kwargs)
4015
4016 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
4017 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
4018
4019class SizeEventPtr(SizeEvent):
4020 def __init__(self, this):
4021 self.this = this
4022 if not hasattr(self,"thisown"): self.thisown = 0
4023 self.__class__ = SizeEvent
4024_core_.SizeEvent_swigregister(SizeEventPtr)
4025
4026#---------------------------------------------------------------------------
4027
4028class MoveEvent(Event):
093d3ff1 4029 """Proxy of C++ MoveEvent class"""
d55e5bfc
RD		 4030 def __repr__(self):
4031 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4032 def __init__(self, *args, **kwargs):
4033 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
4034 newobj = _core_.new_MoveEvent(*args, **kwargs)
4035 self.this = newobj.this
4036 self.thisown = 1
4037 del newobj.thisown
4038 def GetPosition(*args, **kwargs):
4039 """GetPosition(self) -> Point"""
4040 return _core_.MoveEvent_GetPosition(*args, **kwargs)
4041
4042 def GetRect(*args, **kwargs):
4043 """GetRect(self) -> Rect"""
4044 return _core_.MoveEvent_GetRect(*args, **kwargs)
4045
4046 def SetRect(*args, **kwargs):
4047 """SetRect(self, Rect rect)"""
4048 return _core_.MoveEvent_SetRect(*args, **kwargs)
4049
4050 def SetPosition(*args, **kwargs):
4051 """SetPosition(self, Point pos)"""
4052 return _core_.MoveEvent_SetPosition(*args, **kwargs)
4053
fef4c27a
RD		 4054 m_pos = property(GetPosition, SetPosition)
4055 m_rect = property(GetRect, SetRect)
4056
d55e5bfc
RD		 4057
4058class MoveEventPtr(MoveEvent):
4059 def __init__(self, this):
4060 self.this = this
4061 if not hasattr(self,"thisown"): self.thisown = 0
4062 self.__class__ = MoveEvent
4063_core_.MoveEvent_swigregister(MoveEventPtr)
4064
4065#---------------------------------------------------------------------------
4066
4067class PaintEvent(Event):
093d3ff1 4068 """Proxy of C++ PaintEvent class"""
d55e5bfc
RD		 4069 def __repr__(self):
4070 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4071 def __init__(self, *args, **kwargs):
4072 """__init__(self, int Id=0) -> PaintEvent"""
4073 newobj = _core_.new_PaintEvent(*args, **kwargs)
4074 self.this = newobj.this
4075 self.thisown = 1
4076 del newobj.thisown
4077
4078class PaintEventPtr(PaintEvent):
4079 def __init__(self, this):
4080 self.this = this
4081 if not hasattr(self,"thisown"): self.thisown = 0
4082 self.__class__ = PaintEvent
4083_core_.PaintEvent_swigregister(PaintEventPtr)
4084
4085class NcPaintEvent(Event):
093d3ff1 4086 """Proxy of C++ NcPaintEvent class"""
d55e5bfc
RD		 4087 def __repr__(self):
4088 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4089 def __init__(self, *args, **kwargs):
4090 """__init__(self, int winid=0) -> NcPaintEvent"""
4091 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
4092 self.this = newobj.this
4093 self.thisown = 1
4094 del newobj.thisown
4095
4096class NcPaintEventPtr(NcPaintEvent):
4097 def __init__(self, this):
4098 self.this = this
4099 if not hasattr(self,"thisown"): self.thisown = 0
4100 self.__class__ = NcPaintEvent
4101_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
4102
4103#---------------------------------------------------------------------------
4104
4105class EraseEvent(Event):
093d3ff1 4106 """Proxy of C++ EraseEvent class"""
d55e5bfc
RD		 4107 def __repr__(self):
4108 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4109 def __init__(self, *args, **kwargs):
4110 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
4111 newobj = _core_.new_EraseEvent(*args, **kwargs)
4112 self.this = newobj.this
4113 self.thisown = 1
4114 del newobj.thisown
4115 def GetDC(*args, **kwargs):
4116 """GetDC(self) -> DC"""
4117 return _core_.EraseEvent_GetDC(*args, **kwargs)
4118
4119
4120class EraseEventPtr(EraseEvent):
4121 def __init__(self, this):
4122 self.this = this
4123 if not hasattr(self,"thisown"): self.thisown = 0
4124 self.__class__ = EraseEvent
4125_core_.EraseEvent_swigregister(EraseEventPtr)
4126
4127#---------------------------------------------------------------------------
4128
4129class FocusEvent(Event):
093d3ff1 4130 """Proxy of C++ FocusEvent class"""
d55e5bfc
RD		 4131 def __repr__(self):
4132 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4133 def __init__(self, *args, **kwargs):
4134 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
4135 newobj = _core_.new_FocusEvent(*args, **kwargs)
4136 self.this = newobj.this
4137 self.thisown = 1
4138 del newobj.thisown
4139 def GetWindow(*args, **kwargs):
4140 """GetWindow(self) -> Window"""
4141 return _core_.FocusEvent_GetWindow(*args, **kwargs)
4142
4143 def SetWindow(*args, **kwargs):
4144 """SetWindow(self, Window win)"""
4145 return _core_.FocusEvent_SetWindow(*args, **kwargs)
4146
4147
4148class FocusEventPtr(FocusEvent):
4149 def __init__(self, this):
4150 self.this = this
4151 if not hasattr(self,"thisown"): self.thisown = 0
4152 self.__class__ = FocusEvent
4153_core_.FocusEvent_swigregister(FocusEventPtr)
4154
4155#---------------------------------------------------------------------------
4156
4157class ChildFocusEvent(CommandEvent):
093d3ff1 4158 """Proxy of C++ ChildFocusEvent class"""
d55e5bfc
RD		 4159 def __repr__(self):
4160 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4161 def __init__(self, *args, **kwargs):
4162 """__init__(self, Window win=None) -> ChildFocusEvent"""
4163 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
4164 self.this = newobj.this
4165 self.thisown = 1
4166 del newobj.thisown
4167 def GetWindow(*args, **kwargs):
4168 """GetWindow(self) -> Window"""
4169 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
4170
4171
4172class ChildFocusEventPtr(ChildFocusEvent):
4173 def __init__(self, this):
4174 self.this = this
4175 if not hasattr(self,"thisown"): self.thisown = 0
4176 self.__class__ = ChildFocusEvent
4177_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
4178
4179#---------------------------------------------------------------------------
4180
4181class ActivateEvent(Event):
093d3ff1 4182 """Proxy of C++ ActivateEvent class"""
d55e5bfc
RD		 4183 def __repr__(self):
4184 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4185 def __init__(self, *args, **kwargs):
4186 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
4187 newobj = _core_.new_ActivateEvent(*args, **kwargs)
4188 self.this = newobj.this
4189 self.thisown = 1
4190 del newobj.thisown
4191 def GetActive(*args, **kwargs):
4192 """GetActive(self) -> bool"""
4193 return _core_.ActivateEvent_GetActive(*args, **kwargs)
4194
4195
4196class ActivateEventPtr(ActivateEvent):
4197 def __init__(self, this):
4198 self.this = this
4199 if not hasattr(self,"thisown"): self.thisown = 0
4200 self.__class__ = ActivateEvent
4201_core_.ActivateEvent_swigregister(ActivateEventPtr)
4202
4203#---------------------------------------------------------------------------
4204
4205class InitDialogEvent(Event):
093d3ff1 4206 """Proxy of C++ InitDialogEvent class"""
d55e5bfc
RD		 4207 def __repr__(self):
4208 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4209 def __init__(self, *args, **kwargs):
4210 """__init__(self, int Id=0) -> InitDialogEvent"""
4211 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
4212 self.this = newobj.this
4213 self.thisown = 1
4214 del newobj.thisown
4215
4216class InitDialogEventPtr(InitDialogEvent):
4217 def __init__(self, this):
4218 self.this = this
4219 if not hasattr(self,"thisown"): self.thisown = 0
4220 self.__class__ = InitDialogEvent
4221_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
4222
4223#---------------------------------------------------------------------------
4224
4225class MenuEvent(Event):
093d3ff1 4226 """Proxy of C++ MenuEvent class"""
d55e5bfc
RD		 4227 def __repr__(self):
4228 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4229 def __init__(self, *args, **kwargs):
4230 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
4231 newobj = _core_.new_MenuEvent(*args, **kwargs)
4232 self.this = newobj.this
4233 self.thisown = 1
4234 del newobj.thisown
4235 def GetMenuId(*args, **kwargs):
4236 """GetMenuId(self) -> int"""
4237 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
4238
4239 def IsPopup(*args, **kwargs):
4240 """IsPopup(self) -> bool"""
4241 return _core_.MenuEvent_IsPopup(*args, **kwargs)
4242
4243 def GetMenu(*args, **kwargs):
4244 """GetMenu(self) -> Menu"""
4245 return _core_.MenuEvent_GetMenu(*args, **kwargs)
4246
4247
4248class MenuEventPtr(MenuEvent):
4249 def __init__(self, this):
4250 self.this = this
4251 if not hasattr(self,"thisown"): self.thisown = 0
4252 self.__class__ = MenuEvent
4253_core_.MenuEvent_swigregister(MenuEventPtr)
4254
4255#---------------------------------------------------------------------------
4256
4257class CloseEvent(Event):
093d3ff1 4258 """Proxy of C++ CloseEvent class"""
d55e5bfc
RD		 4259 def __repr__(self):
4260 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4261 def __init__(self, *args, **kwargs):
4262 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
4263 newobj = _core_.new_CloseEvent(*args, **kwargs)
4264 self.this = newobj.this
4265 self.thisown = 1
4266 del newobj.thisown
4267 def SetLoggingOff(*args, **kwargs):
4268 """SetLoggingOff(self, bool logOff)"""
4269 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
4270
4271 def GetLoggingOff(*args, **kwargs):
4272 """GetLoggingOff(self) -> bool"""
4273 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
4274
4275 def Veto(*args, **kwargs):
4276 """Veto(self, bool veto=True)"""
4277 return _core_.CloseEvent_Veto(*args, **kwargs)
4278
4279 def SetCanVeto(*args, **kwargs):
4280 """SetCanVeto(self, bool canVeto)"""
4281 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
4282
4283 def CanVeto(*args, **kwargs):
4284 """CanVeto(self) -> bool"""
4285 return _core_.CloseEvent_CanVeto(*args, **kwargs)
4286
4287 def GetVeto(*args, **kwargs):
4288 """GetVeto(self) -> bool"""
4289 return _core_.CloseEvent_GetVeto(*args, **kwargs)
4290
4291
4292class CloseEventPtr(CloseEvent):
4293 def __init__(self, this):
4294 self.this = this
4295 if not hasattr(self,"thisown"): self.thisown = 0
4296 self.__class__ = CloseEvent
4297_core_.CloseEvent_swigregister(CloseEventPtr)
4298
4299#---------------------------------------------------------------------------
4300
4301class ShowEvent(Event):
093d3ff1 4302 """Proxy of C++ ShowEvent class"""
d55e5bfc
RD		 4303 def __repr__(self):
4304 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4305 def __init__(self, *args, **kwargs):
4306 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
4307 newobj = _core_.new_ShowEvent(*args, **kwargs)
4308 self.this = newobj.this
4309 self.thisown = 1
4310 del newobj.thisown
4311 def SetShow(*args, **kwargs):
4312 """SetShow(self, bool show)"""
4313 return _core_.ShowEvent_SetShow(*args, **kwargs)
4314
4315 def GetShow(*args, **kwargs):
4316 """GetShow(self) -> bool"""
4317 return _core_.ShowEvent_GetShow(*args, **kwargs)
4318
4319
4320class ShowEventPtr(ShowEvent):
4321 def __init__(self, this):
4322 self.this = this
4323 if not hasattr(self,"thisown"): self.thisown = 0
4324 self.__class__ = ShowEvent
4325_core_.ShowEvent_swigregister(ShowEventPtr)
4326
4327#---------------------------------------------------------------------------
4328
4329class IconizeEvent(Event):
093d3ff1 4330 """Proxy of C++ IconizeEvent class"""
d55e5bfc
RD		 4331 def __repr__(self):
4332 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4333 def __init__(self, *args, **kwargs):
4334 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
4335 newobj = _core_.new_IconizeEvent(*args, **kwargs)
4336 self.this = newobj.this
4337 self.thisown = 1
4338 del newobj.thisown
4339 def Iconized(*args, **kwargs):
4340 """Iconized(self) -> bool"""
4341 return _core_.IconizeEvent_Iconized(*args, **kwargs)
4342
4343
4344class IconizeEventPtr(IconizeEvent):
4345 def __init__(self, this):
4346 self.this = this
4347 if not hasattr(self,"thisown"): self.thisown = 0
4348 self.__class__ = IconizeEvent
4349_core_.IconizeEvent_swigregister(IconizeEventPtr)
4350
4351#---------------------------------------------------------------------------
4352
4353class MaximizeEvent(Event):
093d3ff1 4354 """Proxy of C++ MaximizeEvent class"""
d55e5bfc
RD		 4355 def __repr__(self):
4356 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4357 def __init__(self, *args, **kwargs):
4358 """__init__(self, int id=0) -> MaximizeEvent"""
4359 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
4360 self.this = newobj.this
4361 self.thisown = 1
4362 del newobj.thisown
4363
4364class MaximizeEventPtr(MaximizeEvent):
4365 def __init__(self, this):
4366 self.this = this
4367 if not hasattr(self,"thisown"): self.thisown = 0
4368 self.__class__ = MaximizeEvent
4369_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4370
4371#---------------------------------------------------------------------------
4372
4373class DropFilesEvent(Event):
093d3ff1 4374 """Proxy of C++ DropFilesEvent class"""
d55e5bfc
RD		 4375 def __init__(self): raise RuntimeError, "No constructor defined"
4376 def __repr__(self):
4377 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4378 def GetPosition(*args, **kwargs):
4379 """GetPosition(self) -> Point"""
4380 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4381
4382 def GetNumberOfFiles(*args, **kwargs):
4383 """GetNumberOfFiles(self) -> int"""
4384 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4385
4386 def GetFiles(*args, **kwargs):
4387 """GetFiles(self) -> PyObject"""
4388 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4389
4390
4391class DropFilesEventPtr(DropFilesEvent):
4392 def __init__(self, this):
4393 self.this = this
4394 if not hasattr(self,"thisown"): self.thisown = 0
4395 self.__class__ = DropFilesEvent
4396_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4397
4398#---------------------------------------------------------------------------
4399
4400UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4401UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4402class UpdateUIEvent(CommandEvent):
093d3ff1 4403 """Proxy of C++ UpdateUIEvent class"""
d55e5bfc
RD		 4404 def __repr__(self):
4405 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4406 def __init__(self, *args, **kwargs):
4407 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4408 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4409 self.this = newobj.this
4410 self.thisown = 1
4411 del newobj.thisown
4412 def GetChecked(*args, **kwargs):
4413 """GetChecked(self) -> bool"""
4414 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4415
4416 def GetEnabled(*args, **kwargs):
4417 """GetEnabled(self) -> bool"""
4418 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4419
4420 def GetText(*args, **kwargs):
4421 """GetText(self) -> String"""
4422 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4423
4424 def GetSetText(*args, **kwargs):
4425 """GetSetText(self) -> bool"""
4426 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4427
4428 def GetSetChecked(*args, **kwargs):
4429 """GetSetChecked(self) -> bool"""
4430 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4431
4432 def GetSetEnabled(*args, **kwargs):
4433 """GetSetEnabled(self) -> bool"""
4434 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4435
4436 def Check(*args, **kwargs):
4437 """Check(self, bool check)"""
4438 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4439
4440 def Enable(*args, **kwargs):
4441 """Enable(self, bool enable)"""
4442 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4443
4444 def SetText(*args, **kwargs):
4445 """SetText(self, String text)"""
4446 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4447
4448 def SetUpdateInterval(*args, **kwargs):
c24da6d6 4449 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD		 4450 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4451
4452 SetUpdateInterval = staticmethod(SetUpdateInterval)
4453 def GetUpdateInterval(*args, **kwargs):
c24da6d6 4454 """GetUpdateInterval() -> long"""
d55e5bfc
RD		 4455 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4456
4457 GetUpdateInterval = staticmethod(GetUpdateInterval)
4458 def CanUpdate(*args, **kwargs):
c24da6d6 4459 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD		 4460 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4461
4462 CanUpdate = staticmethod(CanUpdate)
4463 def ResetUpdateTime(*args, **kwargs):
c24da6d6 4464 """ResetUpdateTime()"""
d55e5bfc
RD		 4465 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4466
4467 ResetUpdateTime = staticmethod(ResetUpdateTime)
4468 def SetMode(*args, **kwargs):
c24da6d6 4469 """SetMode(int mode)"""
d55e5bfc
RD		 4470 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4471
4472 SetMode = staticmethod(SetMode)
4473 def GetMode(*args, **kwargs):
c24da6d6 4474 """GetMode() -> int"""
d55e5bfc
RD		 4475 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4476
4477 GetMode = staticmethod(GetMode)
4478
4479class UpdateUIEventPtr(UpdateUIEvent):
4480 def __init__(self, this):
4481 self.this = this
4482 if not hasattr(self,"thisown"): self.thisown = 0
4483 self.__class__ = UpdateUIEvent
4484_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4485
4486def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4487 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4488 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4489
4490def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4491 """UpdateUIEvent_GetUpdateInterval() -> long"""
4492 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4493
4494def UpdateUIEvent_CanUpdate(*args, **kwargs):
4495 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4496 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4497
4498def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4499 """UpdateUIEvent_ResetUpdateTime()"""
4500 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4501
4502def UpdateUIEvent_SetMode(*args, **kwargs):
4503 """UpdateUIEvent_SetMode(int mode)"""
4504 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4505
4506def UpdateUIEvent_GetMode(*args, **kwargs):
4507 """UpdateUIEvent_GetMode() -> int"""
4508 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4509
4510#---------------------------------------------------------------------------
4511
4512class SysColourChangedEvent(Event):
093d3ff1 4513 """Proxy of C++ SysColourChangedEvent class"""
d55e5bfc
RD		 4514 def __repr__(self):
4515 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4516 def __init__(self, *args, **kwargs):
4517 """__init__(self) -> SysColourChangedEvent"""
4518 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4519 self.this = newobj.this
4520 self.thisown = 1
4521 del newobj.thisown
4522
4523class SysColourChangedEventPtr(SysColourChangedEvent):
4524 def __init__(self, this):
4525 self.this = this
4526 if not hasattr(self,"thisown"): self.thisown = 0
4527 self.__class__ = SysColourChangedEvent
4528_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4529
4530#---------------------------------------------------------------------------
4531
4532class MouseCaptureChangedEvent(Event):
093d3ff1 4533 """Proxy of C++ MouseCaptureChangedEvent class"""
d55e5bfc
RD		 4534 def __repr__(self):
4535 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4536 def __init__(self, *args, **kwargs):
4537 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4538 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4539 self.this = newobj.this
4540 self.thisown = 1
4541 del newobj.thisown
4542 def GetCapturedWindow(*args, **kwargs):
4543 """GetCapturedWindow(self) -> Window"""
4544 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4545
4546
4547class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4548 def __init__(self, this):
4549 self.this = this
4550 if not hasattr(self,"thisown"): self.thisown = 0
4551 self.__class__ = MouseCaptureChangedEvent
4552_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4553
4554#---------------------------------------------------------------------------
4555
4556class DisplayChangedEvent(Event):
093d3ff1 4557 """Proxy of C++ DisplayChangedEvent class"""
d55e5bfc
RD		 4558 def __repr__(self):
4559 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4560 def __init__(self, *args, **kwargs):
4561 """__init__(self) -> DisplayChangedEvent"""
4562 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4563 self.this = newobj.this
4564 self.thisown = 1
4565 del newobj.thisown
4566
4567class DisplayChangedEventPtr(DisplayChangedEvent):
4568 def __init__(self, this):
4569 self.this = this
4570 if not hasattr(self,"thisown"): self.thisown = 0
4571 self.__class__ = DisplayChangedEvent
4572_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4573
4574#---------------------------------------------------------------------------
4575
4576class PaletteChangedEvent(Event):
093d3ff1 4577 """Proxy of C++ PaletteChangedEvent class"""
d55e5bfc
RD		 4578 def __repr__(self):
4579 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4580 def __init__(self, *args, **kwargs):
4581 """__init__(self, int id=0) -> PaletteChangedEvent"""
4582 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4583 self.this = newobj.this
4584 self.thisown = 1
4585 del newobj.thisown
4586 def SetChangedWindow(*args, **kwargs):
4587 """SetChangedWindow(self, Window win)"""
4588 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4589
4590 def GetChangedWindow(*args, **kwargs):
4591 """GetChangedWindow(self) -> Window"""
4592 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4593
4594
4595class PaletteChangedEventPtr(PaletteChangedEvent):
4596 def __init__(self, this):
4597 self.this = this
4598 if not hasattr(self,"thisown"): self.thisown = 0
4599 self.__class__ = PaletteChangedEvent
4600_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4601
4602#---------------------------------------------------------------------------
4603
4604class QueryNewPaletteEvent(Event):
093d3ff1 4605 """Proxy of C++ QueryNewPaletteEvent class"""
d55e5bfc
RD		 4606 def __repr__(self):
4607 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4608 def __init__(self, *args, **kwargs):
4609 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4610 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4611 self.this = newobj.this
4612 self.thisown = 1
4613 del newobj.thisown
4614 def SetPaletteRealized(*args, **kwargs):
4615 """SetPaletteRealized(self, bool realized)"""
4616 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4617
4618 def GetPaletteRealized(*args, **kwargs):
4619 """GetPaletteRealized(self) -> bool"""
4620 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4621
4622
4623class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4624 def __init__(self, this):
4625 self.this = this
4626 if not hasattr(self,"thisown"): self.thisown = 0
4627 self.__class__ = QueryNewPaletteEvent
4628_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4629
4630#---------------------------------------------------------------------------
4631
4632class NavigationKeyEvent(Event):
093d3ff1 4633 """Proxy of C++ NavigationKeyEvent class"""
d55e5bfc
RD		 4634 def __repr__(self):
4635 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4636 def __init__(self, *args, **kwargs):
4637 """__init__(self) -> NavigationKeyEvent"""
4638 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4639 self.this = newobj.this
4640 self.thisown = 1
4641 del newobj.thisown
4642 def GetDirection(*args, **kwargs):
4643 """GetDirection(self) -> bool"""
4644 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4645
4646 def SetDirection(*args, **kwargs):
908b74cd 4647 """SetDirection(self, bool forward)"""
d55e5bfc
RD		 4648 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4649
4650 def IsWindowChange(*args, **kwargs):
4651 """IsWindowChange(self) -> bool"""
4652 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4653
4654 def SetWindowChange(*args, **kwargs):
908b74cd 4655 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD		 4656 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4657
68350608
RD		 4658 def IsFromTab(*args, **kwargs):
4659 """IsFromTab(self) -> bool"""
4660 return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
4661
4662 def SetFromTab(*args, **kwargs):
4663 """SetFromTab(self, bool bIs)"""
4664 return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
4665
908b74cd
RD		 4666 def SetFlags(*args, **kwargs):
4667 """SetFlags(self, long flags)"""
4668 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4669
d55e5bfc
RD		 4670 def GetCurrentFocus(*args, **kwargs):
4671 """GetCurrentFocus(self) -> Window"""
4672 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4673
4674 def SetCurrentFocus(*args, **kwargs):
4675 """SetCurrentFocus(self, Window win)"""
4676 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4677
b0f7404b 4678 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD		 4679 IsForward = _core_.NavigationKeyEvent_IsForward
4680 WinChange = _core_.NavigationKeyEvent_WinChange
68350608 4681 FromTab = _core_.NavigationKeyEvent_FromTab
d55e5bfc
RD		 4682
4683class NavigationKeyEventPtr(NavigationKeyEvent):
4684 def __init__(self, this):
4685 self.this = this
4686 if not hasattr(self,"thisown"): self.thisown = 0
4687 self.__class__ = NavigationKeyEvent
4688_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4689
4690#---------------------------------------------------------------------------
4691
4692class WindowCreateEvent(CommandEvent):
093d3ff1 4693 """Proxy of C++ WindowCreateEvent class"""
d55e5bfc
RD		 4694 def __repr__(self):
4695 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4696 def __init__(self, *args, **kwargs):
4697 """__init__(self, Window win=None) -> WindowCreateEvent"""
4698 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4699 self.this = newobj.this
4700 self.thisown = 1
4701 del newobj.thisown
4702 def GetWindow(*args, **kwargs):
4703 """GetWindow(self) -> Window"""
4704 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4705
4706
4707class WindowCreateEventPtr(WindowCreateEvent):
4708 def __init__(self, this):
4709 self.this = this
4710 if not hasattr(self,"thisown"): self.thisown = 0
4711 self.__class__ = WindowCreateEvent
4712_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4713
4714class WindowDestroyEvent(CommandEvent):
093d3ff1 4715 """Proxy of C++ WindowDestroyEvent class"""
d55e5bfc
RD		 4716 def __repr__(self):
4717 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4718 def __init__(self, *args, **kwargs):
4719 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4720 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4721 self.this = newobj.this
4722 self.thisown = 1
4723 del newobj.thisown
4724 def GetWindow(*args, **kwargs):
4725 """GetWindow(self) -> Window"""
4726 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4727
4728
4729class WindowDestroyEventPtr(WindowDestroyEvent):
4730 def __init__(self, this):
4731 self.this = this
4732 if not hasattr(self,"thisown"): self.thisown = 0
4733 self.__class__ = WindowDestroyEvent
4734_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4735
4736#---------------------------------------------------------------------------
4737
4738class ContextMenuEvent(CommandEvent):
093d3ff1 4739 """Proxy of C++ ContextMenuEvent class"""
d55e5bfc
RD		 4740 def __repr__(self):
4741 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4742 def __init__(self, *args, **kwargs):
4743 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4744 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4745 self.this = newobj.this
4746 self.thisown = 1
4747 del newobj.thisown
4748 def GetPosition(*args, **kwargs):
4749 """GetPosition(self) -> Point"""
4750 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4751
4752 def SetPosition(*args, **kwargs):
4753 """SetPosition(self, Point pos)"""
4754 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4755
4756
4757class ContextMenuEventPtr(ContextMenuEvent):
4758 def __init__(self, this):
4759 self.this = this
4760 if not hasattr(self,"thisown"): self.thisown = 0
4761 self.__class__ = ContextMenuEvent
4762_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4763
4764#---------------------------------------------------------------------------
4765
4766IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4767IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4768class IdleEvent(Event):
093d3ff1 4769 """Proxy of C++ IdleEvent class"""
d55e5bfc
RD		 4770 def __repr__(self):
4771 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4772 def __init__(self, *args, **kwargs):
4773 """__init__(self) -> IdleEvent"""
4774 newobj = _core_.new_IdleEvent(*args, **kwargs)
4775 self.this = newobj.this
4776 self.thisown = 1
4777 del newobj.thisown
4778 def RequestMore(*args, **kwargs):
4779 """RequestMore(self, bool needMore=True)"""
4780 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4781
4782 def MoreRequested(*args, **kwargs):
4783 """MoreRequested(self) -> bool"""
4784 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4785
4786 def SetMode(*args, **kwargs):
c24da6d6 4787 """SetMode(int mode)"""
d55e5bfc
RD		 4788 return _core_.IdleEvent_SetMode(*args, **kwargs)
4789
4790 SetMode = staticmethod(SetMode)
4791 def GetMode(*args, **kwargs):
c24da6d6 4792 """GetMode() -> int"""
d55e5bfc
RD		 4793 return _core_.IdleEvent_GetMode(*args, **kwargs)
4794
4795 GetMode = staticmethod(GetMode)
4796 def CanSend(*args, **kwargs):
c24da6d6 4797 """CanSend(Window win) -> bool"""
d55e5bfc
RD		 4798 return _core_.IdleEvent_CanSend(*args, **kwargs)
4799
4800 CanSend = staticmethod(CanSend)
4801
4802class IdleEventPtr(IdleEvent):
4803 def __init__(self, this):
4804 self.this = this
4805 if not hasattr(self,"thisown"): self.thisown = 0
4806 self.__class__ = IdleEvent
4807_core_.IdleEvent_swigregister(IdleEventPtr)
4808
4809def IdleEvent_SetMode(*args, **kwargs):
4810 """IdleEvent_SetMode(int mode)"""
4811 return _core_.IdleEvent_SetMode(*args, **kwargs)
4812
4813def IdleEvent_GetMode(*args, **kwargs):
4814 """IdleEvent_GetMode() -> int"""
4815 return _core_.IdleEvent_GetMode(*args, **kwargs)
4816
4817def IdleEvent_CanSend(*args, **kwargs):
4818 """IdleEvent_CanSend(Window win) -> bool"""
4819 return _core_.IdleEvent_CanSend(*args, **kwargs)
4820
4821#---------------------------------------------------------------------------
4822
4823class PyEvent(Event):
093d3ff1 4824 """Proxy of C++ PyEvent class"""
d55e5bfc
RD		 4825 def __repr__(self):
4826 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4827 def __init__(self, *args, **kwargs):
4828 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4829 newobj = _core_.new_PyEvent(*args, **kwargs)
4830 self.this = newobj.this
4831 self.thisown = 1
4832 del newobj.thisown
4833 self.SetSelf(self)
4834
4835 def __del__(self, destroy=_core_.delete_PyEvent):
4836 """__del__(self)"""
4837 try:
4838 if self.thisown: destroy(self)
4839 except: pass
4840
4841 def SetSelf(*args, **kwargs):
4842 """SetSelf(self, PyObject self)"""
4843 return _core_.PyEvent_SetSelf(*args, **kwargs)
4844
4845 def GetSelf(*args, **kwargs):
4846 """GetSelf(self) -> PyObject"""
4847 return _core_.PyEvent_GetSelf(*args, **kwargs)
4848
4849
4850class PyEventPtr(PyEvent):
4851 def __init__(self, this):
4852 self.this = this
4853 if not hasattr(self,"thisown"): self.thisown = 0
4854 self.__class__ = PyEvent
4855_core_.PyEvent_swigregister(PyEventPtr)
4856
4857class PyCommandEvent(CommandEvent):
093d3ff1 4858 """Proxy of C++ PyCommandEvent class"""
d55e5bfc
RD		 4859 def __repr__(self):
4860 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4861 def __init__(self, *args, **kwargs):
4862 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4863 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4864 self.this = newobj.this
4865 self.thisown = 1
4866 del newobj.thisown
4867 self.SetSelf(self)
4868
4869 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4870 """__del__(self)"""
4871 try:
4872 if self.thisown: destroy(self)
4873 except: pass
4874
4875 def SetSelf(*args, **kwargs):
4876 """SetSelf(self, PyObject self)"""
4877 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4878
4879 def GetSelf(*args, **kwargs):
4880 """GetSelf(self) -> PyObject"""
4881 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4882
4883
4884class PyCommandEventPtr(PyCommandEvent):
4885 def __init__(self, this):
4886 self.this = this
4887 if not hasattr(self,"thisown"): self.thisown = 0
4888 self.__class__ = PyCommandEvent
4889_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4890
53aa7709
RD		 4891class DateEvent(CommandEvent):
4892 """Proxy of C++ DateEvent class"""
4893 def __repr__(self):
4894 return "<%s.%s; proxy of C++ wxDateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4895 def __init__(self, *args, **kwargs):
4896 """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
4897 newobj = _core_.new_DateEvent(*args, **kwargs)
4898 self.this = newobj.this
4899 self.thisown = 1
4900 del newobj.thisown
4901 def GetDate(*args, **kwargs):
4902 """GetDate(self) -> DateTime"""
4903 return _core_.DateEvent_GetDate(*args, **kwargs)
4904
4905 def SetDate(*args, **kwargs):
4906 """SetDate(self, DateTime date)"""
4907 return _core_.DateEvent_SetDate(*args, **kwargs)
4908
4909
4910class DateEventPtr(DateEvent):
4911 def __init__(self, this):
4912 self.this = this
4913 if not hasattr(self,"thisown"): self.thisown = 0
4914 self.__class__ = DateEvent
4915_core_.DateEvent_swigregister(DateEventPtr)
4916
4917wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
4918EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
4919
d55e5bfc
RD		 4920#---------------------------------------------------------------------------
4921
4922PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4923PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4924PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4925PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4926PRINT_WINDOWS = _core_.PRINT_WINDOWS
4927PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4928class PyApp(EvtHandler):
c24da6d6
RD		 4929 """
4930 The ``wx.PyApp`` class is an *implementation detail*, please use the
4931 `wx.App` class (or some other derived class) instead.
4932 """
d55e5bfc
RD		 4933 def __repr__(self):
4934 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4935 def __init__(self, *args, **kwargs):
4936 """
4937 __init__(self) -> PyApp
4938
4939 Create a new application object, starting the bootstrap process.
4940 """
4941 newobj = _core_.new_PyApp(*args, **kwargs)
4942 self.this = newobj.this
4943 self.thisown = 1
4944 del newobj.thisown
4945 self._setCallbackInfo(self, PyApp)
4946 self._setOORInfo(self)
4947
4948 def __del__(self, destroy=_core_.delete_PyApp):
4949 """__del__(self)"""
4950 try:
4951 if self.thisown: destroy(self)
4952 except: pass
4953
4954 def _setCallbackInfo(*args, **kwargs):
4955 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4956 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4957
4958 def GetAppName(*args, **kwargs):
4959 """
4960 GetAppName(self) -> String
4961
4962 Get the application name.
4963 """
4964 return _core_.PyApp_GetAppName(*args, **kwargs)
4965
4966 def SetAppName(*args, **kwargs):
4967 """
4968 SetAppName(self, String name)
4969
c24da6d6
RD		 4970 Set the application name. This value may be used automatically by
4971 `wx.Config` and such.
d55e5bfc
RD		 4972 """
4973 return _core_.PyApp_SetAppName(*args, **kwargs)
4974
4975 def GetClassName(*args, **kwargs):
4976 """
4977 GetClassName(self) -> String
4978
4979 Get the application's class name.
4980 """
4981 return _core_.PyApp_GetClassName(*args, **kwargs)
4982
4983 def SetClassName(*args, **kwargs):
4984 """
4985 SetClassName(self, String name)
4986
c24da6d6
RD		 4987 Set the application's class name. This value may be used for
4988 X-resources if applicable for the platform
d55e5bfc
RD		 4989 """
4990 return _core_.PyApp_SetClassName(*args, **kwargs)
4991
4992 def GetVendorName(*args, **kwargs):
4993 """
4994 GetVendorName(self) -> String
4995
4996 Get the application's vendor name.
4997 """
4998 return _core_.PyApp_GetVendorName(*args, **kwargs)
4999
5000 def SetVendorName(*args, **kwargs):
5001 """
5002 SetVendorName(self, String name)
5003
c24da6d6
RD		 5004 Set the application's vendor name. This value may be used
5005 automatically by `wx.Config` and such.
d55e5bfc
RD		 5006 """
5007 return _core_.PyApp_SetVendorName(*args, **kwargs)
5008
5009 def GetTraits(*args, **kwargs):
5010 """
5011 GetTraits(self) -> wxAppTraits
5012
c24da6d6
RD		 5013 Return (and create if necessary) the app traits object to which we
5014 delegate for everything which either should be configurable by the
5015 user (then he can change the default behaviour simply by overriding
5016 CreateTraits() and returning his own traits object) or which is
5017 GUI/console dependent as then wx.AppTraits allows us to abstract the
5018 differences behind the common facade.
5019
5020 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD		 5021 """
5022 return _core_.PyApp_GetTraits(*args, **kwargs)
5023
5024 def ProcessPendingEvents(*args, **kwargs):
5025 """
5026 ProcessPendingEvents(self)
5027
c24da6d6
RD		 5028 Process all events in the Pending Events list -- it is necessary to
5029 call this function to process posted events. This normally happens
5030 during each event loop iteration.
d55e5bfc
RD		 5031 """
5032 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
5033
5034 def Yield(*args, **kwargs):
5035 """
5036 Yield(self, bool onlyIfNeeded=False) -> bool
5037
c24da6d6
RD		 5038 Process all currently pending events right now, instead of waiting
5039 until return to the event loop. It is an error to call ``Yield``
5040 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 5041
c24da6d6 5042 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD		 5043 reentrancies (i.e. when called from an event handler it may
5044 result in calling the same event handler again), use with
5045 extreme care or, better, don't use at all!
d55e5bfc 5046
c24da6d6 5047 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 5048
d55e5bfc
RD		 5049 """
5050 return _core_.PyApp_Yield(*args, **kwargs)
5051
5052 def WakeUpIdle(*args, **kwargs):
5053 """
5054 WakeUpIdle(self)
5055
c24da6d6
RD		 5056 Make sure that idle events are sent again.
5057 :see: `wx.WakeUpIdle`
d55e5bfc
RD		 5058 """
5059 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
5060
84f85550
RD		 5061 def IsMainLoopRunning(*args, **kwargs):
5062 """
5063 IsMainLoopRunning() -> bool
5064
5065 Returns True if we're running the main loop, i.e. if the events can
5066 currently be dispatched.
5067 """
5068 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5069
5070 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD		 5071 def MainLoop(*args, **kwargs):
5072 """
5073 MainLoop(self) -> int
5074
c24da6d6
RD		 5075 Execute the main GUI loop, the function doesn't normally return until
5076 all top level windows have been closed and destroyed.
d55e5bfc
RD		 5077 """
5078 return _core_.PyApp_MainLoop(*args, **kwargs)
5079
5080 def Exit(*args, **kwargs):
5081 """
5082 Exit(self)
5083
5084 Exit the main loop thus terminating the application.
c24da6d6 5085 :see: `wx.Exit`
d55e5bfc
RD		 5086 """
5087 return _core_.PyApp_Exit(*args, **kwargs)
5088
5089 def ExitMainLoop(*args, **kwargs):
5090 """
5091 ExitMainLoop(self)
5092
c24da6d6
RD		 5093 Exit the main GUI loop during the next iteration of the main
5094 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD		 5095 """
5096 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
5097
5098 def Pending(*args, **kwargs):
5099 """
5100 Pending(self) -> bool
5101
5102 Returns True if there are unprocessed events in the event queue.
5103 """
5104 return _core_.PyApp_Pending(*args, **kwargs)
5105
5106 def Dispatch(*args, **kwargs):
5107 """
5108 Dispatch(self) -> bool
5109
5110 Process the first event in the event queue (blocks until an event
5111 appears if there are none currently)
5112 """
5113 return _core_.PyApp_Dispatch(*args, **kwargs)
5114
5115 def ProcessIdle(*args, **kwargs):
5116 """
5117 ProcessIdle(self) -> bool
5118
c24da6d6
RD		 5119 Called from the MainLoop when the application becomes idle (there are
5120 no pending events) and sends a `wx.IdleEvent` to all interested
5121 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD		 5122 """
5123 return _core_.PyApp_ProcessIdle(*args, **kwargs)
5124
5125 def SendIdleEvents(*args, **kwargs):
5126 """
5127 SendIdleEvents(self, Window win, IdleEvent event) -> bool
5128
c24da6d6
RD		 5129 Send idle event to window and all subwindows. Returns True if more
5130 idle time is requested.
d55e5bfc
RD		 5131 """
5132 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
5133
5134 def IsActive(*args, **kwargs):
5135 """
5136 IsActive(self) -> bool
5137
5138 Return True if our app has focus.
5139 """
5140 return _core_.PyApp_IsActive(*args, **kwargs)
5141
5142 def SetTopWindow(*args, **kwargs):
5143 """
5144 SetTopWindow(self, Window win)
5145
c24da6d6 5146 Set the *main* top level window
d55e5bfc
RD		 5147 """
5148 return _core_.PyApp_SetTopWindow(*args, **kwargs)
5149
5150 def GetTopWindow(*args, **kwargs):
5151 """
5152 GetTopWindow(self) -> Window
5153
c24da6d6
RD		 5154 Return the *main* top level window (if it hadn't been set previously
5155 with SetTopWindow(), will return just some top level window and, if
5156 there not any, will return None)
d55e5bfc
RD		 5157 """
5158 return _core_.PyApp_GetTopWindow(*args, **kwargs)
5159
5160 def SetExitOnFrameDelete(*args, **kwargs):
5161 """
5162 SetExitOnFrameDelete(self, bool flag)
5163
c24da6d6
RD		 5164 Control the exit behaviour: by default, the program will exit the main
5165 loop (and so, usually, terminate) when the last top-level program
5166 window is deleted. Beware that if you disable this behaviour (with
5167 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
5168 explicitly from somewhere.
d55e5bfc
RD		 5169 """
5170 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
5171
5172 def GetExitOnFrameDelete(*args, **kwargs):
5173 """
5174 GetExitOnFrameDelete(self) -> bool
5175
5176 Get the current exit behaviour setting.
5177 """
5178 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
5179
5180 def SetUseBestVisual(*args, **kwargs):
5181 """
5182 SetUseBestVisual(self, bool flag)
5183
c24da6d6
RD		 5184 Set whether the app should try to use the best available visual on
5185 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD		 5186 """
5187 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
5188
5189 def GetUseBestVisual(*args, **kwargs):
5190 """
5191 GetUseBestVisual(self) -> bool
5192
5193 Get current UseBestVisual setting.
5194 """
5195 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
5196
5197 def SetPrintMode(*args, **kwargs):
5198 """SetPrintMode(self, int mode)"""
5199 return _core_.PyApp_SetPrintMode(*args, **kwargs)
5200
5201 def GetPrintMode(*args, **kwargs):
5202 """GetPrintMode(self) -> int"""
5203 return _core_.PyApp_GetPrintMode(*args, **kwargs)
5204
5205 def SetAssertMode(*args, **kwargs):
5206 """
5207 SetAssertMode(self, int mode)
5208
79fccf9d 5209 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD		 5210 """
5211 return _core_.PyApp_SetAssertMode(*args, **kwargs)
5212
5213 def GetAssertMode(*args, **kwargs):
5214 """
5215 GetAssertMode(self) -> int
5216
5217 Get the current OnAssert behaviour setting.
5218 """
5219 return _core_.PyApp_GetAssertMode(*args, **kwargs)
5220
5221 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 5222 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD		 5223 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
5224
5225 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
5226 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 5227 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD		 5228 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
5229
5230 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
5231 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 5232 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD		 5233 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
5234
5235 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
5236 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 5237 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD		 5238 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
5239
5240 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
5241 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 5242 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD		 5243 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
5244
5245 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
5246 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 5247 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD		 5248 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5249
5250 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
5251 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 5252 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD		 5253 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5254
5255 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
5256 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 5257 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD		 5258 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5259
5260 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
5261 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 5262 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD		 5263 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5264
5265 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
5266 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 5267 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD		 5268 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5269
5270 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5271 def _BootstrapApp(*args, **kwargs):
5272 """
5273 _BootstrapApp(self)
5274
5275 For internal use only
5276 """
5277 return _core_.PyApp__BootstrapApp(*args, **kwargs)
5278
5279 def GetComCtl32Version(*args, **kwargs):
5280 """
c24da6d6 5281 GetComCtl32Version() -> int
d55e5bfc 5282
c24da6d6
RD		 5283 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5284 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD		 5285 """
5286 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5287
5288 GetComCtl32Version = staticmethod(GetComCtl32Version)
5289
5290class PyAppPtr(PyApp):
5291 def __init__(self, this):
5292 self.this = this
5293 if not hasattr(self,"thisown"): self.thisown = 0
5294 self.__class__ = PyApp
5295_core_.PyApp_swigregister(PyAppPtr)
5296
84f85550
RD		 5297def PyApp_IsMainLoopRunning(*args, **kwargs):
5298 """
5299 PyApp_IsMainLoopRunning() -> bool
5300
5301 Returns True if we're running the main loop, i.e. if the events can
5302 currently be dispatched.
5303 """
5304 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5305
d55e5bfc
RD		 5306def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5307 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
5308 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
5309
5310def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5311 """PyApp_GetMacAboutMenuItemId() -> long"""
5312 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
5313
5314def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5315 """PyApp_GetMacPreferencesMenuItemId() -> long"""
5316 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
5317
5318def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5319 """PyApp_GetMacExitMenuItemId() -> long"""
5320 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
5321
5322def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
5323 """PyApp_GetMacHelpMenuTitleName() -> String"""
5324 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
5325
5326def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5327 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
5328 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5329
5330def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5331 """PyApp_SetMacAboutMenuItemId(long val)"""
5332 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5333
5334def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5335 """PyApp_SetMacPreferencesMenuItemId(long val)"""
5336 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5337
5338def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5339 """PyApp_SetMacExitMenuItemId(long val)"""
5340 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5341
5342def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
5343 """PyApp_SetMacHelpMenuTitleName(String val)"""
5344 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5345
5346def PyApp_GetComCtl32Version(*args, **kwargs):
5347 """
5348 PyApp_GetComCtl32Version() -> int
5349
c24da6d6
RD		 5350 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5351 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD		 5352 """
5353 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5354
5355#---------------------------------------------------------------------------
5356
5357
5358def Exit(*args, **kwargs):
5359 """
5360 Exit()
5361
5362 Force an exit of the application. Convenience for wx.GetApp().Exit()
5363 """
5364 return _core_.Exit(*args, **kwargs)
5365
5366def Yield(*args, **kwargs):
5367 """
5368 Yield() -> bool
5369
5370 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5371 """
5372 return _core_.Yield(*args, **kwargs)
5373
5374def YieldIfNeeded(*args, **kwargs):
5375 """
5376 YieldIfNeeded() -> bool
5377
5378 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5379 """
5380 return _core_.YieldIfNeeded(*args, **kwargs)
5381
5382def SafeYield(*args, **kwargs):
5383 """
5384 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
5385
c24da6d6
RD		 5386 This function is similar to `wx.Yield`, except that it disables the
5387 user input to all program windows before calling `wx.Yield` and
5388 re-enables it again afterwards. If ``win`` is not None, this window
5389 will remain enabled, allowing the implementation of some limited user
5390 interaction.
d55e5bfc 5391
c24da6d6 5392 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD		 5393 """
5394 return _core_.SafeYield(*args, **kwargs)
5395
5396def WakeUpIdle(*args, **kwargs):
5397 """
5398 WakeUpIdle()
5399
c24da6d6
RD		 5400 Cause the message queue to become empty again, so idle events will be
5401 sent.
d55e5bfc
RD		 5402 """
5403 return _core_.WakeUpIdle(*args, **kwargs)
5404
5405def PostEvent(*args, **kwargs):
5406 """
5407 PostEvent(EvtHandler dest, Event event)
5408
c24da6d6
RD		 5409 Send an event to a window or other wx.EvtHandler to be processed
5410 later.
d55e5bfc
RD		 5411 """
5412 return _core_.PostEvent(*args, **kwargs)
5413
5414def App_CleanUp(*args, **kwargs):
5415 """
5416 App_CleanUp()
5417
79fccf9d 5418 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 5419 Python shuts down.
d55e5bfc
RD		 5420 """
5421 return _core_.App_CleanUp(*args, **kwargs)
5422
5423def GetApp(*args, **kwargs):
5424 """
5425 GetApp() -> PyApp
5426
5427 Return a reference to the current wx.App object.
5428 """
5429 return _core_.GetApp(*args, **kwargs)
5cbf236d
RD		 5430
5431def SetDefaultPyEncoding(*args, **kwargs):
5432 """
5433 SetDefaultPyEncoding(string encoding)
5434
5435 Sets the encoding that wxPython will use when it needs to convert a
5436 Python string or unicode object to or from a wxString.
62d32a5f
RD		 5437
5438 The default encoding is the value of ``locale.getdefaultlocale()[1]``
5439 but please be aware that the default encoding within the same locale
5440 may be slightly different on different platforms. For example, please
5441 see http://www.alanwood.net/demos/charsetdiffs.html for differences
5442 between the common latin/roman encodings.
5cbf236d
RD		 5443 """
5444 return _core_.SetDefaultPyEncoding(*args, **kwargs)
5445
5446def GetDefaultPyEncoding(*args, **kwargs):
5447 """
5448 GetDefaultPyEncoding() -> string
5449
5450 Gets the current encoding that wxPython will use when it needs to
5451 convert a Python string or unicode object to or from a wxString.
5452 """
5453 return _core_.GetDefaultPyEncoding(*args, **kwargs)
d55e5bfc
RD		 5454#----------------------------------------------------------------------
5455
5456class PyOnDemandOutputWindow:
5457 """
5458 A class that can be used for redirecting Python's stdout and
5459 stderr streams. It will do nothing until something is wrriten to
5460 the stream at which point it will create a Frame with a text area
5461 and write the text there.
5462 """
5463 def __init__(self, title = "wxPython: stdout/stderr"):
5464 self.frame = None
5465 self.title = title
412d302d
RD		 5466 self.pos = wx.DefaultPosition
5467 self.size = (450, 300)
d55e5bfc
RD		 5468 self.parent = None
5469
5470 def SetParent(self, parent):
5471 """Set the window to be used as the popup Frame's parent."""
5472 self.parent = parent
5473
5474
5475 def CreateOutputWindow(self, st):
412d302d
RD		 5476 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5477 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 5478 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5479 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 5480 self.text.AppendText(st)
d55e5bfc
RD		 5481 self.frame.Show(True)
5482 EVT_CLOSE(self.frame, self.OnCloseWindow)
5483
5484
5485 def OnCloseWindow(self, event):
5486 if self.frame is not None:
5487 self.frame.Destroy()
5488 self.frame = None
5489 self.text = None
5490
5491
5492 # These methods provide the file-like output behaviour.
5493 def write(self, text):
5494 """
5495 Create the output window if needed and write the string to it.
5496 If not called in the context of the gui thread then uses
5497 CallAfter to do the work there.
5498 """
5499 if self.frame is None:
5500 if not wx.Thread_IsMain():
5501 wx.CallAfter(self.CreateOutputWindow, text)
5502 else:
5503 self.CreateOutputWindow(text)
5504 else:
5505 if not wx.Thread_IsMain():
5506 wx.CallAfter(self.text.AppendText, text)
5507 else:
5508 self.text.AppendText(text)
5509
5510
5511 def close(self):
5512 if self.frame is not None:
5513 wx.CallAfter(self.frame.Close)
5514
5515
19272049
RD		 5516 def flush(self):
5517 pass
5518
5519
d55e5bfc
RD		 5520
5521#----------------------------------------------------------------------
5522
5523_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5524
5525class App(wx.PyApp):
5526 """
c24da6d6
RD		 5527 The ``wx.App`` class represents the application and is used to:
5528
5529 * bootstrap the wxPython system and initialize the underlying
5530 gui toolkit
5531 * set and get application-wide properties
5532 * implement the windowing system main message or event loop,
5533 and to dispatch events to window instances
5534 * etc.
5535
5536 Every application must have a ``wx.App`` instance, and all
5537 creation of UI objects should be delayed until after the
5538 ``wx.App`` object has been created in order to ensure that the gui
5539 platform and wxWidgets have been fully initialized.
5540
5541 Normally you would derive from this class and implement an
5542 ``OnInit`` method that creates a frame and then calls
5543 ``self.SetTopWindow(frame)``.
5544
5545 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 5546 directly.
d55e5bfc 5547 """
c24da6d6 5548
d55e5bfc
RD		 5549 outputWindowClass = PyOnDemandOutputWindow
5550
c24da6d6
RD		 5551 def __init__(self, redirect=_defRedirect, filename=None,
5552 useBestVisual=False, clearSigInt=True):
5553 """
5554 Construct a ``wx.App`` object.
5555
5556 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5557 redirected? Defaults to True on Windows and Mac, False
5558 otherwise. If `filename` is None then output will be
5559 redirected to a window that pops up as needed. (You can
5560 control what kind of window is created for the output by
5561 resetting the class variable ``outputWindowClass`` to a
5562 class of your choosing.)
5563
5564 :param filename: The name of a file to redirect output to, if
5565 redirect is True.
5566
5567 :param useBestVisual: Should the app try to use the best
5568 available visual provided by the system (only relevant on
5569 systems that have more than one visual.) This parameter
5570 must be used instead of calling `SetUseBestVisual` later
5571 on because it must be set before the underlying GUI
5572 toolkit is initialized.
5573
5574 :param clearSigInt: Should SIGINT be cleared? This allows the
5575 app to terminate upon a Ctrl-C in the console like other
5576 GUI apps will.
5577
5578 :note: You should override OnInit to do applicaition
5579 initialization to ensure that the system, toolkit and
5580 wxWidgets are fully initialized.
5581 """
d55e5bfc
RD		 5582 wx.PyApp.__init__(self)
5583
5584 if wx.Platform == "__WXMAC__":
5585 try:
5586 import MacOS
5587 if not MacOS.WMAvailable():
5588 print """\
5589This program needs access to the screen. Please run with 'pythonw',
5590not 'python', and only when you are logged in on the main display of
5591your Mac."""
5592 _sys.exit(1)
b1f29bf7
RD		 5593 except SystemExit:
5594 raise
d55e5bfc
RD		 5595 except:
5596 pass
5597
5598 # This has to be done before OnInit
5599 self.SetUseBestVisual(useBestVisual)
5600
5601 # Set the default handler for SIGINT. This fixes a problem
5602 # where if Ctrl-C is pressed in the console that started this
5603 # app then it will not appear to do anything, (not even send
5604 # KeyboardInterrupt???) but will later segfault on exit. By
5605 # setting the default handler then the app will exit, as
5606 # expected (depending on platform.)
c24da6d6
RD		 5607 if clearSigInt:
5608 try:
5609 import signal
5610 signal.signal(signal.SIGINT, signal.SIG_DFL)
5611 except:
5612 pass
d55e5bfc
RD		 5613
5614 # Save and redirect the stdio to a window?
5615 self.stdioWin = None
5616 self.saveStdio = (_sys.stdout, _sys.stderr)
5617 if redirect:
5618 self.RedirectStdio(filename)
5619
8fb0e70a
RD		 5620 # Use Python's install prefix as the default
5621 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5622
d55e5bfc
RD		 5623 # This finishes the initialization of wxWindows and then calls
5624 # the OnInit that should be present in the derived class
5625 self._BootstrapApp()
5626
5627
5628 def __del__(self):
5629 try:
5630 self.RestoreStdio() # Just in case the MainLoop was overridden
5631 except:
5632 pass
5633
5634
5635 def SetTopWindow(self, frame):
5636 """Set the \"main\" top level window"""
5637 if self.stdioWin:
5638 self.stdioWin.SetParent(frame)
5639 wx.PyApp.SetTopWindow(self, frame)
5640
5641
5642 def MainLoop(self):
5643 """Execute the main GUI event loop"""
5644 wx.PyApp.MainLoop(self)
5645 self.RestoreStdio()
5646
5647
5648 def RedirectStdio(self, filename=None):
5649 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5650 if filename:
5651 _sys.stdout = _sys.stderr = open(filename, 'a')
5652 else:
5653 self.stdioWin = self.outputWindowClass()
5654 _sys.stdout = _sys.stderr = self.stdioWin
5655
5656
5657 def RestoreStdio(self):
5658 _sys.stdout, _sys.stderr = self.saveStdio
5659
5660
412d302d
RD		 5661 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5662 """
5663 Set the title, position and/or size of the output window if
f5b96ee1
RD		 5664 the stdio has been redirected. This should be called before
5665 any output would cause the output window to be created.
412d302d
RD		 5666 """
5667 if self.stdioWin:
5668 if title is not None:
5669 self.stdioWin.title = title
5670 if pos is not None:
5671 self.stdioWin.pos = pos
5672 if size is not None:
5673 self.stdioWin.size = size
5674
5675
5676
d55e5bfc 5677
c24da6d6 5678# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD		 5679App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5680App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5681App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5682App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5683App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5684App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5685App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5686App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5687App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5688App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5689App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5690
5691#----------------------------------------------------------------------------
5692
5693class PySimpleApp(wx.App):
5694 """
5695 A simple application class. You can just create one of these and
5696 then then make your top level windows later, and not have to worry
c24da6d6 5697 about OnInit. For example::
d55e5bfc 5698
c24da6d6
RD		 5699 app = wx.PySimpleApp()
5700 frame = wx.Frame(None, title='Hello World')
5701 frame.Show()
5702 app.MainLoop()
5703
5704 :see: `wx.App`
5705 """
5706
5707 def __init__(self, redirect=False, filename=None,
5708 useBestVisual=False, clearSigInt=True):
5709 """
5710 :see: `wx.App.__init__`
5711 """
5712 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD		 5713
5714 def OnInit(self):
d55e5bfc
RD		 5715 return True
5716
5717
c24da6d6 5718
d55e5bfc
RD		 5719# Is anybody using this one?
5720class PyWidgetTester(wx.App):
5721 def __init__(self, size = (250, 100)):
5722 self.size = size
5723 wx.App.__init__(self, 0)
5724
5725 def OnInit(self):
5726 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5727 self.SetTopWindow(self.frame)
5728 return True
5729
c24da6d6
RD		 5730 def SetWidget(self, widgetClass, *args, **kwargs):
5731 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD		 5732 self.frame.Show(True)
5733
5734#----------------------------------------------------------------------------
5735# DO NOT hold any other references to this object. This is how we
c24da6d6 5736# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5737# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 5738# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD		 5739
5740class __wxPyCleanup:
5741 def __init__(self):
5742 self.cleanup = _core_.App_CleanUp
5743 def __del__(self):
5744 self.cleanup()
5745
5746_sys.__wxPythonCleanup = __wxPyCleanup()
5747
5748## # another possible solution, but it gets called too early...
c24da6d6
RD		 5749## import atexit
5750## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD		 5751
5752
5753#----------------------------------------------------------------------------
5754
5755#---------------------------------------------------------------------------
5756
ae8162c8 5757class EventLoop(object):
093d3ff1 5758 """Proxy of C++ EventLoop class"""
ae8162c8
RD		 5759 def __repr__(self):
5760 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5761 def __init__(self, *args, **kwargs):
5762 """__init__(self) -> EventLoop"""
5763 newobj = _core_.new_EventLoop(*args, **kwargs)
5764 self.this = newobj.this
5765 self.thisown = 1
5766 del newobj.thisown
5767 def __del__(self, destroy=_core_.delete_EventLoop):
5768 """__del__(self)"""
5769 try:
5770 if self.thisown: destroy(self)
5771 except: pass
5772
5773 def Run(*args, **kwargs):
5774 """Run(self) -> int"""
5775 return _core_.EventLoop_Run(*args, **kwargs)
5776
5777 def Exit(*args, **kwargs):
5778 """Exit(self, int rc=0)"""
5779 return _core_.EventLoop_Exit(*args, **kwargs)
5780
5781 def Pending(*args, **kwargs):
5782 """Pending(self) -> bool"""
5783 return _core_.EventLoop_Pending(*args, **kwargs)
5784
5785 def Dispatch(*args, **kwargs):
5786 """Dispatch(self) -> bool"""
5787 return _core_.EventLoop_Dispatch(*args, **kwargs)
5788
5789 def IsRunning(*args, **kwargs):
5790 """IsRunning(self) -> bool"""
5791 return _core_.EventLoop_IsRunning(*args, **kwargs)
5792
5793 def GetActive(*args, **kwargs):
5794 """GetActive() -> EventLoop"""
5795 return _core_.EventLoop_GetActive(*args, **kwargs)
5796
5797 GetActive = staticmethod(GetActive)
5798 def SetActive(*args, **kwargs):
5799 """SetActive(EventLoop loop)"""
5800 return _core_.EventLoop_SetActive(*args, **kwargs)
5801
5802 SetActive = staticmethod(SetActive)
5803
5804class EventLoopPtr(EventLoop):
5805 def __init__(self, this):
5806 self.this = this
5807 if not hasattr(self,"thisown"): self.thisown = 0
5808 self.__class__ = EventLoop
5809_core_.EventLoop_swigregister(EventLoopPtr)
5810
5811def EventLoop_GetActive(*args, **kwargs):
5812 """EventLoop_GetActive() -> EventLoop"""
5813 return _core_.EventLoop_GetActive(*args, **kwargs)
5814
5815def EventLoop_SetActive(*args, **kwargs):
5816 """EventLoop_SetActive(EventLoop loop)"""
5817 return _core_.EventLoop_SetActive(*args, **kwargs)
5818
5819#---------------------------------------------------------------------------
5820
d55e5bfc 5821class AcceleratorEntry(object):
c24da6d6
RD		 5822 """
5823 A class used to define items in an `wx.AcceleratorTable`. wxPython
5824 programs can choose to use wx.AcceleratorEntry objects, but using a
5825 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 5826 as well. See `__init__` for of the tuple values.
c24da6d6
RD		 5827
5828 :see: `wx.AcceleratorTable`
5829 """
d55e5bfc
RD		 5830 def __repr__(self):
5831 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5832 def __init__(self, *args, **kwargs):
c24da6d6
RD		 5833 """
5834 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5835
5836 Construct a wx.AcceleratorEntry.
c24da6d6 5837 """
d55e5bfc
RD		 5838 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5839 self.this = newobj.this
5840 self.thisown = 1
5841 del newobj.thisown
5842 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5843 """__del__(self)"""
5844 try:
5845 if self.thisown: destroy(self)
5846 except: pass
5847
5848 def Set(*args, **kwargs):
c24da6d6
RD		 5849 """
5850 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5851
c24da6d6
RD		 5852 (Re)set the attributes of a wx.AcceleratorEntry.
5853 :see `__init__`
5854 """
5855 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD		 5856
5857 def GetFlags(*args, **kwargs):
c24da6d6
RD		 5858 """
5859 GetFlags(self) -> int
5860
5861 Get the AcceleratorEntry's flags.
5862 """
d55e5bfc
RD		 5863 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5864
5865 def GetKeyCode(*args, **kwargs):
c24da6d6
RD		 5866 """
5867 GetKeyCode(self) -> int
5868
5869 Get the AcceleratorEntry's keycode.
5870 """
d55e5bfc
RD		 5871 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5872
5873 def GetCommand(*args, **kwargs):
c24da6d6
RD		 5874 """
5875 GetCommand(self) -> int
5876
5877 Get the AcceleratorEntry's command ID.
5878 """
d55e5bfc
RD		 5879 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5880
5881
5882class AcceleratorEntryPtr(AcceleratorEntry):
5883 def __init__(self, this):
5884 self.this = this
5885 if not hasattr(self,"thisown"): self.thisown = 0
5886 self.__class__ = AcceleratorEntry
5887_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5888
5889class AcceleratorTable(Object):
c24da6d6
RD		 5890 """
5891 An accelerator table allows the application to specify a table of
5892 keyboard shortcuts for menus or other commands. On Windows, menu or
5893 button commands are supported; on GTK, only menu commands are
5894 supported.
c24da6d6 5895 """
d55e5bfc
RD		 5896 def __repr__(self):
5897 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5898 def __init__(self, *args, **kwargs):
5899 """
5900 __init__(entries) -> AcceleratorTable
5901
c24da6d6
RD		 5902 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5903 items or or of 3-tuples (flags, keyCode, cmdID)
5904
5905 :see: `wx.AcceleratorEntry`
d55e5bfc
RD		 5906 """
5907 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5908 self.this = newobj.this
5909 self.thisown = 1
5910 del newobj.thisown
5911 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5912 """__del__(self)"""
5913 try:
5914 if self.thisown: destroy(self)
5915 except: pass
5916
5917 def Ok(*args, **kwargs):
5918 """Ok(self) -> bool"""
5919 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5920
5921
5922class AcceleratorTablePtr(AcceleratorTable):
5923 def __init__(self, this):
5924 self.this = this
5925 if not hasattr(self,"thisown"): self.thisown = 0
5926 self.__class__ = AcceleratorTable
5927_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5928
5929
5930def GetAccelFromString(*args, **kwargs):
5931 """GetAccelFromString(String label) -> AcceleratorEntry"""
5932 return _core_.GetAccelFromString(*args, **kwargs)
5933#---------------------------------------------------------------------------
5934
5935class VisualAttributes(object):
5936 """struct containing all the visual attributes of a control"""
5937 def __repr__(self):
5938 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5939 def __init__(self, *args, **kwargs):
5940 """
5941 __init__(self) -> VisualAttributes
5942
5943 struct containing all the visual attributes of a control
5944 """
5945 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5946 self.this = newobj.this
5947 self.thisown = 1
5948 del newobj.thisown
5949 def __del__(self, destroy=_core_.delete_VisualAttributes):
5950 """__del__(self)"""
5951 try:
5952 if self.thisown: destroy(self)
5953 except: pass
5954
5955 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5956 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5957 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5958
5959class VisualAttributesPtr(VisualAttributes):
5960 def __init__(self, this):
5961 self.this = this
5962 if not hasattr(self,"thisown"): self.thisown = 0
5963 self.__class__ = VisualAttributes
5964_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5965NullAcceleratorTable = cvar.NullAcceleratorTable
5966PanelNameStr = cvar.PanelNameStr
5967
5968WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5969WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5970WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5971WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5972WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5973class Window(EvtHandler):
5974 """
5975 wx.Window is the base class for all windows and represents any visible
5976 object on the screen. All controls, top level windows and so on are
5977 wx.Windows. Sizers and device contexts are not however, as they don't
5978 appear on screen themselves.
5979
5980 """
5981 def __repr__(self):
5982 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5983 def __init__(self, *args, **kwargs):
5984 """
5985 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5986 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5987
5988 Construct and show a generic Window.
5989 """
5990 newobj = _core_.new_Window(*args, **kwargs)
5991 self.this = newobj.this
5992 self.thisown = 1
5993 del newobj.thisown
5994 self._setOORInfo(self)
5995
5996 def Create(*args, **kwargs):
5997 """
5998 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5999 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
6000
6001 Create the GUI part of the Window for 2-phase creation mode.
6002 """
6003 return _core_.Window_Create(*args, **kwargs)
6004
6005 def Close(*args, **kwargs):
6006 """
6007 Close(self, bool force=False) -> bool
6008
6009 This function simply generates a EVT_CLOSE event whose handler usually
6010 tries to close the window. It doesn't close the window itself,
6011 however. If force is False (the default) then the window's close
6012 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD		 6013 """
6014 return _core_.Window_Close(*args, **kwargs)
6015
6016 def Destroy(*args, **kwargs):
6017 """
6018 Destroy(self) -> bool
6019
6020 Destroys the window safely. Frames and dialogs are not destroyed
6021 immediately when this function is called -- they are added to a list
6022 of windows to be deleted on idle time, when all the window's events
6023 have been processed. This prevents problems with events being sent to
6024 non-existent windows.
6025
6026 Returns True if the window has either been successfully deleted, or it
6027 has been added to the list of windows pending real deletion.
6028 """
6029 return _core_.Window_Destroy(*args, **kwargs)
6030
6031 def DestroyChildren(*args, **kwargs):
6032 """
6033 DestroyChildren(self) -> bool
6034
79fccf9d
RD		 6035 Destroys all children of a window. Called automatically by the
6036 destructor.
d55e5bfc
RD		 6037 """
6038 return _core_.Window_DestroyChildren(*args, **kwargs)
6039
6040 def IsBeingDeleted(*args, **kwargs):
6041 """
6042 IsBeingDeleted(self) -> bool
6043
6044 Is the window in the process of being deleted?
6045 """
6046 return _core_.Window_IsBeingDeleted(*args, **kwargs)
6047
6048 def SetTitle(*args, **kwargs):
6049 """
6050 SetTitle(self, String title)
6051
6052 Sets the window's title. Applicable only to frames and dialogs.
6053 """
6054 return _core_.Window_SetTitle(*args, **kwargs)
6055
6056 def GetTitle(*args, **kwargs):
6057 """
6058 GetTitle(self) -> String
6059
6060 Gets the window's title. Applicable only to frames and dialogs.
6061 """
6062 return _core_.Window_GetTitle(*args, **kwargs)
6063
6064 def SetLabel(*args, **kwargs):
6065 """
6066 SetLabel(self, String label)
6067
6068 Set the text which the window shows in its label if applicable.
6069 """
6070 return _core_.Window_SetLabel(*args, **kwargs)
6071
6072 def GetLabel(*args, **kwargs):
6073 """
6074 GetLabel(self) -> String
6075
79fccf9d
RD		 6076 Generic way of getting a label from any window, for identification
6077 purposes. The interpretation of this function differs from class to
6078 class. For frames and dialogs, the value returned is the title. For
6079 buttons or static text controls, it is the button text. This function
6080 can be useful for meta-programs such as testing tools or special-needs
6081 access programs)which need to identify windows by name.
d55e5bfc
RD		 6082 """
6083 return _core_.Window_GetLabel(*args, **kwargs)
6084
6085 def SetName(*args, **kwargs):
6086 """
6087 SetName(self, String name)
6088
79fccf9d
RD		 6089 Sets the window's name. The window name is used for ressource setting
6090 in X, it is not the same as the window title/label
d55e5bfc
RD		 6091 """
6092 return _core_.Window_SetName(*args, **kwargs)
6093
6094 def GetName(*args, **kwargs):
6095 """
6096 GetName(self) -> String
6097
79fccf9d
RD		 6098 Returns the windows name. This name is not guaranteed to be unique;
6099 it is up to the programmer to supply an appropriate name in the window
6100 constructor or via wx.Window.SetName.
d55e5bfc
RD		 6101 """
6102 return _core_.Window_GetName(*args, **kwargs)
6103
6104 def SetWindowVariant(*args, **kwargs):
6105 """
6106 SetWindowVariant(self, int variant)
6107
79fccf9d
RD		 6108 Sets the variant of the window/font size to use for this window, if
6109 the platform supports variants, for example, wxMac.
d55e5bfc
RD		 6110 """
6111 return _core_.Window_SetWindowVariant(*args, **kwargs)
6112
6113 def GetWindowVariant(*args, **kwargs):
6114 """GetWindowVariant(self) -> int"""
6115 return _core_.Window_GetWindowVariant(*args, **kwargs)
6116
6117 def SetId(*args, **kwargs):
6118 """
6119 SetId(self, int winid)
6120
6121 Sets the identifier of the window. Each window has an integer
6122 identifier. If the application has not provided one, an identifier
6123 will be generated. Normally, the identifier should be provided on
6124 creation and should not be modified subsequently.
6125 """
6126 return _core_.Window_SetId(*args, **kwargs)
6127
6128 def GetId(*args, **kwargs):
6129 """
6130 GetId(self) -> int
6131
6132 Returns the identifier of the window. Each window has an integer
6133 identifier. If the application has not provided one (or the default Id
6134 -1 is used) then an unique identifier with a negative value will be
6135 generated.
6136 """
6137 return _core_.Window_GetId(*args, **kwargs)
6138
6139 def NewControlId(*args, **kwargs):
6140 """
c24da6d6 6141 NewControlId() -> int
d55e5bfc
RD		 6142
6143 Generate a control id for the controls which were not given one.
6144 """
6145 return _core_.Window_NewControlId(*args, **kwargs)
6146
6147 NewControlId = staticmethod(NewControlId)
6148 def NextControlId(*args, **kwargs):
6149 """
c24da6d6 6150 NextControlId(int winid) -> int
d55e5bfc
RD		 6151
6152 Get the id of the control following the one with the given
79fccf9d 6153 autogenerated) id
d55e5bfc
RD		 6154 """
6155 return _core_.Window_NextControlId(*args, **kwargs)
6156
6157 NextControlId = staticmethod(NextControlId)
6158 def PrevControlId(*args, **kwargs):
6159 """
c24da6d6 6160 PrevControlId(int winid) -> int
d55e5bfc
RD		 6161
6162 Get the id of the control preceding the one with the given
79fccf9d 6163 autogenerated) id
d55e5bfc
RD		 6164 """
6165 return _core_.Window_PrevControlId(*args, **kwargs)
6166
6167 PrevControlId = staticmethod(PrevControlId)
6168 def SetSize(*args, **kwargs):
6169 """
6170 SetSize(self, Size size)
6171
6172 Sets the size of the window in pixels.
6173 """
6174 return _core_.Window_SetSize(*args, **kwargs)
6175
6176 def SetDimensions(*args, **kwargs):
6177 """
6178 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
6179
6180 Sets the position and size of the window in pixels. The sizeFlags
6181 parameter indicates the interpretation of the other params if they are
62d32a5f
RD		 6182 equal to -1.
6183
6184 ======================== ======================================
6185 wx.SIZE_AUTO A -1 indicates that a class-specific
6186 default should be used.
6187 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
6188 -1 values are supplied.
6189 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
6190 interpreted as real dimensions, not
6191 default values.
6192 ======================== ======================================
6193
d55e5bfc
RD		 6194 """
6195 return _core_.Window_SetDimensions(*args, **kwargs)
6196
6197 def SetRect(*args, **kwargs):
6198 """
6199 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
6200
6201 Sets the position and size of the window in pixels using a wx.Rect.
6202 """
6203 return _core_.Window_SetRect(*args, **kwargs)
6204
6205 def SetSizeWH(*args, **kwargs):
6206 """
6207 SetSizeWH(self, int width, int height)
6208
6209 Sets the size of the window in pixels.
6210 """
6211 return _core_.Window_SetSizeWH(*args, **kwargs)
6212
6213 def Move(*args, **kwargs):
6214 """
6215 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
6216
6217 Moves the window to the given position.
6218 """
6219 return _core_.Window_Move(*args, **kwargs)
6220
6221 SetPosition = Move
6222 def MoveXY(*args, **kwargs):
6223 """
6224 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
6225
6226 Moves the window to the given position.
6227 """
6228 return _core_.Window_MoveXY(*args, **kwargs)
6229
f8167d6e
RD		 6230 def SetBestFittingSize(*args, **kwargs):
6231 """
6232 SetBestFittingSize(self, Size size=DefaultSize)
6233
6234 A 'Smart' SetSize that will fill in default size components with the
6235 window's *best size* values. Also set's the minsize for use with sizers.
6236 """
6237 return _core_.Window_SetBestFittingSize(*args, **kwargs)
6238
d55e5bfc
RD		 6239 def Raise(*args, **kwargs):
6240 """
6241 Raise(self)
6242
6243 Raises the window to the top of the window hierarchy if it is a
6244 managed window (dialog or frame).
6245 """
6246 return _core_.Window_Raise(*args, **kwargs)
6247
6248 def Lower(*args, **kwargs):
6249 """
6250 Lower(self)
6251
6252 Lowers the window to the bottom of the window hierarchy if it is a
6253 managed window (dialog or frame).
6254 """
6255 return _core_.Window_Lower(*args, **kwargs)
6256
6257 def SetClientSize(*args, **kwargs):
6258 """
6259 SetClientSize(self, Size size)
6260
6261 This sets the size of the window client area in pixels. Using this
6262 function to size a window tends to be more device-independent than
6263 wx.Window.SetSize, since the application need not worry about what
6264 dimensions the border or title bar have when trying to fit the window
6265 around panel items, for example.
6266 """
6267 return _core_.Window_SetClientSize(*args, **kwargs)
6268
6269 def SetClientSizeWH(*args, **kwargs):
6270 """
6271 SetClientSizeWH(self, int width, int height)
6272
6273 This sets the size of the window client area in pixels. Using this
6274 function to size a window tends to be more device-independent than
6275 wx.Window.SetSize, since the application need not worry about what
6276 dimensions the border or title bar have when trying to fit the window
6277 around panel items, for example.
6278 """
6279 return _core_.Window_SetClientSizeWH(*args, **kwargs)
6280
6281 def SetClientRect(*args, **kwargs):
6282 """
6283 SetClientRect(self, Rect rect)
6284
6285 This sets the size of the window client area in pixels. Using this
6286 function to size a window tends to be more device-independent than
6287 wx.Window.SetSize, since the application need not worry about what
6288 dimensions the border or title bar have when trying to fit the window
6289 around panel items, for example.
6290 """
6291 return _core_.Window_SetClientRect(*args, **kwargs)
6292
6293 def GetPosition(*args, **kwargs):
6294 """
6295 GetPosition(self) -> Point
6296
6297 Get the window's position.
6298 """
6299 return _core_.Window_GetPosition(*args, **kwargs)
6300
6301 def GetPositionTuple(*args, **kwargs):
6302 """
6303 GetPositionTuple() -> (x,y)
6304
6305 Get the window's position.
6306 """
6307 return _core_.Window_GetPositionTuple(*args, **kwargs)
6308
6309 def GetSize(*args, **kwargs):
6310 """
6311 GetSize(self) -> Size
6312
6313 Get the window size.
6314 """
6315 return _core_.Window_GetSize(*args, **kwargs)
6316
6317 def GetSizeTuple(*args, **kwargs):
6318 """
6319 GetSizeTuple() -> (width, height)
6320
6321 Get the window size.
6322 """
6323 return _core_.Window_GetSizeTuple(*args, **kwargs)
6324
6325 def GetRect(*args, **kwargs):
6326 """
6327 GetRect(self) -> Rect
6328
6329 Returns the size and position of the window as a wx.Rect object.
6330 """
6331 return _core_.Window_GetRect(*args, **kwargs)
6332
6333 def GetClientSize(*args, **kwargs):
6334 """
6335 GetClientSize(self) -> Size
6336
6337 This gets the size of the window's 'client area' in pixels. The client
6338 area is the area which may be drawn on by the programmer, excluding
6339 title bar, border, scrollbars, etc.
6340 """
6341 return _core_.Window_GetClientSize(*args, **kwargs)
6342
6343 def GetClientSizeTuple(*args, **kwargs):
6344 """
6345 GetClientSizeTuple() -> (width, height)
6346
6347 This gets the size of the window's 'client area' in pixels. The client
6348 area is the area which may be drawn on by the programmer, excluding
6349 title bar, border, scrollbars, etc.
6350 """
6351 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
6352
6353 def GetClientAreaOrigin(*args, **kwargs):
6354 """
6355 GetClientAreaOrigin(self) -> Point
6356
6357 Get the origin of the client area of the window relative to the
6358 window's top left corner (the client area may be shifted because of
6359 the borders, scrollbars, other decorations...)
6360 """
6361 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
6362
6363 def GetClientRect(*args, **kwargs):
6364 """
6365 GetClientRect(self) -> Rect
6366
629f3c1b 6367 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD		 6368 """
6369 return _core_.Window_GetClientRect(*args, **kwargs)
6370
6371 def GetBestSize(*args, **kwargs):
6372 """
6373 GetBestSize(self) -> Size
6374
248ed943 6375 This function returns the best acceptable minimal size for the
79fccf9d
RD		 6376 window, if applicable. For example, for a static text control, it will
6377 be the minimal size such that the control label is not truncated. For
6378 windows containing subwindows (suzh aswx.Panel), the size returned by
6379 this function will be the same as the size the window would have had
6380 after calling Fit.
d55e5bfc
RD		 6381 """
6382 return _core_.Window_GetBestSize(*args, **kwargs)
6383
6384 def GetBestSizeTuple(*args, **kwargs):
6385 """
6386 GetBestSizeTuple() -> (width, height)
6387
248ed943 6388 This function returns the best acceptable minimal size for the
79fccf9d
RD		 6389 window, if applicable. For example, for a static text control, it will
6390 be the minimal size such that the control label is not truncated. For
6391 windows containing subwindows (suzh aswx.Panel), the size returned by
6392 this function will be the same as the size the window would have had
6393 after calling Fit.
d55e5bfc
RD		 6394 """
6395 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
6396
a001823c
RD		 6397 def InvalidateBestSize(*args, **kwargs):
6398 """
6399 InvalidateBestSize(self)
6400
6401 Reset the cached best size value so it will be recalculated the next
6402 time it is needed.
6403 """
6404 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6405
6406 def GetBestFittingSize(*args, **kwargs):
6407 """
6408 GetBestFittingSize(self) -> Size
6409
6410 This function will merge the window's best size into the window's
6411 minimum size, giving priority to the min size components, and returns
6412 the results.
6413
6414 """
6415 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6416
d55e5bfc
RD		 6417 def GetAdjustedBestSize(*args, **kwargs):
6418 """
6419 GetAdjustedBestSize(self) -> Size
6420
6421 This method is similar to GetBestSize, except in one
6422 thing. GetBestSize should return the minimum untruncated size of the
6423 window, while this method will return the largest of BestSize and any
6424 user specified minimum size. ie. it is the minimum size the window
6425 should currently be drawn at, not the minimal size it can possibly
6426 tolerate.
6427 """
6428 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
6429
6430 def Center(*args, **kwargs):
6431 """
6432 Center(self, int direction=BOTH)
6433
6434 Centers the window. The parameter specifies the direction for
6435 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6436 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6437 on the entire screen and not on its parent window. If it is a
6438 top-level window and has no parent then it will always be centered
6439 relative to the screen.
6440 """
6441 return _core_.Window_Center(*args, **kwargs)
6442
6443 Centre = Center
6444 def CenterOnScreen(*args, **kwargs):
6445 """
6446 CenterOnScreen(self, int dir=BOTH)
6447
6448 Center on screen (only works for top level windows)
6449 """
6450 return _core_.Window_CenterOnScreen(*args, **kwargs)
6451
6452 CentreOnScreen = CenterOnScreen
6453 def CenterOnParent(*args, **kwargs):
6454 """
6455 CenterOnParent(self, int dir=BOTH)
6456
6457 Center with respect to the the parent window
6458 """
6459 return _core_.Window_CenterOnParent(*args, **kwargs)
6460
6461 CentreOnParent = CenterOnParent
6462 def Fit(*args, **kwargs):
6463 """
6464 Fit(self)
6465
6466 Sizes the window so that it fits around its subwindows. This function
6467 won't do anything if there are no subwindows and will only really work
6468 correctly if sizers are used for the subwindows layout. Also, if the
6469 window has exactly one subwindow it is better (faster and the result
6470 is more precise as Fit adds some margin to account for fuzziness of
6471 its calculations) to call window.SetClientSize(child.GetSize())
6472 instead of calling Fit.
6473 """
6474 return _core_.Window_Fit(*args, **kwargs)
6475
6476 def FitInside(*args, **kwargs):
6477 """
6478 FitInside(self)
6479
6480 Similar to Fit, but sizes the interior (virtual) size of a
6481 window. Mainly useful with scrolled windows to reset scrollbars after
6482 sizing changes that do not trigger a size event, and/or scrolled
6483 windows without an interior sizer. This function similarly won't do
6484 anything if there are no subwindows.
6485 """
6486 return _core_.Window_FitInside(*args, **kwargs)
6487
03837c5c 6488 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD		 6489 """
6490 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
6491 int incH=-1)
d55e5bfc
RD		 6492
6493 Allows specification of minimum and maximum window sizes, and window
6494 size increments. If a pair of values is not set (or set to -1), the
6495 default values will be used. If this function is called, the user
908b74cd
RD		 6496 will not be able to size the window outside the given bounds (if it is
6497 a top-level window.) Sizers will also inspect the minimum window size
6498 and will use that value if set when calculating layout.
6499
6500 The resizing increments are only significant under Motif or Xt.
d55e5bfc 6501 """
03837c5c 6502 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 6503
03837c5c
RD		 6504 def SetSizeHintsSz(*args, **kwargs):
6505 """
6506 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6507
6508 Allows specification of minimum and maximum window sizes, and window
6509 size increments. If a pair of values is not set (or set to -1), the
6510 default values will be used. If this function is called, the user
6511 will not be able to size the window outside the given bounds (if it is
6512 a top-level window.) Sizers will also inspect the minimum window size
6513 and will use that value if set when calculating layout.
6514
6515 The resizing increments are only significant under Motif or Xt.
6516 """
6517 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6518
6519 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 6520 """
908b74cd 6521 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD		 6522
6523 Allows specification of minimum and maximum virtual window sizes. If a
6524 pair of values is not set (or set to -1), the default values will be
6525 used. If this function is called, the user will not be able to size
6526 the virtual area of the window outside the given bounds.
6527 """
03837c5c
RD		 6528 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6529
6530 def SetVirtualSizeHintsSz(*args, **kwargs):
6531 """
6532 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6533
6534 Allows specification of minimum and maximum virtual window sizes. If a
6535 pair of values is not set (or set to -1), the default values will be
6536 used. If this function is called, the user will not be able to size
6537 the virtual area of the window outside the given bounds.
6538 """
6539 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 6540
908b74cd
RD		 6541 def GetMaxSize(*args, **kwargs):
6542 """GetMaxSize(self) -> Size"""
6543 return _core_.Window_GetMaxSize(*args, **kwargs)
6544
6545 def GetMinSize(*args, **kwargs):
6546 """GetMinSize(self) -> Size"""
6547 return _core_.Window_GetMinSize(*args, **kwargs)
6548
6549 def SetMinSize(*args, **kwargs):
6550 """
6551 SetMinSize(self, Size minSize)
6552
6553 A more convenient method than `SetSizeHints` for setting just the
6554 min size.
6555 """
6556 return _core_.Window_SetMinSize(*args, **kwargs)
6557
6558 def SetMaxSize(*args, **kwargs):
6559 """
6560 SetMaxSize(self, Size maxSize)
6561
6562 A more convenient method than `SetSizeHints` for setting just the
6563 max size.
6564 """
6565 return _core_.Window_SetMaxSize(*args, **kwargs)
6566
d55e5bfc
RD		 6567 def GetMinWidth(*args, **kwargs):
6568 """GetMinWidth(self) -> int"""
6569 return _core_.Window_GetMinWidth(*args, **kwargs)
6570
6571 def GetMinHeight(*args, **kwargs):
6572 """GetMinHeight(self) -> int"""
6573 return _core_.Window_GetMinHeight(*args, **kwargs)
6574
6575 def GetMaxWidth(*args, **kwargs):
6576 """GetMaxWidth(self) -> int"""
6577 return _core_.Window_GetMaxWidth(*args, **kwargs)
6578
6579 def GetMaxHeight(*args, **kwargs):
6580 """GetMaxHeight(self) -> int"""
6581 return _core_.Window_GetMaxHeight(*args, **kwargs)
6582
d55e5bfc
RD		 6583 def SetVirtualSize(*args, **kwargs):
6584 """
6585 SetVirtualSize(self, Size size)
6586
6587 Set the the virtual size of a window in pixels. For most windows this
6588 is just the client area of the window, but for some like scrolled
6589 windows it is more or less independent of the screen window size.
6590 """
6591 return _core_.Window_SetVirtualSize(*args, **kwargs)
6592
6593 def SetVirtualSizeWH(*args, **kwargs):
6594 """
6595 SetVirtualSizeWH(self, int w, int h)
6596
6597 Set the the virtual size of a window in pixels. For most windows this
6598 is just the client area of the window, but for some like scrolled
6599 windows it is more or less independent of the screen window size.
6600 """
6601 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6602
6603 def GetVirtualSize(*args, **kwargs):
6604 """
6605 GetVirtualSize(self) -> Size
6606
6607 Get the the virtual size of the window in pixels. For most windows
6608 this is just the client area of the window, but for some like scrolled
6609 windows it is more or less independent of the screen window size.
6610 """
6611 return _core_.Window_GetVirtualSize(*args, **kwargs)
6612
6613 def GetVirtualSizeTuple(*args, **kwargs):
6614 """
6615 GetVirtualSizeTuple() -> (width, height)
6616
6617 Get the the virtual size of the window in pixels. For most windows
6618 this is just the client area of the window, but for some like scrolled
6619 windows it is more or less independent of the screen window size.
6620 """
6621 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6622
6623 def GetBestVirtualSize(*args, **kwargs):
6624 """
6625 GetBestVirtualSize(self) -> Size
6626
6627 Return the largest of ClientSize and BestSize (as determined by a
6628 sizer, interior children, or other means)
6629 """
6630 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6631
6632 def Show(*args, **kwargs):
6633 """
6634 Show(self, bool show=True) -> bool
6635
6636 Shows or hides the window. You may need to call Raise for a top level
6637 window if you want to bring it to top, although this is not needed if
6638 Show is called immediately after the frame creation. Returns True if
6639 the window has been shown or hidden or False if nothing was done
6640 because it already was in the requested state.
6641 """
6642 return _core_.Window_Show(*args, **kwargs)
6643
6644 def Hide(*args, **kwargs):
6645 """
6646 Hide(self) -> bool
6647
6648 Equivalent to calling Show(False).
6649 """
6650 return _core_.Window_Hide(*args, **kwargs)
6651
6652 def Enable(*args, **kwargs):
6653 """
6654 Enable(self, bool enable=True) -> bool
6655
6656 Enable or disable the window for user input. Note that when a parent
6657 window is disabled, all of its children are disabled as well and they
6658 are reenabled again when the parent is. Returns true if the window
6659 has been enabled or disabled, false if nothing was done, i.e. if the
6660 window had already been in the specified state.
6661 """
6662 return _core_.Window_Enable(*args, **kwargs)
6663
6664 def Disable(*args, **kwargs):
6665 """
6666 Disable(self) -> bool
6667
6668 Disables the window, same as Enable(false).
6669 """
6670 return _core_.Window_Disable(*args, **kwargs)
6671
6672 def IsShown(*args, **kwargs):
6673 """
6674 IsShown(self) -> bool
6675
6676 Returns true if the window is shown, false if it has been hidden.
6677 """
6678 return _core_.Window_IsShown(*args, **kwargs)
6679
6680 def IsEnabled(*args, **kwargs):
6681 """
6682 IsEnabled(self) -> bool
6683
6684 Returns true if the window is enabled for input, false otherwise.
6685 """
6686 return _core_.Window_IsEnabled(*args, **kwargs)
6687
6688 def SetWindowStyleFlag(*args, **kwargs):
6689 """
6690 SetWindowStyleFlag(self, long style)
6691
79fccf9d
RD		 6692 Sets the style of the window. Please note that some styles cannot be
6693 changed after the window creation and that Refresh() might need to be
6694 called after changing the others for the change to take place
6695 immediately.
d55e5bfc
RD		 6696 """
6697 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6698
6699 def GetWindowStyleFlag(*args, **kwargs):
6700 """
6701 GetWindowStyleFlag(self) -> long
6702
6703 Gets the window style that was passed to the constructor or Create
6704 method.
6705 """
6706 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6707
6708 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6709 def HasFlag(*args, **kwargs):
6710 """
6711 HasFlag(self, int flag) -> bool
6712
6713 Test if the given style is set for this window.
6714 """
6715 return _core_.Window_HasFlag(*args, **kwargs)
6716
6717 def IsRetained(*args, **kwargs):
6718 """
6719 IsRetained(self) -> bool
6720
6721 Returns true if the window is retained, false otherwise. Retained
6722 windows are only available on X platforms.
6723 """
6724 return _core_.Window_IsRetained(*args, **kwargs)
6725
6726 def SetExtraStyle(*args, **kwargs):
6727 """
6728 SetExtraStyle(self, long exStyle)
6729
6730 Sets the extra style bits for the window. Extra styles are the less
6731 often used style bits which can't be set with the constructor or with
6732 SetWindowStyleFlag()
6733 """
6734 return _core_.Window_SetExtraStyle(*args, **kwargs)
6735
6736 def GetExtraStyle(*args, **kwargs):
6737 """
6738 GetExtraStyle(self) -> long
6739
6740 Returns the extra style bits for the window.
6741 """
6742 return _core_.Window_GetExtraStyle(*args, **kwargs)
6743
6744 def MakeModal(*args, **kwargs):
6745 """
6746 MakeModal(self, bool modal=True)
6747
6748 Disables all other windows in the application so that the user can
6749 only interact with this window. Passing False will reverse this
6750 effect.
6751 """
6752 return _core_.Window_MakeModal(*args, **kwargs)
6753
6754 def SetThemeEnabled(*args, **kwargs):
6755 """
6756 SetThemeEnabled(self, bool enableTheme)
6757
6758 This function tells a window if it should use the system's "theme"
6759 code to draw the windows' background instead if its own background
6760 drawing code. This will only have an effect on platforms that support
6761 the notion of themes in user defined windows. One such platform is
6762 GTK+ where windows can have (very colourful) backgrounds defined by a
6763 user's selected theme.
6764
6765 Dialogs, notebook pages and the status bar have this flag set to true
6766 by default so that the default look and feel is simulated best.
6767 """
6768 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6769
6770 def GetThemeEnabled(*args, **kwargs):
6771 """
6772 GetThemeEnabled(self) -> bool
6773
6774 Return the themeEnabled flag.
6775 """
6776 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6777
6778 def SetFocus(*args, **kwargs):
6779 """
6780 SetFocus(self)
6781
6782 Set's the focus to this window, allowing it to receive keyboard input.
6783 """
6784 return _core_.Window_SetFocus(*args, **kwargs)
6785
6786 def SetFocusFromKbd(*args, **kwargs):
6787 """
6788 SetFocusFromKbd(self)
6789
6790 Set focus to this window as the result of a keyboard action. Normally
6791 only called internally.
6792 """
6793 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6794
6795 def FindFocus(*args, **kwargs):
6796 """
c24da6d6 6797 FindFocus() -> Window
d55e5bfc
RD		 6798
6799 Returns the window or control that currently has the keyboard focus,
6800 or None.
6801 """
6802 return _core_.Window_FindFocus(*args, **kwargs)
6803
6804 FindFocus = staticmethod(FindFocus)
6805 def AcceptsFocus(*args, **kwargs):
6806 """
6807 AcceptsFocus(self) -> bool
6808
6809 Can this window have focus?
6810 """
6811 return _core_.Window_AcceptsFocus(*args, **kwargs)
6812
6813 def AcceptsFocusFromKeyboard(*args, **kwargs):
6814 """
6815 AcceptsFocusFromKeyboard(self) -> bool
6816
6817 Can this window be given focus by keyboard navigation? if not, the
6818 only way to give it focus (provided it accepts it at all) is to click
6819 it.
6820 """
6821 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6822
6823 def GetDefaultItem(*args, **kwargs):
6824 """
6825 GetDefaultItem(self) -> Window
6826
6827 Get the default child of this parent, i.e. the one which is activated
6828 by pressing <Enter> such as the OK button on a wx.Dialog.
6829 """
6830 return _core_.Window_GetDefaultItem(*args, **kwargs)
6831
6832 def SetDefaultItem(*args, **kwargs):
6833 """
6834 SetDefaultItem(self, Window child) -> Window
6835
6836 Set this child as default, return the old default.
6837 """
6838 return _core_.Window_SetDefaultItem(*args, **kwargs)
6839
6840 def SetTmpDefaultItem(*args, **kwargs):
6841 """
6842 SetTmpDefaultItem(self, Window win)
6843
6844 Set this child as temporary default
6845 """
6846 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6847
908b74cd
RD		 6848 def Navigate(*args, **kwargs):
6849 """
6850 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6851
a8eff060
RD		 6852 Does keyboard navigation from this window to another, by sending a
6853 `wx.NavigationKeyEvent`.
908b74cd
RD		 6854 """
6855 return _core_.Window_Navigate(*args, **kwargs)
6856
bf26d883
RD		 6857 def MoveAfterInTabOrder(*args, **kwargs):
6858 """
6859 MoveAfterInTabOrder(self, Window win)
6860
6861 Moves this window in the tab navigation order after the specified
6862 sibling window. This means that when the user presses the TAB key on
6863 that other window, the focus switches to this window.
6864
6865 The default tab order is the same as creation order. This function
6866 and `MoveBeforeInTabOrder` allow to change it after creating all the
6867 windows.
6868
6869 """
6870 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6871
6872 def MoveBeforeInTabOrder(*args, **kwargs):
6873 """
6874 MoveBeforeInTabOrder(self, Window win)
6875
6876 Same as `MoveAfterInTabOrder` except that it inserts this window just
6877 before win instead of putting it right after it.
6878 """
6879 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6880
d55e5bfc
RD		 6881 def GetChildren(*args, **kwargs):
6882 """
6883 GetChildren(self) -> PyObject
6884
6885 Returns a list of the window's children. NOTE: Currently this is a
6886 copy of the child window list maintained by the window, so the return
6887 value of this function is only valid as long as the window's children
6888 do not change.
6889 """
6890 return _core_.Window_GetChildren(*args, **kwargs)
6891
6892 def GetParent(*args, **kwargs):
6893 """
6894 GetParent(self) -> Window
6895
6896 Returns the parent window of this window, or None if there isn't one.
6897 """
6898 return _core_.Window_GetParent(*args, **kwargs)
6899
6900 def GetGrandParent(*args, **kwargs):
6901 """
6902 GetGrandParent(self) -> Window
6903
79fccf9d
RD		 6904 Returns the parent of the parent of this window, or None if there
6905 isn't one.
d55e5bfc
RD		 6906 """
6907 return _core_.Window_GetGrandParent(*args, **kwargs)
6908
6909 def IsTopLevel(*args, **kwargs):
6910 """
6911 IsTopLevel(self) -> bool
6912
6913 Returns true if the given window is a top-level one. Currently all
6914 frames and dialogs are always considered to be top-level windows (even
6915 if they have a parent window).
6916 """
6917 return _core_.Window_IsTopLevel(*args, **kwargs)
6918
6919 def Reparent(*args, **kwargs):
6920 """
6921 Reparent(self, Window newParent) -> bool
6922
6923 Reparents the window, i.e the window will be removed from its current
6924 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6925 re-inserted into another. Available on Windows and GTK. Returns True
6926 if the parent was changed, False otherwise (error or newParent ==
6927 oldParent)
6928 """
6929 return _core_.Window_Reparent(*args, **kwargs)
6930
6931 def AddChild(*args, **kwargs):
6932 """
6933 AddChild(self, Window child)
6934
6935 Adds a child window. This is called automatically by window creation
6936 functions so should not be required by the application programmer.
6937 """
6938 return _core_.Window_AddChild(*args, **kwargs)
6939
6940 def RemoveChild(*args, **kwargs):
6941 """
6942 RemoveChild(self, Window child)
6943
6944 Removes a child window. This is called automatically by window
6945 deletion functions so should not be required by the application
6946 programmer.
6947 """
6948 return _core_.Window_RemoveChild(*args, **kwargs)
6949
6950 def FindWindowById(*args, **kwargs):
6951 """
6952 FindWindowById(self, long winid) -> Window
6953
6954 Find a chld of this window by window ID
6955 """
6956 return _core_.Window_FindWindowById(*args, **kwargs)
6957
6958 def FindWindowByName(*args, **kwargs):
6959 """
6960 FindWindowByName(self, String name) -> Window
6961
6962 Find a child of this window by name
6963 """
6964 return _core_.Window_FindWindowByName(*args, **kwargs)
6965
6966 def GetEventHandler(*args, **kwargs):
6967 """
6968 GetEventHandler(self) -> EvtHandler
6969
6970 Returns the event handler for this window. By default, the window is
6971 its own event handler.
6972 """
6973 return _core_.Window_GetEventHandler(*args, **kwargs)
6974
6975 def SetEventHandler(*args, **kwargs):
6976 """
6977 SetEventHandler(self, EvtHandler handler)
6978
6979 Sets the event handler for this window. An event handler is an object
6980 that is capable of processing the events sent to a window. By default,
6981 the window is its own event handler, but an application may wish to
6982 substitute another, for example to allow central implementation of
6983 event-handling for a variety of different window classes.
6984
79fccf9d 6985 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD		 6986 up a chain of event handlers, where an event not handled by one event
6987 handler is handed to the next one in the chain.
6988 """
6989 return _core_.Window_SetEventHandler(*args, **kwargs)
6990
6991 def PushEventHandler(*args, **kwargs):
6992 """
6993 PushEventHandler(self, EvtHandler handler)
6994
6995 Pushes this event handler onto the event handler stack for the window.
6996 An event handler is an object that is capable of processing the events
6997 sent to a window. By default, the window is its own event handler, but
6998 an application may wish to substitute another, for example to allow
6999 central implementation of event-handling for a variety of different
7000 window classes.
7001
7002 wx.Window.PushEventHandler allows an application to set up a chain of
7003 event handlers, where an event not handled by one event handler is
79fccf9d 7004 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD		 7005 remove the event handler.
7006 """
7007 return _core_.Window_PushEventHandler(*args, **kwargs)
7008
7009 def PopEventHandler(*args, **kwargs):
7010 """
7011 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
7012
7013 Removes and returns the top-most event handler on the event handler
7014 stack. If deleteHandler is True then the wx.EvtHandler object will be
7015 destroyed after it is popped.
7016 """
7017 return _core_.Window_PopEventHandler(*args, **kwargs)
7018
7019 def RemoveEventHandler(*args, **kwargs):
7020 """
7021 RemoveEventHandler(self, EvtHandler handler) -> bool
7022
79fccf9d
RD		 7023 Find the given handler in the event handler chain and remove (but not
7024 delete) it from the event handler chain, return True if it was found
7025 and False otherwise (this also results in an assert failure so this
7026 function should only be called when the handler is supposed to be
7027 there.)
d55e5bfc
RD		 7028 """
7029 return _core_.Window_RemoveEventHandler(*args, **kwargs)
7030
7031 def SetValidator(*args, **kwargs):
7032 """
7033 SetValidator(self, Validator validator)
7034
7035 Deletes the current validator (if any) and sets the window validator,
7036 having called wx.Validator.Clone to create a new validator of this
7037 type.
7038 """
7039 return _core_.Window_SetValidator(*args, **kwargs)
7040
7041 def GetValidator(*args, **kwargs):
7042 """
7043 GetValidator(self) -> Validator
7044
7045 Returns a pointer to the current validator for the window, or None if
7046 there is none.
7047 """
7048 return _core_.Window_GetValidator(*args, **kwargs)
7049
7050 def Validate(*args, **kwargs):
7051 """
7052 Validate(self) -> bool
7053
7054 Validates the current values of the child controls using their
79fccf9d
RD		 7055 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
7056 style flag set, the method will also call Validate() of all child
7057 windows. Returns false if any of the validations failed.
d55e5bfc
RD		 7058 """
7059 return _core_.Window_Validate(*args, **kwargs)
7060
7061 def TransferDataToWindow(*args, **kwargs):
7062 """
7063 TransferDataToWindow(self) -> bool
7064
79fccf9d
RD		 7065 Transfers values to child controls from data areas specified by their
7066 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
7067 style flag set, the method will also call TransferDataToWindow() of
7068 all child windows.
d55e5bfc
RD		 7069 """
7070 return _core_.Window_TransferDataToWindow(*args, **kwargs)
7071
7072 def TransferDataFromWindow(*args, **kwargs):
7073 """
7074 TransferDataFromWindow(self) -> bool
7075
79fccf9d
RD		 7076 Transfers values from child controls to data areas specified by their
7077 validators. Returns false if a transfer failed. If the window has
7078 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
7079 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD		 7080 """
7081 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
7082
7083 def InitDialog(*args, **kwargs):
7084 """
7085 InitDialog(self)
7086
79fccf9d
RD		 7087 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
7088 to the dialog via validators.
d55e5bfc
RD		 7089 """
7090 return _core_.Window_InitDialog(*args, **kwargs)
7091
7092 def SetAcceleratorTable(*args, **kwargs):
7093 """
7094 SetAcceleratorTable(self, AcceleratorTable accel)
7095
7096 Sets the accelerator table for this window.
7097 """
7098 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
7099
7100 def GetAcceleratorTable(*args, **kwargs):
7101 """
7102 GetAcceleratorTable(self) -> AcceleratorTable
7103
7104 Gets the accelerator table for this window.
7105 """
7106 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
7107
7108 def RegisterHotKey(*args, **kwargs):
7109 """
7110 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
7111
7112 Registers a system wide hotkey. Every time the user presses the hotkey
7113 registered here, this window will receive a hotkey event. It will
7114 receive the event even if the application is in the background and
7115 does not have the input focus because the user is working with some
7116 other application. To bind an event handler function to this hotkey
7117 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
7118 hotkey was registered successfully.
7119 """
7120 return _core_.Window_RegisterHotKey(*args, **kwargs)
7121
7122 def UnregisterHotKey(*args, **kwargs):
7123 """
7124 UnregisterHotKey(self, int hotkeyId) -> bool
7125
7126 Unregisters a system wide hotkey.
7127 """
7128 return _core_.Window_UnregisterHotKey(*args, **kwargs)
7129
7130 def ConvertDialogPointToPixels(*args, **kwargs):
7131 """
7132 ConvertDialogPointToPixels(self, Point pt) -> Point
7133
7134 Converts a point or size from dialog units to pixels. Dialog units
7135 are used for maintaining a dialog's proportions even if the font
7136 changes. For the x dimension, the dialog units are multiplied by the
7137 average character width and then divided by 4. For the y dimension,
7138 the dialog units are multiplied by the average character height and
7139 then divided by 8.
7140 """
7141 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
7142
7143 def ConvertDialogSizeToPixels(*args, **kwargs):
7144 """
7145 ConvertDialogSizeToPixels(self, Size sz) -> Size
7146
7147 Converts a point or size from dialog units to pixels. Dialog units
7148 are used for maintaining a dialog's proportions even if the font
7149 changes. For the x dimension, the dialog units are multiplied by the
7150 average character width and then divided by 4. For the y dimension,
7151 the dialog units are multiplied by the average character height and
7152 then divided by 8.
7153 """
7154 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
7155
7156 def DLG_PNT(*args, **kwargs):
7157 """
7158 DLG_PNT(self, Point pt) -> Point
7159
7160 Converts a point or size from dialog units to pixels. Dialog units
7161 are used for maintaining a dialog's proportions even if the font
7162 changes. For the x dimension, the dialog units are multiplied by the
7163 average character width and then divided by 4. For the y dimension,
7164 the dialog units are multiplied by the average character height and
7165 then divided by 8.
7166 """
7167 return _core_.Window_DLG_PNT(*args, **kwargs)
7168
7169 def DLG_SZE(*args, **kwargs):
7170 """
7171 DLG_SZE(self, Size sz) -> Size
7172
7173 Converts a point or size from dialog units to pixels. Dialog units
7174 are used for maintaining a dialog's proportions even if the font
7175 changes. For the x dimension, the dialog units are multiplied by the
7176 average character width and then divided by 4. For the y dimension,
7177 the dialog units are multiplied by the average character height and
7178 then divided by 8.
7179 """
7180 return _core_.Window_DLG_SZE(*args, **kwargs)
7181
7182 def ConvertPixelPointToDialog(*args, **kwargs):
7183 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
7184 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
7185
7186 def ConvertPixelSizeToDialog(*args, **kwargs):
7187 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
7188 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
7189
7190 def WarpPointer(*args, **kwargs):
7191 """
7192 WarpPointer(self, int x, int y)
7193
7194 Moves the pointer to the given position on the window.
7195
7196 NOTE: This function is not supported under Mac because Apple Human
7197 Interface Guidelines forbid moving the mouse cursor programmatically.
7198 """
7199 return _core_.Window_WarpPointer(*args, **kwargs)
7200
7201 def CaptureMouse(*args, **kwargs):
7202 """
7203 CaptureMouse(self)
7204
7205 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
7206 release the capture.
7207
7208 Note that wxWindows maintains the stack of windows having captured the
7209 mouse and when the mouse is released the capture returns to the window
7210 which had had captured it previously and it is only really released if
7211 there were no previous window. In particular, this means that you must
7212 release the mouse as many times as you capture it.
7213 """
7214 return _core_.Window_CaptureMouse(*args, **kwargs)
7215
7216 def ReleaseMouse(*args, **kwargs):
7217 """
7218 ReleaseMouse(self)
7219
7220 Releases mouse input captured with wx.Window.CaptureMouse.
7221 """
7222 return _core_.Window_ReleaseMouse(*args, **kwargs)
7223
7224 def GetCapture(*args, **kwargs):
7225 """
c24da6d6 7226 GetCapture() -> Window
d55e5bfc
RD		 7227
7228 Returns the window which currently captures the mouse or None
7229 """
7230 return _core_.Window_GetCapture(*args, **kwargs)
7231
7232 GetCapture = staticmethod(GetCapture)
7233 def HasCapture(*args, **kwargs):
7234 """
7235 HasCapture(self) -> bool
7236
7237 Returns true if this window has the current mouse capture.
7238 """
7239 return _core_.Window_HasCapture(*args, **kwargs)
7240
7241 def Refresh(*args, **kwargs):
7242 """
7243 Refresh(self, bool eraseBackground=True, Rect rect=None)
7244
7245 Mark the specified rectangle (or the whole window) as "dirty" so it
7246 will be repainted. Causes an EVT_PAINT event to be generated and sent
7247 to the window.
7248 """
7249 return _core_.Window_Refresh(*args, **kwargs)
7250
7251 def RefreshRect(*args, **kwargs):
7252 """
fef4c27a 7253 RefreshRect(self, Rect rect, bool eraseBackground=True)
d55e5bfc
RD		 7254
7255 Redraws the contents of the given rectangle: the area inside it will
7256 be repainted. This is the same as Refresh but has a nicer syntax.
7257 """
7258 return _core_.Window_RefreshRect(*args, **kwargs)
7259
7260 def Update(*args, **kwargs):
7261 """
7262 Update(self)
7263
7264 Calling this method immediately repaints the invalidated area of the
7265 window instead of waiting for the EVT_PAINT event to happen, (normally
7266 this would usually only happen when the flow of control returns to the
7267 event loop.) Notice that this function doesn't refresh the window and
7268 does nothing if the window has been already repainted. Use Refresh
7269 first if you want to immediately redraw the window (or some portion of
7270 it) unconditionally.
7271 """
7272 return _core_.Window_Update(*args, **kwargs)
7273
7274 def ClearBackground(*args, **kwargs):
7275 """
7276 ClearBackground(self)
7277
7278 Clears the window by filling it with the current background
7279 colour. Does not cause an erase background event to be generated.
7280 """
7281 return _core_.Window_ClearBackground(*args, **kwargs)
7282
7283 def Freeze(*args, **kwargs):
7284 """
7285 Freeze(self)
7286
79fccf9d
RD		 7287 Freezes the window or, in other words, prevents any updates from
7288 taking place on screen, the window is not redrawn at all. Thaw must be
7289 called to reenable window redrawing. Calls to Freeze/Thaw may be
7290 nested, with the actual Thaw being delayed until all the nesting has
7291 been undone.
d55e5bfc
RD		 7292
7293 This method is useful for visual appearance optimization (for example,
7294 it is a good idea to use it before inserting large amount of text into
7295 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
7296 for all controls so it is mostly just a hint to wxWindows and not a
7297 mandatory directive.
7298 """
7299 return _core_.Window_Freeze(*args, **kwargs)
7300
7301 def Thaw(*args, **kwargs):
7302 """
7303 Thaw(self)
7304
7305 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD		 7306 Freeze/Thaw may be nested, so Thaw must be called the same number of
7307 times that Freeze was before the window will be updated.
d55e5bfc
RD		 7308 """
7309 return _core_.Window_Thaw(*args, **kwargs)
7310
7311 def PrepareDC(*args, **kwargs):
7312 """
7313 PrepareDC(self, DC dc)
7314
7315 Call this function to prepare the device context for drawing a
7316 scrolled image. It sets the device origin according to the current
7317 scroll position.
7318 """
7319 return _core_.Window_PrepareDC(*args, **kwargs)
7320
7321 def GetUpdateRegion(*args, **kwargs):
7322 """
7323 GetUpdateRegion(self) -> Region
7324
7325 Returns the region specifying which parts of the window have been
7326 damaged. Should only be called within an EVT_PAINT handler.
7327 """
7328 return _core_.Window_GetUpdateRegion(*args, **kwargs)
7329
7330 def GetUpdateClientRect(*args, **kwargs):
7331 """
7332 GetUpdateClientRect(self) -> Rect
7333
7334 Get the update rectangle region bounding box in client coords.
7335 """
7336 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
7337
7338 def IsExposed(*args, **kwargs):
7339 """
7340 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
7341
7342 Returns true if the given point or rectangle area has been exposed
7343 since the last repaint. Call this in an paint event handler to
7344 optimize redrawing by only redrawing those areas, which have been
7345 exposed.
7346 """
7347 return _core_.Window_IsExposed(*args, **kwargs)
7348
7349 def IsExposedPoint(*args, **kwargs):
7350 """
7351 IsExposedPoint(self, Point pt) -> bool
7352
7353 Returns true if the given point or rectangle area has been exposed
7354 since the last repaint. Call this in an paint event handler to
7355 optimize redrawing by only redrawing those areas, which have been
7356 exposed.
7357 """
7358 return _core_.Window_IsExposedPoint(*args, **kwargs)
7359
7360 def IsExposedRect(*args, **kwargs):
7361 """
7362 IsExposedRect(self, Rect rect) -> bool
7363
7364 Returns true if the given point or rectangle area has been exposed
7365 since the last repaint. Call this in an paint event handler to
7366 optimize redrawing by only redrawing those areas, which have been
7367 exposed.
7368 """
7369 return _core_.Window_IsExposedRect(*args, **kwargs)
7370
7371 def GetDefaultAttributes(*args, **kwargs):
7372 """
7373 GetDefaultAttributes(self) -> VisualAttributes
7374
79fccf9d
RD		 7375 Get the default attributes for an instance of this class. This is
7376 useful if you want to use the same font or colour in your own control
7377 as in a standard control -- which is a much better idea than hard
7378 coding specific colours or fonts which might look completely out of
caef1a4d 7379 place on the user's system, especially if it uses themes.
d55e5bfc
RD		 7380 """
7381 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
7382
7383 def GetClassDefaultAttributes(*args, **kwargs):
7384 """
c24da6d6 7385 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 7386
79fccf9d
RD		 7387 Get the default attributes for this class. This is useful if you want
7388 to use the same font or colour in your own control as in a standard
7389 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 7390 colours or fonts which might look completely out of place on the
7391 user's system, especially if it uses themes.
d55e5bfc
RD		 7392
7393 The variant parameter is only relevant under Mac currently and is
79fccf9d 7394 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 7395 the returned font. See `wx.Window.SetWindowVariant` for more about
7396 this.
d55e5bfc
RD		 7397 """
7398 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7399
7400 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
7401 def SetBackgroundColour(*args, **kwargs):
7402 """
7403 SetBackgroundColour(self, Colour colour) -> bool
7404
7405 Sets the background colour of the window. Returns True if the colour
7406 was changed. The background colour is usually painted by the default
7407 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD		 7408 automatically under GTK. Using `wx.NullColour` will reset the window
7409 to the default background colour.
d55e5bfc 7410
caef1a4d 7411 Note that setting the background colour may not cause an immediate
f8167d6e 7412 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD		 7413 calling this function.
7414
f8167d6e
RD		 7415 Using this function will disable attempts to use themes for this
7416 window, if the system supports them. Use with care since usually the
7417 themes represent the appearance chosen by the user to be used for all
7418 applications on the system.
d55e5bfc
RD		 7419 """
7420 return _core_.Window_SetBackgroundColour(*args, **kwargs)
7421
412d302d
RD		 7422 def SetOwnBackgroundColour(*args, **kwargs):
7423 """SetOwnBackgroundColour(self, Colour colour)"""
7424 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD		 7425
7426 def SetForegroundColour(*args, **kwargs):
7427 """
7428 SetForegroundColour(self, Colour colour) -> bool
7429
7430 Sets the foreground colour of the window. Returns True is the colour
7431 was changed. The interpretation of foreground colour is dependent on
7432 the window class; it may be the text colour or other colour, or it may
7433 not be used at all.
7434 """
7435 return _core_.Window_SetForegroundColour(*args, **kwargs)
7436
fa47d7a7
VS		 7437 def SetOwnForegroundColour(*args, **kwargs):
7438 """SetOwnForegroundColour(self, Colour colour)"""
7439 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD		 7440
7441 def GetBackgroundColour(*args, **kwargs):
7442 """
7443 GetBackgroundColour(self) -> Colour
7444
7445 Returns the background colour of the window.
7446 """
7447 return _core_.Window_GetBackgroundColour(*args, **kwargs)
7448
7449 def GetForegroundColour(*args, **kwargs):
7450 """
7451 GetForegroundColour(self) -> Colour
7452
7453 Returns the foreground colour of the window. The interpretation of
7454 foreground colour is dependent on the window class; it may be the text
7455 colour or other colour, or it may not be used at all.
7456 """
7457 return _core_.Window_GetForegroundColour(*args, **kwargs)
7458
dcb8fc74
RD		 7459 def InheritsBackgroundColour(*args, **kwargs):
7460 """InheritsBackgroundColour(self) -> bool"""
7461 return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
7462
7463 def UseBgCol(*args, **kwargs):
7464 """UseBgCol(self) -> bool"""
7465 return _core_.Window_UseBgCol(*args, **kwargs)
7466
0f63ec68
RD		 7467 def SetBackgroundStyle(*args, **kwargs):
7468 """
7469 SetBackgroundStyle(self, int style) -> bool
7470
7471 Returns the background style of the window. The background style
7472 indicates how the background of the window is drawn.
7473
7474 ====================== ========================================
7475 wx.BG_STYLE_SYSTEM The background colour or pattern should
7476 be determined by the system
7477 wx.BG_STYLE_COLOUR The background should be a solid colour
7478 wx.BG_STYLE_CUSTOM The background will be implemented by the
7479 application.
7480 ====================== ========================================
7481
7482 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7483 a custom background, such as a tiled bitmap. Currently the style has
7484 no effect on other platforms.
7485
7486 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7487 """
7488 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7489
7490 def GetBackgroundStyle(*args, **kwargs):
7491 """
7492 GetBackgroundStyle(self) -> int
7493
7494 Returns the background style of the window.
7495
7496 :see: `SetBackgroundStyle`
7497 """
7498 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7499
51b83b37
RD		 7500 def HasTransparentBackground(*args, **kwargs):
7501 """
7502 HasTransparentBackground(self) -> bool
7503
7504 Returns True if this window's background is transparent (as, for
7505 example, for `wx.StaticText`) and should show the parent window's
7506 background.
7507
7508 This method is mostly used internally by the library itself and you
7509 normally shouldn't have to call it. You may, however, have to override
7510 it in your custom control classes to ensure that background is painted
7511 correctly.
7512 """
7513 return _core_.Window_HasTransparentBackground(*args, **kwargs)
7514
d55e5bfc
RD		 7515 def SetCursor(*args, **kwargs):
7516 """
7517 SetCursor(self, Cursor cursor) -> bool
7518
7519 Sets the window's cursor. Notice that the window cursor also sets it
7520 for the children of the window implicitly.
7521
7522 The cursor may be wx.NullCursor in which case the window cursor will
7523 be reset back to default.
7524 """
7525 return _core_.Window_SetCursor(*args, **kwargs)
7526
7527 def GetCursor(*args, **kwargs):
7528 """
7529 GetCursor(self) -> Cursor
7530
7531 Return the cursor associated with this window.
7532 """
7533 return _core_.Window_GetCursor(*args, **kwargs)
7534
7535 def SetFont(*args, **kwargs):
7536 """
7537 SetFont(self, Font font) -> bool
7538
7539 Sets the font for this window.
7540 """
7541 return _core_.Window_SetFont(*args, **kwargs)
7542
fa47d7a7
VS		 7543 def SetOwnFont(*args, **kwargs):
7544 """SetOwnFont(self, Font font)"""
7545 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD		 7546
7547 def GetFont(*args, **kwargs):
7548 """
7549 GetFont(self) -> Font
7550
7551 Returns the default font used for this window.
7552 """
7553 return _core_.Window_GetFont(*args, **kwargs)
7554
7555 def SetCaret(*args, **kwargs):
7556 """
7557 SetCaret(self, Caret caret)
7558
7559 Sets the caret associated with the window.
7560 """
7561 return _core_.Window_SetCaret(*args, **kwargs)
7562
7563 def GetCaret(*args, **kwargs):
7564 """
7565 GetCaret(self) -> Caret
7566
7567 Returns the caret associated with the window.
7568 """
7569 return _core_.Window_GetCaret(*args, **kwargs)
7570
7571 def GetCharHeight(*args, **kwargs):
7572 """
7573 GetCharHeight(self) -> int
7574
7575 Get the (average) character size for the current font.
7576 """
7577 return _core_.Window_GetCharHeight(*args, **kwargs)
7578
7579 def GetCharWidth(*args, **kwargs):
7580 """
7581 GetCharWidth(self) -> int
7582
7583 Get the (average) character size for the current font.
7584 """
7585 return _core_.Window_GetCharWidth(*args, **kwargs)
7586
7587 def GetTextExtent(*args, **kwargs):
a8eff060
RD		 7588 """
7589 GetTextExtent(String string) -> (width, height)
7590
7591 Get the width and height of the text using the current font.
7592 """
d55e5bfc
RD		 7593 return _core_.Window_GetTextExtent(*args, **kwargs)
7594
7595 def GetFullTextExtent(*args, **kwargs):
7596 """
7597 GetFullTextExtent(String string, Font font=None) ->
7598 (width, height, descent, externalLeading)
7599
7600 Get the width, height, decent and leading of the text using the
7601 current or specified font.
7602 """
7603 return _core_.Window_GetFullTextExtent(*args, **kwargs)
7604
7605 def ClientToScreenXY(*args, **kwargs):
7606 """
7607 ClientToScreenXY(int x, int y) -> (x,y)
7608
7609 Converts to screen coordinates from coordinates relative to this window.
7610 """
7611 return _core_.Window_ClientToScreenXY(*args, **kwargs)
7612
7613 def ScreenToClientXY(*args, **kwargs):
7614 """
7615 ScreenToClientXY(int x, int y) -> (x,y)
7616
7617 Converts from screen to client window coordinates.
7618 """
7619 return _core_.Window_ScreenToClientXY(*args, **kwargs)
7620
7621 def ClientToScreen(*args, **kwargs):
7622 """
7623 ClientToScreen(self, Point pt) -> Point
7624
7625 Converts to screen coordinates from coordinates relative to this window.
7626 """
7627 return _core_.Window_ClientToScreen(*args, **kwargs)
7628
7629 def ScreenToClient(*args, **kwargs):
7630 """
7631 ScreenToClient(self, Point pt) -> Point
7632
7633 Converts from screen to client window coordinates.
7634 """
7635 return _core_.Window_ScreenToClient(*args, **kwargs)
7636
7637 def HitTestXY(*args, **kwargs):
7638 """
7639 HitTestXY(self, int x, int y) -> int
7640
7641 Test where the given (in client coords) point lies
7642 """
7643 return _core_.Window_HitTestXY(*args, **kwargs)
7644
7645 def HitTest(*args, **kwargs):
7646 """
7647 HitTest(self, Point pt) -> int
7648
7649 Test where the given (in client coords) point lies
7650 """
7651 return _core_.Window_HitTest(*args, **kwargs)
7652
7653 def GetBorder(*args):
7654 """
7655 GetBorder(self, long flags) -> int
7656 GetBorder(self) -> int
7657
7658 Get border for the flags of this window
7659 """
7660 return _core_.Window_GetBorder(*args)
7661
7662 def UpdateWindowUI(*args, **kwargs):
7663 """
7664 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
7665
7666 This function sends EVT_UPDATE_UI events to the window. The particular
7667 implementation depends on the window; for example a wx.ToolBar will
7668 send an update UI event for each toolbar button, and a wx.Frame will
7669 send an update UI event for each menubar menu item. You can call this
7670 function from your application to ensure that your UI is up-to-date at
7671 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7672 concerned). This may be necessary if you have called
7673 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7674 limit the overhead that wxWindows incurs by sending update UI events
7675 in idle time.
d55e5bfc
RD		 7676 """
7677 return _core_.Window_UpdateWindowUI(*args, **kwargs)
7678
7679 def PopupMenuXY(*args, **kwargs):
7680 """
7a0b95b0 7681 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7682
7a0b95b0
RD		 7683 Pops up the given menu at the specified coordinates, relative to this window,
7684 and returns control when the user has dismissed the menu. If a menu item is
7685 selected, the corresponding menu event is generated and will be processed as
7686 usual. If the default position is given then the current position of the
7687 mouse cursor will be used.
d55e5bfc
RD		 7688 """
7689 return _core_.Window_PopupMenuXY(*args, **kwargs)
7690
7691 def PopupMenu(*args, **kwargs):
7692 """
7a0b95b0 7693 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7694
7a0b95b0
RD		 7695 Pops up the given menu at the specified coordinates, relative to this window,
7696 and returns control when the user has dismissed the menu. If a menu item is
7697 selected, the corresponding menu event is generated and will be processed as
7698 usual. If the default position is given then the current position of the
7699 mouse cursor will be used.
d55e5bfc
RD		 7700 """
7701 return _core_.Window_PopupMenu(*args, **kwargs)
7702
7703 def GetHandle(*args, **kwargs):
7704 """
7705 GetHandle(self) -> long
7706
7707 Returns the platform-specific handle (as a long integer) of the
7708 physical window. Currently on wxMac it returns the handle of the
7709 toplevel parent of the window.
7710 """
7711 return _core_.Window_GetHandle(*args, **kwargs)
7712
629e65c2
RD		 7713 def AssociateHandle(*args, **kwargs):
7714 """
7715 AssociateHandle(self, long handle)
7716
7717 Associate the window with a new native handle
7718 """
7719 return _core_.Window_AssociateHandle(*args, **kwargs)
7720
7721 def DissociateHandle(*args, **kwargs):
7722 """
7723 DissociateHandle(self)
7724
7725 Dissociate the current native handle from the window
7726 """
7727 return _core_.Window_DissociateHandle(*args, **kwargs)
7728
d55e5bfc
RD		 7729 def OnPaint(*args, **kwargs):
7730 """OnPaint(self, PaintEvent event)"""
7731 return _core_.Window_OnPaint(*args, **kwargs)
7732
7733 def HasScrollbar(*args, **kwargs):
7734 """
7735 HasScrollbar(self, int orient) -> bool
7736
7737 Does the window have the scrollbar for this orientation?
7738 """
7739 return _core_.Window_HasScrollbar(*args, **kwargs)
7740
7741 def SetScrollbar(*args, **kwargs):
7742 """
79fccf9d 7743 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD		 7744 bool refresh=True)
7745
7746 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD		 7747 """
7748 return _core_.Window_SetScrollbar(*args, **kwargs)
7749
7750 def SetScrollPos(*args, **kwargs):
7751 """
7752 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7753
7754 Sets the position of one of the built-in scrollbars.
7755 """
7756 return _core_.Window_SetScrollPos(*args, **kwargs)
7757
7758 def GetScrollPos(*args, **kwargs):
7759 """
7760 GetScrollPos(self, int orientation) -> int
7761
7762 Returns the built-in scrollbar position.
7763 """
7764 return _core_.Window_GetScrollPos(*args, **kwargs)
7765
7766 def GetScrollThumb(*args, **kwargs):
7767 """
7768 GetScrollThumb(self, int orientation) -> int
7769
7770 Returns the built-in scrollbar thumb size.
7771 """
7772 return _core_.Window_GetScrollThumb(*args, **kwargs)
7773
7774 def GetScrollRange(*args, **kwargs):
7775 """
7776 GetScrollRange(self, int orientation) -> int
7777
7778 Returns the built-in scrollbar range.
7779 """
7780 return _core_.Window_GetScrollRange(*args, **kwargs)
7781
7782 def ScrollWindow(*args, **kwargs):
7783 """
7784 ScrollWindow(self, int dx, int dy, Rect rect=None)
7785
7786 Physically scrolls the pixels in the window and move child windows
7787 accordingly. Use this function to optimise your scrolling
7788 implementations, to minimise the area that must be redrawn. Note that
7789 it is rarely required to call this function from a user program.
d55e5bfc
RD		 7790 """
7791 return _core_.Window_ScrollWindow(*args, **kwargs)
7792
7793 def ScrollLines(*args, **kwargs):
7794 """
7795 ScrollLines(self, int lines) -> bool
7796
7797 If the platform and window class supports it, scrolls the window by
7798 the given number of lines down, if lines is positive, or up if lines
7799 is negative. Returns True if the window was scrolled, False if it was
7800 already on top/bottom and nothing was done.
7801 """
7802 return _core_.Window_ScrollLines(*args, **kwargs)
7803
7804 def ScrollPages(*args, **kwargs):
7805 """
7806 ScrollPages(self, int pages) -> bool
7807
79fccf9d 7808 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD		 7809 the given number of pages down, if pages is positive, or up if pages
7810 is negative. Returns True if the window was scrolled, False if it was
7811 already on top/bottom and nothing was done.
7812 """
7813 return _core_.Window_ScrollPages(*args, **kwargs)
7814
7815 def LineUp(*args, **kwargs):
7816 """
7817 LineUp(self) -> bool
7818
7819 This is just a wrapper for ScrollLines(-1).
7820 """
7821 return _core_.Window_LineUp(*args, **kwargs)
7822
7823 def LineDown(*args, **kwargs):
7824 """
7825 LineDown(self) -> bool
7826
7827 This is just a wrapper for ScrollLines(1).
7828 """
7829 return _core_.Window_LineDown(*args, **kwargs)
7830
7831 def PageUp(*args, **kwargs):
7832 """
7833 PageUp(self) -> bool
7834
7835 This is just a wrapper for ScrollPages(-1).
7836 """
7837 return _core_.Window_PageUp(*args, **kwargs)
7838
7839 def PageDown(*args, **kwargs):
7840 """
7841 PageDown(self) -> bool
7842
7843 This is just a wrapper for ScrollPages(1).
7844 """
7845 return _core_.Window_PageDown(*args, **kwargs)
7846
7847 def SetHelpText(*args, **kwargs):
7848 """
7849 SetHelpText(self, String text)
7850
7851 Sets the help text to be used as context-sensitive help for this
7852 window. Note that the text is actually stored by the current
7853 wxHelpProvider implementation, and not in the window object itself.
7854 """
7855 return _core_.Window_SetHelpText(*args, **kwargs)
7856
7857 def SetHelpTextForId(*args, **kwargs):
7858 """
7859 SetHelpTextForId(self, String text)
7860
7861 Associate this help text with all windows with the same id as this
7862 one.
7863 """
7864 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7865
7866 def GetHelpText(*args, **kwargs):
7867 """
7868 GetHelpText(self) -> String
7869
7870 Gets the help text to be used as context-sensitive help for this
7871 window. Note that the text is actually stored by the current
7872 wxHelpProvider implementation, and not in the window object itself.
7873 """
7874 return _core_.Window_GetHelpText(*args, **kwargs)
7875
7876 def SetToolTipString(*args, **kwargs):
7877 """
7878 SetToolTipString(self, String tip)
7879
7880 Attach a tooltip to the window.
7881 """
7882 return _core_.Window_SetToolTipString(*args, **kwargs)
7883
7884 def SetToolTip(*args, **kwargs):
7885 """
7886 SetToolTip(self, ToolTip tip)
7887
7888 Attach a tooltip to the window.
7889 """
7890 return _core_.Window_SetToolTip(*args, **kwargs)
7891
7892 def GetToolTip(*args, **kwargs):
7893 """
7894 GetToolTip(self) -> ToolTip
7895
7896 get the associated tooltip or None if none
7897 """
7898 return _core_.Window_GetToolTip(*args, **kwargs)
7899
7900 def SetDropTarget(*args, **kwargs):
7901 """
7902 SetDropTarget(self, DropTarget dropTarget)
7903
7904 Associates a drop target with this window. If the window already has
7905 a drop target, it is deleted.
7906 """
7907 return _core_.Window_SetDropTarget(*args, **kwargs)
7908
7909 def GetDropTarget(*args, **kwargs):
7910 """
7911 GetDropTarget(self) -> DropTarget
7912
7913 Returns the associated drop target, which may be None.
7914 """
7915 return _core_.Window_GetDropTarget(*args, **kwargs)
7916
7917 def DragAcceptFiles(*args, **kwargs):
7918 """
7919 DragAcceptFiles(self, bool accept)
7920
7921 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
7922 Only available on Windows.
7923 """
7924 return _core_.Window_DragAcceptFiles(*args, **kwargs)
7925
7926 def SetConstraints(*args, **kwargs):
7927 """
7928 SetConstraints(self, LayoutConstraints constraints)
7929
7930 Sets the window to have the given layout constraints. If an existing
7931 layout constraints object is already owned by the window, it will be
7932 deleted. Pass None to disassociate and delete the window's current
7933 constraints.
7934
7935 You must call SetAutoLayout to tell a window to use the constraints
7936 automatically in its default EVT_SIZE handler; otherwise, you must
7937 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7938 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7939 effect.
7940 """
7941 return _core_.Window_SetConstraints(*args, **kwargs)
7942
7943 def GetConstraints(*args, **kwargs):
7944 """
7945 GetConstraints(self) -> LayoutConstraints
7946
7947 Returns a pointer to the window's layout constraints, or None if there
7948 are none.
7949 """
7950 return _core_.Window_GetConstraints(*args, **kwargs)
7951
7952 def SetAutoLayout(*args, **kwargs):
7953 """
7954 SetAutoLayout(self, bool autoLayout)
7955
7956 Determines whether the Layout function will be called automatically
7957 when the window is resized. It is called implicitly by SetSizer but
7958 if you use SetConstraints you should call it manually or otherwise the
7959 window layout won't be correctly updated when its size changes.
7960 """
7961 return _core_.Window_SetAutoLayout(*args, **kwargs)
7962
7963 def GetAutoLayout(*args, **kwargs):
7964 """
7965 GetAutoLayout(self) -> bool
7966
7967 Returns the current autoLayout setting
7968 """
7969 return _core_.Window_GetAutoLayout(*args, **kwargs)
7970
7971 def Layout(*args, **kwargs):
7972 """
7973 Layout(self) -> bool
7974
7975 Invokes the constraint-based layout algorithm or the sizer-based
7976 algorithm for this window. See SetAutoLayout: when auto layout is on,
7977 this function gets called automatically by the default EVT_SIZE
7978 handler when the window is resized.
7979 """
7980 return _core_.Window_Layout(*args, **kwargs)
7981
7982 def SetSizer(*args, **kwargs):
7983 """
7984 SetSizer(self, Sizer sizer, bool deleteOld=True)
7985
7986 Sets the window to have the given layout sizer. The window will then
7987 own the object, and will take care of its deletion. If an existing
7988 layout sizer object is already owned by the window, it will be deleted
7989 if the deleteOld parameter is true. Note that this function will also
7990 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 7991 non-None, and False otherwise.
d55e5bfc
RD		 7992 """
7993 return _core_.Window_SetSizer(*args, **kwargs)
7994
7995 def SetSizerAndFit(*args, **kwargs):
7996 """
7997 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7998
7999 The same as SetSizer, except it also sets the size hints for the
8000 window based on the sizer's minimum size.
8001 """
8002 return _core_.Window_SetSizerAndFit(*args, **kwargs)
8003
8004 def GetSizer(*args, **kwargs):
8005 """
8006 GetSizer(self) -> Sizer
8007
8008 Return the sizer associated with the window by a previous call to
8009 SetSizer or None if there isn't one.
8010 """
8011 return _core_.Window_GetSizer(*args, **kwargs)
8012
8013 def SetContainingSizer(*args, **kwargs):
8014 """
8015 SetContainingSizer(self, Sizer sizer)
8016
8017 This normally does not need to be called by application code. It is
8018 called internally when a window is added to a sizer, and is used so
8019 the window can remove itself from the sizer when it is destroyed.
8020 """
8021 return _core_.Window_SetContainingSizer(*args, **kwargs)
8022
8023 def GetContainingSizer(*args, **kwargs):
8024 """
8025 GetContainingSizer(self) -> Sizer
8026
8027 Return the sizer that this window is a member of, if any, otherwise None.
8028 """
8029 return _core_.Window_GetContainingSizer(*args, **kwargs)
8030
8031 def InheritAttributes(*args, **kwargs):
8032 """
8033 InheritAttributes(self)
8034
79fccf9d
RD		 8035 This function is (or should be, in case of custom controls) called
8036 during window creation to intelligently set up the window visual
8037 attributes, that is the font and the foreground and background
8038 colours.
8039
8040 By 'intelligently' the following is meant: by default, all windows use
8041 their own default attributes. However if some of the parent's
8042 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 8043 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD		 8044 explicitly set for this window itself, then this window takes the same
8045 value as used by the parent. In addition, if the window overrides
8046 ShouldInheritColours to return false, the colours will not be changed
8047 no matter what and only the font might.
8048
ec9b55ca
RD		 8049 This rather complicated logic is necessary in order to accommodate the
8050 different usage scenarios. The most common one is when all default
79fccf9d
RD		 8051 attributes are used and in this case, nothing should be inherited as
8052 in modern GUIs different controls use different fonts (and colours)
8053 than their siblings so they can't inherit the same value from the
8054 parent. However it was also deemed desirable to allow to simply change
8055 the attributes of all children at once by just changing the font or
8056 colour of their common parent, hence in this case we do inherit the
8057 parents attributes.
8058
d55e5bfc
RD		 8059 """
8060 return _core_.Window_InheritAttributes(*args, **kwargs)
8061
8062 def ShouldInheritColours(*args, **kwargs):
8063 """
8064 ShouldInheritColours(self) -> bool
8065
8066 Return true from here to allow the colours of this window to be
79fccf9d
RD		 8067 changed by InheritAttributes, returning false forbids inheriting them
8068 from the parent window.
d55e5bfc 8069
79fccf9d
RD		 8070 The base class version returns false, but this method is overridden in
8071 wxControl where it returns true.
d55e5bfc
RD		 8072 """
8073 return _core_.Window_ShouldInheritColours(*args, **kwargs)
8074
8075 def PostCreate(self, pre):
8076 """
8077 Phase 3 of the 2-phase create <wink!>
8078 Call this method after precreating the window with the 2-phase create method.
8079 """
8080 self.this = pre.this
8081 self.thisown = pre.thisown
8082 pre.thisown = 0
8083 if hasattr(self, '_setOORInfo'):
8084 self._setOORInfo(self)
8085 if hasattr(self, '_setCallbackInfo'):
8086 self._setCallbackInfo(self, self.__class__)
8087
8088
8089class WindowPtr(Window):
8090 def __init__(self, this):
8091 self.this = this
8092 if not hasattr(self,"thisown"): self.thisown = 0
8093 self.__class__ = Window
8094_core_.Window_swigregister(WindowPtr)
8095
8096def PreWindow(*args, **kwargs):
8097 """
8098 PreWindow() -> Window
8099
8100 Precreate a Window for 2-phase creation.
8101 """
8102 val = _core_.new_PreWindow(*args, **kwargs)
8103 val.thisown = 1
8104 return val
8105
8106def Window_NewControlId(*args, **kwargs):
8107 """
8108 Window_NewControlId() -> int
8109
8110 Generate a control id for the controls which were not given one.
8111 """
8112 return _core_.Window_NewControlId(*args, **kwargs)
8113
8114def Window_NextControlId(*args, **kwargs):
8115 """
8116 Window_NextControlId(int winid) -> int
8117
8118 Get the id of the control following the one with the given
79fccf9d 8119 autogenerated) id
d55e5bfc
RD		 8120 """
8121 return _core_.Window_NextControlId(*args, **kwargs)
8122
8123def Window_PrevControlId(*args, **kwargs):
8124 """
8125 Window_PrevControlId(int winid) -> int
8126
8127 Get the id of the control preceding the one with the given
79fccf9d 8128 autogenerated) id
d55e5bfc
RD		 8129 """
8130 return _core_.Window_PrevControlId(*args, **kwargs)
8131
8132def Window_FindFocus(*args, **kwargs):
8133 """
8134 Window_FindFocus() -> Window
8135
8136 Returns the window or control that currently has the keyboard focus,
8137 or None.
8138 """
8139 return _core_.Window_FindFocus(*args, **kwargs)
8140
8141def Window_GetCapture(*args, **kwargs):
8142 """
8143 Window_GetCapture() -> Window
8144
8145 Returns the window which currently captures the mouse or None
8146 """
8147 return _core_.Window_GetCapture(*args, **kwargs)
8148
8149def Window_GetClassDefaultAttributes(*args, **kwargs):
8150 """
8151 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8152
79fccf9d
RD		 8153 Get the default attributes for this class. This is useful if you want
8154 to use the same font or colour in your own control as in a standard
8155 control -- which is a much better idea than hard coding specific
caef1a4d
RD		 8156 colours or fonts which might look completely out of place on the
8157 user's system, especially if it uses themes.
d55e5bfc
RD		 8158
8159 The variant parameter is only relevant under Mac currently and is
79fccf9d 8160 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD		 8161 the returned font. See `wx.Window.SetWindowVariant` for more about
8162 this.
d55e5bfc
RD		 8163 """
8164 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
8165
8166def DLG_PNT(win, point_or_x, y=None):
8167 """
8168 Convenience function for converting a Point or (x,y) in
8169 dialog units to pixel units.
8170 """
8171 if y is None:
8172 return win.ConvertDialogPointToPixels(point_or_x)
8173 else:
8174 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
8175
8176def DLG_SZE(win, size_width, height=None):
8177 """
8178 Convenience function for converting a Size or (w,h) in
8179 dialog units to pixel units.
8180 """
8181 if height is None:
8182 return win.ConvertDialogSizeToPixels(size_width)
8183 else:
8184 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
8185
8186
8187def FindWindowById(*args, **kwargs):
8188 """
8189 FindWindowById(long id, Window parent=None) -> Window
8190
8191 Find the first window in the application with the given id. If parent
8192 is None, the search will start from all top-level frames and dialog
8193 boxes; if non-None, the search will be limited to the given window
8194 hierarchy. The search is recursive in both cases.
8195 """
8196 return _core_.FindWindowById(*args, **kwargs)
8197
8198def FindWindowByName(*args, **kwargs):
8199 """
8200 FindWindowByName(String name, Window parent=None) -> Window
8201
8202 Find a window by its name (as given in a window constructor or Create
8203 function call). If parent is None, the search will start from all
8204 top-level frames and dialog boxes; if non-None, the search will be
8205 limited to the given window hierarchy. The search is recursive in both
8206 cases.
8207
8208 If no window with such name is found, wx.FindWindowByLabel is called.
8209 """
8210 return _core_.FindWindowByName(*args, **kwargs)
8211
8212def FindWindowByLabel(*args, **kwargs):
8213 """
8214 FindWindowByLabel(String label, Window parent=None) -> Window
8215
8216 Find a window by its label. Depending on the type of window, the label
8217 may be a window title or panel item label. If parent is None, the
8218 search will start from all top-level frames and dialog boxes; if
8219 non-None, the search will be limited to the given window
8220 hierarchy. The search is recursive in both cases.
8221 """
8222 return _core_.FindWindowByLabel(*args, **kwargs)
8223
8224def Window_FromHWND(*args, **kwargs):
8225 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
8226 return _core_.Window_FromHWND(*args, **kwargs)
8227#---------------------------------------------------------------------------
8228
8229class Validator(EvtHandler):
093d3ff1 8230 """Proxy of C++ Validator class"""
d55e5bfc
RD		 8231 def __repr__(self):
8232 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8233 def __init__(self, *args, **kwargs):
8234 """__init__(self) -> Validator"""
8235 newobj = _core_.new_Validator(*args, **kwargs)
8236 self.this = newobj.this
8237 self.thisown = 1
8238 del newobj.thisown
8239 self._setOORInfo(self)
8240
8241 def Clone(*args, **kwargs):
8242 """Clone(self) -> Validator"""
8243 return _core_.Validator_Clone(*args, **kwargs)
8244
8245 def Validate(*args, **kwargs):
8246 """Validate(self, Window parent) -> bool"""
8247 return _core_.Validator_Validate(*args, **kwargs)
8248
8249 def TransferToWindow(*args, **kwargs):
8250 """TransferToWindow(self) -> bool"""
8251 return _core_.Validator_TransferToWindow(*args, **kwargs)
8252
8253 def TransferFromWindow(*args, **kwargs):
8254 """TransferFromWindow(self) -> bool"""
8255 return _core_.Validator_TransferFromWindow(*args, **kwargs)
8256
8257 def GetWindow(*args, **kwargs):
8258 """GetWindow(self) -> Window"""
8259 return _core_.Validator_GetWindow(*args, **kwargs)
8260
8261 def SetWindow(*args, **kwargs):
8262 """SetWindow(self, Window window)"""
8263 return _core_.Validator_SetWindow(*args, **kwargs)
8264
8265 def IsSilent(*args, **kwargs):
c24da6d6 8266 """IsSilent() -> bool"""
d55e5bfc
RD		 8267 return _core_.Validator_IsSilent(*args, **kwargs)
8268
8269 IsSilent = staticmethod(IsSilent)
8270 def SetBellOnError(*args, **kwargs):
c24da6d6 8271 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD		 8272 return _core_.Validator_SetBellOnError(*args, **kwargs)
8273
8274 SetBellOnError = staticmethod(SetBellOnError)
8275
8276class ValidatorPtr(Validator):
8277 def __init__(self, this):
8278 self.this = this
8279 if not hasattr(self,"thisown"): self.thisown = 0
8280 self.__class__ = Validator
8281_core_.Validator_swigregister(ValidatorPtr)
8282
8283def Validator_IsSilent(*args, **kwargs):
8284 """Validator_IsSilent() -> bool"""
8285 return _core_.Validator_IsSilent(*args, **kwargs)
8286
8287def Validator_SetBellOnError(*args, **kwargs):
8288 """Validator_SetBellOnError(int doIt=True)"""
8289 return _core_.Validator_SetBellOnError(*args, **kwargs)
8290
8291class PyValidator(Validator):
093d3ff1 8292 """Proxy of C++ PyValidator class"""
d55e5bfc
RD		 8293 def __repr__(self):
8294 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8295 def __init__(self, *args, **kwargs):
8296 """__init__(self) -> PyValidator"""
8297 newobj = _core_.new_PyValidator(*args, **kwargs)
8298 self.this = newobj.this
8299 self.thisown = 1
8300 del newobj.thisown
8301
8302 self._setCallbackInfo(self, PyValidator, 1)
8303 self._setOORInfo(self)
8304
8305 def _setCallbackInfo(*args, **kwargs):
8306 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
8307 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
8308
8309
8310class PyValidatorPtr(PyValidator):
8311 def __init__(self, this):
8312 self.this = this
8313 if not hasattr(self,"thisown"): self.thisown = 0
8314 self.__class__ = PyValidator
8315_core_.PyValidator_swigregister(PyValidatorPtr)
8316
8317#---------------------------------------------------------------------------
8318
8319class Menu(EvtHandler):
093d3ff1 8320 """Proxy of C++ Menu class"""
d55e5bfc
RD		 8321 def __repr__(self):
8322 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8323 def __init__(self, *args, **kwargs):
8324 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
8325 newobj = _core_.new_Menu(*args, **kwargs)
8326 self.this = newobj.this
8327 self.thisown = 1
8328 del newobj.thisown
8329 self._setOORInfo(self)
8330
8331 def Append(*args, **kwargs):
8332 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8333 return _core_.Menu_Append(*args, **kwargs)
8334
8335 def AppendSeparator(*args, **kwargs):
8336 """AppendSeparator(self) -> MenuItem"""
8337 return _core_.Menu_AppendSeparator(*args, **kwargs)
8338
8339 def AppendCheckItem(*args, **kwargs):
8340 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8341 return _core_.Menu_AppendCheckItem(*args, **kwargs)
8342
8343 def AppendRadioItem(*args, **kwargs):
8344 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8345 return _core_.Menu_AppendRadioItem(*args, **kwargs)
8346
8347 def AppendMenu(*args, **kwargs):
8348 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8349 return _core_.Menu_AppendMenu(*args, **kwargs)
8350
8351 def AppendItem(*args, **kwargs):
8352 """AppendItem(self, MenuItem item) -> MenuItem"""
8353 return _core_.Menu_AppendItem(*args, **kwargs)
8354
8355 def Break(*args, **kwargs):
8356 """Break(self)"""
8357 return _core_.Menu_Break(*args, **kwargs)
8358
8359 def InsertItem(*args, **kwargs):
8360 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
8361 return _core_.Menu_InsertItem(*args, **kwargs)
8362
8363 def Insert(*args, **kwargs):
8364 """
8365 Insert(self, size_t pos, int id, String text, String help=EmptyString,
8366 int kind=ITEM_NORMAL) -> MenuItem
8367 """
8368 return _core_.Menu_Insert(*args, **kwargs)
8369
8370 def InsertSeparator(*args, **kwargs):
8371 """InsertSeparator(self, size_t pos) -> MenuItem"""
8372 return _core_.Menu_InsertSeparator(*args, **kwargs)
8373
8374 def InsertCheckItem(*args, **kwargs):
8375 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8376 return _core_.Menu_InsertCheckItem(*args, **kwargs)
8377
8378 def InsertRadioItem(*args, **kwargs):
8379 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8380 return _core_.Menu_InsertRadioItem(*args, **kwargs)
8381
8382 def InsertMenu(*args, **kwargs):
8383 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8384 return _core_.Menu_InsertMenu(*args, **kwargs)
8385
8386 def PrependItem(*args, **kwargs):
8387 """PrependItem(self, MenuItem item) -> MenuItem"""
8388 return _core_.Menu_PrependItem(*args, **kwargs)
8389
8390 def Prepend(*args, **kwargs):
8391 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8392 return _core_.Menu_Prepend(*args, **kwargs)
8393
8394 def PrependSeparator(*args, **kwargs):
8395 """PrependSeparator(self) -> MenuItem"""
8396 return _core_.Menu_PrependSeparator(*args, **kwargs)
8397
8398 def PrependCheckItem(*args, **kwargs):
8399 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8400 return _core_.Menu_PrependCheckItem(*args, **kwargs)
8401
8402 def PrependRadioItem(*args, **kwargs):
8403 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8404 return _core_.Menu_PrependRadioItem(*args, **kwargs)
8405
8406 def PrependMenu(*args, **kwargs):
8407 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8408 return _core_.Menu_PrependMenu(*args, **kwargs)
8409
8410 def Remove(*args, **kwargs):
8411 """Remove(self, int id) -> MenuItem"""
8412 return _core_.Menu_Remove(*args, **kwargs)
8413
8414 def RemoveItem(*args, **kwargs):
8415 """RemoveItem(self, MenuItem item) -> MenuItem"""
8416 return _core_.Menu_RemoveItem(*args, **kwargs)
8417
8418 def Delete(*args, **kwargs):
8419 """Delete(self, int id) -> bool"""
8420 return _core_.Menu_Delete(*args, **kwargs)
8421
8422 def DeleteItem(*args, **kwargs):
8423 """DeleteItem(self, MenuItem item) -> bool"""
8424 return _core_.Menu_DeleteItem(*args, **kwargs)
8425
8426 def Destroy(*args, **kwargs):
8427 """
8428 Destroy(self)
8429
8430 Deletes the C++ object this Python object is a proxy for.
8431 """
8432 return _core_.Menu_Destroy(*args, **kwargs)
8433
8434 def DestroyId(*args, **kwargs):
8435 """
8436 DestroyId(self, int id) -> bool
8437
8438 Deletes the C++ object this Python object is a proxy for.
8439 """
8440 return _core_.Menu_DestroyId(*args, **kwargs)
8441
8442 def DestroyItem(*args, **kwargs):
8443 """
8444 DestroyItem(self, MenuItem item) -> bool
8445
8446 Deletes the C++ object this Python object is a proxy for.
8447 """
8448 return _core_.Menu_DestroyItem(*args, **kwargs)
8449
8450 def GetMenuItemCount(*args, **kwargs):
8451 """GetMenuItemCount(self) -> size_t"""
8452 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
8453
8454 def GetMenuItems(*args, **kwargs):
8455 """GetMenuItems(self) -> PyObject"""
8456 return _core_.Menu_GetMenuItems(*args, **kwargs)
8457
8458 def FindItem(*args, **kwargs):
8459 """FindItem(self, String item) -> int"""
8460 return _core_.Menu_FindItem(*args, **kwargs)
8461
8462 def FindItemById(*args, **kwargs):
8463 """FindItemById(self, int id) -> MenuItem"""
8464 return _core_.Menu_FindItemById(*args, **kwargs)
8465
8466 def FindItemByPosition(*args, **kwargs):
8467 """FindItemByPosition(self, size_t position) -> MenuItem"""
8468 return _core_.Menu_FindItemByPosition(*args, **kwargs)
8469
8470 def Enable(*args, **kwargs):
8471 """Enable(self, int id, bool enable)"""
8472 return _core_.Menu_Enable(*args, **kwargs)
8473
8474 def IsEnabled(*args, **kwargs):
8475 """IsEnabled(self, int id) -> bool"""
8476 return _core_.Menu_IsEnabled(*args, **kwargs)
8477
8478 def Check(*args, **kwargs):
8479 """Check(self, int id, bool check)"""
8480 return _core_.Menu_Check(*args, **kwargs)
8481
8482 def IsChecked(*args, **kwargs):
8483 """IsChecked(self, int id) -> bool"""
8484 return _core_.Menu_IsChecked(*args, **kwargs)
8485
8486 def SetLabel(*args, **kwargs):
8487 """SetLabel(self, int id, String label)"""
8488 return _core_.Menu_SetLabel(*args, **kwargs)
8489
8490 def GetLabel(*args, **kwargs):
8491 """GetLabel(self, int id) -> String"""
8492 return _core_.Menu_GetLabel(*args, **kwargs)
8493
8494 def SetHelpString(*args, **kwargs):
8495 """SetHelpString(self, int id, String helpString)"""
8496 return _core_.Menu_SetHelpString(*args, **kwargs)
8497
8498 def GetHelpString(*args, **kwargs):
8499 """GetHelpString(self, int id) -> String"""
8500 return _core_.Menu_GetHelpString(*args, **kwargs)
8501
8502 def SetTitle(*args, **kwargs):
8503 """SetTitle(self, String title)"""
8504 return _core_.Menu_SetTitle(*args, **kwargs)
8505
8506 def GetTitle(*args, **kwargs):
8507 """GetTitle(self) -> String"""
8508 return _core_.Menu_GetTitle(*args, **kwargs)
8509
8510 def SetEventHandler(*args, **kwargs):
8511 """SetEventHandler(self, EvtHandler handler)"""
8512 return _core_.Menu_SetEventHandler(*args, **kwargs)
8513
8514 def GetEventHandler(*args, **kwargs):
8515 """GetEventHandler(self) -> EvtHandler"""
8516 return _core_.Menu_GetEventHandler(*args, **kwargs)
8517
8518 def SetInvokingWindow(*args, **kwargs):
8519 """SetInvokingWindow(self, Window win)"""
8520 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
8521
8522 def GetInvokingWindow(*args, **kwargs):
8523 """GetInvokingWindow(self) -> Window"""
8524 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
8525
8526 def GetStyle(*args, **kwargs):
8527 """GetStyle(self) -> long"""
8528 return _core_.Menu_GetStyle(*args, **kwargs)
8529
8530 def UpdateUI(*args, **kwargs):
8531 """UpdateUI(self, EvtHandler source=None)"""
8532 return _core_.Menu_UpdateUI(*args, **kwargs)
8533
8534 def GetMenuBar(*args, **kwargs):
8535 """GetMenuBar(self) -> MenuBar"""
8536 return _core_.Menu_GetMenuBar(*args, **kwargs)
8537
8538 def Attach(*args, **kwargs):
8539 """Attach(self, wxMenuBarBase menubar)"""
8540 return _core_.Menu_Attach(*args, **kwargs)
8541
8542 def Detach(*args, **kwargs):
8543 """Detach(self)"""
8544 return _core_.Menu_Detach(*args, **kwargs)
8545
8546 def IsAttached(*args, **kwargs):
8547 """IsAttached(self) -> bool"""
8548 return _core_.Menu_IsAttached(*args, **kwargs)
8549
8550 def SetParent(*args, **kwargs):
8551 """SetParent(self, Menu parent)"""
8552 return _core_.Menu_SetParent(*args, **kwargs)
8553
8554 def GetParent(*args, **kwargs):
8555 """GetParent(self) -> Menu"""
8556 return _core_.Menu_GetParent(*args, **kwargs)
8557
8558
8559class MenuPtr(Menu):
8560 def __init__(self, this):
8561 self.this = this
8562 if not hasattr(self,"thisown"): self.thisown = 0
8563 self.__class__ = Menu
8564_core_.Menu_swigregister(MenuPtr)
8565DefaultValidator = cvar.DefaultValidator
8566
8567#---------------------------------------------------------------------------
8568
8569class MenuBar(Window):
093d3ff1 8570 """Proxy of C++ MenuBar class"""
d55e5bfc
RD		 8571 def __repr__(self):
8572 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8573 def __init__(self, *args, **kwargs):
8574 """__init__(self, long style=0) -> MenuBar"""
8575 newobj = _core_.new_MenuBar(*args, **kwargs)
8576 self.this = newobj.this
8577 self.thisown = 1
8578 del newobj.thisown
8579 self._setOORInfo(self)
8580
8581 def Append(*args, **kwargs):
8582 """Append(self, Menu menu, String title) -> bool"""
8583 return _core_.MenuBar_Append(*args, **kwargs)
8584
8585 def Insert(*args, **kwargs):
8586 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
8587 return _core_.MenuBar_Insert(*args, **kwargs)
8588
8589 def GetMenuCount(*args, **kwargs):
8590 """GetMenuCount(self) -> size_t"""
8591 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
8592
8593 def GetMenu(*args, **kwargs):
8594 """GetMenu(self, size_t pos) -> Menu"""
8595 return _core_.MenuBar_GetMenu(*args, **kwargs)
8596
8597 def Replace(*args, **kwargs):
8598 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
8599 return _core_.MenuBar_Replace(*args, **kwargs)
8600
8601 def Remove(*args, **kwargs):
8602 """Remove(self, size_t pos) -> Menu"""
8603 return _core_.MenuBar_Remove(*args, **kwargs)
8604
8605 def EnableTop(*args, **kwargs):
8606 """EnableTop(self, size_t pos, bool enable)"""
8607 return _core_.MenuBar_EnableTop(*args, **kwargs)
8608
8609 def IsEnabledTop(*args, **kwargs):
8610 """IsEnabledTop(self, size_t pos) -> bool"""
8611 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
8612
8613 def SetLabelTop(*args, **kwargs):
8614 """SetLabelTop(self, size_t pos, String label)"""
8615 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
8616
8617 def GetLabelTop(*args, **kwargs):
8618 """GetLabelTop(self, size_t pos) -> String"""
8619 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
8620
8621 def FindMenuItem(*args, **kwargs):
8622 """FindMenuItem(self, String menu, String item) -> int"""
8623 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
8624
8625 def FindItemById(*args, **kwargs):
8626 """FindItemById(self, int id) -> MenuItem"""
8627 return _core_.MenuBar_FindItemById(*args, **kwargs)
8628
8629 def FindMenu(*args, **kwargs):
8630 """FindMenu(self, String title) -> int"""
8631 return _core_.MenuBar_FindMenu(*args, **kwargs)
8632
8633 def Enable(*args, **kwargs):
8634 """Enable(self, int id, bool enable)"""
8635 return _core_.MenuBar_Enable(*args, **kwargs)
8636
8637 def Check(*args, **kwargs):
8638 """Check(self, int id, bool check)"""
8639 return _core_.MenuBar_Check(*args, **kwargs)
8640
8641 def IsChecked(*args, **kwargs):
8642 """IsChecked(self, int id) -> bool"""
8643 return _core_.MenuBar_IsChecked(*args, **kwargs)
8644
8645 def IsEnabled(*args, **kwargs):
8646 """IsEnabled(self, int id) -> bool"""
8647 return _core_.MenuBar_IsEnabled(*args, **kwargs)
8648
8649 def SetLabel(*args, **kwargs):
8650 """SetLabel(self, int id, String label)"""
8651 return _core_.MenuBar_SetLabel(*args, **kwargs)
8652
8653 def GetLabel(*args, **kwargs):
8654 """GetLabel(self, int id) -> String"""
8655 return _core_.MenuBar_GetLabel(*args, **kwargs)
8656
8657 def SetHelpString(*args, **kwargs):
8658 """SetHelpString(self, int id, String helpString)"""
8659 return _core_.MenuBar_SetHelpString(*args, **kwargs)
8660
8661 def GetHelpString(*args, **kwargs):
8662 """GetHelpString(self, int id) -> String"""
8663 return _core_.MenuBar_GetHelpString(*args, **kwargs)
8664
8665 def GetFrame(*args, **kwargs):
8666 """GetFrame(self) -> wxFrame"""
8667 return _core_.MenuBar_GetFrame(*args, **kwargs)
8668
8669 def IsAttached(*args, **kwargs):
8670 """IsAttached(self) -> bool"""
8671 return _core_.MenuBar_IsAttached(*args, **kwargs)
8672
8673 def Attach(*args, **kwargs):
8674 """Attach(self, wxFrame frame)"""
8675 return _core_.MenuBar_Attach(*args, **kwargs)
8676
8677 def Detach(*args, **kwargs):
8678 """Detach(self)"""
8679 return _core_.MenuBar_Detach(*args, **kwargs)
8680
8681
8682class MenuBarPtr(MenuBar):
8683 def __init__(self, this):
8684 self.this = this
8685 if not hasattr(self,"thisown"): self.thisown = 0
8686 self.__class__ = MenuBar
8687_core_.MenuBar_swigregister(MenuBarPtr)
8688
8689#---------------------------------------------------------------------------
8690
8691class MenuItem(Object):
093d3ff1 8692 """Proxy of C++ MenuItem class"""
d55e5bfc
RD		 8693 def __repr__(self):
8694 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8695 def __init__(self, *args, **kwargs):
8696 """
8697 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
8698 String help=EmptyString, int kind=ITEM_NORMAL,
8699 Menu subMenu=None) -> MenuItem
8700 """
8701 newobj = _core_.new_MenuItem(*args, **kwargs)
8702 self.this = newobj.this
8703 self.thisown = 1
8704 del newobj.thisown
8705 def GetMenu(*args, **kwargs):
8706 """GetMenu(self) -> Menu"""
8707 return _core_.MenuItem_GetMenu(*args, **kwargs)
8708
8709 def SetMenu(*args, **kwargs):
8710 """SetMenu(self, Menu menu)"""
8711 return _core_.MenuItem_SetMenu(*args, **kwargs)
8712
8713 def SetId(*args, **kwargs):
8714 """SetId(self, int id)"""
8715 return _core_.MenuItem_SetId(*args, **kwargs)
8716
8717 def GetId(*args, **kwargs):
8718 """GetId(self) -> int"""
8719 return _core_.MenuItem_GetId(*args, **kwargs)
8720
8721 def IsSeparator(*args, **kwargs):
8722 """IsSeparator(self) -> bool"""
8723 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8724
8725 def SetText(*args, **kwargs):
8726 """SetText(self, String str)"""
8727 return _core_.MenuItem_SetText(*args, **kwargs)
8728
8729 def GetLabel(*args, **kwargs):
8730 """GetLabel(self) -> String"""
8731 return _core_.MenuItem_GetLabel(*args, **kwargs)
8732
8733 def GetText(*args, **kwargs):
8734 """GetText(self) -> String"""
8735 return _core_.MenuItem_GetText(*args, **kwargs)
8736
8737 def GetLabelFromText(*args, **kwargs):
c24da6d6 8738 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD		 8739 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8740
8741 GetLabelFromText = staticmethod(GetLabelFromText)
8742 def GetKind(*args, **kwargs):
8743 """GetKind(self) -> int"""
8744 return _core_.MenuItem_GetKind(*args, **kwargs)
8745
8746 def SetKind(*args, **kwargs):
8747 """SetKind(self, int kind)"""
8748 return _core_.MenuItem_SetKind(*args, **kwargs)
8749
8750 def SetCheckable(*args, **kwargs):
8751 """SetCheckable(self, bool checkable)"""
8752 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8753
8754 def IsCheckable(*args, **kwargs):
8755 """IsCheckable(self) -> bool"""
8756 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8757
8758 def IsSubMenu(*args, **kwargs):
8759 """IsSubMenu(self) -> bool"""
8760 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8761
8762 def SetSubMenu(*args, **kwargs):
8763 """SetSubMenu(self, Menu menu)"""
8764 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8765
8766 def GetSubMenu(*args, **kwargs):
8767 """GetSubMenu(self) -> Menu"""
8768 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8769
8770 def Enable(*args, **kwargs):
8771 """Enable(self, bool enable=True)"""
8772 return _core_.MenuItem_Enable(*args, **kwargs)
8773
8774 def IsEnabled(*args, **kwargs):
8775 """IsEnabled(self) -> bool"""
8776 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8777
8778 def Check(*args, **kwargs):
8779 """Check(self, bool check=True)"""
8780 return _core_.MenuItem_Check(*args, **kwargs)
8781
8782 def IsChecked(*args, **kwargs):
8783 """IsChecked(self) -> bool"""
8784 return _core_.MenuItem_IsChecked(*args, **kwargs)
8785
8786 def Toggle(*args, **kwargs):
8787 """Toggle(self)"""
8788 return _core_.MenuItem_Toggle(*args, **kwargs)
8789
8790 def SetHelp(*args, **kwargs):
8791 """SetHelp(self, String str)"""
8792 return _core_.MenuItem_SetHelp(*args, **kwargs)
8793
8794 def GetHelp(*args, **kwargs):
8795 """GetHelp(self) -> String"""
8796 return _core_.MenuItem_GetHelp(*args, **kwargs)
8797
8798 def GetAccel(*args, **kwargs):
8799 """GetAccel(self) -> AcceleratorEntry"""
8800 return _core_.MenuItem_GetAccel(*args, **kwargs)
8801
8802 def SetAccel(*args, **kwargs):
8803 """SetAccel(self, AcceleratorEntry accel)"""
8804 return _core_.MenuItem_SetAccel(*args, **kwargs)
8805
8806 def SetFont(*args, **kwargs):
8807 """SetFont(self, Font font)"""
8808 return _core_.MenuItem_SetFont(*args, **kwargs)
8809
8810 def GetFont(*args, **kwargs):
8811 """GetFont(self) -> Font"""
8812 return _core_.MenuItem_GetFont(*args, **kwargs)
8813
8814 def SetTextColour(*args, **kwargs):
8815 """SetTextColour(self, Colour colText)"""
8816 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8817
8818 def GetTextColour(*args, **kwargs):
8819 """GetTextColour(self) -> Colour"""
8820 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8821
8822 def SetBackgroundColour(*args, **kwargs):
8823 """SetBackgroundColour(self, Colour colBack)"""
8824 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8825
8826 def GetBackgroundColour(*args, **kwargs):
8827 """GetBackgroundColour(self) -> Colour"""
8828 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8829
8830 def SetBitmaps(*args, **kwargs):
8831 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8832 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8833
8834 def SetDisabledBitmap(*args, **kwargs):
8835 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8836 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8837
8838 def GetDisabledBitmap(*args, **kwargs):
8839 """GetDisabledBitmap(self) -> Bitmap"""
8840 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8841
8842 def SetMarginWidth(*args, **kwargs):
8843 """SetMarginWidth(self, int nWidth)"""
8844 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8845
8846 def GetMarginWidth(*args, **kwargs):
8847 """GetMarginWidth(self) -> int"""
8848 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8849
8850 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 8851 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD		 8852 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8853
8854 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8855 def IsOwnerDrawn(*args, **kwargs):
8856 """IsOwnerDrawn(self) -> bool"""
8857 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8858
8859 def SetOwnerDrawn(*args, **kwargs):
8860 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8861 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8862
8863 def ResetOwnerDrawn(*args, **kwargs):
8864 """ResetOwnerDrawn(self)"""
8865 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8866
8867 def SetBitmap(*args, **kwargs):
8868 """SetBitmap(self, Bitmap bitmap)"""
8869 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8870
8871 def GetBitmap(*args, **kwargs):
8872 """GetBitmap(self) -> Bitmap"""
8873 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8874
8875
8876class MenuItemPtr(MenuItem):
8877 def __init__(self, this):
8878 self.this = this
8879 if not hasattr(self,"thisown"): self.thisown = 0
8880 self.__class__ = MenuItem
8881_core_.MenuItem_swigregister(MenuItemPtr)
8882
8883def MenuItem_GetLabelFromText(*args, **kwargs):
8884 """MenuItem_GetLabelFromText(String text) -> String"""
8885 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8886
8887def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8888 """MenuItem_GetDefaultMarginWidth() -> int"""
8889 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8890
8891#---------------------------------------------------------------------------
8892
8893class Control(Window):
8894 """
8895 This is the base class for a control or 'widget'.
8896
79fccf9d
RD		 8897 A control is generally a small window which processes user input
8898 and/or displays one or more item of data.
d55e5bfc
RD		 8899 """
8900 def __repr__(self):
8901 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8902 def __init__(self, *args, **kwargs):
8903 """
248ed943
RD		 8904 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8905 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 8906 String name=ControlNameStr) -> Control
8907
79fccf9d
RD		 8908 Create a Control. Normally you should only call this from a subclass'
8909 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD		 8910 """
8911 newobj = _core_.new_Control(*args, **kwargs)
8912 self.this = newobj.this
8913 self.thisown = 1
8914 del newobj.thisown
8915 self._setOORInfo(self)
8916
8917 def Create(*args, **kwargs):
8918 """
248ed943
RD		 8919 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8920 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD		 8921 String name=ControlNameStr) -> bool
8922
8923 Do the 2nd phase and create the GUI control.
8924 """
8925 return _core_.Control_Create(*args, **kwargs)
8926
8927 def Command(*args, **kwargs):
8928 """
8929 Command(self, CommandEvent event)
8930
79fccf9d
RD		 8931 Simulates the effect of the user issuing a command to the item.
8932
8933 :see: `wx.CommandEvent`
8934
d55e5bfc
RD		 8935 """
8936 return _core_.Control_Command(*args, **kwargs)
8937
8938 def GetLabel(*args, **kwargs):
8939 """
8940 GetLabel(self) -> String
8941
8942 Return a control's text.
8943 """
8944 return _core_.Control_GetLabel(*args, **kwargs)
8945
8946 def SetLabel(*args, **kwargs):
8947 """
8948 SetLabel(self, String label)
8949
8950 Sets the item's text.
8951 """
8952 return _core_.Control_SetLabel(*args, **kwargs)
8953
a001823c 8954 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 8955 """
a001823c 8956 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 8957
a001823c
RD		 8958 Get the default attributes for this class. This is useful if you want
8959 to use the same font or colour in your own control as in a standard
8960 control -- which is a much better idea than hard coding specific
8961 colours or fonts which might look completely out of place on the
8962 user's system, especially if it uses themes.
f8167d6e 8963
a001823c
RD		 8964 The variant parameter is only relevant under Mac currently and is
8965 ignore under other platforms. Under Mac, it will change the size of
8966 the returned font. See `wx.Window.SetWindowVariant` for more about
8967 this.
f8167d6e 8968 """
d55e5bfc
RD		 8969 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8970
8971 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8972
8973class ControlPtr(Control):
8974 def __init__(self, this):
8975 self.this = this
8976 if not hasattr(self,"thisown"): self.thisown = 0
8977 self.__class__ = Control
8978_core_.Control_swigregister(ControlPtr)
8979ControlNameStr = cvar.ControlNameStr
8980
8981def PreControl(*args, **kwargs):
8982 """
8983 PreControl() -> Control
8984
8985 Precreate a Control control for 2-phase creation
8986 """
8987 val = _core_.new_PreControl(*args, **kwargs)
8988 val.thisown = 1
8989 return val
8990
8991def Control_GetClassDefaultAttributes(*args, **kwargs):
a001823c
RD		 8992 """
8993 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8994
8995 Get the default attributes for this class. This is useful if you want
8996 to use the same font or colour in your own control as in a standard
8997 control -- which is a much better idea than hard coding specific
8998 colours or fonts which might look completely out of place on the
8999 user's system, especially if it uses themes.
9000
9001 The variant parameter is only relevant under Mac currently and is
9002 ignore under other platforms. Under Mac, it will change the size of
9003 the returned font. See `wx.Window.SetWindowVariant` for more about
9004 this.
9005 """
d55e5bfc
RD		 9006 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
9007
9008#---------------------------------------------------------------------------
9009
9010class ItemContainer(object):
9011 """
53aa7709
RD		 9012 The wx.ItemContainer class defines an interface which is implemented
9013 by all controls which have string subitems, each of which may be
9014 selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
9015 as `wx.ComboBox` which implements an extended interface deriving from
79fccf9d 9016 this one.
d55e5bfc 9017
79fccf9d
RD		 9018 It defines the methods for accessing the control's items and although
9019 each of the derived classes implements them differently, they still
9020 all conform to the same interface.
d55e5bfc 9021
79fccf9d
RD		 9022 The items in a wx.ItemContainer have (non empty) string labels and,
9023 optionally, client data associated with them.
d55e5bfc
RD		 9024
9025 """
9026 def __init__(self): raise RuntimeError, "No constructor defined"
9027 def __repr__(self):
9028 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9029 def Append(*args, **kwargs):
9030 """
9031 Append(self, String item, PyObject clientData=None) -> int
9032
79fccf9d
RD		 9033 Adds the item to the control, associating the given data with the item
9034 if not None. The return value is the index of the newly added item
9035 which may be different from the last one if the control is sorted (e.g.
9036 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD		 9037 """
9038 return _core_.ItemContainer_Append(*args, **kwargs)
9039
9040 def AppendItems(*args, **kwargs):
9041 """
f5b96ee1 9042 AppendItems(self, List strings)
d55e5bfc 9043
79fccf9d
RD		 9044 Apend several items at once to the control. Notice that calling this
9045 method may be much faster than appending the items one by one if you
9046 need to add a lot of items.
d55e5bfc
RD		 9047 """
9048 return _core_.ItemContainer_AppendItems(*args, **kwargs)
9049
9050 def Insert(*args, **kwargs):
9051 """
9052 Insert(self, String item, int pos, PyObject clientData=None) -> int
9053
79fccf9d 9054 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD		 9055 optionally associating some data object with the item.
9056 """
9057 return _core_.ItemContainer_Insert(*args, **kwargs)
9058
9059 def Clear(*args, **kwargs):
9060 """
9061 Clear(self)
9062
9063 Removes all items from the control.
9064 """
9065 return _core_.ItemContainer_Clear(*args, **kwargs)
9066
9067 def Delete(*args, **kwargs):
9068 """
9069 Delete(self, int n)
9070
79fccf9d
RD		 9071 Deletes the item at the zero-based index 'n' from the control. Note
9072 that it is an error (signalled by a `wx.PyAssertionError` exception if
9073 enabled) to remove an item with the index negative or greater or equal
9074 than the number of items in the control.
d55e5bfc
RD		 9075 """
9076 return _core_.ItemContainer_Delete(*args, **kwargs)
9077
53aa7709
RD		 9078 def GetClientData(*args, **kwargs):
9079 """
9080 GetClientData(self, int n) -> PyObject
9081
9082 Returns the client data associated with the given item, (if any.)
9083 """
9084 return _core_.ItemContainer_GetClientData(*args, **kwargs)
9085
9086 def SetClientData(*args, **kwargs):
9087 """
9088 SetClientData(self, int n, PyObject clientData)
9089
9090 Associate the given client data with the item at position n.
9091 """
9092 return _core_.ItemContainer_SetClientData(*args, **kwargs)
9093
d55e5bfc
RD		 9094 def GetCount(*args, **kwargs):
9095 """
9096 GetCount(self) -> int
9097
9098 Returns the number of items in the control.
9099 """
9100 return _core_.ItemContainer_GetCount(*args, **kwargs)
9101
9102 def IsEmpty(*args, **kwargs):
9103 """
9104 IsEmpty(self) -> bool
9105
9106 Returns True if the control is empty or False if it has some items.
9107 """
9108 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
9109
9110 def GetString(*args, **kwargs):
9111 """
9112 GetString(self, int n) -> String
9113
9114 Returns the label of the item with the given index.
9115 """
9116 return _core_.ItemContainer_GetString(*args, **kwargs)
9117
9118 def GetStrings(*args, **kwargs):
9119 """GetStrings(self) -> wxArrayString"""
9120 return _core_.ItemContainer_GetStrings(*args, **kwargs)
9121
9122 def SetString(*args, **kwargs):
9123 """
9124 SetString(self, int n, String s)
9125
9126 Sets the label for the given item.
9127 """
9128 return _core_.ItemContainer_SetString(*args, **kwargs)
9129
9130 def FindString(*args, **kwargs):
9131 """
9132 FindString(self, String s) -> int
9133
9134 Finds an item whose label matches the given string. Returns the
79fccf9d
RD		 9135 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
9136 found.
d55e5bfc
RD		 9137 """
9138 return _core_.ItemContainer_FindString(*args, **kwargs)
9139
53aa7709 9140 def SetSelection(*args, **kwargs):
d55e5bfc 9141 """
53aa7709 9142 SetSelection(self, int n)
d55e5bfc
RD		 9143
9144 Sets the item at index 'n' to be the selected item.
9145 """
53aa7709 9146 return _core_.ItemContainer_SetSelection(*args, **kwargs)
d55e5bfc 9147
d55e5bfc
RD		 9148 def GetSelection(*args, **kwargs):
9149 """
9150 GetSelection(self) -> int
9151
79fccf9d
RD		 9152 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
9153 is selected.
d55e5bfc
RD		 9154 """
9155 return _core_.ItemContainer_GetSelection(*args, **kwargs)
9156
53aa7709
RD		 9157 def SetStringSelection(*args, **kwargs):
9158 """SetStringSelection(self, String s) -> bool"""
9159 return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
9160
d55e5bfc
RD		 9161 def GetStringSelection(*args, **kwargs):
9162 """
9163 GetStringSelection(self) -> String
9164
79fccf9d
RD		 9165 Returns the label of the selected item or an empty string if no item
9166 is selected.
d55e5bfc
RD		 9167 """
9168 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
9169
53aa7709 9170 def Select(*args, **kwargs):
d55e5bfc 9171 """
53aa7709 9172 Select(self, int n)
d55e5bfc 9173
53aa7709
RD		 9174 This is the same as `SetSelection` and exists only because it is
9175 slightly more natural for controls which support multiple selection.
d55e5bfc 9176 """
53aa7709 9177 return _core_.ItemContainer_Select(*args, **kwargs)
d55e5bfc
RD		 9178
9179
9180class ItemContainerPtr(ItemContainer):
9181 def __init__(self, this):
9182 self.this = this
9183 if not hasattr(self,"thisown"): self.thisown = 0
9184 self.__class__ = ItemContainer
9185_core_.ItemContainer_swigregister(ItemContainerPtr)
9186
9187#---------------------------------------------------------------------------
9188
9189class ControlWithItems(Control,ItemContainer):
9190 """
79fccf9d
RD		 9191 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
9192 wx.Control class, and is used for the base class of various controls
9193 that have items.
d55e5bfc
RD		 9194 """
9195 def __init__(self): raise RuntimeError, "No constructor defined"
9196 def __repr__(self):
9197 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9198
9199class ControlWithItemsPtr(ControlWithItems):
9200 def __init__(self, this):
9201 self.this = this
9202 if not hasattr(self,"thisown"): self.thisown = 0
9203 self.__class__ = ControlWithItems
9204_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
9205
9206#---------------------------------------------------------------------------
9207
9208class SizerItem(Object):
248ed943
RD		 9209 """
9210 The wx.SizerItem class is used to track the position, size and other
9211 attributes of each item managed by a `wx.Sizer`. In normal usage user
9212 code should never need to deal directly with a wx.SizerItem, but
9213 custom classes derived from `wx.PySizer` will probably need to use the
9214 collection of wx.SizerItems held by wx.Sizer when calculating layout.
9215
9216 :see: `wx.Sizer`, `wx.GBSizerItem`
9217 """
d55e5bfc
RD		 9218 def __repr__(self):
9219 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9220 def __init__(self, *args, **kwargs):
248ed943
RD		 9221 """
9222 __init__(self) -> SizerItem
9223
9224 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
9225 size will need to be set before this item can be used in a Sizer.
9226
9227 You will probably never need to create a wx.SizerItem directly as they
9228 are created automatically when the sizer's Add, Insert or Prepend
9229 methods are called.
9230
9231 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
9232 """
d55e5bfc
RD		 9233 newobj = _core_.new_SizerItem(*args, **kwargs)
9234 self.this = newobj.this
9235 self.thisown = 1
9236 del newobj.thisown
9237 def DeleteWindows(*args, **kwargs):
248ed943
RD		 9238 """
9239 DeleteWindows(self)
9240
9241 Destroy the window or the windows in a subsizer, depending on the type
9242 of item.
9243 """
d55e5bfc
RD		 9244 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
9245
9246 def DetachSizer(*args, **kwargs):
248ed943
RD		 9247 """
9248 DetachSizer(self)
9249
9250 Enable deleting the SizerItem without destroying the contained sizer.
9251 """
d55e5bfc
RD		 9252 return _core_.SizerItem_DetachSizer(*args, **kwargs)
9253
9254 def GetSize(*args, **kwargs):
248ed943
RD		 9255 """
9256 GetSize(self) -> Size
9257
9258 Get the current size of the item, as set in the last Layout.
9259 """
d55e5bfc
RD		 9260 return _core_.SizerItem_GetSize(*args, **kwargs)
9261
9262 def CalcMin(*args, **kwargs):
248ed943
RD		 9263 """
9264 CalcMin(self) -> Size
9265
9266 Calculates the minimum desired size for the item, including any space
9267 needed by borders.
9268 """
d55e5bfc
RD		 9269 return _core_.SizerItem_CalcMin(*args, **kwargs)
9270
9271 def SetDimension(*args, **kwargs):
248ed943
RD		 9272 """
9273 SetDimension(self, Point pos, Size size)
9274
9275 Set the position and size of the space allocated for this item by the
9276 sizer, and adjust the position and size of the item (window or
9277 subsizer) to be within that space taking alignment and borders into
9278 account.
9279 """
d55e5bfc
RD		 9280 return _core_.SizerItem_SetDimension(*args, **kwargs)
9281
9282 def GetMinSize(*args, **kwargs):
248ed943
RD		 9283 """
9284 GetMinSize(self) -> Size
9285
9286 Get the minimum size needed for the item.
9287 """
d55e5bfc
RD		 9288 return _core_.SizerItem_GetMinSize(*args, **kwargs)
9289
a001823c
RD		 9290 def GetMinSizeWithBorder(*args, **kwargs):
9291 """
9292 GetMinSizeWithBorder(self) -> Size
9293
9294 Get the minimum size needed for the item with space for the borders
9295 added, if needed.
9296 """
9297 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
9298
d55e5bfc
RD		 9299 def SetInitSize(*args, **kwargs):
9300 """SetInitSize(self, int x, int y)"""
9301 return _core_.SizerItem_SetInitSize(*args, **kwargs)
9302
9303 def SetRatioWH(*args, **kwargs):
248ed943
RD		 9304 """
9305 SetRatioWH(self, int width, int height)
9306
9307 Set the ratio item attribute.
9308 """
d55e5bfc
RD		 9309 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
9310
9311 def SetRatioSize(*args, **kwargs):
248ed943
RD		 9312 """
9313 SetRatioSize(self, Size size)
9314
9315 Set the ratio item attribute.
9316 """
d55e5bfc
RD		 9317 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
9318
9319 def SetRatio(*args, **kwargs):
248ed943
RD		 9320 """
9321 SetRatio(self, float ratio)
9322
9323 Set the ratio item attribute.
9324 """
d55e5bfc
RD		 9325 return _core_.SizerItem_SetRatio(*args, **kwargs)
9326
9327 def GetRatio(*args, **kwargs):
248ed943
RD		 9328 """
9329 GetRatio(self) -> float
9330
9331 Set the ratio item attribute.
9332 """
d55e5bfc
RD		 9333 return _core_.SizerItem_GetRatio(*args, **kwargs)
9334
c1cb24a4
RD		 9335 def GetRect(*args, **kwargs):
9336 """
9337 GetRect(self) -> Rect
9338
9339 Returns the rectangle that the sizer item should occupy
9340 """
9341 return _core_.SizerItem_GetRect(*args, **kwargs)
9342
d55e5bfc 9343 def IsWindow(*args, **kwargs):
248ed943
RD		 9344 """
9345 IsWindow(self) -> bool
9346
9347 Is this sizer item a window?
9348 """
d55e5bfc
RD		 9349 return _core_.SizerItem_IsWindow(*args, **kwargs)
9350
9351 def IsSizer(*args, **kwargs):
248ed943
RD		 9352 """
9353 IsSizer(self) -> bool
9354
9355 Is this sizer item a subsizer?
9356 """
d55e5bfc
RD		 9357 return _core_.SizerItem_IsSizer(*args, **kwargs)
9358
9359 def IsSpacer(*args, **kwargs):
248ed943
RD		 9360 """
9361 IsSpacer(self) -> bool
9362
9363 Is this sizer item a spacer?
9364 """
d55e5bfc
RD		 9365 return _core_.SizerItem_IsSpacer(*args, **kwargs)
9366
9367 def SetProportion(*args, **kwargs):
248ed943
RD		 9368 """
9369 SetProportion(self, int proportion)
9370
9371 Set the proportion value for this item.
9372 """
d55e5bfc
RD		 9373 return _core_.SizerItem_SetProportion(*args, **kwargs)
9374
9375 def GetProportion(*args, **kwargs):
248ed943
RD		 9376 """
9377 GetProportion(self) -> int
9378
9379 Get the proportion value for this item.
9380 """
d55e5bfc
RD		 9381 return _core_.SizerItem_GetProportion(*args, **kwargs)
9382
248ed943
RD		 9383 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9384 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 9385 def SetFlag(*args, **kwargs):
248ed943
RD		 9386 """
9387 SetFlag(self, int flag)
9388
9389 Set the flag value for this item.
9390 """
d55e5bfc
RD		 9391 return _core_.SizerItem_SetFlag(*args, **kwargs)
9392
9393 def GetFlag(*args, **kwargs):
248ed943
RD		 9394 """
9395 GetFlag(self) -> int
9396
9397 Get the flag value for this item.
9398 """
d55e5bfc
RD		 9399 return _core_.SizerItem_GetFlag(*args, **kwargs)
9400
9401 def SetBorder(*args, **kwargs):
248ed943
RD		 9402 """
9403 SetBorder(self, int border)
9404
9405 Set the border value for this item.
9406 """
d55e5bfc
RD		 9407 return _core_.SizerItem_SetBorder(*args, **kwargs)
9408
9409 def GetBorder(*args, **kwargs):
248ed943
RD		 9410 """
9411 GetBorder(self) -> int
9412
9413 Get the border value for this item.
9414 """
d55e5bfc
RD		 9415 return _core_.SizerItem_GetBorder(*args, **kwargs)
9416
9417 def GetWindow(*args, **kwargs):
248ed943
RD		 9418 """
9419 GetWindow(self) -> Window
9420
9421 Get the window (if any) that is managed by this sizer item.
9422 """
d55e5bfc
RD		 9423 return _core_.SizerItem_GetWindow(*args, **kwargs)
9424
9425 def SetWindow(*args, **kwargs):
248ed943
RD		 9426 """
9427 SetWindow(self, Window window)
9428
9429 Set the window to be managed by this sizer item.
9430 """
d55e5bfc
RD		 9431 return _core_.SizerItem_SetWindow(*args, **kwargs)
9432
9433 def GetSizer(*args, **kwargs):
248ed943
RD		 9434 """
9435 GetSizer(self) -> Sizer
9436
9437 Get the subsizer (if any) that is managed by this sizer item.
9438 """
d55e5bfc
RD		 9439 return _core_.SizerItem_GetSizer(*args, **kwargs)
9440
9441 def SetSizer(*args, **kwargs):
248ed943
RD		 9442 """
9443 SetSizer(self, Sizer sizer)
9444
9445 Set the subsizer to be managed by this sizer item.
9446 """
d55e5bfc
RD		 9447 return _core_.SizerItem_SetSizer(*args, **kwargs)
9448
9449 def GetSpacer(*args, **kwargs):
248ed943
RD		 9450 """
9451 GetSpacer(self) -> Size
9452
9453 Get the size of the spacer managed by this sizer item.
9454 """
d55e5bfc
RD		 9455 return _core_.SizerItem_GetSpacer(*args, **kwargs)
9456
9457 def SetSpacer(*args, **kwargs):
248ed943
RD		 9458 """
9459 SetSpacer(self, Size size)
9460
9461 Set the size of the spacer to be managed by this sizer item.
9462 """
d55e5bfc
RD		 9463 return _core_.SizerItem_SetSpacer(*args, **kwargs)
9464
9465 def Show(*args, **kwargs):
248ed943
RD		 9466 """
9467 Show(self, bool show)
9468
9469 Set the show item attribute, which sizers use to determine if the item
9470 is to be made part of the layout or not. If the item is tracking a
9471 window then it is shown or hidden as needed.
9472 """
d55e5bfc
RD		 9473 return _core_.SizerItem_Show(*args, **kwargs)
9474
9475 def IsShown(*args, **kwargs):
248ed943
RD		 9476 """
9477 IsShown(self) -> bool
9478
9479 Is the item to be shown in the layout?
9480 """
d55e5bfc
RD		 9481 return _core_.SizerItem_IsShown(*args, **kwargs)
9482
9483 def GetPosition(*args, **kwargs):
248ed943
RD		 9484 """
9485 GetPosition(self) -> Point
9486
9487 Returns the current position of the item, as set in the last Layout.
9488 """
d55e5bfc
RD		 9489 return _core_.SizerItem_GetPosition(*args, **kwargs)
9490
9491 def GetUserData(*args, **kwargs):
248ed943
RD		 9492 """
9493 GetUserData(self) -> PyObject
9494
9495 Returns the userData associated with this sizer item, or None if there
9496 isn't any.
9497 """
d55e5bfc
RD		 9498 return _core_.SizerItem_GetUserData(*args, **kwargs)
9499
9500
9501class SizerItemPtr(SizerItem):
9502 def __init__(self, this):
9503 self.this = this
9504 if not hasattr(self,"thisown"): self.thisown = 0
9505 self.__class__ = SizerItem
9506_core_.SizerItem_swigregister(SizerItemPtr)
9507
248ed943 9508def SizerItemWindow(*args, **kwargs):
d55e5bfc 9509 """
248ed943
RD		 9510 SizerItemWindow(Window window, int proportion, int flag, int border,
9511 PyObject userData=None) -> SizerItem
9512
9513 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 9514 """
248ed943 9515 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD		 9516 val.thisown = 1
9517 return val
9518
248ed943 9519def SizerItemSpacer(*args, **kwargs):
d55e5bfc 9520 """
248ed943
RD		 9521 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9522 PyObject userData=None) -> SizerItem
9523
9524 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 9525 """
248ed943 9526 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD		 9527 val.thisown = 1
9528 return val
9529
9530def SizerItemSizer(*args, **kwargs):
9531 """
9532 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD		 9533 PyObject userData=None) -> SizerItem
9534
9535 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD		 9536 """
9537 val = _core_.new_SizerItemSizer(*args, **kwargs)
9538 val.thisown = 1
9539 return val
9540
9541class Sizer(Object):
248ed943
RD		 9542 """
9543 wx.Sizer is the abstract base class used for laying out subwindows in
9544 a window. You cannot use wx.Sizer directly; instead, you will have to
9545 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9546 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9547 and `wx.GridBagSizer`.
9548
9549 The concept implemented by sizers in wxWidgets is closely related to
9550 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9551 toolkit or the Qt toolkit. It is based upon the idea of the individual
9552 subwindows reporting their minimal required size and their ability to
9553 get stretched if the size of the parent window has changed. This will
9554 most often mean that the programmer does not set the original size of
9555 a dialog in the beginning, rather the dialog will assigned a sizer and
9556 this sizer will be queried about the recommended size. The sizer in
9557 turn will query its children, which can be normal windows or contorls,
9558 empty space or other sizers, so that a hierarchy of sizers can be
9559 constructed. Note that wxSizer does not derive from wxWindow and thus
9560 do not interfere with tab ordering and requires very little resources
9561 compared to a real window on screen.
9562
9563 What makes sizers so well fitted for use in wxWidgets is the fact that
9564 every control reports its own minimal size and the algorithm can
9565 handle differences in font sizes or different window (dialog item)
9566 sizes on different platforms without problems. If for example the
9567 standard font as well as the overall design of Mac widgets requires
9568 more space than on Windows, then the initial size of a dialog using a
9569 sizer will automatically be bigger on Mac than on Windows.
9570 """
d55e5bfc
RD		 9571 def __init__(self): raise RuntimeError, "No constructor defined"
9572 def __repr__(self):
9573 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9574 def _setOORInfo(*args, **kwargs):
9575 """_setOORInfo(self, PyObject _self)"""
9576 return _core_.Sizer__setOORInfo(*args, **kwargs)
9577
9578 def Add(*args, **kwargs):
9579 """
248ed943 9580 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9581 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 9582
9583 Appends a child item to the sizer.
d55e5bfc
RD		 9584 """
9585 return _core_.Sizer_Add(*args, **kwargs)
9586
9587 def Insert(*args, **kwargs):
9588 """
248ed943 9589 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9590 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 9591
9592 Inserts a new item into the list of items managed by this sizer before
9593 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD		 9594 """
9595 return _core_.Sizer_Insert(*args, **kwargs)
9596
9597 def Prepend(*args, **kwargs):
9598 """
248ed943 9599 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9600 PyObject userData=None) -> wx.SizerItem
248ed943
RD		 9601
9602 Adds a new item to the begining of the list of sizer items managed by
9603 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD		 9604 """
9605 return _core_.Sizer_Prepend(*args, **kwargs)
9606
9607 def Remove(*args, **kwargs):
248ed943
RD		 9608 """
9609 Remove(self, item) -> bool
9610
9611 Removes an item from the sizer and destroys it. This method does not
9612 cause any layout or resizing to take place, call `Layout` to update
9613 the layout on screen after removing a child from the sizer. The
9614 *item* parameter can be either a window, a sizer, or the zero-based
9615 index of an item to remove. Returns True if the child item was found
9616 and removed.
9617 """
d55e5bfc
RD		 9618 return _core_.Sizer_Remove(*args, **kwargs)
9619
1a6bba1e 9620 def Detach(*args, **kwargs):
248ed943
RD		 9621 """
9622 Detach(self, item) -> bool
9623
9624 Detaches an item from the sizer without destroying it. This method
9625 does not cause any layout or resizing to take place, call `Layout` to
9626 do so. The *item* parameter can be either a window, a sizer, or the
9627 zero-based index of the item to be detached. Returns True if the child item
9628 was found and detached.
9629 """
1a6bba1e
RD		 9630 return _core_.Sizer_Detach(*args, **kwargs)
9631
c1cb24a4
RD		 9632 def GetItem(*args, **kwargs):
9633 """
9634 GetItem(self, item) -> wx.SizerItem
9635
9636 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9637 parameter can be either a window, a sizer, or the zero-based index of
9638 the item to be detached.
9639 """
9640 return _core_.Sizer_GetItem(*args, **kwargs)
9641
d55e5bfc
RD		 9642 def _SetItemMinSize(*args, **kwargs):
9643 """_SetItemMinSize(self, PyObject item, Size size)"""
9644 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
9645
248ed943
RD		 9646 def SetItemMinSize(self, item, *args):
9647 """
9648 SetItemMinSize(self, item, Size size)
9649
9650 Sets the minimum size that will be allocated for an item in the sizer.
9651 The *item* parameter can be either a window, a sizer, or the
9652 zero-based index of the item. If a window or sizer is given then it
9653 will be searched for recursivly in subsizers if neccessary.
9654 """
9655 if len(args) == 2:
9656 # for backward compatibility accept separate width,height args too
9657 return self._SetItemMinSize(item, args)
9658 else:
9659 return self._SetItemMinSize(item, args[0])
9660
d55e5bfc 9661 def AddItem(*args, **kwargs):
248ed943
RD		 9662 """
9663 AddItem(self, SizerItem item)
9664
9665 Adds a `wx.SizerItem` to the sizer.
9666 """
d55e5bfc
RD		 9667 return _core_.Sizer_AddItem(*args, **kwargs)
9668
9669 def InsertItem(*args, **kwargs):
248ed943
RD		 9670 """
9671 InsertItem(self, int index, SizerItem item)
9672
9673 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9674 """
d55e5bfc
RD		 9675 return _core_.Sizer_InsertItem(*args, **kwargs)
9676
9677 def PrependItem(*args, **kwargs):
248ed943
RD		 9678 """
9679 PrependItem(self, SizerItem item)
9680
9681 Prepends a `wx.SizerItem` to the sizer.
9682 """
d55e5bfc
RD		 9683 return _core_.Sizer_PrependItem(*args, **kwargs)
9684
248ed943 9685 def AddMany(self, items):
c24da6d6
RD		 9686 """
9687 AddMany is a convenience method for adding several items
9688 to a sizer at one time. Simply pass it a list of tuples,
9689 where each tuple consists of the parameters that you
9690 would normally pass to the `Add` method.
9691 """
248ed943
RD		 9692 for item in items:
9693 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9694 item = (item, )
9695 self.Add(*item)
d55e5bfc
RD		 9696
9697 # for backwards compatibility only, please do not use in new code
b9d6a5f3
RD		 9698 def AddWindow(self, *args, **kw):
9699 """Compatibility alias for `Add`."""
9700 return self.Add(*args, **kw)
9701 def AddSizer(self, *args, **kw):
9702 """Compatibility alias for `Add`."""
9703 return self.Add(*args, **kw)
9704 def AddSpacer(self, *args, **kw):
9705 """Compatibility alias for `Add`."""
9706 return self.Add(*args, **kw)
9707
9708 def PrependWindow(self, *args, **kw):
9709 """Compatibility alias for `Prepend`."""
9710 return self.Prepend(*args, **kw)
9711 def PrependSizer(self, *args, **kw):
9712 """Compatibility alias for `Prepend`."""
9713 return self.Prepend(*args, **kw)
9714 def PrependSpacer(self, *args, **kw):
9715 """Compatibility alias for `Prepend`."""
9716 return self.Prepend(*args, **kw)
9717
9718 def InsertWindow(self, *args, **kw):
9719 """Compatibility alias for `Insert`."""
9720 return self.Insert(*args, **kw)
9721 def InsertSizer(self, *args, **kw):
9722 """Compatibility alias for `Insert`."""
9723 return self.Insert(*args, **kw)
9724 def InsertSpacer(self, *args, **kw):
9725 """Compatibility alias for `Insert`."""
9726 return self.Insert(*args, **kw)
9727
9728 def RemoveWindow(self, *args, **kw):
9729 """Compatibility alias for `Remove`."""
9730 return self.Remove(*args, **kw)
9731 def RemoveSizer(self, *args, **kw):
9732 """Compatibility alias for `Remove`."""
9733 return self.Remove(*args, **kw)
9734 def RemovePos(self, *args, **kw):
9735 """Compatibility alias for `Remove`."""
9736 return self.Remove(*args, **kw)
d55e5bfc
RD		 9737
9738
d55e5bfc 9739 def SetDimension(*args, **kwargs):
248ed943
RD		 9740 """
9741 SetDimension(self, int x, int y, int width, int height)
9742
9743 Call this to force the sizer to take the given dimension and thus
9744 force the items owned by the sizer to resize themselves according to
9745 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9746 methods.
9747 """
d55e5bfc
RD		 9748 return _core_.Sizer_SetDimension(*args, **kwargs)
9749
9750 def SetMinSize(*args, **kwargs):
248ed943
RD		 9751 """
9752 SetMinSize(self, Size size)
9753
9754 Call this to give the sizer a minimal size. Normally, the sizer will
9755 calculate its minimal size based purely on how much space its children
9756 need. After calling this method `GetMinSize` will return either the
9757 minimal size as requested by its children or the minimal size set
9758 here, depending on which is bigger.
9759 """
d55e5bfc
RD		 9760 return _core_.Sizer_SetMinSize(*args, **kwargs)
9761
9762 def GetSize(*args, **kwargs):
248ed943
RD		 9763 """
9764 GetSize(self) -> Size
9765
9766 Returns the current size of the space managed by the sizer.
9767 """
d55e5bfc
RD		 9768 return _core_.Sizer_GetSize(*args, **kwargs)
9769
9770 def GetPosition(*args, **kwargs):
248ed943
RD		 9771 """
9772 GetPosition(self) -> Point
9773
9774 Returns the current position of the sizer's managed space.
9775 """
d55e5bfc
RD		 9776 return _core_.Sizer_GetPosition(*args, **kwargs)
9777
9778 def GetMinSize(*args, **kwargs):
248ed943
RD		 9779 """
9780 GetMinSize(self) -> Size
9781
9782 Returns the minimal size of the sizer. This is either the combined
9783 minimal size of all the children and their borders or the minimal size
9784 set by SetMinSize, depending on which is bigger.
9785 """
d55e5bfc
RD		 9786 return _core_.Sizer_GetMinSize(*args, **kwargs)
9787
9788 def GetSizeTuple(self):
1a6bba1e 9789 return self.GetSize().Get()
d55e5bfc 9790 def GetPositionTuple(self):
1a6bba1e 9791 return self.GetPosition().Get()
d55e5bfc 9792 def GetMinSizeTuple(self):
1a6bba1e 9793 return self.GetMinSize().Get()
d55e5bfc
RD		 9794
9795 def RecalcSizes(*args, **kwargs):
248ed943
RD		 9796 """
9797 RecalcSizes(self)
9798
9799 Using the sizes calculated by `CalcMin` reposition and resize all the
9800 items managed by this sizer. You should not need to call this directly as
9801 it is called by `Layout`.
9802 """
d55e5bfc
RD		 9803 return _core_.Sizer_RecalcSizes(*args, **kwargs)
9804
9805 def CalcMin(*args, **kwargs):
248ed943
RD		 9806 """
9807 CalcMin(self) -> Size
9808
9809 This method is where the sizer will do the actual calculation of its
9810 children's minimal sizes. You should not need to call this directly as
9811 it is called by `Layout`.
9812 """
d55e5bfc
RD		 9813 return _core_.Sizer_CalcMin(*args, **kwargs)
9814
9815 def Layout(*args, **kwargs):
248ed943
RD		 9816 """
9817 Layout(self)
9818
9819 This method will force the recalculation and layout of the items
9820 controlled by the sizer using the current space allocated to the
9821 sizer. Normally this is called automatically from the owning window's
9822 EVT_SIZE handler, but it is also useful to call it from user code when
9823 one of the items in a sizer change size, or items are added or
9824 removed.
9825 """
d55e5bfc
RD		 9826 return _core_.Sizer_Layout(*args, **kwargs)
9827
9828 def Fit(*args, **kwargs):
248ed943
RD		 9829 """
9830 Fit(self, Window window) -> Size
9831
9832 Tell the sizer to resize the *window* to match the sizer's minimal
9833 size. This is commonly done in the constructor of the window itself in
9834 order to set its initial size to match the needs of the children as
9835 determined by the sizer. Returns the new size.
9836
9837 For a top level window this is the total window size, not the client size.
9838 """
d55e5bfc
RD		 9839 return _core_.Sizer_Fit(*args, **kwargs)
9840
9841 def FitInside(*args, **kwargs):
248ed943
RD		 9842 """
9843 FitInside(self, Window window)
9844
9845 Tell the sizer to resize the *virtual size* of the *window* to match the
9846 sizer's minimal size. This will not alter the on screen size of the
9847 window, but may cause the addition/removal/alteration of scrollbars
9848 required to view the virtual area in windows which manage it.
9849
9850 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9851
9852 """
d55e5bfc
RD		 9853 return _core_.Sizer_FitInside(*args, **kwargs)
9854
9855 def SetSizeHints(*args, **kwargs):
248ed943
RD		 9856 """
9857 SetSizeHints(self, Window window)
9858
9859 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9860 match the sizer's minimal size. This is commonly done in the
9861 constructor of the window itself if the window is resizable (as are
9862 many dialogs under Unix and frames on probably all platforms) in order
9863 to prevent the window from being sized smaller than the minimal size
9864 required by the sizer.
9865 """
d55e5bfc
RD		 9866 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9867
9868 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD		 9869 """
9870 SetVirtualSizeHints(self, Window window)
9871
9872 Tell the sizer to set the minimal size of the window virtual area to
9873 match the sizer's minimal size. For windows with managed scrollbars
9874 this will set them appropriately.
9875
9876 :see: `wx.ScrolledWindow.SetScrollbars`
9877
9878 """
d55e5bfc
RD		 9879 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9880
9881 def Clear(*args, **kwargs):
248ed943
RD		 9882 """
9883 Clear(self, bool deleteWindows=False)
9884
9885 Clear all items from the sizer, optionally destroying the window items
9886 as well.
9887 """
d55e5bfc
RD		 9888 return _core_.Sizer_Clear(*args, **kwargs)
9889
9890 def DeleteWindows(*args, **kwargs):
248ed943
RD		 9891 """
9892 DeleteWindows(self)
9893
9894 Destroy all windows managed by the sizer.
9895 """
d55e5bfc
RD		 9896 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9897
9898 def GetChildren(*args, **kwargs):
248ed943 9899 """
51b83b37 9900 GetChildren(self) -> list
248ed943
RD		 9901
9902 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9903 """
d55e5bfc
RD		 9904 return _core_.Sizer_GetChildren(*args, **kwargs)
9905
9906 def Show(*args, **kwargs):
248ed943 9907 """
ae8162c8 9908 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 9909
248ed943
RD		 9910 Shows or hides an item managed by the sizer. To make a sizer item
9911 disappear or reappear, use Show followed by `Layout`. The *item*
9912 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD		 9913 the item. Use the recursive parameter to show or hide an item in a
9914 subsizer. Returns True if the item was found.
248ed943
RD		 9915 """
9916 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD		 9917
9918 def IsShown(*args, **kwargs):
248ed943
RD		 9919 """
9920 IsShown(self, item)
9921
9922 Determines if the item is currently shown. sizer. To make a sizer
9923 item disappear or reappear, use Show followed by `Layout`. The *item*
9924 parameter can be either a window, a sizer, or the zero-based index of
9925 the item.
9926 """
d55e5bfc
RD		 9927 return _core_.Sizer_IsShown(*args, **kwargs)
9928
629e65c2 9929 def Hide(self, item, recursive=False):
248ed943 9930 """
88c6b281 9931 A convenience method for `Show`(item, False, recursive).
248ed943 9932 """
06759a38 9933 return self.Show(item, False, recursive)
248ed943 9934
d55e5bfc 9935 def ShowItems(*args, **kwargs):
248ed943
RD		 9936 """
9937 ShowItems(self, bool show)
9938
84f85550 9939 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9940 """
d55e5bfc
RD		 9941 return _core_.Sizer_ShowItems(*args, **kwargs)
9942
9943
9944class SizerPtr(Sizer):
9945 def __init__(self, this):
9946 self.this = this
9947 if not hasattr(self,"thisown"): self.thisown = 0
9948 self.__class__ = Sizer
9949_core_.Sizer_swigregister(SizerPtr)
9950
9951class PySizer(Sizer):
248ed943
RD		 9952 """
9953 wx.PySizer is a special version of `wx.Sizer` that has been
9954 instrumented to allow the C++ virtual methods to be overloaded in
9955 Python derived classes. You would derive from this class if you are
9956 wanting to implement a custom sizer in Python code. Simply implement
9957 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9958 For example::
9959
9960 class MySizer(wx.PySizer):
9961 def __init__(self):
9962 wx.PySizer.__init__(self)
9963
9964 def CalcMin(self):
9965 for item in self.GetChildren():
9966 # calculate the total minimum width and height needed
9967 # by all items in the sizer according to this sizer's
9968 # layout algorithm.
9969 ...
9970 return wx.Size(width, height)
9971
9972 def RecalcSizes(self):
9973 # find the space allotted to this sizer
9974 pos = self.GetPosition()
9975 size = self.GetSize()
9976 for item in self.GetChildren():
9977 # Recalculate (if necessary) the position and size of
9978 # each item and then call item.SetDimension to do the
9979 # actual positioning and sizing of the items within the
9980 # space alloted to this sizer.
9981 ...
9982 item.SetDimension(itemPos, itemSize)
9983
9984
9985 When `Layout` is called it first calls `CalcMin` followed by
9986 `RecalcSizes` so you can optimize a bit by saving the results of
62d32a5f 9987 `CalcMin` and reusing them in `RecalcSizes`.
248ed943
RD		 9988
9989 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9990
9991
9992 """
d55e5bfc
RD		 9993 def __repr__(self):
9994 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9995 def __init__(self, *args, **kwargs):
248ed943
RD		 9996 """
9997 __init__(self) -> PySizer
9998
9999 Creates a wx.PySizer. Must be called from the __init__ in the derived
10000 class.
10001 """
d55e5bfc
RD		 10002 newobj = _core_.new_PySizer(*args, **kwargs)
10003 self.this = newobj.this
10004 self.thisown = 1
10005 del newobj.thisown
10006 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
10007
10008 def _setCallbackInfo(*args, **kwargs):
10009 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
10010 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
10011
10012
10013class PySizerPtr(PySizer):
10014 def __init__(self, this):
10015 self.this = this
10016 if not hasattr(self,"thisown"): self.thisown = 0
10017 self.__class__ = PySizer
10018_core_.PySizer_swigregister(PySizerPtr)
10019
10020#---------------------------------------------------------------------------
10021
10022class BoxSizer(Sizer):
248ed943
RD		 10023 """
10024 The basic idea behind a box sizer is that windows will most often be
10025 laid out in rather simple basic geometry, typically in a row or a
10026 column or nested hierarchies of either. A wx.BoxSizer will lay out
10027 its items in a simple row or column, depending on the orientation
10028 parameter passed to the constructor.
10029 """
d55e5bfc
RD		 10030 def __repr__(self):
10031 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10032 def __init__(self, *args, **kwargs):
248ed943
RD		 10033 """
10034 __init__(self, int orient=HORIZONTAL) -> BoxSizer
10035
10036 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
10037 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
10038 sizer.
10039 """
d55e5bfc
RD		 10040 newobj = _core_.new_BoxSizer(*args, **kwargs)
10041 self.this = newobj.this
10042 self.thisown = 1
10043 del newobj.thisown
10044 self._setOORInfo(self)
10045
10046 def GetOrientation(*args, **kwargs):
248ed943
RD		 10047 """
10048 GetOrientation(self) -> int
10049
10050 Returns the current orientation of the sizer.
10051 """
d55e5bfc
RD		 10052 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
10053
10054 def SetOrientation(*args, **kwargs):
248ed943
RD		 10055 """
10056 SetOrientation(self, int orient)
d55e5bfc 10057
248ed943
RD		 10058 Resets the orientation of the sizer.
10059 """
10060 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD		 10061
10062
10063class BoxSizerPtr(BoxSizer):
10064 def __init__(self, this):
10065 self.this = this
10066 if not hasattr(self,"thisown"): self.thisown = 0
10067 self.__class__ = BoxSizer
10068_core_.BoxSizer_swigregister(BoxSizerPtr)
10069
10070#---------------------------------------------------------------------------
10071
10072class StaticBoxSizer(BoxSizer):
248ed943
RD		 10073 """
10074 wx.StaticBoxSizer derives from and functions identically to the
10075 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
10076 manages. Note that this static box must be created separately and
10077 passed to the sizer constructor.
10078 """
d55e5bfc
RD		 10079 def __repr__(self):
10080 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10081 def __init__(self, *args, **kwargs):
248ed943
RD		 10082 """
10083 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
10084
10085 Constructor. It takes an associated static box and the orientation
10086 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
10087 ``wx.HORIZONTAL``.
10088 """
d55e5bfc
RD		 10089 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
10090 self.this = newobj.this
10091 self.thisown = 1
10092 del newobj.thisown
10093 self._setOORInfo(self)
10094
10095 def GetStaticBox(*args, **kwargs):
248ed943
RD		 10096 """
10097 GetStaticBox(self) -> StaticBox
d55e5bfc 10098
248ed943
RD		 10099 Returns the static box associated with this sizer.
10100 """
10101 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD		 10102
10103
10104class StaticBoxSizerPtr(StaticBoxSizer):
10105 def __init__(self, this):
10106 self.this = this
10107 if not hasattr(self,"thisown"): self.thisown = 0
10108 self.__class__ = StaticBoxSizer
10109_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
10110
10111#---------------------------------------------------------------------------
10112
10113class GridSizer(Sizer):
248ed943
RD		 10114 """
10115 A grid sizer is a sizer which lays out its children in a
10116 two-dimensional table with all cells having the same size. In other
10117 words, the width of each cell within the grid is the width of the
10118 widest item added to the sizer and the height of each grid cell is the
10119 height of the tallest item. An optional vertical and/or horizontal
10120 gap between items can also be specified (in pixels.)
10121
10122 Items are placed in the cells of the grid in the order they are added,
10123 in row-major order. In other words, the first row is filled first,
10124 then the second, and so on until all items have been added. (If
10125 neccessary, additional rows will be added as items are added.) If you
10126 need to have greater control over the cells that items are placed in
10127 then use the `wx.GridBagSizer`.
10128
10129 """
d55e5bfc
RD		 10130 def __repr__(self):
10131 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10132 def __init__(self, *args, **kwargs):
248ed943
RD		 10133 """
10134 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
10135
10136 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
10137 of columns and rows in the sizer - if either of the parameters is
10138 zero, it will be calculated to from the total number of children in
10139 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10140 define extra space between all children.
10141 """
d55e5bfc
RD		 10142 newobj = _core_.new_GridSizer(*args, **kwargs)
10143 self.this = newobj.this
10144 self.thisown = 1
10145 del newobj.thisown
10146 self._setOORInfo(self)
10147
d55e5bfc 10148 def SetCols(*args, **kwargs):
248ed943
RD		 10149 """
10150 SetCols(self, int cols)
10151
10152 Sets the number of columns in the sizer.
10153 """
d55e5bfc
RD		 10154 return _core_.GridSizer_SetCols(*args, **kwargs)
10155
10156 def SetRows(*args, **kwargs):
248ed943
RD		 10157 """
10158 SetRows(self, int rows)
10159
10160 Sets the number of rows in the sizer.
10161 """
d55e5bfc
RD		 10162 return _core_.GridSizer_SetRows(*args, **kwargs)
10163
10164 def SetVGap(*args, **kwargs):
248ed943
RD		 10165 """
10166 SetVGap(self, int gap)
10167
10168 Sets the vertical gap (in pixels) between the cells in the sizer.
10169 """
d55e5bfc
RD		 10170 return _core_.GridSizer_SetVGap(*args, **kwargs)
10171
10172 def SetHGap(*args, **kwargs):
248ed943
RD		 10173 """
10174 SetHGap(self, int gap)
10175
10176 Sets the horizontal gap (in pixels) between cells in the sizer
10177 """
d55e5bfc
RD		 10178 return _core_.GridSizer_SetHGap(*args, **kwargs)
10179
10180 def GetCols(*args, **kwargs):
248ed943
RD		 10181 """
10182 GetCols(self) -> int
10183
10184 Returns the number of columns in the sizer.
10185 """
d55e5bfc
RD		 10186 return _core_.GridSizer_GetCols(*args, **kwargs)
10187
10188 def GetRows(*args, **kwargs):
248ed943
RD		 10189 """
10190 GetRows(self) -> int
10191
10192 Returns the number of rows in the sizer.
10193 """
d55e5bfc
RD		 10194 return _core_.GridSizer_GetRows(*args, **kwargs)
10195
10196 def GetVGap(*args, **kwargs):
248ed943
RD		 10197 """
10198 GetVGap(self) -> int
10199
10200 Returns the vertical gap (in pixels) between the cells in the sizer.
10201 """
d55e5bfc
RD		 10202 return _core_.GridSizer_GetVGap(*args, **kwargs)
10203
10204 def GetHGap(*args, **kwargs):
248ed943
RD		 10205 """
10206 GetHGap(self) -> int
10207
10208 Returns the horizontal gap (in pixels) between cells in the sizer.
10209 """
d55e5bfc
RD		 10210 return _core_.GridSizer_GetHGap(*args, **kwargs)
10211
10212
10213class GridSizerPtr(GridSizer):
10214 def __init__(self, this):
10215 self.this = this
10216 if not hasattr(self,"thisown"): self.thisown = 0
10217 self.__class__ = GridSizer
10218_core_.GridSizer_swigregister(GridSizerPtr)
10219
10220#---------------------------------------------------------------------------
10221
10222FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
10223FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
10224FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
10225class FlexGridSizer(GridSizer):
248ed943
RD		 10226 """
10227 A flex grid sizer is a sizer which lays out its children in a
10228 two-dimensional table with all table cells in one row having the same
10229 height and all cells in one column having the same width, but all
10230 rows or all columns are not necessarily the same height or width as in
10231 the `wx.GridSizer`.
10232
10233 wx.FlexGridSizer can also size items equally in one direction but
10234 unequally ("flexibly") in the other. If the sizer is only flexible
10235 in one direction (this can be changed using `SetFlexibleDirection`), it
10236 needs to be decided how the sizer should grow in the other ("non
10237 flexible") direction in order to fill the available space. The
10238 `SetNonFlexibleGrowMode` method serves this purpose.
10239
10240
10241 """
d55e5bfc
RD		 10242 def __repr__(self):
10243 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10244 def __init__(self, *args, **kwargs):
248ed943
RD		 10245 """
10246 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
10247
10248 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
10249 number of columns and rows in the sizer - if either of the parameters
10250 is zero, it will be calculated to from the total number of children in
10251 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
10252 define extra space between all children.
10253 """
d55e5bfc
RD		 10254 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
10255 self.this = newobj.this
10256 self.thisown = 1
10257 del newobj.thisown
10258 self._setOORInfo(self)
10259
248ed943
RD		 10260 def AddGrowableRow(*args, **kwargs):
10261 """
10262 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 10263
248ed943
RD		 10264 Specifies that row *idx* (starting from zero) should be grown if there
10265 is extra space available to the sizer.
d55e5bfc 10266
248ed943
RD		 10267 The *proportion* parameter has the same meaning as the stretch factor
10268 for the box sizers except that if all proportions are 0, then all
10269 columns are resized equally (instead of not being resized at all).
10270 """
d55e5bfc
RD		 10271 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
10272
10273 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD		 10274 """
10275 RemoveGrowableRow(self, size_t idx)
10276
10277 Specifies that row *idx* is no longer growable.
10278 """
d55e5bfc
RD		 10279 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
10280
10281 def AddGrowableCol(*args, **kwargs):
248ed943
RD		 10282 """
10283 AddGrowableCol(self, size_t idx, int proportion=0)
10284
10285 Specifies that column *idx* (starting from zero) should be grown if
10286 there is extra space available to the sizer.
10287
10288 The *proportion* parameter has the same meaning as the stretch factor
10289 for the box sizers except that if all proportions are 0, then all
10290 columns are resized equally (instead of not being resized at all).
10291 """
d55e5bfc
RD		 10292 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
10293
10294 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD		 10295 """
10296 RemoveGrowableCol(self, size_t idx)
10297
10298 Specifies that column *idx* is no longer growable.
10299 """
d55e5bfc
RD		 10300 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
10301
10302 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD		 10303 """
10304 SetFlexibleDirection(self, int direction)
10305
10306 Specifies whether the sizer should flexibly resize its columns, rows,
10307 or both. Argument *direction* can be one of the following values. Any
10308 other value is ignored.
10309
10310 ============== =======================================
10311 wx.VERTICAL Rows are flexibly sized.
10312 wx.HORIZONTAL Columns are flexibly sized.
10313 wx.BOTH Both rows and columns are flexibly sized
10314 (this is the default value).
10315 ============== =======================================
10316
10317 Note that this method does not trigger relayout.
10318
10319 """
d55e5bfc
RD		 10320 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
10321
10322 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD		 10323 """
10324 GetFlexibleDirection(self) -> int
10325
10326 Returns a value that specifies whether the sizer
10327 flexibly resizes its columns, rows, or both (default).
10328
10329 :see: `SetFlexibleDirection`
10330 """
d55e5bfc
RD		 10331 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
10332
10333 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 10334 """
10335 SetNonFlexibleGrowMode(self, int mode)
10336
10337 Specifies how the sizer should grow in the non-flexible direction if
10338 there is one (so `SetFlexibleDirection` must have been called
10339 previously). Argument *mode* can be one of the following values:
10340
10341 ========================== =================================================
10342 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
10343 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
10344 `AddGrowableCol` and `AddGrowableRow`. In this
10345 case equal sizing applies to minimum sizes of
10346 columns or rows (this is the default value).
10347 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
10348 the non flexible direction, whether they are
10349 growable or not in the flexbile direction.
10350 ========================== =================================================
10351
10352 Note that this method does not trigger relayout.
10353
10354
10355 """
d55e5bfc
RD		 10356 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
10357
10358 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD		 10359 """
10360 GetNonFlexibleGrowMode(self) -> int
10361
10362 Returns the value that specifies how the sizer grows in the
10363 non-flexible direction if there is one.
10364
10365 :see: `SetNonFlexibleGrowMode`
10366 """
d55e5bfc
RD		 10367 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
10368
10369 def GetRowHeights(*args, **kwargs):
a8eff060
RD		 10370 """
10371 GetRowHeights(self) -> list
10372
10373 Returns a list of integers representing the heights of each of the
10374 rows in the sizer.
10375 """
d55e5bfc
RD		 10376 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
10377
10378 def GetColWidths(*args, **kwargs):
a8eff060
RD		 10379 """
10380 GetColWidths(self) -> list
10381
10382 Returns a list of integers representing the widths of each of the
10383 columns in the sizer.
10384 """
d55e5bfc
RD		 10385 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
10386
10387
10388class FlexGridSizerPtr(FlexGridSizer):
10389 def __init__(self, this):
10390 self.this = this
10391 if not hasattr(self,"thisown"): self.thisown = 0
10392 self.__class__ = FlexGridSizer
10393_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
10394
62d32a5f
RD		 10395class StdDialogButtonSizer(BoxSizer):
10396 """
10397 A special sizer that knows how to order and position standard buttons
10398 in order to conform to the current platform's standards. You simply
10399 need to add each `wx.Button` to the sizer, and be sure to create the
53aa7709 10400 buttons using the standard ID's. Then call `Realize` and the sizer
62d32a5f
RD		 10401 will take care of the rest.
10402
10403 """
10404 def __repr__(self):
10405 return "<%s.%s; proxy of C++ wxStdDialogButtonSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10406 def __init__(self, *args, **kwargs):
10407 """__init__(self) -> StdDialogButtonSizer"""
10408 newobj = _core_.new_StdDialogButtonSizer(*args, **kwargs)
10409 self.this = newobj.this
10410 self.thisown = 1
10411 del newobj.thisown
10412 def AddButton(*args, **kwargs):
10413 """
10414 AddButton(self, wxButton button)
10415
10416 Use this to add the buttons to this sizer. Do not use the `Add`
10417 method in the base class.
10418 """
10419 return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
10420
53aa7709 10421 def Realize(*args, **kwargs):
62d32a5f 10422 """
53aa7709 10423 Realize(self)
62d32a5f
RD		 10424
10425 This funciton needs to be called after all the buttons have been added
10426 to the sizer. It will reorder them and position them in a platform
10427 specifc manner.
10428 """
53aa7709 10429 return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
51b83b37
RD		 10430
10431 def SetAffirmativeButton(*args, **kwargs):
10432 """SetAffirmativeButton(self, wxButton button)"""
10433 return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
10434
10435 def SetNegativeButton(*args, **kwargs):
10436 """SetNegativeButton(self, wxButton button)"""
10437 return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
10438
10439 def SetCancelButton(*args, **kwargs):
10440 """SetCancelButton(self, wxButton button)"""
10441 return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
62d32a5f
RD		 10442
10443 def GetAffirmativeButton(*args, **kwargs):
10444 """GetAffirmativeButton(self) -> wxButton"""
10445 return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
10446
10447 def GetApplyButton(*args, **kwargs):
10448 """GetApplyButton(self) -> wxButton"""
10449 return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
10450
10451 def GetNegativeButton(*args, **kwargs):
10452 """GetNegativeButton(self) -> wxButton"""
10453 return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
10454
10455 def GetCancelButton(*args, **kwargs):
10456 """GetCancelButton(self) -> wxButton"""
10457 return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
10458
10459 def GetHelpButton(*args, **kwargs):
10460 """GetHelpButton(self) -> wxButton"""
10461 return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
10462
10463
10464class StdDialogButtonSizerPtr(StdDialogButtonSizer):
10465 def __init__(self, this):
10466 self.this = this
10467 if not hasattr(self,"thisown"): self.thisown = 0
10468 self.__class__ = StdDialogButtonSizer
10469_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizerPtr)
10470
d55e5bfc
RD		 10471#---------------------------------------------------------------------------
10472
10473class GBPosition(object):
248ed943
RD		 10474 """
10475 This class represents the position of an item in a virtual grid of
10476 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10477 typemaps that will automatically convert from a 2-element sequence of
10478 integers to a wx.GBPosition, so you can use the more pythonic
10479 representation of the position nearly transparently in Python code.
10480 """
d55e5bfc
RD		 10481 def __repr__(self):
10482 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10483 def __init__(self, *args, **kwargs):
248ed943
RD		 10484 """
10485 __init__(self, int row=0, int col=0) -> GBPosition
10486
10487 This class represents the position of an item in a virtual grid of
10488 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10489 typemaps that will automatically convert from a 2-element sequence of
10490 integers to a wx.GBPosition, so you can use the more pythonic
10491 representation of the position nearly transparently in Python code.
10492 """
d55e5bfc
RD		 10493 newobj = _core_.new_GBPosition(*args, **kwargs)
10494 self.this = newobj.this
10495 self.thisown = 1
10496 del newobj.thisown
10497 def GetRow(*args, **kwargs):
10498 """GetRow(self) -> int"""
10499 return _core_.GBPosition_GetRow(*args, **kwargs)
10500
10501 def GetCol(*args, **kwargs):
10502 """GetCol(self) -> int"""
10503 return _core_.GBPosition_GetCol(*args, **kwargs)
10504
10505 def SetRow(*args, **kwargs):
10506 """SetRow(self, int row)"""
10507 return _core_.GBPosition_SetRow(*args, **kwargs)
10508
10509 def SetCol(*args, **kwargs):
10510 """SetCol(self, int col)"""
10511 return _core_.GBPosition_SetCol(*args, **kwargs)
10512
10513 def __eq__(*args, **kwargs):
10514 """__eq__(self, GBPosition other) -> bool"""
10515 return _core_.GBPosition___eq__(*args, **kwargs)
10516
10517 def __ne__(*args, **kwargs):
10518 """__ne__(self, GBPosition other) -> bool"""
10519 return _core_.GBPosition___ne__(*args, **kwargs)
10520
10521 def Set(*args, **kwargs):
10522 """Set(self, int row=0, int col=0)"""
10523 return _core_.GBPosition_Set(*args, **kwargs)
10524
10525 def Get(*args, **kwargs):
10526 """Get(self) -> PyObject"""
10527 return _core_.GBPosition_Get(*args, **kwargs)
10528
79fccf9d 10529 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 10530 def __str__(self): return str(self.Get())
10531 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10532 def __len__(self): return len(self.Get())
10533 def __getitem__(self, index): return self.Get()[index]
10534 def __setitem__(self, index, val):
10535 if index == 0: self.SetRow(val)
10536 elif index == 1: self.SetCol(val)
10537 else: raise IndexError
10538 def __nonzero__(self): return self.Get() != (0,0)
10539 __safe_for_unpickling__ = True
10540 def __reduce__(self): return (wx.GBPosition, self.Get())
10541
10542 row = property(GetRow, SetRow)
10543 col = property(GetCol, SetCol)
10544
10545
10546class GBPositionPtr(GBPosition):
10547 def __init__(self, this):
10548 self.this = this
10549 if not hasattr(self,"thisown"): self.thisown = 0
10550 self.__class__ = GBPosition
10551_core_.GBPosition_swigregister(GBPositionPtr)
10552
10553class GBSpan(object):
248ed943
RD		 10554 """
10555 This class is used to hold the row and column spanning attributes of
10556 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10557 automatically convert from a 2-element sequence of integers to a
10558 wx.GBSpan, so you can use the more pythonic representation of the span
10559 nearly transparently in Python code.
10560
10561 """
d55e5bfc
RD		 10562 def __repr__(self):
10563 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10564 def __init__(self, *args, **kwargs):
248ed943
RD		 10565 """
10566 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10567
10568 Construct a new wxGBSpan, optionally setting the rowspan and
10569 colspan. The default is (1,1). (Meaning that the item occupies one
10570 cell in each direction.
10571 """
d55e5bfc
RD		 10572 newobj = _core_.new_GBSpan(*args, **kwargs)
10573 self.this = newobj.this
10574 self.thisown = 1
10575 del newobj.thisown
10576 def GetRowspan(*args, **kwargs):
10577 """GetRowspan(self) -> int"""
10578 return _core_.GBSpan_GetRowspan(*args, **kwargs)
10579
10580 def GetColspan(*args, **kwargs):
10581 """GetColspan(self) -> int"""
10582 return _core_.GBSpan_GetColspan(*args, **kwargs)
10583
10584 def SetRowspan(*args, **kwargs):
10585 """SetRowspan(self, int rowspan)"""
10586 return _core_.GBSpan_SetRowspan(*args, **kwargs)
10587
10588 def SetColspan(*args, **kwargs):
10589 """SetColspan(self, int colspan)"""
10590 return _core_.GBSpan_SetColspan(*args, **kwargs)
10591
10592 def __eq__(*args, **kwargs):
10593 """__eq__(self, GBSpan other) -> bool"""
10594 return _core_.GBSpan___eq__(*args, **kwargs)
10595
10596 def __ne__(*args, **kwargs):
10597 """__ne__(self, GBSpan other) -> bool"""
10598 return _core_.GBSpan___ne__(*args, **kwargs)
10599
10600 def Set(*args, **kwargs):
10601 """Set(self, int rowspan=1, int colspan=1)"""
10602 return _core_.GBSpan_Set(*args, **kwargs)
10603
10604 def Get(*args, **kwargs):
10605 """Get(self) -> PyObject"""
10606 return _core_.GBSpan_Get(*args, **kwargs)
10607
79fccf9d 10608 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD		 10609 def __str__(self): return str(self.Get())
10610 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10611 def __len__(self): return len(self.Get())
10612 def __getitem__(self, index): return self.Get()[index]
10613 def __setitem__(self, index, val):
10614 if index == 0: self.SetRowspan(val)
10615 elif index == 1: self.SetColspan(val)
10616 else: raise IndexError
10617 def __nonzero__(self): return self.Get() != (0,0)
10618 __safe_for_unpickling__ = True
10619 def __reduce__(self): return (wx.GBSpan, self.Get())
10620
10621 rowspan = property(GetRowspan, SetRowspan)
10622 colspan = property(GetColspan, SetColspan)
10623
10624
10625class GBSpanPtr(GBSpan):
10626 def __init__(self, this):
10627 self.this = this
10628 if not hasattr(self,"thisown"): self.thisown = 0
10629 self.__class__ = GBSpan
10630_core_.GBSpan_swigregister(GBSpanPtr)
10631
10632class GBSizerItem(SizerItem):
248ed943
RD		 10633 """
10634 The wx.GBSizerItem class is used to track the additional data about
10635 items in a `wx.GridBagSizer` such as the item's position in the grid
10636 and how many rows or columns it spans.
10637
10638 """
d55e5bfc
RD		 10639 def __repr__(self):
10640 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10641 def __init__(self, *args, **kwargs):
248ed943
RD		 10642 """
10643 __init__(self) -> GBSizerItem
10644
10645 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10646 size will need to be set, as well as a position and span before this
10647 item can be used in a Sizer.
10648
10649 You will probably never need to create a wx.GBSizerItem directly as they
10650 are created automatically when the sizer's Add method is called.
10651 """
d55e5bfc
RD		 10652 newobj = _core_.new_GBSizerItem(*args, **kwargs)
10653 self.this = newobj.this
10654 self.thisown = 1
10655 del newobj.thisown
10656 def GetPos(*args, **kwargs):
248ed943
RD		 10657 """
10658 GetPos(self) -> GBPosition
10659
10660 Get the grid position of the item
10661 """
d55e5bfc
RD		 10662 return _core_.GBSizerItem_GetPos(*args, **kwargs)
10663
10664 def GetPosTuple(self): return self.GetPos().Get()
10665 def GetSpan(*args, **kwargs):
248ed943
RD		 10666 """
10667 GetSpan(self) -> GBSpan
10668
10669 Get the row and column spanning of the item
10670 """
d55e5bfc
RD		 10671 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
10672
10673 def GetSpanTuple(self): return self.GetSpan().Get()
10674 def SetPos(*args, **kwargs):
248ed943
RD		 10675 """
10676 SetPos(self, GBPosition pos) -> bool
10677
10678 If the item is already a member of a sizer then first ensure that
10679 there is no other item that would intersect with this one at the new
10680 position, then set the new position. Returns True if the change is
10681 successful and after the next Layout() the item will be moved.
10682 """
d55e5bfc
RD		 10683 return _core_.GBSizerItem_SetPos(*args, **kwargs)
10684
10685 def SetSpan(*args, **kwargs):
248ed943
RD		 10686 """
10687 SetSpan(self, GBSpan span) -> bool
10688
10689 If the item is already a member of a sizer then first ensure that
10690 there is no other item that would intersect with this one with its new
10691 spanning size, then set the new spanning. Returns True if the change
10692 is successful and after the next Layout() the item will be resized.
10693
10694 """
d55e5bfc
RD		 10695 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
10696
248ed943 10697 def Intersects(*args, **kwargs):
d55e5bfc
RD		 10698 """
10699 Intersects(self, GBSizerItem other) -> bool
248ed943
RD		 10700
10701 Returns True if this item and the other item instersect.
d55e5bfc 10702 """
248ed943
RD		 10703 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10704
10705 def IntersectsPos(*args, **kwargs):
10706 """
10707 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10708
10709 Returns True if the given pos/span would intersect with this item.
10710 """
10711 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD		 10712
10713 def GetEndPos(*args, **kwargs):
248ed943
RD		 10714 """
10715 GetEndPos(self) -> GBPosition
10716
10717 Get the row and column of the endpoint of this item.
10718 """
d55e5bfc
RD		 10719 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
10720
10721 def GetGBSizer(*args, **kwargs):
248ed943
RD		 10722 """
10723 GetGBSizer(self) -> GridBagSizer
10724
10725 Get the sizer this item is a member of.
10726 """
d55e5bfc
RD		 10727 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
10728
10729 def SetGBSizer(*args, **kwargs):
248ed943
RD		 10730 """
10731 SetGBSizer(self, GridBagSizer sizer)
10732
10733 Set the sizer this item is a member of.
10734 """
d55e5bfc
RD		 10735 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
10736
10737
10738class GBSizerItemPtr(GBSizerItem):
10739 def __init__(self, this):
10740 self.this = this
10741 if not hasattr(self,"thisown"): self.thisown = 0
10742 self.__class__ = GBSizerItem
10743_core_.GBSizerItem_swigregister(GBSizerItemPtr)
10744DefaultSpan = cvar.DefaultSpan
10745
10746def GBSizerItemWindow(*args, **kwargs):
10747 """
10748 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 10749 int border, PyObject userData=None) -> GBSizerItem
10750
10751 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD		 10752 """
10753 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
10754 val.thisown = 1
10755 return val
10756
10757def GBSizerItemSizer(*args, **kwargs):
10758 """
10759 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD		 10760 int border, PyObject userData=None) -> GBSizerItem
10761
10762 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD		 10763 """
10764 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
10765 val.thisown = 1
10766 return val
10767
10768def GBSizerItemSpacer(*args, **kwargs):
10769 """
10770 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD		 10771 int flag, int border, PyObject userData=None) -> GBSizerItem
10772
10773 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD		 10774 """
10775 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
10776 val.thisown = 1
10777 return val
10778
10779class GridBagSizer(FlexGridSizer):
248ed943
RD		 10780 """
10781 A `wx.Sizer` that can lay out items in a virtual grid like a
10782 `wx.FlexGridSizer` but in this case explicit positioning of the items
10783 is allowed using `wx.GBPosition`, and items can optionally span more
10784 than one row and/or column using `wx.GBSpan`. The total size of the
10785 virtual grid is determined by the largest row and column that items are
10786 positioned at, adjusted for spanning.
10787
10788 """
d55e5bfc
RD		 10789 def __repr__(self):
10790 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10791 def __init__(self, *args, **kwargs):
248ed943
RD		 10792 """
10793 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10794
10795 Constructor, with optional parameters to specify the gap between the
10796 rows and columns.
10797 """
d55e5bfc
RD		 10798 newobj = _core_.new_GridBagSizer(*args, **kwargs)
10799 self.this = newobj.this
10800 self.thisown = 1
10801 del newobj.thisown
c9c2cf70
RD		 10802 self._setOORInfo(self)
10803
d55e5bfc
RD		 10804 def Add(*args, **kwargs):
10805 """
248ed943 10806 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 10807 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD		 10808
10809 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10810 more than one row or column as specified with *span*. The remaining
10811 args behave similarly to `wx.Sizer.Add`.
10812
10813 Returns True if the item was successfully placed at the given cell
10814 position, False if something was already there.
10815
d55e5bfc
RD		 10816 """
10817 return _core_.GridBagSizer_Add(*args, **kwargs)
10818
10819 def AddItem(*args, **kwargs):
248ed943 10820 """
c1cb24a4 10821 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD		 10822
10823 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10824 the item was successfully placed at its given cell position, False if
10825 something was already there.
10826 """
d55e5bfc
RD		 10827 return _core_.GridBagSizer_AddItem(*args, **kwargs)
10828
84f85550
RD		 10829 def GetCellSize(*args, **kwargs):
10830 """
10831 GetCellSize(self, int row, int col) -> Size
10832
10833 Get the size of the specified cell, including hgap and
10834 vgap. Only valid after a Layout.
10835 """
10836 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10837
d55e5bfc 10838 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD		 10839 """
10840 GetEmptyCellSize(self) -> Size
10841
10842 Get the size used for cells in the grid with no item.
10843 """
d55e5bfc
RD		 10844 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
10845
10846 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD		 10847 """
10848 SetEmptyCellSize(self, Size sz)
10849
10850 Set the size used for cells in the grid with no item.
10851 """
d55e5bfc
RD		 10852 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
10853
10854 def GetItemPosition(*args):
10855 """
248ed943
RD		 10856 GetItemPosition(self, item) -> GBPosition
10857
10858 Get the grid position of the specified *item* where *item* is either a
10859 window or subsizer that is a member of this sizer, or a zero-based
10860 index of an item.
d55e5bfc
RD		 10861 """
10862 return _core_.GridBagSizer_GetItemPosition(*args)
10863
10864 def SetItemPosition(*args):
10865 """
248ed943
RD		 10866 SetItemPosition(self, item, GBPosition pos) -> bool
10867
10868 Set the grid position of the specified *item* where *item* is either a
10869 window or subsizer that is a member of this sizer, or a zero-based
10870 index of an item. Returns True on success. If the move is not
10871 allowed (because an item is already there) then False is returned.
10872
d55e5bfc
RD		 10873 """
10874 return _core_.GridBagSizer_SetItemPosition(*args)
10875
10876 def GetItemSpan(*args):
10877 """
248ed943
RD		 10878 GetItemSpan(self, item) -> GBSpan
10879
10880 Get the row/col spanning of the specified *item* where *item* is
10881 either a window or subsizer that is a member of this sizer, or a
10882 zero-based index of an item.
d55e5bfc
RD		 10883 """
10884 return _core_.GridBagSizer_GetItemSpan(*args)
10885
10886 def SetItemSpan(*args):
10887 """
248ed943
RD		 10888 SetItemSpan(self, item, GBSpan span) -> bool
10889
10890 Set the row/col spanning of the specified *item* where *item* is
10891 either a window or subsizer that is a member of this sizer, or a
10892 zero-based index of an item. Returns True on success. If the move is
10893 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD		 10894 """
10895 return _core_.GridBagSizer_SetItemSpan(*args)
10896
10897 def FindItem(*args):
10898 """
248ed943
RD		 10899 FindItem(self, item) -> GBSizerItem
10900
10901 Find the sizer item for the given window or subsizer, returns None if
10902 not found. (non-recursive)
d55e5bfc
RD		 10903 """
10904 return _core_.GridBagSizer_FindItem(*args)
10905
10906 def FindItemAtPosition(*args, **kwargs):
248ed943
RD		 10907 """
10908 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10909
10910 Return the sizer item for the given grid cell, or None if there is no
10911 item at that position. (non-recursive)
10912 """
d55e5bfc
RD		 10913 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10914
10915 def FindItemAtPoint(*args, **kwargs):
248ed943
RD		 10916 """
10917 FindItemAtPoint(self, Point pt) -> GBSizerItem
10918
10919 Return the sizer item located at the point given in *pt*, or None if
10920 there is no item at that point. The (x,y) coordinates in pt correspond
10921 to the client coordinates of the window using the sizer for
10922 layout. (non-recursive)
10923 """
d55e5bfc
RD		 10924 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10925
248ed943
RD		 10926 def CheckForIntersection(*args, **kwargs):
10927 """
10928 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10929
248ed943
RD		 10930 Look at all items and see if any intersect (or would overlap) the
10931 given *item*. Returns True if so, False if there would be no overlap.
10932 If an *excludeItem* is given then it will not be checked for
10933 intersection, for example it may be the item we are checking the
10934 position of.
d55e5bfc 10935
248ed943
RD		 10936 """
10937 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10938
248ed943 10939 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10940 """
248ed943
RD		 10941 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10942
10943 Look at all items and see if any intersect (or would overlap) the
10944 given position and span. Returns True if so, False if there would be
10945 no overlap. If an *excludeItem* is given then it will not be checked
10946 for intersection, for example it may be the item we are checking the
10947 position of.
d55e5bfc 10948 """
248ed943 10949 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD		 10950
10951
10952class GridBagSizerPtr(GridBagSizer):
10953 def __init__(self, this):
10954 self.this = this
10955 if not hasattr(self,"thisown"): self.thisown = 0
10956 self.__class__ = GridBagSizer
10957_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10958
10959#---------------------------------------------------------------------------
10960
10961Left = _core_.Left
10962Top = _core_.Top
10963Right = _core_.Right
10964Bottom = _core_.Bottom
10965Width = _core_.Width
10966Height = _core_.Height
10967Centre = _core_.Centre
10968Center = _core_.Center
10969CentreX = _core_.CentreX
10970CentreY = _core_.CentreY
10971Unconstrained = _core_.Unconstrained
10972AsIs = _core_.AsIs
10973PercentOf = _core_.PercentOf
10974Above = _core_.Above
10975Below = _core_.Below
10976LeftOf = _core_.LeftOf
10977RightOf = _core_.RightOf
10978SameAs = _core_.SameAs
10979Absolute = _core_.Absolute
10980class IndividualLayoutConstraint(Object):
10981 """
79fccf9d
RD		 10982 Objects of this class are stored in the `wx.LayoutConstraints` class as
10983 one of eight possible constraints that a window can be involved in.
10984 You will never need to create an instance of
10985 wx.IndividualLayoutConstraint, rather you should create a
10986 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10987 that it contains.
d55e5bfc
RD		 10988 """
10989 def __init__(self): raise RuntimeError, "No constructor defined"
10990 def __repr__(self):
10991 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10992 def Set(*args, **kwargs):
79fccf9d
RD		 10993 """
10994 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10995
10996 Sets the properties of the constraint. Normally called by one of the
10997 convenience functions such as Above, RightOf, SameAs.
10998 """
d55e5bfc
RD		 10999 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
11000
11001 def LeftOf(*args, **kwargs):
11002 """
11003 LeftOf(self, Window sibling, int marg=0)
11004
79fccf9d
RD		 11005 Constrains this edge to be to the left of the given window, with an
11006 optional margin. Implicitly, this is relative to the left edge of the
11007 other window.
d55e5bfc
RD		 11008 """
11009 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
11010
11011 def RightOf(*args, **kwargs):
11012 """
11013 RightOf(self, Window sibling, int marg=0)
11014
79fccf9d
RD		 11015 Constrains this edge to be to the right of the given window, with an
11016 optional margin. Implicitly, this is relative to the right edge of the
11017 other window.
d55e5bfc
RD		 11018 """
11019 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
11020
11021 def Above(*args, **kwargs):
11022 """
11023 Above(self, Window sibling, int marg=0)
11024
79fccf9d
RD		 11025 Constrains this edge to be above the given window, with an optional
11026 margin. Implicitly, this is relative to the top edge of the other
11027 window.
d55e5bfc
RD		 11028 """
11029 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
11030
11031 def Below(*args, **kwargs):
11032 """
11033 Below(self, Window sibling, int marg=0)
11034
79fccf9d
RD		 11035 Constrains this edge to be below the given window, with an optional
11036 margin. Implicitly, this is relative to the bottom edge of the other
11037 window.
d55e5bfc
RD		 11038 """
11039 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
11040
11041 def SameAs(*args, **kwargs):
11042 """
11043 SameAs(self, Window otherW, int edge, int marg=0)
11044
79fccf9d
RD		 11045 Constrains this edge or dimension to be to the same as the edge of the
11046 given window, with an optional margin.
d55e5bfc
RD		 11047 """
11048 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
11049
11050 def PercentOf(*args, **kwargs):
11051 """
11052 PercentOf(self, Window otherW, int wh, int per)
11053
79fccf9d
RD		 11054 Constrains this edge or dimension to be to a percentage of the given
11055 window, with an optional margin.
d55e5bfc
RD		 11056 """
11057 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
11058
11059 def Absolute(*args, **kwargs):
11060 """
11061 Absolute(self, int val)
11062
79fccf9d 11063 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD		 11064 """
11065 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
11066
11067 def Unconstrained(*args, **kwargs):
11068 """
11069 Unconstrained(self)
11070
79fccf9d
RD		 11071 Sets this edge or dimension to be unconstrained, that is, dependent on
11072 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD		 11073 """
11074 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
11075
11076 def AsIs(*args, **kwargs):
11077 """
11078 AsIs(self)
11079
79fccf9d
RD		 11080 Sets this edge or constraint to be whatever the window's value is at
11081 the moment. If either of the width and height constraints are *as is*,
11082 the window will not be resized, but moved instead. This is important
11083 when considering panel items which are intended to have a default
11084 size, such as a button, which may take its size from the size of the
11085 button label.
d55e5bfc
RD		 11086 """
11087 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
11088
11089 def GetOtherWindow(*args, **kwargs):
11090 """GetOtherWindow(self) -> Window"""
11091 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
11092
11093 def GetMyEdge(*args, **kwargs):
11094 """GetMyEdge(self) -> int"""
11095 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
11096
11097 def SetEdge(*args, **kwargs):
11098 """SetEdge(self, int which)"""
11099 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
11100
11101 def SetValue(*args, **kwargs):
11102 """SetValue(self, int v)"""
11103 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
11104
11105 def GetMargin(*args, **kwargs):
11106 """GetMargin(self) -> int"""
11107 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
11108
11109 def SetMargin(*args, **kwargs):
11110 """SetMargin(self, int m)"""
11111 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
11112
11113 def GetValue(*args, **kwargs):
11114 """GetValue(self) -> int"""
11115 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
11116
11117 def GetPercent(*args, **kwargs):
11118 """GetPercent(self) -> int"""
11119 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
11120
11121 def GetOtherEdge(*args, **kwargs):
11122 """GetOtherEdge(self) -> int"""
11123 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
11124
11125 def GetDone(*args, **kwargs):
11126 """GetDone(self) -> bool"""
11127 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
11128
11129 def SetDone(*args, **kwargs):
11130 """SetDone(self, bool d)"""
11131 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
11132
11133 def GetRelationship(*args, **kwargs):
11134 """GetRelationship(self) -> int"""
11135 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
11136
11137 def SetRelationship(*args, **kwargs):
11138 """SetRelationship(self, int r)"""
11139 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
11140
11141 def ResetIfWin(*args, **kwargs):
11142 """
11143 ResetIfWin(self, Window otherW) -> bool
11144
11145 Reset constraint if it mentions otherWin
11146 """
11147 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
11148
11149 def SatisfyConstraint(*args, **kwargs):
11150 """
11151 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
11152
11153 Try to satisfy constraint
11154 """
11155 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
11156
11157 def GetEdge(*args, **kwargs):
11158 """
11159 GetEdge(self, int which, Window thisWin, Window other) -> int
11160
11161 Get the value of this edge or dimension, or if this
11162 is not determinable, -1.
11163 """
11164 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
11165
11166
11167class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
11168 def __init__(self, this):
11169 self.this = this
11170 if not hasattr(self,"thisown"): self.thisown = 0
11171 self.__class__ = IndividualLayoutConstraint
11172_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
11173
11174class LayoutConstraints(Object):
11175 """
79fccf9d
RD		 11176 **Note:** constraints are now deprecated and you should use sizers
11177 instead.
d55e5bfc 11178
79fccf9d
RD		 11179 Objects of this class can be associated with a window to define its
11180 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD		 11181
11182 The class consists of the following eight constraints of class
11183 wx.IndividualLayoutConstraint, some or all of which should be accessed
11184 directly to set the appropriate constraints.
11185
11186 * left: represents the left hand edge of the window
11187 * right: represents the right hand edge of the window
11188 * top: represents the top edge of the window
11189 * bottom: represents the bottom edge of the window
11190 * width: represents the width of the window
11191 * height: represents the height of the window
11192 * centreX: represents the horizontal centre point of the window
11193 * centreY: represents the vertical centre point of the window
11194
79fccf9d
RD		 11195 Most constraints are initially set to have the relationship
11196 wxUnconstrained, which means that their values should be calculated by
11197 looking at known constraints. The exceptions are width and height,
11198 which are set to wxAsIs to ensure that if the user does not specify a
11199 constraint, the existing width and height will be used, to be
11200 compatible with panel items which often have take a default size. If
11201 the constraint is ``wx.AsIs``, the dimension will not be changed.
11202
11203 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD		 11204
11205 """
11206 def __repr__(self):
11207 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
11208 left = property(_core_.LayoutConstraints_left_get)
11209 top = property(_core_.LayoutConstraints_top_get)
11210 right = property(_core_.LayoutConstraints_right_get)
11211 bottom = property(_core_.LayoutConstraints_bottom_get)
11212 width = property(_core_.LayoutConstraints_width_get)
11213 height = property(_core_.LayoutConstraints_height_get)
11214 centreX = property(_core_.LayoutConstraints_centreX_get)
11215 centreY = property(_core_.LayoutConstraints_centreY_get)
11216 def __init__(self, *args, **kwargs):
11217 """__init__(self) -> LayoutConstraints"""
11218 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
11219 self.this = newobj.this
11220 self.thisown = 1
11221 del newobj.thisown
11222 def SatisfyConstraints(*args, **kwargs):
11223 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
11224 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
11225
11226 def AreSatisfied(*args, **kwargs):
11227 """AreSatisfied(self) -> bool"""
11228 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
11229
11230
11231class LayoutConstraintsPtr(LayoutConstraints):
11232 def __init__(self, this):
11233 self.this = this
11234 if not hasattr(self,"thisown"): self.thisown = 0
11235 self.__class__ = LayoutConstraints
11236_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
11237
11238#----------------------------------------------------------------------------
11239
11240# Use Python's bool constants if available, make some if not
11241try:
11242 True
11243except NameError:
11244 __builtins__.True = 1==1
11245 __builtins__.False = 1==0
11246 def bool(value): return not not value
11247 __builtins__.bool = bool
11248
11249
11250
11251# workarounds for bad wxRTTI names
11252__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
11253__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
11254__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
11255
11256
11257#----------------------------------------------------------------------------
11258# Load version numbers from __version__... Ensure that major and minor
0f63ec68 11259# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD		 11260
11261from __version__ import *
11262__version__ = VERSION_STRING
11263
0f63ec68
RD		 11264assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
11265assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD		 11266if RELEASE_VERSION != _core_.RELEASE_VERSION:
11267 import warnings
0f63ec68 11268 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD		 11269
11270#----------------------------------------------------------------------------
11271
62d32a5f
RD		 11272# Set the default string<-->unicode conversion encoding from the
11273# locale. This encoding is used when string or unicode objects need
11274# to be converted in order to pass them to wxWidgets. Please be aware
11275# that the default encoding within the same locale may be slightly
11276# different on different platforms. For example, please see
11277# http://www.alanwood.net/demos/charsetdiffs.html for differences
11278# between the common latin/roman encodings.
396fb509
RD		 11279
11280default = _sys.getdefaultencoding()
11281if default == 'ascii':
11282 import locale
11283 import codecs
11284 try:
11285 default = locale.getdefaultlocale()[1]
11286 codecs.lookup(default)
11287 except (ValueError, LookupError):
11288 default = _sys.getdefaultencoding()
11289 del locale
11290 del codecs
5cbf236d
RD		 11291if default:
11292 wx.SetDefaultPyEncoding(default)
11293del default
5cbf236d
RD		 11294
11295#----------------------------------------------------------------------------
11296
d55e5bfc
RD		 11297class PyDeadObjectError(AttributeError):
11298 pass
11299
11300class _wxPyDeadObject(object):
11301 """
11302 Instances of wx objects that are OOR capable will have their __class__
11303 changed to this class when the C++ object is deleted. This should help
11304 prevent crashes due to referencing a bogus C++ pointer.
11305 """
11306 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
11307 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
11308
11309 def __repr__(self):
11310 if not hasattr(self, "_name"):
11311 self._name = "[unknown]"
11312 return self.reprStr % self._name
11313
11314 def __getattr__(self, *args):
11315 if not hasattr(self, "_name"):
11316 self._name = "[unknown]"
11317 raise PyDeadObjectError(self.attrStr % self._name)
11318
11319 def __nonzero__(self):
11320 return 0
11321
11322
11323
11324class PyUnbornObjectError(AttributeError):
11325 pass
11326
11327class _wxPyUnbornObject(object):
11328 """
11329 Some stock objects are created when the wx._core module is
11330 imported, but their C++ instance is not created until the wx.App
11331 object is created and initialized. These object instances will
11332 temporarily have their __class__ changed to this class so an
11333 exception will be raised if they are used before the C++ instance
11334 is ready.
11335 """
11336
11337 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
11338 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
11339
11340 def __repr__(self):
11341 #if not hasattr(self, "_name"):
11342 # self._name = "[unknown]"
11343 return self.reprStr #% self._name
11344
11345 def __getattr__(self, *args):
11346 #if not hasattr(self, "_name"):
11347 # self._name = "[unknown]"
11348 raise PyUnbornObjectError(self.attrStr) # % self._name )
11349
11350 def __nonzero__(self):
11351 return 0
11352
11353
11354#----------------------------------------------------------------------------
d55e5bfc
RD		 11355
11356def CallAfter(callable, *args, **kw):
11357 """
11358 Call the specified function after the current and pending event
11359 handlers have been completed. This is also good for making GUI
0439c23b
RD		 11360 method calls from non-GUI threads. Any extra positional or
11361 keyword args are passed on to the callable when it is called.
11362
11363 :see: `wx.FutureCall`
d55e5bfc
RD		 11364 """
11365 app = wx.GetApp()
a001823c 11366 assert app is not None, 'No wx.App created yet'
d55e5bfc 11367
891bb194
RD		 11368 if not hasattr(app, "_CallAfterId"):
11369 app._CallAfterId = wx.NewEventType()
11370 app.Connect(-1, -1, app._CallAfterId,
11371 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 11372 evt = wx.PyEvent()
891bb194 11373 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD		 11374 evt.callable = callable
11375 evt.args = args
11376 evt.kw = kw
11377 wx.PostEvent(app, evt)
11378
d55e5bfc
RD		 11379#----------------------------------------------------------------------------
11380
11381
11382class FutureCall:
11383 """
8ac8dba0 11384 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD		 11385 object once after the given amount of milliseconds, passing any
11386 positional or keyword args. The return value of the callable is
0439c23b 11387 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD		 11388
11389 If you don't need to get the return value or restart the timer
11390 then there is no need to hold a reference to this object. It will
11391 hold a reference to itself while the timer is running (the timer
11392 has a reference to self.Notify) but the cycle will be broken when
11393 the timer completes, automatically cleaning up the wx.FutureCall
11394 object.
0439c23b
RD		 11395
11396 :see: `wx.CallAfter`
d55e5bfc
RD		 11397 """
11398 def __init__(self, millis, callable, *args, **kwargs):
11399 self.millis = millis
11400 self.callable = callable
11401 self.SetArgs(*args, **kwargs)
11402 self.runCount = 0
11403 self.running = False
11404 self.hasRun = False
11405 self.result = None
11406 self.timer = None
11407 self.Start()
11408
11409 def __del__(self):
11410 self.Stop()
11411
11412
11413 def Start(self, millis=None, *args, **kwargs):
11414 """
11415 (Re)start the timer
11416 """
11417 self.hasRun = False
11418 if millis is not None:
11419 self.millis = millis
11420 if args or kwargs:
11421 self.SetArgs(*args, **kwargs)
11422 self.Stop()
11423 self.timer = wx.PyTimer(self.Notify)
11424 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
11425 self.running = True
11426 Restart = Start
11427
11428
11429 def Stop(self):
11430 """
11431 Stop and destroy the timer.
11432 """
11433 if self.timer is not None:
11434 self.timer.Stop()
11435 self.timer = None
11436
11437
11438 def GetInterval(self):
11439 if self.timer is not None:
11440 return self.timer.GetInterval()
11441 else:
11442 return 0
11443
11444
11445 def IsRunning(self):
11446 return self.timer is not None and self.timer.IsRunning()
11447
11448
11449 def SetArgs(self, *args, **kwargs):
11450 """
11451 (Re)set the args passed to the callable object. This is
11452 useful in conjunction with Restart if you want to schedule a
11453 new call to the same callable object but with different
11454 parameters.
11455 """
11456 self.args = args
11457 self.kwargs = kwargs
11458
11459
11460 def HasRun(self):
11461 return self.hasRun
11462
11463 def GetResult(self):
11464 return self.result
11465
11466 def Notify(self):
11467 """
11468 The timer has expired so call the callable.
11469 """
11470 if self.callable and getattr(self.callable, 'im_self', True):
11471 self.runCount += 1
11472 self.running = False
11473 self.result = self.callable(*self.args, **self.kwargs)
11474 self.hasRun = True
11475 if not self.running:
11476 # if it wasn't restarted, then cleanup
11477 wx.CallAfter(self.Stop)
11478
11479
11480
11481#----------------------------------------------------------------------------
11482# Control which items in this module should be documented by epydoc.
11483# We allow only classes and functions, which will help reduce the size
11484# of the docs by filtering out the zillions of constants, EVT objects,
11485# and etc that don't make much sense by themselves, but are instead
11486# documented (or will be) as part of the classes/functions/methods
11487# where they should be used.
11488
c24da6d6
RD		 11489class __DocFilter:
11490 """
11491 A filter for epydoc that only allows non-Ptr classes and
11492 fucntions, in order to reduce the clutter in the API docs.
11493 """
11494 def __init__(self, globals):
11495 self._globals = globals
11496
11497 def __call__(self, name):
11498 import types
11499 obj = self._globals.get(name, None)
11500 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11501 return False
11502 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11503 return False
11504 return True
d55e5bfc
RD		 11505
11506#----------------------------------------------------------------------------
11507#----------------------------------------------------------------------------
11508
11509# Import other modules in this package that should show up in the
11510# "core" wx namespace
11511from _gdi import *
11512from _windows import *
11513from _controls import *
11514from _misc import *
11515
11516
11517# Fixup the stock objects since they can't be used yet. (They will be
11518# restored in wx.PyApp.OnInit.)
11519_core_._wxPyFixStockObjects()
11520
11521#----------------------------------------------------------------------------
11522#----------------------------------------------------------------------------
11523
11524
wxWidgets (Impactor)