]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
Add flags parameter to wx.Process.Kill and wx.Kill
[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
6#// Give a reference to the dictionary of this module to the C++ extension
7#// code.
8_core_._wxPySetDictionary(vars())
9
10#// A little trick to make 'wx' be a reference to this module so wx.Names can
11#// be used here.
12import sys as _sys
13wx = _sys.modules[__name__]
14
c24da6d6
RD
15
16#----------------------------------------------------------------------------
17
18def _deprecated(callable, msg=None):
19 """
20 Create a wrapper function that will raise a DeprecationWarning
21 before calling the callable.
22 """
23 if msg is None:
24 msg = "%s is deprecated" % callable
25 def deprecatedWrapper(*args, **kwargs):
26 import warnings
27 warnings.warn(msg, DeprecationWarning, stacklevel=2)
28 return callable(*args, **kwargs)
29 deprecatedWrapper.__doc__ = msg
30 return deprecatedWrapper
31
32
33#----------------------------------------------------------------------------
34
d55e5bfc
RD
35NOT_FOUND = _core_.NOT_FOUND
36VSCROLL = _core_.VSCROLL
37HSCROLL = _core_.HSCROLL
38CAPTION = _core_.CAPTION
39DOUBLE_BORDER = _core_.DOUBLE_BORDER
40SUNKEN_BORDER = _core_.SUNKEN_BORDER
41RAISED_BORDER = _core_.RAISED_BORDER
42BORDER = _core_.BORDER
43SIMPLE_BORDER = _core_.SIMPLE_BORDER
44STATIC_BORDER = _core_.STATIC_BORDER
45TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
46NO_BORDER = _core_.NO_BORDER
47TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
48WANTS_CHARS = _core_.WANTS_CHARS
49POPUP_WINDOW = _core_.POPUP_WINDOW
50CENTER_FRAME = _core_.CENTER_FRAME
51CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
52CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
53ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
54ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
55ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
56ED_STATIC_LINE = _core_.ED_STATIC_LINE
57EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
58CLIP_CHILDREN = _core_.CLIP_CHILDREN
59CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
60ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
61RETAINED = _core_.RETAINED
62BACKINGSTORE = _core_.BACKINGSTORE
63COLOURED = _core_.COLOURED
64FIXED_LENGTH = _core_.FIXED_LENGTH
65LB_NEEDED_SB = _core_.LB_NEEDED_SB
66LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
67LB_SORT = _core_.LB_SORT
68LB_SINGLE = _core_.LB_SINGLE
69LB_MULTIPLE = _core_.LB_MULTIPLE
70LB_EXTENDED = _core_.LB_EXTENDED
71LB_OWNERDRAW = _core_.LB_OWNERDRAW
72LB_HSCROLL = _core_.LB_HSCROLL
73PROCESS_ENTER = _core_.PROCESS_ENTER
74PASSWORD = _core_.PASSWORD
75CB_SIMPLE = _core_.CB_SIMPLE
76CB_DROPDOWN = _core_.CB_DROPDOWN
77CB_SORT = _core_.CB_SORT
78CB_READONLY = _core_.CB_READONLY
79RA_HORIZONTAL = _core_.RA_HORIZONTAL
80RA_VERTICAL = _core_.RA_VERTICAL
81RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
82RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
83RB_GROUP = _core_.RB_GROUP
84RB_SINGLE = _core_.RB_SINGLE
85SL_HORIZONTAL = _core_.SL_HORIZONTAL
86SL_VERTICAL = _core_.SL_VERTICAL
87SL_AUTOTICKS = _core_.SL_AUTOTICKS
88SL_LABELS = _core_.SL_LABELS
89SL_LEFT = _core_.SL_LEFT
90SL_TOP = _core_.SL_TOP
91SL_RIGHT = _core_.SL_RIGHT
92SL_BOTTOM = _core_.SL_BOTTOM
93SL_BOTH = _core_.SL_BOTH
94SL_SELRANGE = _core_.SL_SELRANGE
95SB_HORIZONTAL = _core_.SB_HORIZONTAL
96SB_VERTICAL = _core_.SB_VERTICAL
97ST_SIZEGRIP = _core_.ST_SIZEGRIP
98ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
99FLOOD_SURFACE = _core_.FLOOD_SURFACE
100FLOOD_BORDER = _core_.FLOOD_BORDER
101ODDEVEN_RULE = _core_.ODDEVEN_RULE
102WINDING_RULE = _core_.WINDING_RULE
103TOOL_TOP = _core_.TOOL_TOP
104TOOL_BOTTOM = _core_.TOOL_BOTTOM
105TOOL_LEFT = _core_.TOOL_LEFT
106TOOL_RIGHT = _core_.TOOL_RIGHT
107OK = _core_.OK
108YES_NO = _core_.YES_NO
109CANCEL = _core_.CANCEL
110YES = _core_.YES
111NO = _core_.NO
112NO_DEFAULT = _core_.NO_DEFAULT
113YES_DEFAULT = _core_.YES_DEFAULT
114ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
115ICON_HAND = _core_.ICON_HAND
116ICON_QUESTION = _core_.ICON_QUESTION
117ICON_INFORMATION = _core_.ICON_INFORMATION
118ICON_STOP = _core_.ICON_STOP
119ICON_ASTERISK = _core_.ICON_ASTERISK
120ICON_MASK = _core_.ICON_MASK
121ICON_WARNING = _core_.ICON_WARNING
122ICON_ERROR = _core_.ICON_ERROR
123FORWARD = _core_.FORWARD
124BACKWARD = _core_.BACKWARD
125RESET = _core_.RESET
126HELP = _core_.HELP
127MORE = _core_.MORE
128SETUP = _core_.SETUP
129SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
130SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
131SIZE_AUTO = _core_.SIZE_AUTO
132SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
133SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
134PORTRAIT = _core_.PORTRAIT
135LANDSCAPE = _core_.LANDSCAPE
136PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
137PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
138PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
139PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
140ID_ANY = _core_.ID_ANY
141ID_SEPARATOR = _core_.ID_SEPARATOR
142ID_LOWEST = _core_.ID_LOWEST
143ID_OPEN = _core_.ID_OPEN
144ID_CLOSE = _core_.ID_CLOSE
145ID_NEW = _core_.ID_NEW
146ID_SAVE = _core_.ID_SAVE
147ID_SAVEAS = _core_.ID_SAVEAS
148ID_REVERT = _core_.ID_REVERT
149ID_EXIT = _core_.ID_EXIT
150ID_UNDO = _core_.ID_UNDO
151ID_REDO = _core_.ID_REDO
152ID_HELP = _core_.ID_HELP
153ID_PRINT = _core_.ID_PRINT
154ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
155ID_PREVIEW = _core_.ID_PREVIEW
156ID_ABOUT = _core_.ID_ABOUT
157ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
158ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
159ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
160ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
161ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
162ID_PREFERENCES = _core_.ID_PREFERENCES
163ID_CUT = _core_.ID_CUT
164ID_COPY = _core_.ID_COPY
165ID_PASTE = _core_.ID_PASTE
166ID_CLEAR = _core_.ID_CLEAR
167ID_FIND = _core_.ID_FIND
168ID_DUPLICATE = _core_.ID_DUPLICATE
169ID_SELECTALL = _core_.ID_SELECTALL
170ID_DELETE = _core_.ID_DELETE
171ID_REPLACE = _core_.ID_REPLACE
172ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
173ID_PROPERTIES = _core_.ID_PROPERTIES
174ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
175ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
176ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
177ID_VIEW_LIST = _core_.ID_VIEW_LIST
178ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
179ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
180ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
181ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
182ID_FILE1 = _core_.ID_FILE1
183ID_FILE2 = _core_.ID_FILE2
184ID_FILE3 = _core_.ID_FILE3
185ID_FILE4 = _core_.ID_FILE4
186ID_FILE5 = _core_.ID_FILE5
187ID_FILE6 = _core_.ID_FILE6
188ID_FILE7 = _core_.ID_FILE7
189ID_FILE8 = _core_.ID_FILE8
190ID_FILE9 = _core_.ID_FILE9
191ID_OK = _core_.ID_OK
192ID_CANCEL = _core_.ID_CANCEL
193ID_APPLY = _core_.ID_APPLY
194ID_YES = _core_.ID_YES
195ID_NO = _core_.ID_NO
196ID_STATIC = _core_.ID_STATIC
197ID_FORWARD = _core_.ID_FORWARD
198ID_BACKWARD = _core_.ID_BACKWARD
199ID_DEFAULT = _core_.ID_DEFAULT
200ID_MORE = _core_.ID_MORE
201ID_SETUP = _core_.ID_SETUP
202ID_RESET = _core_.ID_RESET
203ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
204ID_YESTOALL = _core_.ID_YESTOALL
205ID_NOTOALL = _core_.ID_NOTOALL
206ID_ABORT = _core_.ID_ABORT
207ID_RETRY = _core_.ID_RETRY
208ID_IGNORE = _core_.ID_IGNORE
0f63ec68
RD
209ID_ADD = _core_.ID_ADD
210ID_REMOVE = _core_.ID_REMOVE
211ID_UP = _core_.ID_UP
212ID_DOWN = _core_.ID_DOWN
213ID_HOME = _core_.ID_HOME
214ID_REFRESH = _core_.ID_REFRESH
215ID_STOP = _core_.ID_STOP
216ID_INDEX = _core_.ID_INDEX
217ID_BOLD = _core_.ID_BOLD
218ID_ITALIC = _core_.ID_ITALIC
219ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
220ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
221ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
222ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
223ID_UNDERLINE = _core_.ID_UNDERLINE
224ID_INDENT = _core_.ID_INDENT
225ID_UNINDENT = _core_.ID_UNINDENT
226ID_ZOOM_100 = _core_.ID_ZOOM_100
227ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
228ID_ZOOM_IN = _core_.ID_ZOOM_IN
229ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
230ID_UNDELETE = _core_.ID_UNDELETE
231ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
d55e5bfc
RD
232ID_HIGHEST = _core_.ID_HIGHEST
233OPEN = _core_.OPEN
234SAVE = _core_.SAVE
235HIDE_READONLY = _core_.HIDE_READONLY
236OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
237FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
238MULTIPLE = _core_.MULTIPLE
239CHANGE_DIR = _core_.CHANGE_DIR
240ACCEL_ALT = _core_.ACCEL_ALT
241ACCEL_CTRL = _core_.ACCEL_CTRL
242ACCEL_SHIFT = _core_.ACCEL_SHIFT
243ACCEL_NORMAL = _core_.ACCEL_NORMAL
244PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
245PD_APP_MODAL = _core_.PD_APP_MODAL
246PD_CAN_ABORT = _core_.PD_CAN_ABORT
247PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
248PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
249PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
250DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
251DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
252MENU_TEAROFF = _core_.MENU_TEAROFF
253MB_DOCKABLE = _core_.MB_DOCKABLE
254NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
255FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
256LI_HORIZONTAL = _core_.LI_HORIZONTAL
257LI_VERTICAL = _core_.LI_VERTICAL
258WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
259WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
260WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
261WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
262WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
263WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
264MM_TEXT = _core_.MM_TEXT
265MM_LOMETRIC = _core_.MM_LOMETRIC
266MM_HIMETRIC = _core_.MM_HIMETRIC
267MM_LOENGLISH = _core_.MM_LOENGLISH
268MM_HIENGLISH = _core_.MM_HIENGLISH
269MM_TWIPS = _core_.MM_TWIPS
270MM_ISOTROPIC = _core_.MM_ISOTROPIC
271MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
272MM_POINTS = _core_.MM_POINTS
273MM_METRIC = _core_.MM_METRIC
274CENTRE = _core_.CENTRE
275CENTER = _core_.CENTER
276HORIZONTAL = _core_.HORIZONTAL
277VERTICAL = _core_.VERTICAL
278BOTH = _core_.BOTH
279LEFT = _core_.LEFT
280RIGHT = _core_.RIGHT
281UP = _core_.UP
282DOWN = _core_.DOWN
283TOP = _core_.TOP
284BOTTOM = _core_.BOTTOM
285NORTH = _core_.NORTH
286SOUTH = _core_.SOUTH
287WEST = _core_.WEST
288EAST = _core_.EAST
289ALL = _core_.ALL
290ALIGN_NOT = _core_.ALIGN_NOT
291ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
292ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
293ALIGN_LEFT = _core_.ALIGN_LEFT
294ALIGN_TOP = _core_.ALIGN_TOP
295ALIGN_RIGHT = _core_.ALIGN_RIGHT
296ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
297ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
298ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
299ALIGN_CENTER = _core_.ALIGN_CENTER
300ALIGN_CENTRE = _core_.ALIGN_CENTRE
301ALIGN_MASK = _core_.ALIGN_MASK
302STRETCH_NOT = _core_.STRETCH_NOT
303SHRINK = _core_.SHRINK
304GROW = _core_.GROW
305EXPAND = _core_.EXPAND
306SHAPED = _core_.SHAPED
307FIXED_MINSIZE = _core_.FIXED_MINSIZE
308TILE = _core_.TILE
309ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
310BORDER_DEFAULT = _core_.BORDER_DEFAULT
311BORDER_NONE = _core_.BORDER_NONE
312BORDER_STATIC = _core_.BORDER_STATIC
313BORDER_SIMPLE = _core_.BORDER_SIMPLE
314BORDER_RAISED = _core_.BORDER_RAISED
315BORDER_SUNKEN = _core_.BORDER_SUNKEN
316BORDER_DOUBLE = _core_.BORDER_DOUBLE
317BORDER_MASK = _core_.BORDER_MASK
0f63ec68
RD
318BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
319BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
320BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD
321DEFAULT = _core_.DEFAULT
322DECORATIVE = _core_.DECORATIVE
323ROMAN = _core_.ROMAN
324SCRIPT = _core_.SCRIPT
325SWISS = _core_.SWISS
326MODERN = _core_.MODERN
327TELETYPE = _core_.TELETYPE
328VARIABLE = _core_.VARIABLE
329FIXED = _core_.FIXED
330NORMAL = _core_.NORMAL
331LIGHT = _core_.LIGHT
332BOLD = _core_.BOLD
333ITALIC = _core_.ITALIC
334SLANT = _core_.SLANT
335SOLID = _core_.SOLID
336DOT = _core_.DOT
337LONG_DASH = _core_.LONG_DASH
338SHORT_DASH = _core_.SHORT_DASH
339DOT_DASH = _core_.DOT_DASH
340USER_DASH = _core_.USER_DASH
341TRANSPARENT = _core_.TRANSPARENT
342STIPPLE = _core_.STIPPLE
343BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
344CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
345FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
346CROSS_HATCH = _core_.CROSS_HATCH
347HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
348VERTICAL_HATCH = _core_.VERTICAL_HATCH
349JOIN_BEVEL = _core_.JOIN_BEVEL
350JOIN_MITER = _core_.JOIN_MITER
351JOIN_ROUND = _core_.JOIN_ROUND
352CAP_ROUND = _core_.CAP_ROUND
353CAP_PROJECTING = _core_.CAP_PROJECTING
354CAP_BUTT = _core_.CAP_BUTT
355CLEAR = _core_.CLEAR
356XOR = _core_.XOR
357INVERT = _core_.INVERT
358OR_REVERSE = _core_.OR_REVERSE
359AND_REVERSE = _core_.AND_REVERSE
360COPY = _core_.COPY
361AND = _core_.AND
362AND_INVERT = _core_.AND_INVERT
363NO_OP = _core_.NO_OP
364NOR = _core_.NOR
365EQUIV = _core_.EQUIV
366SRC_INVERT = _core_.SRC_INVERT
367OR_INVERT = _core_.OR_INVERT
368NAND = _core_.NAND
369OR = _core_.OR
370SET = _core_.SET
371WXK_BACK = _core_.WXK_BACK
372WXK_TAB = _core_.WXK_TAB
373WXK_RETURN = _core_.WXK_RETURN
374WXK_ESCAPE = _core_.WXK_ESCAPE
375WXK_SPACE = _core_.WXK_SPACE
376WXK_DELETE = _core_.WXK_DELETE
377WXK_START = _core_.WXK_START
378WXK_LBUTTON = _core_.WXK_LBUTTON
379WXK_RBUTTON = _core_.WXK_RBUTTON
380WXK_CANCEL = _core_.WXK_CANCEL
381WXK_MBUTTON = _core_.WXK_MBUTTON
382WXK_CLEAR = _core_.WXK_CLEAR
383WXK_SHIFT = _core_.WXK_SHIFT
384WXK_ALT = _core_.WXK_ALT
385WXK_CONTROL = _core_.WXK_CONTROL
386WXK_MENU = _core_.WXK_MENU
387WXK_PAUSE = _core_.WXK_PAUSE
388WXK_CAPITAL = _core_.WXK_CAPITAL
389WXK_PRIOR = _core_.WXK_PRIOR
390WXK_NEXT = _core_.WXK_NEXT
391WXK_END = _core_.WXK_END
392WXK_HOME = _core_.WXK_HOME
393WXK_LEFT = _core_.WXK_LEFT
394WXK_UP = _core_.WXK_UP
395WXK_RIGHT = _core_.WXK_RIGHT
396WXK_DOWN = _core_.WXK_DOWN
397WXK_SELECT = _core_.WXK_SELECT
398WXK_PRINT = _core_.WXK_PRINT
399WXK_EXECUTE = _core_.WXK_EXECUTE
400WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
401WXK_INSERT = _core_.WXK_INSERT
402WXK_HELP = _core_.WXK_HELP
403WXK_NUMPAD0 = _core_.WXK_NUMPAD0
404WXK_NUMPAD1 = _core_.WXK_NUMPAD1
405WXK_NUMPAD2 = _core_.WXK_NUMPAD2
406WXK_NUMPAD3 = _core_.WXK_NUMPAD3
407WXK_NUMPAD4 = _core_.WXK_NUMPAD4
408WXK_NUMPAD5 = _core_.WXK_NUMPAD5
409WXK_NUMPAD6 = _core_.WXK_NUMPAD6
410WXK_NUMPAD7 = _core_.WXK_NUMPAD7
411WXK_NUMPAD8 = _core_.WXK_NUMPAD8
412WXK_NUMPAD9 = _core_.WXK_NUMPAD9
413WXK_MULTIPLY = _core_.WXK_MULTIPLY
414WXK_ADD = _core_.WXK_ADD
415WXK_SEPARATOR = _core_.WXK_SEPARATOR
416WXK_SUBTRACT = _core_.WXK_SUBTRACT
417WXK_DECIMAL = _core_.WXK_DECIMAL
418WXK_DIVIDE = _core_.WXK_DIVIDE
419WXK_F1 = _core_.WXK_F1
420WXK_F2 = _core_.WXK_F2
421WXK_F3 = _core_.WXK_F3
422WXK_F4 = _core_.WXK_F4
423WXK_F5 = _core_.WXK_F5
424WXK_F6 = _core_.WXK_F6
425WXK_F7 = _core_.WXK_F7
426WXK_F8 = _core_.WXK_F8
427WXK_F9 = _core_.WXK_F9
428WXK_F10 = _core_.WXK_F10
429WXK_F11 = _core_.WXK_F11
430WXK_F12 = _core_.WXK_F12
431WXK_F13 = _core_.WXK_F13
432WXK_F14 = _core_.WXK_F14
433WXK_F15 = _core_.WXK_F15
434WXK_F16 = _core_.WXK_F16
435WXK_F17 = _core_.WXK_F17
436WXK_F18 = _core_.WXK_F18
437WXK_F19 = _core_.WXK_F19
438WXK_F20 = _core_.WXK_F20
439WXK_F21 = _core_.WXK_F21
440WXK_F22 = _core_.WXK_F22
441WXK_F23 = _core_.WXK_F23
442WXK_F24 = _core_.WXK_F24
443WXK_NUMLOCK = _core_.WXK_NUMLOCK
444WXK_SCROLL = _core_.WXK_SCROLL
445WXK_PAGEUP = _core_.WXK_PAGEUP
446WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
447WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
448WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
449WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
450WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
451WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
452WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
453WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
454WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
455WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
456WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
457WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
458WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
459WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
460WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
461WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
462WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
463WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
464WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
465WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
466WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
467WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
468WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
469WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
470WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
471WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
472WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
473WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
474WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
475WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
476WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
477PAPER_NONE = _core_.PAPER_NONE
478PAPER_LETTER = _core_.PAPER_LETTER
479PAPER_LEGAL = _core_.PAPER_LEGAL
480PAPER_A4 = _core_.PAPER_A4
481PAPER_CSHEET = _core_.PAPER_CSHEET
482PAPER_DSHEET = _core_.PAPER_DSHEET
483PAPER_ESHEET = _core_.PAPER_ESHEET
484PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
485PAPER_TABLOID = _core_.PAPER_TABLOID
486PAPER_LEDGER = _core_.PAPER_LEDGER
487PAPER_STATEMENT = _core_.PAPER_STATEMENT
488PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
489PAPER_A3 = _core_.PAPER_A3
490PAPER_A4SMALL = _core_.PAPER_A4SMALL
491PAPER_A5 = _core_.PAPER_A5
492PAPER_B4 = _core_.PAPER_B4
493PAPER_B5 = _core_.PAPER_B5
494PAPER_FOLIO = _core_.PAPER_FOLIO
495PAPER_QUARTO = _core_.PAPER_QUARTO
496PAPER_10X14 = _core_.PAPER_10X14
497PAPER_11X17 = _core_.PAPER_11X17
498PAPER_NOTE = _core_.PAPER_NOTE
499PAPER_ENV_9 = _core_.PAPER_ENV_9
500PAPER_ENV_10 = _core_.PAPER_ENV_10
501PAPER_ENV_11 = _core_.PAPER_ENV_11
502PAPER_ENV_12 = _core_.PAPER_ENV_12
503PAPER_ENV_14 = _core_.PAPER_ENV_14
504PAPER_ENV_DL = _core_.PAPER_ENV_DL
505PAPER_ENV_C5 = _core_.PAPER_ENV_C5
506PAPER_ENV_C3 = _core_.PAPER_ENV_C3
507PAPER_ENV_C4 = _core_.PAPER_ENV_C4
508PAPER_ENV_C6 = _core_.PAPER_ENV_C6
509PAPER_ENV_C65 = _core_.PAPER_ENV_C65
510PAPER_ENV_B4 = _core_.PAPER_ENV_B4
511PAPER_ENV_B5 = _core_.PAPER_ENV_B5
512PAPER_ENV_B6 = _core_.PAPER_ENV_B6
513PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
514PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
515PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
516PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
517PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
518PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
519PAPER_ISO_B4 = _core_.PAPER_ISO_B4
520PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
521PAPER_9X11 = _core_.PAPER_9X11
522PAPER_10X11 = _core_.PAPER_10X11
523PAPER_15X11 = _core_.PAPER_15X11
524PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
525PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
526PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
527PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
528PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
529PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
530PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
531PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
532PAPER_A_PLUS = _core_.PAPER_A_PLUS
533PAPER_B_PLUS = _core_.PAPER_B_PLUS
534PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
535PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
536PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
537PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
538PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
539PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
540PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
541PAPER_A2 = _core_.PAPER_A2
542PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
543PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
544DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
545DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
546DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
547ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
548ITEM_NORMAL = _core_.ITEM_NORMAL
549ITEM_CHECK = _core_.ITEM_CHECK
550ITEM_RADIO = _core_.ITEM_RADIO
551ITEM_MAX = _core_.ITEM_MAX
552HT_NOWHERE = _core_.HT_NOWHERE
553HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
554HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
555HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
556HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
557HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
558HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
559HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
560HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
561HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
562HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
563HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
564HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
565HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
566HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
567HT_MAX = _core_.HT_MAX
568MOD_NONE = _core_.MOD_NONE
569MOD_ALT = _core_.MOD_ALT
570MOD_CONTROL = _core_.MOD_CONTROL
571MOD_SHIFT = _core_.MOD_SHIFT
572MOD_WIN = _core_.MOD_WIN
573UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
574UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
575UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
576#---------------------------------------------------------------------------
577
578class Object(object):
579 """
580 The base class for most wx objects, although in wxPython not
581 much functionality is needed nor exposed.
582 """
583 def __init__(self): raise RuntimeError, "No constructor defined"
584 def __repr__(self):
585 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
586 def GetClassName(*args, **kwargs):
587 """
588 GetClassName(self) -> String
589
590 Returns the class name of the C++ class using wxRTTI.
591 """
592 return _core_.Object_GetClassName(*args, **kwargs)
593
594 def Destroy(*args, **kwargs):
595 """
596 Destroy(self)
597
598 Deletes the C++ object this Python object is a proxy for.
599 """
600 return _core_.Object_Destroy(*args, **kwargs)
601
602
603class ObjectPtr(Object):
604 def __init__(self, this):
605 self.this = this
606 if not hasattr(self,"thisown"): self.thisown = 0
607 self.__class__ = Object
608_core_.Object_swigregister(ObjectPtr)
609_wxPySetDictionary = _core_._wxPySetDictionary
610
611_wxPyFixStockObjects = _core_._wxPyFixStockObjects
612
613cvar = _core_.cvar
614EmptyString = cvar.EmptyString
615
616#---------------------------------------------------------------------------
617
618BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
619BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
620BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
621BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
622BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
623BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
624BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
625BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
626BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
627BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
628BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
629BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
630BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
631BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
632BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
633BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
634BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
635BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
636BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
637BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
638CURSOR_NONE = _core_.CURSOR_NONE
639CURSOR_ARROW = _core_.CURSOR_ARROW
640CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
641CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
642CURSOR_CHAR = _core_.CURSOR_CHAR
643CURSOR_CROSS = _core_.CURSOR_CROSS
644CURSOR_HAND = _core_.CURSOR_HAND
645CURSOR_IBEAM = _core_.CURSOR_IBEAM
646CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
647CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
648CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
649CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
650CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
651CURSOR_PENCIL = _core_.CURSOR_PENCIL
652CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
653CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
654CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
655CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
656CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
657CURSOR_SIZENS = _core_.CURSOR_SIZENS
658CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
659CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
660CURSOR_SIZING = _core_.CURSOR_SIZING
661CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
662CURSOR_WAIT = _core_.CURSOR_WAIT
663CURSOR_WATCH = _core_.CURSOR_WATCH
664CURSOR_BLANK = _core_.CURSOR_BLANK
665CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
666CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
667CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
668CURSOR_MAX = _core_.CURSOR_MAX
669#---------------------------------------------------------------------------
670
671class Size(object):
672 """
79fccf9d
RD
673 wx.Size is a useful data structure used to represent the size of
674 something. It simply contians integer width and height proprtites.
675 In most places in wxPython where a wx.Size is expected a
676 (width,height) tuple can be used instead.
d55e5bfc
RD
677 """
678 def __repr__(self):
679 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
680 width = property(_core_.Size_width_get, _core_.Size_width_set)
681 height = property(_core_.Size_height_get, _core_.Size_height_set)
682 x = width; y = height
683 def __init__(self, *args, **kwargs):
684 """
685 __init__(self, int w=0, int h=0) -> Size
686
687 Creates a size object.
688 """
689 newobj = _core_.new_Size(*args, **kwargs)
690 self.this = newobj.this
691 self.thisown = 1
692 del newobj.thisown
693 def __del__(self, destroy=_core_.delete_Size):
694 """__del__(self)"""
695 try:
696 if self.thisown: destroy(self)
697 except: pass
698
699 def __eq__(*args, **kwargs):
700 """
701 __eq__(self, Size sz) -> bool
702
703 Test for equality of wx.Size objects.
704 """
705 return _core_.Size___eq__(*args, **kwargs)
706
707 def __ne__(*args, **kwargs):
708 """
709 __ne__(self, Size sz) -> bool
710
711 Test for inequality.
712 """
713 return _core_.Size___ne__(*args, **kwargs)
714
715 def __add__(*args, **kwargs):
716 """
717 __add__(self, Size sz) -> Size
718
719 Add sz's proprties to this and return the result.
720 """
721 return _core_.Size___add__(*args, **kwargs)
722
723 def __sub__(*args, **kwargs):
724 """
725 __sub__(self, Size sz) -> Size
726
727 Subtract sz's properties from this and return the result.
728 """
729 return _core_.Size___sub__(*args, **kwargs)
730
731 def IncTo(*args, **kwargs):
732 """
733 IncTo(self, Size sz)
734
735 Increments this object so that both of its dimensions are not less
736 than the corresponding dimensions of the size.
737 """
738 return _core_.Size_IncTo(*args, **kwargs)
739
740 def DecTo(*args, **kwargs):
741 """
742 DecTo(self, Size sz)
743
744 Decrements this object so that both of its dimensions are not greater
745 than the corresponding dimensions of the size.
746 """
747 return _core_.Size_DecTo(*args, **kwargs)
748
749 def Set(*args, **kwargs):
750 """
751 Set(self, int w, int h)
752
753 Set both width and height.
754 """
755 return _core_.Size_Set(*args, **kwargs)
756
757 def SetWidth(*args, **kwargs):
758 """SetWidth(self, int w)"""
759 return _core_.Size_SetWidth(*args, **kwargs)
760
761 def SetHeight(*args, **kwargs):
762 """SetHeight(self, int h)"""
763 return _core_.Size_SetHeight(*args, **kwargs)
764
765 def GetWidth(*args, **kwargs):
766 """GetWidth(self) -> int"""
767 return _core_.Size_GetWidth(*args, **kwargs)
768
769 def GetHeight(*args, **kwargs):
770 """GetHeight(self) -> int"""
771 return _core_.Size_GetHeight(*args, **kwargs)
772
773 def IsFullySpecified(*args, **kwargs):
774 """
775 IsFullySpecified(self) -> bool
776
777 Returns True if both components of the size are non-default values.
778 """
779 return _core_.Size_IsFullySpecified(*args, **kwargs)
780
781 def SetDefaults(*args, **kwargs):
782 """
783 SetDefaults(self, Size size)
784
79fccf9d
RD
785 Combine this size with the other one replacing the default components
786 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD
787 """
788 return _core_.Size_SetDefaults(*args, **kwargs)
789
790 def Get(*args, **kwargs):
791 """
792 Get() -> (width,height)
793
794 Returns the width and height properties as a tuple.
795 """
796 return _core_.Size_Get(*args, **kwargs)
797
79fccf9d 798 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
799 def __str__(self): return str(self.Get())
800 def __repr__(self): return 'wx.Size'+str(self.Get())
801 def __len__(self): return len(self.Get())
802 def __getitem__(self, index): return self.Get()[index]
803 def __setitem__(self, index, val):
804 if index == 0: self.width = val
805 elif index == 1: self.height = val
806 else: raise IndexError
807 def __nonzero__(self): return self.Get() != (0,0)
808 __safe_for_unpickling__ = True
809 def __reduce__(self): return (wx.Size, self.Get())
810
811
812class SizePtr(Size):
813 def __init__(self, this):
814 self.this = this
815 if not hasattr(self,"thisown"): self.thisown = 0
816 self.__class__ = Size
817_core_.Size_swigregister(SizePtr)
818
819#---------------------------------------------------------------------------
820
821class RealPoint(object):
822 """
79fccf9d
RD
823 A data structure for representing a point or position with floating
824 point x and y properties. In wxPython most places that expect a
825 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc
RD
826 """
827 def __repr__(self):
828 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
829 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
830 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
831 def __init__(self, *args, **kwargs):
832 """
833 __init__(self, double x=0.0, double y=0.0) -> RealPoint
834
835 Create a wx.RealPoint object
836 """
837 newobj = _core_.new_RealPoint(*args, **kwargs)
838 self.this = newobj.this
839 self.thisown = 1
840 del newobj.thisown
841 def __del__(self, destroy=_core_.delete_RealPoint):
842 """__del__(self)"""
843 try:
844 if self.thisown: destroy(self)
845 except: pass
846
847 def __eq__(*args, **kwargs):
848 """
849 __eq__(self, RealPoint pt) -> bool
850
851 Test for equality of wx.RealPoint objects.
852 """
853 return _core_.RealPoint___eq__(*args, **kwargs)
854
855 def __ne__(*args, **kwargs):
856 """
857 __ne__(self, RealPoint pt) -> bool
858
859 Test for inequality of wx.RealPoint objects.
860 """
861 return _core_.RealPoint___ne__(*args, **kwargs)
862
863 def __add__(*args, **kwargs):
864 """
865 __add__(self, RealPoint pt) -> RealPoint
866
867 Add pt's proprties to this and return the result.
868 """
869 return _core_.RealPoint___add__(*args, **kwargs)
870
871 def __sub__(*args, **kwargs):
872 """
873 __sub__(self, RealPoint pt) -> RealPoint
874
875 Subtract pt's proprties from this and return the result
876 """
877 return _core_.RealPoint___sub__(*args, **kwargs)
878
879 def Set(*args, **kwargs):
880 """
881 Set(self, double x, double y)
882
883 Set both the x and y properties
884 """
885 return _core_.RealPoint_Set(*args, **kwargs)
886
887 def Get(*args, **kwargs):
888 """
889 Get() -> (x,y)
890
891 Return the x and y properties as a tuple.
892 """
893 return _core_.RealPoint_Get(*args, **kwargs)
894
79fccf9d 895 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
896 def __str__(self): return str(self.Get())
897 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
898 def __len__(self): return len(self.Get())
899 def __getitem__(self, index): return self.Get()[index]
900 def __setitem__(self, index, val):
901 if index == 0: self.x = val
902 elif index == 1: self.y = val
903 else: raise IndexError
904 def __nonzero__(self): return self.Get() != (0.0, 0.0)
905 __safe_for_unpickling__ = True
906 def __reduce__(self): return (wx.RealPoint, self.Get())
907
908
909class RealPointPtr(RealPoint):
910 def __init__(self, this):
911 self.this = this
912 if not hasattr(self,"thisown"): self.thisown = 0
913 self.__class__ = RealPoint
914_core_.RealPoint_swigregister(RealPointPtr)
915
916#---------------------------------------------------------------------------
917
918class Point(object):
919 """
79fccf9d
RD
920 A data structure for representing a point or position with integer x
921 and y properties. Most places in wxPython that expect a wx.Point can
922 also accept a (x,y) tuple.
d55e5bfc
RD
923 """
924 def __repr__(self):
925 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
926 x = property(_core_.Point_x_get, _core_.Point_x_set)
927 y = property(_core_.Point_y_get, _core_.Point_y_set)
928 def __init__(self, *args, **kwargs):
929 """
930 __init__(self, int x=0, int y=0) -> Point
931
932 Create a wx.Point object
933 """
934 newobj = _core_.new_Point(*args, **kwargs)
935 self.this = newobj.this
936 self.thisown = 1
937 del newobj.thisown
938 def __del__(self, destroy=_core_.delete_Point):
939 """__del__(self)"""
940 try:
941 if self.thisown: destroy(self)
942 except: pass
943
944 def __eq__(*args, **kwargs):
945 """
946 __eq__(self, Point pt) -> bool
947
948 Test for equality of wx.Point objects.
949 """
950 return _core_.Point___eq__(*args, **kwargs)
951
952 def __ne__(*args, **kwargs):
953 """
954 __ne__(self, Point pt) -> bool
955
956 Test for inequality of wx.Point objects.
957 """
958 return _core_.Point___ne__(*args, **kwargs)
959
960 def __add__(*args, **kwargs):
961 """
962 __add__(self, Point pt) -> Point
963
964 Add pt's proprties to this and return the result.
965 """
966 return _core_.Point___add__(*args, **kwargs)
967
968 def __sub__(*args, **kwargs):
969 """
970 __sub__(self, Point pt) -> Point
971
972 Subtract pt's proprties from this and return the result
973 """
974 return _core_.Point___sub__(*args, **kwargs)
975
976 def __iadd__(*args, **kwargs):
977 """
978 __iadd__(self, Point pt) -> Point
979
980 Add pt to this object.
981 """
982 return _core_.Point___iadd__(*args, **kwargs)
983
984 def __isub__(*args, **kwargs):
985 """
986 __isub__(self, Point pt) -> Point
987
988 Subtract pt from this object.
989 """
990 return _core_.Point___isub__(*args, **kwargs)
991
992 def Set(*args, **kwargs):
993 """
994 Set(self, long x, long y)
995
996 Set both the x and y properties
997 """
998 return _core_.Point_Set(*args, **kwargs)
999
1000 def Get(*args, **kwargs):
1001 """
1002 Get() -> (x,y)
1003
1004 Return the x and y properties as a tuple.
1005 """
1006 return _core_.Point_Get(*args, **kwargs)
1007
79fccf9d 1008 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1009 def __str__(self): return str(self.Get())
1010 def __repr__(self): return 'wx.Point'+str(self.Get())
1011 def __len__(self): return len(self.Get())
1012 def __getitem__(self, index): return self.Get()[index]
1013 def __setitem__(self, index, val):
1014 if index == 0: self.x = val
1015 elif index == 1: self.y = val
1016 else: raise IndexError
1017 def __nonzero__(self): return self.Get() != (0,0)
1018 __safe_for_unpickling__ = True
1019 def __reduce__(self): return (wx.Point, self.Get())
1020
1021
1022class PointPtr(Point):
1023 def __init__(self, this):
1024 self.this = this
1025 if not hasattr(self,"thisown"): self.thisown = 0
1026 self.__class__ = Point
1027_core_.Point_swigregister(PointPtr)
1028
1029#---------------------------------------------------------------------------
1030
1031class Rect(object):
1032 """
79fccf9d
RD
1033 A class for representing and manipulating rectangles. It has x, y,
1034 width and height properties. In wxPython most palces that expect a
1035 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc
RD
1036 """
1037 def __repr__(self):
1038 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1039 def __init__(self, *args, **kwargs):
1040 """
1041 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1042
1043 Create a new Rect object.
1044 """
1045 newobj = _core_.new_Rect(*args, **kwargs)
1046 self.this = newobj.this
1047 self.thisown = 1
1048 del newobj.thisown
1049 def __del__(self, destroy=_core_.delete_Rect):
1050 """__del__(self)"""
1051 try:
1052 if self.thisown: destroy(self)
1053 except: pass
1054
1055 def GetX(*args, **kwargs):
1056 """GetX(self) -> int"""
1057 return _core_.Rect_GetX(*args, **kwargs)
1058
1059 def SetX(*args, **kwargs):
1060 """SetX(self, int x)"""
1061 return _core_.Rect_SetX(*args, **kwargs)
1062
1063 def GetY(*args, **kwargs):
1064 """GetY(self) -> int"""
1065 return _core_.Rect_GetY(*args, **kwargs)
1066
1067 def SetY(*args, **kwargs):
1068 """SetY(self, int y)"""
1069 return _core_.Rect_SetY(*args, **kwargs)
1070
1071 def GetWidth(*args, **kwargs):
1072 """GetWidth(self) -> int"""
1073 return _core_.Rect_GetWidth(*args, **kwargs)
1074
1075 def SetWidth(*args, **kwargs):
1076 """SetWidth(self, int w)"""
1077 return _core_.Rect_SetWidth(*args, **kwargs)
1078
1079 def GetHeight(*args, **kwargs):
1080 """GetHeight(self) -> int"""
1081 return _core_.Rect_GetHeight(*args, **kwargs)
1082
1083 def SetHeight(*args, **kwargs):
1084 """SetHeight(self, int h)"""
1085 return _core_.Rect_SetHeight(*args, **kwargs)
1086
1087 def GetPosition(*args, **kwargs):
1088 """GetPosition(self) -> Point"""
1089 return _core_.Rect_GetPosition(*args, **kwargs)
1090
1091 def SetPosition(*args, **kwargs):
1092 """SetPosition(self, Point p)"""
1093 return _core_.Rect_SetPosition(*args, **kwargs)
1094
1095 def GetSize(*args, **kwargs):
1096 """GetSize(self) -> Size"""
1097 return _core_.Rect_GetSize(*args, **kwargs)
1098
1099 def SetSize(*args, **kwargs):
1100 """SetSize(self, Size s)"""
1101 return _core_.Rect_SetSize(*args, **kwargs)
1102
1103 def GetTopLeft(*args, **kwargs):
1104 """GetTopLeft(self) -> Point"""
1105 return _core_.Rect_GetTopLeft(*args, **kwargs)
1106
1107 def SetTopLeft(*args, **kwargs):
1108 """SetTopLeft(self, Point p)"""
1109 return _core_.Rect_SetTopLeft(*args, **kwargs)
1110
1111 def GetBottomRight(*args, **kwargs):
1112 """GetBottomRight(self) -> Point"""
1113 return _core_.Rect_GetBottomRight(*args, **kwargs)
1114
1115 def SetBottomRight(*args, **kwargs):
1116 """SetBottomRight(self, Point p)"""
1117 return _core_.Rect_SetBottomRight(*args, **kwargs)
1118
1119 def GetLeft(*args, **kwargs):
1120 """GetLeft(self) -> int"""
1121 return _core_.Rect_GetLeft(*args, **kwargs)
1122
1123 def GetTop(*args, **kwargs):
1124 """GetTop(self) -> int"""
1125 return _core_.Rect_GetTop(*args, **kwargs)
1126
1127 def GetBottom(*args, **kwargs):
1128 """GetBottom(self) -> int"""
1129 return _core_.Rect_GetBottom(*args, **kwargs)
1130
1131 def GetRight(*args, **kwargs):
1132 """GetRight(self) -> int"""
1133 return _core_.Rect_GetRight(*args, **kwargs)
1134
1135 def SetLeft(*args, **kwargs):
1136 """SetLeft(self, int left)"""
1137 return _core_.Rect_SetLeft(*args, **kwargs)
1138
1139 def SetRight(*args, **kwargs):
1140 """SetRight(self, int right)"""
1141 return _core_.Rect_SetRight(*args, **kwargs)
1142
1143 def SetTop(*args, **kwargs):
1144 """SetTop(self, int top)"""
1145 return _core_.Rect_SetTop(*args, **kwargs)
1146
1147 def SetBottom(*args, **kwargs):
1148 """SetBottom(self, int bottom)"""
1149 return _core_.Rect_SetBottom(*args, **kwargs)
1150
1151 position = property(GetPosition, SetPosition)
1152 size = property(GetSize, SetSize)
1153 left = property(GetLeft, SetLeft)
1154 right = property(GetRight, SetRight)
1155 top = property(GetTop, SetTop)
1156 bottom = property(GetBottom, SetBottom)
1157
1158 def Inflate(*args, **kwargs):
1159 """
1160 Inflate(self, int dx, int dy) -> Rect
1161
79fccf9d
RD
1162 Increase the rectangle size by dx in x direction and dy in y
1163 direction. Both or one of) parameters may be negative to decrease the
1164 rectangle size.
d55e5bfc
RD
1165 """
1166 return _core_.Rect_Inflate(*args, **kwargs)
1167
1168 def Deflate(*args, **kwargs):
1169 """
1170 Deflate(self, int dx, int dy) -> Rect
1171
79fccf9d
RD
1172 Decrease the rectangle size by dx in x direction and dy in y
1173 direction. Both or one of) parameters may be negative to increase the
1174 rectngle size. This method is the opposite of Inflate.
d55e5bfc
RD
1175 """
1176 return _core_.Rect_Deflate(*args, **kwargs)
1177
1178 def OffsetXY(*args, **kwargs):
1179 """
1180 OffsetXY(self, int dx, int dy)
1181
79fccf9d
RD
1182 Moves the rectangle by the specified offset. If dx is positive, the
1183 rectangle is moved to the right, if dy is positive, it is moved to the
1184 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1185 """
1186 return _core_.Rect_OffsetXY(*args, **kwargs)
1187
1188 def Offset(*args, **kwargs):
1189 """
1190 Offset(self, Point pt)
1191
1192 Same as OffsetXY but uses dx,dy from Point
1193 """
1194 return _core_.Rect_Offset(*args, **kwargs)
1195
1196 def Intersect(*args, **kwargs):
1197 """
1198 Intersect(self, Rect rect) -> Rect
1199
1200 Return the intersectsion of this rectangle and rect.
1201 """
1202 return _core_.Rect_Intersect(*args, **kwargs)
1203
1204 def __add__(*args, **kwargs):
1205 """
1206 __add__(self, Rect rect) -> Rect
1207
1208 Add the properties of rect to this rectangle and return the result.
1209 """
1210 return _core_.Rect___add__(*args, **kwargs)
1211
1212 def __iadd__(*args, **kwargs):
1213 """
1214 __iadd__(self, Rect rect) -> Rect
1215
1216 Add the properties of rect to this rectangle, updating this rectangle.
1217 """
1218 return _core_.Rect___iadd__(*args, **kwargs)
1219
1220 def __eq__(*args, **kwargs):
1221 """
1222 __eq__(self, Rect rect) -> bool
1223
1224 Test for equality.
1225 """
1226 return _core_.Rect___eq__(*args, **kwargs)
1227
1228 def __ne__(*args, **kwargs):
1229 """
1230 __ne__(self, Rect rect) -> bool
1231
1232 Test for inequality.
1233 """
1234 return _core_.Rect___ne__(*args, **kwargs)
1235
1236 def InsideXY(*args, **kwargs):
1237 """
1238 InsideXY(self, int x, int y) -> bool
1239
1240 Return True if the point is (not strcitly) inside the rect.
1241 """
1242 return _core_.Rect_InsideXY(*args, **kwargs)
1243
1244 def Inside(*args, **kwargs):
1245 """
1246 Inside(self, Point pt) -> bool
1247
1248 Return True if the point is (not strcitly) inside the rect.
1249 """
1250 return _core_.Rect_Inside(*args, **kwargs)
1251
1252 def Intersects(*args, **kwargs):
1253 """
1254 Intersects(self, Rect rect) -> bool
1255
1256 Returns True if the rectangles have a non empty intersection.
1257 """
1258 return _core_.Rect_Intersects(*args, **kwargs)
1259
1260 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1261 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1262 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1263 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1264 def Set(*args, **kwargs):
1265 """
1266 Set(self, int x=0, int y=0, int width=0, int height=0)
1267
1268 Set all rectangle properties.
1269 """
1270 return _core_.Rect_Set(*args, **kwargs)
1271
1272 def Get(*args, **kwargs):
1273 """
1274 Get() -> (x,y,width,height)
1275
1276 Return the rectangle properties as a tuple.
1277 """
1278 return _core_.Rect_Get(*args, **kwargs)
1279
79fccf9d 1280 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1281 def __str__(self): return str(self.Get())
1282 def __repr__(self): return 'wx.Rect'+str(self.Get())
1283 def __len__(self): return len(self.Get())
1284 def __getitem__(self, index): return self.Get()[index]
1285 def __setitem__(self, index, val):
1286 if index == 0: self.x = val
1287 elif index == 1: self.y = val
1288 elif index == 2: self.width = val
1289 elif index == 3: self.height = val
1290 else: raise IndexError
1291 def __nonzero__(self): return self.Get() != (0,0,0,0)
1292 __safe_for_unpickling__ = True
1293 def __reduce__(self): return (wx.Rect, self.Get())
1294
1295
1296class RectPtr(Rect):
1297 def __init__(self, this):
1298 self.this = this
1299 if not hasattr(self,"thisown"): self.thisown = 0
1300 self.__class__ = Rect
1301_core_.Rect_swigregister(RectPtr)
1302
1303def RectPP(*args, **kwargs):
1304 """
1305 RectPP(Point topLeft, Point bottomRight) -> Rect
1306
1307 Create a new Rect object from Points representing two corners.
1308 """
1309 val = _core_.new_RectPP(*args, **kwargs)
1310 val.thisown = 1
1311 return val
1312
1313def RectPS(*args, **kwargs):
1314 """
1315 RectPS(Point pos, Size size) -> Rect
1316
1317 Create a new Rect from a position and size.
1318 """
1319 val = _core_.new_RectPS(*args, **kwargs)
1320 val.thisown = 1
1321 return val
1322
c1cb24a4
RD
1323def RectS(*args, **kwargs):
1324 """
1325 RectS(Size size) -> Rect
1326
1327 Create a new Rect from a size only.
1328 """
1329 val = _core_.new_RectS(*args, **kwargs)
1330 val.thisown = 1
1331 return val
1332
d55e5bfc
RD
1333
1334def IntersectRect(*args, **kwargs):
1335 """
1336 IntersectRect(Rect r1, Rect r2) -> Rect
1337
1338 Calculate and return the intersection of r1 and r2.
1339 """
1340 return _core_.IntersectRect(*args, **kwargs)
1341#---------------------------------------------------------------------------
1342
1343class Point2D(object):
79fccf9d
RD
1344 """
1345 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1346 with floating point values.
1347 """
d55e5bfc
RD
1348 def __repr__(self):
1349 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1350 def __init__(self, *args, **kwargs):
1351 """
1352 __init__(self, double x=0.0, double y=0.0) -> Point2D
1353
1354 Create a w.Point2D object.
1355 """
1356 newobj = _core_.new_Point2D(*args, **kwargs)
1357 self.this = newobj.this
1358 self.thisown = 1
1359 del newobj.thisown
1360 def GetFloor(*args, **kwargs):
a8eff060
RD
1361 """
1362 GetFloor() -> (x,y)
1363
1364 Convert to integer
1365 """
d55e5bfc
RD
1366 return _core_.Point2D_GetFloor(*args, **kwargs)
1367
1368 def GetRounded(*args, **kwargs):
a8eff060
RD
1369 """
1370 GetRounded() -> (x,y)
1371
1372 Convert to integer
1373 """
d55e5bfc
RD
1374 return _core_.Point2D_GetRounded(*args, **kwargs)
1375
1376 def GetVectorLength(*args, **kwargs):
1377 """GetVectorLength(self) -> double"""
1378 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1379
1380 def GetVectorAngle(*args, **kwargs):
1381 """GetVectorAngle(self) -> double"""
1382 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1383
1384 def SetVectorLength(*args, **kwargs):
1385 """SetVectorLength(self, double length)"""
1386 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1387
1388 def SetVectorAngle(*args, **kwargs):
1389 """SetVectorAngle(self, double degrees)"""
1390 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1391
1392 def SetPolarCoordinates(self, angle, length):
1393 self.SetVectorLength(length)
1394 self.SetVectorAngle(angle)
1395 def Normalize(self):
1396 self.SetVectorLength(1.0)
1397
1398 def GetDistance(*args, **kwargs):
1399 """GetDistance(self, Point2D pt) -> double"""
1400 return _core_.Point2D_GetDistance(*args, **kwargs)
1401
1402 def GetDistanceSquare(*args, **kwargs):
1403 """GetDistanceSquare(self, Point2D pt) -> double"""
1404 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1405
1406 def GetDotProduct(*args, **kwargs):
1407 """GetDotProduct(self, Point2D vec) -> double"""
1408 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1409
1410 def GetCrossProduct(*args, **kwargs):
1411 """GetCrossProduct(self, Point2D vec) -> double"""
1412 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1413
1414 def __neg__(*args, **kwargs):
1415 """
1416 __neg__(self) -> Point2D
1417
1418 the reflection of this point
1419 """
1420 return _core_.Point2D___neg__(*args, **kwargs)
1421
1422 def __iadd__(*args, **kwargs):
1423 """__iadd__(self, Point2D pt) -> Point2D"""
1424 return _core_.Point2D___iadd__(*args, **kwargs)
1425
1426 def __isub__(*args, **kwargs):
1427 """__isub__(self, Point2D pt) -> Point2D"""
1428 return _core_.Point2D___isub__(*args, **kwargs)
1429
1430 def __imul__(*args, **kwargs):
1431 """__imul__(self, Point2D pt) -> Point2D"""
1432 return _core_.Point2D___imul__(*args, **kwargs)
1433
1434 def __idiv__(*args, **kwargs):
1435 """__idiv__(self, Point2D pt) -> Point2D"""
1436 return _core_.Point2D___idiv__(*args, **kwargs)
1437
1438 def __eq__(*args, **kwargs):
1439 """
1440 __eq__(self, Point2D pt) -> bool
1441
1442 Test for equality
1443 """
1444 return _core_.Point2D___eq__(*args, **kwargs)
1445
1446 def __ne__(*args, **kwargs):
1447 """
1448 __ne__(self, Point2D pt) -> bool
1449
1450 Test for inequality
1451 """
1452 return _core_.Point2D___ne__(*args, **kwargs)
1453
1454 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1455 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1456 def Set(*args, **kwargs):
1457 """Set(self, double x=0, double y=0)"""
1458 return _core_.Point2D_Set(*args, **kwargs)
1459
1460 def Get(*args, **kwargs):
1461 """
1462 Get() -> (x,y)
1463
1464 Return x and y properties as a tuple.
1465 """
1466 return _core_.Point2D_Get(*args, **kwargs)
1467
79fccf9d 1468 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1469 def __str__(self): return str(self.Get())
1470 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1471 def __len__(self): return len(self.Get())
1472 def __getitem__(self, index): return self.Get()[index]
1473 def __setitem__(self, index, val):
1474 if index == 0: self.x = val
1475 elif index == 1: self.y = val
1476 else: raise IndexError
1477 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1478 __safe_for_unpickling__ = True
1479 def __reduce__(self): return (wx.Point2D, self.Get())
1480
1481
1482class Point2DPtr(Point2D):
1483 def __init__(self, this):
1484 self.this = this
1485 if not hasattr(self,"thisown"): self.thisown = 0
1486 self.__class__ = Point2D
1487_core_.Point2D_swigregister(Point2DPtr)
1488
1489def Point2DCopy(*args, **kwargs):
1490 """
1491 Point2DCopy(Point2D pt) -> Point2D
1492
1493 Create a w.Point2D object.
1494 """
1495 val = _core_.new_Point2DCopy(*args, **kwargs)
1496 val.thisown = 1
1497 return val
1498
1499def Point2DFromPoint(*args, **kwargs):
1500 """
1501 Point2DFromPoint(Point pt) -> Point2D
1502
1503 Create a w.Point2D object.
1504 """
1505 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1506 val.thisown = 1
1507 return val
1508
1509#---------------------------------------------------------------------------
1510
1511FromStart = _core_.FromStart
1512FromCurrent = _core_.FromCurrent
1513FromEnd = _core_.FromEnd
1514class InputStream(object):
1515 def __repr__(self):
1516 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1517 def __init__(self, *args, **kwargs):
1518 """__init__(self, PyObject p) -> InputStream"""
1519 newobj = _core_.new_InputStream(*args, **kwargs)
1520 self.this = newobj.this
1521 self.thisown = 1
1522 del newobj.thisown
8fb0e70a
RD
1523 def __del__(self, destroy=_core_.delete_InputStream):
1524 """__del__(self)"""
1525 try:
1526 if self.thisown: destroy(self)
1527 except: pass
1528
d55e5bfc
RD
1529 def close(*args, **kwargs):
1530 """close(self)"""
1531 return _core_.InputStream_close(*args, **kwargs)
1532
1533 def flush(*args, **kwargs):
1534 """flush(self)"""
1535 return _core_.InputStream_flush(*args, **kwargs)
1536
1537 def eof(*args, **kwargs):
1538 """eof(self) -> bool"""
1539 return _core_.InputStream_eof(*args, **kwargs)
1540
1541 def read(*args, **kwargs):
1542 """read(self, int size=-1) -> PyObject"""
1543 return _core_.InputStream_read(*args, **kwargs)
1544
1545 def readline(*args, **kwargs):
1546 """readline(self, int size=-1) -> PyObject"""
1547 return _core_.InputStream_readline(*args, **kwargs)
1548
1549 def readlines(*args, **kwargs):
1550 """readlines(self, int sizehint=-1) -> PyObject"""
1551 return _core_.InputStream_readlines(*args, **kwargs)
1552
1553 def seek(*args, **kwargs):
1554 """seek(self, int offset, int whence=0)"""
1555 return _core_.InputStream_seek(*args, **kwargs)
1556
1557 def tell(*args, **kwargs):
1558 """tell(self) -> int"""
1559 return _core_.InputStream_tell(*args, **kwargs)
1560
1561 def Peek(*args, **kwargs):
1562 """Peek(self) -> char"""
1563 return _core_.InputStream_Peek(*args, **kwargs)
1564
1565 def GetC(*args, **kwargs):
1566 """GetC(self) -> char"""
1567 return _core_.InputStream_GetC(*args, **kwargs)
1568
1569 def LastRead(*args, **kwargs):
1570 """LastRead(self) -> size_t"""
1571 return _core_.InputStream_LastRead(*args, **kwargs)
1572
1573 def CanRead(*args, **kwargs):
1574 """CanRead(self) -> bool"""
1575 return _core_.InputStream_CanRead(*args, **kwargs)
1576
1577 def Eof(*args, **kwargs):
1578 """Eof(self) -> bool"""
1579 return _core_.InputStream_Eof(*args, **kwargs)
1580
1581 def Ungetch(*args, **kwargs):
1582 """Ungetch(self, char c) -> bool"""
1583 return _core_.InputStream_Ungetch(*args, **kwargs)
1584
1585 def SeekI(*args, **kwargs):
1586 """SeekI(self, long pos, int mode=FromStart) -> long"""
1587 return _core_.InputStream_SeekI(*args, **kwargs)
1588
1589 def TellI(*args, **kwargs):
1590 """TellI(self) -> long"""
1591 return _core_.InputStream_TellI(*args, **kwargs)
1592
1593
1594class InputStreamPtr(InputStream):
1595 def __init__(self, this):
1596 self.this = this
1597 if not hasattr(self,"thisown"): self.thisown = 0
1598 self.__class__ = InputStream
1599_core_.InputStream_swigregister(InputStreamPtr)
1600DefaultPosition = cvar.DefaultPosition
1601DefaultSize = cvar.DefaultSize
1602
1603class OutputStream(object):
1604 def __init__(self): raise RuntimeError, "No constructor defined"
1605 def __repr__(self):
1606 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1607 def write(*args, **kwargs):
1608 """write(self, PyObject obj)"""
1609 return _core_.OutputStream_write(*args, **kwargs)
1610
1611
1612class OutputStreamPtr(OutputStream):
1613 def __init__(self, this):
1614 self.this = this
1615 if not hasattr(self,"thisown"): self.thisown = 0
1616 self.__class__ = OutputStream
1617_core_.OutputStream_swigregister(OutputStreamPtr)
1618
1619#---------------------------------------------------------------------------
1620
1621class FSFile(Object):
1622 def __repr__(self):
1623 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1624 def __init__(self, *args, **kwargs):
1625 """
1626 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1627 DateTime modif) -> FSFile
1628 """
1629 newobj = _core_.new_FSFile(*args, **kwargs)
1630 self.this = newobj.this
1631 self.thisown = 1
1632 del newobj.thisown
4cf4100f
RD
1633 self.thisown = 0 # It will normally be deleted by the user of the wxFileSystem
1634
d55e5bfc
RD
1635 def __del__(self, destroy=_core_.delete_FSFile):
1636 """__del__(self)"""
1637 try:
1638 if self.thisown: destroy(self)
1639 except: pass
1640
1641 def GetStream(*args, **kwargs):
1642 """GetStream(self) -> InputStream"""
1643 return _core_.FSFile_GetStream(*args, **kwargs)
1644
1645 def GetMimeType(*args, **kwargs):
1646 """GetMimeType(self) -> String"""
1647 return _core_.FSFile_GetMimeType(*args, **kwargs)
1648
1649 def GetLocation(*args, **kwargs):
1650 """GetLocation(self) -> String"""
1651 return _core_.FSFile_GetLocation(*args, **kwargs)
1652
1653 def GetAnchor(*args, **kwargs):
1654 """GetAnchor(self) -> String"""
1655 return _core_.FSFile_GetAnchor(*args, **kwargs)
1656
1657 def GetModificationTime(*args, **kwargs):
1658 """GetModificationTime(self) -> DateTime"""
1659 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1660
1661
1662class FSFilePtr(FSFile):
1663 def __init__(self, this):
1664 self.this = this
1665 if not hasattr(self,"thisown"): self.thisown = 0
1666 self.__class__ = FSFile
1667_core_.FSFile_swigregister(FSFilePtr)
1668
1669class CPPFileSystemHandler(object):
1670 def __init__(self): raise RuntimeError, "No constructor defined"
1671 def __repr__(self):
1672 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1673
1674class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1675 def __init__(self, this):
1676 self.this = this
1677 if not hasattr(self,"thisown"): self.thisown = 0
1678 self.__class__ = CPPFileSystemHandler
1679_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1680
1681class FileSystemHandler(CPPFileSystemHandler):
1682 def __repr__(self):
1683 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1684 def __init__(self, *args, **kwargs):
1685 """__init__(self) -> FileSystemHandler"""
1686 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1687 self.this = newobj.this
1688 self.thisown = 1
1689 del newobj.thisown
1690 self._setCallbackInfo(self, FileSystemHandler)
1691
1692 def _setCallbackInfo(*args, **kwargs):
1693 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1694 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1695
1696 def CanOpen(*args, **kwargs):
1697 """CanOpen(self, String location) -> bool"""
1698 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1699
1700 def OpenFile(*args, **kwargs):
1701 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1702 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1703
1704 def FindFirst(*args, **kwargs):
1705 """FindFirst(self, String spec, int flags=0) -> String"""
1706 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1707
1708 def FindNext(*args, **kwargs):
1709 """FindNext(self) -> String"""
1710 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1711
1712 def GetProtocol(*args, **kwargs):
1713 """GetProtocol(self, String location) -> String"""
1714 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1715
1716 def GetLeftLocation(*args, **kwargs):
1717 """GetLeftLocation(self, String location) -> String"""
1718 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1719
1720 def GetAnchor(*args, **kwargs):
1721 """GetAnchor(self, String location) -> String"""
1722 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1723
1724 def GetRightLocation(*args, **kwargs):
1725 """GetRightLocation(self, String location) -> String"""
1726 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1727
1728 def GetMimeTypeFromExt(*args, **kwargs):
1729 """GetMimeTypeFromExt(self, String location) -> String"""
1730 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1731
1732
1733class FileSystemHandlerPtr(FileSystemHandler):
1734 def __init__(self, this):
1735 self.this = this
1736 if not hasattr(self,"thisown"): self.thisown = 0
1737 self.__class__ = FileSystemHandler
1738_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1739
1740class FileSystem(Object):
1741 def __repr__(self):
1742 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1743 def __init__(self, *args, **kwargs):
1744 """__init__(self) -> FileSystem"""
1745 newobj = _core_.new_FileSystem(*args, **kwargs)
1746 self.this = newobj.this
1747 self.thisown = 1
1748 del newobj.thisown
1749 def __del__(self, destroy=_core_.delete_FileSystem):
1750 """__del__(self)"""
1751 try:
1752 if self.thisown: destroy(self)
1753 except: pass
1754
1755 def ChangePathTo(*args, **kwargs):
1756 """ChangePathTo(self, String location, bool is_dir=False)"""
1757 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1758
1759 def GetPath(*args, **kwargs):
1760 """GetPath(self) -> String"""
1761 return _core_.FileSystem_GetPath(*args, **kwargs)
1762
1763 def OpenFile(*args, **kwargs):
1764 """OpenFile(self, String location) -> FSFile"""
1765 return _core_.FileSystem_OpenFile(*args, **kwargs)
1766
1767 def FindFirst(*args, **kwargs):
1768 """FindFirst(self, String spec, int flags=0) -> String"""
1769 return _core_.FileSystem_FindFirst(*args, **kwargs)
1770
1771 def FindNext(*args, **kwargs):
1772 """FindNext(self) -> String"""
1773 return _core_.FileSystem_FindNext(*args, **kwargs)
1774
1775 def AddHandler(*args, **kwargs):
c24da6d6 1776 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1777 return _core_.FileSystem_AddHandler(*args, **kwargs)
1778
1779 AddHandler = staticmethod(AddHandler)
1780 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1781 """CleanUpHandlers()"""
d55e5bfc
RD
1782 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1783
1784 CleanUpHandlers = staticmethod(CleanUpHandlers)
1785 def FileNameToURL(*args, **kwargs):
c24da6d6 1786 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1787 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1788
1789 FileNameToURL = staticmethod(FileNameToURL)
ae8162c8
RD
1790 def URLToFileName(*args, **kwargs):
1791 """URLToFileName(String url) -> String"""
1792 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1793
1794 URLToFileName = staticmethod(URLToFileName)
d55e5bfc
RD
1795
1796class FileSystemPtr(FileSystem):
1797 def __init__(self, this):
1798 self.this = this
1799 if not hasattr(self,"thisown"): self.thisown = 0
1800 self.__class__ = FileSystem
1801_core_.FileSystem_swigregister(FileSystemPtr)
1802
1803def FileSystem_AddHandler(*args, **kwargs):
1804 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1805 return _core_.FileSystem_AddHandler(*args, **kwargs)
1806
1807def FileSystem_CleanUpHandlers(*args, **kwargs):
1808 """FileSystem_CleanUpHandlers()"""
1809 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1810
1811def FileSystem_FileNameToURL(*args, **kwargs):
1812 """FileSystem_FileNameToURL(String filename) -> String"""
1813 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1814
d55e5bfc
RD
1815def FileSystem_URLToFileName(*args, **kwargs):
1816 """FileSystem_URLToFileName(String url) -> String"""
1817 return _core_.FileSystem_URLToFileName(*args, **kwargs)
ae8162c8 1818
d55e5bfc
RD
1819class InternetFSHandler(CPPFileSystemHandler):
1820 def __repr__(self):
1821 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1822 def __init__(self, *args, **kwargs):
1823 """__init__(self) -> InternetFSHandler"""
1824 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1825 self.this = newobj.this
1826 self.thisown = 1
1827 del newobj.thisown
1828 def CanOpen(*args, **kwargs):
1829 """CanOpen(self, String location) -> bool"""
1830 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1831
1832 def OpenFile(*args, **kwargs):
1833 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1834 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1835
1836
1837class InternetFSHandlerPtr(InternetFSHandler):
1838 def __init__(self, this):
1839 self.this = this
1840 if not hasattr(self,"thisown"): self.thisown = 0
1841 self.__class__ = InternetFSHandler
1842_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1843
1844class ZipFSHandler(CPPFileSystemHandler):
1845 def __repr__(self):
1846 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1847 def __init__(self, *args, **kwargs):
1848 """__init__(self) -> ZipFSHandler"""
1849 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1850 self.this = newobj.this
1851 self.thisown = 1
1852 del newobj.thisown
1853 def CanOpen(*args, **kwargs):
1854 """CanOpen(self, String location) -> bool"""
1855 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1856
1857 def OpenFile(*args, **kwargs):
1858 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1859 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1860
1861 def FindFirst(*args, **kwargs):
1862 """FindFirst(self, String spec, int flags=0) -> String"""
1863 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1864
1865 def FindNext(*args, **kwargs):
1866 """FindNext(self) -> String"""
1867 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1868
1869
1870class ZipFSHandlerPtr(ZipFSHandler):
1871 def __init__(self, this):
1872 self.this = this
1873 if not hasattr(self,"thisown"): self.thisown = 0
1874 self.__class__ = ZipFSHandler
1875_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
1876
1877
1878def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1879 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1880 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1881
1882def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1883 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1884 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1885
1886def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1887 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1888 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
ae8162c8
RD
1889def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
1890 """
1891 Add 'file' to the memory filesystem. The dataItem parameter can
1892 either be a `wx.Bitmap`, `wx.Image` or a string that can contain
1893 arbitrary data. If a bitmap or image is used then the imgType
1894 parameter should specify what kind of image file it should be
1895 written as, wx.BITMAP_TYPE_PNG, etc.
1896 """
1897 if isinstance(dataItem, wx.Image):
1898 __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
1899 elif isinstance(dataItem, wx.Bitmap):
1900 __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
1901 elif type(dataItem) == str:
1902 __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
1903 else:
1904 raise TypeError, 'wx.Image, wx.Bitmap or string expected'
d55e5bfc
RD
1905
1906class MemoryFSHandler(CPPFileSystemHandler):
1907 def __repr__(self):
1908 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1909 def __init__(self, *args, **kwargs):
1910 """__init__(self) -> MemoryFSHandler"""
1911 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
1912 self.this = newobj.this
1913 self.thisown = 1
1914 del newobj.thisown
1915 def RemoveFile(*args, **kwargs):
c24da6d6 1916 """RemoveFile(String filename)"""
d55e5bfc
RD
1917 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1918
1919 RemoveFile = staticmethod(RemoveFile)
1920 AddFile = staticmethod(MemoryFSHandler_AddFile)
1921 def CanOpen(*args, **kwargs):
1922 """CanOpen(self, String location) -> bool"""
1923 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1924
1925 def OpenFile(*args, **kwargs):
1926 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1927 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1928
1929 def FindFirst(*args, **kwargs):
1930 """FindFirst(self, String spec, int flags=0) -> String"""
1931 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1932
1933 def FindNext(*args, **kwargs):
1934 """FindNext(self) -> String"""
1935 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1936
1937
1938class MemoryFSHandlerPtr(MemoryFSHandler):
1939 def __init__(self, this):
1940 self.this = this
1941 if not hasattr(self,"thisown"): self.thisown = 0
1942 self.__class__ = MemoryFSHandler
1943_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
1944
1945def MemoryFSHandler_RemoveFile(*args, **kwargs):
1946 """MemoryFSHandler_RemoveFile(String filename)"""
1947 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1948
1949#---------------------------------------------------------------------------
1950
1951class ImageHandler(Object):
1952 def __init__(self): raise RuntimeError, "No constructor defined"
1953 def __repr__(self):
1954 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1955 def GetName(*args, **kwargs):
1956 """GetName(self) -> String"""
1957 return _core_.ImageHandler_GetName(*args, **kwargs)
1958
1959 def GetExtension(*args, **kwargs):
1960 """GetExtension(self) -> String"""
1961 return _core_.ImageHandler_GetExtension(*args, **kwargs)
1962
1963 def GetType(*args, **kwargs):
1964 """GetType(self) -> long"""
1965 return _core_.ImageHandler_GetType(*args, **kwargs)
1966
1967 def GetMimeType(*args, **kwargs):
1968 """GetMimeType(self) -> String"""
1969 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
1970
1971 def CanRead(*args, **kwargs):
1972 """CanRead(self, String name) -> bool"""
1973 return _core_.ImageHandler_CanRead(*args, **kwargs)
1974
1975 def SetName(*args, **kwargs):
1976 """SetName(self, String name)"""
1977 return _core_.ImageHandler_SetName(*args, **kwargs)
1978
1979 def SetExtension(*args, **kwargs):
1980 """SetExtension(self, String extension)"""
1981 return _core_.ImageHandler_SetExtension(*args, **kwargs)
1982
1983 def SetType(*args, **kwargs):
1984 """SetType(self, long type)"""
1985 return _core_.ImageHandler_SetType(*args, **kwargs)
1986
1987 def SetMimeType(*args, **kwargs):
1988 """SetMimeType(self, String mimetype)"""
1989 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
1990
1991
1992class ImageHandlerPtr(ImageHandler):
1993 def __init__(self, this):
1994 self.this = this
1995 if not hasattr(self,"thisown"): self.thisown = 0
1996 self.__class__ = ImageHandler
1997_core_.ImageHandler_swigregister(ImageHandlerPtr)
1998
1999class ImageHistogram(object):
2000 def __repr__(self):
2001 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2002 def __init__(self, *args, **kwargs):
2003 """__init__(self) -> ImageHistogram"""
2004 newobj = _core_.new_ImageHistogram(*args, **kwargs)
2005 self.this = newobj.this
2006 self.thisown = 1
2007 del newobj.thisown
2008 def MakeKey(*args, **kwargs):
2009 """
c24da6d6 2010 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
d55e5bfc
RD
2011
2012 Get the key in the histogram for the given RGB values
2013 """
2014 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2015
2016 MakeKey = staticmethod(MakeKey)
2017 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2018 """
2019 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2020
2021 Find first colour that is not used in the image and has higher RGB
2022 values than startR, startG, startB. Returns a tuple consisting of a
2023 success flag and rgb values.
2024 """
d55e5bfc
RD
2025 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
2026
2027
2028class ImageHistogramPtr(ImageHistogram):
2029 def __init__(self, this):
2030 self.this = this
2031 if not hasattr(self,"thisown"): self.thisown = 0
2032 self.__class__ = ImageHistogram
2033_core_.ImageHistogram_swigregister(ImageHistogramPtr)
2034
2035def ImageHistogram_MakeKey(*args, **kwargs):
2036 """
2037 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2038
2039 Get the key in the histogram for the given RGB values
2040 """
2041 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2042
2043class Image(Object):
2044 def __repr__(self):
2045 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2046 def __init__(self, *args, **kwargs):
2047 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2048 newobj = _core_.new_Image(*args, **kwargs)
2049 self.this = newobj.this
2050 self.thisown = 1
2051 del newobj.thisown
2052 def __del__(self, destroy=_core_.delete_Image):
2053 """__del__(self)"""
2054 try:
2055 if self.thisown: destroy(self)
2056 except: pass
2057
2058 def Create(*args, **kwargs):
2059 """Create(self, int width, int height)"""
2060 return _core_.Image_Create(*args, **kwargs)
2061
2062 def Destroy(*args, **kwargs):
2063 """
2064 Destroy(self)
2065
2066 Deletes the C++ object this Python object is a proxy for.
2067 """
2068 return _core_.Image_Destroy(*args, **kwargs)
2069
2070 def Scale(*args, **kwargs):
2071 """Scale(self, int width, int height) -> Image"""
2072 return _core_.Image_Scale(*args, **kwargs)
2073
2074 def ShrinkBy(*args, **kwargs):
2075 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
2076 return _core_.Image_ShrinkBy(*args, **kwargs)
2077
2078 def Rescale(*args, **kwargs):
2079 """Rescale(self, int width, int height) -> Image"""
2080 return _core_.Image_Rescale(*args, **kwargs)
2081
2082 def SetRGB(*args, **kwargs):
2083 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
2084 return _core_.Image_SetRGB(*args, **kwargs)
2085
2086 def GetRed(*args, **kwargs):
2087 """GetRed(self, int x, int y) -> unsigned char"""
2088 return _core_.Image_GetRed(*args, **kwargs)
2089
2090 def GetGreen(*args, **kwargs):
2091 """GetGreen(self, int x, int y) -> unsigned char"""
2092 return _core_.Image_GetGreen(*args, **kwargs)
2093
2094 def GetBlue(*args, **kwargs):
2095 """GetBlue(self, int x, int y) -> unsigned char"""
2096 return _core_.Image_GetBlue(*args, **kwargs)
2097
2098 def SetAlpha(*args, **kwargs):
2099 """SetAlpha(self, int x, int y, unsigned char alpha)"""
2100 return _core_.Image_SetAlpha(*args, **kwargs)
2101
2102 def GetAlpha(*args, **kwargs):
2103 """GetAlpha(self, int x, int y) -> unsigned char"""
2104 return _core_.Image_GetAlpha(*args, **kwargs)
2105
2106 def HasAlpha(*args, **kwargs):
2107 """HasAlpha(self) -> bool"""
2108 return _core_.Image_HasAlpha(*args, **kwargs)
2109
2110 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2111 """
2112 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2113
2114 Find first colour that is not used in the image and has higher RGB
2115 values than startR, startG, startB. Returns a tuple consisting of a
2116 success flag and rgb values.
2117 """
d55e5bfc
RD
2118 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2119
4cf4100f
RD
2120 def ConvertAlphaToMask(*args, **kwargs):
2121 """
2122 ConvertAlphaToMask(self, byte threshold=128) -> bool
2123
2124 If the image has alpha channel, this method converts it to mask. All pixels
2125 with alpha value less than ``threshold`` are replaced with mask colour and the
2126 alpha channel is removed. Mask colour is chosen automatically using
2127 `FindFirstUnusedColour`.
2128
2129 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2130 nothing.
2131 """
2132 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2133
8fb0e70a
RD
2134 def ConvertColourToAlpha(*args, **kwargs):
2135 """
2136 ConvertColourToAlpha(self, unsigned char r, unsigned char g, unsigned char b) -> bool
2137
2138 This method converts an image where the original alpha information is
2139 only available as a shades of a colour (actually shades of grey)
2140 typically when you draw anti-aliased text into a bitmap. The DC
2141 drawing routines draw grey values on the black background although
2142 they actually mean to draw white with differnt alpha values. This
2143 method reverses it, assuming a black (!) background and white text.
2144 The method will then fill up the whole image with the colour given.
2145 """
2146 return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
2147
d55e5bfc
RD
2148 def SetMaskFromImage(*args, **kwargs):
2149 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
2150 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2151
2152 def CanRead(*args, **kwargs):
c24da6d6 2153 """CanRead(String name) -> bool"""
d55e5bfc
RD
2154 return _core_.Image_CanRead(*args, **kwargs)
2155
2156 CanRead = staticmethod(CanRead)
2157 def GetImageCount(*args, **kwargs):
c24da6d6 2158 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
d55e5bfc
RD
2159 return _core_.Image_GetImageCount(*args, **kwargs)
2160
2161 GetImageCount = staticmethod(GetImageCount)
2162 def LoadFile(*args, **kwargs):
2163 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2164 return _core_.Image_LoadFile(*args, **kwargs)
2165
2166 def LoadMimeFile(*args, **kwargs):
2167 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
2168 return _core_.Image_LoadMimeFile(*args, **kwargs)
2169
2170 def SaveFile(*args, **kwargs):
2171 """SaveFile(self, String name, int type) -> bool"""
2172 return _core_.Image_SaveFile(*args, **kwargs)
2173
2174 def SaveMimeFile(*args, **kwargs):
2175 """SaveMimeFile(self, String name, String mimetype) -> bool"""
2176 return _core_.Image_SaveMimeFile(*args, **kwargs)
2177
2178 def CanReadStream(*args, **kwargs):
c24da6d6 2179 """CanReadStream(InputStream stream) -> bool"""
d55e5bfc
RD
2180 return _core_.Image_CanReadStream(*args, **kwargs)
2181
2182 CanReadStream = staticmethod(CanReadStream)
2183 def LoadStream(*args, **kwargs):
2184 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2185 return _core_.Image_LoadStream(*args, **kwargs)
2186
2187 def LoadMimeStream(*args, **kwargs):
2188 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
2189 return _core_.Image_LoadMimeStream(*args, **kwargs)
2190
2191 def Ok(*args, **kwargs):
2192 """Ok(self) -> bool"""
2193 return _core_.Image_Ok(*args, **kwargs)
2194
2195 def GetWidth(*args, **kwargs):
2196 """GetWidth(self) -> int"""
2197 return _core_.Image_GetWidth(*args, **kwargs)
2198
2199 def GetHeight(*args, **kwargs):
2200 """GetHeight(self) -> int"""
2201 return _core_.Image_GetHeight(*args, **kwargs)
2202
2203 def GetSize(*args, **kwargs):
2204 """GetSize(self) -> Size"""
2205 return _core_.Image_GetSize(*args, **kwargs)
2206
2207 def GetSubImage(*args, **kwargs):
2208 """GetSubImage(self, Rect rect) -> Image"""
2209 return _core_.Image_GetSubImage(*args, **kwargs)
2210
2211 def Copy(*args, **kwargs):
2212 """Copy(self) -> Image"""
2213 return _core_.Image_Copy(*args, **kwargs)
2214
2215 def Paste(*args, **kwargs):
2216 """Paste(self, Image image, int x, int y)"""
2217 return _core_.Image_Paste(*args, **kwargs)
2218
2219 def GetData(*args, **kwargs):
2220 """GetData(self) -> PyObject"""
2221 return _core_.Image_GetData(*args, **kwargs)
2222
2223 def SetData(*args, **kwargs):
2224 """SetData(self, PyObject data)"""
2225 return _core_.Image_SetData(*args, **kwargs)
2226
2227 def GetDataBuffer(*args, **kwargs):
2228 """GetDataBuffer(self) -> PyObject"""
2229 return _core_.Image_GetDataBuffer(*args, **kwargs)
2230
2231 def SetDataBuffer(*args, **kwargs):
2232 """SetDataBuffer(self, PyObject data)"""
2233 return _core_.Image_SetDataBuffer(*args, **kwargs)
2234
2235 def GetAlphaData(*args, **kwargs):
2236 """GetAlphaData(self) -> PyObject"""
2237 return _core_.Image_GetAlphaData(*args, **kwargs)
2238
2239 def SetAlphaData(*args, **kwargs):
2240 """SetAlphaData(self, PyObject data)"""
2241 return _core_.Image_SetAlphaData(*args, **kwargs)
2242
2243 def GetAlphaBuffer(*args, **kwargs):
2244 """GetAlphaBuffer(self) -> PyObject"""
2245 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2246
2247 def SetAlphaBuffer(*args, **kwargs):
2248 """SetAlphaBuffer(self, PyObject data)"""
2249 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2250
2251 def SetMaskColour(*args, **kwargs):
2252 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
2253 return _core_.Image_SetMaskColour(*args, **kwargs)
2254
2255 def GetMaskRed(*args, **kwargs):
2256 """GetMaskRed(self) -> unsigned char"""
2257 return _core_.Image_GetMaskRed(*args, **kwargs)
2258
2259 def GetMaskGreen(*args, **kwargs):
2260 """GetMaskGreen(self) -> unsigned char"""
2261 return _core_.Image_GetMaskGreen(*args, **kwargs)
2262
2263 def GetMaskBlue(*args, **kwargs):
2264 """GetMaskBlue(self) -> unsigned char"""
2265 return _core_.Image_GetMaskBlue(*args, **kwargs)
2266
2267 def SetMask(*args, **kwargs):
2268 """SetMask(self, bool mask=True)"""
2269 return _core_.Image_SetMask(*args, **kwargs)
2270
2271 def HasMask(*args, **kwargs):
2272 """HasMask(self) -> bool"""
2273 return _core_.Image_HasMask(*args, **kwargs)
2274
2275 def Rotate(*args, **kwargs):
2276 """
2277 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2278 Point offset_after_rotation=None) -> Image
2279 """
2280 return _core_.Image_Rotate(*args, **kwargs)
2281
2282 def Rotate90(*args, **kwargs):
2283 """Rotate90(self, bool clockwise=True) -> Image"""
2284 return _core_.Image_Rotate90(*args, **kwargs)
2285
2286 def Mirror(*args, **kwargs):
2287 """Mirror(self, bool horizontally=True) -> Image"""
2288 return _core_.Image_Mirror(*args, **kwargs)
2289
2290 def Replace(*args, **kwargs):
2291 """
2292 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
2293 unsigned char r2, unsigned char g2, unsigned char b2)
2294 """
2295 return _core_.Image_Replace(*args, **kwargs)
2296
2297 def ConvertToMono(*args, **kwargs):
2298 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
2299 return _core_.Image_ConvertToMono(*args, **kwargs)
2300
2301 def SetOption(*args, **kwargs):
2302 """SetOption(self, String name, String value)"""
2303 return _core_.Image_SetOption(*args, **kwargs)
2304
2305 def SetOptionInt(*args, **kwargs):
2306 """SetOptionInt(self, String name, int value)"""
2307 return _core_.Image_SetOptionInt(*args, **kwargs)
2308
2309 def GetOption(*args, **kwargs):
2310 """GetOption(self, String name) -> String"""
2311 return _core_.Image_GetOption(*args, **kwargs)
2312
2313 def GetOptionInt(*args, **kwargs):
2314 """GetOptionInt(self, String name) -> int"""
2315 return _core_.Image_GetOptionInt(*args, **kwargs)
2316
2317 def HasOption(*args, **kwargs):
2318 """HasOption(self, String name) -> bool"""
2319 return _core_.Image_HasOption(*args, **kwargs)
2320
2321 def CountColours(*args, **kwargs):
2322 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2323 return _core_.Image_CountColours(*args, **kwargs)
2324
2325 def ComputeHistogram(*args, **kwargs):
2326 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2327 return _core_.Image_ComputeHistogram(*args, **kwargs)
2328
2329 def AddHandler(*args, **kwargs):
c24da6d6 2330 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
2331 return _core_.Image_AddHandler(*args, **kwargs)
2332
2333 AddHandler = staticmethod(AddHandler)
2334 def InsertHandler(*args, **kwargs):
c24da6d6 2335 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
2336 return _core_.Image_InsertHandler(*args, **kwargs)
2337
2338 InsertHandler = staticmethod(InsertHandler)
2339 def RemoveHandler(*args, **kwargs):
c24da6d6 2340 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
2341 return _core_.Image_RemoveHandler(*args, **kwargs)
2342
2343 RemoveHandler = staticmethod(RemoveHandler)
2344 def GetImageExtWildcard(*args, **kwargs):
c24da6d6 2345 """GetImageExtWildcard() -> String"""
d55e5bfc
RD
2346 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2347
2348 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2349 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2350 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD
2351 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2352
2353 def ConvertToMonoBitmap(*args, **kwargs):
2354 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
2355 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2356
2357 def __nonzero__(self): return self.Ok()
2358
2359class ImagePtr(Image):
2360 def __init__(self, this):
2361 self.this = this
2362 if not hasattr(self,"thisown"): self.thisown = 0
2363 self.__class__ = Image
2364_core_.Image_swigregister(ImagePtr)
2365
2366def ImageFromMime(*args, **kwargs):
2367 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
2368 val = _core_.new_ImageFromMime(*args, **kwargs)
2369 val.thisown = 1
2370 return val
2371
2372def ImageFromStream(*args, **kwargs):
2373 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2374 val = _core_.new_ImageFromStream(*args, **kwargs)
2375 val.thisown = 1
2376 return val
2377
2378def ImageFromStreamMime(*args, **kwargs):
2379 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
2380 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2381 val.thisown = 1
2382 return val
2383
c24da6d6
RD
2384def EmptyImage(*args, **kwargs):
2385 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2386 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
2387 val.thisown = 1
2388 return val
2389
2390def ImageFromBitmap(*args, **kwargs):
2391 """ImageFromBitmap(Bitmap bitmap) -> Image"""
2392 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2393 val.thisown = 1
2394 return val
2395
2396def ImageFromData(*args, **kwargs):
2397 """ImageFromData(int width, int height, unsigned char data) -> Image"""
2398 val = _core_.new_ImageFromData(*args, **kwargs)
2399 val.thisown = 1
2400 return val
2401
2402def Image_CanRead(*args, **kwargs):
2403 """Image_CanRead(String name) -> bool"""
2404 return _core_.Image_CanRead(*args, **kwargs)
2405
2406def Image_GetImageCount(*args, **kwargs):
2407 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
2408 return _core_.Image_GetImageCount(*args, **kwargs)
2409
2410def Image_CanReadStream(*args, **kwargs):
2411 """Image_CanReadStream(InputStream stream) -> bool"""
2412 return _core_.Image_CanReadStream(*args, **kwargs)
2413
2414def Image_AddHandler(*args, **kwargs):
2415 """Image_AddHandler(ImageHandler handler)"""
2416 return _core_.Image_AddHandler(*args, **kwargs)
2417
2418def Image_InsertHandler(*args, **kwargs):
2419 """Image_InsertHandler(ImageHandler handler)"""
2420 return _core_.Image_InsertHandler(*args, **kwargs)
2421
2422def Image_RemoveHandler(*args, **kwargs):
2423 """Image_RemoveHandler(String name) -> bool"""
2424 return _core_.Image_RemoveHandler(*args, **kwargs)
2425
2426def Image_GetImageExtWildcard(*args, **kwargs):
2427 """Image_GetImageExtWildcard() -> String"""
2428 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2429
a07a67e6
RD
2430def InitAllImageHandlers():
2431 """
2432 The former functionality of InitAllImageHanders is now done internal to
2433 the _core_ extension module and so this function has become a simple NOP.
2434 """
2435 pass
d55e5bfc 2436
d55e5bfc
RD
2437IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2438IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2439BMP_24BPP = _core_.BMP_24BPP
2440BMP_8BPP = _core_.BMP_8BPP
2441BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2442BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2443BMP_8BPP_RED = _core_.BMP_8BPP_RED
2444BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2445BMP_4BPP = _core_.BMP_4BPP
2446BMP_1BPP = _core_.BMP_1BPP
2447BMP_1BPP_BW = _core_.BMP_1BPP_BW
2448class BMPHandler(ImageHandler):
2449 def __repr__(self):
2450 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2451 def __init__(self, *args, **kwargs):
2452 """__init__(self) -> BMPHandler"""
2453 newobj = _core_.new_BMPHandler(*args, **kwargs)
2454 self.this = newobj.this
2455 self.thisown = 1
2456 del newobj.thisown
2457
2458class BMPHandlerPtr(BMPHandler):
2459 def __init__(self, this):
2460 self.this = this
2461 if not hasattr(self,"thisown"): self.thisown = 0
2462 self.__class__ = BMPHandler
2463_core_.BMPHandler_swigregister(BMPHandlerPtr)
2464NullImage = cvar.NullImage
2465IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2466IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2467IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2468IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2469IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2470
2471class ICOHandler(BMPHandler):
2472 def __repr__(self):
2473 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2474 def __init__(self, *args, **kwargs):
2475 """__init__(self) -> ICOHandler"""
2476 newobj = _core_.new_ICOHandler(*args, **kwargs)
2477 self.this = newobj.this
2478 self.thisown = 1
2479 del newobj.thisown
2480
2481class ICOHandlerPtr(ICOHandler):
2482 def __init__(self, this):
2483 self.this = this
2484 if not hasattr(self,"thisown"): self.thisown = 0
2485 self.__class__ = ICOHandler
2486_core_.ICOHandler_swigregister(ICOHandlerPtr)
2487
2488class CURHandler(ICOHandler):
2489 def __repr__(self):
2490 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2491 def __init__(self, *args, **kwargs):
2492 """__init__(self) -> CURHandler"""
2493 newobj = _core_.new_CURHandler(*args, **kwargs)
2494 self.this = newobj.this
2495 self.thisown = 1
2496 del newobj.thisown
2497
2498class CURHandlerPtr(CURHandler):
2499 def __init__(self, this):
2500 self.this = this
2501 if not hasattr(self,"thisown"): self.thisown = 0
2502 self.__class__ = CURHandler
2503_core_.CURHandler_swigregister(CURHandlerPtr)
2504
2505class ANIHandler(CURHandler):
2506 def __repr__(self):
2507 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2508 def __init__(self, *args, **kwargs):
2509 """__init__(self) -> ANIHandler"""
2510 newobj = _core_.new_ANIHandler(*args, **kwargs)
2511 self.this = newobj.this
2512 self.thisown = 1
2513 del newobj.thisown
2514
2515class ANIHandlerPtr(ANIHandler):
2516 def __init__(self, this):
2517 self.this = this
2518 if not hasattr(self,"thisown"): self.thisown = 0
2519 self.__class__ = ANIHandler
2520_core_.ANIHandler_swigregister(ANIHandlerPtr)
2521
2522class PNGHandler(ImageHandler):
2523 def __repr__(self):
2524 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2525 def __init__(self, *args, **kwargs):
2526 """__init__(self) -> PNGHandler"""
2527 newobj = _core_.new_PNGHandler(*args, **kwargs)
2528 self.this = newobj.this
2529 self.thisown = 1
2530 del newobj.thisown
2531
2532class PNGHandlerPtr(PNGHandler):
2533 def __init__(self, this):
2534 self.this = this
2535 if not hasattr(self,"thisown"): self.thisown = 0
2536 self.__class__ = PNGHandler
2537_core_.PNGHandler_swigregister(PNGHandlerPtr)
2538
2539class GIFHandler(ImageHandler):
2540 def __repr__(self):
2541 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2542 def __init__(self, *args, **kwargs):
2543 """__init__(self) -> GIFHandler"""
2544 newobj = _core_.new_GIFHandler(*args, **kwargs)
2545 self.this = newobj.this
2546 self.thisown = 1
2547 del newobj.thisown
2548
2549class GIFHandlerPtr(GIFHandler):
2550 def __init__(self, this):
2551 self.this = this
2552 if not hasattr(self,"thisown"): self.thisown = 0
2553 self.__class__ = GIFHandler
2554_core_.GIFHandler_swigregister(GIFHandlerPtr)
2555
2556class PCXHandler(ImageHandler):
2557 def __repr__(self):
2558 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2559 def __init__(self, *args, **kwargs):
2560 """__init__(self) -> PCXHandler"""
2561 newobj = _core_.new_PCXHandler(*args, **kwargs)
2562 self.this = newobj.this
2563 self.thisown = 1
2564 del newobj.thisown
2565
2566class PCXHandlerPtr(PCXHandler):
2567 def __init__(self, this):
2568 self.this = this
2569 if not hasattr(self,"thisown"): self.thisown = 0
2570 self.__class__ = PCXHandler
2571_core_.PCXHandler_swigregister(PCXHandlerPtr)
2572
2573class JPEGHandler(ImageHandler):
2574 def __repr__(self):
2575 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2576 def __init__(self, *args, **kwargs):
2577 """__init__(self) -> JPEGHandler"""
2578 newobj = _core_.new_JPEGHandler(*args, **kwargs)
2579 self.this = newobj.this
2580 self.thisown = 1
2581 del newobj.thisown
2582
2583class JPEGHandlerPtr(JPEGHandler):
2584 def __init__(self, this):
2585 self.this = this
2586 if not hasattr(self,"thisown"): self.thisown = 0
2587 self.__class__ = JPEGHandler
2588_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
2589
2590class PNMHandler(ImageHandler):
2591 def __repr__(self):
2592 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2593 def __init__(self, *args, **kwargs):
2594 """__init__(self) -> PNMHandler"""
2595 newobj = _core_.new_PNMHandler(*args, **kwargs)
2596 self.this = newobj.this
2597 self.thisown = 1
2598 del newobj.thisown
2599
2600class PNMHandlerPtr(PNMHandler):
2601 def __init__(self, this):
2602 self.this = this
2603 if not hasattr(self,"thisown"): self.thisown = 0
2604 self.__class__ = PNMHandler
2605_core_.PNMHandler_swigregister(PNMHandlerPtr)
2606
2607class XPMHandler(ImageHandler):
2608 def __repr__(self):
2609 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2610 def __init__(self, *args, **kwargs):
2611 """__init__(self) -> XPMHandler"""
2612 newobj = _core_.new_XPMHandler(*args, **kwargs)
2613 self.this = newobj.this
2614 self.thisown = 1
2615 del newobj.thisown
2616
2617class XPMHandlerPtr(XPMHandler):
2618 def __init__(self, this):
2619 self.this = this
2620 if not hasattr(self,"thisown"): self.thisown = 0
2621 self.__class__ = XPMHandler
2622_core_.XPMHandler_swigregister(XPMHandlerPtr)
2623
2624class TIFFHandler(ImageHandler):
2625 def __repr__(self):
2626 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2627 def __init__(self, *args, **kwargs):
2628 """__init__(self) -> TIFFHandler"""
2629 newobj = _core_.new_TIFFHandler(*args, **kwargs)
2630 self.this = newobj.this
2631 self.thisown = 1
2632 del newobj.thisown
2633
2634class TIFFHandlerPtr(TIFFHandler):
2635 def __init__(self, this):
2636 self.this = this
2637 if not hasattr(self,"thisown"): self.thisown = 0
2638 self.__class__ = TIFFHandler
2639_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
2640
c0de73ae
RD
2641QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2642QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2643class Quantize(object):
2644 """Performs quantization, or colour reduction, on a wxImage."""
2645 def __init__(self): raise RuntimeError, "No constructor defined"
2646 def __repr__(self):
2647 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2648 def Quantize(*args, **kwargs):
2649 """
2650 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2651
2652 Reduce the colours in the source image and put the result into the
2653 destination image, setting the palette in the destination if
2654 needed. Both images may be the same, to overwrite the source image.
2655 """
2656 return _core_.Quantize_Quantize(*args, **kwargs)
2657
2658 Quantize = staticmethod(Quantize)
2659
2660class QuantizePtr(Quantize):
2661 def __init__(self, this):
2662 self.this = this
2663 if not hasattr(self,"thisown"): self.thisown = 0
2664 self.__class__ = Quantize
2665_core_.Quantize_swigregister(QuantizePtr)
2666
2667def Quantize_Quantize(*args, **kwargs):
2668 """
2669 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2670
2671 Reduce the colours in the source image and put the result into the
2672 destination image, setting the palette in the destination if
2673 needed. Both images may be the same, to overwrite the source image.
2674 """
2675 return _core_.Quantize_Quantize(*args, **kwargs)
2676
d55e5bfc
RD
2677#---------------------------------------------------------------------------
2678
2679class EvtHandler(Object):
2680 def __repr__(self):
2681 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2682 def __init__(self, *args, **kwargs):
2683 """__init__(self) -> EvtHandler"""
2684 newobj = _core_.new_EvtHandler(*args, **kwargs)
2685 self.this = newobj.this
2686 self.thisown = 1
2687 del newobj.thisown
2688 def GetNextHandler(*args, **kwargs):
2689 """GetNextHandler(self) -> EvtHandler"""
2690 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
2691
2692 def GetPreviousHandler(*args, **kwargs):
2693 """GetPreviousHandler(self) -> EvtHandler"""
2694 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
2695
2696 def SetNextHandler(*args, **kwargs):
2697 """SetNextHandler(self, EvtHandler handler)"""
2698 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
2699
2700 def SetPreviousHandler(*args, **kwargs):
2701 """SetPreviousHandler(self, EvtHandler handler)"""
2702 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
2703
2704 def GetEvtHandlerEnabled(*args, **kwargs):
2705 """GetEvtHandlerEnabled(self) -> bool"""
2706 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
2707
2708 def SetEvtHandlerEnabled(*args, **kwargs):
2709 """SetEvtHandlerEnabled(self, bool enabled)"""
2710 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
2711
2712 def ProcessEvent(*args, **kwargs):
2713 """ProcessEvent(self, Event event) -> bool"""
2714 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
2715
2716 def AddPendingEvent(*args, **kwargs):
2717 """AddPendingEvent(self, Event event)"""
2718 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
2719
2720 def ProcessPendingEvents(*args, **kwargs):
2721 """ProcessPendingEvents(self)"""
2722 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
2723
2724 def Connect(*args, **kwargs):
2725 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
2726 return _core_.EvtHandler_Connect(*args, **kwargs)
2727
2728 def Disconnect(*args, **kwargs):
2729 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
2730 return _core_.EvtHandler_Disconnect(*args, **kwargs)
2731
2732 def _setOORInfo(*args, **kwargs):
2733 """_setOORInfo(self, PyObject _self)"""
2734 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
2735
2736 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2737 """
2738 Bind an event to an event handler.
2739
caef1a4d
RD
2740 :param event: One of the EVT_* objects that specifies the
2741 type of event to bind,
d55e5bfc 2742
caef1a4d
RD
2743 :param handler: A callable object to be invoked when the
2744 event is delivered to self. Pass None to
2745 disconnect an event handler.
d55e5bfc 2746
caef1a4d
RD
2747 :param source: Sometimes the event originates from a
2748 different window than self, but you still
2749 want to catch it in self. (For example, a
2750 button event delivered to a frame.) By
2751 passing the source of the event, the event
2752 handling system is able to differentiate
2753 between the same event type from different
2754 controls.
d55e5bfc 2755
caef1a4d
RD
2756 :param id: Used to spcify the event source by ID instead
2757 of instance.
2758
2759 :param id2: Used when it is desirable to bind a handler
2760 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
2761 """
2762 if source is not None:
2763 id = source.GetId()
2764 event.Bind(self, id, id2, handler)
2765
c24da6d6
RD
2766 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2767 """
2768 Disconencts the event handler binding for event from self.
2769 Returns True if successful.
2770 """
2771 if source is not None:
2772 id = source.GetId()
2773 return event.Unbind(self, id, id2)
d55e5bfc
RD
2774
2775
2776class EvtHandlerPtr(EvtHandler):
2777 def __init__(self, this):
2778 self.this = this
2779 if not hasattr(self,"thisown"): self.thisown = 0
2780 self.__class__ = EvtHandler
2781_core_.EvtHandler_swigregister(EvtHandlerPtr)
2782
2783#---------------------------------------------------------------------------
2784
2785class PyEventBinder(object):
2786 """
2787 Instances of this class are used to bind specific events to event
2788 handlers.
2789 """
2790 def __init__(self, evtType, expectedIDs=0):
2791 if expectedIDs not in [0, 1, 2]:
2792 raise ValueError, "Invalid number of expectedIDs"
2793 self.expectedIDs = expectedIDs
2794
2795 if type(evtType) == list or type(evtType) == tuple:
2796 self.evtType = evtType
2797 else:
2798 self.evtType = [evtType]
2799
2800
2801 def Bind(self, target, id1, id2, function):
2802 """Bind this set of event types to target."""
2803 for et in self.evtType:
2804 target.Connect(id1, id2, et, function)
2805
c24da6d6
RD
2806
2807 def Unbind(self, target, id1, id2):
2808 """Remove an event binding."""
2809 success = 0
2810 for et in self.evtType:
2811 success += target.Disconnect(id1, id2, et)
2812 return success != 0
2813
d55e5bfc
RD
2814
2815 def __call__(self, *args):
2816 """
2817 For backwards compatibility with the old EVT_* functions.
2818 Should be called with either (window, func), (window, ID,
2819 func) or (window, ID1, ID2, func) parameters depending on the
2820 type of the event.
2821 """
2822 assert len(args) == 2 + self.expectedIDs
2823 id1 = wx.ID_ANY
2824 id2 = wx.ID_ANY
2825 target = args[0]
2826 if self.expectedIDs == 0:
2827 func = args[1]
2828 elif self.expectedIDs == 1:
2829 id1 = args[1]
2830 func = args[2]
2831 elif self.expectedIDs == 2:
2832 id1 = args[1]
2833 id2 = args[2]
2834 func = args[3]
2835 else:
2836 raise ValueError, "Unexpected number of IDs"
2837
2838 self.Bind(target, id1, id2, func)
2839
2840
2841# These two are square pegs that don't fit the PyEventBinder hole...
2842def EVT_COMMAND(win, id, cmd, func):
2843 win.Connect(id, -1, cmd, func)
2844def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2845 win.Connect(id1, id2, cmd, func)
2846
2847
2848#---------------------------------------------------------------------------
2849
2850#---------------------------------------------------------------------------
2851
2852EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2853EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
2854
2855def NewEventType(*args, **kwargs):
2856 """NewEventType() -> wxEventType"""
2857 return _core_.NewEventType(*args, **kwargs)
2858wxEVT_NULL = _core_.wxEVT_NULL
2859wxEVT_FIRST = _core_.wxEVT_FIRST
2860wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2861wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2862wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2863wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2864wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2865wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2866wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2867wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2868wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2869wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2870wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2871wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2872wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2873wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2874wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2875wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2876wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2877wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2878wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2879wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2880wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2881wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2882wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2883wxEVT_MOTION = _core_.wxEVT_MOTION
2884wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2885wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2886wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2887wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2888wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2889wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2890wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2891wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2892wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2893wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2894wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2895wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2896wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2897wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2898wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2899wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2900wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2901wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2902wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2903wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2904wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2905wxEVT_CHAR = _core_.wxEVT_CHAR
2906wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2907wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2908wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2909wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2910wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2911wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2912wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2913wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2914wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2915wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2916wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2917wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2918wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2919wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2920wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2921wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2922wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2923wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2924wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2925wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2926wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2927wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2928wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2929wxEVT_SIZE = _core_.wxEVT_SIZE
2930wxEVT_MOVE = _core_.wxEVT_MOVE
2931wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2932wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2933wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2934wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2935wxEVT_POWER = _core_.wxEVT_POWER
2936wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2937wxEVT_CREATE = _core_.wxEVT_CREATE
2938wxEVT_DESTROY = _core_.wxEVT_DESTROY
2939wxEVT_SHOW = _core_.wxEVT_SHOW
2940wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2941wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2942wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2943wxEVT_PAINT = _core_.wxEVT_PAINT
2944wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2945wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2946wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2947wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2948wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2949wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2950wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2951wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2952wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2953wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2954wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2955wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2956wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2957wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2958wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2959wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2960wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2961wxEVT_IDLE = _core_.wxEVT_IDLE
2962wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2963wxEVT_SIZING = _core_.wxEVT_SIZING
2964wxEVT_MOVING = _core_.wxEVT_MOVING
2965wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2966wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2967wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2968wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2969wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2970wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2971wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
2972#
2973# Create some event binders
2974EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2975EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2976EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2977EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2978EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2979EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2980EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2981EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2982EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2983EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2984EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2985EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2986EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2987EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2988EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2989EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2990EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2991EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2992EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2993EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2994EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2995EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2996EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2997EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2998EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2999EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
3000EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
3001EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
3002EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
3003EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
3004EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
3005EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
3006EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
3007EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
3008EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
3009EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
3010EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
3011EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
3012EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
3013EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
3014
3015EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
3016EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
3017EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
3018EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
3019EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
3020EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
3021EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
3022EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
3023EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
3024EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
3025EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
3026EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
3027EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
3028
3029EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
3030 wxEVT_LEFT_UP,
3031 wxEVT_MIDDLE_DOWN,
3032 wxEVT_MIDDLE_UP,
3033 wxEVT_RIGHT_DOWN,
3034 wxEVT_RIGHT_UP,
3035 wxEVT_MOTION,
3036 wxEVT_LEFT_DCLICK,
3037 wxEVT_MIDDLE_DCLICK,
3038 wxEVT_RIGHT_DCLICK,
3039 wxEVT_ENTER_WINDOW,
3040 wxEVT_LEAVE_WINDOW,
3041 wxEVT_MOUSEWHEEL
3042 ])
3043
3044
3045# Scrolling from wxWindow (sent to wxScrolledWindow)
3046EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3047 wxEVT_SCROLLWIN_BOTTOM,
3048 wxEVT_SCROLLWIN_LINEUP,
3049 wxEVT_SCROLLWIN_LINEDOWN,
3050 wxEVT_SCROLLWIN_PAGEUP,
3051 wxEVT_SCROLLWIN_PAGEDOWN,
3052 wxEVT_SCROLLWIN_THUMBTRACK,
3053 wxEVT_SCROLLWIN_THUMBRELEASE,
3054 ])
3055
3056EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3057EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3058EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3059EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3060EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3061EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3062EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3063EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3064
3065# Scrolling from wxSlider and wxScrollBar
3066EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3067 wxEVT_SCROLL_BOTTOM,
3068 wxEVT_SCROLL_LINEUP,
3069 wxEVT_SCROLL_LINEDOWN,
3070 wxEVT_SCROLL_PAGEUP,
3071 wxEVT_SCROLL_PAGEDOWN,
3072 wxEVT_SCROLL_THUMBTRACK,
3073 wxEVT_SCROLL_THUMBRELEASE,
3074 wxEVT_SCROLL_ENDSCROLL,
3075 ])
3076
3077EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3078EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3079EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3080EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3081EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3082EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3083EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3084EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3085EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3086
3087# Scrolling from wxSlider and wxScrollBar, with an id
3088EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3089 wxEVT_SCROLL_BOTTOM,
3090 wxEVT_SCROLL_LINEUP,
3091 wxEVT_SCROLL_LINEDOWN,
3092 wxEVT_SCROLL_PAGEUP,
3093 wxEVT_SCROLL_PAGEDOWN,
3094 wxEVT_SCROLL_THUMBTRACK,
3095 wxEVT_SCROLL_THUMBRELEASE,
3096 wxEVT_SCROLL_ENDSCROLL,
3097 ], 1)
3098
3099EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3100EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3101EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3102EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3103EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3104EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3105EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3106EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3107EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3108
3109EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3110EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3111EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3112EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3113EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3114EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3115EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3116EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3117EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3118EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3119
3120EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3121EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3122EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3123EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3124EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3125EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3126EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3127EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3128EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3129
3130
3131EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3132EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3133EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3134EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3135EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3136EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3137EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3138
3139EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3140
3141EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3142EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3143
3144EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3145
3146
3147
3148#---------------------------------------------------------------------------
3149
3150class Event(Object):
3151 def __init__(self): raise RuntimeError, "No constructor defined"
3152 def __repr__(self):
3153 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3154 def __del__(self, destroy=_core_.delete_Event):
3155 """__del__(self)"""
3156 try:
3157 if self.thisown: destroy(self)
3158 except: pass
3159
3160 def SetEventType(*args, **kwargs):
3161 """SetEventType(self, wxEventType typ)"""
3162 return _core_.Event_SetEventType(*args, **kwargs)
3163
3164 def GetEventType(*args, **kwargs):
3165 """GetEventType(self) -> wxEventType"""
3166 return _core_.Event_GetEventType(*args, **kwargs)
3167
3168 def GetEventObject(*args, **kwargs):
3169 """GetEventObject(self) -> Object"""
3170 return _core_.Event_GetEventObject(*args, **kwargs)
3171
3172 def SetEventObject(*args, **kwargs):
3173 """SetEventObject(self, Object obj)"""
3174 return _core_.Event_SetEventObject(*args, **kwargs)
3175
3176 def GetTimestamp(*args, **kwargs):
3177 """GetTimestamp(self) -> long"""
3178 return _core_.Event_GetTimestamp(*args, **kwargs)
3179
3180 def SetTimestamp(*args, **kwargs):
3181 """SetTimestamp(self, long ts=0)"""
3182 return _core_.Event_SetTimestamp(*args, **kwargs)
3183
3184 def GetId(*args, **kwargs):
3185 """GetId(self) -> int"""
3186 return _core_.Event_GetId(*args, **kwargs)
3187
3188 def SetId(*args, **kwargs):
3189 """SetId(self, int Id)"""
3190 return _core_.Event_SetId(*args, **kwargs)
3191
3192 def IsCommandEvent(*args, **kwargs):
3193 """IsCommandEvent(self) -> bool"""
3194 return _core_.Event_IsCommandEvent(*args, **kwargs)
3195
3196 def Skip(*args, **kwargs):
3197 """Skip(self, bool skip=True)"""
3198 return _core_.Event_Skip(*args, **kwargs)
3199
3200 def GetSkipped(*args, **kwargs):
3201 """GetSkipped(self) -> bool"""
3202 return _core_.Event_GetSkipped(*args, **kwargs)
3203
3204 def ShouldPropagate(*args, **kwargs):
3205 """ShouldPropagate(self) -> bool"""
3206 return _core_.Event_ShouldPropagate(*args, **kwargs)
3207
3208 def StopPropagation(*args, **kwargs):
3209 """StopPropagation(self) -> int"""
3210 return _core_.Event_StopPropagation(*args, **kwargs)
3211
3212 def ResumePropagation(*args, **kwargs):
3213 """ResumePropagation(self, int propagationLevel)"""
3214 return _core_.Event_ResumePropagation(*args, **kwargs)
3215
3216 def Clone(*args, **kwargs):
3217 """Clone(self) -> Event"""
3218 return _core_.Event_Clone(*args, **kwargs)
3219
3220
3221class EventPtr(Event):
3222 def __init__(self, this):
3223 self.this = this
3224 if not hasattr(self,"thisown"): self.thisown = 0
3225 self.__class__ = Event
3226_core_.Event_swigregister(EventPtr)
3227
3228#---------------------------------------------------------------------------
3229
3230class PropagationDisabler(object):
3231 def __repr__(self):
3232 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3233 def __init__(self, *args, **kwargs):
3234 """__init__(self, Event event) -> PropagationDisabler"""
3235 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
3236 self.this = newobj.this
3237 self.thisown = 1
3238 del newobj.thisown
3239 def __del__(self, destroy=_core_.delete_PropagationDisabler):
3240 """__del__(self)"""
3241 try:
3242 if self.thisown: destroy(self)
3243 except: pass
3244
3245
3246class PropagationDisablerPtr(PropagationDisabler):
3247 def __init__(self, this):
3248 self.this = this
3249 if not hasattr(self,"thisown"): self.thisown = 0
3250 self.__class__ = PropagationDisabler
3251_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
3252
3253class PropagateOnce(object):
3254 def __repr__(self):
3255 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3256 def __init__(self, *args, **kwargs):
3257 """__init__(self, Event event) -> PropagateOnce"""
3258 newobj = _core_.new_PropagateOnce(*args, **kwargs)
3259 self.this = newobj.this
3260 self.thisown = 1
3261 del newobj.thisown
3262 def __del__(self, destroy=_core_.delete_PropagateOnce):
3263 """__del__(self)"""
3264 try:
3265 if self.thisown: destroy(self)
3266 except: pass
3267
3268
3269class PropagateOncePtr(PropagateOnce):
3270 def __init__(self, this):
3271 self.this = this
3272 if not hasattr(self,"thisown"): self.thisown = 0
3273 self.__class__ = PropagateOnce
3274_core_.PropagateOnce_swigregister(PropagateOncePtr)
3275
3276#---------------------------------------------------------------------------
3277
3278class CommandEvent(Event):
3279 def __repr__(self):
3280 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3281 def __init__(self, *args, **kwargs):
3282 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
3283 newobj = _core_.new_CommandEvent(*args, **kwargs)
3284 self.this = newobj.this
3285 self.thisown = 1
3286 del newobj.thisown
3287 def GetSelection(*args, **kwargs):
3288 """GetSelection(self) -> int"""
3289 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3290
3291 def SetString(*args, **kwargs):
3292 """SetString(self, String s)"""
3293 return _core_.CommandEvent_SetString(*args, **kwargs)
3294
3295 def GetString(*args, **kwargs):
3296 """GetString(self) -> String"""
3297 return _core_.CommandEvent_GetString(*args, **kwargs)
3298
3299 def IsChecked(*args, **kwargs):
3300 """IsChecked(self) -> bool"""
3301 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3302
3303 Checked = IsChecked
3304 def IsSelection(*args, **kwargs):
3305 """IsSelection(self) -> bool"""
3306 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3307
3308 def SetExtraLong(*args, **kwargs):
3309 """SetExtraLong(self, long extraLong)"""
3310 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3311
3312 def GetExtraLong(*args, **kwargs):
3313 """GetExtraLong(self) -> long"""
3314 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3315
3316 def SetInt(*args, **kwargs):
3317 """SetInt(self, int i)"""
3318 return _core_.CommandEvent_SetInt(*args, **kwargs)
3319
3320 def GetInt(*args, **kwargs):
3321 """GetInt(self) -> long"""
3322 return _core_.CommandEvent_GetInt(*args, **kwargs)
3323
3324 def Clone(*args, **kwargs):
3325 """Clone(self) -> Event"""
3326 return _core_.CommandEvent_Clone(*args, **kwargs)
3327
3328
3329class CommandEventPtr(CommandEvent):
3330 def __init__(self, this):
3331 self.this = this
3332 if not hasattr(self,"thisown"): self.thisown = 0
3333 self.__class__ = CommandEvent
3334_core_.CommandEvent_swigregister(CommandEventPtr)
3335
3336#---------------------------------------------------------------------------
3337
3338class NotifyEvent(CommandEvent):
3339 def __repr__(self):
3340 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3341 def __init__(self, *args, **kwargs):
3342 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
3343 newobj = _core_.new_NotifyEvent(*args, **kwargs)
3344 self.this = newobj.this
3345 self.thisown = 1
3346 del newobj.thisown
3347 def Veto(*args, **kwargs):
3348 """Veto(self)"""
3349 return _core_.NotifyEvent_Veto(*args, **kwargs)
3350
3351 def Allow(*args, **kwargs):
3352 """Allow(self)"""
3353 return _core_.NotifyEvent_Allow(*args, **kwargs)
3354
3355 def IsAllowed(*args, **kwargs):
3356 """IsAllowed(self) -> bool"""
3357 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
3358
3359
3360class NotifyEventPtr(NotifyEvent):
3361 def __init__(self, this):
3362 self.this = this
3363 if not hasattr(self,"thisown"): self.thisown = 0
3364 self.__class__ = NotifyEvent
3365_core_.NotifyEvent_swigregister(NotifyEventPtr)
3366
3367#---------------------------------------------------------------------------
3368
3369class ScrollEvent(CommandEvent):
3370 def __repr__(self):
3371 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3372 def __init__(self, *args, **kwargs):
3373 """
3374 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
3375 int orient=0) -> ScrollEvent
3376 """
3377 newobj = _core_.new_ScrollEvent(*args, **kwargs)
3378 self.this = newobj.this
3379 self.thisown = 1
3380 del newobj.thisown
3381 def GetOrientation(*args, **kwargs):
3382 """GetOrientation(self) -> int"""
3383 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
3384
3385 def GetPosition(*args, **kwargs):
3386 """GetPosition(self) -> int"""
3387 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
3388
3389 def SetOrientation(*args, **kwargs):
3390 """SetOrientation(self, int orient)"""
3391 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
3392
3393 def SetPosition(*args, **kwargs):
3394 """SetPosition(self, int pos)"""
3395 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
3396
3397
3398class ScrollEventPtr(ScrollEvent):
3399 def __init__(self, this):
3400 self.this = this
3401 if not hasattr(self,"thisown"): self.thisown = 0
3402 self.__class__ = ScrollEvent
3403_core_.ScrollEvent_swigregister(ScrollEventPtr)
3404
3405#---------------------------------------------------------------------------
3406
3407class ScrollWinEvent(Event):
3408 def __repr__(self):
3409 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3410 def __init__(self, *args, **kwargs):
3411 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
3412 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
3413 self.this = newobj.this
3414 self.thisown = 1
3415 del newobj.thisown
3416 def GetOrientation(*args, **kwargs):
3417 """GetOrientation(self) -> int"""
3418 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
3419
3420 def GetPosition(*args, **kwargs):
3421 """GetPosition(self) -> int"""
3422 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
3423
3424 def SetOrientation(*args, **kwargs):
3425 """SetOrientation(self, int orient)"""
3426 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
3427
3428 def SetPosition(*args, **kwargs):
3429 """SetPosition(self, int pos)"""
3430 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
3431
3432
3433class ScrollWinEventPtr(ScrollWinEvent):
3434 def __init__(self, this):
3435 self.this = this
3436 if not hasattr(self,"thisown"): self.thisown = 0
3437 self.__class__ = ScrollWinEvent
3438_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
3439
3440#---------------------------------------------------------------------------
3441
3442MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3443MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3444MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3445MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3446MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
3447class MouseEvent(Event):
3448 def __repr__(self):
3449 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3450 def __init__(self, *args, **kwargs):
3451 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
3452 newobj = _core_.new_MouseEvent(*args, **kwargs)
3453 self.this = newobj.this
3454 self.thisown = 1
3455 del newobj.thisown
3456 def IsButton(*args, **kwargs):
3457 """IsButton(self) -> bool"""
3458 return _core_.MouseEvent_IsButton(*args, **kwargs)
3459
3460 def ButtonDown(*args, **kwargs):
3461 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
3462 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
3463
3464 def ButtonDClick(*args, **kwargs):
3465 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
3466 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
3467
3468 def ButtonUp(*args, **kwargs):
3469 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
3470 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
3471
3472 def Button(*args, **kwargs):
3473 """Button(self, int but) -> bool"""
3474 return _core_.MouseEvent_Button(*args, **kwargs)
3475
3476 def ButtonIsDown(*args, **kwargs):
3477 """ButtonIsDown(self, int but) -> bool"""
3478 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
3479
3480 def GetButton(*args, **kwargs):
3481 """GetButton(self) -> int"""
3482 return _core_.MouseEvent_GetButton(*args, **kwargs)
3483
3484 def ControlDown(*args, **kwargs):
3485 """ControlDown(self) -> bool"""
3486 return _core_.MouseEvent_ControlDown(*args, **kwargs)
3487
3488 def MetaDown(*args, **kwargs):
3489 """MetaDown(self) -> bool"""
3490 return _core_.MouseEvent_MetaDown(*args, **kwargs)
3491
3492 def AltDown(*args, **kwargs):
3493 """AltDown(self) -> bool"""
3494 return _core_.MouseEvent_AltDown(*args, **kwargs)
3495
3496 def ShiftDown(*args, **kwargs):
3497 """ShiftDown(self) -> bool"""
3498 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
3499
412d302d
RD
3500 def CmdDown(*args, **kwargs):
3501 """
3502 CmdDown(self) -> bool
3503
3504 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3505 platforms but the special "Apple" (a.k.a as "Command") key on
3506 Macs: it makes often sense to use it instead of, say, `ControlDown`
3507 because Cmd key is used for the same thing under Mac as Ctrl
3508 elsewhere. The Ctrl still exists, it's just not used for this
3509 purpose. So for non-Mac platforms this is the same as `ControlDown`
3510 and Macs this is the same as `MetaDown`.
3511 """
3512 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3513
d55e5bfc
RD
3514 def LeftDown(*args, **kwargs):
3515 """LeftDown(self) -> bool"""
3516 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3517
3518 def MiddleDown(*args, **kwargs):
3519 """MiddleDown(self) -> bool"""
3520 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3521
3522 def RightDown(*args, **kwargs):
3523 """RightDown(self) -> bool"""
3524 return _core_.MouseEvent_RightDown(*args, **kwargs)
3525
3526 def LeftUp(*args, **kwargs):
3527 """LeftUp(self) -> bool"""
3528 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3529
3530 def MiddleUp(*args, **kwargs):
3531 """MiddleUp(self) -> bool"""
3532 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3533
3534 def RightUp(*args, **kwargs):
3535 """RightUp(self) -> bool"""
3536 return _core_.MouseEvent_RightUp(*args, **kwargs)
3537
3538 def LeftDClick(*args, **kwargs):
3539 """LeftDClick(self) -> bool"""
3540 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3541
3542 def MiddleDClick(*args, **kwargs):
3543 """MiddleDClick(self) -> bool"""
3544 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3545
3546 def RightDClick(*args, **kwargs):
3547 """RightDClick(self) -> bool"""
3548 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3549
3550 def LeftIsDown(*args, **kwargs):
3551 """LeftIsDown(self) -> bool"""
3552 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3553
3554 def MiddleIsDown(*args, **kwargs):
3555 """MiddleIsDown(self) -> bool"""
3556 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3557
3558 def RightIsDown(*args, **kwargs):
3559 """RightIsDown(self) -> bool"""
3560 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3561
3562 def Dragging(*args, **kwargs):
3563 """Dragging(self) -> bool"""
3564 return _core_.MouseEvent_Dragging(*args, **kwargs)
3565
3566 def Moving(*args, **kwargs):
3567 """Moving(self) -> bool"""
3568 return _core_.MouseEvent_Moving(*args, **kwargs)
3569
3570 def Entering(*args, **kwargs):
3571 """Entering(self) -> bool"""
3572 return _core_.MouseEvent_Entering(*args, **kwargs)
3573
3574 def Leaving(*args, **kwargs):
3575 """Leaving(self) -> bool"""
3576 return _core_.MouseEvent_Leaving(*args, **kwargs)
3577
3578 def GetPosition(*args, **kwargs):
3579 """
3580 GetPosition(self) -> Point
3581
79fccf9d
RD
3582 Returns the position of the mouse in window coordinates when the event
3583 happened.
d55e5bfc
RD
3584 """
3585 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3586
3587 def GetPositionTuple(*args, **kwargs):
3588 """
3589 GetPositionTuple() -> (x,y)
3590
79fccf9d
RD
3591 Returns the position of the mouse in window coordinates when the event
3592 happened.
d55e5bfc
RD
3593 """
3594 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3595
3596 def GetLogicalPosition(*args, **kwargs):
3597 """GetLogicalPosition(self, DC dc) -> Point"""
3598 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3599
3600 def GetX(*args, **kwargs):
3601 """GetX(self) -> int"""
3602 return _core_.MouseEvent_GetX(*args, **kwargs)
3603
3604 def GetY(*args, **kwargs):
3605 """GetY(self) -> int"""
3606 return _core_.MouseEvent_GetY(*args, **kwargs)
3607
3608 def GetWheelRotation(*args, **kwargs):
3609 """GetWheelRotation(self) -> int"""
3610 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3611
3612 def GetWheelDelta(*args, **kwargs):
3613 """GetWheelDelta(self) -> int"""
3614 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3615
3616 def GetLinesPerAction(*args, **kwargs):
3617 """GetLinesPerAction(self) -> int"""
3618 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3619
3620 def IsPageScroll(*args, **kwargs):
3621 """IsPageScroll(self) -> bool"""
3622 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3623
3624 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3625 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3626 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3627 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3628 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3629 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3630 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3631 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3632 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3633 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3634 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3635 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3636
3637class MouseEventPtr(MouseEvent):
3638 def __init__(self, this):
3639 self.this = this
3640 if not hasattr(self,"thisown"): self.thisown = 0
3641 self.__class__ = MouseEvent
3642_core_.MouseEvent_swigregister(MouseEventPtr)
3643
3644#---------------------------------------------------------------------------
3645
3646class SetCursorEvent(Event):
3647 def __repr__(self):
3648 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3649 def __init__(self, *args, **kwargs):
3650 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3651 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3652 self.this = newobj.this
3653 self.thisown = 1
3654 del newobj.thisown
3655 def GetX(*args, **kwargs):
3656 """GetX(self) -> int"""
3657 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3658
3659 def GetY(*args, **kwargs):
3660 """GetY(self) -> int"""
3661 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3662
3663 def SetCursor(*args, **kwargs):
3664 """SetCursor(self, Cursor cursor)"""
3665 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3666
3667 def GetCursor(*args, **kwargs):
3668 """GetCursor(self) -> Cursor"""
3669 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3670
3671 def HasCursor(*args, **kwargs):
3672 """HasCursor(self) -> bool"""
3673 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3674
3675
3676class SetCursorEventPtr(SetCursorEvent):
3677 def __init__(self, this):
3678 self.this = this
3679 if not hasattr(self,"thisown"): self.thisown = 0
3680 self.__class__ = SetCursorEvent
3681_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3682
3683#---------------------------------------------------------------------------
3684
3685class KeyEvent(Event):
3686 def __repr__(self):
3687 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3688 def __init__(self, *args, **kwargs):
3689 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3690 newobj = _core_.new_KeyEvent(*args, **kwargs)
3691 self.this = newobj.this
3692 self.thisown = 1
3693 del newobj.thisown
3694 def ControlDown(*args, **kwargs):
3695 """ControlDown(self) -> bool"""
3696 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3697
3698 def MetaDown(*args, **kwargs):
3699 """MetaDown(self) -> bool"""
3700 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3701
3702 def AltDown(*args, **kwargs):
3703 """AltDown(self) -> bool"""
3704 return _core_.KeyEvent_AltDown(*args, **kwargs)
3705
3706 def ShiftDown(*args, **kwargs):
3707 """ShiftDown(self) -> bool"""
3708 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3709
412d302d
RD
3710 def CmdDown(*args, **kwargs):
3711 """
3712 CmdDown(self) -> bool
3713
3714 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3715 platforms but the special "Apple" (a.k.a as "Command") key on
3716 Macs: it makes often sense to use it instead of, say, `ControlDown`
3717 because Cmd key is used for the same thing under Mac as Ctrl
3718 elsewhere. The Ctrl still exists, it's just not used for this
3719 purpose. So for non-Mac platforms this is the same as `ControlDown`
3720 and Macs this is the same as `MetaDown`.
3721 """
3722 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3723
d55e5bfc
RD
3724 def HasModifiers(*args, **kwargs):
3725 """HasModifiers(self) -> bool"""
3726 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3727
3728 def GetKeyCode(*args, **kwargs):
3729 """GetKeyCode(self) -> int"""
3730 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3731
3732 KeyCode = GetKeyCode
19272049
RD
3733 def GetUnicodeKey(*args, **kwargs):
3734 """GetUnicodeKey(self) -> int"""
3735 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 3736
19272049 3737 GetUniChar = GetUnicodeKey
d55e5bfc
RD
3738 def GetRawKeyCode(*args, **kwargs):
3739 """GetRawKeyCode(self) -> unsigned int"""
3740 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3741
3742 def GetRawKeyFlags(*args, **kwargs):
3743 """GetRawKeyFlags(self) -> unsigned int"""
3744 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3745
3746 def GetPosition(*args, **kwargs):
3747 """
3748 GetPosition(self) -> Point
3749
3750 Find the position of the event.
3751 """
3752 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3753
3754 def GetPositionTuple(*args, **kwargs):
3755 """
3756 GetPositionTuple() -> (x,y)
3757
3758 Find the position of the event.
3759 """
3760 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3761
3762 def GetX(*args, **kwargs):
3763 """GetX(self) -> int"""
3764 return _core_.KeyEvent_GetX(*args, **kwargs)
3765
3766 def GetY(*args, **kwargs):
3767 """GetY(self) -> int"""
3768 return _core_.KeyEvent_GetY(*args, **kwargs)
3769
3770 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3771 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3772 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3773 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3774 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3775 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3776 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3777 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3778 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3779 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3780
3781class KeyEventPtr(KeyEvent):
3782 def __init__(self, this):
3783 self.this = this
3784 if not hasattr(self,"thisown"): self.thisown = 0
3785 self.__class__ = KeyEvent
3786_core_.KeyEvent_swigregister(KeyEventPtr)
3787
3788#---------------------------------------------------------------------------
3789
3790class SizeEvent(Event):
3791 def __repr__(self):
3792 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3793 def __init__(self, *args, **kwargs):
3794 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3795 newobj = _core_.new_SizeEvent(*args, **kwargs)
3796 self.this = newobj.this
3797 self.thisown = 1
3798 del newobj.thisown
3799 def GetSize(*args, **kwargs):
3800 """GetSize(self) -> Size"""
3801 return _core_.SizeEvent_GetSize(*args, **kwargs)
3802
3803 def GetRect(*args, **kwargs):
3804 """GetRect(self) -> Rect"""
3805 return _core_.SizeEvent_GetRect(*args, **kwargs)
3806
3807 def SetRect(*args, **kwargs):
3808 """SetRect(self, Rect rect)"""
3809 return _core_.SizeEvent_SetRect(*args, **kwargs)
3810
3811 def SetSize(*args, **kwargs):
3812 """SetSize(self, Size size)"""
3813 return _core_.SizeEvent_SetSize(*args, **kwargs)
3814
3815 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3816 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
3817
3818class SizeEventPtr(SizeEvent):
3819 def __init__(self, this):
3820 self.this = this
3821 if not hasattr(self,"thisown"): self.thisown = 0
3822 self.__class__ = SizeEvent
3823_core_.SizeEvent_swigregister(SizeEventPtr)
3824
3825#---------------------------------------------------------------------------
3826
3827class MoveEvent(Event):
3828 def __repr__(self):
3829 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3830 def __init__(self, *args, **kwargs):
3831 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
3832 newobj = _core_.new_MoveEvent(*args, **kwargs)
3833 self.this = newobj.this
3834 self.thisown = 1
3835 del newobj.thisown
3836 def GetPosition(*args, **kwargs):
3837 """GetPosition(self) -> Point"""
3838 return _core_.MoveEvent_GetPosition(*args, **kwargs)
3839
3840 def GetRect(*args, **kwargs):
3841 """GetRect(self) -> Rect"""
3842 return _core_.MoveEvent_GetRect(*args, **kwargs)
3843
3844 def SetRect(*args, **kwargs):
3845 """SetRect(self, Rect rect)"""
3846 return _core_.MoveEvent_SetRect(*args, **kwargs)
3847
3848 def SetPosition(*args, **kwargs):
3849 """SetPosition(self, Point pos)"""
3850 return _core_.MoveEvent_SetPosition(*args, **kwargs)
3851
3852 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3853 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
3854
3855class MoveEventPtr(MoveEvent):
3856 def __init__(self, this):
3857 self.this = this
3858 if not hasattr(self,"thisown"): self.thisown = 0
3859 self.__class__ = MoveEvent
3860_core_.MoveEvent_swigregister(MoveEventPtr)
3861
3862#---------------------------------------------------------------------------
3863
3864class PaintEvent(Event):
3865 def __repr__(self):
3866 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3867 def __init__(self, *args, **kwargs):
3868 """__init__(self, int Id=0) -> PaintEvent"""
3869 newobj = _core_.new_PaintEvent(*args, **kwargs)
3870 self.this = newobj.this
3871 self.thisown = 1
3872 del newobj.thisown
3873
3874class PaintEventPtr(PaintEvent):
3875 def __init__(self, this):
3876 self.this = this
3877 if not hasattr(self,"thisown"): self.thisown = 0
3878 self.__class__ = PaintEvent
3879_core_.PaintEvent_swigregister(PaintEventPtr)
3880
3881class NcPaintEvent(Event):
3882 def __repr__(self):
3883 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3884 def __init__(self, *args, **kwargs):
3885 """__init__(self, int winid=0) -> NcPaintEvent"""
3886 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
3887 self.this = newobj.this
3888 self.thisown = 1
3889 del newobj.thisown
3890
3891class NcPaintEventPtr(NcPaintEvent):
3892 def __init__(self, this):
3893 self.this = this
3894 if not hasattr(self,"thisown"): self.thisown = 0
3895 self.__class__ = NcPaintEvent
3896_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
3897
3898#---------------------------------------------------------------------------
3899
3900class EraseEvent(Event):
3901 def __repr__(self):
3902 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3903 def __init__(self, *args, **kwargs):
3904 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
3905 newobj = _core_.new_EraseEvent(*args, **kwargs)
3906 self.this = newobj.this
3907 self.thisown = 1
3908 del newobj.thisown
3909 def GetDC(*args, **kwargs):
3910 """GetDC(self) -> DC"""
3911 return _core_.EraseEvent_GetDC(*args, **kwargs)
3912
3913
3914class EraseEventPtr(EraseEvent):
3915 def __init__(self, this):
3916 self.this = this
3917 if not hasattr(self,"thisown"): self.thisown = 0
3918 self.__class__ = EraseEvent
3919_core_.EraseEvent_swigregister(EraseEventPtr)
3920
3921#---------------------------------------------------------------------------
3922
3923class FocusEvent(Event):
3924 def __repr__(self):
3925 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3926 def __init__(self, *args, **kwargs):
3927 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
3928 newobj = _core_.new_FocusEvent(*args, **kwargs)
3929 self.this = newobj.this
3930 self.thisown = 1
3931 del newobj.thisown
3932 def GetWindow(*args, **kwargs):
3933 """GetWindow(self) -> Window"""
3934 return _core_.FocusEvent_GetWindow(*args, **kwargs)
3935
3936 def SetWindow(*args, **kwargs):
3937 """SetWindow(self, Window win)"""
3938 return _core_.FocusEvent_SetWindow(*args, **kwargs)
3939
3940
3941class FocusEventPtr(FocusEvent):
3942 def __init__(self, this):
3943 self.this = this
3944 if not hasattr(self,"thisown"): self.thisown = 0
3945 self.__class__ = FocusEvent
3946_core_.FocusEvent_swigregister(FocusEventPtr)
3947
3948#---------------------------------------------------------------------------
3949
3950class ChildFocusEvent(CommandEvent):
3951 def __repr__(self):
3952 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3953 def __init__(self, *args, **kwargs):
3954 """__init__(self, Window win=None) -> ChildFocusEvent"""
3955 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
3956 self.this = newobj.this
3957 self.thisown = 1
3958 del newobj.thisown
3959 def GetWindow(*args, **kwargs):
3960 """GetWindow(self) -> Window"""
3961 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
3962
3963
3964class ChildFocusEventPtr(ChildFocusEvent):
3965 def __init__(self, this):
3966 self.this = this
3967 if not hasattr(self,"thisown"): self.thisown = 0
3968 self.__class__ = ChildFocusEvent
3969_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
3970
3971#---------------------------------------------------------------------------
3972
3973class ActivateEvent(Event):
3974 def __repr__(self):
3975 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3976 def __init__(self, *args, **kwargs):
3977 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
3978 newobj = _core_.new_ActivateEvent(*args, **kwargs)
3979 self.this = newobj.this
3980 self.thisown = 1
3981 del newobj.thisown
3982 def GetActive(*args, **kwargs):
3983 """GetActive(self) -> bool"""
3984 return _core_.ActivateEvent_GetActive(*args, **kwargs)
3985
3986
3987class ActivateEventPtr(ActivateEvent):
3988 def __init__(self, this):
3989 self.this = this
3990 if not hasattr(self,"thisown"): self.thisown = 0
3991 self.__class__ = ActivateEvent
3992_core_.ActivateEvent_swigregister(ActivateEventPtr)
3993
3994#---------------------------------------------------------------------------
3995
3996class InitDialogEvent(Event):
3997 def __repr__(self):
3998 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3999 def __init__(self, *args, **kwargs):
4000 """__init__(self, int Id=0) -> InitDialogEvent"""
4001 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
4002 self.this = newobj.this
4003 self.thisown = 1
4004 del newobj.thisown
4005
4006class InitDialogEventPtr(InitDialogEvent):
4007 def __init__(self, this):
4008 self.this = this
4009 if not hasattr(self,"thisown"): self.thisown = 0
4010 self.__class__ = InitDialogEvent
4011_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
4012
4013#---------------------------------------------------------------------------
4014
4015class MenuEvent(Event):
4016 def __repr__(self):
4017 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4018 def __init__(self, *args, **kwargs):
4019 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
4020 newobj = _core_.new_MenuEvent(*args, **kwargs)
4021 self.this = newobj.this
4022 self.thisown = 1
4023 del newobj.thisown
4024 def GetMenuId(*args, **kwargs):
4025 """GetMenuId(self) -> int"""
4026 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
4027
4028 def IsPopup(*args, **kwargs):
4029 """IsPopup(self) -> bool"""
4030 return _core_.MenuEvent_IsPopup(*args, **kwargs)
4031
4032 def GetMenu(*args, **kwargs):
4033 """GetMenu(self) -> Menu"""
4034 return _core_.MenuEvent_GetMenu(*args, **kwargs)
4035
4036
4037class MenuEventPtr(MenuEvent):
4038 def __init__(self, this):
4039 self.this = this
4040 if not hasattr(self,"thisown"): self.thisown = 0
4041 self.__class__ = MenuEvent
4042_core_.MenuEvent_swigregister(MenuEventPtr)
4043
4044#---------------------------------------------------------------------------
4045
4046class CloseEvent(Event):
4047 def __repr__(self):
4048 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4049 def __init__(self, *args, **kwargs):
4050 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
4051 newobj = _core_.new_CloseEvent(*args, **kwargs)
4052 self.this = newobj.this
4053 self.thisown = 1
4054 del newobj.thisown
4055 def SetLoggingOff(*args, **kwargs):
4056 """SetLoggingOff(self, bool logOff)"""
4057 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
4058
4059 def GetLoggingOff(*args, **kwargs):
4060 """GetLoggingOff(self) -> bool"""
4061 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
4062
4063 def Veto(*args, **kwargs):
4064 """Veto(self, bool veto=True)"""
4065 return _core_.CloseEvent_Veto(*args, **kwargs)
4066
4067 def SetCanVeto(*args, **kwargs):
4068 """SetCanVeto(self, bool canVeto)"""
4069 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
4070
4071 def CanVeto(*args, **kwargs):
4072 """CanVeto(self) -> bool"""
4073 return _core_.CloseEvent_CanVeto(*args, **kwargs)
4074
4075 def GetVeto(*args, **kwargs):
4076 """GetVeto(self) -> bool"""
4077 return _core_.CloseEvent_GetVeto(*args, **kwargs)
4078
4079
4080class CloseEventPtr(CloseEvent):
4081 def __init__(self, this):
4082 self.this = this
4083 if not hasattr(self,"thisown"): self.thisown = 0
4084 self.__class__ = CloseEvent
4085_core_.CloseEvent_swigregister(CloseEventPtr)
4086
4087#---------------------------------------------------------------------------
4088
4089class ShowEvent(Event):
4090 def __repr__(self):
4091 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4092 def __init__(self, *args, **kwargs):
4093 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
4094 newobj = _core_.new_ShowEvent(*args, **kwargs)
4095 self.this = newobj.this
4096 self.thisown = 1
4097 del newobj.thisown
4098 def SetShow(*args, **kwargs):
4099 """SetShow(self, bool show)"""
4100 return _core_.ShowEvent_SetShow(*args, **kwargs)
4101
4102 def GetShow(*args, **kwargs):
4103 """GetShow(self) -> bool"""
4104 return _core_.ShowEvent_GetShow(*args, **kwargs)
4105
4106
4107class ShowEventPtr(ShowEvent):
4108 def __init__(self, this):
4109 self.this = this
4110 if not hasattr(self,"thisown"): self.thisown = 0
4111 self.__class__ = ShowEvent
4112_core_.ShowEvent_swigregister(ShowEventPtr)
4113
4114#---------------------------------------------------------------------------
4115
4116class IconizeEvent(Event):
4117 def __repr__(self):
4118 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4119 def __init__(self, *args, **kwargs):
4120 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
4121 newobj = _core_.new_IconizeEvent(*args, **kwargs)
4122 self.this = newobj.this
4123 self.thisown = 1
4124 del newobj.thisown
4125 def Iconized(*args, **kwargs):
4126 """Iconized(self) -> bool"""
4127 return _core_.IconizeEvent_Iconized(*args, **kwargs)
4128
4129
4130class IconizeEventPtr(IconizeEvent):
4131 def __init__(self, this):
4132 self.this = this
4133 if not hasattr(self,"thisown"): self.thisown = 0
4134 self.__class__ = IconizeEvent
4135_core_.IconizeEvent_swigregister(IconizeEventPtr)
4136
4137#---------------------------------------------------------------------------
4138
4139class MaximizeEvent(Event):
4140 def __repr__(self):
4141 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4142 def __init__(self, *args, **kwargs):
4143 """__init__(self, int id=0) -> MaximizeEvent"""
4144 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
4145 self.this = newobj.this
4146 self.thisown = 1
4147 del newobj.thisown
4148
4149class MaximizeEventPtr(MaximizeEvent):
4150 def __init__(self, this):
4151 self.this = this
4152 if not hasattr(self,"thisown"): self.thisown = 0
4153 self.__class__ = MaximizeEvent
4154_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4155
4156#---------------------------------------------------------------------------
4157
4158class DropFilesEvent(Event):
4159 def __init__(self): raise RuntimeError, "No constructor defined"
4160 def __repr__(self):
4161 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4162 def GetPosition(*args, **kwargs):
4163 """GetPosition(self) -> Point"""
4164 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4165
4166 def GetNumberOfFiles(*args, **kwargs):
4167 """GetNumberOfFiles(self) -> int"""
4168 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4169
4170 def GetFiles(*args, **kwargs):
4171 """GetFiles(self) -> PyObject"""
4172 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4173
4174
4175class DropFilesEventPtr(DropFilesEvent):
4176 def __init__(self, this):
4177 self.this = this
4178 if not hasattr(self,"thisown"): self.thisown = 0
4179 self.__class__ = DropFilesEvent
4180_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4181
4182#---------------------------------------------------------------------------
4183
4184UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4185UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4186class UpdateUIEvent(CommandEvent):
4187 def __repr__(self):
4188 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4189 def __init__(self, *args, **kwargs):
4190 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4191 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4192 self.this = newobj.this
4193 self.thisown = 1
4194 del newobj.thisown
4195 def GetChecked(*args, **kwargs):
4196 """GetChecked(self) -> bool"""
4197 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4198
4199 def GetEnabled(*args, **kwargs):
4200 """GetEnabled(self) -> bool"""
4201 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4202
4203 def GetText(*args, **kwargs):
4204 """GetText(self) -> String"""
4205 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4206
4207 def GetSetText(*args, **kwargs):
4208 """GetSetText(self) -> bool"""
4209 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4210
4211 def GetSetChecked(*args, **kwargs):
4212 """GetSetChecked(self) -> bool"""
4213 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4214
4215 def GetSetEnabled(*args, **kwargs):
4216 """GetSetEnabled(self) -> bool"""
4217 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4218
4219 def Check(*args, **kwargs):
4220 """Check(self, bool check)"""
4221 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4222
4223 def Enable(*args, **kwargs):
4224 """Enable(self, bool enable)"""
4225 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4226
4227 def SetText(*args, **kwargs):
4228 """SetText(self, String text)"""
4229 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4230
4231 def SetUpdateInterval(*args, **kwargs):
c24da6d6 4232 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD
4233 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4234
4235 SetUpdateInterval = staticmethod(SetUpdateInterval)
4236 def GetUpdateInterval(*args, **kwargs):
c24da6d6 4237 """GetUpdateInterval() -> long"""
d55e5bfc
RD
4238 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4239
4240 GetUpdateInterval = staticmethod(GetUpdateInterval)
4241 def CanUpdate(*args, **kwargs):
c24da6d6 4242 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD
4243 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4244
4245 CanUpdate = staticmethod(CanUpdate)
4246 def ResetUpdateTime(*args, **kwargs):
c24da6d6 4247 """ResetUpdateTime()"""
d55e5bfc
RD
4248 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4249
4250 ResetUpdateTime = staticmethod(ResetUpdateTime)
4251 def SetMode(*args, **kwargs):
c24da6d6 4252 """SetMode(int mode)"""
d55e5bfc
RD
4253 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4254
4255 SetMode = staticmethod(SetMode)
4256 def GetMode(*args, **kwargs):
c24da6d6 4257 """GetMode() -> int"""
d55e5bfc
RD
4258 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4259
4260 GetMode = staticmethod(GetMode)
4261
4262class UpdateUIEventPtr(UpdateUIEvent):
4263 def __init__(self, this):
4264 self.this = this
4265 if not hasattr(self,"thisown"): self.thisown = 0
4266 self.__class__ = UpdateUIEvent
4267_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4268
4269def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4270 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4271 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4272
4273def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4274 """UpdateUIEvent_GetUpdateInterval() -> long"""
4275 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4276
4277def UpdateUIEvent_CanUpdate(*args, **kwargs):
4278 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4279 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4280
4281def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4282 """UpdateUIEvent_ResetUpdateTime()"""
4283 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4284
4285def UpdateUIEvent_SetMode(*args, **kwargs):
4286 """UpdateUIEvent_SetMode(int mode)"""
4287 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4288
4289def UpdateUIEvent_GetMode(*args, **kwargs):
4290 """UpdateUIEvent_GetMode() -> int"""
4291 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4292
4293#---------------------------------------------------------------------------
4294
4295class SysColourChangedEvent(Event):
4296 def __repr__(self):
4297 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4298 def __init__(self, *args, **kwargs):
4299 """__init__(self) -> SysColourChangedEvent"""
4300 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4301 self.this = newobj.this
4302 self.thisown = 1
4303 del newobj.thisown
4304
4305class SysColourChangedEventPtr(SysColourChangedEvent):
4306 def __init__(self, this):
4307 self.this = this
4308 if not hasattr(self,"thisown"): self.thisown = 0
4309 self.__class__ = SysColourChangedEvent
4310_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4311
4312#---------------------------------------------------------------------------
4313
4314class MouseCaptureChangedEvent(Event):
4315 def __repr__(self):
4316 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4317 def __init__(self, *args, **kwargs):
4318 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4319 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4320 self.this = newobj.this
4321 self.thisown = 1
4322 del newobj.thisown
4323 def GetCapturedWindow(*args, **kwargs):
4324 """GetCapturedWindow(self) -> Window"""
4325 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4326
4327
4328class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4329 def __init__(self, this):
4330 self.this = this
4331 if not hasattr(self,"thisown"): self.thisown = 0
4332 self.__class__ = MouseCaptureChangedEvent
4333_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4334
4335#---------------------------------------------------------------------------
4336
4337class DisplayChangedEvent(Event):
4338 def __repr__(self):
4339 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4340 def __init__(self, *args, **kwargs):
4341 """__init__(self) -> DisplayChangedEvent"""
4342 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4343 self.this = newobj.this
4344 self.thisown = 1
4345 del newobj.thisown
4346
4347class DisplayChangedEventPtr(DisplayChangedEvent):
4348 def __init__(self, this):
4349 self.this = this
4350 if not hasattr(self,"thisown"): self.thisown = 0
4351 self.__class__ = DisplayChangedEvent
4352_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4353
4354#---------------------------------------------------------------------------
4355
4356class PaletteChangedEvent(Event):
4357 def __repr__(self):
4358 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4359 def __init__(self, *args, **kwargs):
4360 """__init__(self, int id=0) -> PaletteChangedEvent"""
4361 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4362 self.this = newobj.this
4363 self.thisown = 1
4364 del newobj.thisown
4365 def SetChangedWindow(*args, **kwargs):
4366 """SetChangedWindow(self, Window win)"""
4367 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4368
4369 def GetChangedWindow(*args, **kwargs):
4370 """GetChangedWindow(self) -> Window"""
4371 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4372
4373
4374class PaletteChangedEventPtr(PaletteChangedEvent):
4375 def __init__(self, this):
4376 self.this = this
4377 if not hasattr(self,"thisown"): self.thisown = 0
4378 self.__class__ = PaletteChangedEvent
4379_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4380
4381#---------------------------------------------------------------------------
4382
4383class QueryNewPaletteEvent(Event):
4384 def __repr__(self):
4385 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4386 def __init__(self, *args, **kwargs):
4387 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4388 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4389 self.this = newobj.this
4390 self.thisown = 1
4391 del newobj.thisown
4392 def SetPaletteRealized(*args, **kwargs):
4393 """SetPaletteRealized(self, bool realized)"""
4394 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4395
4396 def GetPaletteRealized(*args, **kwargs):
4397 """GetPaletteRealized(self) -> bool"""
4398 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4399
4400
4401class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4402 def __init__(self, this):
4403 self.this = this
4404 if not hasattr(self,"thisown"): self.thisown = 0
4405 self.__class__ = QueryNewPaletteEvent
4406_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4407
4408#---------------------------------------------------------------------------
4409
4410class NavigationKeyEvent(Event):
4411 def __repr__(self):
4412 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4413 def __init__(self, *args, **kwargs):
4414 """__init__(self) -> NavigationKeyEvent"""
4415 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4416 self.this = newobj.this
4417 self.thisown = 1
4418 del newobj.thisown
4419 def GetDirection(*args, **kwargs):
4420 """GetDirection(self) -> bool"""
4421 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4422
4423 def SetDirection(*args, **kwargs):
908b74cd 4424 """SetDirection(self, bool forward)"""
d55e5bfc
RD
4425 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4426
4427 def IsWindowChange(*args, **kwargs):
4428 """IsWindowChange(self) -> bool"""
4429 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4430
4431 def SetWindowChange(*args, **kwargs):
908b74cd 4432 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD
4433 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4434
908b74cd
RD
4435 def SetFlags(*args, **kwargs):
4436 """SetFlags(self, long flags)"""
4437 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4438
d55e5bfc
RD
4439 def GetCurrentFocus(*args, **kwargs):
4440 """GetCurrentFocus(self) -> Window"""
4441 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4442
4443 def SetCurrentFocus(*args, **kwargs):
4444 """SetCurrentFocus(self, Window win)"""
4445 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4446
b0f7404b 4447 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4448 IsForward = _core_.NavigationKeyEvent_IsForward
4449 WinChange = _core_.NavigationKeyEvent_WinChange
d55e5bfc
RD
4450
4451class NavigationKeyEventPtr(NavigationKeyEvent):
4452 def __init__(self, this):
4453 self.this = this
4454 if not hasattr(self,"thisown"): self.thisown = 0
4455 self.__class__ = NavigationKeyEvent
4456_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4457
4458#---------------------------------------------------------------------------
4459
4460class WindowCreateEvent(CommandEvent):
4461 def __repr__(self):
4462 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4463 def __init__(self, *args, **kwargs):
4464 """__init__(self, Window win=None) -> WindowCreateEvent"""
4465 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4466 self.this = newobj.this
4467 self.thisown = 1
4468 del newobj.thisown
4469 def GetWindow(*args, **kwargs):
4470 """GetWindow(self) -> Window"""
4471 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4472
4473
4474class WindowCreateEventPtr(WindowCreateEvent):
4475 def __init__(self, this):
4476 self.this = this
4477 if not hasattr(self,"thisown"): self.thisown = 0
4478 self.__class__ = WindowCreateEvent
4479_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4480
4481class WindowDestroyEvent(CommandEvent):
4482 def __repr__(self):
4483 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4484 def __init__(self, *args, **kwargs):
4485 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4486 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4487 self.this = newobj.this
4488 self.thisown = 1
4489 del newobj.thisown
4490 def GetWindow(*args, **kwargs):
4491 """GetWindow(self) -> Window"""
4492 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4493
4494
4495class WindowDestroyEventPtr(WindowDestroyEvent):
4496 def __init__(self, this):
4497 self.this = this
4498 if not hasattr(self,"thisown"): self.thisown = 0
4499 self.__class__ = WindowDestroyEvent
4500_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4501
4502#---------------------------------------------------------------------------
4503
4504class ContextMenuEvent(CommandEvent):
4505 def __repr__(self):
4506 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4507 def __init__(self, *args, **kwargs):
4508 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4509 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4510 self.this = newobj.this
4511 self.thisown = 1
4512 del newobj.thisown
4513 def GetPosition(*args, **kwargs):
4514 """GetPosition(self) -> Point"""
4515 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4516
4517 def SetPosition(*args, **kwargs):
4518 """SetPosition(self, Point pos)"""
4519 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4520
4521
4522class ContextMenuEventPtr(ContextMenuEvent):
4523 def __init__(self, this):
4524 self.this = this
4525 if not hasattr(self,"thisown"): self.thisown = 0
4526 self.__class__ = ContextMenuEvent
4527_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4528
4529#---------------------------------------------------------------------------
4530
4531IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4532IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4533class IdleEvent(Event):
4534 def __repr__(self):
4535 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4536 def __init__(self, *args, **kwargs):
4537 """__init__(self) -> IdleEvent"""
4538 newobj = _core_.new_IdleEvent(*args, **kwargs)
4539 self.this = newobj.this
4540 self.thisown = 1
4541 del newobj.thisown
4542 def RequestMore(*args, **kwargs):
4543 """RequestMore(self, bool needMore=True)"""
4544 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4545
4546 def MoreRequested(*args, **kwargs):
4547 """MoreRequested(self) -> bool"""
4548 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4549
4550 def SetMode(*args, **kwargs):
c24da6d6 4551 """SetMode(int mode)"""
d55e5bfc
RD
4552 return _core_.IdleEvent_SetMode(*args, **kwargs)
4553
4554 SetMode = staticmethod(SetMode)
4555 def GetMode(*args, **kwargs):
c24da6d6 4556 """GetMode() -> int"""
d55e5bfc
RD
4557 return _core_.IdleEvent_GetMode(*args, **kwargs)
4558
4559 GetMode = staticmethod(GetMode)
4560 def CanSend(*args, **kwargs):
c24da6d6 4561 """CanSend(Window win) -> bool"""
d55e5bfc
RD
4562 return _core_.IdleEvent_CanSend(*args, **kwargs)
4563
4564 CanSend = staticmethod(CanSend)
4565
4566class IdleEventPtr(IdleEvent):
4567 def __init__(self, this):
4568 self.this = this
4569 if not hasattr(self,"thisown"): self.thisown = 0
4570 self.__class__ = IdleEvent
4571_core_.IdleEvent_swigregister(IdleEventPtr)
4572
4573def IdleEvent_SetMode(*args, **kwargs):
4574 """IdleEvent_SetMode(int mode)"""
4575 return _core_.IdleEvent_SetMode(*args, **kwargs)
4576
4577def IdleEvent_GetMode(*args, **kwargs):
4578 """IdleEvent_GetMode() -> int"""
4579 return _core_.IdleEvent_GetMode(*args, **kwargs)
4580
4581def IdleEvent_CanSend(*args, **kwargs):
4582 """IdleEvent_CanSend(Window win) -> bool"""
4583 return _core_.IdleEvent_CanSend(*args, **kwargs)
4584
4585#---------------------------------------------------------------------------
4586
4587class PyEvent(Event):
4588 def __repr__(self):
4589 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4590 def __init__(self, *args, **kwargs):
4591 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4592 newobj = _core_.new_PyEvent(*args, **kwargs)
4593 self.this = newobj.this
4594 self.thisown = 1
4595 del newobj.thisown
4596 self.SetSelf(self)
4597
4598 def __del__(self, destroy=_core_.delete_PyEvent):
4599 """__del__(self)"""
4600 try:
4601 if self.thisown: destroy(self)
4602 except: pass
4603
4604 def SetSelf(*args, **kwargs):
4605 """SetSelf(self, PyObject self)"""
4606 return _core_.PyEvent_SetSelf(*args, **kwargs)
4607
4608 def GetSelf(*args, **kwargs):
4609 """GetSelf(self) -> PyObject"""
4610 return _core_.PyEvent_GetSelf(*args, **kwargs)
4611
4612
4613class PyEventPtr(PyEvent):
4614 def __init__(self, this):
4615 self.this = this
4616 if not hasattr(self,"thisown"): self.thisown = 0
4617 self.__class__ = PyEvent
4618_core_.PyEvent_swigregister(PyEventPtr)
4619
4620class PyCommandEvent(CommandEvent):
4621 def __repr__(self):
4622 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4623 def __init__(self, *args, **kwargs):
4624 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4625 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4626 self.this = newobj.this
4627 self.thisown = 1
4628 del newobj.thisown
4629 self.SetSelf(self)
4630
4631 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4632 """__del__(self)"""
4633 try:
4634 if self.thisown: destroy(self)
4635 except: pass
4636
4637 def SetSelf(*args, **kwargs):
4638 """SetSelf(self, PyObject self)"""
4639 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4640
4641 def GetSelf(*args, **kwargs):
4642 """GetSelf(self) -> PyObject"""
4643 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4644
4645
4646class PyCommandEventPtr(PyCommandEvent):
4647 def __init__(self, this):
4648 self.this = this
4649 if not hasattr(self,"thisown"): self.thisown = 0
4650 self.__class__ = PyCommandEvent
4651_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4652
4653#---------------------------------------------------------------------------
4654
4655PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4656PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4657PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4658PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4659PRINT_WINDOWS = _core_.PRINT_WINDOWS
4660PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4661class PyApp(EvtHandler):
c24da6d6
RD
4662 """
4663 The ``wx.PyApp`` class is an *implementation detail*, please use the
4664 `wx.App` class (or some other derived class) instead.
4665 """
d55e5bfc
RD
4666 def __repr__(self):
4667 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4668 def __init__(self, *args, **kwargs):
4669 """
4670 __init__(self) -> PyApp
4671
4672 Create a new application object, starting the bootstrap process.
4673 """
4674 newobj = _core_.new_PyApp(*args, **kwargs)
4675 self.this = newobj.this
4676 self.thisown = 1
4677 del newobj.thisown
4678 self._setCallbackInfo(self, PyApp)
4679 self._setOORInfo(self)
4680
4681 def __del__(self, destroy=_core_.delete_PyApp):
4682 """__del__(self)"""
4683 try:
4684 if self.thisown: destroy(self)
4685 except: pass
4686
4687 def _setCallbackInfo(*args, **kwargs):
4688 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4689 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4690
4691 def GetAppName(*args, **kwargs):
4692 """
4693 GetAppName(self) -> String
4694
4695 Get the application name.
4696 """
4697 return _core_.PyApp_GetAppName(*args, **kwargs)
4698
4699 def SetAppName(*args, **kwargs):
4700 """
4701 SetAppName(self, String name)
4702
c24da6d6
RD
4703 Set the application name. This value may be used automatically by
4704 `wx.Config` and such.
d55e5bfc
RD
4705 """
4706 return _core_.PyApp_SetAppName(*args, **kwargs)
4707
4708 def GetClassName(*args, **kwargs):
4709 """
4710 GetClassName(self) -> String
4711
4712 Get the application's class name.
4713 """
4714 return _core_.PyApp_GetClassName(*args, **kwargs)
4715
4716 def SetClassName(*args, **kwargs):
4717 """
4718 SetClassName(self, String name)
4719
c24da6d6
RD
4720 Set the application's class name. This value may be used for
4721 X-resources if applicable for the platform
d55e5bfc
RD
4722 """
4723 return _core_.PyApp_SetClassName(*args, **kwargs)
4724
4725 def GetVendorName(*args, **kwargs):
4726 """
4727 GetVendorName(self) -> String
4728
4729 Get the application's vendor name.
4730 """
4731 return _core_.PyApp_GetVendorName(*args, **kwargs)
4732
4733 def SetVendorName(*args, **kwargs):
4734 """
4735 SetVendorName(self, String name)
4736
c24da6d6
RD
4737 Set the application's vendor name. This value may be used
4738 automatically by `wx.Config` and such.
d55e5bfc
RD
4739 """
4740 return _core_.PyApp_SetVendorName(*args, **kwargs)
4741
4742 def GetTraits(*args, **kwargs):
4743 """
4744 GetTraits(self) -> wxAppTraits
4745
c24da6d6
RD
4746 Return (and create if necessary) the app traits object to which we
4747 delegate for everything which either should be configurable by the
4748 user (then he can change the default behaviour simply by overriding
4749 CreateTraits() and returning his own traits object) or which is
4750 GUI/console dependent as then wx.AppTraits allows us to abstract the
4751 differences behind the common facade.
4752
4753 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
4754 """
4755 return _core_.PyApp_GetTraits(*args, **kwargs)
4756
4757 def ProcessPendingEvents(*args, **kwargs):
4758 """
4759 ProcessPendingEvents(self)
4760
c24da6d6
RD
4761 Process all events in the Pending Events list -- it is necessary to
4762 call this function to process posted events. This normally happens
4763 during each event loop iteration.
d55e5bfc
RD
4764 """
4765 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
4766
4767 def Yield(*args, **kwargs):
4768 """
4769 Yield(self, bool onlyIfNeeded=False) -> bool
4770
c24da6d6
RD
4771 Process all currently pending events right now, instead of waiting
4772 until return to the event loop. It is an error to call ``Yield``
4773 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 4774
c24da6d6 4775 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD
4776 reentrancies (i.e. when called from an event handler it may
4777 result in calling the same event handler again), use with
4778 extreme care or, better, don't use at all!
d55e5bfc 4779
c24da6d6 4780 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 4781
d55e5bfc
RD
4782 """
4783 return _core_.PyApp_Yield(*args, **kwargs)
4784
4785 def WakeUpIdle(*args, **kwargs):
4786 """
4787 WakeUpIdle(self)
4788
c24da6d6
RD
4789 Make sure that idle events are sent again.
4790 :see: `wx.WakeUpIdle`
d55e5bfc
RD
4791 """
4792 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
4793
84f85550
RD
4794 def IsMainLoopRunning(*args, **kwargs):
4795 """
4796 IsMainLoopRunning() -> bool
4797
4798 Returns True if we're running the main loop, i.e. if the events can
4799 currently be dispatched.
4800 """
4801 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
4802
4803 IsMainLoopRunning = staticmethod(IsMainLoopRunning)
d55e5bfc
RD
4804 def MainLoop(*args, **kwargs):
4805 """
4806 MainLoop(self) -> int
4807
c24da6d6
RD
4808 Execute the main GUI loop, the function doesn't normally return until
4809 all top level windows have been closed and destroyed.
d55e5bfc
RD
4810 """
4811 return _core_.PyApp_MainLoop(*args, **kwargs)
4812
4813 def Exit(*args, **kwargs):
4814 """
4815 Exit(self)
4816
4817 Exit the main loop thus terminating the application.
c24da6d6 4818 :see: `wx.Exit`
d55e5bfc
RD
4819 """
4820 return _core_.PyApp_Exit(*args, **kwargs)
4821
4822 def ExitMainLoop(*args, **kwargs):
4823 """
4824 ExitMainLoop(self)
4825
c24da6d6
RD
4826 Exit the main GUI loop during the next iteration of the main
4827 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
4828 """
4829 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
4830
4831 def Pending(*args, **kwargs):
4832 """
4833 Pending(self) -> bool
4834
4835 Returns True if there are unprocessed events in the event queue.
4836 """
4837 return _core_.PyApp_Pending(*args, **kwargs)
4838
4839 def Dispatch(*args, **kwargs):
4840 """
4841 Dispatch(self) -> bool
4842
4843 Process the first event in the event queue (blocks until an event
4844 appears if there are none currently)
4845 """
4846 return _core_.PyApp_Dispatch(*args, **kwargs)
4847
4848 def ProcessIdle(*args, **kwargs):
4849 """
4850 ProcessIdle(self) -> bool
4851
c24da6d6
RD
4852 Called from the MainLoop when the application becomes idle (there are
4853 no pending events) and sends a `wx.IdleEvent` to all interested
4854 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
4855 """
4856 return _core_.PyApp_ProcessIdle(*args, **kwargs)
4857
4858 def SendIdleEvents(*args, **kwargs):
4859 """
4860 SendIdleEvents(self, Window win, IdleEvent event) -> bool
4861
c24da6d6
RD
4862 Send idle event to window and all subwindows. Returns True if more
4863 idle time is requested.
d55e5bfc
RD
4864 """
4865 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
4866
4867 def IsActive(*args, **kwargs):
4868 """
4869 IsActive(self) -> bool
4870
4871 Return True if our app has focus.
4872 """
4873 return _core_.PyApp_IsActive(*args, **kwargs)
4874
4875 def SetTopWindow(*args, **kwargs):
4876 """
4877 SetTopWindow(self, Window win)
4878
c24da6d6 4879 Set the *main* top level window
d55e5bfc
RD
4880 """
4881 return _core_.PyApp_SetTopWindow(*args, **kwargs)
4882
4883 def GetTopWindow(*args, **kwargs):
4884 """
4885 GetTopWindow(self) -> Window
4886
c24da6d6
RD
4887 Return the *main* top level window (if it hadn't been set previously
4888 with SetTopWindow(), will return just some top level window and, if
4889 there not any, will return None)
d55e5bfc
RD
4890 """
4891 return _core_.PyApp_GetTopWindow(*args, **kwargs)
4892
4893 def SetExitOnFrameDelete(*args, **kwargs):
4894 """
4895 SetExitOnFrameDelete(self, bool flag)
4896
c24da6d6
RD
4897 Control the exit behaviour: by default, the program will exit the main
4898 loop (and so, usually, terminate) when the last top-level program
4899 window is deleted. Beware that if you disable this behaviour (with
4900 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4901 explicitly from somewhere.
d55e5bfc
RD
4902 """
4903 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
4904
4905 def GetExitOnFrameDelete(*args, **kwargs):
4906 """
4907 GetExitOnFrameDelete(self) -> bool
4908
4909 Get the current exit behaviour setting.
4910 """
4911 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
4912
4913 def SetUseBestVisual(*args, **kwargs):
4914 """
4915 SetUseBestVisual(self, bool flag)
4916
c24da6d6
RD
4917 Set whether the app should try to use the best available visual on
4918 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
4919 """
4920 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
4921
4922 def GetUseBestVisual(*args, **kwargs):
4923 """
4924 GetUseBestVisual(self) -> bool
4925
4926 Get current UseBestVisual setting.
4927 """
4928 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
4929
4930 def SetPrintMode(*args, **kwargs):
4931 """SetPrintMode(self, int mode)"""
4932 return _core_.PyApp_SetPrintMode(*args, **kwargs)
4933
4934 def GetPrintMode(*args, **kwargs):
4935 """GetPrintMode(self) -> int"""
4936 return _core_.PyApp_GetPrintMode(*args, **kwargs)
4937
4938 def SetAssertMode(*args, **kwargs):
4939 """
4940 SetAssertMode(self, int mode)
4941
79fccf9d 4942 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
4943 """
4944 return _core_.PyApp_SetAssertMode(*args, **kwargs)
4945
4946 def GetAssertMode(*args, **kwargs):
4947 """
4948 GetAssertMode(self) -> int
4949
4950 Get the current OnAssert behaviour setting.
4951 """
4952 return _core_.PyApp_GetAssertMode(*args, **kwargs)
4953
4954 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 4955 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
4956 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4957
4958 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4959 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 4960 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
4961 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4962
4963 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4964 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 4965 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
4966 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4967
4968 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4969 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 4970 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
4971 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4972
4973 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4974 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 4975 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
4976 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4977
4978 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4979 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 4980 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
4981 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4982
4983 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4984 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 4985 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
4986 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4987
4988 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4989 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 4990 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
4991 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4992
4993 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4994 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 4995 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
4996 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4997
4998 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4999 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 5000 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
5001 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5002
5003 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
5004 def _BootstrapApp(*args, **kwargs):
5005 """
5006 _BootstrapApp(self)
5007
5008 For internal use only
5009 """
5010 return _core_.PyApp__BootstrapApp(*args, **kwargs)
5011
5012 def GetComCtl32Version(*args, **kwargs):
5013 """
c24da6d6 5014 GetComCtl32Version() -> int
d55e5bfc 5015
c24da6d6
RD
5016 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5017 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
5018 """
5019 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5020
5021 GetComCtl32Version = staticmethod(GetComCtl32Version)
5022
5023class PyAppPtr(PyApp):
5024 def __init__(self, this):
5025 self.this = this
5026 if not hasattr(self,"thisown"): self.thisown = 0
5027 self.__class__ = PyApp
5028_core_.PyApp_swigregister(PyAppPtr)
5029
84f85550
RD
5030def PyApp_IsMainLoopRunning(*args, **kwargs):
5031 """
5032 PyApp_IsMainLoopRunning() -> bool
5033
5034 Returns True if we're running the main loop, i.e. if the events can
5035 currently be dispatched.
5036 """
5037 return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
5038
d55e5bfc
RD
5039def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
5040 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
5041 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
5042
5043def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
5044 """PyApp_GetMacAboutMenuItemId() -> long"""
5045 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
5046
5047def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
5048 """PyApp_GetMacPreferencesMenuItemId() -> long"""
5049 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
5050
5051def PyApp_GetMacExitMenuItemId(*args, **kwargs):
5052 """PyApp_GetMacExitMenuItemId() -> long"""
5053 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
5054
5055def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
5056 """PyApp_GetMacHelpMenuTitleName() -> String"""
5057 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
5058
5059def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
5060 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
5061 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5062
5063def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5064 """PyApp_SetMacAboutMenuItemId(long val)"""
5065 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5066
5067def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5068 """PyApp_SetMacPreferencesMenuItemId(long val)"""
5069 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5070
5071def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5072 """PyApp_SetMacExitMenuItemId(long val)"""
5073 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5074
5075def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
5076 """PyApp_SetMacHelpMenuTitleName(String val)"""
5077 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5078
5079def PyApp_GetComCtl32Version(*args, **kwargs):
5080 """
5081 PyApp_GetComCtl32Version() -> int
5082
c24da6d6
RD
5083 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5084 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
5085 """
5086 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5087
5088#---------------------------------------------------------------------------
5089
5090
5091def Exit(*args, **kwargs):
5092 """
5093 Exit()
5094
5095 Force an exit of the application. Convenience for wx.GetApp().Exit()
5096 """
5097 return _core_.Exit(*args, **kwargs)
5098
5099def Yield(*args, **kwargs):
5100 """
5101 Yield() -> bool
5102
5103 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5104 """
5105 return _core_.Yield(*args, **kwargs)
5106
5107def YieldIfNeeded(*args, **kwargs):
5108 """
5109 YieldIfNeeded() -> bool
5110
5111 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5112 """
5113 return _core_.YieldIfNeeded(*args, **kwargs)
5114
5115def SafeYield(*args, **kwargs):
5116 """
5117 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
5118
c24da6d6
RD
5119 This function is similar to `wx.Yield`, except that it disables the
5120 user input to all program windows before calling `wx.Yield` and
5121 re-enables it again afterwards. If ``win`` is not None, this window
5122 will remain enabled, allowing the implementation of some limited user
5123 interaction.
d55e5bfc 5124
c24da6d6 5125 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
5126 """
5127 return _core_.SafeYield(*args, **kwargs)
5128
5129def WakeUpIdle(*args, **kwargs):
5130 """
5131 WakeUpIdle()
5132
c24da6d6
RD
5133 Cause the message queue to become empty again, so idle events will be
5134 sent.
d55e5bfc
RD
5135 """
5136 return _core_.WakeUpIdle(*args, **kwargs)
5137
5138def PostEvent(*args, **kwargs):
5139 """
5140 PostEvent(EvtHandler dest, Event event)
5141
c24da6d6
RD
5142 Send an event to a window or other wx.EvtHandler to be processed
5143 later.
d55e5bfc
RD
5144 """
5145 return _core_.PostEvent(*args, **kwargs)
5146
5147def App_CleanUp(*args, **kwargs):
5148 """
5149 App_CleanUp()
5150
79fccf9d 5151 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 5152 Python shuts down.
d55e5bfc
RD
5153 """
5154 return _core_.App_CleanUp(*args, **kwargs)
5155
5156def GetApp(*args, **kwargs):
5157 """
5158 GetApp() -> PyApp
5159
5160 Return a reference to the current wx.App object.
5161 """
5162 return _core_.GetApp(*args, **kwargs)
5163#----------------------------------------------------------------------
5164
5165class PyOnDemandOutputWindow:
5166 """
5167 A class that can be used for redirecting Python's stdout and
5168 stderr streams. It will do nothing until something is wrriten to
5169 the stream at which point it will create a Frame with a text area
5170 and write the text there.
5171 """
5172 def __init__(self, title = "wxPython: stdout/stderr"):
5173 self.frame = None
5174 self.title = title
412d302d
RD
5175 self.pos = wx.DefaultPosition
5176 self.size = (450, 300)
d55e5bfc
RD
5177 self.parent = None
5178
5179 def SetParent(self, parent):
5180 """Set the window to be used as the popup Frame's parent."""
5181 self.parent = parent
5182
5183
5184 def CreateOutputWindow(self, st):
412d302d
RD
5185 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5186 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 5187 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5188 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 5189 self.text.AppendText(st)
d55e5bfc
RD
5190 self.frame.Show(True)
5191 EVT_CLOSE(self.frame, self.OnCloseWindow)
5192
5193
5194 def OnCloseWindow(self, event):
5195 if self.frame is not None:
5196 self.frame.Destroy()
5197 self.frame = None
5198 self.text = None
5199
5200
5201 # These methods provide the file-like output behaviour.
5202 def write(self, text):
5203 """
5204 Create the output window if needed and write the string to it.
5205 If not called in the context of the gui thread then uses
5206 CallAfter to do the work there.
5207 """
5208 if self.frame is None:
5209 if not wx.Thread_IsMain():
5210 wx.CallAfter(self.CreateOutputWindow, text)
5211 else:
5212 self.CreateOutputWindow(text)
5213 else:
5214 if not wx.Thread_IsMain():
5215 wx.CallAfter(self.text.AppendText, text)
5216 else:
5217 self.text.AppendText(text)
5218
5219
5220 def close(self):
5221 if self.frame is not None:
5222 wx.CallAfter(self.frame.Close)
5223
5224
19272049
RD
5225 def flush(self):
5226 pass
5227
5228
d55e5bfc
RD
5229
5230#----------------------------------------------------------------------
5231
5232_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5233
5234class App(wx.PyApp):
5235 """
c24da6d6
RD
5236 The ``wx.App`` class represents the application and is used to:
5237
5238 * bootstrap the wxPython system and initialize the underlying
5239 gui toolkit
5240 * set and get application-wide properties
5241 * implement the windowing system main message or event loop,
5242 and to dispatch events to window instances
5243 * etc.
5244
5245 Every application must have a ``wx.App`` instance, and all
5246 creation of UI objects should be delayed until after the
5247 ``wx.App`` object has been created in order to ensure that the gui
5248 platform and wxWidgets have been fully initialized.
5249
5250 Normally you would derive from this class and implement an
5251 ``OnInit`` method that creates a frame and then calls
5252 ``self.SetTopWindow(frame)``.
5253
5254 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 5255 directly.
d55e5bfc 5256 """
c24da6d6 5257
d55e5bfc
RD
5258 outputWindowClass = PyOnDemandOutputWindow
5259
c24da6d6
RD
5260 def __init__(self, redirect=_defRedirect, filename=None,
5261 useBestVisual=False, clearSigInt=True):
5262 """
5263 Construct a ``wx.App`` object.
5264
5265 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5266 redirected? Defaults to True on Windows and Mac, False
5267 otherwise. If `filename` is None then output will be
5268 redirected to a window that pops up as needed. (You can
5269 control what kind of window is created for the output by
5270 resetting the class variable ``outputWindowClass`` to a
5271 class of your choosing.)
5272
5273 :param filename: The name of a file to redirect output to, if
5274 redirect is True.
5275
5276 :param useBestVisual: Should the app try to use the best
5277 available visual provided by the system (only relevant on
5278 systems that have more than one visual.) This parameter
5279 must be used instead of calling `SetUseBestVisual` later
5280 on because it must be set before the underlying GUI
5281 toolkit is initialized.
5282
5283 :param clearSigInt: Should SIGINT be cleared? This allows the
5284 app to terminate upon a Ctrl-C in the console like other
5285 GUI apps will.
5286
5287 :note: You should override OnInit to do applicaition
5288 initialization to ensure that the system, toolkit and
5289 wxWidgets are fully initialized.
5290 """
d55e5bfc
RD
5291 wx.PyApp.__init__(self)
5292
5293 if wx.Platform == "__WXMAC__":
5294 try:
5295 import MacOS
5296 if not MacOS.WMAvailable():
5297 print """\
5298This program needs access to the screen. Please run with 'pythonw',
5299not 'python', and only when you are logged in on the main display of
5300your Mac."""
5301 _sys.exit(1)
b1f29bf7
RD
5302 except SystemExit:
5303 raise
d55e5bfc
RD
5304 except:
5305 pass
5306
5307 # This has to be done before OnInit
5308 self.SetUseBestVisual(useBestVisual)
5309
5310 # Set the default handler for SIGINT. This fixes a problem
5311 # where if Ctrl-C is pressed in the console that started this
5312 # app then it will not appear to do anything, (not even send
5313 # KeyboardInterrupt???) but will later segfault on exit. By
5314 # setting the default handler then the app will exit, as
5315 # expected (depending on platform.)
c24da6d6
RD
5316 if clearSigInt:
5317 try:
5318 import signal
5319 signal.signal(signal.SIGINT, signal.SIG_DFL)
5320 except:
5321 pass
d55e5bfc
RD
5322
5323 # Save and redirect the stdio to a window?
5324 self.stdioWin = None
5325 self.saveStdio = (_sys.stdout, _sys.stderr)
5326 if redirect:
5327 self.RedirectStdio(filename)
5328
8fb0e70a
RD
5329 # Use Python's install prefix as the default
5330 wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
5331
d55e5bfc
RD
5332 # This finishes the initialization of wxWindows and then calls
5333 # the OnInit that should be present in the derived class
5334 self._BootstrapApp()
5335
5336
5337 def __del__(self):
5338 try:
5339 self.RestoreStdio() # Just in case the MainLoop was overridden
5340 except:
5341 pass
5342
5343
5344 def SetTopWindow(self, frame):
5345 """Set the \"main\" top level window"""
5346 if self.stdioWin:
5347 self.stdioWin.SetParent(frame)
5348 wx.PyApp.SetTopWindow(self, frame)
5349
5350
5351 def MainLoop(self):
5352 """Execute the main GUI event loop"""
5353 wx.PyApp.MainLoop(self)
5354 self.RestoreStdio()
5355
5356
5357 def RedirectStdio(self, filename=None):
5358 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5359 if filename:
5360 _sys.stdout = _sys.stderr = open(filename, 'a')
5361 else:
5362 self.stdioWin = self.outputWindowClass()
5363 _sys.stdout = _sys.stderr = self.stdioWin
5364
5365
5366 def RestoreStdio(self):
5367 _sys.stdout, _sys.stderr = self.saveStdio
5368
5369
412d302d
RD
5370 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5371 """
5372 Set the title, position and/or size of the output window if
f5b96ee1
RD
5373 the stdio has been redirected. This should be called before
5374 any output would cause the output window to be created.
412d302d
RD
5375 """
5376 if self.stdioWin:
5377 if title is not None:
5378 self.stdioWin.title = title
5379 if pos is not None:
5380 self.stdioWin.pos = pos
5381 if size is not None:
5382 self.stdioWin.size = size
5383
5384
5385
d55e5bfc 5386
c24da6d6 5387# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
5388App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5389App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5390App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5391App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5392App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5393App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5394App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5395App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5396App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5397App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5398App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5399
5400#----------------------------------------------------------------------------
5401
5402class PySimpleApp(wx.App):
5403 """
5404 A simple application class. You can just create one of these and
5405 then then make your top level windows later, and not have to worry
c24da6d6 5406 about OnInit. For example::
d55e5bfc 5407
c24da6d6
RD
5408 app = wx.PySimpleApp()
5409 frame = wx.Frame(None, title='Hello World')
5410 frame.Show()
5411 app.MainLoop()
5412
5413 :see: `wx.App`
5414 """
5415
5416 def __init__(self, redirect=False, filename=None,
5417 useBestVisual=False, clearSigInt=True):
5418 """
5419 :see: `wx.App.__init__`
5420 """
5421 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
5422
5423 def OnInit(self):
d55e5bfc
RD
5424 return True
5425
5426
c24da6d6 5427
d55e5bfc
RD
5428# Is anybody using this one?
5429class PyWidgetTester(wx.App):
5430 def __init__(self, size = (250, 100)):
5431 self.size = size
5432 wx.App.__init__(self, 0)
5433
5434 def OnInit(self):
5435 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5436 self.SetTopWindow(self.frame)
5437 return True
5438
c24da6d6
RD
5439 def SetWidget(self, widgetClass, *args, **kwargs):
5440 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
5441 self.frame.Show(True)
5442
5443#----------------------------------------------------------------------------
5444# DO NOT hold any other references to this object. This is how we
c24da6d6 5445# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5446# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 5447# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
5448
5449class __wxPyCleanup:
5450 def __init__(self):
5451 self.cleanup = _core_.App_CleanUp
5452 def __del__(self):
5453 self.cleanup()
5454
5455_sys.__wxPythonCleanup = __wxPyCleanup()
5456
5457## # another possible solution, but it gets called too early...
c24da6d6
RD
5458## import atexit
5459## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
5460
5461
5462#----------------------------------------------------------------------------
5463
5464#---------------------------------------------------------------------------
5465
ae8162c8
RD
5466class EventLoop(object):
5467 def __repr__(self):
5468 return "<%s.%s; proxy of C++ wxEventLoop instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5469 def __init__(self, *args, **kwargs):
5470 """__init__(self) -> EventLoop"""
5471 newobj = _core_.new_EventLoop(*args, **kwargs)
5472 self.this = newobj.this
5473 self.thisown = 1
5474 del newobj.thisown
5475 def __del__(self, destroy=_core_.delete_EventLoop):
5476 """__del__(self)"""
5477 try:
5478 if self.thisown: destroy(self)
5479 except: pass
5480
5481 def Run(*args, **kwargs):
5482 """Run(self) -> int"""
5483 return _core_.EventLoop_Run(*args, **kwargs)
5484
5485 def Exit(*args, **kwargs):
5486 """Exit(self, int rc=0)"""
5487 return _core_.EventLoop_Exit(*args, **kwargs)
5488
5489 def Pending(*args, **kwargs):
5490 """Pending(self) -> bool"""
5491 return _core_.EventLoop_Pending(*args, **kwargs)
5492
5493 def Dispatch(*args, **kwargs):
5494 """Dispatch(self) -> bool"""
5495 return _core_.EventLoop_Dispatch(*args, **kwargs)
5496
5497 def IsRunning(*args, **kwargs):
5498 """IsRunning(self) -> bool"""
5499 return _core_.EventLoop_IsRunning(*args, **kwargs)
5500
5501 def GetActive(*args, **kwargs):
5502 """GetActive() -> EventLoop"""
5503 return _core_.EventLoop_GetActive(*args, **kwargs)
5504
5505 GetActive = staticmethod(GetActive)
5506 def SetActive(*args, **kwargs):
5507 """SetActive(EventLoop loop)"""
5508 return _core_.EventLoop_SetActive(*args, **kwargs)
5509
5510 SetActive = staticmethod(SetActive)
5511
5512class EventLoopPtr(EventLoop):
5513 def __init__(self, this):
5514 self.this = this
5515 if not hasattr(self,"thisown"): self.thisown = 0
5516 self.__class__ = EventLoop
5517_core_.EventLoop_swigregister(EventLoopPtr)
5518
5519def EventLoop_GetActive(*args, **kwargs):
5520 """EventLoop_GetActive() -> EventLoop"""
5521 return _core_.EventLoop_GetActive(*args, **kwargs)
5522
5523def EventLoop_SetActive(*args, **kwargs):
5524 """EventLoop_SetActive(EventLoop loop)"""
5525 return _core_.EventLoop_SetActive(*args, **kwargs)
5526
5527#---------------------------------------------------------------------------
5528
d55e5bfc 5529class AcceleratorEntry(object):
c24da6d6
RD
5530 """
5531 A class used to define items in an `wx.AcceleratorTable`. wxPython
5532 programs can choose to use wx.AcceleratorEntry objects, but using a
5533 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 5534 as well. See `__init__` for of the tuple values.
c24da6d6
RD
5535
5536 :see: `wx.AcceleratorTable`
5537 """
d55e5bfc
RD
5538 def __repr__(self):
5539 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5540 def __init__(self, *args, **kwargs):
c24da6d6
RD
5541 """
5542 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5543
5544 Construct a wx.AcceleratorEntry.
c24da6d6 5545 """
d55e5bfc
RD
5546 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5547 self.this = newobj.this
5548 self.thisown = 1
5549 del newobj.thisown
5550 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5551 """__del__(self)"""
5552 try:
5553 if self.thisown: destroy(self)
5554 except: pass
5555
5556 def Set(*args, **kwargs):
c24da6d6
RD
5557 """
5558 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5559
c24da6d6
RD
5560 (Re)set the attributes of a wx.AcceleratorEntry.
5561 :see `__init__`
5562 """
5563 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
5564
5565 def GetFlags(*args, **kwargs):
c24da6d6
RD
5566 """
5567 GetFlags(self) -> int
5568
5569 Get the AcceleratorEntry's flags.
5570 """
d55e5bfc
RD
5571 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5572
5573 def GetKeyCode(*args, **kwargs):
c24da6d6
RD
5574 """
5575 GetKeyCode(self) -> int
5576
5577 Get the AcceleratorEntry's keycode.
5578 """
d55e5bfc
RD
5579 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5580
5581 def GetCommand(*args, **kwargs):
c24da6d6
RD
5582 """
5583 GetCommand(self) -> int
5584
5585 Get the AcceleratorEntry's command ID.
5586 """
d55e5bfc
RD
5587 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5588
5589
5590class AcceleratorEntryPtr(AcceleratorEntry):
5591 def __init__(self, this):
5592 self.this = this
5593 if not hasattr(self,"thisown"): self.thisown = 0
5594 self.__class__ = AcceleratorEntry
5595_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5596
5597class AcceleratorTable(Object):
c24da6d6
RD
5598 """
5599 An accelerator table allows the application to specify a table of
5600 keyboard shortcuts for menus or other commands. On Windows, menu or
5601 button commands are supported; on GTK, only menu commands are
5602 supported.
c24da6d6 5603 """
d55e5bfc
RD
5604 def __repr__(self):
5605 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5606 def __init__(self, *args, **kwargs):
5607 """
5608 __init__(entries) -> AcceleratorTable
5609
c24da6d6
RD
5610 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5611 items or or of 3-tuples (flags, keyCode, cmdID)
5612
5613 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
5614 """
5615 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5616 self.this = newobj.this
5617 self.thisown = 1
5618 del newobj.thisown
5619 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5620 """__del__(self)"""
5621 try:
5622 if self.thisown: destroy(self)
5623 except: pass
5624
5625 def Ok(*args, **kwargs):
5626 """Ok(self) -> bool"""
5627 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5628
5629
5630class AcceleratorTablePtr(AcceleratorTable):
5631 def __init__(self, this):
5632 self.this = this
5633 if not hasattr(self,"thisown"): self.thisown = 0
5634 self.__class__ = AcceleratorTable
5635_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5636
5637
5638def GetAccelFromString(*args, **kwargs):
5639 """GetAccelFromString(String label) -> AcceleratorEntry"""
5640 return _core_.GetAccelFromString(*args, **kwargs)
5641#---------------------------------------------------------------------------
5642
5643class VisualAttributes(object):
5644 """struct containing all the visual attributes of a control"""
5645 def __repr__(self):
5646 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5647 def __init__(self, *args, **kwargs):
5648 """
5649 __init__(self) -> VisualAttributes
5650
5651 struct containing all the visual attributes of a control
5652 """
5653 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5654 self.this = newobj.this
5655 self.thisown = 1
5656 del newobj.thisown
5657 def __del__(self, destroy=_core_.delete_VisualAttributes):
5658 """__del__(self)"""
5659 try:
5660 if self.thisown: destroy(self)
5661 except: pass
5662
5663 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5664 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5665 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5666
5667class VisualAttributesPtr(VisualAttributes):
5668 def __init__(self, this):
5669 self.this = this
5670 if not hasattr(self,"thisown"): self.thisown = 0
5671 self.__class__ = VisualAttributes
5672_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5673NullAcceleratorTable = cvar.NullAcceleratorTable
5674PanelNameStr = cvar.PanelNameStr
5675
5676WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5677WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5678WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5679WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5680WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5681class Window(EvtHandler):
5682 """
5683 wx.Window is the base class for all windows and represents any visible
5684 object on the screen. All controls, top level windows and so on are
5685 wx.Windows. Sizers and device contexts are not however, as they don't
5686 appear on screen themselves.
5687
5688 """
5689 def __repr__(self):
5690 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5691 def __init__(self, *args, **kwargs):
5692 """
5693 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5694 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5695
5696 Construct and show a generic Window.
5697 """
5698 newobj = _core_.new_Window(*args, **kwargs)
5699 self.this = newobj.this
5700 self.thisown = 1
5701 del newobj.thisown
5702 self._setOORInfo(self)
5703
5704 def Create(*args, **kwargs):
5705 """
5706 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5707 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
5708
5709 Create the GUI part of the Window for 2-phase creation mode.
5710 """
5711 return _core_.Window_Create(*args, **kwargs)
5712
5713 def Close(*args, **kwargs):
5714 """
5715 Close(self, bool force=False) -> bool
5716
5717 This function simply generates a EVT_CLOSE event whose handler usually
5718 tries to close the window. It doesn't close the window itself,
5719 however. If force is False (the default) then the window's close
5720 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
5721 """
5722 return _core_.Window_Close(*args, **kwargs)
5723
5724 def Destroy(*args, **kwargs):
5725 """
5726 Destroy(self) -> bool
5727
5728 Destroys the window safely. Frames and dialogs are not destroyed
5729 immediately when this function is called -- they are added to a list
5730 of windows to be deleted on idle time, when all the window's events
5731 have been processed. This prevents problems with events being sent to
5732 non-existent windows.
5733
5734 Returns True if the window has either been successfully deleted, or it
5735 has been added to the list of windows pending real deletion.
5736 """
5737 return _core_.Window_Destroy(*args, **kwargs)
5738
5739 def DestroyChildren(*args, **kwargs):
5740 """
5741 DestroyChildren(self) -> bool
5742
79fccf9d
RD
5743 Destroys all children of a window. Called automatically by the
5744 destructor.
d55e5bfc
RD
5745 """
5746 return _core_.Window_DestroyChildren(*args, **kwargs)
5747
5748 def IsBeingDeleted(*args, **kwargs):
5749 """
5750 IsBeingDeleted(self) -> bool
5751
5752 Is the window in the process of being deleted?
5753 """
5754 return _core_.Window_IsBeingDeleted(*args, **kwargs)
5755
5756 def SetTitle(*args, **kwargs):
5757 """
5758 SetTitle(self, String title)
5759
5760 Sets the window's title. Applicable only to frames and dialogs.
5761 """
5762 return _core_.Window_SetTitle(*args, **kwargs)
5763
5764 def GetTitle(*args, **kwargs):
5765 """
5766 GetTitle(self) -> String
5767
5768 Gets the window's title. Applicable only to frames and dialogs.
5769 """
5770 return _core_.Window_GetTitle(*args, **kwargs)
5771
5772 def SetLabel(*args, **kwargs):
5773 """
5774 SetLabel(self, String label)
5775
5776 Set the text which the window shows in its label if applicable.
5777 """
5778 return _core_.Window_SetLabel(*args, **kwargs)
5779
5780 def GetLabel(*args, **kwargs):
5781 """
5782 GetLabel(self) -> String
5783
79fccf9d
RD
5784 Generic way of getting a label from any window, for identification
5785 purposes. The interpretation of this function differs from class to
5786 class. For frames and dialogs, the value returned is the title. For
5787 buttons or static text controls, it is the button text. This function
5788 can be useful for meta-programs such as testing tools or special-needs
5789 access programs)which need to identify windows by name.
d55e5bfc
RD
5790 """
5791 return _core_.Window_GetLabel(*args, **kwargs)
5792
5793 def SetName(*args, **kwargs):
5794 """
5795 SetName(self, String name)
5796
79fccf9d
RD
5797 Sets the window's name. The window name is used for ressource setting
5798 in X, it is not the same as the window title/label
d55e5bfc
RD
5799 """
5800 return _core_.Window_SetName(*args, **kwargs)
5801
5802 def GetName(*args, **kwargs):
5803 """
5804 GetName(self) -> String
5805
79fccf9d
RD
5806 Returns the windows name. This name is not guaranteed to be unique;
5807 it is up to the programmer to supply an appropriate name in the window
5808 constructor or via wx.Window.SetName.
d55e5bfc
RD
5809 """
5810 return _core_.Window_GetName(*args, **kwargs)
5811
5812 def SetWindowVariant(*args, **kwargs):
5813 """
5814 SetWindowVariant(self, int variant)
5815
79fccf9d
RD
5816 Sets the variant of the window/font size to use for this window, if
5817 the platform supports variants, for example, wxMac.
d55e5bfc
RD
5818 """
5819 return _core_.Window_SetWindowVariant(*args, **kwargs)
5820
5821 def GetWindowVariant(*args, **kwargs):
5822 """GetWindowVariant(self) -> int"""
5823 return _core_.Window_GetWindowVariant(*args, **kwargs)
5824
5825 def SetId(*args, **kwargs):
5826 """
5827 SetId(self, int winid)
5828
5829 Sets the identifier of the window. Each window has an integer
5830 identifier. If the application has not provided one, an identifier
5831 will be generated. Normally, the identifier should be provided on
5832 creation and should not be modified subsequently.
5833 """
5834 return _core_.Window_SetId(*args, **kwargs)
5835
5836 def GetId(*args, **kwargs):
5837 """
5838 GetId(self) -> int
5839
5840 Returns the identifier of the window. Each window has an integer
5841 identifier. If the application has not provided one (or the default Id
5842 -1 is used) then an unique identifier with a negative value will be
5843 generated.
5844 """
5845 return _core_.Window_GetId(*args, **kwargs)
5846
5847 def NewControlId(*args, **kwargs):
5848 """
c24da6d6 5849 NewControlId() -> int
d55e5bfc
RD
5850
5851 Generate a control id for the controls which were not given one.
5852 """
5853 return _core_.Window_NewControlId(*args, **kwargs)
5854
5855 NewControlId = staticmethod(NewControlId)
5856 def NextControlId(*args, **kwargs):
5857 """
c24da6d6 5858 NextControlId(int winid) -> int
d55e5bfc
RD
5859
5860 Get the id of the control following the one with the given
79fccf9d 5861 autogenerated) id
d55e5bfc
RD
5862 """
5863 return _core_.Window_NextControlId(*args, **kwargs)
5864
5865 NextControlId = staticmethod(NextControlId)
5866 def PrevControlId(*args, **kwargs):
5867 """
c24da6d6 5868 PrevControlId(int winid) -> int
d55e5bfc
RD
5869
5870 Get the id of the control preceding the one with the given
79fccf9d 5871 autogenerated) id
d55e5bfc
RD
5872 """
5873 return _core_.Window_PrevControlId(*args, **kwargs)
5874
5875 PrevControlId = staticmethod(PrevControlId)
5876 def SetSize(*args, **kwargs):
5877 """
5878 SetSize(self, Size size)
5879
5880 Sets the size of the window in pixels.
5881 """
5882 return _core_.Window_SetSize(*args, **kwargs)
5883
5884 def SetDimensions(*args, **kwargs):
5885 """
5886 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
5887
5888 Sets the position and size of the window in pixels. The sizeFlags
5889 parameter indicates the interpretation of the other params if they are
5890 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5891 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5892 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5893 dimensions of -1 and less to be interpreted as real dimensions, not
5894 default values.
5895 """
5896 return _core_.Window_SetDimensions(*args, **kwargs)
5897
5898 def SetRect(*args, **kwargs):
5899 """
5900 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
5901
5902 Sets the position and size of the window in pixels using a wx.Rect.
5903 """
5904 return _core_.Window_SetRect(*args, **kwargs)
5905
5906 def SetSizeWH(*args, **kwargs):
5907 """
5908 SetSizeWH(self, int width, int height)
5909
5910 Sets the size of the window in pixels.
5911 """
5912 return _core_.Window_SetSizeWH(*args, **kwargs)
5913
5914 def Move(*args, **kwargs):
5915 """
5916 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
5917
5918 Moves the window to the given position.
5919 """
5920 return _core_.Window_Move(*args, **kwargs)
5921
5922 SetPosition = Move
5923 def MoveXY(*args, **kwargs):
5924 """
5925 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
5926
5927 Moves the window to the given position.
5928 """
5929 return _core_.Window_MoveXY(*args, **kwargs)
5930
f8167d6e
RD
5931 def SetBestFittingSize(*args, **kwargs):
5932 """
5933 SetBestFittingSize(self, Size size=DefaultSize)
5934
5935 A 'Smart' SetSize that will fill in default size components with the
5936 window's *best size* values. Also set's the minsize for use with sizers.
5937 """
5938 return _core_.Window_SetBestFittingSize(*args, **kwargs)
5939
d55e5bfc
RD
5940 def Raise(*args, **kwargs):
5941 """
5942 Raise(self)
5943
5944 Raises the window to the top of the window hierarchy if it is a
5945 managed window (dialog or frame).
5946 """
5947 return _core_.Window_Raise(*args, **kwargs)
5948
5949 def Lower(*args, **kwargs):
5950 """
5951 Lower(self)
5952
5953 Lowers the window to the bottom of the window hierarchy if it is a
5954 managed window (dialog or frame).
5955 """
5956 return _core_.Window_Lower(*args, **kwargs)
5957
5958 def SetClientSize(*args, **kwargs):
5959 """
5960 SetClientSize(self, Size size)
5961
5962 This sets the size of the window client area in pixels. Using this
5963 function to size a window tends to be more device-independent than
5964 wx.Window.SetSize, since the application need not worry about what
5965 dimensions the border or title bar have when trying to fit the window
5966 around panel items, for example.
5967 """
5968 return _core_.Window_SetClientSize(*args, **kwargs)
5969
5970 def SetClientSizeWH(*args, **kwargs):
5971 """
5972 SetClientSizeWH(self, int width, int height)
5973
5974 This sets the size of the window client area in pixels. Using this
5975 function to size a window tends to be more device-independent than
5976 wx.Window.SetSize, since the application need not worry about what
5977 dimensions the border or title bar have when trying to fit the window
5978 around panel items, for example.
5979 """
5980 return _core_.Window_SetClientSizeWH(*args, **kwargs)
5981
5982 def SetClientRect(*args, **kwargs):
5983 """
5984 SetClientRect(self, Rect rect)
5985
5986 This sets the size of the window client area in pixels. Using this
5987 function to size a window tends to be more device-independent than
5988 wx.Window.SetSize, since the application need not worry about what
5989 dimensions the border or title bar have when trying to fit the window
5990 around panel items, for example.
5991 """
5992 return _core_.Window_SetClientRect(*args, **kwargs)
5993
5994 def GetPosition(*args, **kwargs):
5995 """
5996 GetPosition(self) -> Point
5997
5998 Get the window's position.
5999 """
6000 return _core_.Window_GetPosition(*args, **kwargs)
6001
6002 def GetPositionTuple(*args, **kwargs):
6003 """
6004 GetPositionTuple() -> (x,y)
6005
6006 Get the window's position.
6007 """
6008 return _core_.Window_GetPositionTuple(*args, **kwargs)
6009
6010 def GetSize(*args, **kwargs):
6011 """
6012 GetSize(self) -> Size
6013
6014 Get the window size.
6015 """
6016 return _core_.Window_GetSize(*args, **kwargs)
6017
6018 def GetSizeTuple(*args, **kwargs):
6019 """
6020 GetSizeTuple() -> (width, height)
6021
6022 Get the window size.
6023 """
6024 return _core_.Window_GetSizeTuple(*args, **kwargs)
6025
6026 def GetRect(*args, **kwargs):
6027 """
6028 GetRect(self) -> Rect
6029
6030 Returns the size and position of the window as a wx.Rect object.
6031 """
6032 return _core_.Window_GetRect(*args, **kwargs)
6033
6034 def GetClientSize(*args, **kwargs):
6035 """
6036 GetClientSize(self) -> Size
6037
6038 This gets the size of the window's 'client area' in pixels. The client
6039 area is the area which may be drawn on by the programmer, excluding
6040 title bar, border, scrollbars, etc.
6041 """
6042 return _core_.Window_GetClientSize(*args, **kwargs)
6043
6044 def GetClientSizeTuple(*args, **kwargs):
6045 """
6046 GetClientSizeTuple() -> (width, height)
6047
6048 This gets the size of the window's 'client area' in pixels. The client
6049 area is the area which may be drawn on by the programmer, excluding
6050 title bar, border, scrollbars, etc.
6051 """
6052 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
6053
6054 def GetClientAreaOrigin(*args, **kwargs):
6055 """
6056 GetClientAreaOrigin(self) -> Point
6057
6058 Get the origin of the client area of the window relative to the
6059 window's top left corner (the client area may be shifted because of
6060 the borders, scrollbars, other decorations...)
6061 """
6062 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
6063
6064 def GetClientRect(*args, **kwargs):
6065 """
6066 GetClientRect(self) -> Rect
6067
629f3c1b 6068 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
6069 """
6070 return _core_.Window_GetClientRect(*args, **kwargs)
6071
6072 def GetBestSize(*args, **kwargs):
6073 """
6074 GetBestSize(self) -> Size
6075
248ed943 6076 This function returns the best acceptable minimal size for the
79fccf9d
RD
6077 window, if applicable. For example, for a static text control, it will
6078 be the minimal size such that the control label is not truncated. For
6079 windows containing subwindows (suzh aswx.Panel), the size returned by
6080 this function will be the same as the size the window would have had
6081 after calling Fit.
d55e5bfc
RD
6082 """
6083 return _core_.Window_GetBestSize(*args, **kwargs)
6084
6085 def GetBestSizeTuple(*args, **kwargs):
6086 """
6087 GetBestSizeTuple() -> (width, height)
6088
248ed943 6089 This function returns the best acceptable minimal size for the
79fccf9d
RD
6090 window, if applicable. For example, for a static text control, it will
6091 be the minimal size such that the control label is not truncated. For
6092 windows containing subwindows (suzh aswx.Panel), the size returned by
6093 this function will be the same as the size the window would have had
6094 after calling Fit.
d55e5bfc
RD
6095 """
6096 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
6097
a001823c
RD
6098 def InvalidateBestSize(*args, **kwargs):
6099 """
6100 InvalidateBestSize(self)
6101
6102 Reset the cached best size value so it will be recalculated the next
6103 time it is needed.
6104 """
6105 return _core_.Window_InvalidateBestSize(*args, **kwargs)
6106
6107 def GetBestFittingSize(*args, **kwargs):
6108 """
6109 GetBestFittingSize(self) -> Size
6110
6111 This function will merge the window's best size into the window's
6112 minimum size, giving priority to the min size components, and returns
6113 the results.
6114
6115 """
6116 return _core_.Window_GetBestFittingSize(*args, **kwargs)
6117
d55e5bfc
RD
6118 def GetAdjustedBestSize(*args, **kwargs):
6119 """
6120 GetAdjustedBestSize(self) -> Size
6121
6122 This method is similar to GetBestSize, except in one
6123 thing. GetBestSize should return the minimum untruncated size of the
6124 window, while this method will return the largest of BestSize and any
6125 user specified minimum size. ie. it is the minimum size the window
6126 should currently be drawn at, not the minimal size it can possibly
6127 tolerate.
6128 """
6129 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
6130
6131 def Center(*args, **kwargs):
6132 """
6133 Center(self, int direction=BOTH)
6134
6135 Centers the window. The parameter specifies the direction for
6136 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6137 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6138 on the entire screen and not on its parent window. If it is a
6139 top-level window and has no parent then it will always be centered
6140 relative to the screen.
6141 """
6142 return _core_.Window_Center(*args, **kwargs)
6143
6144 Centre = Center
6145 def CenterOnScreen(*args, **kwargs):
6146 """
6147 CenterOnScreen(self, int dir=BOTH)
6148
6149 Center on screen (only works for top level windows)
6150 """
6151 return _core_.Window_CenterOnScreen(*args, **kwargs)
6152
6153 CentreOnScreen = CenterOnScreen
6154 def CenterOnParent(*args, **kwargs):
6155 """
6156 CenterOnParent(self, int dir=BOTH)
6157
6158 Center with respect to the the parent window
6159 """
6160 return _core_.Window_CenterOnParent(*args, **kwargs)
6161
6162 CentreOnParent = CenterOnParent
6163 def Fit(*args, **kwargs):
6164 """
6165 Fit(self)
6166
6167 Sizes the window so that it fits around its subwindows. This function
6168 won't do anything if there are no subwindows and will only really work
6169 correctly if sizers are used for the subwindows layout. Also, if the
6170 window has exactly one subwindow it is better (faster and the result
6171 is more precise as Fit adds some margin to account for fuzziness of
6172 its calculations) to call window.SetClientSize(child.GetSize())
6173 instead of calling Fit.
6174 """
6175 return _core_.Window_Fit(*args, **kwargs)
6176
6177 def FitInside(*args, **kwargs):
6178 """
6179 FitInside(self)
6180
6181 Similar to Fit, but sizes the interior (virtual) size of a
6182 window. Mainly useful with scrolled windows to reset scrollbars after
6183 sizing changes that do not trigger a size event, and/or scrolled
6184 windows without an interior sizer. This function similarly won't do
6185 anything if there are no subwindows.
6186 """
6187 return _core_.Window_FitInside(*args, **kwargs)
6188
03837c5c 6189 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD
6190 """
6191 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
6192 int incH=-1)
d55e5bfc
RD
6193
6194 Allows specification of minimum and maximum window sizes, and window
6195 size increments. If a pair of values is not set (or set to -1), the
6196 default values will be used. If this function is called, the user
908b74cd
RD
6197 will not be able to size the window outside the given bounds (if it is
6198 a top-level window.) Sizers will also inspect the minimum window size
6199 and will use that value if set when calculating layout.
6200
6201 The resizing increments are only significant under Motif or Xt.
d55e5bfc 6202 """
03837c5c 6203 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 6204
03837c5c
RD
6205 def SetSizeHintsSz(*args, **kwargs):
6206 """
6207 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6208
6209 Allows specification of minimum and maximum window sizes, and window
6210 size increments. If a pair of values is not set (or set to -1), the
6211 default values will be used. If this function is called, the user
6212 will not be able to size the window outside the given bounds (if it is
6213 a top-level window.) Sizers will also inspect the minimum window size
6214 and will use that value if set when calculating layout.
6215
6216 The resizing increments are only significant under Motif or Xt.
6217 """
6218 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6219
6220 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 6221 """
908b74cd 6222 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
6223
6224 Allows specification of minimum and maximum virtual window sizes. If a
6225 pair of values is not set (or set to -1), the default values will be
6226 used. If this function is called, the user will not be able to size
6227 the virtual area of the window outside the given bounds.
6228 """
03837c5c
RD
6229 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6230
6231 def SetVirtualSizeHintsSz(*args, **kwargs):
6232 """
6233 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6234
6235 Allows specification of minimum and maximum virtual window sizes. If a
6236 pair of values is not set (or set to -1), the default values will be
6237 used. If this function is called, the user will not be able to size
6238 the virtual area of the window outside the given bounds.
6239 """
6240 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 6241
908b74cd
RD
6242 def GetMaxSize(*args, **kwargs):
6243 """GetMaxSize(self) -> Size"""
6244 return _core_.Window_GetMaxSize(*args, **kwargs)
6245
6246 def GetMinSize(*args, **kwargs):
6247 """GetMinSize(self) -> Size"""
6248 return _core_.Window_GetMinSize(*args, **kwargs)
6249
6250 def SetMinSize(*args, **kwargs):
6251 """
6252 SetMinSize(self, Size minSize)
6253
6254 A more convenient method than `SetSizeHints` for setting just the
6255 min size.
6256 """
6257 return _core_.Window_SetMinSize(*args, **kwargs)
6258
6259 def SetMaxSize(*args, **kwargs):
6260 """
6261 SetMaxSize(self, Size maxSize)
6262
6263 A more convenient method than `SetSizeHints` for setting just the
6264 max size.
6265 """
6266 return _core_.Window_SetMaxSize(*args, **kwargs)
6267
d55e5bfc
RD
6268 def GetMinWidth(*args, **kwargs):
6269 """GetMinWidth(self) -> int"""
6270 return _core_.Window_GetMinWidth(*args, **kwargs)
6271
6272 def GetMinHeight(*args, **kwargs):
6273 """GetMinHeight(self) -> int"""
6274 return _core_.Window_GetMinHeight(*args, **kwargs)
6275
6276 def GetMaxWidth(*args, **kwargs):
6277 """GetMaxWidth(self) -> int"""
6278 return _core_.Window_GetMaxWidth(*args, **kwargs)
6279
6280 def GetMaxHeight(*args, **kwargs):
6281 """GetMaxHeight(self) -> int"""
6282 return _core_.Window_GetMaxHeight(*args, **kwargs)
6283
d55e5bfc
RD
6284 def SetVirtualSize(*args, **kwargs):
6285 """
6286 SetVirtualSize(self, Size size)
6287
6288 Set the the virtual size of a window in pixels. For most windows this
6289 is just the client area of the window, but for some like scrolled
6290 windows it is more or less independent of the screen window size.
6291 """
6292 return _core_.Window_SetVirtualSize(*args, **kwargs)
6293
6294 def SetVirtualSizeWH(*args, **kwargs):
6295 """
6296 SetVirtualSizeWH(self, int w, int h)
6297
6298 Set the the virtual size of a window in pixels. For most windows this
6299 is just the client area of the window, but for some like scrolled
6300 windows it is more or less independent of the screen window size.
6301 """
6302 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6303
6304 def GetVirtualSize(*args, **kwargs):
6305 """
6306 GetVirtualSize(self) -> Size
6307
6308 Get the the virtual size of the window in pixels. For most windows
6309 this is just the client area of the window, but for some like scrolled
6310 windows it is more or less independent of the screen window size.
6311 """
6312 return _core_.Window_GetVirtualSize(*args, **kwargs)
6313
6314 def GetVirtualSizeTuple(*args, **kwargs):
6315 """
6316 GetVirtualSizeTuple() -> (width, height)
6317
6318 Get the the virtual size of the window in pixels. For most windows
6319 this is just the client area of the window, but for some like scrolled
6320 windows it is more or less independent of the screen window size.
6321 """
6322 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6323
6324 def GetBestVirtualSize(*args, **kwargs):
6325 """
6326 GetBestVirtualSize(self) -> Size
6327
6328 Return the largest of ClientSize and BestSize (as determined by a
6329 sizer, interior children, or other means)
6330 """
6331 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6332
6333 def Show(*args, **kwargs):
6334 """
6335 Show(self, bool show=True) -> bool
6336
6337 Shows or hides the window. You may need to call Raise for a top level
6338 window if you want to bring it to top, although this is not needed if
6339 Show is called immediately after the frame creation. Returns True if
6340 the window has been shown or hidden or False if nothing was done
6341 because it already was in the requested state.
6342 """
6343 return _core_.Window_Show(*args, **kwargs)
6344
6345 def Hide(*args, **kwargs):
6346 """
6347 Hide(self) -> bool
6348
6349 Equivalent to calling Show(False).
6350 """
6351 return _core_.Window_Hide(*args, **kwargs)
6352
6353 def Enable(*args, **kwargs):
6354 """
6355 Enable(self, bool enable=True) -> bool
6356
6357 Enable or disable the window for user input. Note that when a parent
6358 window is disabled, all of its children are disabled as well and they
6359 are reenabled again when the parent is. Returns true if the window
6360 has been enabled or disabled, false if nothing was done, i.e. if the
6361 window had already been in the specified state.
6362 """
6363 return _core_.Window_Enable(*args, **kwargs)
6364
6365 def Disable(*args, **kwargs):
6366 """
6367 Disable(self) -> bool
6368
6369 Disables the window, same as Enable(false).
6370 """
6371 return _core_.Window_Disable(*args, **kwargs)
6372
6373 def IsShown(*args, **kwargs):
6374 """
6375 IsShown(self) -> bool
6376
6377 Returns true if the window is shown, false if it has been hidden.
6378 """
6379 return _core_.Window_IsShown(*args, **kwargs)
6380
6381 def IsEnabled(*args, **kwargs):
6382 """
6383 IsEnabled(self) -> bool
6384
6385 Returns true if the window is enabled for input, false otherwise.
6386 """
6387 return _core_.Window_IsEnabled(*args, **kwargs)
6388
6389 def SetWindowStyleFlag(*args, **kwargs):
6390 """
6391 SetWindowStyleFlag(self, long style)
6392
79fccf9d
RD
6393 Sets the style of the window. Please note that some styles cannot be
6394 changed after the window creation and that Refresh() might need to be
6395 called after changing the others for the change to take place
6396 immediately.
d55e5bfc
RD
6397 """
6398 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6399
6400 def GetWindowStyleFlag(*args, **kwargs):
6401 """
6402 GetWindowStyleFlag(self) -> long
6403
6404 Gets the window style that was passed to the constructor or Create
6405 method.
6406 """
6407 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6408
6409 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6410 def HasFlag(*args, **kwargs):
6411 """
6412 HasFlag(self, int flag) -> bool
6413
6414 Test if the given style is set for this window.
6415 """
6416 return _core_.Window_HasFlag(*args, **kwargs)
6417
6418 def IsRetained(*args, **kwargs):
6419 """
6420 IsRetained(self) -> bool
6421
6422 Returns true if the window is retained, false otherwise. Retained
6423 windows are only available on X platforms.
6424 """
6425 return _core_.Window_IsRetained(*args, **kwargs)
6426
6427 def SetExtraStyle(*args, **kwargs):
6428 """
6429 SetExtraStyle(self, long exStyle)
6430
6431 Sets the extra style bits for the window. Extra styles are the less
6432 often used style bits which can't be set with the constructor or with
6433 SetWindowStyleFlag()
6434 """
6435 return _core_.Window_SetExtraStyle(*args, **kwargs)
6436
6437 def GetExtraStyle(*args, **kwargs):
6438 """
6439 GetExtraStyle(self) -> long
6440
6441 Returns the extra style bits for the window.
6442 """
6443 return _core_.Window_GetExtraStyle(*args, **kwargs)
6444
6445 def MakeModal(*args, **kwargs):
6446 """
6447 MakeModal(self, bool modal=True)
6448
6449 Disables all other windows in the application so that the user can
6450 only interact with this window. Passing False will reverse this
6451 effect.
6452 """
6453 return _core_.Window_MakeModal(*args, **kwargs)
6454
6455 def SetThemeEnabled(*args, **kwargs):
6456 """
6457 SetThemeEnabled(self, bool enableTheme)
6458
6459 This function tells a window if it should use the system's "theme"
6460 code to draw the windows' background instead if its own background
6461 drawing code. This will only have an effect on platforms that support
6462 the notion of themes in user defined windows. One such platform is
6463 GTK+ where windows can have (very colourful) backgrounds defined by a
6464 user's selected theme.
6465
6466 Dialogs, notebook pages and the status bar have this flag set to true
6467 by default so that the default look and feel is simulated best.
6468 """
6469 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6470
6471 def GetThemeEnabled(*args, **kwargs):
6472 """
6473 GetThemeEnabled(self) -> bool
6474
6475 Return the themeEnabled flag.
6476 """
6477 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6478
6479 def SetFocus(*args, **kwargs):
6480 """
6481 SetFocus(self)
6482
6483 Set's the focus to this window, allowing it to receive keyboard input.
6484 """
6485 return _core_.Window_SetFocus(*args, **kwargs)
6486
6487 def SetFocusFromKbd(*args, **kwargs):
6488 """
6489 SetFocusFromKbd(self)
6490
6491 Set focus to this window as the result of a keyboard action. Normally
6492 only called internally.
6493 """
6494 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6495
6496 def FindFocus(*args, **kwargs):
6497 """
c24da6d6 6498 FindFocus() -> Window
d55e5bfc
RD
6499
6500 Returns the window or control that currently has the keyboard focus,
6501 or None.
6502 """
6503 return _core_.Window_FindFocus(*args, **kwargs)
6504
6505 FindFocus = staticmethod(FindFocus)
6506 def AcceptsFocus(*args, **kwargs):
6507 """
6508 AcceptsFocus(self) -> bool
6509
6510 Can this window have focus?
6511 """
6512 return _core_.Window_AcceptsFocus(*args, **kwargs)
6513
6514 def AcceptsFocusFromKeyboard(*args, **kwargs):
6515 """
6516 AcceptsFocusFromKeyboard(self) -> bool
6517
6518 Can this window be given focus by keyboard navigation? if not, the
6519 only way to give it focus (provided it accepts it at all) is to click
6520 it.
6521 """
6522 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6523
6524 def GetDefaultItem(*args, **kwargs):
6525 """
6526 GetDefaultItem(self) -> Window
6527
6528 Get the default child of this parent, i.e. the one which is activated
6529 by pressing <Enter> such as the OK button on a wx.Dialog.
6530 """
6531 return _core_.Window_GetDefaultItem(*args, **kwargs)
6532
6533 def SetDefaultItem(*args, **kwargs):
6534 """
6535 SetDefaultItem(self, Window child) -> Window
6536
6537 Set this child as default, return the old default.
6538 """
6539 return _core_.Window_SetDefaultItem(*args, **kwargs)
6540
6541 def SetTmpDefaultItem(*args, **kwargs):
6542 """
6543 SetTmpDefaultItem(self, Window win)
6544
6545 Set this child as temporary default
6546 """
6547 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6548
908b74cd
RD
6549 def Navigate(*args, **kwargs):
6550 """
6551 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6552
a8eff060
RD
6553 Does keyboard navigation from this window to another, by sending a
6554 `wx.NavigationKeyEvent`.
908b74cd
RD
6555 """
6556 return _core_.Window_Navigate(*args, **kwargs)
6557
bf26d883
RD
6558 def MoveAfterInTabOrder(*args, **kwargs):
6559 """
6560 MoveAfterInTabOrder(self, Window win)
6561
6562 Moves this window in the tab navigation order after the specified
6563 sibling window. This means that when the user presses the TAB key on
6564 that other window, the focus switches to this window.
6565
6566 The default tab order is the same as creation order. This function
6567 and `MoveBeforeInTabOrder` allow to change it after creating all the
6568 windows.
6569
6570 """
6571 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6572
6573 def MoveBeforeInTabOrder(*args, **kwargs):
6574 """
6575 MoveBeforeInTabOrder(self, Window win)
6576
6577 Same as `MoveAfterInTabOrder` except that it inserts this window just
6578 before win instead of putting it right after it.
6579 """
6580 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6581
d55e5bfc
RD
6582 def GetChildren(*args, **kwargs):
6583 """
6584 GetChildren(self) -> PyObject
6585
6586 Returns a list of the window's children. NOTE: Currently this is a
6587 copy of the child window list maintained by the window, so the return
6588 value of this function is only valid as long as the window's children
6589 do not change.
6590 """
6591 return _core_.Window_GetChildren(*args, **kwargs)
6592
6593 def GetParent(*args, **kwargs):
6594 """
6595 GetParent(self) -> Window
6596
6597 Returns the parent window of this window, or None if there isn't one.
6598 """
6599 return _core_.Window_GetParent(*args, **kwargs)
6600
6601 def GetGrandParent(*args, **kwargs):
6602 """
6603 GetGrandParent(self) -> Window
6604
79fccf9d
RD
6605 Returns the parent of the parent of this window, or None if there
6606 isn't one.
d55e5bfc
RD
6607 """
6608 return _core_.Window_GetGrandParent(*args, **kwargs)
6609
6610 def IsTopLevel(*args, **kwargs):
6611 """
6612 IsTopLevel(self) -> bool
6613
6614 Returns true if the given window is a top-level one. Currently all
6615 frames and dialogs are always considered to be top-level windows (even
6616 if they have a parent window).
6617 """
6618 return _core_.Window_IsTopLevel(*args, **kwargs)
6619
6620 def Reparent(*args, **kwargs):
6621 """
6622 Reparent(self, Window newParent) -> bool
6623
6624 Reparents the window, i.e the window will be removed from its current
6625 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6626 re-inserted into another. Available on Windows and GTK. Returns True
6627 if the parent was changed, False otherwise (error or newParent ==
6628 oldParent)
6629 """
6630 return _core_.Window_Reparent(*args, **kwargs)
6631
6632 def AddChild(*args, **kwargs):
6633 """
6634 AddChild(self, Window child)
6635
6636 Adds a child window. This is called automatically by window creation
6637 functions so should not be required by the application programmer.
6638 """
6639 return _core_.Window_AddChild(*args, **kwargs)
6640
6641 def RemoveChild(*args, **kwargs):
6642 """
6643 RemoveChild(self, Window child)
6644
6645 Removes a child window. This is called automatically by window
6646 deletion functions so should not be required by the application
6647 programmer.
6648 """
6649 return _core_.Window_RemoveChild(*args, **kwargs)
6650
6651 def FindWindowById(*args, **kwargs):
6652 """
6653 FindWindowById(self, long winid) -> Window
6654
6655 Find a chld of this window by window ID
6656 """
6657 return _core_.Window_FindWindowById(*args, **kwargs)
6658
6659 def FindWindowByName(*args, **kwargs):
6660 """
6661 FindWindowByName(self, String name) -> Window
6662
6663 Find a child of this window by name
6664 """
6665 return _core_.Window_FindWindowByName(*args, **kwargs)
6666
6667 def GetEventHandler(*args, **kwargs):
6668 """
6669 GetEventHandler(self) -> EvtHandler
6670
6671 Returns the event handler for this window. By default, the window is
6672 its own event handler.
6673 """
6674 return _core_.Window_GetEventHandler(*args, **kwargs)
6675
6676 def SetEventHandler(*args, **kwargs):
6677 """
6678 SetEventHandler(self, EvtHandler handler)
6679
6680 Sets the event handler for this window. An event handler is an object
6681 that is capable of processing the events sent to a window. By default,
6682 the window is its own event handler, but an application may wish to
6683 substitute another, for example to allow central implementation of
6684 event-handling for a variety of different window classes.
6685
79fccf9d 6686 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
6687 up a chain of event handlers, where an event not handled by one event
6688 handler is handed to the next one in the chain.
6689 """
6690 return _core_.Window_SetEventHandler(*args, **kwargs)
6691
6692 def PushEventHandler(*args, **kwargs):
6693 """
6694 PushEventHandler(self, EvtHandler handler)
6695
6696 Pushes this event handler onto the event handler stack for the window.
6697 An event handler is an object that is capable of processing the events
6698 sent to a window. By default, the window is its own event handler, but
6699 an application may wish to substitute another, for example to allow
6700 central implementation of event-handling for a variety of different
6701 window classes.
6702
6703 wx.Window.PushEventHandler allows an application to set up a chain of
6704 event handlers, where an event not handled by one event handler is
79fccf9d 6705 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
6706 remove the event handler.
6707 """
6708 return _core_.Window_PushEventHandler(*args, **kwargs)
6709
6710 def PopEventHandler(*args, **kwargs):
6711 """
6712 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
6713
6714 Removes and returns the top-most event handler on the event handler
6715 stack. If deleteHandler is True then the wx.EvtHandler object will be
6716 destroyed after it is popped.
6717 """
6718 return _core_.Window_PopEventHandler(*args, **kwargs)
6719
6720 def RemoveEventHandler(*args, **kwargs):
6721 """
6722 RemoveEventHandler(self, EvtHandler handler) -> bool
6723
79fccf9d
RD
6724 Find the given handler in the event handler chain and remove (but not
6725 delete) it from the event handler chain, return True if it was found
6726 and False otherwise (this also results in an assert failure so this
6727 function should only be called when the handler is supposed to be
6728 there.)
d55e5bfc
RD
6729 """
6730 return _core_.Window_RemoveEventHandler(*args, **kwargs)
6731
6732 def SetValidator(*args, **kwargs):
6733 """
6734 SetValidator(self, Validator validator)
6735
6736 Deletes the current validator (if any) and sets the window validator,
6737 having called wx.Validator.Clone to create a new validator of this
6738 type.
6739 """
6740 return _core_.Window_SetValidator(*args, **kwargs)
6741
6742 def GetValidator(*args, **kwargs):
6743 """
6744 GetValidator(self) -> Validator
6745
6746 Returns a pointer to the current validator for the window, or None if
6747 there is none.
6748 """
6749 return _core_.Window_GetValidator(*args, **kwargs)
6750
6751 def Validate(*args, **kwargs):
6752 """
6753 Validate(self) -> bool
6754
6755 Validates the current values of the child controls using their
79fccf9d
RD
6756 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6757 style flag set, the method will also call Validate() of all child
6758 windows. Returns false if any of the validations failed.
d55e5bfc
RD
6759 """
6760 return _core_.Window_Validate(*args, **kwargs)
6761
6762 def TransferDataToWindow(*args, **kwargs):
6763 """
6764 TransferDataToWindow(self) -> bool
6765
79fccf9d
RD
6766 Transfers values to child controls from data areas specified by their
6767 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6768 style flag set, the method will also call TransferDataToWindow() of
6769 all child windows.
d55e5bfc
RD
6770 """
6771 return _core_.Window_TransferDataToWindow(*args, **kwargs)
6772
6773 def TransferDataFromWindow(*args, **kwargs):
6774 """
6775 TransferDataFromWindow(self) -> bool
6776
79fccf9d
RD
6777 Transfers values from child controls to data areas specified by their
6778 validators. Returns false if a transfer failed. If the window has
6779 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6780 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
6781 """
6782 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
6783
6784 def InitDialog(*args, **kwargs):
6785 """
6786 InitDialog(self)
6787
79fccf9d
RD
6788 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6789 to the dialog via validators.
d55e5bfc
RD
6790 """
6791 return _core_.Window_InitDialog(*args, **kwargs)
6792
6793 def SetAcceleratorTable(*args, **kwargs):
6794 """
6795 SetAcceleratorTable(self, AcceleratorTable accel)
6796
6797 Sets the accelerator table for this window.
6798 """
6799 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
6800
6801 def GetAcceleratorTable(*args, **kwargs):
6802 """
6803 GetAcceleratorTable(self) -> AcceleratorTable
6804
6805 Gets the accelerator table for this window.
6806 """
6807 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
6808
6809 def RegisterHotKey(*args, **kwargs):
6810 """
6811 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
6812
6813 Registers a system wide hotkey. Every time the user presses the hotkey
6814 registered here, this window will receive a hotkey event. It will
6815 receive the event even if the application is in the background and
6816 does not have the input focus because the user is working with some
6817 other application. To bind an event handler function to this hotkey
6818 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6819 hotkey was registered successfully.
6820 """
6821 return _core_.Window_RegisterHotKey(*args, **kwargs)
6822
6823 def UnregisterHotKey(*args, **kwargs):
6824 """
6825 UnregisterHotKey(self, int hotkeyId) -> bool
6826
6827 Unregisters a system wide hotkey.
6828 """
6829 return _core_.Window_UnregisterHotKey(*args, **kwargs)
6830
6831 def ConvertDialogPointToPixels(*args, **kwargs):
6832 """
6833 ConvertDialogPointToPixels(self, Point pt) -> Point
6834
6835 Converts a point or size from dialog units to pixels. Dialog units
6836 are used for maintaining a dialog's proportions even if the font
6837 changes. For the x dimension, the dialog units are multiplied by the
6838 average character width and then divided by 4. For the y dimension,
6839 the dialog units are multiplied by the average character height and
6840 then divided by 8.
6841 """
6842 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
6843
6844 def ConvertDialogSizeToPixels(*args, **kwargs):
6845 """
6846 ConvertDialogSizeToPixels(self, Size sz) -> Size
6847
6848 Converts a point or size from dialog units to pixels. Dialog units
6849 are used for maintaining a dialog's proportions even if the font
6850 changes. For the x dimension, the dialog units are multiplied by the
6851 average character width and then divided by 4. For the y dimension,
6852 the dialog units are multiplied by the average character height and
6853 then divided by 8.
6854 """
6855 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
6856
6857 def DLG_PNT(*args, **kwargs):
6858 """
6859 DLG_PNT(self, Point pt) -> Point
6860
6861 Converts a point or size from dialog units to pixels. Dialog units
6862 are used for maintaining a dialog's proportions even if the font
6863 changes. For the x dimension, the dialog units are multiplied by the
6864 average character width and then divided by 4. For the y dimension,
6865 the dialog units are multiplied by the average character height and
6866 then divided by 8.
6867 """
6868 return _core_.Window_DLG_PNT(*args, **kwargs)
6869
6870 def DLG_SZE(*args, **kwargs):
6871 """
6872 DLG_SZE(self, Size sz) -> Size
6873
6874 Converts a point or size from dialog units to pixels. Dialog units
6875 are used for maintaining a dialog's proportions even if the font
6876 changes. For the x dimension, the dialog units are multiplied by the
6877 average character width and then divided by 4. For the y dimension,
6878 the dialog units are multiplied by the average character height and
6879 then divided by 8.
6880 """
6881 return _core_.Window_DLG_SZE(*args, **kwargs)
6882
6883 def ConvertPixelPointToDialog(*args, **kwargs):
6884 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
6885 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
6886
6887 def ConvertPixelSizeToDialog(*args, **kwargs):
6888 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
6889 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
6890
6891 def WarpPointer(*args, **kwargs):
6892 """
6893 WarpPointer(self, int x, int y)
6894
6895 Moves the pointer to the given position on the window.
6896
6897 NOTE: This function is not supported under Mac because Apple Human
6898 Interface Guidelines forbid moving the mouse cursor programmatically.
6899 """
6900 return _core_.Window_WarpPointer(*args, **kwargs)
6901
6902 def CaptureMouse(*args, **kwargs):
6903 """
6904 CaptureMouse(self)
6905
6906 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6907 release the capture.
6908
6909 Note that wxWindows maintains the stack of windows having captured the
6910 mouse and when the mouse is released the capture returns to the window
6911 which had had captured it previously and it is only really released if
6912 there were no previous window. In particular, this means that you must
6913 release the mouse as many times as you capture it.
6914 """
6915 return _core_.Window_CaptureMouse(*args, **kwargs)
6916
6917 def ReleaseMouse(*args, **kwargs):
6918 """
6919 ReleaseMouse(self)
6920
6921 Releases mouse input captured with wx.Window.CaptureMouse.
6922 """
6923 return _core_.Window_ReleaseMouse(*args, **kwargs)
6924
6925 def GetCapture(*args, **kwargs):
6926 """
c24da6d6 6927 GetCapture() -> Window
d55e5bfc
RD
6928
6929 Returns the window which currently captures the mouse or None
6930 """
6931 return _core_.Window_GetCapture(*args, **kwargs)
6932
6933 GetCapture = staticmethod(GetCapture)
6934 def HasCapture(*args, **kwargs):
6935 """
6936 HasCapture(self) -> bool
6937
6938 Returns true if this window has the current mouse capture.
6939 """
6940 return _core_.Window_HasCapture(*args, **kwargs)
6941
6942 def Refresh(*args, **kwargs):
6943 """
6944 Refresh(self, bool eraseBackground=True, Rect rect=None)
6945
6946 Mark the specified rectangle (or the whole window) as "dirty" so it
6947 will be repainted. Causes an EVT_PAINT event to be generated and sent
6948 to the window.
6949 """
6950 return _core_.Window_Refresh(*args, **kwargs)
6951
6952 def RefreshRect(*args, **kwargs):
6953 """
6954 RefreshRect(self, Rect rect)
6955
6956 Redraws the contents of the given rectangle: the area inside it will
6957 be repainted. This is the same as Refresh but has a nicer syntax.
6958 """
6959 return _core_.Window_RefreshRect(*args, **kwargs)
6960
6961 def Update(*args, **kwargs):
6962 """
6963 Update(self)
6964
6965 Calling this method immediately repaints the invalidated area of the
6966 window instead of waiting for the EVT_PAINT event to happen, (normally
6967 this would usually only happen when the flow of control returns to the
6968 event loop.) Notice that this function doesn't refresh the window and
6969 does nothing if the window has been already repainted. Use Refresh
6970 first if you want to immediately redraw the window (or some portion of
6971 it) unconditionally.
6972 """
6973 return _core_.Window_Update(*args, **kwargs)
6974
6975 def ClearBackground(*args, **kwargs):
6976 """
6977 ClearBackground(self)
6978
6979 Clears the window by filling it with the current background
6980 colour. Does not cause an erase background event to be generated.
6981 """
6982 return _core_.Window_ClearBackground(*args, **kwargs)
6983
6984 def Freeze(*args, **kwargs):
6985 """
6986 Freeze(self)
6987
79fccf9d
RD
6988 Freezes the window or, in other words, prevents any updates from
6989 taking place on screen, the window is not redrawn at all. Thaw must be
6990 called to reenable window redrawing. Calls to Freeze/Thaw may be
6991 nested, with the actual Thaw being delayed until all the nesting has
6992 been undone.
d55e5bfc
RD
6993
6994 This method is useful for visual appearance optimization (for example,
6995 it is a good idea to use it before inserting large amount of text into
6996 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6997 for all controls so it is mostly just a hint to wxWindows and not a
6998 mandatory directive.
6999 """
7000 return _core_.Window_Freeze(*args, **kwargs)
7001
7002 def Thaw(*args, **kwargs):
7003 """
7004 Thaw(self)
7005
7006 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD
7007 Freeze/Thaw may be nested, so Thaw must be called the same number of
7008 times that Freeze was before the window will be updated.
d55e5bfc
RD
7009 """
7010 return _core_.Window_Thaw(*args, **kwargs)
7011
7012 def PrepareDC(*args, **kwargs):
7013 """
7014 PrepareDC(self, DC dc)
7015
7016 Call this function to prepare the device context for drawing a
7017 scrolled image. It sets the device origin according to the current
7018 scroll position.
7019 """
7020 return _core_.Window_PrepareDC(*args, **kwargs)
7021
7022 def GetUpdateRegion(*args, **kwargs):
7023 """
7024 GetUpdateRegion(self) -> Region
7025
7026 Returns the region specifying which parts of the window have been
7027 damaged. Should only be called within an EVT_PAINT handler.
7028 """
7029 return _core_.Window_GetUpdateRegion(*args, **kwargs)
7030
7031 def GetUpdateClientRect(*args, **kwargs):
7032 """
7033 GetUpdateClientRect(self) -> Rect
7034
7035 Get the update rectangle region bounding box in client coords.
7036 """
7037 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
7038
7039 def IsExposed(*args, **kwargs):
7040 """
7041 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
7042
7043 Returns true if the given point or rectangle area has been exposed
7044 since the last repaint. Call this in an paint event handler to
7045 optimize redrawing by only redrawing those areas, which have been
7046 exposed.
7047 """
7048 return _core_.Window_IsExposed(*args, **kwargs)
7049
7050 def IsExposedPoint(*args, **kwargs):
7051 """
7052 IsExposedPoint(self, Point pt) -> bool
7053
7054 Returns true if the given point or rectangle area has been exposed
7055 since the last repaint. Call this in an paint event handler to
7056 optimize redrawing by only redrawing those areas, which have been
7057 exposed.
7058 """
7059 return _core_.Window_IsExposedPoint(*args, **kwargs)
7060
7061 def IsExposedRect(*args, **kwargs):
7062 """
7063 IsExposedRect(self, Rect rect) -> bool
7064
7065 Returns true if the given point or rectangle area has been exposed
7066 since the last repaint. Call this in an paint event handler to
7067 optimize redrawing by only redrawing those areas, which have been
7068 exposed.
7069 """
7070 return _core_.Window_IsExposedRect(*args, **kwargs)
7071
7072 def GetDefaultAttributes(*args, **kwargs):
7073 """
7074 GetDefaultAttributes(self) -> VisualAttributes
7075
79fccf9d
RD
7076 Get the default attributes for an instance of this class. This is
7077 useful if you want to use the same font or colour in your own control
7078 as in a standard control -- which is a much better idea than hard
7079 coding specific colours or fonts which might look completely out of
caef1a4d 7080 place on the user's system, especially if it uses themes.
d55e5bfc
RD
7081 """
7082 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
7083
7084 def GetClassDefaultAttributes(*args, **kwargs):
7085 """
c24da6d6 7086 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 7087
79fccf9d
RD
7088 Get the default attributes for this class. This is useful if you want
7089 to use the same font or colour in your own control as in a standard
7090 control -- which is a much better idea than hard coding specific
caef1a4d
RD
7091 colours or fonts which might look completely out of place on the
7092 user's system, especially if it uses themes.
d55e5bfc
RD
7093
7094 The variant parameter is only relevant under Mac currently and is
79fccf9d 7095 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
7096 the returned font. See `wx.Window.SetWindowVariant` for more about
7097 this.
d55e5bfc
RD
7098 """
7099 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7100
7101 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
7102 def SetBackgroundColour(*args, **kwargs):
7103 """
7104 SetBackgroundColour(self, Colour colour) -> bool
7105
7106 Sets the background colour of the window. Returns True if the colour
7107 was changed. The background colour is usually painted by the default
7108 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
7109 automatically under GTK. Using `wx.NullColour` will reset the window
7110 to the default background colour.
d55e5bfc 7111
caef1a4d 7112 Note that setting the background colour may not cause an immediate
f8167d6e 7113 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
7114 calling this function.
7115
f8167d6e
RD
7116 Using this function will disable attempts to use themes for this
7117 window, if the system supports them. Use with care since usually the
7118 themes represent the appearance chosen by the user to be used for all
7119 applications on the system.
d55e5bfc
RD
7120 """
7121 return _core_.Window_SetBackgroundColour(*args, **kwargs)
7122
412d302d
RD
7123 def SetOwnBackgroundColour(*args, **kwargs):
7124 """SetOwnBackgroundColour(self, Colour colour)"""
7125 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD
7126
7127 def SetForegroundColour(*args, **kwargs):
7128 """
7129 SetForegroundColour(self, Colour colour) -> bool
7130
7131 Sets the foreground colour of the window. Returns True is the colour
7132 was changed. The interpretation of foreground colour is dependent on
7133 the window class; it may be the text colour or other colour, or it may
7134 not be used at all.
7135 """
7136 return _core_.Window_SetForegroundColour(*args, **kwargs)
7137
fa47d7a7
VS
7138 def SetOwnForegroundColour(*args, **kwargs):
7139 """SetOwnForegroundColour(self, Colour colour)"""
7140 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
7141
7142 def GetBackgroundColour(*args, **kwargs):
7143 """
7144 GetBackgroundColour(self) -> Colour
7145
7146 Returns the background colour of the window.
7147 """
7148 return _core_.Window_GetBackgroundColour(*args, **kwargs)
7149
7150 def GetForegroundColour(*args, **kwargs):
7151 """
7152 GetForegroundColour(self) -> Colour
7153
7154 Returns the foreground colour of the window. The interpretation of
7155 foreground colour is dependent on the window class; it may be the text
7156 colour or other colour, or it may not be used at all.
7157 """
7158 return _core_.Window_GetForegroundColour(*args, **kwargs)
7159
0f63ec68
RD
7160 def SetBackgroundStyle(*args, **kwargs):
7161 """
7162 SetBackgroundStyle(self, int style) -> bool
7163
7164 Returns the background style of the window. The background style
7165 indicates how the background of the window is drawn.
7166
7167 ====================== ========================================
7168 wx.BG_STYLE_SYSTEM The background colour or pattern should
7169 be determined by the system
7170 wx.BG_STYLE_COLOUR The background should be a solid colour
7171 wx.BG_STYLE_CUSTOM The background will be implemented by the
7172 application.
7173 ====================== ========================================
7174
7175 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7176 a custom background, such as a tiled bitmap. Currently the style has
7177 no effect on other platforms.
7178
7179 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7180 """
7181 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7182
7183 def GetBackgroundStyle(*args, **kwargs):
7184 """
7185 GetBackgroundStyle(self) -> int
7186
7187 Returns the background style of the window.
7188
7189 :see: `SetBackgroundStyle`
7190 """
7191 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7192
d55e5bfc
RD
7193 def SetCursor(*args, **kwargs):
7194 """
7195 SetCursor(self, Cursor cursor) -> bool
7196
7197 Sets the window's cursor. Notice that the window cursor also sets it
7198 for the children of the window implicitly.
7199
7200 The cursor may be wx.NullCursor in which case the window cursor will
7201 be reset back to default.
7202 """
7203 return _core_.Window_SetCursor(*args, **kwargs)
7204
7205 def GetCursor(*args, **kwargs):
7206 """
7207 GetCursor(self) -> Cursor
7208
7209 Return the cursor associated with this window.
7210 """
7211 return _core_.Window_GetCursor(*args, **kwargs)
7212
7213 def SetFont(*args, **kwargs):
7214 """
7215 SetFont(self, Font font) -> bool
7216
7217 Sets the font for this window.
7218 """
7219 return _core_.Window_SetFont(*args, **kwargs)
7220
fa47d7a7
VS
7221 def SetOwnFont(*args, **kwargs):
7222 """SetOwnFont(self, Font font)"""
7223 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
7224
7225 def GetFont(*args, **kwargs):
7226 """
7227 GetFont(self) -> Font
7228
7229 Returns the default font used for this window.
7230 """
7231 return _core_.Window_GetFont(*args, **kwargs)
7232
7233 def SetCaret(*args, **kwargs):
7234 """
7235 SetCaret(self, Caret caret)
7236
7237 Sets the caret associated with the window.
7238 """
7239 return _core_.Window_SetCaret(*args, **kwargs)
7240
7241 def GetCaret(*args, **kwargs):
7242 """
7243 GetCaret(self) -> Caret
7244
7245 Returns the caret associated with the window.
7246 """
7247 return _core_.Window_GetCaret(*args, **kwargs)
7248
7249 def GetCharHeight(*args, **kwargs):
7250 """
7251 GetCharHeight(self) -> int
7252
7253 Get the (average) character size for the current font.
7254 """
7255 return _core_.Window_GetCharHeight(*args, **kwargs)
7256
7257 def GetCharWidth(*args, **kwargs):
7258 """
7259 GetCharWidth(self) -> int
7260
7261 Get the (average) character size for the current font.
7262 """
7263 return _core_.Window_GetCharWidth(*args, **kwargs)
7264
7265 def GetTextExtent(*args, **kwargs):
a8eff060
RD
7266 """
7267 GetTextExtent(String string) -> (width, height)
7268
7269 Get the width and height of the text using the current font.
7270 """
d55e5bfc
RD
7271 return _core_.Window_GetTextExtent(*args, **kwargs)
7272
7273 def GetFullTextExtent(*args, **kwargs):
7274 """
7275 GetFullTextExtent(String string, Font font=None) ->
7276 (width, height, descent, externalLeading)
7277
7278 Get the width, height, decent and leading of the text using the
7279 current or specified font.
7280 """
7281 return _core_.Window_GetFullTextExtent(*args, **kwargs)
7282
7283 def ClientToScreenXY(*args, **kwargs):
7284 """
7285 ClientToScreenXY(int x, int y) -> (x,y)
7286
7287 Converts to screen coordinates from coordinates relative to this window.
7288 """
7289 return _core_.Window_ClientToScreenXY(*args, **kwargs)
7290
7291 def ScreenToClientXY(*args, **kwargs):
7292 """
7293 ScreenToClientXY(int x, int y) -> (x,y)
7294
7295 Converts from screen to client window coordinates.
7296 """
7297 return _core_.Window_ScreenToClientXY(*args, **kwargs)
7298
7299 def ClientToScreen(*args, **kwargs):
7300 """
7301 ClientToScreen(self, Point pt) -> Point
7302
7303 Converts to screen coordinates from coordinates relative to this window.
7304 """
7305 return _core_.Window_ClientToScreen(*args, **kwargs)
7306
7307 def ScreenToClient(*args, **kwargs):
7308 """
7309 ScreenToClient(self, Point pt) -> Point
7310
7311 Converts from screen to client window coordinates.
7312 """
7313 return _core_.Window_ScreenToClient(*args, **kwargs)
7314
7315 def HitTestXY(*args, **kwargs):
7316 """
7317 HitTestXY(self, int x, int y) -> int
7318
7319 Test where the given (in client coords) point lies
7320 """
7321 return _core_.Window_HitTestXY(*args, **kwargs)
7322
7323 def HitTest(*args, **kwargs):
7324 """
7325 HitTest(self, Point pt) -> int
7326
7327 Test where the given (in client coords) point lies
7328 """
7329 return _core_.Window_HitTest(*args, **kwargs)
7330
7331 def GetBorder(*args):
7332 """
7333 GetBorder(self, long flags) -> int
7334 GetBorder(self) -> int
7335
7336 Get border for the flags of this window
7337 """
7338 return _core_.Window_GetBorder(*args)
7339
7340 def UpdateWindowUI(*args, **kwargs):
7341 """
7342 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
7343
7344 This function sends EVT_UPDATE_UI events to the window. The particular
7345 implementation depends on the window; for example a wx.ToolBar will
7346 send an update UI event for each toolbar button, and a wx.Frame will
7347 send an update UI event for each menubar menu item. You can call this
7348 function from your application to ensure that your UI is up-to-date at
7349 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7350 concerned). This may be necessary if you have called
7351 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7352 limit the overhead that wxWindows incurs by sending update UI events
7353 in idle time.
d55e5bfc
RD
7354 """
7355 return _core_.Window_UpdateWindowUI(*args, **kwargs)
7356
7357 def PopupMenuXY(*args, **kwargs):
7358 """
7a0b95b0 7359 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7360
7a0b95b0
RD
7361 Pops up the given menu at the specified coordinates, relative to this window,
7362 and returns control when the user has dismissed the menu. If a menu item is
7363 selected, the corresponding menu event is generated and will be processed as
7364 usual. If the default position is given then the current position of the
7365 mouse cursor will be used.
d55e5bfc
RD
7366 """
7367 return _core_.Window_PopupMenuXY(*args, **kwargs)
7368
7369 def PopupMenu(*args, **kwargs):
7370 """
7a0b95b0 7371 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7372
7a0b95b0
RD
7373 Pops up the given menu at the specified coordinates, relative to this window,
7374 and returns control when the user has dismissed the menu. If a menu item is
7375 selected, the corresponding menu event is generated and will be processed as
7376 usual. If the default position is given then the current position of the
7377 mouse cursor will be used.
d55e5bfc
RD
7378 """
7379 return _core_.Window_PopupMenu(*args, **kwargs)
7380
7381 def GetHandle(*args, **kwargs):
7382 """
7383 GetHandle(self) -> long
7384
7385 Returns the platform-specific handle (as a long integer) of the
7386 physical window. Currently on wxMac it returns the handle of the
7387 toplevel parent of the window.
7388 """
7389 return _core_.Window_GetHandle(*args, **kwargs)
7390
629e65c2
RD
7391 def AssociateHandle(*args, **kwargs):
7392 """
7393 AssociateHandle(self, long handle)
7394
7395 Associate the window with a new native handle
7396 """
7397 return _core_.Window_AssociateHandle(*args, **kwargs)
7398
7399 def DissociateHandle(*args, **kwargs):
7400 """
7401 DissociateHandle(self)
7402
7403 Dissociate the current native handle from the window
7404 """
7405 return _core_.Window_DissociateHandle(*args, **kwargs)
7406
d55e5bfc
RD
7407 def OnPaint(*args, **kwargs):
7408 """OnPaint(self, PaintEvent event)"""
7409 return _core_.Window_OnPaint(*args, **kwargs)
7410
7411 def HasScrollbar(*args, **kwargs):
7412 """
7413 HasScrollbar(self, int orient) -> bool
7414
7415 Does the window have the scrollbar for this orientation?
7416 """
7417 return _core_.Window_HasScrollbar(*args, **kwargs)
7418
7419 def SetScrollbar(*args, **kwargs):
7420 """
79fccf9d 7421 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
7422 bool refresh=True)
7423
7424 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
7425 """
7426 return _core_.Window_SetScrollbar(*args, **kwargs)
7427
7428 def SetScrollPos(*args, **kwargs):
7429 """
7430 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7431
7432 Sets the position of one of the built-in scrollbars.
7433 """
7434 return _core_.Window_SetScrollPos(*args, **kwargs)
7435
7436 def GetScrollPos(*args, **kwargs):
7437 """
7438 GetScrollPos(self, int orientation) -> int
7439
7440 Returns the built-in scrollbar position.
7441 """
7442 return _core_.Window_GetScrollPos(*args, **kwargs)
7443
7444 def GetScrollThumb(*args, **kwargs):
7445 """
7446 GetScrollThumb(self, int orientation) -> int
7447
7448 Returns the built-in scrollbar thumb size.
7449 """
7450 return _core_.Window_GetScrollThumb(*args, **kwargs)
7451
7452 def GetScrollRange(*args, **kwargs):
7453 """
7454 GetScrollRange(self, int orientation) -> int
7455
7456 Returns the built-in scrollbar range.
7457 """
7458 return _core_.Window_GetScrollRange(*args, **kwargs)
7459
7460 def ScrollWindow(*args, **kwargs):
7461 """
7462 ScrollWindow(self, int dx, int dy, Rect rect=None)
7463
7464 Physically scrolls the pixels in the window and move child windows
7465 accordingly. Use this function to optimise your scrolling
7466 implementations, to minimise the area that must be redrawn. Note that
7467 it is rarely required to call this function from a user program.
d55e5bfc
RD
7468 """
7469 return _core_.Window_ScrollWindow(*args, **kwargs)
7470
7471 def ScrollLines(*args, **kwargs):
7472 """
7473 ScrollLines(self, int lines) -> bool
7474
7475 If the platform and window class supports it, scrolls the window by
7476 the given number of lines down, if lines is positive, or up if lines
7477 is negative. Returns True if the window was scrolled, False if it was
7478 already on top/bottom and nothing was done.
7479 """
7480 return _core_.Window_ScrollLines(*args, **kwargs)
7481
7482 def ScrollPages(*args, **kwargs):
7483 """
7484 ScrollPages(self, int pages) -> bool
7485
79fccf9d 7486 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
7487 the given number of pages down, if pages is positive, or up if pages
7488 is negative. Returns True if the window was scrolled, False if it was
7489 already on top/bottom and nothing was done.
7490 """
7491 return _core_.Window_ScrollPages(*args, **kwargs)
7492
7493 def LineUp(*args, **kwargs):
7494 """
7495 LineUp(self) -> bool
7496
7497 This is just a wrapper for ScrollLines(-1).
7498 """
7499 return _core_.Window_LineUp(*args, **kwargs)
7500
7501 def LineDown(*args, **kwargs):
7502 """
7503 LineDown(self) -> bool
7504
7505 This is just a wrapper for ScrollLines(1).
7506 """
7507 return _core_.Window_LineDown(*args, **kwargs)
7508
7509 def PageUp(*args, **kwargs):
7510 """
7511 PageUp(self) -> bool
7512
7513 This is just a wrapper for ScrollPages(-1).
7514 """
7515 return _core_.Window_PageUp(*args, **kwargs)
7516
7517 def PageDown(*args, **kwargs):
7518 """
7519 PageDown(self) -> bool
7520
7521 This is just a wrapper for ScrollPages(1).
7522 """
7523 return _core_.Window_PageDown(*args, **kwargs)
7524
7525 def SetHelpText(*args, **kwargs):
7526 """
7527 SetHelpText(self, String text)
7528
7529 Sets the help text to be used as context-sensitive help for this
7530 window. Note that the text is actually stored by the current
7531 wxHelpProvider implementation, and not in the window object itself.
7532 """
7533 return _core_.Window_SetHelpText(*args, **kwargs)
7534
7535 def SetHelpTextForId(*args, **kwargs):
7536 """
7537 SetHelpTextForId(self, String text)
7538
7539 Associate this help text with all windows with the same id as this
7540 one.
7541 """
7542 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7543
7544 def GetHelpText(*args, **kwargs):
7545 """
7546 GetHelpText(self) -> String
7547
7548 Gets the help text to be used as context-sensitive help for this
7549 window. Note that the text is actually stored by the current
7550 wxHelpProvider implementation, and not in the window object itself.
7551 """
7552 return _core_.Window_GetHelpText(*args, **kwargs)
7553
7554 def SetToolTipString(*args, **kwargs):
7555 """
7556 SetToolTipString(self, String tip)
7557
7558 Attach a tooltip to the window.
7559 """
7560 return _core_.Window_SetToolTipString(*args, **kwargs)
7561
7562 def SetToolTip(*args, **kwargs):
7563 """
7564 SetToolTip(self, ToolTip tip)
7565
7566 Attach a tooltip to the window.
7567 """
7568 return _core_.Window_SetToolTip(*args, **kwargs)
7569
7570 def GetToolTip(*args, **kwargs):
7571 """
7572 GetToolTip(self) -> ToolTip
7573
7574 get the associated tooltip or None if none
7575 """
7576 return _core_.Window_GetToolTip(*args, **kwargs)
7577
7578 def SetDropTarget(*args, **kwargs):
7579 """
7580 SetDropTarget(self, DropTarget dropTarget)
7581
7582 Associates a drop target with this window. If the window already has
7583 a drop target, it is deleted.
7584 """
7585 return _core_.Window_SetDropTarget(*args, **kwargs)
7586
7587 def GetDropTarget(*args, **kwargs):
7588 """
7589 GetDropTarget(self) -> DropTarget
7590
7591 Returns the associated drop target, which may be None.
7592 """
7593 return _core_.Window_GetDropTarget(*args, **kwargs)
7594
7595 def DragAcceptFiles(*args, **kwargs):
7596 """
7597 DragAcceptFiles(self, bool accept)
7598
7599 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
7600 Only available on Windows.
7601 """
7602 return _core_.Window_DragAcceptFiles(*args, **kwargs)
7603
7604 def SetConstraints(*args, **kwargs):
7605 """
7606 SetConstraints(self, LayoutConstraints constraints)
7607
7608 Sets the window to have the given layout constraints. If an existing
7609 layout constraints object is already owned by the window, it will be
7610 deleted. Pass None to disassociate and delete the window's current
7611 constraints.
7612
7613 You must call SetAutoLayout to tell a window to use the constraints
7614 automatically in its default EVT_SIZE handler; otherwise, you must
7615 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7616 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7617 effect.
7618 """
7619 return _core_.Window_SetConstraints(*args, **kwargs)
7620
7621 def GetConstraints(*args, **kwargs):
7622 """
7623 GetConstraints(self) -> LayoutConstraints
7624
7625 Returns a pointer to the window's layout constraints, or None if there
7626 are none.
7627 """
7628 return _core_.Window_GetConstraints(*args, **kwargs)
7629
7630 def SetAutoLayout(*args, **kwargs):
7631 """
7632 SetAutoLayout(self, bool autoLayout)
7633
7634 Determines whether the Layout function will be called automatically
7635 when the window is resized. It is called implicitly by SetSizer but
7636 if you use SetConstraints you should call it manually or otherwise the
7637 window layout won't be correctly updated when its size changes.
7638 """
7639 return _core_.Window_SetAutoLayout(*args, **kwargs)
7640
7641 def GetAutoLayout(*args, **kwargs):
7642 """
7643 GetAutoLayout(self) -> bool
7644
7645 Returns the current autoLayout setting
7646 """
7647 return _core_.Window_GetAutoLayout(*args, **kwargs)
7648
7649 def Layout(*args, **kwargs):
7650 """
7651 Layout(self) -> bool
7652
7653 Invokes the constraint-based layout algorithm or the sizer-based
7654 algorithm for this window. See SetAutoLayout: when auto layout is on,
7655 this function gets called automatically by the default EVT_SIZE
7656 handler when the window is resized.
7657 """
7658 return _core_.Window_Layout(*args, **kwargs)
7659
7660 def SetSizer(*args, **kwargs):
7661 """
7662 SetSizer(self, Sizer sizer, bool deleteOld=True)
7663
7664 Sets the window to have the given layout sizer. The window will then
7665 own the object, and will take care of its deletion. If an existing
7666 layout sizer object is already owned by the window, it will be deleted
7667 if the deleteOld parameter is true. Note that this function will also
7668 call SetAutoLayout implicitly with a True parameter if the sizer is
ae8162c8 7669 non-None, and False otherwise.
d55e5bfc
RD
7670 """
7671 return _core_.Window_SetSizer(*args, **kwargs)
7672
7673 def SetSizerAndFit(*args, **kwargs):
7674 """
7675 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7676
7677 The same as SetSizer, except it also sets the size hints for the
7678 window based on the sizer's minimum size.
7679 """
7680 return _core_.Window_SetSizerAndFit(*args, **kwargs)
7681
7682 def GetSizer(*args, **kwargs):
7683 """
7684 GetSizer(self) -> Sizer
7685
7686 Return the sizer associated with the window by a previous call to
7687 SetSizer or None if there isn't one.
7688 """
7689 return _core_.Window_GetSizer(*args, **kwargs)
7690
7691 def SetContainingSizer(*args, **kwargs):
7692 """
7693 SetContainingSizer(self, Sizer sizer)
7694
7695 This normally does not need to be called by application code. It is
7696 called internally when a window is added to a sizer, and is used so
7697 the window can remove itself from the sizer when it is destroyed.
7698 """
7699 return _core_.Window_SetContainingSizer(*args, **kwargs)
7700
7701 def GetContainingSizer(*args, **kwargs):
7702 """
7703 GetContainingSizer(self) -> Sizer
7704
7705 Return the sizer that this window is a member of, if any, otherwise None.
7706 """
7707 return _core_.Window_GetContainingSizer(*args, **kwargs)
7708
7709 def InheritAttributes(*args, **kwargs):
7710 """
7711 InheritAttributes(self)
7712
79fccf9d
RD
7713 This function is (or should be, in case of custom controls) called
7714 during window creation to intelligently set up the window visual
7715 attributes, that is the font and the foreground and background
7716 colours.
7717
7718 By 'intelligently' the following is meant: by default, all windows use
7719 their own default attributes. However if some of the parent's
7720 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7721 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD
7722 explicitly set for this window itself, then this window takes the same
7723 value as used by the parent. In addition, if the window overrides
7724 ShouldInheritColours to return false, the colours will not be changed
7725 no matter what and only the font might.
7726
ec9b55ca
RD
7727 This rather complicated logic is necessary in order to accommodate the
7728 different usage scenarios. The most common one is when all default
79fccf9d
RD
7729 attributes are used and in this case, nothing should be inherited as
7730 in modern GUIs different controls use different fonts (and colours)
7731 than their siblings so they can't inherit the same value from the
7732 parent. However it was also deemed desirable to allow to simply change
7733 the attributes of all children at once by just changing the font or
7734 colour of their common parent, hence in this case we do inherit the
7735 parents attributes.
7736
d55e5bfc
RD
7737 """
7738 return _core_.Window_InheritAttributes(*args, **kwargs)
7739
7740 def ShouldInheritColours(*args, **kwargs):
7741 """
7742 ShouldInheritColours(self) -> bool
7743
7744 Return true from here to allow the colours of this window to be
79fccf9d
RD
7745 changed by InheritAttributes, returning false forbids inheriting them
7746 from the parent window.
d55e5bfc 7747
79fccf9d
RD
7748 The base class version returns false, but this method is overridden in
7749 wxControl where it returns true.
d55e5bfc
RD
7750 """
7751 return _core_.Window_ShouldInheritColours(*args, **kwargs)
7752
7753 def PostCreate(self, pre):
7754 """
7755 Phase 3 of the 2-phase create <wink!>
7756 Call this method after precreating the window with the 2-phase create method.
7757 """
7758 self.this = pre.this
7759 self.thisown = pre.thisown
7760 pre.thisown = 0
7761 if hasattr(self, '_setOORInfo'):
7762 self._setOORInfo(self)
7763 if hasattr(self, '_setCallbackInfo'):
7764 self._setCallbackInfo(self, self.__class__)
7765
7766
7767class WindowPtr(Window):
7768 def __init__(self, this):
7769 self.this = this
7770 if not hasattr(self,"thisown"): self.thisown = 0
7771 self.__class__ = Window
7772_core_.Window_swigregister(WindowPtr)
7773
7774def PreWindow(*args, **kwargs):
7775 """
7776 PreWindow() -> Window
7777
7778 Precreate a Window for 2-phase creation.
7779 """
7780 val = _core_.new_PreWindow(*args, **kwargs)
7781 val.thisown = 1
7782 return val
7783
7784def Window_NewControlId(*args, **kwargs):
7785 """
7786 Window_NewControlId() -> int
7787
7788 Generate a control id for the controls which were not given one.
7789 """
7790 return _core_.Window_NewControlId(*args, **kwargs)
7791
7792def Window_NextControlId(*args, **kwargs):
7793 """
7794 Window_NextControlId(int winid) -> int
7795
7796 Get the id of the control following the one with the given
79fccf9d 7797 autogenerated) id
d55e5bfc
RD
7798 """
7799 return _core_.Window_NextControlId(*args, **kwargs)
7800
7801def Window_PrevControlId(*args, **kwargs):
7802 """
7803 Window_PrevControlId(int winid) -> int
7804
7805 Get the id of the control preceding the one with the given
79fccf9d 7806 autogenerated) id
d55e5bfc
RD
7807 """
7808 return _core_.Window_PrevControlId(*args, **kwargs)
7809
7810def Window_FindFocus(*args, **kwargs):
7811 """
7812 Window_FindFocus() -> Window
7813
7814 Returns the window or control that currently has the keyboard focus,
7815 or None.
7816 """
7817 return _core_.Window_FindFocus(*args, **kwargs)
7818
7819def Window_GetCapture(*args, **kwargs):
7820 """
7821 Window_GetCapture() -> Window
7822
7823 Returns the window which currently captures the mouse or None
7824 """
7825 return _core_.Window_GetCapture(*args, **kwargs)
7826
7827def Window_GetClassDefaultAttributes(*args, **kwargs):
7828 """
7829 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7830
79fccf9d
RD
7831 Get the default attributes for this class. This is useful if you want
7832 to use the same font or colour in your own control as in a standard
7833 control -- which is a much better idea than hard coding specific
caef1a4d
RD
7834 colours or fonts which might look completely out of place on the
7835 user's system, especially if it uses themes.
d55e5bfc
RD
7836
7837 The variant parameter is only relevant under Mac currently and is
79fccf9d 7838 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
7839 the returned font. See `wx.Window.SetWindowVariant` for more about
7840 this.
d55e5bfc
RD
7841 """
7842 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7843
7844def DLG_PNT(win, point_or_x, y=None):
7845 """
7846 Convenience function for converting a Point or (x,y) in
7847 dialog units to pixel units.
7848 """
7849 if y is None:
7850 return win.ConvertDialogPointToPixels(point_or_x)
7851 else:
7852 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
7853
7854def DLG_SZE(win, size_width, height=None):
7855 """
7856 Convenience function for converting a Size or (w,h) in
7857 dialog units to pixel units.
7858 """
7859 if height is None:
7860 return win.ConvertDialogSizeToPixels(size_width)
7861 else:
7862 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
7863
7864
7865def FindWindowById(*args, **kwargs):
7866 """
7867 FindWindowById(long id, Window parent=None) -> Window
7868
7869 Find the first window in the application with the given id. If parent
7870 is None, the search will start from all top-level frames and dialog
7871 boxes; if non-None, the search will be limited to the given window
7872 hierarchy. The search is recursive in both cases.
7873 """
7874 return _core_.FindWindowById(*args, **kwargs)
7875
7876def FindWindowByName(*args, **kwargs):
7877 """
7878 FindWindowByName(String name, Window parent=None) -> Window
7879
7880 Find a window by its name (as given in a window constructor or Create
7881 function call). If parent is None, the search will start from all
7882 top-level frames and dialog boxes; if non-None, the search will be
7883 limited to the given window hierarchy. The search is recursive in both
7884 cases.
7885
7886 If no window with such name is found, wx.FindWindowByLabel is called.
7887 """
7888 return _core_.FindWindowByName(*args, **kwargs)
7889
7890def FindWindowByLabel(*args, **kwargs):
7891 """
7892 FindWindowByLabel(String label, Window parent=None) -> Window
7893
7894 Find a window by its label. Depending on the type of window, the label
7895 may be a window title or panel item label. If parent is None, the
7896 search will start from all top-level frames and dialog boxes; if
7897 non-None, the search will be limited to the given window
7898 hierarchy. The search is recursive in both cases.
7899 """
7900 return _core_.FindWindowByLabel(*args, **kwargs)
7901
7902def Window_FromHWND(*args, **kwargs):
7903 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
7904 return _core_.Window_FromHWND(*args, **kwargs)
7905#---------------------------------------------------------------------------
7906
7907class Validator(EvtHandler):
7908 def __repr__(self):
7909 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7910 def __init__(self, *args, **kwargs):
7911 """__init__(self) -> Validator"""
7912 newobj = _core_.new_Validator(*args, **kwargs)
7913 self.this = newobj.this
7914 self.thisown = 1
7915 del newobj.thisown
7916 self._setOORInfo(self)
7917
7918 def Clone(*args, **kwargs):
7919 """Clone(self) -> Validator"""
7920 return _core_.Validator_Clone(*args, **kwargs)
7921
7922 def Validate(*args, **kwargs):
7923 """Validate(self, Window parent) -> bool"""
7924 return _core_.Validator_Validate(*args, **kwargs)
7925
7926 def TransferToWindow(*args, **kwargs):
7927 """TransferToWindow(self) -> bool"""
7928 return _core_.Validator_TransferToWindow(*args, **kwargs)
7929
7930 def TransferFromWindow(*args, **kwargs):
7931 """TransferFromWindow(self) -> bool"""
7932 return _core_.Validator_TransferFromWindow(*args, **kwargs)
7933
7934 def GetWindow(*args, **kwargs):
7935 """GetWindow(self) -> Window"""
7936 return _core_.Validator_GetWindow(*args, **kwargs)
7937
7938 def SetWindow(*args, **kwargs):
7939 """SetWindow(self, Window window)"""
7940 return _core_.Validator_SetWindow(*args, **kwargs)
7941
7942 def IsSilent(*args, **kwargs):
c24da6d6 7943 """IsSilent() -> bool"""
d55e5bfc
RD
7944 return _core_.Validator_IsSilent(*args, **kwargs)
7945
7946 IsSilent = staticmethod(IsSilent)
7947 def SetBellOnError(*args, **kwargs):
c24da6d6 7948 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
7949 return _core_.Validator_SetBellOnError(*args, **kwargs)
7950
7951 SetBellOnError = staticmethod(SetBellOnError)
7952
7953class ValidatorPtr(Validator):
7954 def __init__(self, this):
7955 self.this = this
7956 if not hasattr(self,"thisown"): self.thisown = 0
7957 self.__class__ = Validator
7958_core_.Validator_swigregister(ValidatorPtr)
7959
7960def Validator_IsSilent(*args, **kwargs):
7961 """Validator_IsSilent() -> bool"""
7962 return _core_.Validator_IsSilent(*args, **kwargs)
7963
7964def Validator_SetBellOnError(*args, **kwargs):
7965 """Validator_SetBellOnError(int doIt=True)"""
7966 return _core_.Validator_SetBellOnError(*args, **kwargs)
7967
7968class PyValidator(Validator):
7969 def __repr__(self):
7970 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7971 def __init__(self, *args, **kwargs):
7972 """__init__(self) -> PyValidator"""
7973 newobj = _core_.new_PyValidator(*args, **kwargs)
7974 self.this = newobj.this
7975 self.thisown = 1
7976 del newobj.thisown
7977
7978 self._setCallbackInfo(self, PyValidator, 1)
7979 self._setOORInfo(self)
7980
7981 def _setCallbackInfo(*args, **kwargs):
7982 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
7983 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
7984
7985
7986class PyValidatorPtr(PyValidator):
7987 def __init__(self, this):
7988 self.this = this
7989 if not hasattr(self,"thisown"): self.thisown = 0
7990 self.__class__ = PyValidator
7991_core_.PyValidator_swigregister(PyValidatorPtr)
7992
7993#---------------------------------------------------------------------------
7994
7995class Menu(EvtHandler):
7996 def __repr__(self):
7997 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7998 def __init__(self, *args, **kwargs):
7999 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
8000 newobj = _core_.new_Menu(*args, **kwargs)
8001 self.this = newobj.this
8002 self.thisown = 1
8003 del newobj.thisown
8004 self._setOORInfo(self)
8005
8006 def Append(*args, **kwargs):
8007 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8008 return _core_.Menu_Append(*args, **kwargs)
8009
8010 def AppendSeparator(*args, **kwargs):
8011 """AppendSeparator(self) -> MenuItem"""
8012 return _core_.Menu_AppendSeparator(*args, **kwargs)
8013
8014 def AppendCheckItem(*args, **kwargs):
8015 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8016 return _core_.Menu_AppendCheckItem(*args, **kwargs)
8017
8018 def AppendRadioItem(*args, **kwargs):
8019 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8020 return _core_.Menu_AppendRadioItem(*args, **kwargs)
8021
8022 def AppendMenu(*args, **kwargs):
8023 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8024 return _core_.Menu_AppendMenu(*args, **kwargs)
8025
8026 def AppendItem(*args, **kwargs):
8027 """AppendItem(self, MenuItem item) -> MenuItem"""
8028 return _core_.Menu_AppendItem(*args, **kwargs)
8029
8030 def Break(*args, **kwargs):
8031 """Break(self)"""
8032 return _core_.Menu_Break(*args, **kwargs)
8033
8034 def InsertItem(*args, **kwargs):
8035 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
8036 return _core_.Menu_InsertItem(*args, **kwargs)
8037
8038 def Insert(*args, **kwargs):
8039 """
8040 Insert(self, size_t pos, int id, String text, String help=EmptyString,
8041 int kind=ITEM_NORMAL) -> MenuItem
8042 """
8043 return _core_.Menu_Insert(*args, **kwargs)
8044
8045 def InsertSeparator(*args, **kwargs):
8046 """InsertSeparator(self, size_t pos) -> MenuItem"""
8047 return _core_.Menu_InsertSeparator(*args, **kwargs)
8048
8049 def InsertCheckItem(*args, **kwargs):
8050 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8051 return _core_.Menu_InsertCheckItem(*args, **kwargs)
8052
8053 def InsertRadioItem(*args, **kwargs):
8054 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
8055 return _core_.Menu_InsertRadioItem(*args, **kwargs)
8056
8057 def InsertMenu(*args, **kwargs):
8058 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8059 return _core_.Menu_InsertMenu(*args, **kwargs)
8060
8061 def PrependItem(*args, **kwargs):
8062 """PrependItem(self, MenuItem item) -> MenuItem"""
8063 return _core_.Menu_PrependItem(*args, **kwargs)
8064
8065 def Prepend(*args, **kwargs):
8066 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
8067 return _core_.Menu_Prepend(*args, **kwargs)
8068
8069 def PrependSeparator(*args, **kwargs):
8070 """PrependSeparator(self) -> MenuItem"""
8071 return _core_.Menu_PrependSeparator(*args, **kwargs)
8072
8073 def PrependCheckItem(*args, **kwargs):
8074 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8075 return _core_.Menu_PrependCheckItem(*args, **kwargs)
8076
8077 def PrependRadioItem(*args, **kwargs):
8078 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
8079 return _core_.Menu_PrependRadioItem(*args, **kwargs)
8080
8081 def PrependMenu(*args, **kwargs):
8082 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
8083 return _core_.Menu_PrependMenu(*args, **kwargs)
8084
8085 def Remove(*args, **kwargs):
8086 """Remove(self, int id) -> MenuItem"""
8087 return _core_.Menu_Remove(*args, **kwargs)
8088
8089 def RemoveItem(*args, **kwargs):
8090 """RemoveItem(self, MenuItem item) -> MenuItem"""
8091 return _core_.Menu_RemoveItem(*args, **kwargs)
8092
8093 def Delete(*args, **kwargs):
8094 """Delete(self, int id) -> bool"""
8095 return _core_.Menu_Delete(*args, **kwargs)
8096
8097 def DeleteItem(*args, **kwargs):
8098 """DeleteItem(self, MenuItem item) -> bool"""
8099 return _core_.Menu_DeleteItem(*args, **kwargs)
8100
8101 def Destroy(*args, **kwargs):
8102 """
8103 Destroy(self)
8104
8105 Deletes the C++ object this Python object is a proxy for.
8106 """
8107 return _core_.Menu_Destroy(*args, **kwargs)
8108
8109 def DestroyId(*args, **kwargs):
8110 """
8111 DestroyId(self, int id) -> bool
8112
8113 Deletes the C++ object this Python object is a proxy for.
8114 """
8115 return _core_.Menu_DestroyId(*args, **kwargs)
8116
8117 def DestroyItem(*args, **kwargs):
8118 """
8119 DestroyItem(self, MenuItem item) -> bool
8120
8121 Deletes the C++ object this Python object is a proxy for.
8122 """
8123 return _core_.Menu_DestroyItem(*args, **kwargs)
8124
8125 def GetMenuItemCount(*args, **kwargs):
8126 """GetMenuItemCount(self) -> size_t"""
8127 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
8128
8129 def GetMenuItems(*args, **kwargs):
8130 """GetMenuItems(self) -> PyObject"""
8131 return _core_.Menu_GetMenuItems(*args, **kwargs)
8132
8133 def FindItem(*args, **kwargs):
8134 """FindItem(self, String item) -> int"""
8135 return _core_.Menu_FindItem(*args, **kwargs)
8136
8137 def FindItemById(*args, **kwargs):
8138 """FindItemById(self, int id) -> MenuItem"""
8139 return _core_.Menu_FindItemById(*args, **kwargs)
8140
8141 def FindItemByPosition(*args, **kwargs):
8142 """FindItemByPosition(self, size_t position) -> MenuItem"""
8143 return _core_.Menu_FindItemByPosition(*args, **kwargs)
8144
8145 def Enable(*args, **kwargs):
8146 """Enable(self, int id, bool enable)"""
8147 return _core_.Menu_Enable(*args, **kwargs)
8148
8149 def IsEnabled(*args, **kwargs):
8150 """IsEnabled(self, int id) -> bool"""
8151 return _core_.Menu_IsEnabled(*args, **kwargs)
8152
8153 def Check(*args, **kwargs):
8154 """Check(self, int id, bool check)"""
8155 return _core_.Menu_Check(*args, **kwargs)
8156
8157 def IsChecked(*args, **kwargs):
8158 """IsChecked(self, int id) -> bool"""
8159 return _core_.Menu_IsChecked(*args, **kwargs)
8160
8161 def SetLabel(*args, **kwargs):
8162 """SetLabel(self, int id, String label)"""
8163 return _core_.Menu_SetLabel(*args, **kwargs)
8164
8165 def GetLabel(*args, **kwargs):
8166 """GetLabel(self, int id) -> String"""
8167 return _core_.Menu_GetLabel(*args, **kwargs)
8168
8169 def SetHelpString(*args, **kwargs):
8170 """SetHelpString(self, int id, String helpString)"""
8171 return _core_.Menu_SetHelpString(*args, **kwargs)
8172
8173 def GetHelpString(*args, **kwargs):
8174 """GetHelpString(self, int id) -> String"""
8175 return _core_.Menu_GetHelpString(*args, **kwargs)
8176
8177 def SetTitle(*args, **kwargs):
8178 """SetTitle(self, String title)"""
8179 return _core_.Menu_SetTitle(*args, **kwargs)
8180
8181 def GetTitle(*args, **kwargs):
8182 """GetTitle(self) -> String"""
8183 return _core_.Menu_GetTitle(*args, **kwargs)
8184
8185 def SetEventHandler(*args, **kwargs):
8186 """SetEventHandler(self, EvtHandler handler)"""
8187 return _core_.Menu_SetEventHandler(*args, **kwargs)
8188
8189 def GetEventHandler(*args, **kwargs):
8190 """GetEventHandler(self) -> EvtHandler"""
8191 return _core_.Menu_GetEventHandler(*args, **kwargs)
8192
8193 def SetInvokingWindow(*args, **kwargs):
8194 """SetInvokingWindow(self, Window win)"""
8195 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
8196
8197 def GetInvokingWindow(*args, **kwargs):
8198 """GetInvokingWindow(self) -> Window"""
8199 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
8200
8201 def GetStyle(*args, **kwargs):
8202 """GetStyle(self) -> long"""
8203 return _core_.Menu_GetStyle(*args, **kwargs)
8204
8205 def UpdateUI(*args, **kwargs):
8206 """UpdateUI(self, EvtHandler source=None)"""
8207 return _core_.Menu_UpdateUI(*args, **kwargs)
8208
8209 def GetMenuBar(*args, **kwargs):
8210 """GetMenuBar(self) -> MenuBar"""
8211 return _core_.Menu_GetMenuBar(*args, **kwargs)
8212
8213 def Attach(*args, **kwargs):
8214 """Attach(self, wxMenuBarBase menubar)"""
8215 return _core_.Menu_Attach(*args, **kwargs)
8216
8217 def Detach(*args, **kwargs):
8218 """Detach(self)"""
8219 return _core_.Menu_Detach(*args, **kwargs)
8220
8221 def IsAttached(*args, **kwargs):
8222 """IsAttached(self) -> bool"""
8223 return _core_.Menu_IsAttached(*args, **kwargs)
8224
8225 def SetParent(*args, **kwargs):
8226 """SetParent(self, Menu parent)"""
8227 return _core_.Menu_SetParent(*args, **kwargs)
8228
8229 def GetParent(*args, **kwargs):
8230 """GetParent(self) -> Menu"""
8231 return _core_.Menu_GetParent(*args, **kwargs)
8232
8233
8234class MenuPtr(Menu):
8235 def __init__(self, this):
8236 self.this = this
8237 if not hasattr(self,"thisown"): self.thisown = 0
8238 self.__class__ = Menu
8239_core_.Menu_swigregister(MenuPtr)
8240DefaultValidator = cvar.DefaultValidator
8241
8242#---------------------------------------------------------------------------
8243
8244class MenuBar(Window):
8245 def __repr__(self):
8246 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8247 def __init__(self, *args, **kwargs):
8248 """__init__(self, long style=0) -> MenuBar"""
8249 newobj = _core_.new_MenuBar(*args, **kwargs)
8250 self.this = newobj.this
8251 self.thisown = 1
8252 del newobj.thisown
8253 self._setOORInfo(self)
8254
8255 def Append(*args, **kwargs):
8256 """Append(self, Menu menu, String title) -> bool"""
8257 return _core_.MenuBar_Append(*args, **kwargs)
8258
8259 def Insert(*args, **kwargs):
8260 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
8261 return _core_.MenuBar_Insert(*args, **kwargs)
8262
8263 def GetMenuCount(*args, **kwargs):
8264 """GetMenuCount(self) -> size_t"""
8265 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
8266
8267 def GetMenu(*args, **kwargs):
8268 """GetMenu(self, size_t pos) -> Menu"""
8269 return _core_.MenuBar_GetMenu(*args, **kwargs)
8270
8271 def Replace(*args, **kwargs):
8272 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
8273 return _core_.MenuBar_Replace(*args, **kwargs)
8274
8275 def Remove(*args, **kwargs):
8276 """Remove(self, size_t pos) -> Menu"""
8277 return _core_.MenuBar_Remove(*args, **kwargs)
8278
8279 def EnableTop(*args, **kwargs):
8280 """EnableTop(self, size_t pos, bool enable)"""
8281 return _core_.MenuBar_EnableTop(*args, **kwargs)
8282
8283 def IsEnabledTop(*args, **kwargs):
8284 """IsEnabledTop(self, size_t pos) -> bool"""
8285 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
8286
8287 def SetLabelTop(*args, **kwargs):
8288 """SetLabelTop(self, size_t pos, String label)"""
8289 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
8290
8291 def GetLabelTop(*args, **kwargs):
8292 """GetLabelTop(self, size_t pos) -> String"""
8293 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
8294
8295 def FindMenuItem(*args, **kwargs):
8296 """FindMenuItem(self, String menu, String item) -> int"""
8297 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
8298
8299 def FindItemById(*args, **kwargs):
8300 """FindItemById(self, int id) -> MenuItem"""
8301 return _core_.MenuBar_FindItemById(*args, **kwargs)
8302
8303 def FindMenu(*args, **kwargs):
8304 """FindMenu(self, String title) -> int"""
8305 return _core_.MenuBar_FindMenu(*args, **kwargs)
8306
8307 def Enable(*args, **kwargs):
8308 """Enable(self, int id, bool enable)"""
8309 return _core_.MenuBar_Enable(*args, **kwargs)
8310
8311 def Check(*args, **kwargs):
8312 """Check(self, int id, bool check)"""
8313 return _core_.MenuBar_Check(*args, **kwargs)
8314
8315 def IsChecked(*args, **kwargs):
8316 """IsChecked(self, int id) -> bool"""
8317 return _core_.MenuBar_IsChecked(*args, **kwargs)
8318
8319 def IsEnabled(*args, **kwargs):
8320 """IsEnabled(self, int id) -> bool"""
8321 return _core_.MenuBar_IsEnabled(*args, **kwargs)
8322
8323 def SetLabel(*args, **kwargs):
8324 """SetLabel(self, int id, String label)"""
8325 return _core_.MenuBar_SetLabel(*args, **kwargs)
8326
8327 def GetLabel(*args, **kwargs):
8328 """GetLabel(self, int id) -> String"""
8329 return _core_.MenuBar_GetLabel(*args, **kwargs)
8330
8331 def SetHelpString(*args, **kwargs):
8332 """SetHelpString(self, int id, String helpString)"""
8333 return _core_.MenuBar_SetHelpString(*args, **kwargs)
8334
8335 def GetHelpString(*args, **kwargs):
8336 """GetHelpString(self, int id) -> String"""
8337 return _core_.MenuBar_GetHelpString(*args, **kwargs)
8338
8339 def GetFrame(*args, **kwargs):
8340 """GetFrame(self) -> wxFrame"""
8341 return _core_.MenuBar_GetFrame(*args, **kwargs)
8342
8343 def IsAttached(*args, **kwargs):
8344 """IsAttached(self) -> bool"""
8345 return _core_.MenuBar_IsAttached(*args, **kwargs)
8346
8347 def Attach(*args, **kwargs):
8348 """Attach(self, wxFrame frame)"""
8349 return _core_.MenuBar_Attach(*args, **kwargs)
8350
8351 def Detach(*args, **kwargs):
8352 """Detach(self)"""
8353 return _core_.MenuBar_Detach(*args, **kwargs)
8354
8355
8356class MenuBarPtr(MenuBar):
8357 def __init__(self, this):
8358 self.this = this
8359 if not hasattr(self,"thisown"): self.thisown = 0
8360 self.__class__ = MenuBar
8361_core_.MenuBar_swigregister(MenuBarPtr)
8362
8363#---------------------------------------------------------------------------
8364
8365class MenuItem(Object):
8366 def __repr__(self):
8367 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8368 def __init__(self, *args, **kwargs):
8369 """
8370 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
8371 String help=EmptyString, int kind=ITEM_NORMAL,
8372 Menu subMenu=None) -> MenuItem
8373 """
8374 newobj = _core_.new_MenuItem(*args, **kwargs)
8375 self.this = newobj.this
8376 self.thisown = 1
8377 del newobj.thisown
8378 def GetMenu(*args, **kwargs):
8379 """GetMenu(self) -> Menu"""
8380 return _core_.MenuItem_GetMenu(*args, **kwargs)
8381
8382 def SetMenu(*args, **kwargs):
8383 """SetMenu(self, Menu menu)"""
8384 return _core_.MenuItem_SetMenu(*args, **kwargs)
8385
8386 def SetId(*args, **kwargs):
8387 """SetId(self, int id)"""
8388 return _core_.MenuItem_SetId(*args, **kwargs)
8389
8390 def GetId(*args, **kwargs):
8391 """GetId(self) -> int"""
8392 return _core_.MenuItem_GetId(*args, **kwargs)
8393
8394 def IsSeparator(*args, **kwargs):
8395 """IsSeparator(self) -> bool"""
8396 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8397
8398 def SetText(*args, **kwargs):
8399 """SetText(self, String str)"""
8400 return _core_.MenuItem_SetText(*args, **kwargs)
8401
8402 def GetLabel(*args, **kwargs):
8403 """GetLabel(self) -> String"""
8404 return _core_.MenuItem_GetLabel(*args, **kwargs)
8405
8406 def GetText(*args, **kwargs):
8407 """GetText(self) -> String"""
8408 return _core_.MenuItem_GetText(*args, **kwargs)
8409
8410 def GetLabelFromText(*args, **kwargs):
c24da6d6 8411 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
8412 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8413
8414 GetLabelFromText = staticmethod(GetLabelFromText)
8415 def GetKind(*args, **kwargs):
8416 """GetKind(self) -> int"""
8417 return _core_.MenuItem_GetKind(*args, **kwargs)
8418
8419 def SetKind(*args, **kwargs):
8420 """SetKind(self, int kind)"""
8421 return _core_.MenuItem_SetKind(*args, **kwargs)
8422
8423 def SetCheckable(*args, **kwargs):
8424 """SetCheckable(self, bool checkable)"""
8425 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8426
8427 def IsCheckable(*args, **kwargs):
8428 """IsCheckable(self) -> bool"""
8429 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8430
8431 def IsSubMenu(*args, **kwargs):
8432 """IsSubMenu(self) -> bool"""
8433 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8434
8435 def SetSubMenu(*args, **kwargs):
8436 """SetSubMenu(self, Menu menu)"""
8437 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8438
8439 def GetSubMenu(*args, **kwargs):
8440 """GetSubMenu(self) -> Menu"""
8441 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8442
8443 def Enable(*args, **kwargs):
8444 """Enable(self, bool enable=True)"""
8445 return _core_.MenuItem_Enable(*args, **kwargs)
8446
8447 def IsEnabled(*args, **kwargs):
8448 """IsEnabled(self) -> bool"""
8449 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8450
8451 def Check(*args, **kwargs):
8452 """Check(self, bool check=True)"""
8453 return _core_.MenuItem_Check(*args, **kwargs)
8454
8455 def IsChecked(*args, **kwargs):
8456 """IsChecked(self) -> bool"""
8457 return _core_.MenuItem_IsChecked(*args, **kwargs)
8458
8459 def Toggle(*args, **kwargs):
8460 """Toggle(self)"""
8461 return _core_.MenuItem_Toggle(*args, **kwargs)
8462
8463 def SetHelp(*args, **kwargs):
8464 """SetHelp(self, String str)"""
8465 return _core_.MenuItem_SetHelp(*args, **kwargs)
8466
8467 def GetHelp(*args, **kwargs):
8468 """GetHelp(self) -> String"""
8469 return _core_.MenuItem_GetHelp(*args, **kwargs)
8470
8471 def GetAccel(*args, **kwargs):
8472 """GetAccel(self) -> AcceleratorEntry"""
8473 return _core_.MenuItem_GetAccel(*args, **kwargs)
8474
8475 def SetAccel(*args, **kwargs):
8476 """SetAccel(self, AcceleratorEntry accel)"""
8477 return _core_.MenuItem_SetAccel(*args, **kwargs)
8478
8479 def SetFont(*args, **kwargs):
8480 """SetFont(self, Font font)"""
8481 return _core_.MenuItem_SetFont(*args, **kwargs)
8482
8483 def GetFont(*args, **kwargs):
8484 """GetFont(self) -> Font"""
8485 return _core_.MenuItem_GetFont(*args, **kwargs)
8486
8487 def SetTextColour(*args, **kwargs):
8488 """SetTextColour(self, Colour colText)"""
8489 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8490
8491 def GetTextColour(*args, **kwargs):
8492 """GetTextColour(self) -> Colour"""
8493 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8494
8495 def SetBackgroundColour(*args, **kwargs):
8496 """SetBackgroundColour(self, Colour colBack)"""
8497 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8498
8499 def GetBackgroundColour(*args, **kwargs):
8500 """GetBackgroundColour(self) -> Colour"""
8501 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8502
8503 def SetBitmaps(*args, **kwargs):
8504 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8505 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8506
8507 def SetDisabledBitmap(*args, **kwargs):
8508 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8509 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8510
8511 def GetDisabledBitmap(*args, **kwargs):
8512 """GetDisabledBitmap(self) -> Bitmap"""
8513 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8514
8515 def SetMarginWidth(*args, **kwargs):
8516 """SetMarginWidth(self, int nWidth)"""
8517 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8518
8519 def GetMarginWidth(*args, **kwargs):
8520 """GetMarginWidth(self) -> int"""
8521 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8522
8523 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 8524 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
8525 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8526
8527 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8528 def IsOwnerDrawn(*args, **kwargs):
8529 """IsOwnerDrawn(self) -> bool"""
8530 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8531
8532 def SetOwnerDrawn(*args, **kwargs):
8533 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8534 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8535
8536 def ResetOwnerDrawn(*args, **kwargs):
8537 """ResetOwnerDrawn(self)"""
8538 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8539
8540 def SetBitmap(*args, **kwargs):
8541 """SetBitmap(self, Bitmap bitmap)"""
8542 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8543
8544 def GetBitmap(*args, **kwargs):
8545 """GetBitmap(self) -> Bitmap"""
8546 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8547
8548
8549class MenuItemPtr(MenuItem):
8550 def __init__(self, this):
8551 self.this = this
8552 if not hasattr(self,"thisown"): self.thisown = 0
8553 self.__class__ = MenuItem
8554_core_.MenuItem_swigregister(MenuItemPtr)
8555
8556def MenuItem_GetLabelFromText(*args, **kwargs):
8557 """MenuItem_GetLabelFromText(String text) -> String"""
8558 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8559
8560def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8561 """MenuItem_GetDefaultMarginWidth() -> int"""
8562 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8563
8564#---------------------------------------------------------------------------
8565
8566class Control(Window):
8567 """
8568 This is the base class for a control or 'widget'.
8569
79fccf9d
RD
8570 A control is generally a small window which processes user input
8571 and/or displays one or more item of data.
d55e5bfc
RD
8572 """
8573 def __repr__(self):
8574 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8575 def __init__(self, *args, **kwargs):
8576 """
248ed943
RD
8577 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8578 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8579 String name=ControlNameStr) -> Control
8580
79fccf9d
RD
8581 Create a Control. Normally you should only call this from a subclass'
8582 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
8583 """
8584 newobj = _core_.new_Control(*args, **kwargs)
8585 self.this = newobj.this
8586 self.thisown = 1
8587 del newobj.thisown
8588 self._setOORInfo(self)
8589
8590 def Create(*args, **kwargs):
8591 """
248ed943
RD
8592 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8593 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8594 String name=ControlNameStr) -> bool
8595
8596 Do the 2nd phase and create the GUI control.
8597 """
8598 return _core_.Control_Create(*args, **kwargs)
8599
8600 def Command(*args, **kwargs):
8601 """
8602 Command(self, CommandEvent event)
8603
79fccf9d
RD
8604 Simulates the effect of the user issuing a command to the item.
8605
8606 :see: `wx.CommandEvent`
8607
d55e5bfc
RD
8608 """
8609 return _core_.Control_Command(*args, **kwargs)
8610
8611 def GetLabel(*args, **kwargs):
8612 """
8613 GetLabel(self) -> String
8614
8615 Return a control's text.
8616 """
8617 return _core_.Control_GetLabel(*args, **kwargs)
8618
8619 def SetLabel(*args, **kwargs):
8620 """
8621 SetLabel(self, String label)
8622
8623 Sets the item's text.
8624 """
8625 return _core_.Control_SetLabel(*args, **kwargs)
8626
a001823c 8627 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 8628 """
a001823c 8629 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 8630
a001823c
RD
8631 Get the default attributes for this class. This is useful if you want
8632 to use the same font or colour in your own control as in a standard
8633 control -- which is a much better idea than hard coding specific
8634 colours or fonts which might look completely out of place on the
8635 user's system, especially if it uses themes.
f8167d6e 8636
a001823c
RD
8637 The variant parameter is only relevant under Mac currently and is
8638 ignore under other platforms. Under Mac, it will change the size of
8639 the returned font. See `wx.Window.SetWindowVariant` for more about
8640 this.
f8167d6e 8641 """
d55e5bfc
RD
8642 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8643
8644 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8645
8646class ControlPtr(Control):
8647 def __init__(self, this):
8648 self.this = this
8649 if not hasattr(self,"thisown"): self.thisown = 0
8650 self.__class__ = Control
8651_core_.Control_swigregister(ControlPtr)
8652ControlNameStr = cvar.ControlNameStr
8653
8654def PreControl(*args, **kwargs):
8655 """
8656 PreControl() -> Control
8657
8658 Precreate a Control control for 2-phase creation
8659 """
8660 val = _core_.new_PreControl(*args, **kwargs)
8661 val.thisown = 1
8662 return val
8663
8664def Control_GetClassDefaultAttributes(*args, **kwargs):
a001823c
RD
8665 """
8666 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8667
8668 Get the default attributes for this class. This is useful if you want
8669 to use the same font or colour in your own control as in a standard
8670 control -- which is a much better idea than hard coding specific
8671 colours or fonts which might look completely out of place on the
8672 user's system, especially if it uses themes.
8673
8674 The variant parameter is only relevant under Mac currently and is
8675 ignore under other platforms. Under Mac, it will change the size of
8676 the returned font. See `wx.Window.SetWindowVariant` for more about
8677 this.
8678 """
d55e5bfc
RD
8679 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8680
8681#---------------------------------------------------------------------------
8682
8683class ItemContainer(object):
8684 """
8685 wx.ItemContainer defines an interface which is implemented by all
79fccf9d
RD
8686 controls which have string subitems, each of which may be selected,
8687 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8688 `wx.ComboBox` which implements an extended interface deriving from
8689 this one.
d55e5bfc 8690
79fccf9d
RD
8691 It defines the methods for accessing the control's items and although
8692 each of the derived classes implements them differently, they still
8693 all conform to the same interface.
d55e5bfc 8694
79fccf9d
RD
8695 The items in a wx.ItemContainer have (non empty) string labels and,
8696 optionally, client data associated with them.
d55e5bfc
RD
8697
8698 """
8699 def __init__(self): raise RuntimeError, "No constructor defined"
8700 def __repr__(self):
8701 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8702 def Append(*args, **kwargs):
8703 """
8704 Append(self, String item, PyObject clientData=None) -> int
8705
79fccf9d
RD
8706 Adds the item to the control, associating the given data with the item
8707 if not None. The return value is the index of the newly added item
8708 which may be different from the last one if the control is sorted (e.g.
8709 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
8710 """
8711 return _core_.ItemContainer_Append(*args, **kwargs)
8712
8713 def AppendItems(*args, **kwargs):
8714 """
f5b96ee1 8715 AppendItems(self, List strings)
d55e5bfc 8716
79fccf9d
RD
8717 Apend several items at once to the control. Notice that calling this
8718 method may be much faster than appending the items one by one if you
8719 need to add a lot of items.
d55e5bfc
RD
8720 """
8721 return _core_.ItemContainer_AppendItems(*args, **kwargs)
8722
8723 def Insert(*args, **kwargs):
8724 """
8725 Insert(self, String item, int pos, PyObject clientData=None) -> int
8726
79fccf9d 8727 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
8728 optionally associating some data object with the item.
8729 """
8730 return _core_.ItemContainer_Insert(*args, **kwargs)
8731
8732 def Clear(*args, **kwargs):
8733 """
8734 Clear(self)
8735
8736 Removes all items from the control.
8737 """
8738 return _core_.ItemContainer_Clear(*args, **kwargs)
8739
8740 def Delete(*args, **kwargs):
8741 """
8742 Delete(self, int n)
8743
79fccf9d
RD
8744 Deletes the item at the zero-based index 'n' from the control. Note
8745 that it is an error (signalled by a `wx.PyAssertionError` exception if
8746 enabled) to remove an item with the index negative or greater or equal
8747 than the number of items in the control.
d55e5bfc
RD
8748 """
8749 return _core_.ItemContainer_Delete(*args, **kwargs)
8750
8751 def GetCount(*args, **kwargs):
8752 """
8753 GetCount(self) -> int
8754
8755 Returns the number of items in the control.
8756 """
8757 return _core_.ItemContainer_GetCount(*args, **kwargs)
8758
8759 def IsEmpty(*args, **kwargs):
8760 """
8761 IsEmpty(self) -> bool
8762
8763 Returns True if the control is empty or False if it has some items.
8764 """
8765 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
8766
8767 def GetString(*args, **kwargs):
8768 """
8769 GetString(self, int n) -> String
8770
8771 Returns the label of the item with the given index.
8772 """
8773 return _core_.ItemContainer_GetString(*args, **kwargs)
8774
8775 def GetStrings(*args, **kwargs):
8776 """GetStrings(self) -> wxArrayString"""
8777 return _core_.ItemContainer_GetStrings(*args, **kwargs)
8778
8779 def SetString(*args, **kwargs):
8780 """
8781 SetString(self, int n, String s)
8782
8783 Sets the label for the given item.
8784 """
8785 return _core_.ItemContainer_SetString(*args, **kwargs)
8786
8787 def FindString(*args, **kwargs):
8788 """
8789 FindString(self, String s) -> int
8790
8791 Finds an item whose label matches the given string. Returns the
79fccf9d
RD
8792 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8793 found.
d55e5bfc
RD
8794 """
8795 return _core_.ItemContainer_FindString(*args, **kwargs)
8796
8797 def Select(*args, **kwargs):
8798 """
8799 Select(self, int n)
8800
8801 Sets the item at index 'n' to be the selected item.
8802 """
8803 return _core_.ItemContainer_Select(*args, **kwargs)
8804
8805 SetSelection = Select
8806 def GetSelection(*args, **kwargs):
8807 """
8808 GetSelection(self) -> int
8809
79fccf9d
RD
8810 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8811 is selected.
d55e5bfc
RD
8812 """
8813 return _core_.ItemContainer_GetSelection(*args, **kwargs)
8814
8815 def GetStringSelection(*args, **kwargs):
8816 """
8817 GetStringSelection(self) -> String
8818
79fccf9d
RD
8819 Returns the label of the selected item or an empty string if no item
8820 is selected.
d55e5bfc
RD
8821 """
8822 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
8823
8824 def GetClientData(*args, **kwargs):
8825 """
8826 GetClientData(self, int n) -> PyObject
8827
8828 Returns the client data associated with the given item, (if any.)
8829 """
8830 return _core_.ItemContainer_GetClientData(*args, **kwargs)
8831
8832 def SetClientData(*args, **kwargs):
8833 """
8834 SetClientData(self, int n, PyObject clientData)
8835
8836 Associate the given client data with the item at position n.
8837 """
8838 return _core_.ItemContainer_SetClientData(*args, **kwargs)
8839
8840
8841class ItemContainerPtr(ItemContainer):
8842 def __init__(self, this):
8843 self.this = this
8844 if not hasattr(self,"thisown"): self.thisown = 0
8845 self.__class__ = ItemContainer
8846_core_.ItemContainer_swigregister(ItemContainerPtr)
8847
8848#---------------------------------------------------------------------------
8849
8850class ControlWithItems(Control,ItemContainer):
8851 """
79fccf9d
RD
8852 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8853 wx.Control class, and is used for the base class of various controls
8854 that have items.
d55e5bfc
RD
8855 """
8856 def __init__(self): raise RuntimeError, "No constructor defined"
8857 def __repr__(self):
8858 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8859
8860class ControlWithItemsPtr(ControlWithItems):
8861 def __init__(self, this):
8862 self.this = this
8863 if not hasattr(self,"thisown"): self.thisown = 0
8864 self.__class__ = ControlWithItems
8865_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
8866
8867#---------------------------------------------------------------------------
8868
8869class SizerItem(Object):
248ed943
RD
8870 """
8871 The wx.SizerItem class is used to track the position, size and other
8872 attributes of each item managed by a `wx.Sizer`. In normal usage user
8873 code should never need to deal directly with a wx.SizerItem, but
8874 custom classes derived from `wx.PySizer` will probably need to use the
8875 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8876
8877 :see: `wx.Sizer`, `wx.GBSizerItem`
8878 """
d55e5bfc
RD
8879 def __repr__(self):
8880 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8881 def __init__(self, *args, **kwargs):
248ed943
RD
8882 """
8883 __init__(self) -> SizerItem
8884
8885 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8886 size will need to be set before this item can be used in a Sizer.
8887
8888 You will probably never need to create a wx.SizerItem directly as they
8889 are created automatically when the sizer's Add, Insert or Prepend
8890 methods are called.
8891
8892 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8893 """
d55e5bfc
RD
8894 newobj = _core_.new_SizerItem(*args, **kwargs)
8895 self.this = newobj.this
8896 self.thisown = 1
8897 del newobj.thisown
8898 def DeleteWindows(*args, **kwargs):
248ed943
RD
8899 """
8900 DeleteWindows(self)
8901
8902 Destroy the window or the windows in a subsizer, depending on the type
8903 of item.
8904 """
d55e5bfc
RD
8905 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
8906
8907 def DetachSizer(*args, **kwargs):
248ed943
RD
8908 """
8909 DetachSizer(self)
8910
8911 Enable deleting the SizerItem without destroying the contained sizer.
8912 """
d55e5bfc
RD
8913 return _core_.SizerItem_DetachSizer(*args, **kwargs)
8914
8915 def GetSize(*args, **kwargs):
248ed943
RD
8916 """
8917 GetSize(self) -> Size
8918
8919 Get the current size of the item, as set in the last Layout.
8920 """
d55e5bfc
RD
8921 return _core_.SizerItem_GetSize(*args, **kwargs)
8922
8923 def CalcMin(*args, **kwargs):
248ed943
RD
8924 """
8925 CalcMin(self) -> Size
8926
8927 Calculates the minimum desired size for the item, including any space
8928 needed by borders.
8929 """
d55e5bfc
RD
8930 return _core_.SizerItem_CalcMin(*args, **kwargs)
8931
8932 def SetDimension(*args, **kwargs):
248ed943
RD
8933 """
8934 SetDimension(self, Point pos, Size size)
8935
8936 Set the position and size of the space allocated for this item by the
8937 sizer, and adjust the position and size of the item (window or
8938 subsizer) to be within that space taking alignment and borders into
8939 account.
8940 """
d55e5bfc
RD
8941 return _core_.SizerItem_SetDimension(*args, **kwargs)
8942
8943 def GetMinSize(*args, **kwargs):
248ed943
RD
8944 """
8945 GetMinSize(self) -> Size
8946
8947 Get the minimum size needed for the item.
8948 """
d55e5bfc
RD
8949 return _core_.SizerItem_GetMinSize(*args, **kwargs)
8950
a001823c
RD
8951 def GetMinSizeWithBorder(*args, **kwargs):
8952 """
8953 GetMinSizeWithBorder(self) -> Size
8954
8955 Get the minimum size needed for the item with space for the borders
8956 added, if needed.
8957 """
8958 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
8959
d55e5bfc
RD
8960 def SetInitSize(*args, **kwargs):
8961 """SetInitSize(self, int x, int y)"""
8962 return _core_.SizerItem_SetInitSize(*args, **kwargs)
8963
8964 def SetRatioWH(*args, **kwargs):
248ed943
RD
8965 """
8966 SetRatioWH(self, int width, int height)
8967
8968 Set the ratio item attribute.
8969 """
d55e5bfc
RD
8970 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
8971
8972 def SetRatioSize(*args, **kwargs):
248ed943
RD
8973 """
8974 SetRatioSize(self, Size size)
8975
8976 Set the ratio item attribute.
8977 """
d55e5bfc
RD
8978 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
8979
8980 def SetRatio(*args, **kwargs):
248ed943
RD
8981 """
8982 SetRatio(self, float ratio)
8983
8984 Set the ratio item attribute.
8985 """
d55e5bfc
RD
8986 return _core_.SizerItem_SetRatio(*args, **kwargs)
8987
8988 def GetRatio(*args, **kwargs):
248ed943
RD
8989 """
8990 GetRatio(self) -> float
8991
8992 Set the ratio item attribute.
8993 """
d55e5bfc
RD
8994 return _core_.SizerItem_GetRatio(*args, **kwargs)
8995
c1cb24a4
RD
8996 def GetRect(*args, **kwargs):
8997 """
8998 GetRect(self) -> Rect
8999
9000 Returns the rectangle that the sizer item should occupy
9001 """
9002 return _core_.SizerItem_GetRect(*args, **kwargs)
9003
d55e5bfc 9004 def IsWindow(*args, **kwargs):
248ed943
RD
9005 """
9006 IsWindow(self) -> bool
9007
9008 Is this sizer item a window?
9009 """
d55e5bfc
RD
9010 return _core_.SizerItem_IsWindow(*args, **kwargs)
9011
9012 def IsSizer(*args, **kwargs):
248ed943
RD
9013 """
9014 IsSizer(self) -> bool
9015
9016 Is this sizer item a subsizer?
9017 """
d55e5bfc
RD
9018 return _core_.SizerItem_IsSizer(*args, **kwargs)
9019
9020 def IsSpacer(*args, **kwargs):
248ed943
RD
9021 """
9022 IsSpacer(self) -> bool
9023
9024 Is this sizer item a spacer?
9025 """
d55e5bfc
RD
9026 return _core_.SizerItem_IsSpacer(*args, **kwargs)
9027
9028 def SetProportion(*args, **kwargs):
248ed943
RD
9029 """
9030 SetProportion(self, int proportion)
9031
9032 Set the proportion value for this item.
9033 """
d55e5bfc
RD
9034 return _core_.SizerItem_SetProportion(*args, **kwargs)
9035
9036 def GetProportion(*args, **kwargs):
248ed943
RD
9037 """
9038 GetProportion(self) -> int
9039
9040 Get the proportion value for this item.
9041 """
d55e5bfc
RD
9042 return _core_.SizerItem_GetProportion(*args, **kwargs)
9043
248ed943
RD
9044 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
9045 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 9046 def SetFlag(*args, **kwargs):
248ed943
RD
9047 """
9048 SetFlag(self, int flag)
9049
9050 Set the flag value for this item.
9051 """
d55e5bfc
RD
9052 return _core_.SizerItem_SetFlag(*args, **kwargs)
9053
9054 def GetFlag(*args, **kwargs):
248ed943
RD
9055 """
9056 GetFlag(self) -> int
9057
9058 Get the flag value for this item.
9059 """
d55e5bfc
RD
9060 return _core_.SizerItem_GetFlag(*args, **kwargs)
9061
9062 def SetBorder(*args, **kwargs):
248ed943
RD
9063 """
9064 SetBorder(self, int border)
9065
9066 Set the border value for this item.
9067 """
d55e5bfc
RD
9068 return _core_.SizerItem_SetBorder(*args, **kwargs)
9069
9070 def GetBorder(*args, **kwargs):
248ed943
RD
9071 """
9072 GetBorder(self) -> int
9073
9074 Get the border value for this item.
9075 """
d55e5bfc
RD
9076 return _core_.SizerItem_GetBorder(*args, **kwargs)
9077
9078 def GetWindow(*args, **kwargs):
248ed943
RD
9079 """
9080 GetWindow(self) -> Window
9081
9082 Get the window (if any) that is managed by this sizer item.
9083 """
d55e5bfc
RD
9084 return _core_.SizerItem_GetWindow(*args, **kwargs)
9085
9086 def SetWindow(*args, **kwargs):
248ed943
RD
9087 """
9088 SetWindow(self, Window window)
9089
9090 Set the window to be managed by this sizer item.
9091 """
d55e5bfc
RD
9092 return _core_.SizerItem_SetWindow(*args, **kwargs)
9093
9094 def GetSizer(*args, **kwargs):
248ed943
RD
9095 """
9096 GetSizer(self) -> Sizer
9097
9098 Get the subsizer (if any) that is managed by this sizer item.
9099 """
d55e5bfc
RD
9100 return _core_.SizerItem_GetSizer(*args, **kwargs)
9101
9102 def SetSizer(*args, **kwargs):
248ed943
RD
9103 """
9104 SetSizer(self, Sizer sizer)
9105
9106 Set the subsizer to be managed by this sizer item.
9107 """
d55e5bfc
RD
9108 return _core_.SizerItem_SetSizer(*args, **kwargs)
9109
9110 def GetSpacer(*args, **kwargs):
248ed943
RD
9111 """
9112 GetSpacer(self) -> Size
9113
9114 Get the size of the spacer managed by this sizer item.
9115 """
d55e5bfc
RD
9116 return _core_.SizerItem_GetSpacer(*args, **kwargs)
9117
9118 def SetSpacer(*args, **kwargs):
248ed943
RD
9119 """
9120 SetSpacer(self, Size size)
9121
9122 Set the size of the spacer to be managed by this sizer item.
9123 """
d55e5bfc
RD
9124 return _core_.SizerItem_SetSpacer(*args, **kwargs)
9125
9126 def Show(*args, **kwargs):
248ed943
RD
9127 """
9128 Show(self, bool show)
9129
9130 Set the show item attribute, which sizers use to determine if the item
9131 is to be made part of the layout or not. If the item is tracking a
9132 window then it is shown or hidden as needed.
9133 """
d55e5bfc
RD
9134 return _core_.SizerItem_Show(*args, **kwargs)
9135
9136 def IsShown(*args, **kwargs):
248ed943
RD
9137 """
9138 IsShown(self) -> bool
9139
9140 Is the item to be shown in the layout?
9141 """
d55e5bfc
RD
9142 return _core_.SizerItem_IsShown(*args, **kwargs)
9143
9144 def GetPosition(*args, **kwargs):
248ed943
RD
9145 """
9146 GetPosition(self) -> Point
9147
9148 Returns the current position of the item, as set in the last Layout.
9149 """
d55e5bfc
RD
9150 return _core_.SizerItem_GetPosition(*args, **kwargs)
9151
9152 def GetUserData(*args, **kwargs):
248ed943
RD
9153 """
9154 GetUserData(self) -> PyObject
9155
9156 Returns the userData associated with this sizer item, or None if there
9157 isn't any.
9158 """
d55e5bfc
RD
9159 return _core_.SizerItem_GetUserData(*args, **kwargs)
9160
9161
9162class SizerItemPtr(SizerItem):
9163 def __init__(self, this):
9164 self.this = this
9165 if not hasattr(self,"thisown"): self.thisown = 0
9166 self.__class__ = SizerItem
9167_core_.SizerItem_swigregister(SizerItemPtr)
9168
248ed943 9169def SizerItemWindow(*args, **kwargs):
d55e5bfc 9170 """
248ed943
RD
9171 SizerItemWindow(Window window, int proportion, int flag, int border,
9172 PyObject userData=None) -> SizerItem
9173
9174 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 9175 """
248ed943 9176 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
9177 val.thisown = 1
9178 return val
9179
248ed943 9180def SizerItemSpacer(*args, **kwargs):
d55e5bfc 9181 """
248ed943
RD
9182 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9183 PyObject userData=None) -> SizerItem
9184
9185 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 9186 """
248ed943 9187 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
9188 val.thisown = 1
9189 return val
9190
9191def SizerItemSizer(*args, **kwargs):
9192 """
9193 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9194 PyObject userData=None) -> SizerItem
9195
9196 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
9197 """
9198 val = _core_.new_SizerItemSizer(*args, **kwargs)
9199 val.thisown = 1
9200 return val
9201
9202class Sizer(Object):
248ed943
RD
9203 """
9204 wx.Sizer is the abstract base class used for laying out subwindows in
9205 a window. You cannot use wx.Sizer directly; instead, you will have to
9206 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9207 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9208 and `wx.GridBagSizer`.
9209
9210 The concept implemented by sizers in wxWidgets is closely related to
9211 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9212 toolkit or the Qt toolkit. It is based upon the idea of the individual
9213 subwindows reporting their minimal required size and their ability to
9214 get stretched if the size of the parent window has changed. This will
9215 most often mean that the programmer does not set the original size of
9216 a dialog in the beginning, rather the dialog will assigned a sizer and
9217 this sizer will be queried about the recommended size. The sizer in
9218 turn will query its children, which can be normal windows or contorls,
9219 empty space or other sizers, so that a hierarchy of sizers can be
9220 constructed. Note that wxSizer does not derive from wxWindow and thus
9221 do not interfere with tab ordering and requires very little resources
9222 compared to a real window on screen.
9223
9224 What makes sizers so well fitted for use in wxWidgets is the fact that
9225 every control reports its own minimal size and the algorithm can
9226 handle differences in font sizes or different window (dialog item)
9227 sizes on different platforms without problems. If for example the
9228 standard font as well as the overall design of Mac widgets requires
9229 more space than on Windows, then the initial size of a dialog using a
9230 sizer will automatically be bigger on Mac than on Windows.
9231 """
d55e5bfc
RD
9232 def __init__(self): raise RuntimeError, "No constructor defined"
9233 def __repr__(self):
9234 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9235 def _setOORInfo(*args, **kwargs):
9236 """_setOORInfo(self, PyObject _self)"""
9237 return _core_.Sizer__setOORInfo(*args, **kwargs)
9238
9239 def Add(*args, **kwargs):
9240 """
248ed943 9241 Add(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9242 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9243
9244 Appends a child item to the sizer.
d55e5bfc
RD
9245 """
9246 return _core_.Sizer_Add(*args, **kwargs)
9247
9248 def Insert(*args, **kwargs):
9249 """
248ed943 9250 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9251 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9252
9253 Inserts a new item into the list of items managed by this sizer before
9254 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
9255 """
9256 return _core_.Sizer_Insert(*args, **kwargs)
9257
9258 def Prepend(*args, **kwargs):
9259 """
248ed943 9260 Prepend(self, item, int proportion=0, int flag=0, int border=0,
c1cb24a4 9261 PyObject userData=None) -> wx.SizerItem
248ed943
RD
9262
9263 Adds a new item to the begining of the list of sizer items managed by
9264 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
9265 """
9266 return _core_.Sizer_Prepend(*args, **kwargs)
9267
9268 def Remove(*args, **kwargs):
248ed943
RD
9269 """
9270 Remove(self, item) -> bool
9271
9272 Removes an item from the sizer and destroys it. This method does not
9273 cause any layout or resizing to take place, call `Layout` to update
9274 the layout on screen after removing a child from the sizer. The
9275 *item* parameter can be either a window, a sizer, or the zero-based
9276 index of an item to remove. Returns True if the child item was found
9277 and removed.
9278 """
d55e5bfc
RD
9279 return _core_.Sizer_Remove(*args, **kwargs)
9280
1a6bba1e 9281 def Detach(*args, **kwargs):
248ed943
RD
9282 """
9283 Detach(self, item) -> bool
9284
9285 Detaches an item from the sizer without destroying it. This method
9286 does not cause any layout or resizing to take place, call `Layout` to
9287 do so. The *item* parameter can be either a window, a sizer, or the
9288 zero-based index of the item to be detached. Returns True if the child item
9289 was found and detached.
9290 """
1a6bba1e
RD
9291 return _core_.Sizer_Detach(*args, **kwargs)
9292
c1cb24a4
RD
9293 def GetItem(*args, **kwargs):
9294 """
9295 GetItem(self, item) -> wx.SizerItem
9296
9297 Returns the `wx.SizerItem` which holds the *item* given. The *item*
9298 parameter can be either a window, a sizer, or the zero-based index of
9299 the item to be detached.
9300 """
9301 return _core_.Sizer_GetItem(*args, **kwargs)
9302
d55e5bfc
RD
9303 def _SetItemMinSize(*args, **kwargs):
9304 """_SetItemMinSize(self, PyObject item, Size size)"""
9305 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
9306
248ed943
RD
9307 def SetItemMinSize(self, item, *args):
9308 """
9309 SetItemMinSize(self, item, Size size)
9310
9311 Sets the minimum size that will be allocated for an item in the sizer.
9312 The *item* parameter can be either a window, a sizer, or the
9313 zero-based index of the item. If a window or sizer is given then it
9314 will be searched for recursivly in subsizers if neccessary.
9315 """
9316 if len(args) == 2:
9317 # for backward compatibility accept separate width,height args too
9318 return self._SetItemMinSize(item, args)
9319 else:
9320 return self._SetItemMinSize(item, args[0])
9321
d55e5bfc 9322 def AddItem(*args, **kwargs):
248ed943
RD
9323 """
9324 AddItem(self, SizerItem item)
9325
9326 Adds a `wx.SizerItem` to the sizer.
9327 """
d55e5bfc
RD
9328 return _core_.Sizer_AddItem(*args, **kwargs)
9329
9330 def InsertItem(*args, **kwargs):
248ed943
RD
9331 """
9332 InsertItem(self, int index, SizerItem item)
9333
9334 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9335 """
d55e5bfc
RD
9336 return _core_.Sizer_InsertItem(*args, **kwargs)
9337
9338 def PrependItem(*args, **kwargs):
248ed943
RD
9339 """
9340 PrependItem(self, SizerItem item)
9341
9342 Prepends a `wx.SizerItem` to the sizer.
9343 """
d55e5bfc
RD
9344 return _core_.Sizer_PrependItem(*args, **kwargs)
9345
248ed943 9346 def AddMany(self, items):
c24da6d6
RD
9347 """
9348 AddMany is a convenience method for adding several items
9349 to a sizer at one time. Simply pass it a list of tuples,
9350 where each tuple consists of the parameters that you
9351 would normally pass to the `Add` method.
9352 """
248ed943
RD
9353 for item in items:
9354 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9355 item = (item, )
9356 self.Add(*item)
d55e5bfc
RD
9357
9358 # for backwards compatibility only, please do not use in new code
c24da6d6
RD
9359 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
9360 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
9361 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
9362 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
9363 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
9364 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
9365 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
9366 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
9367 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
9368 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
9369 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
9370 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d55e5bfc
RD
9371
9372
d55e5bfc 9373 def SetDimension(*args, **kwargs):
248ed943
RD
9374 """
9375 SetDimension(self, int x, int y, int width, int height)
9376
9377 Call this to force the sizer to take the given dimension and thus
9378 force the items owned by the sizer to resize themselves according to
9379 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9380 methods.
9381 """
d55e5bfc
RD
9382 return _core_.Sizer_SetDimension(*args, **kwargs)
9383
9384 def SetMinSize(*args, **kwargs):
248ed943
RD
9385 """
9386 SetMinSize(self, Size size)
9387
9388 Call this to give the sizer a minimal size. Normally, the sizer will
9389 calculate its minimal size based purely on how much space its children
9390 need. After calling this method `GetMinSize` will return either the
9391 minimal size as requested by its children or the minimal size set
9392 here, depending on which is bigger.
9393 """
d55e5bfc
RD
9394 return _core_.Sizer_SetMinSize(*args, **kwargs)
9395
9396 def GetSize(*args, **kwargs):
248ed943
RD
9397 """
9398 GetSize(self) -> Size
9399
9400 Returns the current size of the space managed by the sizer.
9401 """
d55e5bfc
RD
9402 return _core_.Sizer_GetSize(*args, **kwargs)
9403
9404 def GetPosition(*args, **kwargs):
248ed943
RD
9405 """
9406 GetPosition(self) -> Point
9407
9408 Returns the current position of the sizer's managed space.
9409 """
d55e5bfc
RD
9410 return _core_.Sizer_GetPosition(*args, **kwargs)
9411
9412 def GetMinSize(*args, **kwargs):
248ed943
RD
9413 """
9414 GetMinSize(self) -> Size
9415
9416 Returns the minimal size of the sizer. This is either the combined
9417 minimal size of all the children and their borders or the minimal size
9418 set by SetMinSize, depending on which is bigger.
9419 """
d55e5bfc
RD
9420 return _core_.Sizer_GetMinSize(*args, **kwargs)
9421
9422 def GetSizeTuple(self):
1a6bba1e 9423 return self.GetSize().Get()
d55e5bfc 9424 def GetPositionTuple(self):
1a6bba1e 9425 return self.GetPosition().Get()
d55e5bfc 9426 def GetMinSizeTuple(self):
1a6bba1e 9427 return self.GetMinSize().Get()
d55e5bfc
RD
9428
9429 def RecalcSizes(*args, **kwargs):
248ed943
RD
9430 """
9431 RecalcSizes(self)
9432
9433 Using the sizes calculated by `CalcMin` reposition and resize all the
9434 items managed by this sizer. You should not need to call this directly as
9435 it is called by `Layout`.
9436 """
d55e5bfc
RD
9437 return _core_.Sizer_RecalcSizes(*args, **kwargs)
9438
9439 def CalcMin(*args, **kwargs):
248ed943
RD
9440 """
9441 CalcMin(self) -> Size
9442
9443 This method is where the sizer will do the actual calculation of its
9444 children's minimal sizes. You should not need to call this directly as
9445 it is called by `Layout`.
9446 """
d55e5bfc
RD
9447 return _core_.Sizer_CalcMin(*args, **kwargs)
9448
9449 def Layout(*args, **kwargs):
248ed943
RD
9450 """
9451 Layout(self)
9452
9453 This method will force the recalculation and layout of the items
9454 controlled by the sizer using the current space allocated to the
9455 sizer. Normally this is called automatically from the owning window's
9456 EVT_SIZE handler, but it is also useful to call it from user code when
9457 one of the items in a sizer change size, or items are added or
9458 removed.
9459 """
d55e5bfc
RD
9460 return _core_.Sizer_Layout(*args, **kwargs)
9461
9462 def Fit(*args, **kwargs):
248ed943
RD
9463 """
9464 Fit(self, Window window) -> Size
9465
9466 Tell the sizer to resize the *window* to match the sizer's minimal
9467 size. This is commonly done in the constructor of the window itself in
9468 order to set its initial size to match the needs of the children as
9469 determined by the sizer. Returns the new size.
9470
9471 For a top level window this is the total window size, not the client size.
9472 """
d55e5bfc
RD
9473 return _core_.Sizer_Fit(*args, **kwargs)
9474
9475 def FitInside(*args, **kwargs):
248ed943
RD
9476 """
9477 FitInside(self, Window window)
9478
9479 Tell the sizer to resize the *virtual size* of the *window* to match the
9480 sizer's minimal size. This will not alter the on screen size of the
9481 window, but may cause the addition/removal/alteration of scrollbars
9482 required to view the virtual area in windows which manage it.
9483
9484 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9485
9486 """
d55e5bfc
RD
9487 return _core_.Sizer_FitInside(*args, **kwargs)
9488
9489 def SetSizeHints(*args, **kwargs):
248ed943
RD
9490 """
9491 SetSizeHints(self, Window window)
9492
9493 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9494 match the sizer's minimal size. This is commonly done in the
9495 constructor of the window itself if the window is resizable (as are
9496 many dialogs under Unix and frames on probably all platforms) in order
9497 to prevent the window from being sized smaller than the minimal size
9498 required by the sizer.
9499 """
d55e5bfc
RD
9500 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9501
9502 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9503 """
9504 SetVirtualSizeHints(self, Window window)
9505
9506 Tell the sizer to set the minimal size of the window virtual area to
9507 match the sizer's minimal size. For windows with managed scrollbars
9508 this will set them appropriately.
9509
9510 :see: `wx.ScrolledWindow.SetScrollbars`
9511
9512 """
d55e5bfc
RD
9513 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9514
9515 def Clear(*args, **kwargs):
248ed943
RD
9516 """
9517 Clear(self, bool deleteWindows=False)
9518
9519 Clear all items from the sizer, optionally destroying the window items
9520 as well.
9521 """
d55e5bfc
RD
9522 return _core_.Sizer_Clear(*args, **kwargs)
9523
9524 def DeleteWindows(*args, **kwargs):
248ed943
RD
9525 """
9526 DeleteWindows(self)
9527
9528 Destroy all windows managed by the sizer.
9529 """
d55e5bfc
RD
9530 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9531
9532 def GetChildren(*args, **kwargs):
248ed943
RD
9533 """
9534 GetChildren(sefl) -> list
9535
9536 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9537 """
d55e5bfc
RD
9538 return _core_.Sizer_GetChildren(*args, **kwargs)
9539
9540 def Show(*args, **kwargs):
248ed943 9541 """
ae8162c8 9542 Show(self, item, bool show=True, bool recursive=false) -> bool
d55e5bfc 9543
248ed943
RD
9544 Shows or hides an item managed by the sizer. To make a sizer item
9545 disappear or reappear, use Show followed by `Layout`. The *item*
9546 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD
9547 the item. Use the recursive parameter to show or hide an item in a
9548 subsizer. Returns True if the item was found.
248ed943
RD
9549 """
9550 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
9551
9552 def IsShown(*args, **kwargs):
248ed943
RD
9553 """
9554 IsShown(self, item)
9555
9556 Determines if the item is currently shown. sizer. To make a sizer
9557 item disappear or reappear, use Show followed by `Layout`. The *item*
9558 parameter can be either a window, a sizer, or the zero-based index of
9559 the item.
9560 """
d55e5bfc
RD
9561 return _core_.Sizer_IsShown(*args, **kwargs)
9562
629e65c2 9563 def Hide(self, item, recursive=False):
248ed943 9564 """
629e65c2 9565 A convenience method for Show(item, False, recursive).
248ed943 9566 """
06759a38 9567 return self.Show(item, False, recursive)
248ed943 9568
d55e5bfc 9569 def ShowItems(*args, **kwargs):
248ed943
RD
9570 """
9571 ShowItems(self, bool show)
9572
84f85550 9573 Recursively call `wx.SizerItem.Show` on all sizer items.
248ed943 9574 """
d55e5bfc
RD
9575 return _core_.Sizer_ShowItems(*args, **kwargs)
9576
9577
9578class SizerPtr(Sizer):
9579 def __init__(self, this):
9580 self.this = this
9581 if not hasattr(self,"thisown"): self.thisown = 0
9582 self.__class__ = Sizer
9583_core_.Sizer_swigregister(SizerPtr)
9584
9585class PySizer(Sizer):
248ed943
RD
9586 """
9587 wx.PySizer is a special version of `wx.Sizer` that has been
9588 instrumented to allow the C++ virtual methods to be overloaded in
9589 Python derived classes. You would derive from this class if you are
9590 wanting to implement a custom sizer in Python code. Simply implement
9591 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9592 For example::
9593
9594 class MySizer(wx.PySizer):
9595 def __init__(self):
9596 wx.PySizer.__init__(self)
9597
9598 def CalcMin(self):
9599 for item in self.GetChildren():
9600 # calculate the total minimum width and height needed
9601 # by all items in the sizer according to this sizer's
9602 # layout algorithm.
9603 ...
9604 return wx.Size(width, height)
9605
9606 def RecalcSizes(self):
9607 # find the space allotted to this sizer
9608 pos = self.GetPosition()
9609 size = self.GetSize()
9610 for item in self.GetChildren():
9611 # Recalculate (if necessary) the position and size of
9612 # each item and then call item.SetDimension to do the
9613 # actual positioning and sizing of the items within the
9614 # space alloted to this sizer.
9615 ...
9616 item.SetDimension(itemPos, itemSize)
9617
9618
9619 When `Layout` is called it first calls `CalcMin` followed by
9620 `RecalcSizes` so you can optimize a bit by saving the results of
9621 `CalcMin` and resuing them in `RecalcSizes`.
9622
9623 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9624
9625
9626 """
d55e5bfc
RD
9627 def __repr__(self):
9628 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9629 def __init__(self, *args, **kwargs):
248ed943
RD
9630 """
9631 __init__(self) -> PySizer
9632
9633 Creates a wx.PySizer. Must be called from the __init__ in the derived
9634 class.
9635 """
d55e5bfc
RD
9636 newobj = _core_.new_PySizer(*args, **kwargs)
9637 self.this = newobj.this
9638 self.thisown = 1
9639 del newobj.thisown
9640 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
9641
9642 def _setCallbackInfo(*args, **kwargs):
9643 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
9644 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
9645
9646
9647class PySizerPtr(PySizer):
9648 def __init__(self, this):
9649 self.this = this
9650 if not hasattr(self,"thisown"): self.thisown = 0
9651 self.__class__ = PySizer
9652_core_.PySizer_swigregister(PySizerPtr)
9653
9654#---------------------------------------------------------------------------
9655
9656class BoxSizer(Sizer):
248ed943
RD
9657 """
9658 The basic idea behind a box sizer is that windows will most often be
9659 laid out in rather simple basic geometry, typically in a row or a
9660 column or nested hierarchies of either. A wx.BoxSizer will lay out
9661 its items in a simple row or column, depending on the orientation
9662 parameter passed to the constructor.
9663 """
d55e5bfc
RD
9664 def __repr__(self):
9665 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9666 def __init__(self, *args, **kwargs):
248ed943
RD
9667 """
9668 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9669
9670 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9671 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9672 sizer.
9673 """
d55e5bfc
RD
9674 newobj = _core_.new_BoxSizer(*args, **kwargs)
9675 self.this = newobj.this
9676 self.thisown = 1
9677 del newobj.thisown
9678 self._setOORInfo(self)
9679
9680 def GetOrientation(*args, **kwargs):
248ed943
RD
9681 """
9682 GetOrientation(self) -> int
9683
9684 Returns the current orientation of the sizer.
9685 """
d55e5bfc
RD
9686 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
9687
9688 def SetOrientation(*args, **kwargs):
248ed943
RD
9689 """
9690 SetOrientation(self, int orient)
d55e5bfc 9691
248ed943
RD
9692 Resets the orientation of the sizer.
9693 """
9694 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
9695
9696
9697class BoxSizerPtr(BoxSizer):
9698 def __init__(self, this):
9699 self.this = this
9700 if not hasattr(self,"thisown"): self.thisown = 0
9701 self.__class__ = BoxSizer
9702_core_.BoxSizer_swigregister(BoxSizerPtr)
9703
9704#---------------------------------------------------------------------------
9705
9706class StaticBoxSizer(BoxSizer):
248ed943
RD
9707 """
9708 wx.StaticBoxSizer derives from and functions identically to the
9709 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9710 manages. Note that this static box must be created separately and
9711 passed to the sizer constructor.
9712 """
d55e5bfc
RD
9713 def __repr__(self):
9714 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9715 def __init__(self, *args, **kwargs):
248ed943
RD
9716 """
9717 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9718
9719 Constructor. It takes an associated static box and the orientation
9720 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9721 ``wx.HORIZONTAL``.
9722 """
d55e5bfc
RD
9723 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
9724 self.this = newobj.this
9725 self.thisown = 1
9726 del newobj.thisown
9727 self._setOORInfo(self)
9728
9729 def GetStaticBox(*args, **kwargs):
248ed943
RD
9730 """
9731 GetStaticBox(self) -> StaticBox
d55e5bfc 9732
248ed943
RD
9733 Returns the static box associated with this sizer.
9734 """
9735 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
9736
9737
9738class StaticBoxSizerPtr(StaticBoxSizer):
9739 def __init__(self, this):
9740 self.this = this
9741 if not hasattr(self,"thisown"): self.thisown = 0
9742 self.__class__ = StaticBoxSizer
9743_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
9744
9745#---------------------------------------------------------------------------
9746
9747class GridSizer(Sizer):
248ed943
RD
9748 """
9749 A grid sizer is a sizer which lays out its children in a
9750 two-dimensional table with all cells having the same size. In other
9751 words, the width of each cell within the grid is the width of the
9752 widest item added to the sizer and the height of each grid cell is the
9753 height of the tallest item. An optional vertical and/or horizontal
9754 gap between items can also be specified (in pixels.)
9755
9756 Items are placed in the cells of the grid in the order they are added,
9757 in row-major order. In other words, the first row is filled first,
9758 then the second, and so on until all items have been added. (If
9759 neccessary, additional rows will be added as items are added.) If you
9760 need to have greater control over the cells that items are placed in
9761 then use the `wx.GridBagSizer`.
9762
9763 """
d55e5bfc
RD
9764 def __repr__(self):
9765 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9766 def __init__(self, *args, **kwargs):
248ed943
RD
9767 """
9768 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9769
9770 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9771 of columns and rows in the sizer - if either of the parameters is
9772 zero, it will be calculated to from the total number of children in
9773 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9774 define extra space between all children.
9775 """
d55e5bfc
RD
9776 newobj = _core_.new_GridSizer(*args, **kwargs)
9777 self.this = newobj.this
9778 self.thisown = 1
9779 del newobj.thisown
9780 self._setOORInfo(self)
9781
d55e5bfc 9782 def SetCols(*args, **kwargs):
248ed943
RD
9783 """
9784 SetCols(self, int cols)
9785
9786 Sets the number of columns in the sizer.
9787 """
d55e5bfc
RD
9788 return _core_.GridSizer_SetCols(*args, **kwargs)
9789
9790 def SetRows(*args, **kwargs):
248ed943
RD
9791 """
9792 SetRows(self, int rows)
9793
9794 Sets the number of rows in the sizer.
9795 """
d55e5bfc
RD
9796 return _core_.GridSizer_SetRows(*args, **kwargs)
9797
9798 def SetVGap(*args, **kwargs):
248ed943
RD
9799 """
9800 SetVGap(self, int gap)
9801
9802 Sets the vertical gap (in pixels) between the cells in the sizer.
9803 """
d55e5bfc
RD
9804 return _core_.GridSizer_SetVGap(*args, **kwargs)
9805
9806 def SetHGap(*args, **kwargs):
248ed943
RD
9807 """
9808 SetHGap(self, int gap)
9809
9810 Sets the horizontal gap (in pixels) between cells in the sizer
9811 """
d55e5bfc
RD
9812 return _core_.GridSizer_SetHGap(*args, **kwargs)
9813
9814 def GetCols(*args, **kwargs):
248ed943
RD
9815 """
9816 GetCols(self) -> int
9817
9818 Returns the number of columns in the sizer.
9819 """
d55e5bfc
RD
9820 return _core_.GridSizer_GetCols(*args, **kwargs)
9821
9822 def GetRows(*args, **kwargs):
248ed943
RD
9823 """
9824 GetRows(self) -> int
9825
9826 Returns the number of rows in the sizer.
9827 """
d55e5bfc
RD
9828 return _core_.GridSizer_GetRows(*args, **kwargs)
9829
9830 def GetVGap(*args, **kwargs):
248ed943
RD
9831 """
9832 GetVGap(self) -> int
9833
9834 Returns the vertical gap (in pixels) between the cells in the sizer.
9835 """
d55e5bfc
RD
9836 return _core_.GridSizer_GetVGap(*args, **kwargs)
9837
9838 def GetHGap(*args, **kwargs):
248ed943
RD
9839 """
9840 GetHGap(self) -> int
9841
9842 Returns the horizontal gap (in pixels) between cells in the sizer.
9843 """
d55e5bfc
RD
9844 return _core_.GridSizer_GetHGap(*args, **kwargs)
9845
9846
9847class GridSizerPtr(GridSizer):
9848 def __init__(self, this):
9849 self.this = this
9850 if not hasattr(self,"thisown"): self.thisown = 0
9851 self.__class__ = GridSizer
9852_core_.GridSizer_swigregister(GridSizerPtr)
9853
9854#---------------------------------------------------------------------------
9855
9856FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9857FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9858FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
9859class FlexGridSizer(GridSizer):
248ed943
RD
9860 """
9861 A flex grid sizer is a sizer which lays out its children in a
9862 two-dimensional table with all table cells in one row having the same
9863 height and all cells in one column having the same width, but all
9864 rows or all columns are not necessarily the same height or width as in
9865 the `wx.GridSizer`.
9866
9867 wx.FlexGridSizer can also size items equally in one direction but
9868 unequally ("flexibly") in the other. If the sizer is only flexible
9869 in one direction (this can be changed using `SetFlexibleDirection`), it
9870 needs to be decided how the sizer should grow in the other ("non
9871 flexible") direction in order to fill the available space. The
9872 `SetNonFlexibleGrowMode` method serves this purpose.
9873
9874
9875 """
d55e5bfc
RD
9876 def __repr__(self):
9877 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9878 def __init__(self, *args, **kwargs):
248ed943
RD
9879 """
9880 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9881
9882 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9883 number of columns and rows in the sizer - if either of the parameters
9884 is zero, it will be calculated to from the total number of children in
9885 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9886 define extra space between all children.
9887 """
d55e5bfc
RD
9888 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
9889 self.this = newobj.this
9890 self.thisown = 1
9891 del newobj.thisown
9892 self._setOORInfo(self)
9893
248ed943
RD
9894 def AddGrowableRow(*args, **kwargs):
9895 """
9896 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 9897
248ed943
RD
9898 Specifies that row *idx* (starting from zero) should be grown if there
9899 is extra space available to the sizer.
d55e5bfc 9900
248ed943
RD
9901 The *proportion* parameter has the same meaning as the stretch factor
9902 for the box sizers except that if all proportions are 0, then all
9903 columns are resized equally (instead of not being resized at all).
9904 """
d55e5bfc
RD
9905 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
9906
9907 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
9908 """
9909 RemoveGrowableRow(self, size_t idx)
9910
9911 Specifies that row *idx* is no longer growable.
9912 """
d55e5bfc
RD
9913 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
9914
9915 def AddGrowableCol(*args, **kwargs):
248ed943
RD
9916 """
9917 AddGrowableCol(self, size_t idx, int proportion=0)
9918
9919 Specifies that column *idx* (starting from zero) should be grown if
9920 there is extra space available to the sizer.
9921
9922 The *proportion* parameter has the same meaning as the stretch factor
9923 for the box sizers except that if all proportions are 0, then all
9924 columns are resized equally (instead of not being resized at all).
9925 """
d55e5bfc
RD
9926 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
9927
9928 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
9929 """
9930 RemoveGrowableCol(self, size_t idx)
9931
9932 Specifies that column *idx* is no longer growable.
9933 """
d55e5bfc
RD
9934 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
9935
9936 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
9937 """
9938 SetFlexibleDirection(self, int direction)
9939
9940 Specifies whether the sizer should flexibly resize its columns, rows,
9941 or both. Argument *direction* can be one of the following values. Any
9942 other value is ignored.
9943
9944 ============== =======================================
9945 wx.VERTICAL Rows are flexibly sized.
9946 wx.HORIZONTAL Columns are flexibly sized.
9947 wx.BOTH Both rows and columns are flexibly sized
9948 (this is the default value).
9949 ============== =======================================
9950
9951 Note that this method does not trigger relayout.
9952
9953 """
d55e5bfc
RD
9954 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
9955
9956 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
9957 """
9958 GetFlexibleDirection(self) -> int
9959
9960 Returns a value that specifies whether the sizer
9961 flexibly resizes its columns, rows, or both (default).
9962
9963 :see: `SetFlexibleDirection`
9964 """
d55e5bfc
RD
9965 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
9966
9967 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9968 """
9969 SetNonFlexibleGrowMode(self, int mode)
9970
9971 Specifies how the sizer should grow in the non-flexible direction if
9972 there is one (so `SetFlexibleDirection` must have been called
9973 previously). Argument *mode* can be one of the following values:
9974
9975 ========================== =================================================
9976 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9977 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9978 `AddGrowableCol` and `AddGrowableRow`. In this
9979 case equal sizing applies to minimum sizes of
9980 columns or rows (this is the default value).
9981 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9982 the non flexible direction, whether they are
9983 growable or not in the flexbile direction.
9984 ========================== =================================================
9985
9986 Note that this method does not trigger relayout.
9987
9988
9989 """
d55e5bfc
RD
9990 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
9991
9992 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9993 """
9994 GetNonFlexibleGrowMode(self) -> int
9995
9996 Returns the value that specifies how the sizer grows in the
9997 non-flexible direction if there is one.
9998
9999 :see: `SetNonFlexibleGrowMode`
10000 """
d55e5bfc
RD
10001 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
10002
10003 def GetRowHeights(*args, **kwargs):
a8eff060
RD
10004 """
10005 GetRowHeights(self) -> list
10006
10007 Returns a list of integers representing the heights of each of the
10008 rows in the sizer.
10009 """
d55e5bfc
RD
10010 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
10011
10012 def GetColWidths(*args, **kwargs):
a8eff060
RD
10013 """
10014 GetColWidths(self) -> list
10015
10016 Returns a list of integers representing the widths of each of the
10017 columns in the sizer.
10018 """
d55e5bfc
RD
10019 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
10020
10021
10022class FlexGridSizerPtr(FlexGridSizer):
10023 def __init__(self, this):
10024 self.this = this
10025 if not hasattr(self,"thisown"): self.thisown = 0
10026 self.__class__ = FlexGridSizer
10027_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
10028
10029#---------------------------------------------------------------------------
10030
10031class GBPosition(object):
248ed943
RD
10032 """
10033 This class represents the position of an item in a virtual grid of
10034 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10035 typemaps that will automatically convert from a 2-element sequence of
10036 integers to a wx.GBPosition, so you can use the more pythonic
10037 representation of the position nearly transparently in Python code.
10038 """
d55e5bfc
RD
10039 def __repr__(self):
10040 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10041 def __init__(self, *args, **kwargs):
248ed943
RD
10042 """
10043 __init__(self, int row=0, int col=0) -> GBPosition
10044
10045 This class represents the position of an item in a virtual grid of
10046 rows and columns managed by a `wx.GridBagSizer`. wxPython has
10047 typemaps that will automatically convert from a 2-element sequence of
10048 integers to a wx.GBPosition, so you can use the more pythonic
10049 representation of the position nearly transparently in Python code.
10050 """
d55e5bfc
RD
10051 newobj = _core_.new_GBPosition(*args, **kwargs)
10052 self.this = newobj.this
10053 self.thisown = 1
10054 del newobj.thisown
10055 def GetRow(*args, **kwargs):
10056 """GetRow(self) -> int"""
10057 return _core_.GBPosition_GetRow(*args, **kwargs)
10058
10059 def GetCol(*args, **kwargs):
10060 """GetCol(self) -> int"""
10061 return _core_.GBPosition_GetCol(*args, **kwargs)
10062
10063 def SetRow(*args, **kwargs):
10064 """SetRow(self, int row)"""
10065 return _core_.GBPosition_SetRow(*args, **kwargs)
10066
10067 def SetCol(*args, **kwargs):
10068 """SetCol(self, int col)"""
10069 return _core_.GBPosition_SetCol(*args, **kwargs)
10070
10071 def __eq__(*args, **kwargs):
10072 """__eq__(self, GBPosition other) -> bool"""
10073 return _core_.GBPosition___eq__(*args, **kwargs)
10074
10075 def __ne__(*args, **kwargs):
10076 """__ne__(self, GBPosition other) -> bool"""
10077 return _core_.GBPosition___ne__(*args, **kwargs)
10078
10079 def Set(*args, **kwargs):
10080 """Set(self, int row=0, int col=0)"""
10081 return _core_.GBPosition_Set(*args, **kwargs)
10082
10083 def Get(*args, **kwargs):
10084 """Get(self) -> PyObject"""
10085 return _core_.GBPosition_Get(*args, **kwargs)
10086
79fccf9d 10087 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
10088 def __str__(self): return str(self.Get())
10089 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
10090 def __len__(self): return len(self.Get())
10091 def __getitem__(self, index): return self.Get()[index]
10092 def __setitem__(self, index, val):
10093 if index == 0: self.SetRow(val)
10094 elif index == 1: self.SetCol(val)
10095 else: raise IndexError
10096 def __nonzero__(self): return self.Get() != (0,0)
10097 __safe_for_unpickling__ = True
10098 def __reduce__(self): return (wx.GBPosition, self.Get())
10099
10100 row = property(GetRow, SetRow)
10101 col = property(GetCol, SetCol)
10102
10103
10104class GBPositionPtr(GBPosition):
10105 def __init__(self, this):
10106 self.this = this
10107 if not hasattr(self,"thisown"): self.thisown = 0
10108 self.__class__ = GBPosition
10109_core_.GBPosition_swigregister(GBPositionPtr)
10110
10111class GBSpan(object):
248ed943
RD
10112 """
10113 This class is used to hold the row and column spanning attributes of
10114 items in a `wx.GridBagSizer`. wxPython has typemaps that will
10115 automatically convert from a 2-element sequence of integers to a
10116 wx.GBSpan, so you can use the more pythonic representation of the span
10117 nearly transparently in Python code.
10118
10119 """
d55e5bfc
RD
10120 def __repr__(self):
10121 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10122 def __init__(self, *args, **kwargs):
248ed943
RD
10123 """
10124 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
10125
10126 Construct a new wxGBSpan, optionally setting the rowspan and
10127 colspan. The default is (1,1). (Meaning that the item occupies one
10128 cell in each direction.
10129 """
d55e5bfc
RD
10130 newobj = _core_.new_GBSpan(*args, **kwargs)
10131 self.this = newobj.this
10132 self.thisown = 1
10133 del newobj.thisown
10134 def GetRowspan(*args, **kwargs):
10135 """GetRowspan(self) -> int"""
10136 return _core_.GBSpan_GetRowspan(*args, **kwargs)
10137
10138 def GetColspan(*args, **kwargs):
10139 """GetColspan(self) -> int"""
10140 return _core_.GBSpan_GetColspan(*args, **kwargs)
10141
10142 def SetRowspan(*args, **kwargs):
10143 """SetRowspan(self, int rowspan)"""
10144 return _core_.GBSpan_SetRowspan(*args, **kwargs)
10145
10146 def SetColspan(*args, **kwargs):
10147 """SetColspan(self, int colspan)"""
10148 return _core_.GBSpan_SetColspan(*args, **kwargs)
10149
10150 def __eq__(*args, **kwargs):
10151 """__eq__(self, GBSpan other) -> bool"""
10152 return _core_.GBSpan___eq__(*args, **kwargs)
10153
10154 def __ne__(*args, **kwargs):
10155 """__ne__(self, GBSpan other) -> bool"""
10156 return _core_.GBSpan___ne__(*args, **kwargs)
10157
10158 def Set(*args, **kwargs):
10159 """Set(self, int rowspan=1, int colspan=1)"""
10160 return _core_.GBSpan_Set(*args, **kwargs)
10161
10162 def Get(*args, **kwargs):
10163 """Get(self) -> PyObject"""
10164 return _core_.GBSpan_Get(*args, **kwargs)
10165
79fccf9d 10166 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
10167 def __str__(self): return str(self.Get())
10168 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10169 def __len__(self): return len(self.Get())
10170 def __getitem__(self, index): return self.Get()[index]
10171 def __setitem__(self, index, val):
10172 if index == 0: self.SetRowspan(val)
10173 elif index == 1: self.SetColspan(val)
10174 else: raise IndexError
10175 def __nonzero__(self): return self.Get() != (0,0)
10176 __safe_for_unpickling__ = True
10177 def __reduce__(self): return (wx.GBSpan, self.Get())
10178
10179 rowspan = property(GetRowspan, SetRowspan)
10180 colspan = property(GetColspan, SetColspan)
10181
10182
10183class GBSpanPtr(GBSpan):
10184 def __init__(self, this):
10185 self.this = this
10186 if not hasattr(self,"thisown"): self.thisown = 0
10187 self.__class__ = GBSpan
10188_core_.GBSpan_swigregister(GBSpanPtr)
10189
10190class GBSizerItem(SizerItem):
248ed943
RD
10191 """
10192 The wx.GBSizerItem class is used to track the additional data about
10193 items in a `wx.GridBagSizer` such as the item's position in the grid
10194 and how many rows or columns it spans.
10195
10196 """
d55e5bfc
RD
10197 def __repr__(self):
10198 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10199 def __init__(self, *args, **kwargs):
248ed943
RD
10200 """
10201 __init__(self) -> GBSizerItem
10202
10203 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10204 size will need to be set, as well as a position and span before this
10205 item can be used in a Sizer.
10206
10207 You will probably never need to create a wx.GBSizerItem directly as they
10208 are created automatically when the sizer's Add method is called.
10209 """
d55e5bfc
RD
10210 newobj = _core_.new_GBSizerItem(*args, **kwargs)
10211 self.this = newobj.this
10212 self.thisown = 1
10213 del newobj.thisown
10214 def GetPos(*args, **kwargs):
248ed943
RD
10215 """
10216 GetPos(self) -> GBPosition
10217
10218 Get the grid position of the item
10219 """
d55e5bfc
RD
10220 return _core_.GBSizerItem_GetPos(*args, **kwargs)
10221
10222 def GetPosTuple(self): return self.GetPos().Get()
10223 def GetSpan(*args, **kwargs):
248ed943
RD
10224 """
10225 GetSpan(self) -> GBSpan
10226
10227 Get the row and column spanning of the item
10228 """
d55e5bfc
RD
10229 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
10230
10231 def GetSpanTuple(self): return self.GetSpan().Get()
10232 def SetPos(*args, **kwargs):
248ed943
RD
10233 """
10234 SetPos(self, GBPosition pos) -> bool
10235
10236 If the item is already a member of a sizer then first ensure that
10237 there is no other item that would intersect with this one at the new
10238 position, then set the new position. Returns True if the change is
10239 successful and after the next Layout() the item will be moved.
10240 """
d55e5bfc
RD
10241 return _core_.GBSizerItem_SetPos(*args, **kwargs)
10242
10243 def SetSpan(*args, **kwargs):
248ed943
RD
10244 """
10245 SetSpan(self, GBSpan span) -> bool
10246
10247 If the item is already a member of a sizer then first ensure that
10248 there is no other item that would intersect with this one with its new
10249 spanning size, then set the new spanning. Returns True if the change
10250 is successful and after the next Layout() the item will be resized.
10251
10252 """
d55e5bfc
RD
10253 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
10254
248ed943 10255 def Intersects(*args, **kwargs):
d55e5bfc
RD
10256 """
10257 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10258
10259 Returns True if this item and the other item instersect.
d55e5bfc 10260 """
248ed943
RD
10261 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10262
10263 def IntersectsPos(*args, **kwargs):
10264 """
10265 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10266
10267 Returns True if the given pos/span would intersect with this item.
10268 """
10269 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
10270
10271 def GetEndPos(*args, **kwargs):
248ed943
RD
10272 """
10273 GetEndPos(self) -> GBPosition
10274
10275 Get the row and column of the endpoint of this item.
10276 """
d55e5bfc
RD
10277 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
10278
10279 def GetGBSizer(*args, **kwargs):
248ed943
RD
10280 """
10281 GetGBSizer(self) -> GridBagSizer
10282
10283 Get the sizer this item is a member of.
10284 """
d55e5bfc
RD
10285 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
10286
10287 def SetGBSizer(*args, **kwargs):
248ed943
RD
10288 """
10289 SetGBSizer(self, GridBagSizer sizer)
10290
10291 Set the sizer this item is a member of.
10292 """
d55e5bfc
RD
10293 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
10294
10295
10296class GBSizerItemPtr(GBSizerItem):
10297 def __init__(self, this):
10298 self.this = this
10299 if not hasattr(self,"thisown"): self.thisown = 0
10300 self.__class__ = GBSizerItem
10301_core_.GBSizerItem_swigregister(GBSizerItemPtr)
10302DefaultSpan = cvar.DefaultSpan
10303
10304def GBSizerItemWindow(*args, **kwargs):
10305 """
10306 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10307 int border, PyObject userData=None) -> GBSizerItem
10308
10309 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
10310 """
10311 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
10312 val.thisown = 1
10313 return val
10314
10315def GBSizerItemSizer(*args, **kwargs):
10316 """
10317 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10318 int border, PyObject userData=None) -> GBSizerItem
10319
10320 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
10321 """
10322 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
10323 val.thisown = 1
10324 return val
10325
10326def GBSizerItemSpacer(*args, **kwargs):
10327 """
10328 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10329 int flag, int border, PyObject userData=None) -> GBSizerItem
10330
10331 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
10332 """
10333 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
10334 val.thisown = 1
10335 return val
10336
10337class GridBagSizer(FlexGridSizer):
248ed943
RD
10338 """
10339 A `wx.Sizer` that can lay out items in a virtual grid like a
10340 `wx.FlexGridSizer` but in this case explicit positioning of the items
10341 is allowed using `wx.GBPosition`, and items can optionally span more
10342 than one row and/or column using `wx.GBSpan`. The total size of the
10343 virtual grid is determined by the largest row and column that items are
10344 positioned at, adjusted for spanning.
10345
10346 """
d55e5bfc
RD
10347 def __repr__(self):
10348 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10349 def __init__(self, *args, **kwargs):
248ed943
RD
10350 """
10351 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10352
10353 Constructor, with optional parameters to specify the gap between the
10354 rows and columns.
10355 """
d55e5bfc
RD
10356 newobj = _core_.new_GridBagSizer(*args, **kwargs)
10357 self.this = newobj.this
10358 self.thisown = 1
10359 del newobj.thisown
10360 def Add(*args, **kwargs):
10361 """
248ed943 10362 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
c1cb24a4 10363 int border=0, userData=None) -> wx.GBSizerItem
248ed943
RD
10364
10365 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10366 more than one row or column as specified with *span*. The remaining
10367 args behave similarly to `wx.Sizer.Add`.
10368
10369 Returns True if the item was successfully placed at the given cell
10370 position, False if something was already there.
10371
d55e5bfc
RD
10372 """
10373 return _core_.GridBagSizer_Add(*args, **kwargs)
10374
10375 def AddItem(*args, **kwargs):
248ed943 10376 """
c1cb24a4 10377 Add(self, GBSizerItem item) -> wx.GBSizerItem
248ed943
RD
10378
10379 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10380 the item was successfully placed at its given cell position, False if
10381 something was already there.
10382 """
d55e5bfc
RD
10383 return _core_.GridBagSizer_AddItem(*args, **kwargs)
10384
84f85550
RD
10385 def GetCellSize(*args, **kwargs):
10386 """
10387 GetCellSize(self, int row, int col) -> Size
10388
10389 Get the size of the specified cell, including hgap and
10390 vgap. Only valid after a Layout.
10391 """
10392 return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
10393
d55e5bfc 10394 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10395 """
10396 GetEmptyCellSize(self) -> Size
10397
10398 Get the size used for cells in the grid with no item.
10399 """
d55e5bfc
RD
10400 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
10401
10402 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10403 """
10404 SetEmptyCellSize(self, Size sz)
10405
10406 Set the size used for cells in the grid with no item.
10407 """
d55e5bfc
RD
10408 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
10409
10410 def GetItemPosition(*args):
10411 """
248ed943
RD
10412 GetItemPosition(self, item) -> GBPosition
10413
10414 Get the grid position of the specified *item* where *item* is either a
10415 window or subsizer that is a member of this sizer, or a zero-based
10416 index of an item.
d55e5bfc
RD
10417 """
10418 return _core_.GridBagSizer_GetItemPosition(*args)
10419
10420 def SetItemPosition(*args):
10421 """
248ed943
RD
10422 SetItemPosition(self, item, GBPosition pos) -> bool
10423
10424 Set the grid position of the specified *item* where *item* is either a
10425 window or subsizer that is a member of this sizer, or a zero-based
10426 index of an item. Returns True on success. If the move is not
10427 allowed (because an item is already there) then False is returned.
10428
d55e5bfc
RD
10429 """
10430 return _core_.GridBagSizer_SetItemPosition(*args)
10431
10432 def GetItemSpan(*args):
10433 """
248ed943
RD
10434 GetItemSpan(self, item) -> GBSpan
10435
10436 Get the row/col spanning of the specified *item* where *item* is
10437 either a window or subsizer that is a member of this sizer, or a
10438 zero-based index of an item.
d55e5bfc
RD
10439 """
10440 return _core_.GridBagSizer_GetItemSpan(*args)
10441
10442 def SetItemSpan(*args):
10443 """
248ed943
RD
10444 SetItemSpan(self, item, GBSpan span) -> bool
10445
10446 Set the row/col spanning of the specified *item* where *item* is
10447 either a window or subsizer that is a member of this sizer, or a
10448 zero-based index of an item. Returns True on success. If the move is
10449 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
10450 """
10451 return _core_.GridBagSizer_SetItemSpan(*args)
10452
10453 def FindItem(*args):
10454 """
248ed943
RD
10455 FindItem(self, item) -> GBSizerItem
10456
10457 Find the sizer item for the given window or subsizer, returns None if
10458 not found. (non-recursive)
d55e5bfc
RD
10459 """
10460 return _core_.GridBagSizer_FindItem(*args)
10461
10462 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10463 """
10464 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10465
10466 Return the sizer item for the given grid cell, or None if there is no
10467 item at that position. (non-recursive)
10468 """
d55e5bfc
RD
10469 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10470
10471 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10472 """
10473 FindItemAtPoint(self, Point pt) -> GBSizerItem
10474
10475 Return the sizer item located at the point given in *pt*, or None if
10476 there is no item at that point. The (x,y) coordinates in pt correspond
10477 to the client coordinates of the window using the sizer for
10478 layout. (non-recursive)
10479 """
d55e5bfc
RD
10480 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10481
248ed943
RD
10482 def CheckForIntersection(*args, **kwargs):
10483 """
10484 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10485
248ed943
RD
10486 Look at all items and see if any intersect (or would overlap) the
10487 given *item*. Returns True if so, False if there would be no overlap.
10488 If an *excludeItem* is given then it will not be checked for
10489 intersection, for example it may be the item we are checking the
10490 position of.
d55e5bfc 10491
248ed943
RD
10492 """
10493 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10494
248ed943 10495 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10496 """
248ed943
RD
10497 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10498
10499 Look at all items and see if any intersect (or would overlap) the
10500 given position and span. Returns True if so, False if there would be
10501 no overlap. If an *excludeItem* is given then it will not be checked
10502 for intersection, for example it may be the item we are checking the
10503 position of.
d55e5bfc 10504 """
248ed943 10505 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
10506
10507
10508class GridBagSizerPtr(GridBagSizer):
10509 def __init__(self, this):
10510 self.this = this
10511 if not hasattr(self,"thisown"): self.thisown = 0
10512 self.__class__ = GridBagSizer
10513_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10514
10515#---------------------------------------------------------------------------
10516
10517Left = _core_.Left
10518Top = _core_.Top
10519Right = _core_.Right
10520Bottom = _core_.Bottom
10521Width = _core_.Width
10522Height = _core_.Height
10523Centre = _core_.Centre
10524Center = _core_.Center
10525CentreX = _core_.CentreX
10526CentreY = _core_.CentreY
10527Unconstrained = _core_.Unconstrained
10528AsIs = _core_.AsIs
10529PercentOf = _core_.PercentOf
10530Above = _core_.Above
10531Below = _core_.Below
10532LeftOf = _core_.LeftOf
10533RightOf = _core_.RightOf
10534SameAs = _core_.SameAs
10535Absolute = _core_.Absolute
10536class IndividualLayoutConstraint(Object):
10537 """
79fccf9d
RD
10538 Objects of this class are stored in the `wx.LayoutConstraints` class as
10539 one of eight possible constraints that a window can be involved in.
10540 You will never need to create an instance of
10541 wx.IndividualLayoutConstraint, rather you should create a
10542 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10543 that it contains.
d55e5bfc
RD
10544 """
10545 def __init__(self): raise RuntimeError, "No constructor defined"
10546 def __repr__(self):
10547 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10548 def Set(*args, **kwargs):
79fccf9d
RD
10549 """
10550 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10551
10552 Sets the properties of the constraint. Normally called by one of the
10553 convenience functions such as Above, RightOf, SameAs.
10554 """
d55e5bfc
RD
10555 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
10556
10557 def LeftOf(*args, **kwargs):
10558 """
10559 LeftOf(self, Window sibling, int marg=0)
10560
79fccf9d
RD
10561 Constrains this edge to be to the left of the given window, with an
10562 optional margin. Implicitly, this is relative to the left edge of the
10563 other window.
d55e5bfc
RD
10564 """
10565 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
10566
10567 def RightOf(*args, **kwargs):
10568 """
10569 RightOf(self, Window sibling, int marg=0)
10570
79fccf9d
RD
10571 Constrains this edge to be to the right of the given window, with an
10572 optional margin. Implicitly, this is relative to the right edge of the
10573 other window.
d55e5bfc
RD
10574 """
10575 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
10576
10577 def Above(*args, **kwargs):
10578 """
10579 Above(self, Window sibling, int marg=0)
10580
79fccf9d
RD
10581 Constrains this edge to be above the given window, with an optional
10582 margin. Implicitly, this is relative to the top edge of the other
10583 window.
d55e5bfc
RD
10584 """
10585 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
10586
10587 def Below(*args, **kwargs):
10588 """
10589 Below(self, Window sibling, int marg=0)
10590
79fccf9d
RD
10591 Constrains this edge to be below the given window, with an optional
10592 margin. Implicitly, this is relative to the bottom edge of the other
10593 window.
d55e5bfc
RD
10594 """
10595 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
10596
10597 def SameAs(*args, **kwargs):
10598 """
10599 SameAs(self, Window otherW, int edge, int marg=0)
10600
79fccf9d
RD
10601 Constrains this edge or dimension to be to the same as the edge of the
10602 given window, with an optional margin.
d55e5bfc
RD
10603 """
10604 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
10605
10606 def PercentOf(*args, **kwargs):
10607 """
10608 PercentOf(self, Window otherW, int wh, int per)
10609
79fccf9d
RD
10610 Constrains this edge or dimension to be to a percentage of the given
10611 window, with an optional margin.
d55e5bfc
RD
10612 """
10613 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
10614
10615 def Absolute(*args, **kwargs):
10616 """
10617 Absolute(self, int val)
10618
79fccf9d 10619 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
10620 """
10621 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
10622
10623 def Unconstrained(*args, **kwargs):
10624 """
10625 Unconstrained(self)
10626
79fccf9d
RD
10627 Sets this edge or dimension to be unconstrained, that is, dependent on
10628 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
10629 """
10630 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
10631
10632 def AsIs(*args, **kwargs):
10633 """
10634 AsIs(self)
10635
79fccf9d
RD
10636 Sets this edge or constraint to be whatever the window's value is at
10637 the moment. If either of the width and height constraints are *as is*,
10638 the window will not be resized, but moved instead. This is important
10639 when considering panel items which are intended to have a default
10640 size, such as a button, which may take its size from the size of the
10641 button label.
d55e5bfc
RD
10642 """
10643 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
10644
10645 def GetOtherWindow(*args, **kwargs):
10646 """GetOtherWindow(self) -> Window"""
10647 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
10648
10649 def GetMyEdge(*args, **kwargs):
10650 """GetMyEdge(self) -> int"""
10651 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
10652
10653 def SetEdge(*args, **kwargs):
10654 """SetEdge(self, int which)"""
10655 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
10656
10657 def SetValue(*args, **kwargs):
10658 """SetValue(self, int v)"""
10659 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
10660
10661 def GetMargin(*args, **kwargs):
10662 """GetMargin(self) -> int"""
10663 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
10664
10665 def SetMargin(*args, **kwargs):
10666 """SetMargin(self, int m)"""
10667 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
10668
10669 def GetValue(*args, **kwargs):
10670 """GetValue(self) -> int"""
10671 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
10672
10673 def GetPercent(*args, **kwargs):
10674 """GetPercent(self) -> int"""
10675 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
10676
10677 def GetOtherEdge(*args, **kwargs):
10678 """GetOtherEdge(self) -> int"""
10679 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
10680
10681 def GetDone(*args, **kwargs):
10682 """GetDone(self) -> bool"""
10683 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
10684
10685 def SetDone(*args, **kwargs):
10686 """SetDone(self, bool d)"""
10687 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
10688
10689 def GetRelationship(*args, **kwargs):
10690 """GetRelationship(self) -> int"""
10691 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
10692
10693 def SetRelationship(*args, **kwargs):
10694 """SetRelationship(self, int r)"""
10695 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
10696
10697 def ResetIfWin(*args, **kwargs):
10698 """
10699 ResetIfWin(self, Window otherW) -> bool
10700
10701 Reset constraint if it mentions otherWin
10702 """
10703 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
10704
10705 def SatisfyConstraint(*args, **kwargs):
10706 """
10707 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
10708
10709 Try to satisfy constraint
10710 """
10711 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
10712
10713 def GetEdge(*args, **kwargs):
10714 """
10715 GetEdge(self, int which, Window thisWin, Window other) -> int
10716
10717 Get the value of this edge or dimension, or if this
10718 is not determinable, -1.
10719 """
10720 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
10721
10722
10723class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10724 def __init__(self, this):
10725 self.this = this
10726 if not hasattr(self,"thisown"): self.thisown = 0
10727 self.__class__ = IndividualLayoutConstraint
10728_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
10729
10730class LayoutConstraints(Object):
10731 """
79fccf9d
RD
10732 **Note:** constraints are now deprecated and you should use sizers
10733 instead.
d55e5bfc 10734
79fccf9d
RD
10735 Objects of this class can be associated with a window to define its
10736 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
10737
10738 The class consists of the following eight constraints of class
10739 wx.IndividualLayoutConstraint, some or all of which should be accessed
10740 directly to set the appropriate constraints.
10741
10742 * left: represents the left hand edge of the window
10743 * right: represents the right hand edge of the window
10744 * top: represents the top edge of the window
10745 * bottom: represents the bottom edge of the window
10746 * width: represents the width of the window
10747 * height: represents the height of the window
10748 * centreX: represents the horizontal centre point of the window
10749 * centreY: represents the vertical centre point of the window
10750
79fccf9d
RD
10751 Most constraints are initially set to have the relationship
10752 wxUnconstrained, which means that their values should be calculated by
10753 looking at known constraints. The exceptions are width and height,
10754 which are set to wxAsIs to ensure that if the user does not specify a
10755 constraint, the existing width and height will be used, to be
10756 compatible with panel items which often have take a default size. If
10757 the constraint is ``wx.AsIs``, the dimension will not be changed.
10758
10759 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
10760
10761 """
10762 def __repr__(self):
10763 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10764 left = property(_core_.LayoutConstraints_left_get)
10765 top = property(_core_.LayoutConstraints_top_get)
10766 right = property(_core_.LayoutConstraints_right_get)
10767 bottom = property(_core_.LayoutConstraints_bottom_get)
10768 width = property(_core_.LayoutConstraints_width_get)
10769 height = property(_core_.LayoutConstraints_height_get)
10770 centreX = property(_core_.LayoutConstraints_centreX_get)
10771 centreY = property(_core_.LayoutConstraints_centreY_get)
10772 def __init__(self, *args, **kwargs):
10773 """__init__(self) -> LayoutConstraints"""
10774 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
10775 self.this = newobj.this
10776 self.thisown = 1
10777 del newobj.thisown
10778 def SatisfyConstraints(*args, **kwargs):
10779 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
10780 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
10781
10782 def AreSatisfied(*args, **kwargs):
10783 """AreSatisfied(self) -> bool"""
10784 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
10785
10786
10787class LayoutConstraintsPtr(LayoutConstraints):
10788 def __init__(self, this):
10789 self.this = this
10790 if not hasattr(self,"thisown"): self.thisown = 0
10791 self.__class__ = LayoutConstraints
10792_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
10793
10794#----------------------------------------------------------------------------
10795
10796# Use Python's bool constants if available, make some if not
10797try:
10798 True
10799except NameError:
10800 __builtins__.True = 1==1
10801 __builtins__.False = 1==0
10802 def bool(value): return not not value
10803 __builtins__.bool = bool
10804
10805
10806
10807# workarounds for bad wxRTTI names
10808__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10809__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10810__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10811
10812
10813#----------------------------------------------------------------------------
10814# Load version numbers from __version__... Ensure that major and minor
0f63ec68 10815# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD
10816
10817from __version__ import *
10818__version__ = VERSION_STRING
10819
0f63ec68
RD
10820assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
10821assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD
10822if RELEASE_VERSION != _core_.RELEASE_VERSION:
10823 import warnings
0f63ec68 10824 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD
10825
10826#----------------------------------------------------------------------------
10827
10828class PyDeadObjectError(AttributeError):
10829 pass
10830
10831class _wxPyDeadObject(object):
10832 """
10833 Instances of wx objects that are OOR capable will have their __class__
10834 changed to this class when the C++ object is deleted. This should help
10835 prevent crashes due to referencing a bogus C++ pointer.
10836 """
10837 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10838 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10839
10840 def __repr__(self):
10841 if not hasattr(self, "_name"):
10842 self._name = "[unknown]"
10843 return self.reprStr % self._name
10844
10845 def __getattr__(self, *args):
10846 if not hasattr(self, "_name"):
10847 self._name = "[unknown]"
10848 raise PyDeadObjectError(self.attrStr % self._name)
10849
10850 def __nonzero__(self):
10851 return 0
10852
10853
10854
10855class PyUnbornObjectError(AttributeError):
10856 pass
10857
10858class _wxPyUnbornObject(object):
10859 """
10860 Some stock objects are created when the wx._core module is
10861 imported, but their C++ instance is not created until the wx.App
10862 object is created and initialized. These object instances will
10863 temporarily have their __class__ changed to this class so an
10864 exception will be raised if they are used before the C++ instance
10865 is ready.
10866 """
10867
10868 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10869 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10870
10871 def __repr__(self):
10872 #if not hasattr(self, "_name"):
10873 # self._name = "[unknown]"
10874 return self.reprStr #% self._name
10875
10876 def __getattr__(self, *args):
10877 #if not hasattr(self, "_name"):
10878 # self._name = "[unknown]"
10879 raise PyUnbornObjectError(self.attrStr) # % self._name )
10880
10881 def __nonzero__(self):
10882 return 0
10883
10884
10885#----------------------------------------------------------------------------
d55e5bfc
RD
10886
10887def CallAfter(callable, *args, **kw):
10888 """
10889 Call the specified function after the current and pending event
10890 handlers have been completed. This is also good for making GUI
0439c23b
RD
10891 method calls from non-GUI threads. Any extra positional or
10892 keyword args are passed on to the callable when it is called.
10893
10894 :see: `wx.FutureCall`
d55e5bfc
RD
10895 """
10896 app = wx.GetApp()
a001823c 10897 assert app is not None, 'No wx.App created yet'
d55e5bfc 10898
891bb194
RD
10899 if not hasattr(app, "_CallAfterId"):
10900 app._CallAfterId = wx.NewEventType()
10901 app.Connect(-1, -1, app._CallAfterId,
10902 lambda event: event.callable(*event.args, **event.kw) )
d55e5bfc 10903 evt = wx.PyEvent()
891bb194 10904 evt.SetEventType(app._CallAfterId)
d55e5bfc
RD
10905 evt.callable = callable
10906 evt.args = args
10907 evt.kw = kw
10908 wx.PostEvent(app, evt)
10909
d55e5bfc
RD
10910#----------------------------------------------------------------------------
10911
10912
10913class FutureCall:
10914 """
8ac8dba0 10915 A convenience class for `wx.Timer`, that calls the given callable
d55e5bfc
RD
10916 object once after the given amount of milliseconds, passing any
10917 positional or keyword args. The return value of the callable is
0439c23b 10918 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
10919
10920 If you don't need to get the return value or restart the timer
10921 then there is no need to hold a reference to this object. It will
10922 hold a reference to itself while the timer is running (the timer
10923 has a reference to self.Notify) but the cycle will be broken when
10924 the timer completes, automatically cleaning up the wx.FutureCall
10925 object.
0439c23b
RD
10926
10927 :see: `wx.CallAfter`
d55e5bfc
RD
10928 """
10929 def __init__(self, millis, callable, *args, **kwargs):
10930 self.millis = millis
10931 self.callable = callable
10932 self.SetArgs(*args, **kwargs)
10933 self.runCount = 0
10934 self.running = False
10935 self.hasRun = False
10936 self.result = None
10937 self.timer = None
10938 self.Start()
10939
10940 def __del__(self):
10941 self.Stop()
10942
10943
10944 def Start(self, millis=None, *args, **kwargs):
10945 """
10946 (Re)start the timer
10947 """
10948 self.hasRun = False
10949 if millis is not None:
10950 self.millis = millis
10951 if args or kwargs:
10952 self.SetArgs(*args, **kwargs)
10953 self.Stop()
10954 self.timer = wx.PyTimer(self.Notify)
10955 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
10956 self.running = True
10957 Restart = Start
10958
10959
10960 def Stop(self):
10961 """
10962 Stop and destroy the timer.
10963 """
10964 if self.timer is not None:
10965 self.timer.Stop()
10966 self.timer = None
10967
10968
10969 def GetInterval(self):
10970 if self.timer is not None:
10971 return self.timer.GetInterval()
10972 else:
10973 return 0
10974
10975
10976 def IsRunning(self):
10977 return self.timer is not None and self.timer.IsRunning()
10978
10979
10980 def SetArgs(self, *args, **kwargs):
10981 """
10982 (Re)set the args passed to the callable object. This is
10983 useful in conjunction with Restart if you want to schedule a
10984 new call to the same callable object but with different
10985 parameters.
10986 """
10987 self.args = args
10988 self.kwargs = kwargs
10989
10990
10991 def HasRun(self):
10992 return self.hasRun
10993
10994 def GetResult(self):
10995 return self.result
10996
10997 def Notify(self):
10998 """
10999 The timer has expired so call the callable.
11000 """
11001 if self.callable and getattr(self.callable, 'im_self', True):
11002 self.runCount += 1
11003 self.running = False
11004 self.result = self.callable(*self.args, **self.kwargs)
11005 self.hasRun = True
11006 if not self.running:
11007 # if it wasn't restarted, then cleanup
11008 wx.CallAfter(self.Stop)
11009
11010
11011
11012#----------------------------------------------------------------------------
11013# Control which items in this module should be documented by epydoc.
11014# We allow only classes and functions, which will help reduce the size
11015# of the docs by filtering out the zillions of constants, EVT objects,
11016# and etc that don't make much sense by themselves, but are instead
11017# documented (or will be) as part of the classes/functions/methods
11018# where they should be used.
11019
c24da6d6
RD
11020class __DocFilter:
11021 """
11022 A filter for epydoc that only allows non-Ptr classes and
11023 fucntions, in order to reduce the clutter in the API docs.
11024 """
11025 def __init__(self, globals):
11026 self._globals = globals
11027
11028 def __call__(self, name):
11029 import types
11030 obj = self._globals.get(name, None)
11031 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
11032 return False
11033 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
11034 return False
11035 return True
d55e5bfc
RD
11036
11037#----------------------------------------------------------------------------
11038#----------------------------------------------------------------------------
11039
11040# Import other modules in this package that should show up in the
11041# "core" wx namespace
11042from _gdi import *
11043from _windows import *
11044from _controls import *
11045from _misc import *
11046
11047
11048# Fixup the stock objects since they can't be used yet. (They will be
11049# restored in wx.PyApp.OnInit.)
11050_core_._wxPyFixStockObjects()
11051
11052#----------------------------------------------------------------------------
11053#----------------------------------------------------------------------------
11054
11055