]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/mac/_core.py
Print start and stop time
[wxWidgets.git] / wxPython / src / mac / _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
d6c14a4c
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
209ID_HIGHEST = _core_.ID_HIGHEST
210OPEN = _core_.OPEN
211SAVE = _core_.SAVE
212HIDE_READONLY = _core_.HIDE_READONLY
213OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
214FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
215MULTIPLE = _core_.MULTIPLE
216CHANGE_DIR = _core_.CHANGE_DIR
217ACCEL_ALT = _core_.ACCEL_ALT
218ACCEL_CTRL = _core_.ACCEL_CTRL
219ACCEL_SHIFT = _core_.ACCEL_SHIFT
220ACCEL_NORMAL = _core_.ACCEL_NORMAL
221PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
222PD_APP_MODAL = _core_.PD_APP_MODAL
223PD_CAN_ABORT = _core_.PD_CAN_ABORT
224PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
225PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
226PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
227DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
228DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
229MENU_TEAROFF = _core_.MENU_TEAROFF
230MB_DOCKABLE = _core_.MB_DOCKABLE
231NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
232FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
233LI_HORIZONTAL = _core_.LI_HORIZONTAL
234LI_VERTICAL = _core_.LI_VERTICAL
235WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
236WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
237WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
238WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
239WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
240WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
241MM_TEXT = _core_.MM_TEXT
242MM_LOMETRIC = _core_.MM_LOMETRIC
243MM_HIMETRIC = _core_.MM_HIMETRIC
244MM_LOENGLISH = _core_.MM_LOENGLISH
245MM_HIENGLISH = _core_.MM_HIENGLISH
246MM_TWIPS = _core_.MM_TWIPS
247MM_ISOTROPIC = _core_.MM_ISOTROPIC
248MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
249MM_POINTS = _core_.MM_POINTS
250MM_METRIC = _core_.MM_METRIC
251CENTRE = _core_.CENTRE
252CENTER = _core_.CENTER
253HORIZONTAL = _core_.HORIZONTAL
254VERTICAL = _core_.VERTICAL
255BOTH = _core_.BOTH
256LEFT = _core_.LEFT
257RIGHT = _core_.RIGHT
258UP = _core_.UP
259DOWN = _core_.DOWN
260TOP = _core_.TOP
261BOTTOM = _core_.BOTTOM
262NORTH = _core_.NORTH
263SOUTH = _core_.SOUTH
264WEST = _core_.WEST
265EAST = _core_.EAST
266ALL = _core_.ALL
267ALIGN_NOT = _core_.ALIGN_NOT
268ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
269ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
270ALIGN_LEFT = _core_.ALIGN_LEFT
271ALIGN_TOP = _core_.ALIGN_TOP
272ALIGN_RIGHT = _core_.ALIGN_RIGHT
273ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
274ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
275ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
276ALIGN_CENTER = _core_.ALIGN_CENTER
277ALIGN_CENTRE = _core_.ALIGN_CENTRE
278ALIGN_MASK = _core_.ALIGN_MASK
279STRETCH_NOT = _core_.STRETCH_NOT
280SHRINK = _core_.SHRINK
281GROW = _core_.GROW
282EXPAND = _core_.EXPAND
283SHAPED = _core_.SHAPED
284FIXED_MINSIZE = _core_.FIXED_MINSIZE
285TILE = _core_.TILE
286ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
287BORDER_DEFAULT = _core_.BORDER_DEFAULT
288BORDER_NONE = _core_.BORDER_NONE
289BORDER_STATIC = _core_.BORDER_STATIC
290BORDER_SIMPLE = _core_.BORDER_SIMPLE
291BORDER_RAISED = _core_.BORDER_RAISED
292BORDER_SUNKEN = _core_.BORDER_SUNKEN
293BORDER_DOUBLE = _core_.BORDER_DOUBLE
294BORDER_MASK = _core_.BORDER_MASK
295DEFAULT = _core_.DEFAULT
296DECORATIVE = _core_.DECORATIVE
297ROMAN = _core_.ROMAN
298SCRIPT = _core_.SCRIPT
299SWISS = _core_.SWISS
300MODERN = _core_.MODERN
301TELETYPE = _core_.TELETYPE
302VARIABLE = _core_.VARIABLE
303FIXED = _core_.FIXED
304NORMAL = _core_.NORMAL
305LIGHT = _core_.LIGHT
306BOLD = _core_.BOLD
307ITALIC = _core_.ITALIC
308SLANT = _core_.SLANT
309SOLID = _core_.SOLID
310DOT = _core_.DOT
311LONG_DASH = _core_.LONG_DASH
312SHORT_DASH = _core_.SHORT_DASH
313DOT_DASH = _core_.DOT_DASH
314USER_DASH = _core_.USER_DASH
315TRANSPARENT = _core_.TRANSPARENT
316STIPPLE = _core_.STIPPLE
317BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
318CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
319FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
320CROSS_HATCH = _core_.CROSS_HATCH
321HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
322VERTICAL_HATCH = _core_.VERTICAL_HATCH
323JOIN_BEVEL = _core_.JOIN_BEVEL
324JOIN_MITER = _core_.JOIN_MITER
325JOIN_ROUND = _core_.JOIN_ROUND
326CAP_ROUND = _core_.CAP_ROUND
327CAP_PROJECTING = _core_.CAP_PROJECTING
328CAP_BUTT = _core_.CAP_BUTT
329CLEAR = _core_.CLEAR
330XOR = _core_.XOR
331INVERT = _core_.INVERT
332OR_REVERSE = _core_.OR_REVERSE
333AND_REVERSE = _core_.AND_REVERSE
334COPY = _core_.COPY
335AND = _core_.AND
336AND_INVERT = _core_.AND_INVERT
337NO_OP = _core_.NO_OP
338NOR = _core_.NOR
339EQUIV = _core_.EQUIV
340SRC_INVERT = _core_.SRC_INVERT
341OR_INVERT = _core_.OR_INVERT
342NAND = _core_.NAND
343OR = _core_.OR
344SET = _core_.SET
345WXK_BACK = _core_.WXK_BACK
346WXK_TAB = _core_.WXK_TAB
347WXK_RETURN = _core_.WXK_RETURN
348WXK_ESCAPE = _core_.WXK_ESCAPE
349WXK_SPACE = _core_.WXK_SPACE
350WXK_DELETE = _core_.WXK_DELETE
351WXK_START = _core_.WXK_START
352WXK_LBUTTON = _core_.WXK_LBUTTON
353WXK_RBUTTON = _core_.WXK_RBUTTON
354WXK_CANCEL = _core_.WXK_CANCEL
355WXK_MBUTTON = _core_.WXK_MBUTTON
356WXK_CLEAR = _core_.WXK_CLEAR
357WXK_SHIFT = _core_.WXK_SHIFT
358WXK_ALT = _core_.WXK_ALT
359WXK_CONTROL = _core_.WXK_CONTROL
360WXK_MENU = _core_.WXK_MENU
361WXK_PAUSE = _core_.WXK_PAUSE
362WXK_CAPITAL = _core_.WXK_CAPITAL
363WXK_PRIOR = _core_.WXK_PRIOR
364WXK_NEXT = _core_.WXK_NEXT
365WXK_END = _core_.WXK_END
366WXK_HOME = _core_.WXK_HOME
367WXK_LEFT = _core_.WXK_LEFT
368WXK_UP = _core_.WXK_UP
369WXK_RIGHT = _core_.WXK_RIGHT
370WXK_DOWN = _core_.WXK_DOWN
371WXK_SELECT = _core_.WXK_SELECT
372WXK_PRINT = _core_.WXK_PRINT
373WXK_EXECUTE = _core_.WXK_EXECUTE
374WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
375WXK_INSERT = _core_.WXK_INSERT
376WXK_HELP = _core_.WXK_HELP
377WXK_NUMPAD0 = _core_.WXK_NUMPAD0
378WXK_NUMPAD1 = _core_.WXK_NUMPAD1
379WXK_NUMPAD2 = _core_.WXK_NUMPAD2
380WXK_NUMPAD3 = _core_.WXK_NUMPAD3
381WXK_NUMPAD4 = _core_.WXK_NUMPAD4
382WXK_NUMPAD5 = _core_.WXK_NUMPAD5
383WXK_NUMPAD6 = _core_.WXK_NUMPAD6
384WXK_NUMPAD7 = _core_.WXK_NUMPAD7
385WXK_NUMPAD8 = _core_.WXK_NUMPAD8
386WXK_NUMPAD9 = _core_.WXK_NUMPAD9
387WXK_MULTIPLY = _core_.WXK_MULTIPLY
388WXK_ADD = _core_.WXK_ADD
389WXK_SEPARATOR = _core_.WXK_SEPARATOR
390WXK_SUBTRACT = _core_.WXK_SUBTRACT
391WXK_DECIMAL = _core_.WXK_DECIMAL
392WXK_DIVIDE = _core_.WXK_DIVIDE
393WXK_F1 = _core_.WXK_F1
394WXK_F2 = _core_.WXK_F2
395WXK_F3 = _core_.WXK_F3
396WXK_F4 = _core_.WXK_F4
397WXK_F5 = _core_.WXK_F5
398WXK_F6 = _core_.WXK_F6
399WXK_F7 = _core_.WXK_F7
400WXK_F8 = _core_.WXK_F8
401WXK_F9 = _core_.WXK_F9
402WXK_F10 = _core_.WXK_F10
403WXK_F11 = _core_.WXK_F11
404WXK_F12 = _core_.WXK_F12
405WXK_F13 = _core_.WXK_F13
406WXK_F14 = _core_.WXK_F14
407WXK_F15 = _core_.WXK_F15
408WXK_F16 = _core_.WXK_F16
409WXK_F17 = _core_.WXK_F17
410WXK_F18 = _core_.WXK_F18
411WXK_F19 = _core_.WXK_F19
412WXK_F20 = _core_.WXK_F20
413WXK_F21 = _core_.WXK_F21
414WXK_F22 = _core_.WXK_F22
415WXK_F23 = _core_.WXK_F23
416WXK_F24 = _core_.WXK_F24
417WXK_NUMLOCK = _core_.WXK_NUMLOCK
418WXK_SCROLL = _core_.WXK_SCROLL
419WXK_PAGEUP = _core_.WXK_PAGEUP
420WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
421WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
422WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
423WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
424WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
425WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
426WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
427WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
428WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
429WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
430WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
431WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
432WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
433WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
434WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
435WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
436WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
437WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
438WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
439WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
440WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
441WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
442WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
443WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
444WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
445WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
446WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
447WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
448WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
449WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
450WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
451PAPER_NONE = _core_.PAPER_NONE
452PAPER_LETTER = _core_.PAPER_LETTER
453PAPER_LEGAL = _core_.PAPER_LEGAL
454PAPER_A4 = _core_.PAPER_A4
455PAPER_CSHEET = _core_.PAPER_CSHEET
456PAPER_DSHEET = _core_.PAPER_DSHEET
457PAPER_ESHEET = _core_.PAPER_ESHEET
458PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
459PAPER_TABLOID = _core_.PAPER_TABLOID
460PAPER_LEDGER = _core_.PAPER_LEDGER
461PAPER_STATEMENT = _core_.PAPER_STATEMENT
462PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
463PAPER_A3 = _core_.PAPER_A3
464PAPER_A4SMALL = _core_.PAPER_A4SMALL
465PAPER_A5 = _core_.PAPER_A5
466PAPER_B4 = _core_.PAPER_B4
467PAPER_B5 = _core_.PAPER_B5
468PAPER_FOLIO = _core_.PAPER_FOLIO
469PAPER_QUARTO = _core_.PAPER_QUARTO
470PAPER_10X14 = _core_.PAPER_10X14
471PAPER_11X17 = _core_.PAPER_11X17
472PAPER_NOTE = _core_.PAPER_NOTE
473PAPER_ENV_9 = _core_.PAPER_ENV_9
474PAPER_ENV_10 = _core_.PAPER_ENV_10
475PAPER_ENV_11 = _core_.PAPER_ENV_11
476PAPER_ENV_12 = _core_.PAPER_ENV_12
477PAPER_ENV_14 = _core_.PAPER_ENV_14
478PAPER_ENV_DL = _core_.PAPER_ENV_DL
479PAPER_ENV_C5 = _core_.PAPER_ENV_C5
480PAPER_ENV_C3 = _core_.PAPER_ENV_C3
481PAPER_ENV_C4 = _core_.PAPER_ENV_C4
482PAPER_ENV_C6 = _core_.PAPER_ENV_C6
483PAPER_ENV_C65 = _core_.PAPER_ENV_C65
484PAPER_ENV_B4 = _core_.PAPER_ENV_B4
485PAPER_ENV_B5 = _core_.PAPER_ENV_B5
486PAPER_ENV_B6 = _core_.PAPER_ENV_B6
487PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
488PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
489PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
490PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
491PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
492PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
493PAPER_ISO_B4 = _core_.PAPER_ISO_B4
494PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
495PAPER_9X11 = _core_.PAPER_9X11
496PAPER_10X11 = _core_.PAPER_10X11
497PAPER_15X11 = _core_.PAPER_15X11
498PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
499PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
500PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
501PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
502PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
503PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
504PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
505PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
506PAPER_A_PLUS = _core_.PAPER_A_PLUS
507PAPER_B_PLUS = _core_.PAPER_B_PLUS
508PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
509PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
510PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
511PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
512PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
513PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
514PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
515PAPER_A2 = _core_.PAPER_A2
516PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
517PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
518DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
519DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
520DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
521ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
522ITEM_NORMAL = _core_.ITEM_NORMAL
523ITEM_CHECK = _core_.ITEM_CHECK
524ITEM_RADIO = _core_.ITEM_RADIO
525ITEM_MAX = _core_.ITEM_MAX
526HT_NOWHERE = _core_.HT_NOWHERE
527HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
528HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
529HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
530HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
531HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
532HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
533HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
534HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
535HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
536HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
537HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
538HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
539HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
540HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
541HT_MAX = _core_.HT_MAX
542MOD_NONE = _core_.MOD_NONE
543MOD_ALT = _core_.MOD_ALT
544MOD_CONTROL = _core_.MOD_CONTROL
545MOD_SHIFT = _core_.MOD_SHIFT
546MOD_WIN = _core_.MOD_WIN
547UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
548UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
549UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
550#---------------------------------------------------------------------------
551
552class Object(object):
553 """
554 The base class for most wx objects, although in wxPython not
555 much functionality is needed nor exposed.
556 """
557 def __init__(self): raise RuntimeError, "No constructor defined"
558 def __repr__(self):
559 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
560 def GetClassName(*args, **kwargs):
561 """
562 GetClassName(self) -> String
563
564 Returns the class name of the C++ class using wxRTTI.
565 """
566 return _core_.Object_GetClassName(*args, **kwargs)
567
568 def Destroy(*args, **kwargs):
569 """
570 Destroy(self)
571
572 Deletes the C++ object this Python object is a proxy for.
573 """
574 return _core_.Object_Destroy(*args, **kwargs)
575
576
577class ObjectPtr(Object):
578 def __init__(self, this):
579 self.this = this
580 if not hasattr(self,"thisown"): self.thisown = 0
581 self.__class__ = Object
582_core_.Object_swigregister(ObjectPtr)
583_wxPySetDictionary = _core_._wxPySetDictionary
584
585_wxPyFixStockObjects = _core_._wxPyFixStockObjects
586
587cvar = _core_.cvar
588EmptyString = cvar.EmptyString
589
590#---------------------------------------------------------------------------
591
592BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
593BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
594BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
595BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
596BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
597BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
598BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
599BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
600BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
601BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
602BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
603BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
604BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
605BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
606BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
607BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
608BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
609BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
610BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
611BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
612CURSOR_NONE = _core_.CURSOR_NONE
613CURSOR_ARROW = _core_.CURSOR_ARROW
614CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
615CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
616CURSOR_CHAR = _core_.CURSOR_CHAR
617CURSOR_CROSS = _core_.CURSOR_CROSS
618CURSOR_HAND = _core_.CURSOR_HAND
619CURSOR_IBEAM = _core_.CURSOR_IBEAM
620CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
621CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
622CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
623CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
624CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
625CURSOR_PENCIL = _core_.CURSOR_PENCIL
626CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
627CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
628CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
629CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
630CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
631CURSOR_SIZENS = _core_.CURSOR_SIZENS
632CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
633CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
634CURSOR_SIZING = _core_.CURSOR_SIZING
635CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
636CURSOR_WAIT = _core_.CURSOR_WAIT
637CURSOR_WATCH = _core_.CURSOR_WATCH
638CURSOR_BLANK = _core_.CURSOR_BLANK
639CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
640CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
641CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
642CURSOR_MAX = _core_.CURSOR_MAX
643#---------------------------------------------------------------------------
644
645class Size(object):
646 """
15817c7e
RD
647 wx.Size is a useful data structure used to represent the size of
648 something. It simply contians integer width and height proprtites.
649 In most places in wxPython where a wx.Size is expected a
650 (width,height) tuple can be used instead.
d55e5bfc
RD
651 """
652 def __repr__(self):
653 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
654 width = property(_core_.Size_width_get, _core_.Size_width_set)
655 height = property(_core_.Size_height_get, _core_.Size_height_set)
656 x = width; y = height
657 def __init__(self, *args, **kwargs):
658 """
659 __init__(self, int w=0, int h=0) -> Size
660
661 Creates a size object.
662 """
663 newobj = _core_.new_Size(*args, **kwargs)
664 self.this = newobj.this
665 self.thisown = 1
666 del newobj.thisown
667 def __del__(self, destroy=_core_.delete_Size):
668 """__del__(self)"""
669 try:
670 if self.thisown: destroy(self)
671 except: pass
672
673 def __eq__(*args, **kwargs):
674 """
675 __eq__(self, Size sz) -> bool
676
677 Test for equality of wx.Size objects.
678 """
679 return _core_.Size___eq__(*args, **kwargs)
680
681 def __ne__(*args, **kwargs):
682 """
683 __ne__(self, Size sz) -> bool
684
685 Test for inequality.
686 """
687 return _core_.Size___ne__(*args, **kwargs)
688
689 def __add__(*args, **kwargs):
690 """
691 __add__(self, Size sz) -> Size
692
693 Add sz's proprties to this and return the result.
694 """
695 return _core_.Size___add__(*args, **kwargs)
696
697 def __sub__(*args, **kwargs):
698 """
699 __sub__(self, Size sz) -> Size
700
701 Subtract sz's properties from this and return the result.
702 """
703 return _core_.Size___sub__(*args, **kwargs)
704
705 def IncTo(*args, **kwargs):
706 """
707 IncTo(self, Size sz)
708
709 Increments this object so that both of its dimensions are not less
710 than the corresponding dimensions of the size.
711 """
712 return _core_.Size_IncTo(*args, **kwargs)
713
714 def DecTo(*args, **kwargs):
715 """
716 DecTo(self, Size sz)
717
718 Decrements this object so that both of its dimensions are not greater
719 than the corresponding dimensions of the size.
720 """
721 return _core_.Size_DecTo(*args, **kwargs)
722
723 def Set(*args, **kwargs):
724 """
725 Set(self, int w, int h)
726
727 Set both width and height.
728 """
729 return _core_.Size_Set(*args, **kwargs)
730
731 def SetWidth(*args, **kwargs):
732 """SetWidth(self, int w)"""
733 return _core_.Size_SetWidth(*args, **kwargs)
734
735 def SetHeight(*args, **kwargs):
736 """SetHeight(self, int h)"""
737 return _core_.Size_SetHeight(*args, **kwargs)
738
739 def GetWidth(*args, **kwargs):
740 """GetWidth(self) -> int"""
741 return _core_.Size_GetWidth(*args, **kwargs)
742
743 def GetHeight(*args, **kwargs):
744 """GetHeight(self) -> int"""
745 return _core_.Size_GetHeight(*args, **kwargs)
746
747 def IsFullySpecified(*args, **kwargs):
748 """
749 IsFullySpecified(self) -> bool
750
751 Returns True if both components of the size are non-default values.
752 """
753 return _core_.Size_IsFullySpecified(*args, **kwargs)
754
755 def SetDefaults(*args, **kwargs):
756 """
757 SetDefaults(self, Size size)
758
15817c7e
RD
759 Combine this size with the other one replacing the default components
760 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD
761 """
762 return _core_.Size_SetDefaults(*args, **kwargs)
763
764 def Get(*args, **kwargs):
765 """
766 Get() -> (width,height)
767
768 Returns the width and height properties as a tuple.
769 """
770 return _core_.Size_Get(*args, **kwargs)
771
15817c7e 772 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
773 def __str__(self): return str(self.Get())
774 def __repr__(self): return 'wx.Size'+str(self.Get())
775 def __len__(self): return len(self.Get())
776 def __getitem__(self, index): return self.Get()[index]
777 def __setitem__(self, index, val):
778 if index == 0: self.width = val
779 elif index == 1: self.height = val
780 else: raise IndexError
781 def __nonzero__(self): return self.Get() != (0,0)
782 __safe_for_unpickling__ = True
783 def __reduce__(self): return (wx.Size, self.Get())
784
785
786class SizePtr(Size):
787 def __init__(self, this):
788 self.this = this
789 if not hasattr(self,"thisown"): self.thisown = 0
790 self.__class__ = Size
791_core_.Size_swigregister(SizePtr)
792
793#---------------------------------------------------------------------------
794
795class RealPoint(object):
796 """
15817c7e
RD
797 A data structure for representing a point or position with floating
798 point x and y properties. In wxPython most places that expect a
799 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc
RD
800 """
801 def __repr__(self):
802 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
803 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
804 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
805 def __init__(self, *args, **kwargs):
806 """
807 __init__(self, double x=0.0, double y=0.0) -> RealPoint
808
809 Create a wx.RealPoint object
810 """
811 newobj = _core_.new_RealPoint(*args, **kwargs)
812 self.this = newobj.this
813 self.thisown = 1
814 del newobj.thisown
815 def __del__(self, destroy=_core_.delete_RealPoint):
816 """__del__(self)"""
817 try:
818 if self.thisown: destroy(self)
819 except: pass
820
821 def __eq__(*args, **kwargs):
822 """
823 __eq__(self, RealPoint pt) -> bool
824
825 Test for equality of wx.RealPoint objects.
826 """
827 return _core_.RealPoint___eq__(*args, **kwargs)
828
829 def __ne__(*args, **kwargs):
830 """
831 __ne__(self, RealPoint pt) -> bool
832
833 Test for inequality of wx.RealPoint objects.
834 """
835 return _core_.RealPoint___ne__(*args, **kwargs)
836
837 def __add__(*args, **kwargs):
838 """
839 __add__(self, RealPoint pt) -> RealPoint
840
841 Add pt's proprties to this and return the result.
842 """
843 return _core_.RealPoint___add__(*args, **kwargs)
844
845 def __sub__(*args, **kwargs):
846 """
847 __sub__(self, RealPoint pt) -> RealPoint
848
849 Subtract pt's proprties from this and return the result
850 """
851 return _core_.RealPoint___sub__(*args, **kwargs)
852
853 def Set(*args, **kwargs):
854 """
855 Set(self, double x, double y)
856
857 Set both the x and y properties
858 """
859 return _core_.RealPoint_Set(*args, **kwargs)
860
861 def Get(*args, **kwargs):
862 """
863 Get() -> (x,y)
864
865 Return the x and y properties as a tuple.
866 """
867 return _core_.RealPoint_Get(*args, **kwargs)
868
15817c7e 869 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
870 def __str__(self): return str(self.Get())
871 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
872 def __len__(self): return len(self.Get())
873 def __getitem__(self, index): return self.Get()[index]
874 def __setitem__(self, index, val):
875 if index == 0: self.x = val
876 elif index == 1: self.y = val
877 else: raise IndexError
878 def __nonzero__(self): return self.Get() != (0.0, 0.0)
879 __safe_for_unpickling__ = True
880 def __reduce__(self): return (wx.RealPoint, self.Get())
881
882
883class RealPointPtr(RealPoint):
884 def __init__(self, this):
885 self.this = this
886 if not hasattr(self,"thisown"): self.thisown = 0
887 self.__class__ = RealPoint
888_core_.RealPoint_swigregister(RealPointPtr)
889
890#---------------------------------------------------------------------------
891
892class Point(object):
893 """
15817c7e
RD
894 A data structure for representing a point or position with integer x
895 and y properties. Most places in wxPython that expect a wx.Point can
896 also accept a (x,y) tuple.
d55e5bfc
RD
897 """
898 def __repr__(self):
899 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
900 x = property(_core_.Point_x_get, _core_.Point_x_set)
901 y = property(_core_.Point_y_get, _core_.Point_y_set)
902 def __init__(self, *args, **kwargs):
903 """
904 __init__(self, int x=0, int y=0) -> Point
905
906 Create a wx.Point object
907 """
908 newobj = _core_.new_Point(*args, **kwargs)
909 self.this = newobj.this
910 self.thisown = 1
911 del newobj.thisown
912 def __del__(self, destroy=_core_.delete_Point):
913 """__del__(self)"""
914 try:
915 if self.thisown: destroy(self)
916 except: pass
917
918 def __eq__(*args, **kwargs):
919 """
920 __eq__(self, Point pt) -> bool
921
922 Test for equality of wx.Point objects.
923 """
924 return _core_.Point___eq__(*args, **kwargs)
925
926 def __ne__(*args, **kwargs):
927 """
928 __ne__(self, Point pt) -> bool
929
930 Test for inequality of wx.Point objects.
931 """
932 return _core_.Point___ne__(*args, **kwargs)
933
934 def __add__(*args, **kwargs):
935 """
936 __add__(self, Point pt) -> Point
937
938 Add pt's proprties to this and return the result.
939 """
940 return _core_.Point___add__(*args, **kwargs)
941
942 def __sub__(*args, **kwargs):
943 """
944 __sub__(self, Point pt) -> Point
945
946 Subtract pt's proprties from this and return the result
947 """
948 return _core_.Point___sub__(*args, **kwargs)
949
950 def __iadd__(*args, **kwargs):
951 """
952 __iadd__(self, Point pt) -> Point
953
954 Add pt to this object.
955 """
956 return _core_.Point___iadd__(*args, **kwargs)
957
958 def __isub__(*args, **kwargs):
959 """
960 __isub__(self, Point pt) -> Point
961
962 Subtract pt from this object.
963 """
964 return _core_.Point___isub__(*args, **kwargs)
965
966 def Set(*args, **kwargs):
967 """
968 Set(self, long x, long y)
969
970 Set both the x and y properties
971 """
972 return _core_.Point_Set(*args, **kwargs)
973
974 def Get(*args, **kwargs):
975 """
976 Get() -> (x,y)
977
978 Return the x and y properties as a tuple.
979 """
980 return _core_.Point_Get(*args, **kwargs)
981
15817c7e 982 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
983 def __str__(self): return str(self.Get())
984 def __repr__(self): return 'wx.Point'+str(self.Get())
985 def __len__(self): return len(self.Get())
986 def __getitem__(self, index): return self.Get()[index]
987 def __setitem__(self, index, val):
988 if index == 0: self.x = val
989 elif index == 1: self.y = val
990 else: raise IndexError
991 def __nonzero__(self): return self.Get() != (0,0)
992 __safe_for_unpickling__ = True
993 def __reduce__(self): return (wx.Point, self.Get())
994
995
996class PointPtr(Point):
997 def __init__(self, this):
998 self.this = this
999 if not hasattr(self,"thisown"): self.thisown = 0
1000 self.__class__ = Point
1001_core_.Point_swigregister(PointPtr)
1002
1003#---------------------------------------------------------------------------
1004
1005class Rect(object):
1006 """
15817c7e
RD
1007 A class for representing and manipulating rectangles. It has x, y,
1008 width and height properties. In wxPython most palces that expect a
1009 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc
RD
1010 """
1011 def __repr__(self):
1012 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1013 def __init__(self, *args, **kwargs):
1014 """
1015 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1016
1017 Create a new Rect object.
1018 """
1019 newobj = _core_.new_Rect(*args, **kwargs)
1020 self.this = newobj.this
1021 self.thisown = 1
1022 del newobj.thisown
1023 def __del__(self, destroy=_core_.delete_Rect):
1024 """__del__(self)"""
1025 try:
1026 if self.thisown: destroy(self)
1027 except: pass
1028
1029 def GetX(*args, **kwargs):
1030 """GetX(self) -> int"""
1031 return _core_.Rect_GetX(*args, **kwargs)
1032
1033 def SetX(*args, **kwargs):
1034 """SetX(self, int x)"""
1035 return _core_.Rect_SetX(*args, **kwargs)
1036
1037 def GetY(*args, **kwargs):
1038 """GetY(self) -> int"""
1039 return _core_.Rect_GetY(*args, **kwargs)
1040
1041 def SetY(*args, **kwargs):
1042 """SetY(self, int y)"""
1043 return _core_.Rect_SetY(*args, **kwargs)
1044
1045 def GetWidth(*args, **kwargs):
1046 """GetWidth(self) -> int"""
1047 return _core_.Rect_GetWidth(*args, **kwargs)
1048
1049 def SetWidth(*args, **kwargs):
1050 """SetWidth(self, int w)"""
1051 return _core_.Rect_SetWidth(*args, **kwargs)
1052
1053 def GetHeight(*args, **kwargs):
1054 """GetHeight(self) -> int"""
1055 return _core_.Rect_GetHeight(*args, **kwargs)
1056
1057 def SetHeight(*args, **kwargs):
1058 """SetHeight(self, int h)"""
1059 return _core_.Rect_SetHeight(*args, **kwargs)
1060
1061 def GetPosition(*args, **kwargs):
1062 """GetPosition(self) -> Point"""
1063 return _core_.Rect_GetPosition(*args, **kwargs)
1064
1065 def SetPosition(*args, **kwargs):
1066 """SetPosition(self, Point p)"""
1067 return _core_.Rect_SetPosition(*args, **kwargs)
1068
1069 def GetSize(*args, **kwargs):
1070 """GetSize(self) -> Size"""
1071 return _core_.Rect_GetSize(*args, **kwargs)
1072
1073 def SetSize(*args, **kwargs):
1074 """SetSize(self, Size s)"""
1075 return _core_.Rect_SetSize(*args, **kwargs)
1076
1077 def GetTopLeft(*args, **kwargs):
1078 """GetTopLeft(self) -> Point"""
1079 return _core_.Rect_GetTopLeft(*args, **kwargs)
1080
1081 def SetTopLeft(*args, **kwargs):
1082 """SetTopLeft(self, Point p)"""
1083 return _core_.Rect_SetTopLeft(*args, **kwargs)
1084
1085 def GetBottomRight(*args, **kwargs):
1086 """GetBottomRight(self) -> Point"""
1087 return _core_.Rect_GetBottomRight(*args, **kwargs)
1088
1089 def SetBottomRight(*args, **kwargs):
1090 """SetBottomRight(self, Point p)"""
1091 return _core_.Rect_SetBottomRight(*args, **kwargs)
1092
1093 def GetLeft(*args, **kwargs):
1094 """GetLeft(self) -> int"""
1095 return _core_.Rect_GetLeft(*args, **kwargs)
1096
1097 def GetTop(*args, **kwargs):
1098 """GetTop(self) -> int"""
1099 return _core_.Rect_GetTop(*args, **kwargs)
1100
1101 def GetBottom(*args, **kwargs):
1102 """GetBottom(self) -> int"""
1103 return _core_.Rect_GetBottom(*args, **kwargs)
1104
1105 def GetRight(*args, **kwargs):
1106 """GetRight(self) -> int"""
1107 return _core_.Rect_GetRight(*args, **kwargs)
1108
1109 def SetLeft(*args, **kwargs):
1110 """SetLeft(self, int left)"""
1111 return _core_.Rect_SetLeft(*args, **kwargs)
1112
1113 def SetRight(*args, **kwargs):
1114 """SetRight(self, int right)"""
1115 return _core_.Rect_SetRight(*args, **kwargs)
1116
1117 def SetTop(*args, **kwargs):
1118 """SetTop(self, int top)"""
1119 return _core_.Rect_SetTop(*args, **kwargs)
1120
1121 def SetBottom(*args, **kwargs):
1122 """SetBottom(self, int bottom)"""
1123 return _core_.Rect_SetBottom(*args, **kwargs)
1124
1125 position = property(GetPosition, SetPosition)
1126 size = property(GetSize, SetSize)
1127 left = property(GetLeft, SetLeft)
1128 right = property(GetRight, SetRight)
1129 top = property(GetTop, SetTop)
1130 bottom = property(GetBottom, SetBottom)
1131
1132 def Inflate(*args, **kwargs):
1133 """
1134 Inflate(self, int dx, int dy) -> Rect
1135
15817c7e
RD
1136 Increase the rectangle size by dx in x direction and dy in y
1137 direction. Both or one of) parameters may be negative to decrease the
1138 rectangle size.
d55e5bfc
RD
1139 """
1140 return _core_.Rect_Inflate(*args, **kwargs)
1141
1142 def Deflate(*args, **kwargs):
1143 """
1144 Deflate(self, int dx, int dy) -> Rect
1145
15817c7e
RD
1146 Decrease the rectangle size by dx in x direction and dy in y
1147 direction. Both or one of) parameters may be negative to increase the
1148 rectngle size. This method is the opposite of Inflate.
d55e5bfc
RD
1149 """
1150 return _core_.Rect_Deflate(*args, **kwargs)
1151
1152 def OffsetXY(*args, **kwargs):
1153 """
1154 OffsetXY(self, int dx, int dy)
1155
15817c7e
RD
1156 Moves the rectangle by the specified offset. If dx is positive, the
1157 rectangle is moved to the right, if dy is positive, it is moved to the
1158 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1159 """
1160 return _core_.Rect_OffsetXY(*args, **kwargs)
1161
1162 def Offset(*args, **kwargs):
1163 """
1164 Offset(self, Point pt)
1165
1166 Same as OffsetXY but uses dx,dy from Point
1167 """
1168 return _core_.Rect_Offset(*args, **kwargs)
1169
1170 def Intersect(*args, **kwargs):
1171 """
1172 Intersect(self, Rect rect) -> Rect
1173
1174 Return the intersectsion of this rectangle and rect.
1175 """
1176 return _core_.Rect_Intersect(*args, **kwargs)
1177
1178 def __add__(*args, **kwargs):
1179 """
1180 __add__(self, Rect rect) -> Rect
1181
1182 Add the properties of rect to this rectangle and return the result.
1183 """
1184 return _core_.Rect___add__(*args, **kwargs)
1185
1186 def __iadd__(*args, **kwargs):
1187 """
1188 __iadd__(self, Rect rect) -> Rect
1189
1190 Add the properties of rect to this rectangle, updating this rectangle.
1191 """
1192 return _core_.Rect___iadd__(*args, **kwargs)
1193
1194 def __eq__(*args, **kwargs):
1195 """
1196 __eq__(self, Rect rect) -> bool
1197
1198 Test for equality.
1199 """
1200 return _core_.Rect___eq__(*args, **kwargs)
1201
1202 def __ne__(*args, **kwargs):
1203 """
1204 __ne__(self, Rect rect) -> bool
1205
1206 Test for inequality.
1207 """
1208 return _core_.Rect___ne__(*args, **kwargs)
1209
1210 def InsideXY(*args, **kwargs):
1211 """
1212 InsideXY(self, int x, int y) -> bool
1213
1214 Return True if the point is (not strcitly) inside the rect.
1215 """
1216 return _core_.Rect_InsideXY(*args, **kwargs)
1217
1218 def Inside(*args, **kwargs):
1219 """
1220 Inside(self, Point pt) -> bool
1221
1222 Return True if the point is (not strcitly) inside the rect.
1223 """
1224 return _core_.Rect_Inside(*args, **kwargs)
1225
1226 def Intersects(*args, **kwargs):
1227 """
1228 Intersects(self, Rect rect) -> bool
1229
1230 Returns True if the rectangles have a non empty intersection.
1231 """
1232 return _core_.Rect_Intersects(*args, **kwargs)
1233
1234 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1235 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1236 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1237 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1238 def Set(*args, **kwargs):
1239 """
1240 Set(self, int x=0, int y=0, int width=0, int height=0)
1241
1242 Set all rectangle properties.
1243 """
1244 return _core_.Rect_Set(*args, **kwargs)
1245
1246 def Get(*args, **kwargs):
1247 """
1248 Get() -> (x,y,width,height)
1249
1250 Return the rectangle properties as a tuple.
1251 """
1252 return _core_.Rect_Get(*args, **kwargs)
1253
15817c7e 1254 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1255 def __str__(self): return str(self.Get())
1256 def __repr__(self): return 'wx.Rect'+str(self.Get())
1257 def __len__(self): return len(self.Get())
1258 def __getitem__(self, index): return self.Get()[index]
1259 def __setitem__(self, index, val):
1260 if index == 0: self.x = val
1261 elif index == 1: self.y = val
1262 elif index == 2: self.width = val
1263 elif index == 3: self.height = val
1264 else: raise IndexError
1265 def __nonzero__(self): return self.Get() != (0,0,0,0)
1266 __safe_for_unpickling__ = True
1267 def __reduce__(self): return (wx.Rect, self.Get())
1268
1269
1270class RectPtr(Rect):
1271 def __init__(self, this):
1272 self.this = this
1273 if not hasattr(self,"thisown"): self.thisown = 0
1274 self.__class__ = Rect
1275_core_.Rect_swigregister(RectPtr)
1276
1277def RectPP(*args, **kwargs):
1278 """
1279 RectPP(Point topLeft, Point bottomRight) -> Rect
1280
1281 Create a new Rect object from Points representing two corners.
1282 """
1283 val = _core_.new_RectPP(*args, **kwargs)
1284 val.thisown = 1
1285 return val
1286
1287def RectPS(*args, **kwargs):
1288 """
1289 RectPS(Point pos, Size size) -> Rect
1290
1291 Create a new Rect from a position and size.
1292 """
1293 val = _core_.new_RectPS(*args, **kwargs)
1294 val.thisown = 1
1295 return val
1296
1297
1298def IntersectRect(*args, **kwargs):
1299 """
1300 IntersectRect(Rect r1, Rect r2) -> Rect
1301
1302 Calculate and return the intersection of r1 and r2.
1303 """
1304 return _core_.IntersectRect(*args, **kwargs)
1305#---------------------------------------------------------------------------
1306
1307class Point2D(object):
15817c7e
RD
1308 """
1309 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1310 with floating point values.
1311 """
d55e5bfc
RD
1312 def __repr__(self):
1313 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1314 def __init__(self, *args, **kwargs):
1315 """
1316 __init__(self, double x=0.0, double y=0.0) -> Point2D
1317
1318 Create a w.Point2D object.
1319 """
1320 newobj = _core_.new_Point2D(*args, **kwargs)
1321 self.this = newobj.this
1322 self.thisown = 1
1323 del newobj.thisown
1324 def GetFloor(*args, **kwargs):
fd2dc343
RD
1325 """
1326 GetFloor() -> (x,y)
1327
1328 Convert to integer
1329 """
d55e5bfc
RD
1330 return _core_.Point2D_GetFloor(*args, **kwargs)
1331
1332 def GetRounded(*args, **kwargs):
fd2dc343
RD
1333 """
1334 GetRounded() -> (x,y)
1335
1336 Convert to integer
1337 """
d55e5bfc
RD
1338 return _core_.Point2D_GetRounded(*args, **kwargs)
1339
1340 def GetVectorLength(*args, **kwargs):
1341 """GetVectorLength(self) -> double"""
1342 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1343
1344 def GetVectorAngle(*args, **kwargs):
1345 """GetVectorAngle(self) -> double"""
1346 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1347
1348 def SetVectorLength(*args, **kwargs):
1349 """SetVectorLength(self, double length)"""
1350 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1351
1352 def SetVectorAngle(*args, **kwargs):
1353 """SetVectorAngle(self, double degrees)"""
1354 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1355
1356 def SetPolarCoordinates(self, angle, length):
1357 self.SetVectorLength(length)
1358 self.SetVectorAngle(angle)
1359 def Normalize(self):
1360 self.SetVectorLength(1.0)
1361
1362 def GetDistance(*args, **kwargs):
1363 """GetDistance(self, Point2D pt) -> double"""
1364 return _core_.Point2D_GetDistance(*args, **kwargs)
1365
1366 def GetDistanceSquare(*args, **kwargs):
1367 """GetDistanceSquare(self, Point2D pt) -> double"""
1368 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1369
1370 def GetDotProduct(*args, **kwargs):
1371 """GetDotProduct(self, Point2D vec) -> double"""
1372 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1373
1374 def GetCrossProduct(*args, **kwargs):
1375 """GetCrossProduct(self, Point2D vec) -> double"""
1376 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1377
1378 def __neg__(*args, **kwargs):
1379 """
1380 __neg__(self) -> Point2D
1381
1382 the reflection of this point
1383 """
1384 return _core_.Point2D___neg__(*args, **kwargs)
1385
1386 def __iadd__(*args, **kwargs):
1387 """__iadd__(self, Point2D pt) -> Point2D"""
1388 return _core_.Point2D___iadd__(*args, **kwargs)
1389
1390 def __isub__(*args, **kwargs):
1391 """__isub__(self, Point2D pt) -> Point2D"""
1392 return _core_.Point2D___isub__(*args, **kwargs)
1393
1394 def __imul__(*args, **kwargs):
1395 """__imul__(self, Point2D pt) -> Point2D"""
1396 return _core_.Point2D___imul__(*args, **kwargs)
1397
1398 def __idiv__(*args, **kwargs):
1399 """__idiv__(self, Point2D pt) -> Point2D"""
1400 return _core_.Point2D___idiv__(*args, **kwargs)
1401
1402 def __eq__(*args, **kwargs):
1403 """
1404 __eq__(self, Point2D pt) -> bool
1405
1406 Test for equality
1407 """
1408 return _core_.Point2D___eq__(*args, **kwargs)
1409
1410 def __ne__(*args, **kwargs):
1411 """
1412 __ne__(self, Point2D pt) -> bool
1413
1414 Test for inequality
1415 """
1416 return _core_.Point2D___ne__(*args, **kwargs)
1417
1418 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1419 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1420 def Set(*args, **kwargs):
1421 """Set(self, double x=0, double y=0)"""
1422 return _core_.Point2D_Set(*args, **kwargs)
1423
1424 def Get(*args, **kwargs):
1425 """
1426 Get() -> (x,y)
1427
1428 Return x and y properties as a tuple.
1429 """
1430 return _core_.Point2D_Get(*args, **kwargs)
1431
15817c7e 1432 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1433 def __str__(self): return str(self.Get())
1434 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1435 def __len__(self): return len(self.Get())
1436 def __getitem__(self, index): return self.Get()[index]
1437 def __setitem__(self, index, val):
1438 if index == 0: self.x = val
1439 elif index == 1: self.y = val
1440 else: raise IndexError
1441 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1442 __safe_for_unpickling__ = True
1443 def __reduce__(self): return (wx.Point2D, self.Get())
1444
1445
1446class Point2DPtr(Point2D):
1447 def __init__(self, this):
1448 self.this = this
1449 if not hasattr(self,"thisown"): self.thisown = 0
1450 self.__class__ = Point2D
1451_core_.Point2D_swigregister(Point2DPtr)
1452
1453def Point2DCopy(*args, **kwargs):
1454 """
1455 Point2DCopy(Point2D pt) -> Point2D
1456
1457 Create a w.Point2D object.
1458 """
1459 val = _core_.new_Point2DCopy(*args, **kwargs)
1460 val.thisown = 1
1461 return val
1462
1463def Point2DFromPoint(*args, **kwargs):
1464 """
1465 Point2DFromPoint(Point pt) -> Point2D
1466
1467 Create a w.Point2D object.
1468 """
1469 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1470 val.thisown = 1
1471 return val
1472
1473#---------------------------------------------------------------------------
1474
1475FromStart = _core_.FromStart
1476FromCurrent = _core_.FromCurrent
1477FromEnd = _core_.FromEnd
1478class InputStream(object):
1479 def __repr__(self):
1480 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1481 def __init__(self, *args, **kwargs):
1482 """__init__(self, PyObject p) -> InputStream"""
1483 newobj = _core_.new_InputStream(*args, **kwargs)
1484 self.this = newobj.this
1485 self.thisown = 1
1486 del newobj.thisown
1487 def close(*args, **kwargs):
1488 """close(self)"""
1489 return _core_.InputStream_close(*args, **kwargs)
1490
1491 def flush(*args, **kwargs):
1492 """flush(self)"""
1493 return _core_.InputStream_flush(*args, **kwargs)
1494
1495 def eof(*args, **kwargs):
1496 """eof(self) -> bool"""
1497 return _core_.InputStream_eof(*args, **kwargs)
1498
1499 def read(*args, **kwargs):
1500 """read(self, int size=-1) -> PyObject"""
1501 return _core_.InputStream_read(*args, **kwargs)
1502
1503 def readline(*args, **kwargs):
1504 """readline(self, int size=-1) -> PyObject"""
1505 return _core_.InputStream_readline(*args, **kwargs)
1506
1507 def readlines(*args, **kwargs):
1508 """readlines(self, int sizehint=-1) -> PyObject"""
1509 return _core_.InputStream_readlines(*args, **kwargs)
1510
1511 def seek(*args, **kwargs):
1512 """seek(self, int offset, int whence=0)"""
1513 return _core_.InputStream_seek(*args, **kwargs)
1514
1515 def tell(*args, **kwargs):
1516 """tell(self) -> int"""
1517 return _core_.InputStream_tell(*args, **kwargs)
1518
1519 def Peek(*args, **kwargs):
1520 """Peek(self) -> char"""
1521 return _core_.InputStream_Peek(*args, **kwargs)
1522
1523 def GetC(*args, **kwargs):
1524 """GetC(self) -> char"""
1525 return _core_.InputStream_GetC(*args, **kwargs)
1526
1527 def LastRead(*args, **kwargs):
1528 """LastRead(self) -> size_t"""
1529 return _core_.InputStream_LastRead(*args, **kwargs)
1530
1531 def CanRead(*args, **kwargs):
1532 """CanRead(self) -> bool"""
1533 return _core_.InputStream_CanRead(*args, **kwargs)
1534
1535 def Eof(*args, **kwargs):
1536 """Eof(self) -> bool"""
1537 return _core_.InputStream_Eof(*args, **kwargs)
1538
1539 def Ungetch(*args, **kwargs):
1540 """Ungetch(self, char c) -> bool"""
1541 return _core_.InputStream_Ungetch(*args, **kwargs)
1542
1543 def SeekI(*args, **kwargs):
1544 """SeekI(self, long pos, int mode=FromStart) -> long"""
1545 return _core_.InputStream_SeekI(*args, **kwargs)
1546
1547 def TellI(*args, **kwargs):
1548 """TellI(self) -> long"""
1549 return _core_.InputStream_TellI(*args, **kwargs)
1550
1551
1552class InputStreamPtr(InputStream):
1553 def __init__(self, this):
1554 self.this = this
1555 if not hasattr(self,"thisown"): self.thisown = 0
1556 self.__class__ = InputStream
1557_core_.InputStream_swigregister(InputStreamPtr)
1558DefaultPosition = cvar.DefaultPosition
1559DefaultSize = cvar.DefaultSize
1560
1561class OutputStream(object):
1562 def __init__(self): raise RuntimeError, "No constructor defined"
1563 def __repr__(self):
1564 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1565 def write(*args, **kwargs):
1566 """write(self, PyObject obj)"""
1567 return _core_.OutputStream_write(*args, **kwargs)
1568
1569
1570class OutputStreamPtr(OutputStream):
1571 def __init__(self, this):
1572 self.this = this
1573 if not hasattr(self,"thisown"): self.thisown = 0
1574 self.__class__ = OutputStream
1575_core_.OutputStream_swigregister(OutputStreamPtr)
1576
1577#---------------------------------------------------------------------------
1578
1579class FSFile(Object):
1580 def __repr__(self):
1581 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1582 def __init__(self, *args, **kwargs):
1583 """
1584 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1585 DateTime modif) -> FSFile
1586 """
1587 newobj = _core_.new_FSFile(*args, **kwargs)
1588 self.this = newobj.this
1589 self.thisown = 1
1590 del newobj.thisown
1591 def __del__(self, destroy=_core_.delete_FSFile):
1592 """__del__(self)"""
1593 try:
1594 if self.thisown: destroy(self)
1595 except: pass
1596
1597 def GetStream(*args, **kwargs):
1598 """GetStream(self) -> InputStream"""
1599 return _core_.FSFile_GetStream(*args, **kwargs)
1600
1601 def GetMimeType(*args, **kwargs):
1602 """GetMimeType(self) -> String"""
1603 return _core_.FSFile_GetMimeType(*args, **kwargs)
1604
1605 def GetLocation(*args, **kwargs):
1606 """GetLocation(self) -> String"""
1607 return _core_.FSFile_GetLocation(*args, **kwargs)
1608
1609 def GetAnchor(*args, **kwargs):
1610 """GetAnchor(self) -> String"""
1611 return _core_.FSFile_GetAnchor(*args, **kwargs)
1612
1613 def GetModificationTime(*args, **kwargs):
1614 """GetModificationTime(self) -> DateTime"""
1615 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1616
1617
1618class FSFilePtr(FSFile):
1619 def __init__(self, this):
1620 self.this = this
1621 if not hasattr(self,"thisown"): self.thisown = 0
1622 self.__class__ = FSFile
1623_core_.FSFile_swigregister(FSFilePtr)
1624
1625class CPPFileSystemHandler(object):
1626 def __init__(self): raise RuntimeError, "No constructor defined"
1627 def __repr__(self):
1628 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1629
1630class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1631 def __init__(self, this):
1632 self.this = this
1633 if not hasattr(self,"thisown"): self.thisown = 0
1634 self.__class__ = CPPFileSystemHandler
1635_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1636
1637class FileSystemHandler(CPPFileSystemHandler):
1638 def __repr__(self):
1639 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1640 def __init__(self, *args, **kwargs):
1641 """__init__(self) -> FileSystemHandler"""
1642 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1643 self.this = newobj.this
1644 self.thisown = 1
1645 del newobj.thisown
1646 self._setCallbackInfo(self, FileSystemHandler)
1647
1648 def _setCallbackInfo(*args, **kwargs):
1649 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1650 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1651
1652 def CanOpen(*args, **kwargs):
1653 """CanOpen(self, String location) -> bool"""
1654 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1655
1656 def OpenFile(*args, **kwargs):
1657 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1658 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1659
1660 def FindFirst(*args, **kwargs):
1661 """FindFirst(self, String spec, int flags=0) -> String"""
1662 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1663
1664 def FindNext(*args, **kwargs):
1665 """FindNext(self) -> String"""
1666 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1667
1668 def GetProtocol(*args, **kwargs):
1669 """GetProtocol(self, String location) -> String"""
1670 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1671
1672 def GetLeftLocation(*args, **kwargs):
1673 """GetLeftLocation(self, String location) -> String"""
1674 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1675
1676 def GetAnchor(*args, **kwargs):
1677 """GetAnchor(self, String location) -> String"""
1678 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1679
1680 def GetRightLocation(*args, **kwargs):
1681 """GetRightLocation(self, String location) -> String"""
1682 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1683
1684 def GetMimeTypeFromExt(*args, **kwargs):
1685 """GetMimeTypeFromExt(self, String location) -> String"""
1686 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1687
1688
1689class FileSystemHandlerPtr(FileSystemHandler):
1690 def __init__(self, this):
1691 self.this = this
1692 if not hasattr(self,"thisown"): self.thisown = 0
1693 self.__class__ = FileSystemHandler
1694_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1695
1696class FileSystem(Object):
1697 def __repr__(self):
1698 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1699 def __init__(self, *args, **kwargs):
1700 """__init__(self) -> FileSystem"""
1701 newobj = _core_.new_FileSystem(*args, **kwargs)
1702 self.this = newobj.this
1703 self.thisown = 1
1704 del newobj.thisown
1705 def __del__(self, destroy=_core_.delete_FileSystem):
1706 """__del__(self)"""
1707 try:
1708 if self.thisown: destroy(self)
1709 except: pass
1710
1711 def ChangePathTo(*args, **kwargs):
1712 """ChangePathTo(self, String location, bool is_dir=False)"""
1713 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1714
1715 def GetPath(*args, **kwargs):
1716 """GetPath(self) -> String"""
1717 return _core_.FileSystem_GetPath(*args, **kwargs)
1718
1719 def OpenFile(*args, **kwargs):
1720 """OpenFile(self, String location) -> FSFile"""
1721 return _core_.FileSystem_OpenFile(*args, **kwargs)
1722
1723 def FindFirst(*args, **kwargs):
1724 """FindFirst(self, String spec, int flags=0) -> String"""
1725 return _core_.FileSystem_FindFirst(*args, **kwargs)
1726
1727 def FindNext(*args, **kwargs):
1728 """FindNext(self) -> String"""
1729 return _core_.FileSystem_FindNext(*args, **kwargs)
1730
1731 def AddHandler(*args, **kwargs):
d6c14a4c 1732 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1733 return _core_.FileSystem_AddHandler(*args, **kwargs)
1734
1735 AddHandler = staticmethod(AddHandler)
1736 def CleanUpHandlers(*args, **kwargs):
d6c14a4c 1737 """CleanUpHandlers()"""
d55e5bfc
RD
1738 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1739
1740 CleanUpHandlers = staticmethod(CleanUpHandlers)
1741 def FileNameToURL(*args, **kwargs):
d6c14a4c 1742 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1743 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1744
1745 FileNameToURL = staticmethod(FileNameToURL)
1746
1747class FileSystemPtr(FileSystem):
1748 def __init__(self, this):
1749 self.this = this
1750 if not hasattr(self,"thisown"): self.thisown = 0
1751 self.__class__ = FileSystem
1752_core_.FileSystem_swigregister(FileSystemPtr)
1753
1754def FileSystem_AddHandler(*args, **kwargs):
1755 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1756 return _core_.FileSystem_AddHandler(*args, **kwargs)
1757
1758def FileSystem_CleanUpHandlers(*args, **kwargs):
1759 """FileSystem_CleanUpHandlers()"""
1760 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1761
1762def FileSystem_FileNameToURL(*args, **kwargs):
1763 """FileSystem_FileNameToURL(String filename) -> String"""
1764 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1765
1766
1767def FileSystem_URLToFileName(*args, **kwargs):
1768 """FileSystem_URLToFileName(String url) -> String"""
1769 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1770class InternetFSHandler(CPPFileSystemHandler):
1771 def __repr__(self):
1772 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1773 def __init__(self, *args, **kwargs):
1774 """__init__(self) -> InternetFSHandler"""
1775 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1776 self.this = newobj.this
1777 self.thisown = 1
1778 del newobj.thisown
1779 def CanOpen(*args, **kwargs):
1780 """CanOpen(self, String location) -> bool"""
1781 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1782
1783 def OpenFile(*args, **kwargs):
1784 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1785 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1786
1787
1788class InternetFSHandlerPtr(InternetFSHandler):
1789 def __init__(self, this):
1790 self.this = this
1791 if not hasattr(self,"thisown"): self.thisown = 0
1792 self.__class__ = InternetFSHandler
1793_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1794
1795class ZipFSHandler(CPPFileSystemHandler):
1796 def __repr__(self):
1797 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1798 def __init__(self, *args, **kwargs):
1799 """__init__(self) -> ZipFSHandler"""
1800 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1801 self.this = newobj.this
1802 self.thisown = 1
1803 del newobj.thisown
1804 def CanOpen(*args, **kwargs):
1805 """CanOpen(self, String location) -> bool"""
1806 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1807
1808 def OpenFile(*args, **kwargs):
1809 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1810 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1811
1812 def FindFirst(*args, **kwargs):
1813 """FindFirst(self, String spec, int flags=0) -> String"""
1814 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1815
1816 def FindNext(*args, **kwargs):
1817 """FindNext(self) -> String"""
1818 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1819
1820
1821class ZipFSHandlerPtr(ZipFSHandler):
1822 def __init__(self, this):
1823 self.this = this
1824 if not hasattr(self,"thisown"): self.thisown = 0
1825 self.__class__ = ZipFSHandler
1826_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
1827
1828
1829def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1830 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1831 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1832
1833def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1834 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1835 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1836
1837def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1838 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1839 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1840def MemoryFSHandler_AddFile(filename, a, b=''):
1841 if isinstance(a, wx.Image):
1842 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1843 elif isinstance(a, wx.Bitmap):
1844 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1845 elif type(a) == str:
1846 __wxMemoryFSHandler_AddFile_Data(filename, a)
1847 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1848
1849class MemoryFSHandler(CPPFileSystemHandler):
1850 def __repr__(self):
1851 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1852 def __init__(self, *args, **kwargs):
1853 """__init__(self) -> MemoryFSHandler"""
1854 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
1855 self.this = newobj.this
1856 self.thisown = 1
1857 del newobj.thisown
1858 def RemoveFile(*args, **kwargs):
d6c14a4c 1859 """RemoveFile(String filename)"""
d55e5bfc
RD
1860 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1861
1862 RemoveFile = staticmethod(RemoveFile)
1863 AddFile = staticmethod(MemoryFSHandler_AddFile)
1864 def CanOpen(*args, **kwargs):
1865 """CanOpen(self, String location) -> bool"""
1866 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1867
1868 def OpenFile(*args, **kwargs):
1869 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1870 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1871
1872 def FindFirst(*args, **kwargs):
1873 """FindFirst(self, String spec, int flags=0) -> String"""
1874 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1875
1876 def FindNext(*args, **kwargs):
1877 """FindNext(self) -> String"""
1878 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1879
1880
1881class MemoryFSHandlerPtr(MemoryFSHandler):
1882 def __init__(self, this):
1883 self.this = this
1884 if not hasattr(self,"thisown"): self.thisown = 0
1885 self.__class__ = MemoryFSHandler
1886_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
1887
1888def MemoryFSHandler_RemoveFile(*args, **kwargs):
1889 """MemoryFSHandler_RemoveFile(String filename)"""
1890 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1891
1892#---------------------------------------------------------------------------
1893
1894class ImageHandler(Object):
1895 def __init__(self): raise RuntimeError, "No constructor defined"
1896 def __repr__(self):
1897 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1898 def GetName(*args, **kwargs):
1899 """GetName(self) -> String"""
1900 return _core_.ImageHandler_GetName(*args, **kwargs)
1901
1902 def GetExtension(*args, **kwargs):
1903 """GetExtension(self) -> String"""
1904 return _core_.ImageHandler_GetExtension(*args, **kwargs)
1905
1906 def GetType(*args, **kwargs):
1907 """GetType(self) -> long"""
1908 return _core_.ImageHandler_GetType(*args, **kwargs)
1909
1910 def GetMimeType(*args, **kwargs):
1911 """GetMimeType(self) -> String"""
1912 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
1913
1914 def CanRead(*args, **kwargs):
1915 """CanRead(self, String name) -> bool"""
1916 return _core_.ImageHandler_CanRead(*args, **kwargs)
1917
1918 def SetName(*args, **kwargs):
1919 """SetName(self, String name)"""
1920 return _core_.ImageHandler_SetName(*args, **kwargs)
1921
1922 def SetExtension(*args, **kwargs):
1923 """SetExtension(self, String extension)"""
1924 return _core_.ImageHandler_SetExtension(*args, **kwargs)
1925
1926 def SetType(*args, **kwargs):
1927 """SetType(self, long type)"""
1928 return _core_.ImageHandler_SetType(*args, **kwargs)
1929
1930 def SetMimeType(*args, **kwargs):
1931 """SetMimeType(self, String mimetype)"""
1932 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
1933
1934
1935class ImageHandlerPtr(ImageHandler):
1936 def __init__(self, this):
1937 self.this = this
1938 if not hasattr(self,"thisown"): self.thisown = 0
1939 self.__class__ = ImageHandler
1940_core_.ImageHandler_swigregister(ImageHandlerPtr)
1941
1942class ImageHistogram(object):
1943 def __repr__(self):
1944 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1945 def __init__(self, *args, **kwargs):
1946 """__init__(self) -> ImageHistogram"""
1947 newobj = _core_.new_ImageHistogram(*args, **kwargs)
1948 self.this = newobj.this
1949 self.thisown = 1
1950 del newobj.thisown
1951 def MakeKey(*args, **kwargs):
1952 """
d6c14a4c 1953 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
d55e5bfc
RD
1954
1955 Get the key in the histogram for the given RGB values
1956 """
1957 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
1958
1959 MakeKey = staticmethod(MakeKey)
1960 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
1961 """
1962 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
1963
1964 Find first colour that is not used in the image and has higher RGB
1965 values than startR, startG, startB. Returns a tuple consisting of a
1966 success flag and rgb values.
1967 """
d55e5bfc
RD
1968 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
1969
1970
1971class ImageHistogramPtr(ImageHistogram):
1972 def __init__(self, this):
1973 self.this = this
1974 if not hasattr(self,"thisown"): self.thisown = 0
1975 self.__class__ = ImageHistogram
1976_core_.ImageHistogram_swigregister(ImageHistogramPtr)
1977
1978def ImageHistogram_MakeKey(*args, **kwargs):
1979 """
1980 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
1981
1982 Get the key in the histogram for the given RGB values
1983 """
1984 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
1985
1986class Image(Object):
1987 def __repr__(self):
1988 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1989 def __init__(self, *args, **kwargs):
1990 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
1991 newobj = _core_.new_Image(*args, **kwargs)
1992 self.this = newobj.this
1993 self.thisown = 1
1994 del newobj.thisown
1995 def __del__(self, destroy=_core_.delete_Image):
1996 """__del__(self)"""
1997 try:
1998 if self.thisown: destroy(self)
1999 except: pass
2000
2001 def Create(*args, **kwargs):
2002 """Create(self, int width, int height)"""
2003 return _core_.Image_Create(*args, **kwargs)
2004
2005 def Destroy(*args, **kwargs):
2006 """
2007 Destroy(self)
2008
2009 Deletes the C++ object this Python object is a proxy for.
2010 """
2011 return _core_.Image_Destroy(*args, **kwargs)
2012
2013 def Scale(*args, **kwargs):
2014 """Scale(self, int width, int height) -> Image"""
2015 return _core_.Image_Scale(*args, **kwargs)
2016
2017 def ShrinkBy(*args, **kwargs):
2018 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
2019 return _core_.Image_ShrinkBy(*args, **kwargs)
2020
2021 def Rescale(*args, **kwargs):
2022 """Rescale(self, int width, int height) -> Image"""
2023 return _core_.Image_Rescale(*args, **kwargs)
2024
2025 def SetRGB(*args, **kwargs):
2026 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
2027 return _core_.Image_SetRGB(*args, **kwargs)
2028
2029 def GetRed(*args, **kwargs):
2030 """GetRed(self, int x, int y) -> unsigned char"""
2031 return _core_.Image_GetRed(*args, **kwargs)
2032
2033 def GetGreen(*args, **kwargs):
2034 """GetGreen(self, int x, int y) -> unsigned char"""
2035 return _core_.Image_GetGreen(*args, **kwargs)
2036
2037 def GetBlue(*args, **kwargs):
2038 """GetBlue(self, int x, int y) -> unsigned char"""
2039 return _core_.Image_GetBlue(*args, **kwargs)
2040
2041 def SetAlpha(*args, **kwargs):
2042 """SetAlpha(self, int x, int y, unsigned char alpha)"""
2043 return _core_.Image_SetAlpha(*args, **kwargs)
2044
2045 def GetAlpha(*args, **kwargs):
2046 """GetAlpha(self, int x, int y) -> unsigned char"""
2047 return _core_.Image_GetAlpha(*args, **kwargs)
2048
2049 def HasAlpha(*args, **kwargs):
2050 """HasAlpha(self) -> bool"""
2051 return _core_.Image_HasAlpha(*args, **kwargs)
2052
2053 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2054 """
2055 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2056
2057 Find first colour that is not used in the image and has higher RGB
2058 values than startR, startG, startB. Returns a tuple consisting of a
2059 success flag and rgb values.
2060 """
d55e5bfc
RD
2061 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2062
2063 def SetMaskFromImage(*args, **kwargs):
2064 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
2065 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2066
2067 def CanRead(*args, **kwargs):
d6c14a4c 2068 """CanRead(String name) -> bool"""
d55e5bfc
RD
2069 return _core_.Image_CanRead(*args, **kwargs)
2070
2071 CanRead = staticmethod(CanRead)
2072 def GetImageCount(*args, **kwargs):
d6c14a4c 2073 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
d55e5bfc
RD
2074 return _core_.Image_GetImageCount(*args, **kwargs)
2075
2076 GetImageCount = staticmethod(GetImageCount)
2077 def LoadFile(*args, **kwargs):
2078 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2079 return _core_.Image_LoadFile(*args, **kwargs)
2080
2081 def LoadMimeFile(*args, **kwargs):
2082 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
2083 return _core_.Image_LoadMimeFile(*args, **kwargs)
2084
2085 def SaveFile(*args, **kwargs):
2086 """SaveFile(self, String name, int type) -> bool"""
2087 return _core_.Image_SaveFile(*args, **kwargs)
2088
2089 def SaveMimeFile(*args, **kwargs):
2090 """SaveMimeFile(self, String name, String mimetype) -> bool"""
2091 return _core_.Image_SaveMimeFile(*args, **kwargs)
2092
2093 def CanReadStream(*args, **kwargs):
d6c14a4c 2094 """CanReadStream(InputStream stream) -> bool"""
d55e5bfc
RD
2095 return _core_.Image_CanReadStream(*args, **kwargs)
2096
2097 CanReadStream = staticmethod(CanReadStream)
2098 def LoadStream(*args, **kwargs):
2099 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2100 return _core_.Image_LoadStream(*args, **kwargs)
2101
2102 def LoadMimeStream(*args, **kwargs):
2103 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
2104 return _core_.Image_LoadMimeStream(*args, **kwargs)
2105
2106 def Ok(*args, **kwargs):
2107 """Ok(self) -> bool"""
2108 return _core_.Image_Ok(*args, **kwargs)
2109
2110 def GetWidth(*args, **kwargs):
2111 """GetWidth(self) -> int"""
2112 return _core_.Image_GetWidth(*args, **kwargs)
2113
2114 def GetHeight(*args, **kwargs):
2115 """GetHeight(self) -> int"""
2116 return _core_.Image_GetHeight(*args, **kwargs)
2117
2118 def GetSize(*args, **kwargs):
2119 """GetSize(self) -> Size"""
2120 return _core_.Image_GetSize(*args, **kwargs)
2121
2122 def GetSubImage(*args, **kwargs):
2123 """GetSubImage(self, Rect rect) -> Image"""
2124 return _core_.Image_GetSubImage(*args, **kwargs)
2125
2126 def Copy(*args, **kwargs):
2127 """Copy(self) -> Image"""
2128 return _core_.Image_Copy(*args, **kwargs)
2129
2130 def Paste(*args, **kwargs):
2131 """Paste(self, Image image, int x, int y)"""
2132 return _core_.Image_Paste(*args, **kwargs)
2133
2134 def GetData(*args, **kwargs):
2135 """GetData(self) -> PyObject"""
2136 return _core_.Image_GetData(*args, **kwargs)
2137
2138 def SetData(*args, **kwargs):
2139 """SetData(self, PyObject data)"""
2140 return _core_.Image_SetData(*args, **kwargs)
2141
2142 def GetDataBuffer(*args, **kwargs):
2143 """GetDataBuffer(self) -> PyObject"""
2144 return _core_.Image_GetDataBuffer(*args, **kwargs)
2145
2146 def SetDataBuffer(*args, **kwargs):
2147 """SetDataBuffer(self, PyObject data)"""
2148 return _core_.Image_SetDataBuffer(*args, **kwargs)
2149
2150 def GetAlphaData(*args, **kwargs):
2151 """GetAlphaData(self) -> PyObject"""
2152 return _core_.Image_GetAlphaData(*args, **kwargs)
2153
2154 def SetAlphaData(*args, **kwargs):
2155 """SetAlphaData(self, PyObject data)"""
2156 return _core_.Image_SetAlphaData(*args, **kwargs)
2157
2158 def GetAlphaBuffer(*args, **kwargs):
2159 """GetAlphaBuffer(self) -> PyObject"""
2160 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2161
2162 def SetAlphaBuffer(*args, **kwargs):
2163 """SetAlphaBuffer(self, PyObject data)"""
2164 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2165
2166 def SetMaskColour(*args, **kwargs):
2167 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
2168 return _core_.Image_SetMaskColour(*args, **kwargs)
2169
2170 def GetMaskRed(*args, **kwargs):
2171 """GetMaskRed(self) -> unsigned char"""
2172 return _core_.Image_GetMaskRed(*args, **kwargs)
2173
2174 def GetMaskGreen(*args, **kwargs):
2175 """GetMaskGreen(self) -> unsigned char"""
2176 return _core_.Image_GetMaskGreen(*args, **kwargs)
2177
2178 def GetMaskBlue(*args, **kwargs):
2179 """GetMaskBlue(self) -> unsigned char"""
2180 return _core_.Image_GetMaskBlue(*args, **kwargs)
2181
2182 def SetMask(*args, **kwargs):
2183 """SetMask(self, bool mask=True)"""
2184 return _core_.Image_SetMask(*args, **kwargs)
2185
2186 def HasMask(*args, **kwargs):
2187 """HasMask(self) -> bool"""
2188 return _core_.Image_HasMask(*args, **kwargs)
2189
2190 def Rotate(*args, **kwargs):
2191 """
2192 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2193 Point offset_after_rotation=None) -> Image
2194 """
2195 return _core_.Image_Rotate(*args, **kwargs)
2196
2197 def Rotate90(*args, **kwargs):
2198 """Rotate90(self, bool clockwise=True) -> Image"""
2199 return _core_.Image_Rotate90(*args, **kwargs)
2200
2201 def Mirror(*args, **kwargs):
2202 """Mirror(self, bool horizontally=True) -> Image"""
2203 return _core_.Image_Mirror(*args, **kwargs)
2204
2205 def Replace(*args, **kwargs):
2206 """
2207 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
2208 unsigned char r2, unsigned char g2, unsigned char b2)
2209 """
2210 return _core_.Image_Replace(*args, **kwargs)
2211
2212 def ConvertToMono(*args, **kwargs):
2213 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
2214 return _core_.Image_ConvertToMono(*args, **kwargs)
2215
2216 def SetOption(*args, **kwargs):
2217 """SetOption(self, String name, String value)"""
2218 return _core_.Image_SetOption(*args, **kwargs)
2219
2220 def SetOptionInt(*args, **kwargs):
2221 """SetOptionInt(self, String name, int value)"""
2222 return _core_.Image_SetOptionInt(*args, **kwargs)
2223
2224 def GetOption(*args, **kwargs):
2225 """GetOption(self, String name) -> String"""
2226 return _core_.Image_GetOption(*args, **kwargs)
2227
2228 def GetOptionInt(*args, **kwargs):
2229 """GetOptionInt(self, String name) -> int"""
2230 return _core_.Image_GetOptionInt(*args, **kwargs)
2231
2232 def HasOption(*args, **kwargs):
2233 """HasOption(self, String name) -> bool"""
2234 return _core_.Image_HasOption(*args, **kwargs)
2235
2236 def CountColours(*args, **kwargs):
2237 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2238 return _core_.Image_CountColours(*args, **kwargs)
2239
2240 def ComputeHistogram(*args, **kwargs):
2241 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2242 return _core_.Image_ComputeHistogram(*args, **kwargs)
2243
2244 def AddHandler(*args, **kwargs):
d6c14a4c 2245 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
2246 return _core_.Image_AddHandler(*args, **kwargs)
2247
2248 AddHandler = staticmethod(AddHandler)
2249 def InsertHandler(*args, **kwargs):
d6c14a4c 2250 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
2251 return _core_.Image_InsertHandler(*args, **kwargs)
2252
2253 InsertHandler = staticmethod(InsertHandler)
2254 def RemoveHandler(*args, **kwargs):
d6c14a4c 2255 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
2256 return _core_.Image_RemoveHandler(*args, **kwargs)
2257
2258 RemoveHandler = staticmethod(RemoveHandler)
2259 def GetImageExtWildcard(*args, **kwargs):
d6c14a4c 2260 """GetImageExtWildcard() -> String"""
d55e5bfc
RD
2261 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2262
2263 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2264 def ConvertToBitmap(*args, **kwargs):
2265 """ConvertToBitmap(self) -> Bitmap"""
2266 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2267
2268 def ConvertToMonoBitmap(*args, **kwargs):
2269 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
2270 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2271
2272 def __nonzero__(self): return self.Ok()
2273
2274class ImagePtr(Image):
2275 def __init__(self, this):
2276 self.this = this
2277 if not hasattr(self,"thisown"): self.thisown = 0
2278 self.__class__ = Image
2279_core_.Image_swigregister(ImagePtr)
2280
2281def ImageFromMime(*args, **kwargs):
2282 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
2283 val = _core_.new_ImageFromMime(*args, **kwargs)
2284 val.thisown = 1
2285 return val
2286
2287def ImageFromStream(*args, **kwargs):
2288 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2289 val = _core_.new_ImageFromStream(*args, **kwargs)
2290 val.thisown = 1
2291 return val
2292
2293def ImageFromStreamMime(*args, **kwargs):
2294 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
2295 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2296 val.thisown = 1
2297 return val
2298
d6c14a4c
RD
2299def EmptyImage(*args, **kwargs):
2300 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2301 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
2302 val.thisown = 1
2303 return val
2304
2305def ImageFromBitmap(*args, **kwargs):
2306 """ImageFromBitmap(Bitmap bitmap) -> Image"""
2307 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2308 val.thisown = 1
2309 return val
2310
2311def ImageFromData(*args, **kwargs):
2312 """ImageFromData(int width, int height, unsigned char data) -> Image"""
2313 val = _core_.new_ImageFromData(*args, **kwargs)
2314 val.thisown = 1
2315 return val
2316
2317def Image_CanRead(*args, **kwargs):
2318 """Image_CanRead(String name) -> bool"""
2319 return _core_.Image_CanRead(*args, **kwargs)
2320
2321def Image_GetImageCount(*args, **kwargs):
2322 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
2323 return _core_.Image_GetImageCount(*args, **kwargs)
2324
2325def Image_CanReadStream(*args, **kwargs):
2326 """Image_CanReadStream(InputStream stream) -> bool"""
2327 return _core_.Image_CanReadStream(*args, **kwargs)
2328
2329def Image_AddHandler(*args, **kwargs):
2330 """Image_AddHandler(ImageHandler handler)"""
2331 return _core_.Image_AddHandler(*args, **kwargs)
2332
2333def Image_InsertHandler(*args, **kwargs):
2334 """Image_InsertHandler(ImageHandler handler)"""
2335 return _core_.Image_InsertHandler(*args, **kwargs)
2336
2337def Image_RemoveHandler(*args, **kwargs):
2338 """Image_RemoveHandler(String name) -> bool"""
2339 return _core_.Image_RemoveHandler(*args, **kwargs)
2340
2341def Image_GetImageExtWildcard(*args, **kwargs):
2342 """Image_GetImageExtWildcard() -> String"""
2343 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2344
68e533f8
RD
2345def InitAllImageHandlers():
2346 """
2347 The former functionality of InitAllImageHanders is now done internal to
2348 the _core_ extension module and so this function has become a simple NOP.
2349 """
2350 pass
d55e5bfc 2351
d55e5bfc
RD
2352IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2353IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2354BMP_24BPP = _core_.BMP_24BPP
2355BMP_8BPP = _core_.BMP_8BPP
2356BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2357BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2358BMP_8BPP_RED = _core_.BMP_8BPP_RED
2359BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2360BMP_4BPP = _core_.BMP_4BPP
2361BMP_1BPP = _core_.BMP_1BPP
2362BMP_1BPP_BW = _core_.BMP_1BPP_BW
2363class BMPHandler(ImageHandler):
2364 def __repr__(self):
2365 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2366 def __init__(self, *args, **kwargs):
2367 """__init__(self) -> BMPHandler"""
2368 newobj = _core_.new_BMPHandler(*args, **kwargs)
2369 self.this = newobj.this
2370 self.thisown = 1
2371 del newobj.thisown
2372
2373class BMPHandlerPtr(BMPHandler):
2374 def __init__(self, this):
2375 self.this = this
2376 if not hasattr(self,"thisown"): self.thisown = 0
2377 self.__class__ = BMPHandler
2378_core_.BMPHandler_swigregister(BMPHandlerPtr)
2379NullImage = cvar.NullImage
2380IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2381IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2382IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2383IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2384IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2385
2386class ICOHandler(BMPHandler):
2387 def __repr__(self):
2388 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2389 def __init__(self, *args, **kwargs):
2390 """__init__(self) -> ICOHandler"""
2391 newobj = _core_.new_ICOHandler(*args, **kwargs)
2392 self.this = newobj.this
2393 self.thisown = 1
2394 del newobj.thisown
2395
2396class ICOHandlerPtr(ICOHandler):
2397 def __init__(self, this):
2398 self.this = this
2399 if not hasattr(self,"thisown"): self.thisown = 0
2400 self.__class__ = ICOHandler
2401_core_.ICOHandler_swigregister(ICOHandlerPtr)
2402
2403class CURHandler(ICOHandler):
2404 def __repr__(self):
2405 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2406 def __init__(self, *args, **kwargs):
2407 """__init__(self) -> CURHandler"""
2408 newobj = _core_.new_CURHandler(*args, **kwargs)
2409 self.this = newobj.this
2410 self.thisown = 1
2411 del newobj.thisown
2412
2413class CURHandlerPtr(CURHandler):
2414 def __init__(self, this):
2415 self.this = this
2416 if not hasattr(self,"thisown"): self.thisown = 0
2417 self.__class__ = CURHandler
2418_core_.CURHandler_swigregister(CURHandlerPtr)
2419
2420class ANIHandler(CURHandler):
2421 def __repr__(self):
2422 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2423 def __init__(self, *args, **kwargs):
2424 """__init__(self) -> ANIHandler"""
2425 newobj = _core_.new_ANIHandler(*args, **kwargs)
2426 self.this = newobj.this
2427 self.thisown = 1
2428 del newobj.thisown
2429
2430class ANIHandlerPtr(ANIHandler):
2431 def __init__(self, this):
2432 self.this = this
2433 if not hasattr(self,"thisown"): self.thisown = 0
2434 self.__class__ = ANIHandler
2435_core_.ANIHandler_swigregister(ANIHandlerPtr)
2436
2437class PNGHandler(ImageHandler):
2438 def __repr__(self):
2439 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2440 def __init__(self, *args, **kwargs):
2441 """__init__(self) -> PNGHandler"""
2442 newobj = _core_.new_PNGHandler(*args, **kwargs)
2443 self.this = newobj.this
2444 self.thisown = 1
2445 del newobj.thisown
2446
2447class PNGHandlerPtr(PNGHandler):
2448 def __init__(self, this):
2449 self.this = this
2450 if not hasattr(self,"thisown"): self.thisown = 0
2451 self.__class__ = PNGHandler
2452_core_.PNGHandler_swigregister(PNGHandlerPtr)
2453
2454class GIFHandler(ImageHandler):
2455 def __repr__(self):
2456 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2457 def __init__(self, *args, **kwargs):
2458 """__init__(self) -> GIFHandler"""
2459 newobj = _core_.new_GIFHandler(*args, **kwargs)
2460 self.this = newobj.this
2461 self.thisown = 1
2462 del newobj.thisown
2463
2464class GIFHandlerPtr(GIFHandler):
2465 def __init__(self, this):
2466 self.this = this
2467 if not hasattr(self,"thisown"): self.thisown = 0
2468 self.__class__ = GIFHandler
2469_core_.GIFHandler_swigregister(GIFHandlerPtr)
2470
2471class PCXHandler(ImageHandler):
2472 def __repr__(self):
2473 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2474 def __init__(self, *args, **kwargs):
2475 """__init__(self) -> PCXHandler"""
2476 newobj = _core_.new_PCXHandler(*args, **kwargs)
2477 self.this = newobj.this
2478 self.thisown = 1
2479 del newobj.thisown
2480
2481class PCXHandlerPtr(PCXHandler):
2482 def __init__(self, this):
2483 self.this = this
2484 if not hasattr(self,"thisown"): self.thisown = 0
2485 self.__class__ = PCXHandler
2486_core_.PCXHandler_swigregister(PCXHandlerPtr)
2487
2488class JPEGHandler(ImageHandler):
2489 def __repr__(self):
2490 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2491 def __init__(self, *args, **kwargs):
2492 """__init__(self) -> JPEGHandler"""
2493 newobj = _core_.new_JPEGHandler(*args, **kwargs)
2494 self.this = newobj.this
2495 self.thisown = 1
2496 del newobj.thisown
2497
2498class JPEGHandlerPtr(JPEGHandler):
2499 def __init__(self, this):
2500 self.this = this
2501 if not hasattr(self,"thisown"): self.thisown = 0
2502 self.__class__ = JPEGHandler
2503_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
2504
2505class PNMHandler(ImageHandler):
2506 def __repr__(self):
2507 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2508 def __init__(self, *args, **kwargs):
2509 """__init__(self) -> PNMHandler"""
2510 newobj = _core_.new_PNMHandler(*args, **kwargs)
2511 self.this = newobj.this
2512 self.thisown = 1
2513 del newobj.thisown
2514
2515class PNMHandlerPtr(PNMHandler):
2516 def __init__(self, this):
2517 self.this = this
2518 if not hasattr(self,"thisown"): self.thisown = 0
2519 self.__class__ = PNMHandler
2520_core_.PNMHandler_swigregister(PNMHandlerPtr)
2521
2522class XPMHandler(ImageHandler):
2523 def __repr__(self):
2524 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2525 def __init__(self, *args, **kwargs):
2526 """__init__(self) -> XPMHandler"""
2527 newobj = _core_.new_XPMHandler(*args, **kwargs)
2528 self.this = newobj.this
2529 self.thisown = 1
2530 del newobj.thisown
2531
2532class XPMHandlerPtr(XPMHandler):
2533 def __init__(self, this):
2534 self.this = this
2535 if not hasattr(self,"thisown"): self.thisown = 0
2536 self.__class__ = XPMHandler
2537_core_.XPMHandler_swigregister(XPMHandlerPtr)
2538
2539class TIFFHandler(ImageHandler):
2540 def __repr__(self):
2541 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2542 def __init__(self, *args, **kwargs):
2543 """__init__(self) -> TIFFHandler"""
2544 newobj = _core_.new_TIFFHandler(*args, **kwargs)
2545 self.this = newobj.this
2546 self.thisown = 1
2547 del newobj.thisown
2548
2549class TIFFHandlerPtr(TIFFHandler):
2550 def __init__(self, this):
2551 self.this = this
2552 if not hasattr(self,"thisown"): self.thisown = 0
2553 self.__class__ = TIFFHandler
2554_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
2555
2556#---------------------------------------------------------------------------
2557
2558class EvtHandler(Object):
2559 def __repr__(self):
2560 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2561 def __init__(self, *args, **kwargs):
2562 """__init__(self) -> EvtHandler"""
2563 newobj = _core_.new_EvtHandler(*args, **kwargs)
2564 self.this = newobj.this
2565 self.thisown = 1
2566 del newobj.thisown
2567 def GetNextHandler(*args, **kwargs):
2568 """GetNextHandler(self) -> EvtHandler"""
2569 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
2570
2571 def GetPreviousHandler(*args, **kwargs):
2572 """GetPreviousHandler(self) -> EvtHandler"""
2573 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
2574
2575 def SetNextHandler(*args, **kwargs):
2576 """SetNextHandler(self, EvtHandler handler)"""
2577 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
2578
2579 def SetPreviousHandler(*args, **kwargs):
2580 """SetPreviousHandler(self, EvtHandler handler)"""
2581 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
2582
2583 def GetEvtHandlerEnabled(*args, **kwargs):
2584 """GetEvtHandlerEnabled(self) -> bool"""
2585 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
2586
2587 def SetEvtHandlerEnabled(*args, **kwargs):
2588 """SetEvtHandlerEnabled(self, bool enabled)"""
2589 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
2590
2591 def ProcessEvent(*args, **kwargs):
2592 """ProcessEvent(self, Event event) -> bool"""
2593 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
2594
2595 def AddPendingEvent(*args, **kwargs):
2596 """AddPendingEvent(self, Event event)"""
2597 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
2598
2599 def ProcessPendingEvents(*args, **kwargs):
2600 """ProcessPendingEvents(self)"""
2601 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
2602
2603 def Connect(*args, **kwargs):
2604 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
2605 return _core_.EvtHandler_Connect(*args, **kwargs)
2606
2607 def Disconnect(*args, **kwargs):
2608 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
2609 return _core_.EvtHandler_Disconnect(*args, **kwargs)
2610
2611 def _setOORInfo(*args, **kwargs):
2612 """_setOORInfo(self, PyObject _self)"""
2613 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
2614
2615 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2616 """
2617 Bind an event to an event handler.
2618
a5ee0656
RD
2619 :param event: One of the EVT_* objects that specifies the
2620 type of event to bind,
d55e5bfc 2621
a5ee0656
RD
2622 :param handler: A callable object to be invoked when the
2623 event is delivered to self. Pass None to
2624 disconnect an event handler.
d55e5bfc 2625
a5ee0656
RD
2626 :param source: Sometimes the event originates from a
2627 different window than self, but you still
2628 want to catch it in self. (For example, a
2629 button event delivered to a frame.) By
2630 passing the source of the event, the event
2631 handling system is able to differentiate
2632 between the same event type from different
2633 controls.
d55e5bfc 2634
a5ee0656
RD
2635 :param id: Used to spcify the event source by ID instead
2636 of instance.
2637
2638 :param id2: Used when it is desirable to bind a handler
2639 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
2640 """
2641 if source is not None:
2642 id = source.GetId()
2643 event.Bind(self, id, id2, handler)
2644
d6c14a4c
RD
2645 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2646 """
2647 Disconencts the event handler binding for event from self.
2648 Returns True if successful.
2649 """
2650 if source is not None:
2651 id = source.GetId()
2652 return event.Unbind(self, id, id2)
d55e5bfc
RD
2653
2654
2655class EvtHandlerPtr(EvtHandler):
2656 def __init__(self, this):
2657 self.this = this
2658 if not hasattr(self,"thisown"): self.thisown = 0
2659 self.__class__ = EvtHandler
2660_core_.EvtHandler_swigregister(EvtHandlerPtr)
2661
2662#---------------------------------------------------------------------------
2663
2664class PyEventBinder(object):
2665 """
2666 Instances of this class are used to bind specific events to event
2667 handlers.
2668 """
2669 def __init__(self, evtType, expectedIDs=0):
2670 if expectedIDs not in [0, 1, 2]:
2671 raise ValueError, "Invalid number of expectedIDs"
2672 self.expectedIDs = expectedIDs
2673
2674 if type(evtType) == list or type(evtType) == tuple:
2675 self.evtType = evtType
2676 else:
2677 self.evtType = [evtType]
2678
2679
2680 def Bind(self, target, id1, id2, function):
2681 """Bind this set of event types to target."""
2682 for et in self.evtType:
2683 target.Connect(id1, id2, et, function)
2684
d6c14a4c
RD
2685
2686 def Unbind(self, target, id1, id2):
2687 """Remove an event binding."""
2688 success = 0
2689 for et in self.evtType:
2690 success += target.Disconnect(id1, id2, et)
2691 return success != 0
2692
d55e5bfc
RD
2693
2694 def __call__(self, *args):
2695 """
2696 For backwards compatibility with the old EVT_* functions.
2697 Should be called with either (window, func), (window, ID,
2698 func) or (window, ID1, ID2, func) parameters depending on the
2699 type of the event.
2700 """
2701 assert len(args) == 2 + self.expectedIDs
2702 id1 = wx.ID_ANY
2703 id2 = wx.ID_ANY
2704 target = args[0]
2705 if self.expectedIDs == 0:
2706 func = args[1]
2707 elif self.expectedIDs == 1:
2708 id1 = args[1]
2709 func = args[2]
2710 elif self.expectedIDs == 2:
2711 id1 = args[1]
2712 id2 = args[2]
2713 func = args[3]
2714 else:
2715 raise ValueError, "Unexpected number of IDs"
2716
2717 self.Bind(target, id1, id2, func)
2718
2719
2720# These two are square pegs that don't fit the PyEventBinder hole...
2721def EVT_COMMAND(win, id, cmd, func):
2722 win.Connect(id, -1, cmd, func)
2723def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2724 win.Connect(id1, id2, cmd, func)
2725
2726
2727#---------------------------------------------------------------------------
2728
2729#---------------------------------------------------------------------------
2730
2731EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2732EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
2733
2734def NewEventType(*args, **kwargs):
2735 """NewEventType() -> wxEventType"""
2736 return _core_.NewEventType(*args, **kwargs)
2737wxEVT_NULL = _core_.wxEVT_NULL
2738wxEVT_FIRST = _core_.wxEVT_FIRST
2739wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2740wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2741wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2742wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2743wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2744wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2745wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2746wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2747wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2748wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2749wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2750wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2751wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2752wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2753wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2754wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2755wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2756wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2757wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2758wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2759wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2760wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2761wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2762wxEVT_MOTION = _core_.wxEVT_MOTION
2763wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2764wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2765wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2766wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2767wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2768wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2769wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2770wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2771wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2772wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2773wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2774wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2775wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2776wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2777wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2778wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2779wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2780wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2781wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2782wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2783wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2784wxEVT_CHAR = _core_.wxEVT_CHAR
2785wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2786wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2787wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2788wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2789wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2790wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2791wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2792wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2793wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2794wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2795wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2796wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2797wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2798wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2799wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2800wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2801wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2802wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2803wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2804wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2805wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2806wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2807wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2808wxEVT_SIZE = _core_.wxEVT_SIZE
2809wxEVT_MOVE = _core_.wxEVT_MOVE
2810wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2811wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2812wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2813wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2814wxEVT_POWER = _core_.wxEVT_POWER
2815wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2816wxEVT_CREATE = _core_.wxEVT_CREATE
2817wxEVT_DESTROY = _core_.wxEVT_DESTROY
2818wxEVT_SHOW = _core_.wxEVT_SHOW
2819wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2820wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2821wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2822wxEVT_PAINT = _core_.wxEVT_PAINT
2823wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2824wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2825wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2826wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2827wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2828wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2829wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2830wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2831wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2832wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2833wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2834wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2835wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2836wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2837wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2838wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2839wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2840wxEVT_IDLE = _core_.wxEVT_IDLE
2841wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2842wxEVT_SIZING = _core_.wxEVT_SIZING
2843wxEVT_MOVING = _core_.wxEVT_MOVING
2844wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2845wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2846wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2847wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2848wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2849wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2850wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
2851#
2852# Create some event binders
2853EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2854EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2855EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2856EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2857EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2858EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2859EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2860EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2861EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2862EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2863EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2864EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2865EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2866EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2867EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2868EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2869EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2870EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2871EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2872EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2873EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2874EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2875EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2876EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2877EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2878EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2879EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
2880EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
2881EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
2882EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
2883EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
2884EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
2885EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
2886EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
2887EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
2888EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
2889EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
2890EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
2891EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
2892EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
2893
2894EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
2895EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
2896EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
2897EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
2898EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
2899EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
2900EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
2901EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
2902EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
2903EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
2904EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
2905EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
2906EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
2907
2908EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
2909 wxEVT_LEFT_UP,
2910 wxEVT_MIDDLE_DOWN,
2911 wxEVT_MIDDLE_UP,
2912 wxEVT_RIGHT_DOWN,
2913 wxEVT_RIGHT_UP,
2914 wxEVT_MOTION,
2915 wxEVT_LEFT_DCLICK,
2916 wxEVT_MIDDLE_DCLICK,
2917 wxEVT_RIGHT_DCLICK,
2918 wxEVT_ENTER_WINDOW,
2919 wxEVT_LEAVE_WINDOW,
2920 wxEVT_MOUSEWHEEL
2921 ])
2922
2923
2924# Scrolling from wxWindow (sent to wxScrolledWindow)
2925EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
2926 wxEVT_SCROLLWIN_BOTTOM,
2927 wxEVT_SCROLLWIN_LINEUP,
2928 wxEVT_SCROLLWIN_LINEDOWN,
2929 wxEVT_SCROLLWIN_PAGEUP,
2930 wxEVT_SCROLLWIN_PAGEDOWN,
2931 wxEVT_SCROLLWIN_THUMBTRACK,
2932 wxEVT_SCROLLWIN_THUMBRELEASE,
2933 ])
2934
2935EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
2936EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
2937EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
2938EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
2939EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
2940EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
2941EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
2942EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
2943
2944# Scrolling from wxSlider and wxScrollBar
2945EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2946 wxEVT_SCROLL_BOTTOM,
2947 wxEVT_SCROLL_LINEUP,
2948 wxEVT_SCROLL_LINEDOWN,
2949 wxEVT_SCROLL_PAGEUP,
2950 wxEVT_SCROLL_PAGEDOWN,
2951 wxEVT_SCROLL_THUMBTRACK,
2952 wxEVT_SCROLL_THUMBRELEASE,
2953 wxEVT_SCROLL_ENDSCROLL,
2954 ])
2955
2956EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
2957EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
2958EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
2959EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
2960EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
2961EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
2962EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
2963EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
2964EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
2965
2966# Scrolling from wxSlider and wxScrollBar, with an id
2967EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2968 wxEVT_SCROLL_BOTTOM,
2969 wxEVT_SCROLL_LINEUP,
2970 wxEVT_SCROLL_LINEDOWN,
2971 wxEVT_SCROLL_PAGEUP,
2972 wxEVT_SCROLL_PAGEDOWN,
2973 wxEVT_SCROLL_THUMBTRACK,
2974 wxEVT_SCROLL_THUMBRELEASE,
2975 wxEVT_SCROLL_ENDSCROLL,
2976 ], 1)
2977
2978EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
2979EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
2980EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
2981EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
2982EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
2983EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
2984EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
2985EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
2986EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
2987
2988EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
2989EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
2990EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
2991EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
2992EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
2993EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
2994EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
2995EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
2996EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
2997EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
2998
2999EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3000EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3001EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3002EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3003EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3004EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3005EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3006EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3007EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3008
3009
3010EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3011EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3012EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3013EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3014EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3015EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3016EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3017
3018EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3019
3020EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3021EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3022
3023EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3024
3025
3026
3027#---------------------------------------------------------------------------
3028
3029class Event(Object):
3030 def __init__(self): raise RuntimeError, "No constructor defined"
3031 def __repr__(self):
3032 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3033 def __del__(self, destroy=_core_.delete_Event):
3034 """__del__(self)"""
3035 try:
3036 if self.thisown: destroy(self)
3037 except: pass
3038
3039 def SetEventType(*args, **kwargs):
3040 """SetEventType(self, wxEventType typ)"""
3041 return _core_.Event_SetEventType(*args, **kwargs)
3042
3043 def GetEventType(*args, **kwargs):
3044 """GetEventType(self) -> wxEventType"""
3045 return _core_.Event_GetEventType(*args, **kwargs)
3046
3047 def GetEventObject(*args, **kwargs):
3048 """GetEventObject(self) -> Object"""
3049 return _core_.Event_GetEventObject(*args, **kwargs)
3050
3051 def SetEventObject(*args, **kwargs):
3052 """SetEventObject(self, Object obj)"""
3053 return _core_.Event_SetEventObject(*args, **kwargs)
3054
3055 def GetTimestamp(*args, **kwargs):
3056 """GetTimestamp(self) -> long"""
3057 return _core_.Event_GetTimestamp(*args, **kwargs)
3058
3059 def SetTimestamp(*args, **kwargs):
3060 """SetTimestamp(self, long ts=0)"""
3061 return _core_.Event_SetTimestamp(*args, **kwargs)
3062
3063 def GetId(*args, **kwargs):
3064 """GetId(self) -> int"""
3065 return _core_.Event_GetId(*args, **kwargs)
3066
3067 def SetId(*args, **kwargs):
3068 """SetId(self, int Id)"""
3069 return _core_.Event_SetId(*args, **kwargs)
3070
3071 def IsCommandEvent(*args, **kwargs):
3072 """IsCommandEvent(self) -> bool"""
3073 return _core_.Event_IsCommandEvent(*args, **kwargs)
3074
3075 def Skip(*args, **kwargs):
3076 """Skip(self, bool skip=True)"""
3077 return _core_.Event_Skip(*args, **kwargs)
3078
3079 def GetSkipped(*args, **kwargs):
3080 """GetSkipped(self) -> bool"""
3081 return _core_.Event_GetSkipped(*args, **kwargs)
3082
3083 def ShouldPropagate(*args, **kwargs):
3084 """ShouldPropagate(self) -> bool"""
3085 return _core_.Event_ShouldPropagate(*args, **kwargs)
3086
3087 def StopPropagation(*args, **kwargs):
3088 """StopPropagation(self) -> int"""
3089 return _core_.Event_StopPropagation(*args, **kwargs)
3090
3091 def ResumePropagation(*args, **kwargs):
3092 """ResumePropagation(self, int propagationLevel)"""
3093 return _core_.Event_ResumePropagation(*args, **kwargs)
3094
3095 def Clone(*args, **kwargs):
3096 """Clone(self) -> Event"""
3097 return _core_.Event_Clone(*args, **kwargs)
3098
3099
3100class EventPtr(Event):
3101 def __init__(self, this):
3102 self.this = this
3103 if not hasattr(self,"thisown"): self.thisown = 0
3104 self.__class__ = Event
3105_core_.Event_swigregister(EventPtr)
3106
3107#---------------------------------------------------------------------------
3108
3109class PropagationDisabler(object):
3110 def __repr__(self):
3111 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3112 def __init__(self, *args, **kwargs):
3113 """__init__(self, Event event) -> PropagationDisabler"""
3114 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
3115 self.this = newobj.this
3116 self.thisown = 1
3117 del newobj.thisown
3118 def __del__(self, destroy=_core_.delete_PropagationDisabler):
3119 """__del__(self)"""
3120 try:
3121 if self.thisown: destroy(self)
3122 except: pass
3123
3124
3125class PropagationDisablerPtr(PropagationDisabler):
3126 def __init__(self, this):
3127 self.this = this
3128 if not hasattr(self,"thisown"): self.thisown = 0
3129 self.__class__ = PropagationDisabler
3130_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
3131
3132class PropagateOnce(object):
3133 def __repr__(self):
3134 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3135 def __init__(self, *args, **kwargs):
3136 """__init__(self, Event event) -> PropagateOnce"""
3137 newobj = _core_.new_PropagateOnce(*args, **kwargs)
3138 self.this = newobj.this
3139 self.thisown = 1
3140 del newobj.thisown
3141 def __del__(self, destroy=_core_.delete_PropagateOnce):
3142 """__del__(self)"""
3143 try:
3144 if self.thisown: destroy(self)
3145 except: pass
3146
3147
3148class PropagateOncePtr(PropagateOnce):
3149 def __init__(self, this):
3150 self.this = this
3151 if not hasattr(self,"thisown"): self.thisown = 0
3152 self.__class__ = PropagateOnce
3153_core_.PropagateOnce_swigregister(PropagateOncePtr)
3154
3155#---------------------------------------------------------------------------
3156
3157class CommandEvent(Event):
3158 def __repr__(self):
3159 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3160 def __init__(self, *args, **kwargs):
3161 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
3162 newobj = _core_.new_CommandEvent(*args, **kwargs)
3163 self.this = newobj.this
3164 self.thisown = 1
3165 del newobj.thisown
3166 def GetSelection(*args, **kwargs):
3167 """GetSelection(self) -> int"""
3168 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3169
3170 def SetString(*args, **kwargs):
3171 """SetString(self, String s)"""
3172 return _core_.CommandEvent_SetString(*args, **kwargs)
3173
3174 def GetString(*args, **kwargs):
3175 """GetString(self) -> String"""
3176 return _core_.CommandEvent_GetString(*args, **kwargs)
3177
3178 def IsChecked(*args, **kwargs):
3179 """IsChecked(self) -> bool"""
3180 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3181
3182 Checked = IsChecked
3183 def IsSelection(*args, **kwargs):
3184 """IsSelection(self) -> bool"""
3185 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3186
3187 def SetExtraLong(*args, **kwargs):
3188 """SetExtraLong(self, long extraLong)"""
3189 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3190
3191 def GetExtraLong(*args, **kwargs):
3192 """GetExtraLong(self) -> long"""
3193 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3194
3195 def SetInt(*args, **kwargs):
3196 """SetInt(self, int i)"""
3197 return _core_.CommandEvent_SetInt(*args, **kwargs)
3198
3199 def GetInt(*args, **kwargs):
3200 """GetInt(self) -> long"""
3201 return _core_.CommandEvent_GetInt(*args, **kwargs)
3202
3203 def Clone(*args, **kwargs):
3204 """Clone(self) -> Event"""
3205 return _core_.CommandEvent_Clone(*args, **kwargs)
3206
3207
3208class CommandEventPtr(CommandEvent):
3209 def __init__(self, this):
3210 self.this = this
3211 if not hasattr(self,"thisown"): self.thisown = 0
3212 self.__class__ = CommandEvent
3213_core_.CommandEvent_swigregister(CommandEventPtr)
3214
3215#---------------------------------------------------------------------------
3216
3217class NotifyEvent(CommandEvent):
3218 def __repr__(self):
3219 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3220 def __init__(self, *args, **kwargs):
3221 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
3222 newobj = _core_.new_NotifyEvent(*args, **kwargs)
3223 self.this = newobj.this
3224 self.thisown = 1
3225 del newobj.thisown
3226 def Veto(*args, **kwargs):
3227 """Veto(self)"""
3228 return _core_.NotifyEvent_Veto(*args, **kwargs)
3229
3230 def Allow(*args, **kwargs):
3231 """Allow(self)"""
3232 return _core_.NotifyEvent_Allow(*args, **kwargs)
3233
3234 def IsAllowed(*args, **kwargs):
3235 """IsAllowed(self) -> bool"""
3236 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
3237
3238
3239class NotifyEventPtr(NotifyEvent):
3240 def __init__(self, this):
3241 self.this = this
3242 if not hasattr(self,"thisown"): self.thisown = 0
3243 self.__class__ = NotifyEvent
3244_core_.NotifyEvent_swigregister(NotifyEventPtr)
3245
3246#---------------------------------------------------------------------------
3247
3248class ScrollEvent(CommandEvent):
3249 def __repr__(self):
3250 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3251 def __init__(self, *args, **kwargs):
3252 """
3253 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
3254 int orient=0) -> ScrollEvent
3255 """
3256 newobj = _core_.new_ScrollEvent(*args, **kwargs)
3257 self.this = newobj.this
3258 self.thisown = 1
3259 del newobj.thisown
3260 def GetOrientation(*args, **kwargs):
3261 """GetOrientation(self) -> int"""
3262 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
3263
3264 def GetPosition(*args, **kwargs):
3265 """GetPosition(self) -> int"""
3266 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
3267
3268 def SetOrientation(*args, **kwargs):
3269 """SetOrientation(self, int orient)"""
3270 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
3271
3272 def SetPosition(*args, **kwargs):
3273 """SetPosition(self, int pos)"""
3274 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
3275
3276
3277class ScrollEventPtr(ScrollEvent):
3278 def __init__(self, this):
3279 self.this = this
3280 if not hasattr(self,"thisown"): self.thisown = 0
3281 self.__class__ = ScrollEvent
3282_core_.ScrollEvent_swigregister(ScrollEventPtr)
3283
3284#---------------------------------------------------------------------------
3285
3286class ScrollWinEvent(Event):
3287 def __repr__(self):
3288 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3289 def __init__(self, *args, **kwargs):
3290 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
3291 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
3292 self.this = newobj.this
3293 self.thisown = 1
3294 del newobj.thisown
3295 def GetOrientation(*args, **kwargs):
3296 """GetOrientation(self) -> int"""
3297 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
3298
3299 def GetPosition(*args, **kwargs):
3300 """GetPosition(self) -> int"""
3301 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
3302
3303 def SetOrientation(*args, **kwargs):
3304 """SetOrientation(self, int orient)"""
3305 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
3306
3307 def SetPosition(*args, **kwargs):
3308 """SetPosition(self, int pos)"""
3309 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
3310
3311
3312class ScrollWinEventPtr(ScrollWinEvent):
3313 def __init__(self, this):
3314 self.this = this
3315 if not hasattr(self,"thisown"): self.thisown = 0
3316 self.__class__ = ScrollWinEvent
3317_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
3318
3319#---------------------------------------------------------------------------
3320
3321MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3322MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3323MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3324MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3325MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
3326class MouseEvent(Event):
3327 def __repr__(self):
3328 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3329 def __init__(self, *args, **kwargs):
3330 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
3331 newobj = _core_.new_MouseEvent(*args, **kwargs)
3332 self.this = newobj.this
3333 self.thisown = 1
3334 del newobj.thisown
3335 def IsButton(*args, **kwargs):
3336 """IsButton(self) -> bool"""
3337 return _core_.MouseEvent_IsButton(*args, **kwargs)
3338
3339 def ButtonDown(*args, **kwargs):
3340 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
3341 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
3342
3343 def ButtonDClick(*args, **kwargs):
3344 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
3345 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
3346
3347 def ButtonUp(*args, **kwargs):
3348 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
3349 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
3350
3351 def Button(*args, **kwargs):
3352 """Button(self, int but) -> bool"""
3353 return _core_.MouseEvent_Button(*args, **kwargs)
3354
3355 def ButtonIsDown(*args, **kwargs):
3356 """ButtonIsDown(self, int but) -> bool"""
3357 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
3358
3359 def GetButton(*args, **kwargs):
3360 """GetButton(self) -> int"""
3361 return _core_.MouseEvent_GetButton(*args, **kwargs)
3362
3363 def ControlDown(*args, **kwargs):
3364 """ControlDown(self) -> bool"""
3365 return _core_.MouseEvent_ControlDown(*args, **kwargs)
3366
3367 def MetaDown(*args, **kwargs):
3368 """MetaDown(self) -> bool"""
3369 return _core_.MouseEvent_MetaDown(*args, **kwargs)
3370
3371 def AltDown(*args, **kwargs):
3372 """AltDown(self) -> bool"""
3373 return _core_.MouseEvent_AltDown(*args, **kwargs)
3374
3375 def ShiftDown(*args, **kwargs):
3376 """ShiftDown(self) -> bool"""
3377 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
3378
3379 def LeftDown(*args, **kwargs):
3380 """LeftDown(self) -> bool"""
3381 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3382
3383 def MiddleDown(*args, **kwargs):
3384 """MiddleDown(self) -> bool"""
3385 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3386
3387 def RightDown(*args, **kwargs):
3388 """RightDown(self) -> bool"""
3389 return _core_.MouseEvent_RightDown(*args, **kwargs)
3390
3391 def LeftUp(*args, **kwargs):
3392 """LeftUp(self) -> bool"""
3393 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3394
3395 def MiddleUp(*args, **kwargs):
3396 """MiddleUp(self) -> bool"""
3397 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3398
3399 def RightUp(*args, **kwargs):
3400 """RightUp(self) -> bool"""
3401 return _core_.MouseEvent_RightUp(*args, **kwargs)
3402
3403 def LeftDClick(*args, **kwargs):
3404 """LeftDClick(self) -> bool"""
3405 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3406
3407 def MiddleDClick(*args, **kwargs):
3408 """MiddleDClick(self) -> bool"""
3409 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3410
3411 def RightDClick(*args, **kwargs):
3412 """RightDClick(self) -> bool"""
3413 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3414
3415 def LeftIsDown(*args, **kwargs):
3416 """LeftIsDown(self) -> bool"""
3417 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3418
3419 def MiddleIsDown(*args, **kwargs):
3420 """MiddleIsDown(self) -> bool"""
3421 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3422
3423 def RightIsDown(*args, **kwargs):
3424 """RightIsDown(self) -> bool"""
3425 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3426
3427 def Dragging(*args, **kwargs):
3428 """Dragging(self) -> bool"""
3429 return _core_.MouseEvent_Dragging(*args, **kwargs)
3430
3431 def Moving(*args, **kwargs):
3432 """Moving(self) -> bool"""
3433 return _core_.MouseEvent_Moving(*args, **kwargs)
3434
3435 def Entering(*args, **kwargs):
3436 """Entering(self) -> bool"""
3437 return _core_.MouseEvent_Entering(*args, **kwargs)
3438
3439 def Leaving(*args, **kwargs):
3440 """Leaving(self) -> bool"""
3441 return _core_.MouseEvent_Leaving(*args, **kwargs)
3442
3443 def GetPosition(*args, **kwargs):
3444 """
3445 GetPosition(self) -> Point
3446
15817c7e
RD
3447 Returns the position of the mouse in window coordinates when the event
3448 happened.
d55e5bfc
RD
3449 """
3450 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3451
3452 def GetPositionTuple(*args, **kwargs):
3453 """
3454 GetPositionTuple() -> (x,y)
3455
15817c7e
RD
3456 Returns the position of the mouse in window coordinates when the event
3457 happened.
d55e5bfc
RD
3458 """
3459 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3460
3461 def GetLogicalPosition(*args, **kwargs):
3462 """GetLogicalPosition(self, DC dc) -> Point"""
3463 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3464
3465 def GetX(*args, **kwargs):
3466 """GetX(self) -> int"""
3467 return _core_.MouseEvent_GetX(*args, **kwargs)
3468
3469 def GetY(*args, **kwargs):
3470 """GetY(self) -> int"""
3471 return _core_.MouseEvent_GetY(*args, **kwargs)
3472
3473 def GetWheelRotation(*args, **kwargs):
3474 """GetWheelRotation(self) -> int"""
3475 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3476
3477 def GetWheelDelta(*args, **kwargs):
3478 """GetWheelDelta(self) -> int"""
3479 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3480
3481 def GetLinesPerAction(*args, **kwargs):
3482 """GetLinesPerAction(self) -> int"""
3483 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3484
3485 def IsPageScroll(*args, **kwargs):
3486 """IsPageScroll(self) -> bool"""
3487 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3488
3489 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3490 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3491 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3492 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3493 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3494 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3495 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3496 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3497 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3498 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3499 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3500 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3501
3502class MouseEventPtr(MouseEvent):
3503 def __init__(self, this):
3504 self.this = this
3505 if not hasattr(self,"thisown"): self.thisown = 0
3506 self.__class__ = MouseEvent
3507_core_.MouseEvent_swigregister(MouseEventPtr)
3508
3509#---------------------------------------------------------------------------
3510
3511class SetCursorEvent(Event):
3512 def __repr__(self):
3513 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3514 def __init__(self, *args, **kwargs):
3515 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3516 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3517 self.this = newobj.this
3518 self.thisown = 1
3519 del newobj.thisown
3520 def GetX(*args, **kwargs):
3521 """GetX(self) -> int"""
3522 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3523
3524 def GetY(*args, **kwargs):
3525 """GetY(self) -> int"""
3526 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3527
3528 def SetCursor(*args, **kwargs):
3529 """SetCursor(self, Cursor cursor)"""
3530 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3531
3532 def GetCursor(*args, **kwargs):
3533 """GetCursor(self) -> Cursor"""
3534 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3535
3536 def HasCursor(*args, **kwargs):
3537 """HasCursor(self) -> bool"""
3538 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3539
3540
3541class SetCursorEventPtr(SetCursorEvent):
3542 def __init__(self, this):
3543 self.this = this
3544 if not hasattr(self,"thisown"): self.thisown = 0
3545 self.__class__ = SetCursorEvent
3546_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3547
3548#---------------------------------------------------------------------------
3549
3550class KeyEvent(Event):
3551 def __repr__(self):
3552 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3553 def __init__(self, *args, **kwargs):
3554 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3555 newobj = _core_.new_KeyEvent(*args, **kwargs)
3556 self.this = newobj.this
3557 self.thisown = 1
3558 del newobj.thisown
3559 def ControlDown(*args, **kwargs):
3560 """ControlDown(self) -> bool"""
3561 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3562
3563 def MetaDown(*args, **kwargs):
3564 """MetaDown(self) -> bool"""
3565 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3566
3567 def AltDown(*args, **kwargs):
3568 """AltDown(self) -> bool"""
3569 return _core_.KeyEvent_AltDown(*args, **kwargs)
3570
3571 def ShiftDown(*args, **kwargs):
3572 """ShiftDown(self) -> bool"""
3573 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3574
3575 def HasModifiers(*args, **kwargs):
3576 """HasModifiers(self) -> bool"""
3577 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3578
3579 def GetKeyCode(*args, **kwargs):
3580 """GetKeyCode(self) -> int"""
3581 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3582
3583 KeyCode = GetKeyCode
bb4524c4
RD
3584 def GetUnicodeKey(*args, **kwargs):
3585 """GetUnicodeKey(self) -> int"""
3586 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 3587
bb4524c4 3588 GetUniChar = GetUnicodeKey
d55e5bfc
RD
3589 def GetRawKeyCode(*args, **kwargs):
3590 """GetRawKeyCode(self) -> unsigned int"""
3591 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3592
3593 def GetRawKeyFlags(*args, **kwargs):
3594 """GetRawKeyFlags(self) -> unsigned int"""
3595 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3596
3597 def GetPosition(*args, **kwargs):
3598 """
3599 GetPosition(self) -> Point
3600
3601 Find the position of the event.
3602 """
3603 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3604
3605 def GetPositionTuple(*args, **kwargs):
3606 """
3607 GetPositionTuple() -> (x,y)
3608
3609 Find the position of the event.
3610 """
3611 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3612
3613 def GetX(*args, **kwargs):
3614 """GetX(self) -> int"""
3615 return _core_.KeyEvent_GetX(*args, **kwargs)
3616
3617 def GetY(*args, **kwargs):
3618 """GetY(self) -> int"""
3619 return _core_.KeyEvent_GetY(*args, **kwargs)
3620
3621 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3622 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3623 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3624 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3625 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3626 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3627 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3628 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3629 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3630 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3631
3632class KeyEventPtr(KeyEvent):
3633 def __init__(self, this):
3634 self.this = this
3635 if not hasattr(self,"thisown"): self.thisown = 0
3636 self.__class__ = KeyEvent
3637_core_.KeyEvent_swigregister(KeyEventPtr)
3638
3639#---------------------------------------------------------------------------
3640
3641class SizeEvent(Event):
3642 def __repr__(self):
3643 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3644 def __init__(self, *args, **kwargs):
3645 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3646 newobj = _core_.new_SizeEvent(*args, **kwargs)
3647 self.this = newobj.this
3648 self.thisown = 1
3649 del newobj.thisown
3650 def GetSize(*args, **kwargs):
3651 """GetSize(self) -> Size"""
3652 return _core_.SizeEvent_GetSize(*args, **kwargs)
3653
3654 def GetRect(*args, **kwargs):
3655 """GetRect(self) -> Rect"""
3656 return _core_.SizeEvent_GetRect(*args, **kwargs)
3657
3658 def SetRect(*args, **kwargs):
3659 """SetRect(self, Rect rect)"""
3660 return _core_.SizeEvent_SetRect(*args, **kwargs)
3661
3662 def SetSize(*args, **kwargs):
3663 """SetSize(self, Size size)"""
3664 return _core_.SizeEvent_SetSize(*args, **kwargs)
3665
3666 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3667 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
3668
3669class SizeEventPtr(SizeEvent):
3670 def __init__(self, this):
3671 self.this = this
3672 if not hasattr(self,"thisown"): self.thisown = 0
3673 self.__class__ = SizeEvent
3674_core_.SizeEvent_swigregister(SizeEventPtr)
3675
3676#---------------------------------------------------------------------------
3677
3678class MoveEvent(Event):
3679 def __repr__(self):
3680 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3681 def __init__(self, *args, **kwargs):
3682 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
3683 newobj = _core_.new_MoveEvent(*args, **kwargs)
3684 self.this = newobj.this
3685 self.thisown = 1
3686 del newobj.thisown
3687 def GetPosition(*args, **kwargs):
3688 """GetPosition(self) -> Point"""
3689 return _core_.MoveEvent_GetPosition(*args, **kwargs)
3690
3691 def GetRect(*args, **kwargs):
3692 """GetRect(self) -> Rect"""
3693 return _core_.MoveEvent_GetRect(*args, **kwargs)
3694
3695 def SetRect(*args, **kwargs):
3696 """SetRect(self, Rect rect)"""
3697 return _core_.MoveEvent_SetRect(*args, **kwargs)
3698
3699 def SetPosition(*args, **kwargs):
3700 """SetPosition(self, Point pos)"""
3701 return _core_.MoveEvent_SetPosition(*args, **kwargs)
3702
3703 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3704 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
3705
3706class MoveEventPtr(MoveEvent):
3707 def __init__(self, this):
3708 self.this = this
3709 if not hasattr(self,"thisown"): self.thisown = 0
3710 self.__class__ = MoveEvent
3711_core_.MoveEvent_swigregister(MoveEventPtr)
3712
3713#---------------------------------------------------------------------------
3714
3715class PaintEvent(Event):
3716 def __repr__(self):
3717 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3718 def __init__(self, *args, **kwargs):
3719 """__init__(self, int Id=0) -> PaintEvent"""
3720 newobj = _core_.new_PaintEvent(*args, **kwargs)
3721 self.this = newobj.this
3722 self.thisown = 1
3723 del newobj.thisown
3724
3725class PaintEventPtr(PaintEvent):
3726 def __init__(self, this):
3727 self.this = this
3728 if not hasattr(self,"thisown"): self.thisown = 0
3729 self.__class__ = PaintEvent
3730_core_.PaintEvent_swigregister(PaintEventPtr)
3731
3732class NcPaintEvent(Event):
3733 def __repr__(self):
3734 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3735 def __init__(self, *args, **kwargs):
3736 """__init__(self, int winid=0) -> NcPaintEvent"""
3737 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
3738 self.this = newobj.this
3739 self.thisown = 1
3740 del newobj.thisown
3741
3742class NcPaintEventPtr(NcPaintEvent):
3743 def __init__(self, this):
3744 self.this = this
3745 if not hasattr(self,"thisown"): self.thisown = 0
3746 self.__class__ = NcPaintEvent
3747_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
3748
3749#---------------------------------------------------------------------------
3750
3751class EraseEvent(Event):
3752 def __repr__(self):
3753 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3754 def __init__(self, *args, **kwargs):
3755 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
3756 newobj = _core_.new_EraseEvent(*args, **kwargs)
3757 self.this = newobj.this
3758 self.thisown = 1
3759 del newobj.thisown
3760 def GetDC(*args, **kwargs):
3761 """GetDC(self) -> DC"""
3762 return _core_.EraseEvent_GetDC(*args, **kwargs)
3763
3764
3765class EraseEventPtr(EraseEvent):
3766 def __init__(self, this):
3767 self.this = this
3768 if not hasattr(self,"thisown"): self.thisown = 0
3769 self.__class__ = EraseEvent
3770_core_.EraseEvent_swigregister(EraseEventPtr)
3771
3772#---------------------------------------------------------------------------
3773
3774class FocusEvent(Event):
3775 def __repr__(self):
3776 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3777 def __init__(self, *args, **kwargs):
3778 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
3779 newobj = _core_.new_FocusEvent(*args, **kwargs)
3780 self.this = newobj.this
3781 self.thisown = 1
3782 del newobj.thisown
3783 def GetWindow(*args, **kwargs):
3784 """GetWindow(self) -> Window"""
3785 return _core_.FocusEvent_GetWindow(*args, **kwargs)
3786
3787 def SetWindow(*args, **kwargs):
3788 """SetWindow(self, Window win)"""
3789 return _core_.FocusEvent_SetWindow(*args, **kwargs)
3790
3791
3792class FocusEventPtr(FocusEvent):
3793 def __init__(self, this):
3794 self.this = this
3795 if not hasattr(self,"thisown"): self.thisown = 0
3796 self.__class__ = FocusEvent
3797_core_.FocusEvent_swigregister(FocusEventPtr)
3798
3799#---------------------------------------------------------------------------
3800
3801class ChildFocusEvent(CommandEvent):
3802 def __repr__(self):
3803 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3804 def __init__(self, *args, **kwargs):
3805 """__init__(self, Window win=None) -> ChildFocusEvent"""
3806 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
3807 self.this = newobj.this
3808 self.thisown = 1
3809 del newobj.thisown
3810 def GetWindow(*args, **kwargs):
3811 """GetWindow(self) -> Window"""
3812 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
3813
3814
3815class ChildFocusEventPtr(ChildFocusEvent):
3816 def __init__(self, this):
3817 self.this = this
3818 if not hasattr(self,"thisown"): self.thisown = 0
3819 self.__class__ = ChildFocusEvent
3820_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
3821
3822#---------------------------------------------------------------------------
3823
3824class ActivateEvent(Event):
3825 def __repr__(self):
3826 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3827 def __init__(self, *args, **kwargs):
3828 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
3829 newobj = _core_.new_ActivateEvent(*args, **kwargs)
3830 self.this = newobj.this
3831 self.thisown = 1
3832 del newobj.thisown
3833 def GetActive(*args, **kwargs):
3834 """GetActive(self) -> bool"""
3835 return _core_.ActivateEvent_GetActive(*args, **kwargs)
3836
3837
3838class ActivateEventPtr(ActivateEvent):
3839 def __init__(self, this):
3840 self.this = this
3841 if not hasattr(self,"thisown"): self.thisown = 0
3842 self.__class__ = ActivateEvent
3843_core_.ActivateEvent_swigregister(ActivateEventPtr)
3844
3845#---------------------------------------------------------------------------
3846
3847class InitDialogEvent(Event):
3848 def __repr__(self):
3849 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3850 def __init__(self, *args, **kwargs):
3851 """__init__(self, int Id=0) -> InitDialogEvent"""
3852 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
3853 self.this = newobj.this
3854 self.thisown = 1
3855 del newobj.thisown
3856
3857class InitDialogEventPtr(InitDialogEvent):
3858 def __init__(self, this):
3859 self.this = this
3860 if not hasattr(self,"thisown"): self.thisown = 0
3861 self.__class__ = InitDialogEvent
3862_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
3863
3864#---------------------------------------------------------------------------
3865
3866class MenuEvent(Event):
3867 def __repr__(self):
3868 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3869 def __init__(self, *args, **kwargs):
3870 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
3871 newobj = _core_.new_MenuEvent(*args, **kwargs)
3872 self.this = newobj.this
3873 self.thisown = 1
3874 del newobj.thisown
3875 def GetMenuId(*args, **kwargs):
3876 """GetMenuId(self) -> int"""
3877 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
3878
3879 def IsPopup(*args, **kwargs):
3880 """IsPopup(self) -> bool"""
3881 return _core_.MenuEvent_IsPopup(*args, **kwargs)
3882
3883 def GetMenu(*args, **kwargs):
3884 """GetMenu(self) -> Menu"""
3885 return _core_.MenuEvent_GetMenu(*args, **kwargs)
3886
3887
3888class MenuEventPtr(MenuEvent):
3889 def __init__(self, this):
3890 self.this = this
3891 if not hasattr(self,"thisown"): self.thisown = 0
3892 self.__class__ = MenuEvent
3893_core_.MenuEvent_swigregister(MenuEventPtr)
3894
3895#---------------------------------------------------------------------------
3896
3897class CloseEvent(Event):
3898 def __repr__(self):
3899 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3900 def __init__(self, *args, **kwargs):
3901 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
3902 newobj = _core_.new_CloseEvent(*args, **kwargs)
3903 self.this = newobj.this
3904 self.thisown = 1
3905 del newobj.thisown
3906 def SetLoggingOff(*args, **kwargs):
3907 """SetLoggingOff(self, bool logOff)"""
3908 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
3909
3910 def GetLoggingOff(*args, **kwargs):
3911 """GetLoggingOff(self) -> bool"""
3912 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
3913
3914 def Veto(*args, **kwargs):
3915 """Veto(self, bool veto=True)"""
3916 return _core_.CloseEvent_Veto(*args, **kwargs)
3917
3918 def SetCanVeto(*args, **kwargs):
3919 """SetCanVeto(self, bool canVeto)"""
3920 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
3921
3922 def CanVeto(*args, **kwargs):
3923 """CanVeto(self) -> bool"""
3924 return _core_.CloseEvent_CanVeto(*args, **kwargs)
3925
3926 def GetVeto(*args, **kwargs):
3927 """GetVeto(self) -> bool"""
3928 return _core_.CloseEvent_GetVeto(*args, **kwargs)
3929
3930
3931class CloseEventPtr(CloseEvent):
3932 def __init__(self, this):
3933 self.this = this
3934 if not hasattr(self,"thisown"): self.thisown = 0
3935 self.__class__ = CloseEvent
3936_core_.CloseEvent_swigregister(CloseEventPtr)
3937
3938#---------------------------------------------------------------------------
3939
3940class ShowEvent(Event):
3941 def __repr__(self):
3942 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3943 def __init__(self, *args, **kwargs):
3944 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
3945 newobj = _core_.new_ShowEvent(*args, **kwargs)
3946 self.this = newobj.this
3947 self.thisown = 1
3948 del newobj.thisown
3949 def SetShow(*args, **kwargs):
3950 """SetShow(self, bool show)"""
3951 return _core_.ShowEvent_SetShow(*args, **kwargs)
3952
3953 def GetShow(*args, **kwargs):
3954 """GetShow(self) -> bool"""
3955 return _core_.ShowEvent_GetShow(*args, **kwargs)
3956
3957
3958class ShowEventPtr(ShowEvent):
3959 def __init__(self, this):
3960 self.this = this
3961 if not hasattr(self,"thisown"): self.thisown = 0
3962 self.__class__ = ShowEvent
3963_core_.ShowEvent_swigregister(ShowEventPtr)
3964
3965#---------------------------------------------------------------------------
3966
3967class IconizeEvent(Event):
3968 def __repr__(self):
3969 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3970 def __init__(self, *args, **kwargs):
3971 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
3972 newobj = _core_.new_IconizeEvent(*args, **kwargs)
3973 self.this = newobj.this
3974 self.thisown = 1
3975 del newobj.thisown
3976 def Iconized(*args, **kwargs):
3977 """Iconized(self) -> bool"""
3978 return _core_.IconizeEvent_Iconized(*args, **kwargs)
3979
3980
3981class IconizeEventPtr(IconizeEvent):
3982 def __init__(self, this):
3983 self.this = this
3984 if not hasattr(self,"thisown"): self.thisown = 0
3985 self.__class__ = IconizeEvent
3986_core_.IconizeEvent_swigregister(IconizeEventPtr)
3987
3988#---------------------------------------------------------------------------
3989
3990class MaximizeEvent(Event):
3991 def __repr__(self):
3992 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3993 def __init__(self, *args, **kwargs):
3994 """__init__(self, int id=0) -> MaximizeEvent"""
3995 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
3996 self.this = newobj.this
3997 self.thisown = 1
3998 del newobj.thisown
3999
4000class MaximizeEventPtr(MaximizeEvent):
4001 def __init__(self, this):
4002 self.this = this
4003 if not hasattr(self,"thisown"): self.thisown = 0
4004 self.__class__ = MaximizeEvent
4005_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4006
4007#---------------------------------------------------------------------------
4008
4009class DropFilesEvent(Event):
4010 def __init__(self): raise RuntimeError, "No constructor defined"
4011 def __repr__(self):
4012 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4013 def GetPosition(*args, **kwargs):
4014 """GetPosition(self) -> Point"""
4015 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4016
4017 def GetNumberOfFiles(*args, **kwargs):
4018 """GetNumberOfFiles(self) -> int"""
4019 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4020
4021 def GetFiles(*args, **kwargs):
4022 """GetFiles(self) -> PyObject"""
4023 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4024
4025
4026class DropFilesEventPtr(DropFilesEvent):
4027 def __init__(self, this):
4028 self.this = this
4029 if not hasattr(self,"thisown"): self.thisown = 0
4030 self.__class__ = DropFilesEvent
4031_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4032
4033#---------------------------------------------------------------------------
4034
4035UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4036UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4037class UpdateUIEvent(CommandEvent):
4038 def __repr__(self):
4039 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4040 def __init__(self, *args, **kwargs):
4041 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4042 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4043 self.this = newobj.this
4044 self.thisown = 1
4045 del newobj.thisown
4046 def GetChecked(*args, **kwargs):
4047 """GetChecked(self) -> bool"""
4048 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4049
4050 def GetEnabled(*args, **kwargs):
4051 """GetEnabled(self) -> bool"""
4052 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4053
4054 def GetText(*args, **kwargs):
4055 """GetText(self) -> String"""
4056 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4057
4058 def GetSetText(*args, **kwargs):
4059 """GetSetText(self) -> bool"""
4060 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4061
4062 def GetSetChecked(*args, **kwargs):
4063 """GetSetChecked(self) -> bool"""
4064 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4065
4066 def GetSetEnabled(*args, **kwargs):
4067 """GetSetEnabled(self) -> bool"""
4068 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4069
4070 def Check(*args, **kwargs):
4071 """Check(self, bool check)"""
4072 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4073
4074 def Enable(*args, **kwargs):
4075 """Enable(self, bool enable)"""
4076 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4077
4078 def SetText(*args, **kwargs):
4079 """SetText(self, String text)"""
4080 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4081
4082 def SetUpdateInterval(*args, **kwargs):
d6c14a4c 4083 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD
4084 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4085
4086 SetUpdateInterval = staticmethod(SetUpdateInterval)
4087 def GetUpdateInterval(*args, **kwargs):
d6c14a4c 4088 """GetUpdateInterval() -> long"""
d55e5bfc
RD
4089 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4090
4091 GetUpdateInterval = staticmethod(GetUpdateInterval)
4092 def CanUpdate(*args, **kwargs):
d6c14a4c 4093 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD
4094 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4095
4096 CanUpdate = staticmethod(CanUpdate)
4097 def ResetUpdateTime(*args, **kwargs):
d6c14a4c 4098 """ResetUpdateTime()"""
d55e5bfc
RD
4099 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4100
4101 ResetUpdateTime = staticmethod(ResetUpdateTime)
4102 def SetMode(*args, **kwargs):
d6c14a4c 4103 """SetMode(int mode)"""
d55e5bfc
RD
4104 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4105
4106 SetMode = staticmethod(SetMode)
4107 def GetMode(*args, **kwargs):
d6c14a4c 4108 """GetMode() -> int"""
d55e5bfc
RD
4109 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4110
4111 GetMode = staticmethod(GetMode)
4112
4113class UpdateUIEventPtr(UpdateUIEvent):
4114 def __init__(self, this):
4115 self.this = this
4116 if not hasattr(self,"thisown"): self.thisown = 0
4117 self.__class__ = UpdateUIEvent
4118_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4119
4120def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4121 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4122 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4123
4124def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4125 """UpdateUIEvent_GetUpdateInterval() -> long"""
4126 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4127
4128def UpdateUIEvent_CanUpdate(*args, **kwargs):
4129 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4130 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4131
4132def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4133 """UpdateUIEvent_ResetUpdateTime()"""
4134 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4135
4136def UpdateUIEvent_SetMode(*args, **kwargs):
4137 """UpdateUIEvent_SetMode(int mode)"""
4138 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4139
4140def UpdateUIEvent_GetMode(*args, **kwargs):
4141 """UpdateUIEvent_GetMode() -> int"""
4142 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4143
4144#---------------------------------------------------------------------------
4145
4146class SysColourChangedEvent(Event):
4147 def __repr__(self):
4148 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4149 def __init__(self, *args, **kwargs):
4150 """__init__(self) -> SysColourChangedEvent"""
4151 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4152 self.this = newobj.this
4153 self.thisown = 1
4154 del newobj.thisown
4155
4156class SysColourChangedEventPtr(SysColourChangedEvent):
4157 def __init__(self, this):
4158 self.this = this
4159 if not hasattr(self,"thisown"): self.thisown = 0
4160 self.__class__ = SysColourChangedEvent
4161_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4162
4163#---------------------------------------------------------------------------
4164
4165class MouseCaptureChangedEvent(Event):
4166 def __repr__(self):
4167 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4168 def __init__(self, *args, **kwargs):
4169 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4170 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4171 self.this = newobj.this
4172 self.thisown = 1
4173 del newobj.thisown
4174 def GetCapturedWindow(*args, **kwargs):
4175 """GetCapturedWindow(self) -> Window"""
4176 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4177
4178
4179class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4180 def __init__(self, this):
4181 self.this = this
4182 if not hasattr(self,"thisown"): self.thisown = 0
4183 self.__class__ = MouseCaptureChangedEvent
4184_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4185
4186#---------------------------------------------------------------------------
4187
4188class DisplayChangedEvent(Event):
4189 def __repr__(self):
4190 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4191 def __init__(self, *args, **kwargs):
4192 """__init__(self) -> DisplayChangedEvent"""
4193 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4194 self.this = newobj.this
4195 self.thisown = 1
4196 del newobj.thisown
4197
4198class DisplayChangedEventPtr(DisplayChangedEvent):
4199 def __init__(self, this):
4200 self.this = this
4201 if not hasattr(self,"thisown"): self.thisown = 0
4202 self.__class__ = DisplayChangedEvent
4203_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4204
4205#---------------------------------------------------------------------------
4206
4207class PaletteChangedEvent(Event):
4208 def __repr__(self):
4209 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4210 def __init__(self, *args, **kwargs):
4211 """__init__(self, int id=0) -> PaletteChangedEvent"""
4212 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4213 self.this = newobj.this
4214 self.thisown = 1
4215 del newobj.thisown
4216 def SetChangedWindow(*args, **kwargs):
4217 """SetChangedWindow(self, Window win)"""
4218 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4219
4220 def GetChangedWindow(*args, **kwargs):
4221 """GetChangedWindow(self) -> Window"""
4222 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4223
4224
4225class PaletteChangedEventPtr(PaletteChangedEvent):
4226 def __init__(self, this):
4227 self.this = this
4228 if not hasattr(self,"thisown"): self.thisown = 0
4229 self.__class__ = PaletteChangedEvent
4230_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4231
4232#---------------------------------------------------------------------------
4233
4234class QueryNewPaletteEvent(Event):
4235 def __repr__(self):
4236 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4237 def __init__(self, *args, **kwargs):
4238 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4239 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4240 self.this = newobj.this
4241 self.thisown = 1
4242 del newobj.thisown
4243 def SetPaletteRealized(*args, **kwargs):
4244 """SetPaletteRealized(self, bool realized)"""
4245 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4246
4247 def GetPaletteRealized(*args, **kwargs):
4248 """GetPaletteRealized(self) -> bool"""
4249 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4250
4251
4252class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4253 def __init__(self, this):
4254 self.this = this
4255 if not hasattr(self,"thisown"): self.thisown = 0
4256 self.__class__ = QueryNewPaletteEvent
4257_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4258
4259#---------------------------------------------------------------------------
4260
4261class NavigationKeyEvent(Event):
4262 def __repr__(self):
4263 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4264 def __init__(self, *args, **kwargs):
4265 """__init__(self) -> NavigationKeyEvent"""
4266 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4267 self.this = newobj.this
4268 self.thisown = 1
4269 del newobj.thisown
4270 def GetDirection(*args, **kwargs):
4271 """GetDirection(self) -> bool"""
4272 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4273
4274 def SetDirection(*args, **kwargs):
908b74cd 4275 """SetDirection(self, bool forward)"""
d55e5bfc
RD
4276 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4277
4278 def IsWindowChange(*args, **kwargs):
4279 """IsWindowChange(self) -> bool"""
4280 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4281
4282 def SetWindowChange(*args, **kwargs):
908b74cd 4283 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD
4284 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4285
908b74cd
RD
4286 def SetFlags(*args, **kwargs):
4287 """SetFlags(self, long flags)"""
4288 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4289
d55e5bfc
RD
4290 def GetCurrentFocus(*args, **kwargs):
4291 """GetCurrentFocus(self) -> Window"""
4292 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4293
4294 def SetCurrentFocus(*args, **kwargs):
4295 """SetCurrentFocus(self, Window win)"""
4296 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4297
908b74cd
RD
4298 IsForward = _core_.NavigationKeyEvent_IsForward
4299 WinChange = _core_.NavigationKeyEvent_WinChange
d55e5bfc
RD
4300
4301class NavigationKeyEventPtr(NavigationKeyEvent):
4302 def __init__(self, this):
4303 self.this = this
4304 if not hasattr(self,"thisown"): self.thisown = 0
4305 self.__class__ = NavigationKeyEvent
4306_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4307
4308#---------------------------------------------------------------------------
4309
4310class WindowCreateEvent(CommandEvent):
4311 def __repr__(self):
4312 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4313 def __init__(self, *args, **kwargs):
4314 """__init__(self, Window win=None) -> WindowCreateEvent"""
4315 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4316 self.this = newobj.this
4317 self.thisown = 1
4318 del newobj.thisown
4319 def GetWindow(*args, **kwargs):
4320 """GetWindow(self) -> Window"""
4321 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4322
4323
4324class WindowCreateEventPtr(WindowCreateEvent):
4325 def __init__(self, this):
4326 self.this = this
4327 if not hasattr(self,"thisown"): self.thisown = 0
4328 self.__class__ = WindowCreateEvent
4329_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4330
4331class WindowDestroyEvent(CommandEvent):
4332 def __repr__(self):
4333 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4334 def __init__(self, *args, **kwargs):
4335 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4336 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4337 self.this = newobj.this
4338 self.thisown = 1
4339 del newobj.thisown
4340 def GetWindow(*args, **kwargs):
4341 """GetWindow(self) -> Window"""
4342 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4343
4344
4345class WindowDestroyEventPtr(WindowDestroyEvent):
4346 def __init__(self, this):
4347 self.this = this
4348 if not hasattr(self,"thisown"): self.thisown = 0
4349 self.__class__ = WindowDestroyEvent
4350_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4351
4352#---------------------------------------------------------------------------
4353
4354class ContextMenuEvent(CommandEvent):
4355 def __repr__(self):
4356 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4357 def __init__(self, *args, **kwargs):
4358 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4359 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4360 self.this = newobj.this
4361 self.thisown = 1
4362 del newobj.thisown
4363 def GetPosition(*args, **kwargs):
4364 """GetPosition(self) -> Point"""
4365 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4366
4367 def SetPosition(*args, **kwargs):
4368 """SetPosition(self, Point pos)"""
4369 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4370
4371
4372class ContextMenuEventPtr(ContextMenuEvent):
4373 def __init__(self, this):
4374 self.this = this
4375 if not hasattr(self,"thisown"): self.thisown = 0
4376 self.__class__ = ContextMenuEvent
4377_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4378
4379#---------------------------------------------------------------------------
4380
4381IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4382IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4383class IdleEvent(Event):
4384 def __repr__(self):
4385 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4386 def __init__(self, *args, **kwargs):
4387 """__init__(self) -> IdleEvent"""
4388 newobj = _core_.new_IdleEvent(*args, **kwargs)
4389 self.this = newobj.this
4390 self.thisown = 1
4391 del newobj.thisown
4392 def RequestMore(*args, **kwargs):
4393 """RequestMore(self, bool needMore=True)"""
4394 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4395
4396 def MoreRequested(*args, **kwargs):
4397 """MoreRequested(self) -> bool"""
4398 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4399
4400 def SetMode(*args, **kwargs):
d6c14a4c 4401 """SetMode(int mode)"""
d55e5bfc
RD
4402 return _core_.IdleEvent_SetMode(*args, **kwargs)
4403
4404 SetMode = staticmethod(SetMode)
4405 def GetMode(*args, **kwargs):
d6c14a4c 4406 """GetMode() -> int"""
d55e5bfc
RD
4407 return _core_.IdleEvent_GetMode(*args, **kwargs)
4408
4409 GetMode = staticmethod(GetMode)
4410 def CanSend(*args, **kwargs):
d6c14a4c 4411 """CanSend(Window win) -> bool"""
d55e5bfc
RD
4412 return _core_.IdleEvent_CanSend(*args, **kwargs)
4413
4414 CanSend = staticmethod(CanSend)
4415
4416class IdleEventPtr(IdleEvent):
4417 def __init__(self, this):
4418 self.this = this
4419 if not hasattr(self,"thisown"): self.thisown = 0
4420 self.__class__ = IdleEvent
4421_core_.IdleEvent_swigregister(IdleEventPtr)
4422
4423def IdleEvent_SetMode(*args, **kwargs):
4424 """IdleEvent_SetMode(int mode)"""
4425 return _core_.IdleEvent_SetMode(*args, **kwargs)
4426
4427def IdleEvent_GetMode(*args, **kwargs):
4428 """IdleEvent_GetMode() -> int"""
4429 return _core_.IdleEvent_GetMode(*args, **kwargs)
4430
4431def IdleEvent_CanSend(*args, **kwargs):
4432 """IdleEvent_CanSend(Window win) -> bool"""
4433 return _core_.IdleEvent_CanSend(*args, **kwargs)
4434
4435#---------------------------------------------------------------------------
4436
4437class PyEvent(Event):
4438 def __repr__(self):
4439 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4440 def __init__(self, *args, **kwargs):
4441 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4442 newobj = _core_.new_PyEvent(*args, **kwargs)
4443 self.this = newobj.this
4444 self.thisown = 1
4445 del newobj.thisown
4446 self.SetSelf(self)
4447
4448 def __del__(self, destroy=_core_.delete_PyEvent):
4449 """__del__(self)"""
4450 try:
4451 if self.thisown: destroy(self)
4452 except: pass
4453
4454 def SetSelf(*args, **kwargs):
4455 """SetSelf(self, PyObject self)"""
4456 return _core_.PyEvent_SetSelf(*args, **kwargs)
4457
4458 def GetSelf(*args, **kwargs):
4459 """GetSelf(self) -> PyObject"""
4460 return _core_.PyEvent_GetSelf(*args, **kwargs)
4461
4462
4463class PyEventPtr(PyEvent):
4464 def __init__(self, this):
4465 self.this = this
4466 if not hasattr(self,"thisown"): self.thisown = 0
4467 self.__class__ = PyEvent
4468_core_.PyEvent_swigregister(PyEventPtr)
4469
4470class PyCommandEvent(CommandEvent):
4471 def __repr__(self):
4472 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4473 def __init__(self, *args, **kwargs):
4474 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4475 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4476 self.this = newobj.this
4477 self.thisown = 1
4478 del newobj.thisown
4479 self.SetSelf(self)
4480
4481 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4482 """__del__(self)"""
4483 try:
4484 if self.thisown: destroy(self)
4485 except: pass
4486
4487 def SetSelf(*args, **kwargs):
4488 """SetSelf(self, PyObject self)"""
4489 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4490
4491 def GetSelf(*args, **kwargs):
4492 """GetSelf(self) -> PyObject"""
4493 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4494
4495
4496class PyCommandEventPtr(PyCommandEvent):
4497 def __init__(self, this):
4498 self.this = this
4499 if not hasattr(self,"thisown"): self.thisown = 0
4500 self.__class__ = PyCommandEvent
4501_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4502
4503#---------------------------------------------------------------------------
4504
4505PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4506PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4507PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4508PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4509PRINT_WINDOWS = _core_.PRINT_WINDOWS
4510PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4511class PyApp(EvtHandler):
d6c14a4c
RD
4512 """
4513 The ``wx.PyApp`` class is an *implementation detail*, please use the
4514 `wx.App` class (or some other derived class) instead.
4515 """
d55e5bfc
RD
4516 def __repr__(self):
4517 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4518 def __init__(self, *args, **kwargs):
4519 """
4520 __init__(self) -> PyApp
4521
4522 Create a new application object, starting the bootstrap process.
4523 """
4524 newobj = _core_.new_PyApp(*args, **kwargs)
4525 self.this = newobj.this
4526 self.thisown = 1
4527 del newobj.thisown
4528 self._setCallbackInfo(self, PyApp)
4529 self._setOORInfo(self)
4530
4531 def __del__(self, destroy=_core_.delete_PyApp):
4532 """__del__(self)"""
4533 try:
4534 if self.thisown: destroy(self)
4535 except: pass
4536
4537 def _setCallbackInfo(*args, **kwargs):
4538 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4539 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4540
4541 def GetAppName(*args, **kwargs):
4542 """
4543 GetAppName(self) -> String
4544
4545 Get the application name.
4546 """
4547 return _core_.PyApp_GetAppName(*args, **kwargs)
4548
4549 def SetAppName(*args, **kwargs):
4550 """
4551 SetAppName(self, String name)
4552
d6c14a4c
RD
4553 Set the application name. This value may be used automatically by
4554 `wx.Config` and such.
d55e5bfc
RD
4555 """
4556 return _core_.PyApp_SetAppName(*args, **kwargs)
4557
4558 def GetClassName(*args, **kwargs):
4559 """
4560 GetClassName(self) -> String
4561
4562 Get the application's class name.
4563 """
4564 return _core_.PyApp_GetClassName(*args, **kwargs)
4565
4566 def SetClassName(*args, **kwargs):
4567 """
4568 SetClassName(self, String name)
4569
d6c14a4c
RD
4570 Set the application's class name. This value may be used for
4571 X-resources if applicable for the platform
d55e5bfc
RD
4572 """
4573 return _core_.PyApp_SetClassName(*args, **kwargs)
4574
4575 def GetVendorName(*args, **kwargs):
4576 """
4577 GetVendorName(self) -> String
4578
4579 Get the application's vendor name.
4580 """
4581 return _core_.PyApp_GetVendorName(*args, **kwargs)
4582
4583 def SetVendorName(*args, **kwargs):
4584 """
4585 SetVendorName(self, String name)
4586
d6c14a4c
RD
4587 Set the application's vendor name. This value may be used
4588 automatically by `wx.Config` and such.
d55e5bfc
RD
4589 """
4590 return _core_.PyApp_SetVendorName(*args, **kwargs)
4591
4592 def GetTraits(*args, **kwargs):
4593 """
4594 GetTraits(self) -> wxAppTraits
4595
d6c14a4c
RD
4596 Return (and create if necessary) the app traits object to which we
4597 delegate for everything which either should be configurable by the
4598 user (then he can change the default behaviour simply by overriding
4599 CreateTraits() and returning his own traits object) or which is
4600 GUI/console dependent as then wx.AppTraits allows us to abstract the
4601 differences behind the common facade.
4602
4603 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
4604 """
4605 return _core_.PyApp_GetTraits(*args, **kwargs)
4606
4607 def ProcessPendingEvents(*args, **kwargs):
4608 """
4609 ProcessPendingEvents(self)
4610
d6c14a4c
RD
4611 Process all events in the Pending Events list -- it is necessary to
4612 call this function to process posted events. This normally happens
4613 during each event loop iteration.
d55e5bfc
RD
4614 """
4615 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
4616
4617 def Yield(*args, **kwargs):
4618 """
4619 Yield(self, bool onlyIfNeeded=False) -> bool
4620
d6c14a4c
RD
4621 Process all currently pending events right now, instead of waiting
4622 until return to the event loop. It is an error to call ``Yield``
4623 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 4624
d6c14a4c 4625 :warning: This function is dangerous as it can lead to unexpected
15817c7e
RD
4626 reentrancies (i.e. when called from an event handler it may
4627 result in calling the same event handler again), use with
4628 extreme care or, better, don't use at all!
d55e5bfc 4629
d6c14a4c 4630 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
15817c7e 4631
d55e5bfc
RD
4632 """
4633 return _core_.PyApp_Yield(*args, **kwargs)
4634
4635 def WakeUpIdle(*args, **kwargs):
4636 """
4637 WakeUpIdle(self)
4638
d6c14a4c
RD
4639 Make sure that idle events are sent again.
4640 :see: `wx.WakeUpIdle`
d55e5bfc
RD
4641 """
4642 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
4643
4644 def MainLoop(*args, **kwargs):
4645 """
4646 MainLoop(self) -> int
4647
d6c14a4c
RD
4648 Execute the main GUI loop, the function doesn't normally return until
4649 all top level windows have been closed and destroyed.
d55e5bfc
RD
4650 """
4651 return _core_.PyApp_MainLoop(*args, **kwargs)
4652
4653 def Exit(*args, **kwargs):
4654 """
4655 Exit(self)
4656
4657 Exit the main loop thus terminating the application.
d6c14a4c 4658 :see: `wx.Exit`
d55e5bfc
RD
4659 """
4660 return _core_.PyApp_Exit(*args, **kwargs)
4661
4662 def ExitMainLoop(*args, **kwargs):
4663 """
4664 ExitMainLoop(self)
4665
d6c14a4c
RD
4666 Exit the main GUI loop during the next iteration of the main
4667 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
4668 """
4669 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
4670
4671 def Pending(*args, **kwargs):
4672 """
4673 Pending(self) -> bool
4674
4675 Returns True if there are unprocessed events in the event queue.
4676 """
4677 return _core_.PyApp_Pending(*args, **kwargs)
4678
4679 def Dispatch(*args, **kwargs):
4680 """
4681 Dispatch(self) -> bool
4682
4683 Process the first event in the event queue (blocks until an event
4684 appears if there are none currently)
4685 """
4686 return _core_.PyApp_Dispatch(*args, **kwargs)
4687
4688 def ProcessIdle(*args, **kwargs):
4689 """
4690 ProcessIdle(self) -> bool
4691
d6c14a4c
RD
4692 Called from the MainLoop when the application becomes idle (there are
4693 no pending events) and sends a `wx.IdleEvent` to all interested
4694 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
4695 """
4696 return _core_.PyApp_ProcessIdle(*args, **kwargs)
4697
4698 def SendIdleEvents(*args, **kwargs):
4699 """
4700 SendIdleEvents(self, Window win, IdleEvent event) -> bool
4701
d6c14a4c
RD
4702 Send idle event to window and all subwindows. Returns True if more
4703 idle time is requested.
d55e5bfc
RD
4704 """
4705 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
4706
4707 def IsActive(*args, **kwargs):
4708 """
4709 IsActive(self) -> bool
4710
4711 Return True if our app has focus.
4712 """
4713 return _core_.PyApp_IsActive(*args, **kwargs)
4714
4715 def SetTopWindow(*args, **kwargs):
4716 """
4717 SetTopWindow(self, Window win)
4718
d6c14a4c 4719 Set the *main* top level window
d55e5bfc
RD
4720 """
4721 return _core_.PyApp_SetTopWindow(*args, **kwargs)
4722
4723 def GetTopWindow(*args, **kwargs):
4724 """
4725 GetTopWindow(self) -> Window
4726
d6c14a4c
RD
4727 Return the *main* top level window (if it hadn't been set previously
4728 with SetTopWindow(), will return just some top level window and, if
4729 there not any, will return None)
d55e5bfc
RD
4730 """
4731 return _core_.PyApp_GetTopWindow(*args, **kwargs)
4732
4733 def SetExitOnFrameDelete(*args, **kwargs):
4734 """
4735 SetExitOnFrameDelete(self, bool flag)
4736
d6c14a4c
RD
4737 Control the exit behaviour: by default, the program will exit the main
4738 loop (and so, usually, terminate) when the last top-level program
4739 window is deleted. Beware that if you disable this behaviour (with
4740 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4741 explicitly from somewhere.
d55e5bfc
RD
4742 """
4743 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
4744
4745 def GetExitOnFrameDelete(*args, **kwargs):
4746 """
4747 GetExitOnFrameDelete(self) -> bool
4748
4749 Get the current exit behaviour setting.
4750 """
4751 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
4752
4753 def SetUseBestVisual(*args, **kwargs):
4754 """
4755 SetUseBestVisual(self, bool flag)
4756
d6c14a4c
RD
4757 Set whether the app should try to use the best available visual on
4758 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
4759 """
4760 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
4761
4762 def GetUseBestVisual(*args, **kwargs):
4763 """
4764 GetUseBestVisual(self) -> bool
4765
4766 Get current UseBestVisual setting.
4767 """
4768 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
4769
4770 def SetPrintMode(*args, **kwargs):
4771 """SetPrintMode(self, int mode)"""
4772 return _core_.PyApp_SetPrintMode(*args, **kwargs)
4773
4774 def GetPrintMode(*args, **kwargs):
4775 """GetPrintMode(self) -> int"""
4776 return _core_.PyApp_GetPrintMode(*args, **kwargs)
4777
4778 def SetAssertMode(*args, **kwargs):
4779 """
4780 SetAssertMode(self, int mode)
4781
15817c7e 4782 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
4783 """
4784 return _core_.PyApp_SetAssertMode(*args, **kwargs)
4785
4786 def GetAssertMode(*args, **kwargs):
4787 """
4788 GetAssertMode(self) -> int
4789
4790 Get the current OnAssert behaviour setting.
4791 """
4792 return _core_.PyApp_GetAssertMode(*args, **kwargs)
4793
4794 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 4795 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
4796 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4797
4798 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4799 def GetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 4800 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
4801 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4802
4803 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4804 def GetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 4805 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
4806 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4807
4808 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4809 def GetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 4810 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
4811 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4812
4813 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4814 def GetMacHelpMenuTitleName(*args, **kwargs):
d6c14a4c 4815 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
4816 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4817
4818 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4819 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 4820 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
4821 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4822
4823 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4824 def SetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 4825 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
4826 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4827
4828 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4829 def SetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 4830 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
4831 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4832
4833 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4834 def SetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 4835 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
4836 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4837
4838 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4839 def SetMacHelpMenuTitleName(*args, **kwargs):
d6c14a4c 4840 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
4841 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
4842
4843 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4844 def _BootstrapApp(*args, **kwargs):
4845 """
4846 _BootstrapApp(self)
4847
4848 For internal use only
4849 """
4850 return _core_.PyApp__BootstrapApp(*args, **kwargs)
4851
4852 def GetComCtl32Version(*args, **kwargs):
4853 """
d6c14a4c 4854 GetComCtl32Version() -> int
d55e5bfc 4855
d6c14a4c
RD
4856 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4857 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
4858 """
4859 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
4860
4861 GetComCtl32Version = staticmethod(GetComCtl32Version)
4862
4863class PyAppPtr(PyApp):
4864 def __init__(self, this):
4865 self.this = this
4866 if not hasattr(self,"thisown"): self.thisown = 0
4867 self.__class__ = PyApp
4868_core_.PyApp_swigregister(PyAppPtr)
4869
4870def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4871 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
4872 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4873
4874def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4875 """PyApp_GetMacAboutMenuItemId() -> long"""
4876 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4877
4878def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4879 """PyApp_GetMacPreferencesMenuItemId() -> long"""
4880 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4881
4882def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4883 """PyApp_GetMacExitMenuItemId() -> long"""
4884 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4885
4886def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
4887 """PyApp_GetMacHelpMenuTitleName() -> String"""
4888 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4889
4890def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4891 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
4892 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4893
4894def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
4895 """PyApp_SetMacAboutMenuItemId(long val)"""
4896 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4897
4898def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
4899 """PyApp_SetMacPreferencesMenuItemId(long val)"""
4900 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4901
4902def PyApp_SetMacExitMenuItemId(*args, **kwargs):
4903 """PyApp_SetMacExitMenuItemId(long val)"""
4904 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4905
4906def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
4907 """PyApp_SetMacHelpMenuTitleName(String val)"""
4908 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
4909
4910def PyApp_GetComCtl32Version(*args, **kwargs):
4911 """
4912 PyApp_GetComCtl32Version() -> int
4913
d6c14a4c
RD
4914 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4915 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
4916 """
4917 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
4918
4919#---------------------------------------------------------------------------
4920
4921
4922def Exit(*args, **kwargs):
4923 """
4924 Exit()
4925
4926 Force an exit of the application. Convenience for wx.GetApp().Exit()
4927 """
4928 return _core_.Exit(*args, **kwargs)
4929
4930def Yield(*args, **kwargs):
4931 """
4932 Yield() -> bool
4933
4934 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
4935 """
4936 return _core_.Yield(*args, **kwargs)
4937
4938def YieldIfNeeded(*args, **kwargs):
4939 """
4940 YieldIfNeeded() -> bool
4941
4942 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
4943 """
4944 return _core_.YieldIfNeeded(*args, **kwargs)
4945
4946def SafeYield(*args, **kwargs):
4947 """
4948 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
4949
d6c14a4c
RD
4950 This function is similar to `wx.Yield`, except that it disables the
4951 user input to all program windows before calling `wx.Yield` and
4952 re-enables it again afterwards. If ``win`` is not None, this window
4953 will remain enabled, allowing the implementation of some limited user
4954 interaction.
d55e5bfc 4955
d6c14a4c 4956 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
4957 """
4958 return _core_.SafeYield(*args, **kwargs)
4959
4960def WakeUpIdle(*args, **kwargs):
4961 """
4962 WakeUpIdle()
4963
d6c14a4c
RD
4964 Cause the message queue to become empty again, so idle events will be
4965 sent.
d55e5bfc
RD
4966 """
4967 return _core_.WakeUpIdle(*args, **kwargs)
4968
4969def PostEvent(*args, **kwargs):
4970 """
4971 PostEvent(EvtHandler dest, Event event)
4972
d6c14a4c
RD
4973 Send an event to a window or other wx.EvtHandler to be processed
4974 later.
d55e5bfc
RD
4975 """
4976 return _core_.PostEvent(*args, **kwargs)
4977
4978def App_CleanUp(*args, **kwargs):
4979 """
4980 App_CleanUp()
4981
15817c7e 4982 For internal use only, it is used to cleanup after wxWidgets when
d6c14a4c 4983 Python shuts down.
d55e5bfc
RD
4984 """
4985 return _core_.App_CleanUp(*args, **kwargs)
4986
4987def GetApp(*args, **kwargs):
4988 """
4989 GetApp() -> PyApp
4990
4991 Return a reference to the current wx.App object.
4992 """
4993 return _core_.GetApp(*args, **kwargs)
4994#----------------------------------------------------------------------
4995
4996class PyOnDemandOutputWindow:
4997 """
4998 A class that can be used for redirecting Python's stdout and
4999 stderr streams. It will do nothing until something is wrriten to
5000 the stream at which point it will create a Frame with a text area
5001 and write the text there.
5002 """
5003 def __init__(self, title = "wxPython: stdout/stderr"):
5004 self.frame = None
5005 self.title = title
5006 self.parent = None
5007
5008 def SetParent(self, parent):
5009 """Set the window to be used as the popup Frame's parent."""
5010 self.parent = parent
5011
5012
5013 def CreateOutputWindow(self, st):
5014 self.frame = wx.Frame(self.parent, -1, self.title,
5015 style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE)
5016 self.text = wx.TextCtrl(self.frame, -1, "",
5017 style = wx.TE_MULTILINE | wx.TE_READONLY)
5018 self.text.AppendText(st)
5019 self.frame.SetSize((450, 300))
5020 self.frame.Show(True)
5021 EVT_CLOSE(self.frame, self.OnCloseWindow)
5022
5023
5024 def OnCloseWindow(self, event):
5025 if self.frame is not None:
5026 self.frame.Destroy()
5027 self.frame = None
5028 self.text = None
5029
5030
5031 # These methods provide the file-like output behaviour.
5032 def write(self, text):
5033 """
5034 Create the output window if needed and write the string to it.
5035 If not called in the context of the gui thread then uses
5036 CallAfter to do the work there.
5037 """
5038 if self.frame is None:
5039 if not wx.Thread_IsMain():
5040 wx.CallAfter(self.CreateOutputWindow, text)
5041 else:
5042 self.CreateOutputWindow(text)
5043 else:
5044 if not wx.Thread_IsMain():
5045 wx.CallAfter(self.text.AppendText, text)
5046 else:
5047 self.text.AppendText(text)
5048
5049
5050 def close(self):
5051 if self.frame is not None:
5052 wx.CallAfter(self.frame.Close)
5053
5054
bb4524c4
RD
5055 def flush(self):
5056 pass
5057
5058
d55e5bfc
RD
5059
5060#----------------------------------------------------------------------
5061
5062_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5063
5064class App(wx.PyApp):
5065 """
d6c14a4c
RD
5066 The ``wx.App`` class represents the application and is used to:
5067
5068 * bootstrap the wxPython system and initialize the underlying
5069 gui toolkit
5070 * set and get application-wide properties
5071 * implement the windowing system main message or event loop,
5072 and to dispatch events to window instances
5073 * etc.
5074
5075 Every application must have a ``wx.App`` instance, and all
5076 creation of UI objects should be delayed until after the
5077 ``wx.App`` object has been created in order to ensure that the gui
5078 platform and wxWidgets have been fully initialized.
5079
5080 Normally you would derive from this class and implement an
5081 ``OnInit`` method that creates a frame and then calls
5082 ``self.SetTopWindow(frame)``.
5083
5084 :see: `wx.PySimpleApp` for a simpler app class that can be used
15817c7e 5085 directly.
d55e5bfc 5086 """
d6c14a4c 5087
d55e5bfc
RD
5088 outputWindowClass = PyOnDemandOutputWindow
5089
d6c14a4c
RD
5090 def __init__(self, redirect=_defRedirect, filename=None,
5091 useBestVisual=False, clearSigInt=True):
5092 """
5093 Construct a ``wx.App`` object.
5094
5095 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5096 redirected? Defaults to True on Windows and Mac, False
5097 otherwise. If `filename` is None then output will be
5098 redirected to a window that pops up as needed. (You can
5099 control what kind of window is created for the output by
5100 resetting the class variable ``outputWindowClass`` to a
5101 class of your choosing.)
5102
5103 :param filename: The name of a file to redirect output to, if
5104 redirect is True.
5105
5106 :param useBestVisual: Should the app try to use the best
5107 available visual provided by the system (only relevant on
5108 systems that have more than one visual.) This parameter
5109 must be used instead of calling `SetUseBestVisual` later
5110 on because it must be set before the underlying GUI
5111 toolkit is initialized.
5112
5113 :param clearSigInt: Should SIGINT be cleared? This allows the
5114 app to terminate upon a Ctrl-C in the console like other
5115 GUI apps will.
5116
5117 :note: You should override OnInit to do applicaition
5118 initialization to ensure that the system, toolkit and
5119 wxWidgets are fully initialized.
5120 """
d55e5bfc
RD
5121 wx.PyApp.__init__(self)
5122
5123 if wx.Platform == "__WXMAC__":
5124 try:
5125 import MacOS
5126 if not MacOS.WMAvailable():
5127 print """\
5128This program needs access to the screen. Please run with 'pythonw',
5129not 'python', and only when you are logged in on the main display of
5130your Mac."""
5131 _sys.exit(1)
0346c964
RD
5132 except SystemExit:
5133 raise
d55e5bfc
RD
5134 except:
5135 pass
5136
5137 # This has to be done before OnInit
5138 self.SetUseBestVisual(useBestVisual)
5139
5140 # Set the default handler for SIGINT. This fixes a problem
5141 # where if Ctrl-C is pressed in the console that started this
5142 # app then it will not appear to do anything, (not even send
5143 # KeyboardInterrupt???) but will later segfault on exit. By
5144 # setting the default handler then the app will exit, as
5145 # expected (depending on platform.)
d6c14a4c
RD
5146 if clearSigInt:
5147 try:
5148 import signal
5149 signal.signal(signal.SIGINT, signal.SIG_DFL)
5150 except:
5151 pass
d55e5bfc
RD
5152
5153 # Save and redirect the stdio to a window?
5154 self.stdioWin = None
5155 self.saveStdio = (_sys.stdout, _sys.stderr)
5156 if redirect:
5157 self.RedirectStdio(filename)
5158
5159 # This finishes the initialization of wxWindows and then calls
5160 # the OnInit that should be present in the derived class
5161 self._BootstrapApp()
5162
5163
5164 def __del__(self):
5165 try:
5166 self.RestoreStdio() # Just in case the MainLoop was overridden
5167 except:
5168 pass
5169
5170
5171 def SetTopWindow(self, frame):
5172 """Set the \"main\" top level window"""
5173 if self.stdioWin:
5174 self.stdioWin.SetParent(frame)
5175 wx.PyApp.SetTopWindow(self, frame)
5176
5177
5178 def MainLoop(self):
5179 """Execute the main GUI event loop"""
5180 wx.PyApp.MainLoop(self)
5181 self.RestoreStdio()
5182
5183
5184 def RedirectStdio(self, filename=None):
5185 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5186 if filename:
5187 _sys.stdout = _sys.stderr = open(filename, 'a')
5188 else:
5189 self.stdioWin = self.outputWindowClass()
5190 _sys.stdout = _sys.stderr = self.stdioWin
5191
5192
5193 def RestoreStdio(self):
5194 _sys.stdout, _sys.stderr = self.saveStdio
5195
5196
5197
d6c14a4c 5198# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
5199App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5200App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5201App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5202App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5203App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5204App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5205App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5206App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5207App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5208App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5209App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5210
5211#----------------------------------------------------------------------------
5212
5213class PySimpleApp(wx.App):
5214 """
5215 A simple application class. You can just create one of these and
5216 then then make your top level windows later, and not have to worry
d6c14a4c 5217 about OnInit. For example::
d55e5bfc 5218
d6c14a4c
RD
5219 app = wx.PySimpleApp()
5220 frame = wx.Frame(None, title='Hello World')
5221 frame.Show()
5222 app.MainLoop()
5223
5224 :see: `wx.App`
5225 """
5226
5227 def __init__(self, redirect=False, filename=None,
5228 useBestVisual=False, clearSigInt=True):
5229 """
5230 :see: `wx.App.__init__`
5231 """
5232 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
5233
5234 def OnInit(self):
d55e5bfc
RD
5235 return True
5236
5237
d6c14a4c 5238
d55e5bfc
RD
5239# Is anybody using this one?
5240class PyWidgetTester(wx.App):
5241 def __init__(self, size = (250, 100)):
5242 self.size = size
5243 wx.App.__init__(self, 0)
5244
5245 def OnInit(self):
5246 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5247 self.SetTopWindow(self.frame)
5248 return True
5249
d6c14a4c
RD
5250 def SetWidget(self, widgetClass, *args, **kwargs):
5251 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
5252 self.frame.Show(True)
5253
5254#----------------------------------------------------------------------------
5255# DO NOT hold any other references to this object. This is how we
d6c14a4c 5256# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5257# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
d6c14a4c 5258# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
5259
5260class __wxPyCleanup:
5261 def __init__(self):
5262 self.cleanup = _core_.App_CleanUp
5263 def __del__(self):
5264 self.cleanup()
5265
5266_sys.__wxPythonCleanup = __wxPyCleanup()
5267
5268## # another possible solution, but it gets called too early...
d6c14a4c
RD
5269## import atexit
5270## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
5271
5272
5273#----------------------------------------------------------------------------
5274
5275#---------------------------------------------------------------------------
5276
5277class AcceleratorEntry(object):
d6c14a4c
RD
5278 """
5279 A class used to define items in an `wx.AcceleratorTable`. wxPython
5280 programs can choose to use wx.AcceleratorEntry objects, but using a
5281 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
15817c7e 5282 as well. See `__init__` for of the tuple values.
d6c14a4c
RD
5283
5284 :see: `wx.AcceleratorTable`
5285 """
d55e5bfc
RD
5286 def __repr__(self):
5287 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5288 def __init__(self, *args, **kwargs):
d6c14a4c
RD
5289 """
5290 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5291
5292 Construct a wx.AcceleratorEntry.
d6c14a4c 5293 """
d55e5bfc
RD
5294 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5295 self.this = newobj.this
5296 self.thisown = 1
5297 del newobj.thisown
5298 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5299 """__del__(self)"""
5300 try:
5301 if self.thisown: destroy(self)
5302 except: pass
5303
5304 def Set(*args, **kwargs):
d6c14a4c
RD
5305 """
5306 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5307
d6c14a4c
RD
5308 (Re)set the attributes of a wx.AcceleratorEntry.
5309 :see `__init__`
5310 """
5311 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
5312
5313 def GetFlags(*args, **kwargs):
d6c14a4c
RD
5314 """
5315 GetFlags(self) -> int
5316
5317 Get the AcceleratorEntry's flags.
5318 """
d55e5bfc
RD
5319 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5320
5321 def GetKeyCode(*args, **kwargs):
d6c14a4c
RD
5322 """
5323 GetKeyCode(self) -> int
5324
5325 Get the AcceleratorEntry's keycode.
5326 """
d55e5bfc
RD
5327 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5328
5329 def GetCommand(*args, **kwargs):
d6c14a4c
RD
5330 """
5331 GetCommand(self) -> int
5332
5333 Get the AcceleratorEntry's command ID.
5334 """
d55e5bfc
RD
5335 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5336
5337
5338class AcceleratorEntryPtr(AcceleratorEntry):
5339 def __init__(self, this):
5340 self.this = this
5341 if not hasattr(self,"thisown"): self.thisown = 0
5342 self.__class__ = AcceleratorEntry
5343_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5344
5345class AcceleratorTable(Object):
d6c14a4c
RD
5346 """
5347 An accelerator table allows the application to specify a table of
5348 keyboard shortcuts for menus or other commands. On Windows, menu or
5349 button commands are supported; on GTK, only menu commands are
5350 supported.
d6c14a4c 5351 """
d55e5bfc
RD
5352 def __repr__(self):
5353 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5354 def __init__(self, *args, **kwargs):
5355 """
5356 __init__(entries) -> AcceleratorTable
5357
d6c14a4c
RD
5358 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5359 items or or of 3-tuples (flags, keyCode, cmdID)
5360
5361 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
5362 """
5363 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5364 self.this = newobj.this
5365 self.thisown = 1
5366 del newobj.thisown
5367 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5368 """__del__(self)"""
5369 try:
5370 if self.thisown: destroy(self)
5371 except: pass
5372
5373 def Ok(*args, **kwargs):
5374 """Ok(self) -> bool"""
5375 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5376
5377
5378class AcceleratorTablePtr(AcceleratorTable):
5379 def __init__(self, this):
5380 self.this = this
5381 if not hasattr(self,"thisown"): self.thisown = 0
5382 self.__class__ = AcceleratorTable
5383_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5384
5385
5386def GetAccelFromString(*args, **kwargs):
5387 """GetAccelFromString(String label) -> AcceleratorEntry"""
5388 return _core_.GetAccelFromString(*args, **kwargs)
5389#---------------------------------------------------------------------------
5390
5391class VisualAttributes(object):
5392 """struct containing all the visual attributes of a control"""
5393 def __repr__(self):
5394 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5395 def __init__(self, *args, **kwargs):
5396 """
5397 __init__(self) -> VisualAttributes
5398
5399 struct containing all the visual attributes of a control
5400 """
5401 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5402 self.this = newobj.this
5403 self.thisown = 1
5404 del newobj.thisown
5405 def __del__(self, destroy=_core_.delete_VisualAttributes):
5406 """__del__(self)"""
5407 try:
5408 if self.thisown: destroy(self)
5409 except: pass
5410
5411 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5412 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5413 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5414
5415class VisualAttributesPtr(VisualAttributes):
5416 def __init__(self, this):
5417 self.this = this
5418 if not hasattr(self,"thisown"): self.thisown = 0
5419 self.__class__ = VisualAttributes
5420_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5421NullAcceleratorTable = cvar.NullAcceleratorTable
5422PanelNameStr = cvar.PanelNameStr
5423
5424WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5425WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5426WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5427WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5428WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5429class Window(EvtHandler):
5430 """
5431 wx.Window is the base class for all windows and represents any visible
5432 object on the screen. All controls, top level windows and so on are
5433 wx.Windows. Sizers and device contexts are not however, as they don't
5434 appear on screen themselves.
5435
5436 """
5437 def __repr__(self):
5438 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5439 def __init__(self, *args, **kwargs):
5440 """
5441 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5442 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5443
5444 Construct and show a generic Window.
5445 """
5446 newobj = _core_.new_Window(*args, **kwargs)
5447 self.this = newobj.this
5448 self.thisown = 1
5449 del newobj.thisown
5450 self._setOORInfo(self)
5451
5452 def Create(*args, **kwargs):
5453 """
5454 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5455 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
5456
5457 Create the GUI part of the Window for 2-phase creation mode.
5458 """
5459 return _core_.Window_Create(*args, **kwargs)
5460
5461 def Close(*args, **kwargs):
5462 """
5463 Close(self, bool force=False) -> bool
5464
5465 This function simply generates a EVT_CLOSE event whose handler usually
5466 tries to close the window. It doesn't close the window itself,
5467 however. If force is False (the default) then the window's close
5468 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
5469 """
5470 return _core_.Window_Close(*args, **kwargs)
5471
5472 def Destroy(*args, **kwargs):
5473 """
5474 Destroy(self) -> bool
5475
5476 Destroys the window safely. Frames and dialogs are not destroyed
5477 immediately when this function is called -- they are added to a list
5478 of windows to be deleted on idle time, when all the window's events
5479 have been processed. This prevents problems with events being sent to
5480 non-existent windows.
5481
5482 Returns True if the window has either been successfully deleted, or it
5483 has been added to the list of windows pending real deletion.
5484 """
5485 return _core_.Window_Destroy(*args, **kwargs)
5486
5487 def DestroyChildren(*args, **kwargs):
5488 """
5489 DestroyChildren(self) -> bool
5490
15817c7e
RD
5491 Destroys all children of a window. Called automatically by the
5492 destructor.
d55e5bfc
RD
5493 """
5494 return _core_.Window_DestroyChildren(*args, **kwargs)
5495
5496 def IsBeingDeleted(*args, **kwargs):
5497 """
5498 IsBeingDeleted(self) -> bool
5499
5500 Is the window in the process of being deleted?
5501 """
5502 return _core_.Window_IsBeingDeleted(*args, **kwargs)
5503
5504 def SetTitle(*args, **kwargs):
5505 """
5506 SetTitle(self, String title)
5507
5508 Sets the window's title. Applicable only to frames and dialogs.
5509 """
5510 return _core_.Window_SetTitle(*args, **kwargs)
5511
5512 def GetTitle(*args, **kwargs):
5513 """
5514 GetTitle(self) -> String
5515
5516 Gets the window's title. Applicable only to frames and dialogs.
5517 """
5518 return _core_.Window_GetTitle(*args, **kwargs)
5519
5520 def SetLabel(*args, **kwargs):
5521 """
5522 SetLabel(self, String label)
5523
5524 Set the text which the window shows in its label if applicable.
5525 """
5526 return _core_.Window_SetLabel(*args, **kwargs)
5527
5528 def GetLabel(*args, **kwargs):
5529 """
5530 GetLabel(self) -> String
5531
15817c7e
RD
5532 Generic way of getting a label from any window, for identification
5533 purposes. The interpretation of this function differs from class to
5534 class. For frames and dialogs, the value returned is the title. For
5535 buttons or static text controls, it is the button text. This function
5536 can be useful for meta-programs such as testing tools or special-needs
5537 access programs)which need to identify windows by name.
d55e5bfc
RD
5538 """
5539 return _core_.Window_GetLabel(*args, **kwargs)
5540
5541 def SetName(*args, **kwargs):
5542 """
5543 SetName(self, String name)
5544
15817c7e
RD
5545 Sets the window's name. The window name is used for ressource setting
5546 in X, it is not the same as the window title/label
d55e5bfc
RD
5547 """
5548 return _core_.Window_SetName(*args, **kwargs)
5549
5550 def GetName(*args, **kwargs):
5551 """
5552 GetName(self) -> String
5553
15817c7e
RD
5554 Returns the windows name. This name is not guaranteed to be unique;
5555 it is up to the programmer to supply an appropriate name in the window
5556 constructor or via wx.Window.SetName.
d55e5bfc
RD
5557 """
5558 return _core_.Window_GetName(*args, **kwargs)
5559
5560 def SetWindowVariant(*args, **kwargs):
5561 """
5562 SetWindowVariant(self, int variant)
5563
15817c7e
RD
5564 Sets the variant of the window/font size to use for this window, if
5565 the platform supports variants, for example, wxMac.
d55e5bfc
RD
5566 """
5567 return _core_.Window_SetWindowVariant(*args, **kwargs)
5568
5569 def GetWindowVariant(*args, **kwargs):
5570 """GetWindowVariant(self) -> int"""
5571 return _core_.Window_GetWindowVariant(*args, **kwargs)
5572
5573 def SetId(*args, **kwargs):
5574 """
5575 SetId(self, int winid)
5576
5577 Sets the identifier of the window. Each window has an integer
5578 identifier. If the application has not provided one, an identifier
5579 will be generated. Normally, the identifier should be provided on
5580 creation and should not be modified subsequently.
5581 """
5582 return _core_.Window_SetId(*args, **kwargs)
5583
5584 def GetId(*args, **kwargs):
5585 """
5586 GetId(self) -> int
5587
5588 Returns the identifier of the window. Each window has an integer
5589 identifier. If the application has not provided one (or the default Id
5590 -1 is used) then an unique identifier with a negative value will be
5591 generated.
5592 """
5593 return _core_.Window_GetId(*args, **kwargs)
5594
5595 def NewControlId(*args, **kwargs):
5596 """
d6c14a4c 5597 NewControlId() -> int
d55e5bfc
RD
5598
5599 Generate a control id for the controls which were not given one.
5600 """
5601 return _core_.Window_NewControlId(*args, **kwargs)
5602
5603 NewControlId = staticmethod(NewControlId)
5604 def NextControlId(*args, **kwargs):
5605 """
d6c14a4c 5606 NextControlId(int winid) -> int
d55e5bfc
RD
5607
5608 Get the id of the control following the one with the given
15817c7e 5609 autogenerated) id
d55e5bfc
RD
5610 """
5611 return _core_.Window_NextControlId(*args, **kwargs)
5612
5613 NextControlId = staticmethod(NextControlId)
5614 def PrevControlId(*args, **kwargs):
5615 """
d6c14a4c 5616 PrevControlId(int winid) -> int
d55e5bfc
RD
5617
5618 Get the id of the control preceding the one with the given
15817c7e 5619 autogenerated) id
d55e5bfc
RD
5620 """
5621 return _core_.Window_PrevControlId(*args, **kwargs)
5622
5623 PrevControlId = staticmethod(PrevControlId)
5624 def SetSize(*args, **kwargs):
5625 """
5626 SetSize(self, Size size)
5627
5628 Sets the size of the window in pixels.
5629 """
5630 return _core_.Window_SetSize(*args, **kwargs)
5631
5632 def SetDimensions(*args, **kwargs):
5633 """
5634 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
5635
5636 Sets the position and size of the window in pixels. The sizeFlags
5637 parameter indicates the interpretation of the other params if they are
5638 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5639 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5640 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5641 dimensions of -1 and less to be interpreted as real dimensions, not
5642 default values.
5643 """
5644 return _core_.Window_SetDimensions(*args, **kwargs)
5645
5646 def SetRect(*args, **kwargs):
5647 """
5648 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
5649
5650 Sets the position and size of the window in pixels using a wx.Rect.
5651 """
5652 return _core_.Window_SetRect(*args, **kwargs)
5653
5654 def SetSizeWH(*args, **kwargs):
5655 """
5656 SetSizeWH(self, int width, int height)
5657
5658 Sets the size of the window in pixels.
5659 """
5660 return _core_.Window_SetSizeWH(*args, **kwargs)
5661
5662 def Move(*args, **kwargs):
5663 """
5664 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
5665
5666 Moves the window to the given position.
5667 """
5668 return _core_.Window_Move(*args, **kwargs)
5669
5670 SetPosition = Move
5671 def MoveXY(*args, **kwargs):
5672 """
5673 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
5674
5675 Moves the window to the given position.
5676 """
5677 return _core_.Window_MoveXY(*args, **kwargs)
5678
f8167d6e
RD
5679 def SetBestFittingSize(*args, **kwargs):
5680 """
5681 SetBestFittingSize(self, Size size=DefaultSize)
5682
5683 A 'Smart' SetSize that will fill in default size components with the
5684 window's *best size* values. Also set's the minsize for use with sizers.
5685 """
5686 return _core_.Window_SetBestFittingSize(*args, **kwargs)
5687
d55e5bfc
RD
5688 def Raise(*args, **kwargs):
5689 """
5690 Raise(self)
5691
5692 Raises the window to the top of the window hierarchy if it is a
5693 managed window (dialog or frame).
5694 """
5695 return _core_.Window_Raise(*args, **kwargs)
5696
5697 def Lower(*args, **kwargs):
5698 """
5699 Lower(self)
5700
5701 Lowers the window to the bottom of the window hierarchy if it is a
5702 managed window (dialog or frame).
5703 """
5704 return _core_.Window_Lower(*args, **kwargs)
5705
5706 def SetClientSize(*args, **kwargs):
5707 """
5708 SetClientSize(self, Size size)
5709
5710 This sets the size of the window client area in pixels. Using this
5711 function to size a window tends to be more device-independent than
5712 wx.Window.SetSize, since the application need not worry about what
5713 dimensions the border or title bar have when trying to fit the window
5714 around panel items, for example.
5715 """
5716 return _core_.Window_SetClientSize(*args, **kwargs)
5717
5718 def SetClientSizeWH(*args, **kwargs):
5719 """
5720 SetClientSizeWH(self, int width, int height)
5721
5722 This sets the size of the window client area in pixels. Using this
5723 function to size a window tends to be more device-independent than
5724 wx.Window.SetSize, since the application need not worry about what
5725 dimensions the border or title bar have when trying to fit the window
5726 around panel items, for example.
5727 """
5728 return _core_.Window_SetClientSizeWH(*args, **kwargs)
5729
5730 def SetClientRect(*args, **kwargs):
5731 """
5732 SetClientRect(self, Rect rect)
5733
5734 This sets the size of the window client area in pixels. Using this
5735 function to size a window tends to be more device-independent than
5736 wx.Window.SetSize, since the application need not worry about what
5737 dimensions the border or title bar have when trying to fit the window
5738 around panel items, for example.
5739 """
5740 return _core_.Window_SetClientRect(*args, **kwargs)
5741
5742 def GetPosition(*args, **kwargs):
5743 """
5744 GetPosition(self) -> Point
5745
5746 Get the window's position.
5747 """
5748 return _core_.Window_GetPosition(*args, **kwargs)
5749
5750 def GetPositionTuple(*args, **kwargs):
5751 """
5752 GetPositionTuple() -> (x,y)
5753
5754 Get the window's position.
5755 """
5756 return _core_.Window_GetPositionTuple(*args, **kwargs)
5757
5758 def GetSize(*args, **kwargs):
5759 """
5760 GetSize(self) -> Size
5761
5762 Get the window size.
5763 """
5764 return _core_.Window_GetSize(*args, **kwargs)
5765
5766 def GetSizeTuple(*args, **kwargs):
5767 """
5768 GetSizeTuple() -> (width, height)
5769
5770 Get the window size.
5771 """
5772 return _core_.Window_GetSizeTuple(*args, **kwargs)
5773
5774 def GetRect(*args, **kwargs):
5775 """
5776 GetRect(self) -> Rect
5777
5778 Returns the size and position of the window as a wx.Rect object.
5779 """
5780 return _core_.Window_GetRect(*args, **kwargs)
5781
5782 def GetClientSize(*args, **kwargs):
5783 """
5784 GetClientSize(self) -> Size
5785
5786 This gets the size of the window's 'client area' in pixels. The client
5787 area is the area which may be drawn on by the programmer, excluding
5788 title bar, border, scrollbars, etc.
5789 """
5790 return _core_.Window_GetClientSize(*args, **kwargs)
5791
5792 def GetClientSizeTuple(*args, **kwargs):
5793 """
5794 GetClientSizeTuple() -> (width, height)
5795
5796 This gets the size of the window's 'client area' in pixels. The client
5797 area is the area which may be drawn on by the programmer, excluding
5798 title bar, border, scrollbars, etc.
5799 """
5800 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
5801
5802 def GetClientAreaOrigin(*args, **kwargs):
5803 """
5804 GetClientAreaOrigin(self) -> Point
5805
5806 Get the origin of the client area of the window relative to the
5807 window's top left corner (the client area may be shifted because of
5808 the borders, scrollbars, other decorations...)
5809 """
5810 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
5811
5812 def GetClientRect(*args, **kwargs):
5813 """
5814 GetClientRect(self) -> Rect
5815
0439c23b 5816 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
5817 """
5818 return _core_.Window_GetClientRect(*args, **kwargs)
5819
5820 def GetBestSize(*args, **kwargs):
5821 """
5822 GetBestSize(self) -> Size
5823
bfddbb17 5824 This function returns the best acceptable minimal size for the
15817c7e
RD
5825 window, if applicable. For example, for a static text control, it will
5826 be the minimal size such that the control label is not truncated. For
5827 windows containing subwindows (suzh aswx.Panel), the size returned by
5828 this function will be the same as the size the window would have had
5829 after calling Fit.
d55e5bfc
RD
5830 """
5831 return _core_.Window_GetBestSize(*args, **kwargs)
5832
5833 def GetBestSizeTuple(*args, **kwargs):
5834 """
5835 GetBestSizeTuple() -> (width, height)
5836
bfddbb17 5837 This function returns the best acceptable minimal size for the
15817c7e
RD
5838 window, if applicable. For example, for a static text control, it will
5839 be the minimal size such that the control label is not truncated. For
5840 windows containing subwindows (suzh aswx.Panel), the size returned by
5841 this function will be the same as the size the window would have had
5842 after calling Fit.
d55e5bfc
RD
5843 """
5844 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
5845
a001823c
RD
5846 def InvalidateBestSize(*args, **kwargs):
5847 """
5848 InvalidateBestSize(self)
5849
5850 Reset the cached best size value so it will be recalculated the next
5851 time it is needed.
5852 """
5853 return _core_.Window_InvalidateBestSize(*args, **kwargs)
5854
5855 def GetBestFittingSize(*args, **kwargs):
5856 """
5857 GetBestFittingSize(self) -> Size
5858
5859 This function will merge the window's best size into the window's
5860 minimum size, giving priority to the min size components, and returns
5861 the results.
5862
5863 """
5864 return _core_.Window_GetBestFittingSize(*args, **kwargs)
5865
d55e5bfc
RD
5866 def GetAdjustedBestSize(*args, **kwargs):
5867 """
5868 GetAdjustedBestSize(self) -> Size
5869
5870 This method is similar to GetBestSize, except in one
5871 thing. GetBestSize should return the minimum untruncated size of the
5872 window, while this method will return the largest of BestSize and any
5873 user specified minimum size. ie. it is the minimum size the window
5874 should currently be drawn at, not the minimal size it can possibly
5875 tolerate.
5876 """
5877 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
5878
5879 def Center(*args, **kwargs):
5880 """
5881 Center(self, int direction=BOTH)
5882
5883 Centers the window. The parameter specifies the direction for
5884 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
5885 also include wx.CENTER_ON_SCREEN flag if you want to center the window
5886 on the entire screen and not on its parent window. If it is a
5887 top-level window and has no parent then it will always be centered
5888 relative to the screen.
5889 """
5890 return _core_.Window_Center(*args, **kwargs)
5891
5892 Centre = Center
5893 def CenterOnScreen(*args, **kwargs):
5894 """
5895 CenterOnScreen(self, int dir=BOTH)
5896
5897 Center on screen (only works for top level windows)
5898 """
5899 return _core_.Window_CenterOnScreen(*args, **kwargs)
5900
5901 CentreOnScreen = CenterOnScreen
5902 def CenterOnParent(*args, **kwargs):
5903 """
5904 CenterOnParent(self, int dir=BOTH)
5905
5906 Center with respect to the the parent window
5907 """
5908 return _core_.Window_CenterOnParent(*args, **kwargs)
5909
5910 CentreOnParent = CenterOnParent
5911 def Fit(*args, **kwargs):
5912 """
5913 Fit(self)
5914
5915 Sizes the window so that it fits around its subwindows. This function
5916 won't do anything if there are no subwindows and will only really work
5917 correctly if sizers are used for the subwindows layout. Also, if the
5918 window has exactly one subwindow it is better (faster and the result
5919 is more precise as Fit adds some margin to account for fuzziness of
5920 its calculations) to call window.SetClientSize(child.GetSize())
5921 instead of calling Fit.
5922 """
5923 return _core_.Window_Fit(*args, **kwargs)
5924
5925 def FitInside(*args, **kwargs):
5926 """
5927 FitInside(self)
5928
5929 Similar to Fit, but sizes the interior (virtual) size of a
5930 window. Mainly useful with scrolled windows to reset scrollbars after
5931 sizing changes that do not trigger a size event, and/or scrolled
5932 windows without an interior sizer. This function similarly won't do
5933 anything if there are no subwindows.
5934 """
5935 return _core_.Window_FitInside(*args, **kwargs)
5936
5937 def SetSizeHints(*args):
5938 """
908b74cd 5939 SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
d55e5bfc
RD
5940 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
5941 int incH=-1)
d55e5bfc
RD
5942
5943 Allows specification of minimum and maximum window sizes, and window
5944 size increments. If a pair of values is not set (or set to -1), the
5945 default values will be used. If this function is called, the user
908b74cd
RD
5946 will not be able to size the window outside the given bounds (if it is
5947 a top-level window.) Sizers will also inspect the minimum window size
5948 and will use that value if set when calculating layout.
5949
5950 The resizing increments are only significant under Motif or Xt.
d55e5bfc
RD
5951 """
5952 return _core_.Window_SetSizeHints(*args)
5953
5954 def SetVirtualSizeHints(*args):
5955 """
d55e5bfc 5956 SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
908b74cd 5957 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
5958
5959 Allows specification of minimum and maximum virtual window sizes. If a
5960 pair of values is not set (or set to -1), the default values will be
5961 used. If this function is called, the user will not be able to size
5962 the virtual area of the window outside the given bounds.
5963 """
5964 return _core_.Window_SetVirtualSizeHints(*args)
5965
908b74cd
RD
5966 def GetMaxSize(*args, **kwargs):
5967 """GetMaxSize(self) -> Size"""
5968 return _core_.Window_GetMaxSize(*args, **kwargs)
5969
5970 def GetMinSize(*args, **kwargs):
5971 """GetMinSize(self) -> Size"""
5972 return _core_.Window_GetMinSize(*args, **kwargs)
5973
5974 def SetMinSize(*args, **kwargs):
5975 """
5976 SetMinSize(self, Size minSize)
5977
5978 A more convenient method than `SetSizeHints` for setting just the
5979 min size.
5980 """
5981 return _core_.Window_SetMinSize(*args, **kwargs)
5982
5983 def SetMaxSize(*args, **kwargs):
5984 """
5985 SetMaxSize(self, Size maxSize)
5986
5987 A more convenient method than `SetSizeHints` for setting just the
5988 max size.
5989 """
5990 return _core_.Window_SetMaxSize(*args, **kwargs)
5991
d55e5bfc
RD
5992 def GetMinWidth(*args, **kwargs):
5993 """GetMinWidth(self) -> int"""
5994 return _core_.Window_GetMinWidth(*args, **kwargs)
5995
5996 def GetMinHeight(*args, **kwargs):
5997 """GetMinHeight(self) -> int"""
5998 return _core_.Window_GetMinHeight(*args, **kwargs)
5999
6000 def GetMaxWidth(*args, **kwargs):
6001 """GetMaxWidth(self) -> int"""
6002 return _core_.Window_GetMaxWidth(*args, **kwargs)
6003
6004 def GetMaxHeight(*args, **kwargs):
6005 """GetMaxHeight(self) -> int"""
6006 return _core_.Window_GetMaxHeight(*args, **kwargs)
6007
d55e5bfc
RD
6008 def SetVirtualSize(*args, **kwargs):
6009 """
6010 SetVirtualSize(self, Size size)
6011
6012 Set the the virtual size of a window in pixels. For most windows this
6013 is just the client area of the window, but for some like scrolled
6014 windows it is more or less independent of the screen window size.
6015 """
6016 return _core_.Window_SetVirtualSize(*args, **kwargs)
6017
6018 def SetVirtualSizeWH(*args, **kwargs):
6019 """
6020 SetVirtualSizeWH(self, int w, int h)
6021
6022 Set the the virtual size of a window in pixels. For most windows this
6023 is just the client area of the window, but for some like scrolled
6024 windows it is more or less independent of the screen window size.
6025 """
6026 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6027
6028 def GetVirtualSize(*args, **kwargs):
6029 """
6030 GetVirtualSize(self) -> Size
6031
6032 Get the the virtual size of the window in pixels. For most windows
6033 this is just the client area of the window, but for some like scrolled
6034 windows it is more or less independent of the screen window size.
6035 """
6036 return _core_.Window_GetVirtualSize(*args, **kwargs)
6037
6038 def GetVirtualSizeTuple(*args, **kwargs):
6039 """
6040 GetVirtualSizeTuple() -> (width, height)
6041
6042 Get the the virtual size of the window in pixels. For most windows
6043 this is just the client area of the window, but for some like scrolled
6044 windows it is more or less independent of the screen window size.
6045 """
6046 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6047
6048 def GetBestVirtualSize(*args, **kwargs):
6049 """
6050 GetBestVirtualSize(self) -> Size
6051
6052 Return the largest of ClientSize and BestSize (as determined by a
6053 sizer, interior children, or other means)
6054 """
6055 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6056
6057 def Show(*args, **kwargs):
6058 """
6059 Show(self, bool show=True) -> bool
6060
6061 Shows or hides the window. You may need to call Raise for a top level
6062 window if you want to bring it to top, although this is not needed if
6063 Show is called immediately after the frame creation. Returns True if
6064 the window has been shown or hidden or False if nothing was done
6065 because it already was in the requested state.
6066 """
6067 return _core_.Window_Show(*args, **kwargs)
6068
6069 def Hide(*args, **kwargs):
6070 """
6071 Hide(self) -> bool
6072
6073 Equivalent to calling Show(False).
6074 """
6075 return _core_.Window_Hide(*args, **kwargs)
6076
6077 def Enable(*args, **kwargs):
6078 """
6079 Enable(self, bool enable=True) -> bool
6080
6081 Enable or disable the window for user input. Note that when a parent
6082 window is disabled, all of its children are disabled as well and they
6083 are reenabled again when the parent is. Returns true if the window
6084 has been enabled or disabled, false if nothing was done, i.e. if the
6085 window had already been in the specified state.
6086 """
6087 return _core_.Window_Enable(*args, **kwargs)
6088
6089 def Disable(*args, **kwargs):
6090 """
6091 Disable(self) -> bool
6092
6093 Disables the window, same as Enable(false).
6094 """
6095 return _core_.Window_Disable(*args, **kwargs)
6096
6097 def IsShown(*args, **kwargs):
6098 """
6099 IsShown(self) -> bool
6100
6101 Returns true if the window is shown, false if it has been hidden.
6102 """
6103 return _core_.Window_IsShown(*args, **kwargs)
6104
6105 def IsEnabled(*args, **kwargs):
6106 """
6107 IsEnabled(self) -> bool
6108
6109 Returns true if the window is enabled for input, false otherwise.
6110 """
6111 return _core_.Window_IsEnabled(*args, **kwargs)
6112
6113 def SetWindowStyleFlag(*args, **kwargs):
6114 """
6115 SetWindowStyleFlag(self, long style)
6116
15817c7e
RD
6117 Sets the style of the window. Please note that some styles cannot be
6118 changed after the window creation and that Refresh() might need to be
6119 called after changing the others for the change to take place
6120 immediately.
d55e5bfc
RD
6121 """
6122 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6123
6124 def GetWindowStyleFlag(*args, **kwargs):
6125 """
6126 GetWindowStyleFlag(self) -> long
6127
6128 Gets the window style that was passed to the constructor or Create
6129 method.
6130 """
6131 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6132
6133 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6134 def HasFlag(*args, **kwargs):
6135 """
6136 HasFlag(self, int flag) -> bool
6137
6138 Test if the given style is set for this window.
6139 """
6140 return _core_.Window_HasFlag(*args, **kwargs)
6141
6142 def IsRetained(*args, **kwargs):
6143 """
6144 IsRetained(self) -> bool
6145
6146 Returns true if the window is retained, false otherwise. Retained
6147 windows are only available on X platforms.
6148 """
6149 return _core_.Window_IsRetained(*args, **kwargs)
6150
6151 def SetExtraStyle(*args, **kwargs):
6152 """
6153 SetExtraStyle(self, long exStyle)
6154
6155 Sets the extra style bits for the window. Extra styles are the less
6156 often used style bits which can't be set with the constructor or with
6157 SetWindowStyleFlag()
6158 """
6159 return _core_.Window_SetExtraStyle(*args, **kwargs)
6160
6161 def GetExtraStyle(*args, **kwargs):
6162 """
6163 GetExtraStyle(self) -> long
6164
6165 Returns the extra style bits for the window.
6166 """
6167 return _core_.Window_GetExtraStyle(*args, **kwargs)
6168
6169 def MakeModal(*args, **kwargs):
6170 """
6171 MakeModal(self, bool modal=True)
6172
6173 Disables all other windows in the application so that the user can
6174 only interact with this window. Passing False will reverse this
6175 effect.
6176 """
6177 return _core_.Window_MakeModal(*args, **kwargs)
6178
6179 def SetThemeEnabled(*args, **kwargs):
6180 """
6181 SetThemeEnabled(self, bool enableTheme)
6182
6183 This function tells a window if it should use the system's "theme"
6184 code to draw the windows' background instead if its own background
6185 drawing code. This will only have an effect on platforms that support
6186 the notion of themes in user defined windows. One such platform is
6187 GTK+ where windows can have (very colourful) backgrounds defined by a
6188 user's selected theme.
6189
6190 Dialogs, notebook pages and the status bar have this flag set to true
6191 by default so that the default look and feel is simulated best.
6192 """
6193 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6194
6195 def GetThemeEnabled(*args, **kwargs):
6196 """
6197 GetThemeEnabled(self) -> bool
6198
6199 Return the themeEnabled flag.
6200 """
6201 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6202
6203 def SetFocus(*args, **kwargs):
6204 """
6205 SetFocus(self)
6206
6207 Set's the focus to this window, allowing it to receive keyboard input.
6208 """
6209 return _core_.Window_SetFocus(*args, **kwargs)
6210
6211 def SetFocusFromKbd(*args, **kwargs):
6212 """
6213 SetFocusFromKbd(self)
6214
6215 Set focus to this window as the result of a keyboard action. Normally
6216 only called internally.
6217 """
6218 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6219
6220 def FindFocus(*args, **kwargs):
6221 """
d6c14a4c 6222 FindFocus() -> Window
d55e5bfc
RD
6223
6224 Returns the window or control that currently has the keyboard focus,
6225 or None.
6226 """
6227 return _core_.Window_FindFocus(*args, **kwargs)
6228
6229 FindFocus = staticmethod(FindFocus)
6230 def AcceptsFocus(*args, **kwargs):
6231 """
6232 AcceptsFocus(self) -> bool
6233
6234 Can this window have focus?
6235 """
6236 return _core_.Window_AcceptsFocus(*args, **kwargs)
6237
6238 def AcceptsFocusFromKeyboard(*args, **kwargs):
6239 """
6240 AcceptsFocusFromKeyboard(self) -> bool
6241
6242 Can this window be given focus by keyboard navigation? if not, the
6243 only way to give it focus (provided it accepts it at all) is to click
6244 it.
6245 """
6246 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6247
6248 def GetDefaultItem(*args, **kwargs):
6249 """
6250 GetDefaultItem(self) -> Window
6251
6252 Get the default child of this parent, i.e. the one which is activated
6253 by pressing <Enter> such as the OK button on a wx.Dialog.
6254 """
6255 return _core_.Window_GetDefaultItem(*args, **kwargs)
6256
6257 def SetDefaultItem(*args, **kwargs):
6258 """
6259 SetDefaultItem(self, Window child) -> Window
6260
6261 Set this child as default, return the old default.
6262 """
6263 return _core_.Window_SetDefaultItem(*args, **kwargs)
6264
6265 def SetTmpDefaultItem(*args, **kwargs):
6266 """
6267 SetTmpDefaultItem(self, Window win)
6268
6269 Set this child as temporary default
6270 """
6271 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6272
908b74cd
RD
6273 def Navigate(*args, **kwargs):
6274 """
6275 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6276
fd2dc343
RD
6277 Does keyboard navigation from this window to another, by sending a
6278 `wx.NavigationKeyEvent`.
908b74cd
RD
6279 """
6280 return _core_.Window_Navigate(*args, **kwargs)
6281
d55e5bfc
RD
6282 def GetChildren(*args, **kwargs):
6283 """
6284 GetChildren(self) -> PyObject
6285
6286 Returns a list of the window's children. NOTE: Currently this is a
6287 copy of the child window list maintained by the window, so the return
6288 value of this function is only valid as long as the window's children
6289 do not change.
6290 """
6291 return _core_.Window_GetChildren(*args, **kwargs)
6292
6293 def GetParent(*args, **kwargs):
6294 """
6295 GetParent(self) -> Window
6296
6297 Returns the parent window of this window, or None if there isn't one.
6298 """
6299 return _core_.Window_GetParent(*args, **kwargs)
6300
6301 def GetGrandParent(*args, **kwargs):
6302 """
6303 GetGrandParent(self) -> Window
6304
15817c7e
RD
6305 Returns the parent of the parent of this window, or None if there
6306 isn't one.
d55e5bfc
RD
6307 """
6308 return _core_.Window_GetGrandParent(*args, **kwargs)
6309
6310 def IsTopLevel(*args, **kwargs):
6311 """
6312 IsTopLevel(self) -> bool
6313
6314 Returns true if the given window is a top-level one. Currently all
6315 frames and dialogs are always considered to be top-level windows (even
6316 if they have a parent window).
6317 """
6318 return _core_.Window_IsTopLevel(*args, **kwargs)
6319
6320 def Reparent(*args, **kwargs):
6321 """
6322 Reparent(self, Window newParent) -> bool
6323
6324 Reparents the window, i.e the window will be removed from its current
6325 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6326 re-inserted into another. Available on Windows and GTK. Returns True
6327 if the parent was changed, False otherwise (error or newParent ==
6328 oldParent)
6329 """
6330 return _core_.Window_Reparent(*args, **kwargs)
6331
6332 def AddChild(*args, **kwargs):
6333 """
6334 AddChild(self, Window child)
6335
6336 Adds a child window. This is called automatically by window creation
6337 functions so should not be required by the application programmer.
6338 """
6339 return _core_.Window_AddChild(*args, **kwargs)
6340
6341 def RemoveChild(*args, **kwargs):
6342 """
6343 RemoveChild(self, Window child)
6344
6345 Removes a child window. This is called automatically by window
6346 deletion functions so should not be required by the application
6347 programmer.
6348 """
6349 return _core_.Window_RemoveChild(*args, **kwargs)
6350
6351 def FindWindowById(*args, **kwargs):
6352 """
6353 FindWindowById(self, long winid) -> Window
6354
6355 Find a chld of this window by window ID
6356 """
6357 return _core_.Window_FindWindowById(*args, **kwargs)
6358
6359 def FindWindowByName(*args, **kwargs):
6360 """
6361 FindWindowByName(self, String name) -> Window
6362
6363 Find a child of this window by name
6364 """
6365 return _core_.Window_FindWindowByName(*args, **kwargs)
6366
6367 def GetEventHandler(*args, **kwargs):
6368 """
6369 GetEventHandler(self) -> EvtHandler
6370
6371 Returns the event handler for this window. By default, the window is
6372 its own event handler.
6373 """
6374 return _core_.Window_GetEventHandler(*args, **kwargs)
6375
6376 def SetEventHandler(*args, **kwargs):
6377 """
6378 SetEventHandler(self, EvtHandler handler)
6379
6380 Sets the event handler for this window. An event handler is an object
6381 that is capable of processing the events sent to a window. By default,
6382 the window is its own event handler, but an application may wish to
6383 substitute another, for example to allow central implementation of
6384 event-handling for a variety of different window classes.
6385
15817c7e 6386 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
6387 up a chain of event handlers, where an event not handled by one event
6388 handler is handed to the next one in the chain.
6389 """
6390 return _core_.Window_SetEventHandler(*args, **kwargs)
6391
6392 def PushEventHandler(*args, **kwargs):
6393 """
6394 PushEventHandler(self, EvtHandler handler)
6395
6396 Pushes this event handler onto the event handler stack for the window.
6397 An event handler is an object that is capable of processing the events
6398 sent to a window. By default, the window is its own event handler, but
6399 an application may wish to substitute another, for example to allow
6400 central implementation of event-handling for a variety of different
6401 window classes.
6402
6403 wx.Window.PushEventHandler allows an application to set up a chain of
6404 event handlers, where an event not handled by one event handler is
15817c7e 6405 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
6406 remove the event handler.
6407 """
6408 return _core_.Window_PushEventHandler(*args, **kwargs)
6409
6410 def PopEventHandler(*args, **kwargs):
6411 """
6412 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
6413
6414 Removes and returns the top-most event handler on the event handler
6415 stack. If deleteHandler is True then the wx.EvtHandler object will be
6416 destroyed after it is popped.
6417 """
6418 return _core_.Window_PopEventHandler(*args, **kwargs)
6419
6420 def RemoveEventHandler(*args, **kwargs):
6421 """
6422 RemoveEventHandler(self, EvtHandler handler) -> bool
6423
15817c7e
RD
6424 Find the given handler in the event handler chain and remove (but not
6425 delete) it from the event handler chain, return True if it was found
6426 and False otherwise (this also results in an assert failure so this
6427 function should only be called when the handler is supposed to be
6428 there.)
d55e5bfc
RD
6429 """
6430 return _core_.Window_RemoveEventHandler(*args, **kwargs)
6431
6432 def SetValidator(*args, **kwargs):
6433 """
6434 SetValidator(self, Validator validator)
6435
6436 Deletes the current validator (if any) and sets the window validator,
6437 having called wx.Validator.Clone to create a new validator of this
6438 type.
6439 """
6440 return _core_.Window_SetValidator(*args, **kwargs)
6441
6442 def GetValidator(*args, **kwargs):
6443 """
6444 GetValidator(self) -> Validator
6445
6446 Returns a pointer to the current validator for the window, or None if
6447 there is none.
6448 """
6449 return _core_.Window_GetValidator(*args, **kwargs)
6450
6451 def Validate(*args, **kwargs):
6452 """
6453 Validate(self) -> bool
6454
6455 Validates the current values of the child controls using their
15817c7e
RD
6456 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6457 style flag set, the method will also call Validate() of all child
6458 windows. Returns false if any of the validations failed.
d55e5bfc
RD
6459 """
6460 return _core_.Window_Validate(*args, **kwargs)
6461
6462 def TransferDataToWindow(*args, **kwargs):
6463 """
6464 TransferDataToWindow(self) -> bool
6465
15817c7e
RD
6466 Transfers values to child controls from data areas specified by their
6467 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6468 style flag set, the method will also call TransferDataToWindow() of
6469 all child windows.
d55e5bfc
RD
6470 """
6471 return _core_.Window_TransferDataToWindow(*args, **kwargs)
6472
6473 def TransferDataFromWindow(*args, **kwargs):
6474 """
6475 TransferDataFromWindow(self) -> bool
6476
15817c7e
RD
6477 Transfers values from child controls to data areas specified by their
6478 validators. Returns false if a transfer failed. If the window has
6479 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6480 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
6481 """
6482 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
6483
6484 def InitDialog(*args, **kwargs):
6485 """
6486 InitDialog(self)
6487
15817c7e
RD
6488 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6489 to the dialog via validators.
d55e5bfc
RD
6490 """
6491 return _core_.Window_InitDialog(*args, **kwargs)
6492
6493 def SetAcceleratorTable(*args, **kwargs):
6494 """
6495 SetAcceleratorTable(self, AcceleratorTable accel)
6496
6497 Sets the accelerator table for this window.
6498 """
6499 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
6500
6501 def GetAcceleratorTable(*args, **kwargs):
6502 """
6503 GetAcceleratorTable(self) -> AcceleratorTable
6504
6505 Gets the accelerator table for this window.
6506 """
6507 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
6508
6509 def RegisterHotKey(*args, **kwargs):
6510 """
6511 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
6512
6513 Registers a system wide hotkey. Every time the user presses the hotkey
6514 registered here, this window will receive a hotkey event. It will
6515 receive the event even if the application is in the background and
6516 does not have the input focus because the user is working with some
6517 other application. To bind an event handler function to this hotkey
6518 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6519 hotkey was registered successfully.
6520 """
6521 return _core_.Window_RegisterHotKey(*args, **kwargs)
6522
6523 def UnregisterHotKey(*args, **kwargs):
6524 """
6525 UnregisterHotKey(self, int hotkeyId) -> bool
6526
6527 Unregisters a system wide hotkey.
6528 """
6529 return _core_.Window_UnregisterHotKey(*args, **kwargs)
6530
6531 def ConvertDialogPointToPixels(*args, **kwargs):
6532 """
6533 ConvertDialogPointToPixels(self, Point pt) -> Point
6534
6535 Converts a point or size from dialog units to pixels. Dialog units
6536 are used for maintaining a dialog's proportions even if the font
6537 changes. For the x dimension, the dialog units are multiplied by the
6538 average character width and then divided by 4. For the y dimension,
6539 the dialog units are multiplied by the average character height and
6540 then divided by 8.
6541 """
6542 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
6543
6544 def ConvertDialogSizeToPixels(*args, **kwargs):
6545 """
6546 ConvertDialogSizeToPixels(self, Size sz) -> Size
6547
6548 Converts a point or size from dialog units to pixels. Dialog units
6549 are used for maintaining a dialog's proportions even if the font
6550 changes. For the x dimension, the dialog units are multiplied by the
6551 average character width and then divided by 4. For the y dimension,
6552 the dialog units are multiplied by the average character height and
6553 then divided by 8.
6554 """
6555 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
6556
6557 def DLG_PNT(*args, **kwargs):
6558 """
6559 DLG_PNT(self, Point pt) -> Point
6560
6561 Converts a point or size from dialog units to pixels. Dialog units
6562 are used for maintaining a dialog's proportions even if the font
6563 changes. For the x dimension, the dialog units are multiplied by the
6564 average character width and then divided by 4. For the y dimension,
6565 the dialog units are multiplied by the average character height and
6566 then divided by 8.
6567 """
6568 return _core_.Window_DLG_PNT(*args, **kwargs)
6569
6570 def DLG_SZE(*args, **kwargs):
6571 """
6572 DLG_SZE(self, Size sz) -> Size
6573
6574 Converts a point or size from dialog units to pixels. Dialog units
6575 are used for maintaining a dialog's proportions even if the font
6576 changes. For the x dimension, the dialog units are multiplied by the
6577 average character width and then divided by 4. For the y dimension,
6578 the dialog units are multiplied by the average character height and
6579 then divided by 8.
6580 """
6581 return _core_.Window_DLG_SZE(*args, **kwargs)
6582
6583 def ConvertPixelPointToDialog(*args, **kwargs):
6584 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
6585 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
6586
6587 def ConvertPixelSizeToDialog(*args, **kwargs):
6588 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
6589 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
6590
6591 def WarpPointer(*args, **kwargs):
6592 """
6593 WarpPointer(self, int x, int y)
6594
6595 Moves the pointer to the given position on the window.
6596
6597 NOTE: This function is not supported under Mac because Apple Human
6598 Interface Guidelines forbid moving the mouse cursor programmatically.
6599 """
6600 return _core_.Window_WarpPointer(*args, **kwargs)
6601
6602 def CaptureMouse(*args, **kwargs):
6603 """
6604 CaptureMouse(self)
6605
6606 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6607 release the capture.
6608
6609 Note that wxWindows maintains the stack of windows having captured the
6610 mouse and when the mouse is released the capture returns to the window
6611 which had had captured it previously and it is only really released if
6612 there were no previous window. In particular, this means that you must
6613 release the mouse as many times as you capture it.
6614 """
6615 return _core_.Window_CaptureMouse(*args, **kwargs)
6616
6617 def ReleaseMouse(*args, **kwargs):
6618 """
6619 ReleaseMouse(self)
6620
6621 Releases mouse input captured with wx.Window.CaptureMouse.
6622 """
6623 return _core_.Window_ReleaseMouse(*args, **kwargs)
6624
6625 def GetCapture(*args, **kwargs):
6626 """
d6c14a4c 6627 GetCapture() -> Window
d55e5bfc
RD
6628
6629 Returns the window which currently captures the mouse or None
6630 """
6631 return _core_.Window_GetCapture(*args, **kwargs)
6632
6633 GetCapture = staticmethod(GetCapture)
6634 def HasCapture(*args, **kwargs):
6635 """
6636 HasCapture(self) -> bool
6637
6638 Returns true if this window has the current mouse capture.
6639 """
6640 return _core_.Window_HasCapture(*args, **kwargs)
6641
6642 def Refresh(*args, **kwargs):
6643 """
6644 Refresh(self, bool eraseBackground=True, Rect rect=None)
6645
6646 Mark the specified rectangle (or the whole window) as "dirty" so it
6647 will be repainted. Causes an EVT_PAINT event to be generated and sent
6648 to the window.
6649 """
6650 return _core_.Window_Refresh(*args, **kwargs)
6651
6652 def RefreshRect(*args, **kwargs):
6653 """
6654 RefreshRect(self, Rect rect)
6655
6656 Redraws the contents of the given rectangle: the area inside it will
6657 be repainted. This is the same as Refresh but has a nicer syntax.
6658 """
6659 return _core_.Window_RefreshRect(*args, **kwargs)
6660
6661 def Update(*args, **kwargs):
6662 """
6663 Update(self)
6664
6665 Calling this method immediately repaints the invalidated area of the
6666 window instead of waiting for the EVT_PAINT event to happen, (normally
6667 this would usually only happen when the flow of control returns to the
6668 event loop.) Notice that this function doesn't refresh the window and
6669 does nothing if the window has been already repainted. Use Refresh
6670 first if you want to immediately redraw the window (or some portion of
6671 it) unconditionally.
6672 """
6673 return _core_.Window_Update(*args, **kwargs)
6674
6675 def ClearBackground(*args, **kwargs):
6676 """
6677 ClearBackground(self)
6678
6679 Clears the window by filling it with the current background
6680 colour. Does not cause an erase background event to be generated.
6681 """
6682 return _core_.Window_ClearBackground(*args, **kwargs)
6683
6684 def Freeze(*args, **kwargs):
6685 """
6686 Freeze(self)
6687
15817c7e
RD
6688 Freezes the window or, in other words, prevents any updates from
6689 taking place on screen, the window is not redrawn at all. Thaw must be
6690 called to reenable window redrawing. Calls to Freeze/Thaw may be
6691 nested, with the actual Thaw being delayed until all the nesting has
6692 been undone.
d55e5bfc
RD
6693
6694 This method is useful for visual appearance optimization (for example,
6695 it is a good idea to use it before inserting large amount of text into
6696 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6697 for all controls so it is mostly just a hint to wxWindows and not a
6698 mandatory directive.
6699 """
6700 return _core_.Window_Freeze(*args, **kwargs)
6701
6702 def Thaw(*args, **kwargs):
6703 """
6704 Thaw(self)
6705
6706 Reenables window updating after a previous call to Freeze. Calls to
15817c7e
RD
6707 Freeze/Thaw may be nested, so Thaw must be called the same number of
6708 times that Freeze was before the window will be updated.
d55e5bfc
RD
6709 """
6710 return _core_.Window_Thaw(*args, **kwargs)
6711
6712 def PrepareDC(*args, **kwargs):
6713 """
6714 PrepareDC(self, DC dc)
6715
6716 Call this function to prepare the device context for drawing a
6717 scrolled image. It sets the device origin according to the current
6718 scroll position.
6719 """
6720 return _core_.Window_PrepareDC(*args, **kwargs)
6721
6722 def GetUpdateRegion(*args, **kwargs):
6723 """
6724 GetUpdateRegion(self) -> Region
6725
6726 Returns the region specifying which parts of the window have been
6727 damaged. Should only be called within an EVT_PAINT handler.
6728 """
6729 return _core_.Window_GetUpdateRegion(*args, **kwargs)
6730
6731 def GetUpdateClientRect(*args, **kwargs):
6732 """
6733 GetUpdateClientRect(self) -> Rect
6734
6735 Get the update rectangle region bounding box in client coords.
6736 """
6737 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
6738
6739 def IsExposed(*args, **kwargs):
6740 """
6741 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
6742
6743 Returns true if the given point or rectangle area has been exposed
6744 since the last repaint. Call this in an paint event handler to
6745 optimize redrawing by only redrawing those areas, which have been
6746 exposed.
6747 """
6748 return _core_.Window_IsExposed(*args, **kwargs)
6749
6750 def IsExposedPoint(*args, **kwargs):
6751 """
6752 IsExposedPoint(self, Point pt) -> bool
6753
6754 Returns true if the given point or rectangle area has been exposed
6755 since the last repaint. Call this in an paint event handler to
6756 optimize redrawing by only redrawing those areas, which have been
6757 exposed.
6758 """
6759 return _core_.Window_IsExposedPoint(*args, **kwargs)
6760
6761 def IsExposedRect(*args, **kwargs):
6762 """
6763 IsExposedRect(self, Rect rect) -> bool
6764
6765 Returns true if the given point or rectangle area has been exposed
6766 since the last repaint. Call this in an paint event handler to
6767 optimize redrawing by only redrawing those areas, which have been
6768 exposed.
6769 """
6770 return _core_.Window_IsExposedRect(*args, **kwargs)
6771
6772 def GetDefaultAttributes(*args, **kwargs):
6773 """
6774 GetDefaultAttributes(self) -> VisualAttributes
6775
15817c7e
RD
6776 Get the default attributes for an instance of this class. This is
6777 useful if you want to use the same font or colour in your own control
6778 as in a standard control -- which is a much better idea than hard
6779 coding specific colours or fonts which might look completely out of
a5ee0656 6780 place on the user's system, especially if it uses themes.
d55e5bfc
RD
6781 """
6782 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
6783
6784 def GetClassDefaultAttributes(*args, **kwargs):
6785 """
d6c14a4c 6786 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 6787
15817c7e
RD
6788 Get the default attributes for this class. This is useful if you want
6789 to use the same font or colour in your own control as in a standard
6790 control -- which is a much better idea than hard coding specific
a5ee0656
RD
6791 colours or fonts which might look completely out of place on the
6792 user's system, especially if it uses themes.
d55e5bfc
RD
6793
6794 The variant parameter is only relevant under Mac currently and is
15817c7e 6795 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
6796 the returned font. See `wx.Window.SetWindowVariant` for more about
6797 this.
d55e5bfc
RD
6798 """
6799 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
6800
6801 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
6802 def SetBackgroundColour(*args, **kwargs):
6803 """
6804 SetBackgroundColour(self, Colour colour) -> bool
6805
6806 Sets the background colour of the window. Returns True if the colour
6807 was changed. The background colour is usually painted by the default
6808 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
6809 automatically under GTK. Using `wx.NullColour` will reset the window
6810 to the default background colour.
d55e5bfc 6811
a5ee0656 6812 Note that setting the background colour may not cause an immediate
f8167d6e 6813 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
6814 calling this function.
6815
f8167d6e
RD
6816 Using this function will disable attempts to use themes for this
6817 window, if the system supports them. Use with care since usually the
6818 themes represent the appearance chosen by the user to be used for all
6819 applications on the system.
d55e5bfc
RD
6820 """
6821 return _core_.Window_SetBackgroundColour(*args, **kwargs)
6822
fa47d7a7
VS
6823 def SetOwnBackroundColour(*args, **kwargs):
6824 """SetOwnBackroundColour(self, Colour colour)"""
6825 return _core_.Window_SetOwnBackroundColour(*args, **kwargs)
d55e5bfc
RD
6826
6827 def SetForegroundColour(*args, **kwargs):
6828 """
6829 SetForegroundColour(self, Colour colour) -> bool
6830
6831 Sets the foreground colour of the window. Returns True is the colour
6832 was changed. The interpretation of foreground colour is dependent on
6833 the window class; it may be the text colour or other colour, or it may
6834 not be used at all.
6835 """
6836 return _core_.Window_SetForegroundColour(*args, **kwargs)
6837
fa47d7a7
VS
6838 def SetOwnForegroundColour(*args, **kwargs):
6839 """SetOwnForegroundColour(self, Colour colour)"""
6840 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
6841
6842 def GetBackgroundColour(*args, **kwargs):
6843 """
6844 GetBackgroundColour(self) -> Colour
6845
6846 Returns the background colour of the window.
6847 """
6848 return _core_.Window_GetBackgroundColour(*args, **kwargs)
6849
6850 def GetForegroundColour(*args, **kwargs):
6851 """
6852 GetForegroundColour(self) -> Colour
6853
6854 Returns the foreground colour of the window. The interpretation of
6855 foreground colour is dependent on the window class; it may be the text
6856 colour or other colour, or it may not be used at all.
6857 """
6858 return _core_.Window_GetForegroundColour(*args, **kwargs)
6859
6860 def SetCursor(*args, **kwargs):
6861 """
6862 SetCursor(self, Cursor cursor) -> bool
6863
6864 Sets the window's cursor. Notice that the window cursor also sets it
6865 for the children of the window implicitly.
6866
6867 The cursor may be wx.NullCursor in which case the window cursor will
6868 be reset back to default.
6869 """
6870 return _core_.Window_SetCursor(*args, **kwargs)
6871
6872 def GetCursor(*args, **kwargs):
6873 """
6874 GetCursor(self) -> Cursor
6875
6876 Return the cursor associated with this window.
6877 """
6878 return _core_.Window_GetCursor(*args, **kwargs)
6879
6880 def SetFont(*args, **kwargs):
6881 """
6882 SetFont(self, Font font) -> bool
6883
6884 Sets the font for this window.
6885 """
6886 return _core_.Window_SetFont(*args, **kwargs)
6887
fa47d7a7
VS
6888 def SetOwnFont(*args, **kwargs):
6889 """SetOwnFont(self, Font font)"""
6890 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
6891
6892 def GetFont(*args, **kwargs):
6893 """
6894 GetFont(self) -> Font
6895
6896 Returns the default font used for this window.
6897 """
6898 return _core_.Window_GetFont(*args, **kwargs)
6899
6900 def SetCaret(*args, **kwargs):
6901 """
6902 SetCaret(self, Caret caret)
6903
6904 Sets the caret associated with the window.
6905 """
6906 return _core_.Window_SetCaret(*args, **kwargs)
6907
6908 def GetCaret(*args, **kwargs):
6909 """
6910 GetCaret(self) -> Caret
6911
6912 Returns the caret associated with the window.
6913 """
6914 return _core_.Window_GetCaret(*args, **kwargs)
6915
6916 def GetCharHeight(*args, **kwargs):
6917 """
6918 GetCharHeight(self) -> int
6919
6920 Get the (average) character size for the current font.
6921 """
6922 return _core_.Window_GetCharHeight(*args, **kwargs)
6923
6924 def GetCharWidth(*args, **kwargs):
6925 """
6926 GetCharWidth(self) -> int
6927
6928 Get the (average) character size for the current font.
6929 """
6930 return _core_.Window_GetCharWidth(*args, **kwargs)
6931
6932 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
6933 """
6934 GetTextExtent(String string) -> (width, height)
6935
6936 Get the width and height of the text using the current font.
6937 """
d55e5bfc
RD
6938 return _core_.Window_GetTextExtent(*args, **kwargs)
6939
6940 def GetFullTextExtent(*args, **kwargs):
6941 """
6942 GetFullTextExtent(String string, Font font=None) ->
6943 (width, height, descent, externalLeading)
6944
6945 Get the width, height, decent and leading of the text using the
6946 current or specified font.
6947 """
6948 return _core_.Window_GetFullTextExtent(*args, **kwargs)
6949
6950 def ClientToScreenXY(*args, **kwargs):
6951 """
6952 ClientToScreenXY(int x, int y) -> (x,y)
6953
6954 Converts to screen coordinates from coordinates relative to this window.
6955 """
6956 return _core_.Window_ClientToScreenXY(*args, **kwargs)
6957
6958 def ScreenToClientXY(*args, **kwargs):
6959 """
6960 ScreenToClientXY(int x, int y) -> (x,y)
6961
6962 Converts from screen to client window coordinates.
6963 """
6964 return _core_.Window_ScreenToClientXY(*args, **kwargs)
6965
6966 def ClientToScreen(*args, **kwargs):
6967 """
6968 ClientToScreen(self, Point pt) -> Point
6969
6970 Converts to screen coordinates from coordinates relative to this window.
6971 """
6972 return _core_.Window_ClientToScreen(*args, **kwargs)
6973
6974 def ScreenToClient(*args, **kwargs):
6975 """
6976 ScreenToClient(self, Point pt) -> Point
6977
6978 Converts from screen to client window coordinates.
6979 """
6980 return _core_.Window_ScreenToClient(*args, **kwargs)
6981
6982 def HitTestXY(*args, **kwargs):
6983 """
6984 HitTestXY(self, int x, int y) -> int
6985
6986 Test where the given (in client coords) point lies
6987 """
6988 return _core_.Window_HitTestXY(*args, **kwargs)
6989
6990 def HitTest(*args, **kwargs):
6991 """
6992 HitTest(self, Point pt) -> int
6993
6994 Test where the given (in client coords) point lies
6995 """
6996 return _core_.Window_HitTest(*args, **kwargs)
6997
6998 def GetBorder(*args):
6999 """
7000 GetBorder(self, long flags) -> int
7001 GetBorder(self) -> int
7002
7003 Get border for the flags of this window
7004 """
7005 return _core_.Window_GetBorder(*args)
7006
7007 def UpdateWindowUI(*args, **kwargs):
7008 """
7009 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
7010
7011 This function sends EVT_UPDATE_UI events to the window. The particular
7012 implementation depends on the window; for example a wx.ToolBar will
7013 send an update UI event for each toolbar button, and a wx.Frame will
7014 send an update UI event for each menubar menu item. You can call this
7015 function from your application to ensure that your UI is up-to-date at
7016 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7017 concerned). This may be necessary if you have called
7018 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7019 limit the overhead that wxWindows incurs by sending update UI events
7020 in idle time.
d55e5bfc
RD
7021 """
7022 return _core_.Window_UpdateWindowUI(*args, **kwargs)
7023
7024 def PopupMenuXY(*args, **kwargs):
7025 """
b0503257 7026 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7027
b0503257
RD
7028 Pops up the given menu at the specified coordinates, relative to this window,
7029 and returns control when the user has dismissed the menu. If a menu item is
7030 selected, the corresponding menu event is generated and will be processed as
7031 usual. If the default position is given then the current position of the
7032 mouse cursor will be used.
d55e5bfc
RD
7033 """
7034 return _core_.Window_PopupMenuXY(*args, **kwargs)
7035
7036 def PopupMenu(*args, **kwargs):
7037 """
b0503257 7038 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7039
b0503257
RD
7040 Pops up the given menu at the specified coordinates, relative to this window,
7041 and returns control when the user has dismissed the menu. If a menu item is
7042 selected, the corresponding menu event is generated and will be processed as
7043 usual. If the default position is given then the current position of the
7044 mouse cursor will be used.
d55e5bfc
RD
7045 """
7046 return _core_.Window_PopupMenu(*args, **kwargs)
7047
7048 def GetHandle(*args, **kwargs):
7049 """
7050 GetHandle(self) -> long
7051
7052 Returns the platform-specific handle (as a long integer) of the
7053 physical window. Currently on wxMac it returns the handle of the
7054 toplevel parent of the window.
7055 """
7056 return _core_.Window_GetHandle(*args, **kwargs)
7057
7058 def HasScrollbar(*args, **kwargs):
7059 """
7060 HasScrollbar(self, int orient) -> bool
7061
7062 Does the window have the scrollbar for this orientation?
7063 """
7064 return _core_.Window_HasScrollbar(*args, **kwargs)
7065
7066 def SetScrollbar(*args, **kwargs):
7067 """
15817c7e 7068 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
7069 bool refresh=True)
7070
7071 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
7072 """
7073 return _core_.Window_SetScrollbar(*args, **kwargs)
7074
7075 def SetScrollPos(*args, **kwargs):
7076 """
7077 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7078
7079 Sets the position of one of the built-in scrollbars.
7080 """
7081 return _core_.Window_SetScrollPos(*args, **kwargs)
7082
7083 def GetScrollPos(*args, **kwargs):
7084 """
7085 GetScrollPos(self, int orientation) -> int
7086
7087 Returns the built-in scrollbar position.
7088 """
7089 return _core_.Window_GetScrollPos(*args, **kwargs)
7090
7091 def GetScrollThumb(*args, **kwargs):
7092 """
7093 GetScrollThumb(self, int orientation) -> int
7094
7095 Returns the built-in scrollbar thumb size.
7096 """
7097 return _core_.Window_GetScrollThumb(*args, **kwargs)
7098
7099 def GetScrollRange(*args, **kwargs):
7100 """
7101 GetScrollRange(self, int orientation) -> int
7102
7103 Returns the built-in scrollbar range.
7104 """
7105 return _core_.Window_GetScrollRange(*args, **kwargs)
7106
7107 def ScrollWindow(*args, **kwargs):
7108 """
7109 ScrollWindow(self, int dx, int dy, Rect rect=None)
7110
7111 Physically scrolls the pixels in the window and move child windows
7112 accordingly. Use this function to optimise your scrolling
7113 implementations, to minimise the area that must be redrawn. Note that
7114 it is rarely required to call this function from a user program.
d55e5bfc
RD
7115 """
7116 return _core_.Window_ScrollWindow(*args, **kwargs)
7117
7118 def ScrollLines(*args, **kwargs):
7119 """
7120 ScrollLines(self, int lines) -> bool
7121
7122 If the platform and window class supports it, scrolls the window by
7123 the given number of lines down, if lines is positive, or up if lines
7124 is negative. Returns True if the window was scrolled, False if it was
7125 already on top/bottom and nothing was done.
7126 """
7127 return _core_.Window_ScrollLines(*args, **kwargs)
7128
7129 def ScrollPages(*args, **kwargs):
7130 """
7131 ScrollPages(self, int pages) -> bool
7132
15817c7e 7133 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
7134 the given number of pages down, if pages is positive, or up if pages
7135 is negative. Returns True if the window was scrolled, False if it was
7136 already on top/bottom and nothing was done.
7137 """
7138 return _core_.Window_ScrollPages(*args, **kwargs)
7139
7140 def LineUp(*args, **kwargs):
7141 """
7142 LineUp(self) -> bool
7143
7144 This is just a wrapper for ScrollLines(-1).
7145 """
7146 return _core_.Window_LineUp(*args, **kwargs)
7147
7148 def LineDown(*args, **kwargs):
7149 """
7150 LineDown(self) -> bool
7151
7152 This is just a wrapper for ScrollLines(1).
7153 """
7154 return _core_.Window_LineDown(*args, **kwargs)
7155
7156 def PageUp(*args, **kwargs):
7157 """
7158 PageUp(self) -> bool
7159
7160 This is just a wrapper for ScrollPages(-1).
7161 """
7162 return _core_.Window_PageUp(*args, **kwargs)
7163
7164 def PageDown(*args, **kwargs):
7165 """
7166 PageDown(self) -> bool
7167
7168 This is just a wrapper for ScrollPages(1).
7169 """
7170 return _core_.Window_PageDown(*args, **kwargs)
7171
7172 def SetHelpText(*args, **kwargs):
7173 """
7174 SetHelpText(self, String text)
7175
7176 Sets the help text to be used as context-sensitive help for this
7177 window. Note that the text is actually stored by the current
7178 wxHelpProvider implementation, and not in the window object itself.
7179 """
7180 return _core_.Window_SetHelpText(*args, **kwargs)
7181
7182 def SetHelpTextForId(*args, **kwargs):
7183 """
7184 SetHelpTextForId(self, String text)
7185
7186 Associate this help text with all windows with the same id as this
7187 one.
7188 """
7189 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7190
7191 def GetHelpText(*args, **kwargs):
7192 """
7193 GetHelpText(self) -> String
7194
7195 Gets the help text to be used as context-sensitive help for this
7196 window. Note that the text is actually stored by the current
7197 wxHelpProvider implementation, and not in the window object itself.
7198 """
7199 return _core_.Window_GetHelpText(*args, **kwargs)
7200
7201 def SetToolTipString(*args, **kwargs):
7202 """
7203 SetToolTipString(self, String tip)
7204
7205 Attach a tooltip to the window.
7206 """
7207 return _core_.Window_SetToolTipString(*args, **kwargs)
7208
7209 def SetToolTip(*args, **kwargs):
7210 """
7211 SetToolTip(self, ToolTip tip)
7212
7213 Attach a tooltip to the window.
7214 """
7215 return _core_.Window_SetToolTip(*args, **kwargs)
7216
7217 def GetToolTip(*args, **kwargs):
7218 """
7219 GetToolTip(self) -> ToolTip
7220
7221 get the associated tooltip or None if none
7222 """
7223 return _core_.Window_GetToolTip(*args, **kwargs)
7224
7225 def SetDropTarget(*args, **kwargs):
7226 """
7227 SetDropTarget(self, DropTarget dropTarget)
7228
7229 Associates a drop target with this window. If the window already has
7230 a drop target, it is deleted.
7231 """
7232 return _core_.Window_SetDropTarget(*args, **kwargs)
7233
7234 def GetDropTarget(*args, **kwargs):
7235 """
7236 GetDropTarget(self) -> DropTarget
7237
7238 Returns the associated drop target, which may be None.
7239 """
7240 return _core_.Window_GetDropTarget(*args, **kwargs)
7241
7242 def SetConstraints(*args, **kwargs):
7243 """
7244 SetConstraints(self, LayoutConstraints constraints)
7245
7246 Sets the window to have the given layout constraints. If an existing
7247 layout constraints object is already owned by the window, it will be
7248 deleted. Pass None to disassociate and delete the window's current
7249 constraints.
7250
7251 You must call SetAutoLayout to tell a window to use the constraints
7252 automatically in its default EVT_SIZE handler; otherwise, you must
7253 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7254 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7255 effect.
7256 """
7257 return _core_.Window_SetConstraints(*args, **kwargs)
7258
7259 def GetConstraints(*args, **kwargs):
7260 """
7261 GetConstraints(self) -> LayoutConstraints
7262
7263 Returns a pointer to the window's layout constraints, or None if there
7264 are none.
7265 """
7266 return _core_.Window_GetConstraints(*args, **kwargs)
7267
7268 def SetAutoLayout(*args, **kwargs):
7269 """
7270 SetAutoLayout(self, bool autoLayout)
7271
7272 Determines whether the Layout function will be called automatically
7273 when the window is resized. It is called implicitly by SetSizer but
7274 if you use SetConstraints you should call it manually or otherwise the
7275 window layout won't be correctly updated when its size changes.
7276 """
7277 return _core_.Window_SetAutoLayout(*args, **kwargs)
7278
7279 def GetAutoLayout(*args, **kwargs):
7280 """
7281 GetAutoLayout(self) -> bool
7282
7283 Returns the current autoLayout setting
7284 """
7285 return _core_.Window_GetAutoLayout(*args, **kwargs)
7286
7287 def Layout(*args, **kwargs):
7288 """
7289 Layout(self) -> bool
7290
7291 Invokes the constraint-based layout algorithm or the sizer-based
7292 algorithm for this window. See SetAutoLayout: when auto layout is on,
7293 this function gets called automatically by the default EVT_SIZE
7294 handler when the window is resized.
7295 """
7296 return _core_.Window_Layout(*args, **kwargs)
7297
7298 def SetSizer(*args, **kwargs):
7299 """
7300 SetSizer(self, Sizer sizer, bool deleteOld=True)
7301
7302 Sets the window to have the given layout sizer. The window will then
7303 own the object, and will take care of its deletion. If an existing
7304 layout sizer object is already owned by the window, it will be deleted
7305 if the deleteOld parameter is true. Note that this function will also
7306 call SetAutoLayout implicitly with a True parameter if the sizer is
7307 non-NoneL and False otherwise.
7308 """
7309 return _core_.Window_SetSizer(*args, **kwargs)
7310
7311 def SetSizerAndFit(*args, **kwargs):
7312 """
7313 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7314
7315 The same as SetSizer, except it also sets the size hints for the
7316 window based on the sizer's minimum size.
7317 """
7318 return _core_.Window_SetSizerAndFit(*args, **kwargs)
7319
7320 def GetSizer(*args, **kwargs):
7321 """
7322 GetSizer(self) -> Sizer
7323
7324 Return the sizer associated with the window by a previous call to
7325 SetSizer or None if there isn't one.
7326 """
7327 return _core_.Window_GetSizer(*args, **kwargs)
7328
7329 def SetContainingSizer(*args, **kwargs):
7330 """
7331 SetContainingSizer(self, Sizer sizer)
7332
7333 This normally does not need to be called by application code. It is
7334 called internally when a window is added to a sizer, and is used so
7335 the window can remove itself from the sizer when it is destroyed.
7336 """
7337 return _core_.Window_SetContainingSizer(*args, **kwargs)
7338
7339 def GetContainingSizer(*args, **kwargs):
7340 """
7341 GetContainingSizer(self) -> Sizer
7342
7343 Return the sizer that this window is a member of, if any, otherwise None.
7344 """
7345 return _core_.Window_GetContainingSizer(*args, **kwargs)
7346
7347 def InheritAttributes(*args, **kwargs):
7348 """
7349 InheritAttributes(self)
7350
15817c7e
RD
7351 This function is (or should be, in case of custom controls) called
7352 during window creation to intelligently set up the window visual
7353 attributes, that is the font and the foreground and background
7354 colours.
7355
7356 By 'intelligently' the following is meant: by default, all windows use
7357 their own default attributes. However if some of the parent's
7358 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7359 SetOwnFont) and if the corresponding attribute hadn't been
15817c7e
RD
7360 explicitly set for this window itself, then this window takes the same
7361 value as used by the parent. In addition, if the window overrides
7362 ShouldInheritColours to return false, the colours will not be changed
7363 no matter what and only the font might.
7364
7365 This rather complicated logic is necessary in order to accomodate the
7366 different usage scenarius. The most common one is when all default
7367 attributes are used and in this case, nothing should be inherited as
7368 in modern GUIs different controls use different fonts (and colours)
7369 than their siblings so they can't inherit the same value from the
7370 parent. However it was also deemed desirable to allow to simply change
7371 the attributes of all children at once by just changing the font or
7372 colour of their common parent, hence in this case we do inherit the
7373 parents attributes.
7374
d55e5bfc
RD
7375 """
7376 return _core_.Window_InheritAttributes(*args, **kwargs)
7377
7378 def ShouldInheritColours(*args, **kwargs):
7379 """
7380 ShouldInheritColours(self) -> bool
7381
7382 Return true from here to allow the colours of this window to be
15817c7e
RD
7383 changed by InheritAttributes, returning false forbids inheriting them
7384 from the parent window.
d55e5bfc 7385
15817c7e
RD
7386 The base class version returns false, but this method is overridden in
7387 wxControl where it returns true.
d55e5bfc
RD
7388 """
7389 return _core_.Window_ShouldInheritColours(*args, **kwargs)
7390
7391 def PostCreate(self, pre):
7392 """
7393 Phase 3 of the 2-phase create <wink!>
7394 Call this method after precreating the window with the 2-phase create method.
7395 """
7396 self.this = pre.this
7397 self.thisown = pre.thisown
7398 pre.thisown = 0
7399 if hasattr(self, '_setOORInfo'):
7400 self._setOORInfo(self)
7401 if hasattr(self, '_setCallbackInfo'):
7402 self._setCallbackInfo(self, self.__class__)
7403
7404
7405class WindowPtr(Window):
7406 def __init__(self, this):
7407 self.this = this
7408 if not hasattr(self,"thisown"): self.thisown = 0
7409 self.__class__ = Window
7410_core_.Window_swigregister(WindowPtr)
7411
7412def PreWindow(*args, **kwargs):
7413 """
7414 PreWindow() -> Window
7415
7416 Precreate a Window for 2-phase creation.
7417 """
7418 val = _core_.new_PreWindow(*args, **kwargs)
7419 val.thisown = 1
7420 return val
7421
7422def Window_NewControlId(*args, **kwargs):
7423 """
7424 Window_NewControlId() -> int
7425
7426 Generate a control id for the controls which were not given one.
7427 """
7428 return _core_.Window_NewControlId(*args, **kwargs)
7429
7430def Window_NextControlId(*args, **kwargs):
7431 """
7432 Window_NextControlId(int winid) -> int
7433
7434 Get the id of the control following the one with the given
15817c7e 7435 autogenerated) id
d55e5bfc
RD
7436 """
7437 return _core_.Window_NextControlId(*args, **kwargs)
7438
7439def Window_PrevControlId(*args, **kwargs):
7440 """
7441 Window_PrevControlId(int winid) -> int
7442
7443 Get the id of the control preceding the one with the given
15817c7e 7444 autogenerated) id
d55e5bfc
RD
7445 """
7446 return _core_.Window_PrevControlId(*args, **kwargs)
7447
7448def Window_FindFocus(*args, **kwargs):
7449 """
7450 Window_FindFocus() -> Window
7451
7452 Returns the window or control that currently has the keyboard focus,
7453 or None.
7454 """
7455 return _core_.Window_FindFocus(*args, **kwargs)
7456
7457def Window_GetCapture(*args, **kwargs):
7458 """
7459 Window_GetCapture() -> Window
7460
7461 Returns the window which currently captures the mouse or None
7462 """
7463 return _core_.Window_GetCapture(*args, **kwargs)
7464
7465def Window_GetClassDefaultAttributes(*args, **kwargs):
7466 """
7467 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7468
15817c7e
RD
7469 Get the default attributes for this class. This is useful if you want
7470 to use the same font or colour in your own control as in a standard
7471 control -- which is a much better idea than hard coding specific
a5ee0656
RD
7472 colours or fonts which might look completely out of place on the
7473 user's system, especially if it uses themes.
d55e5bfc
RD
7474
7475 The variant parameter is only relevant under Mac currently and is
15817c7e 7476 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
7477 the returned font. See `wx.Window.SetWindowVariant` for more about
7478 this.
d55e5bfc
RD
7479 """
7480 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7481
7482def DLG_PNT(win, point_or_x, y=None):
7483 """
7484 Convenience function for converting a Point or (x,y) in
7485 dialog units to pixel units.
7486 """
7487 if y is None:
7488 return win.ConvertDialogPointToPixels(point_or_x)
7489 else:
7490 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
7491
7492def DLG_SZE(win, size_width, height=None):
7493 """
7494 Convenience function for converting a Size or (w,h) in
7495 dialog units to pixel units.
7496 """
7497 if height is None:
7498 return win.ConvertDialogSizeToPixels(size_width)
7499 else:
7500 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
7501
7502
7503def FindWindowById(*args, **kwargs):
7504 """
7505 FindWindowById(long id, Window parent=None) -> Window
7506
7507 Find the first window in the application with the given id. If parent
7508 is None, the search will start from all top-level frames and dialog
7509 boxes; if non-None, the search will be limited to the given window
7510 hierarchy. The search is recursive in both cases.
7511 """
7512 return _core_.FindWindowById(*args, **kwargs)
7513
7514def FindWindowByName(*args, **kwargs):
7515 """
7516 FindWindowByName(String name, Window parent=None) -> Window
7517
7518 Find a window by its name (as given in a window constructor or Create
7519 function call). If parent is None, the search will start from all
7520 top-level frames and dialog boxes; if non-None, the search will be
7521 limited to the given window hierarchy. The search is recursive in both
7522 cases.
7523
7524 If no window with such name is found, wx.FindWindowByLabel is called.
7525 """
7526 return _core_.FindWindowByName(*args, **kwargs)
7527
7528def FindWindowByLabel(*args, **kwargs):
7529 """
7530 FindWindowByLabel(String label, Window parent=None) -> Window
7531
7532 Find a window by its label. Depending on the type of window, the label
7533 may be a window title or panel item label. If parent is None, the
7534 search will start from all top-level frames and dialog boxes; if
7535 non-None, the search will be limited to the given window
7536 hierarchy. The search is recursive in both cases.
7537 """
7538 return _core_.FindWindowByLabel(*args, **kwargs)
7539
7540def Window_FromHWND(*args, **kwargs):
7541 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
7542 return _core_.Window_FromHWND(*args, **kwargs)
7543#---------------------------------------------------------------------------
7544
7545class Validator(EvtHandler):
7546 def __repr__(self):
7547 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7548 def __init__(self, *args, **kwargs):
7549 """__init__(self) -> Validator"""
7550 newobj = _core_.new_Validator(*args, **kwargs)
7551 self.this = newobj.this
7552 self.thisown = 1
7553 del newobj.thisown
7554 self._setOORInfo(self)
7555
7556 def Clone(*args, **kwargs):
7557 """Clone(self) -> Validator"""
7558 return _core_.Validator_Clone(*args, **kwargs)
7559
7560 def Validate(*args, **kwargs):
7561 """Validate(self, Window parent) -> bool"""
7562 return _core_.Validator_Validate(*args, **kwargs)
7563
7564 def TransferToWindow(*args, **kwargs):
7565 """TransferToWindow(self) -> bool"""
7566 return _core_.Validator_TransferToWindow(*args, **kwargs)
7567
7568 def TransferFromWindow(*args, **kwargs):
7569 """TransferFromWindow(self) -> bool"""
7570 return _core_.Validator_TransferFromWindow(*args, **kwargs)
7571
7572 def GetWindow(*args, **kwargs):
7573 """GetWindow(self) -> Window"""
7574 return _core_.Validator_GetWindow(*args, **kwargs)
7575
7576 def SetWindow(*args, **kwargs):
7577 """SetWindow(self, Window window)"""
7578 return _core_.Validator_SetWindow(*args, **kwargs)
7579
7580 def IsSilent(*args, **kwargs):
d6c14a4c 7581 """IsSilent() -> bool"""
d55e5bfc
RD
7582 return _core_.Validator_IsSilent(*args, **kwargs)
7583
7584 IsSilent = staticmethod(IsSilent)
7585 def SetBellOnError(*args, **kwargs):
d6c14a4c 7586 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
7587 return _core_.Validator_SetBellOnError(*args, **kwargs)
7588
7589 SetBellOnError = staticmethod(SetBellOnError)
7590
7591class ValidatorPtr(Validator):
7592 def __init__(self, this):
7593 self.this = this
7594 if not hasattr(self,"thisown"): self.thisown = 0
7595 self.__class__ = Validator
7596_core_.Validator_swigregister(ValidatorPtr)
7597
7598def Validator_IsSilent(*args, **kwargs):
7599 """Validator_IsSilent() -> bool"""
7600 return _core_.Validator_IsSilent(*args, **kwargs)
7601
7602def Validator_SetBellOnError(*args, **kwargs):
7603 """Validator_SetBellOnError(int doIt=True)"""
7604 return _core_.Validator_SetBellOnError(*args, **kwargs)
7605
7606class PyValidator(Validator):
7607 def __repr__(self):
7608 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7609 def __init__(self, *args, **kwargs):
7610 """__init__(self) -> PyValidator"""
7611 newobj = _core_.new_PyValidator(*args, **kwargs)
7612 self.this = newobj.this
7613 self.thisown = 1
7614 del newobj.thisown
7615
7616 self._setCallbackInfo(self, PyValidator, 1)
7617 self._setOORInfo(self)
7618
7619 def _setCallbackInfo(*args, **kwargs):
7620 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
7621 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
7622
7623
7624class PyValidatorPtr(PyValidator):
7625 def __init__(self, this):
7626 self.this = this
7627 if not hasattr(self,"thisown"): self.thisown = 0
7628 self.__class__ = PyValidator
7629_core_.PyValidator_swigregister(PyValidatorPtr)
7630
7631#---------------------------------------------------------------------------
7632
7633class Menu(EvtHandler):
7634 def __repr__(self):
7635 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7636 def __init__(self, *args, **kwargs):
7637 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
7638 newobj = _core_.new_Menu(*args, **kwargs)
7639 self.this = newobj.this
7640 self.thisown = 1
7641 del newobj.thisown
7642 self._setOORInfo(self)
7643
7644 def Append(*args, **kwargs):
7645 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7646 return _core_.Menu_Append(*args, **kwargs)
7647
7648 def AppendSeparator(*args, **kwargs):
7649 """AppendSeparator(self) -> MenuItem"""
7650 return _core_.Menu_AppendSeparator(*args, **kwargs)
7651
7652 def AppendCheckItem(*args, **kwargs):
7653 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7654 return _core_.Menu_AppendCheckItem(*args, **kwargs)
7655
7656 def AppendRadioItem(*args, **kwargs):
7657 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7658 return _core_.Menu_AppendRadioItem(*args, **kwargs)
7659
7660 def AppendMenu(*args, **kwargs):
7661 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7662 return _core_.Menu_AppendMenu(*args, **kwargs)
7663
7664 def AppendItem(*args, **kwargs):
7665 """AppendItem(self, MenuItem item) -> MenuItem"""
7666 return _core_.Menu_AppendItem(*args, **kwargs)
7667
7668 def Break(*args, **kwargs):
7669 """Break(self)"""
7670 return _core_.Menu_Break(*args, **kwargs)
7671
7672 def InsertItem(*args, **kwargs):
7673 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
7674 return _core_.Menu_InsertItem(*args, **kwargs)
7675
7676 def Insert(*args, **kwargs):
7677 """
7678 Insert(self, size_t pos, int id, String text, String help=EmptyString,
7679 int kind=ITEM_NORMAL) -> MenuItem
7680 """
7681 return _core_.Menu_Insert(*args, **kwargs)
7682
7683 def InsertSeparator(*args, **kwargs):
7684 """InsertSeparator(self, size_t pos) -> MenuItem"""
7685 return _core_.Menu_InsertSeparator(*args, **kwargs)
7686
7687 def InsertCheckItem(*args, **kwargs):
7688 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7689 return _core_.Menu_InsertCheckItem(*args, **kwargs)
7690
7691 def InsertRadioItem(*args, **kwargs):
7692 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7693 return _core_.Menu_InsertRadioItem(*args, **kwargs)
7694
7695 def InsertMenu(*args, **kwargs):
7696 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7697 return _core_.Menu_InsertMenu(*args, **kwargs)
7698
7699 def PrependItem(*args, **kwargs):
7700 """PrependItem(self, MenuItem item) -> MenuItem"""
7701 return _core_.Menu_PrependItem(*args, **kwargs)
7702
7703 def Prepend(*args, **kwargs):
7704 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7705 return _core_.Menu_Prepend(*args, **kwargs)
7706
7707 def PrependSeparator(*args, **kwargs):
7708 """PrependSeparator(self) -> MenuItem"""
7709 return _core_.Menu_PrependSeparator(*args, **kwargs)
7710
7711 def PrependCheckItem(*args, **kwargs):
7712 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7713 return _core_.Menu_PrependCheckItem(*args, **kwargs)
7714
7715 def PrependRadioItem(*args, **kwargs):
7716 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7717 return _core_.Menu_PrependRadioItem(*args, **kwargs)
7718
7719 def PrependMenu(*args, **kwargs):
7720 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7721 return _core_.Menu_PrependMenu(*args, **kwargs)
7722
7723 def Remove(*args, **kwargs):
7724 """Remove(self, int id) -> MenuItem"""
7725 return _core_.Menu_Remove(*args, **kwargs)
7726
7727 def RemoveItem(*args, **kwargs):
7728 """RemoveItem(self, MenuItem item) -> MenuItem"""
7729 return _core_.Menu_RemoveItem(*args, **kwargs)
7730
7731 def Delete(*args, **kwargs):
7732 """Delete(self, int id) -> bool"""
7733 return _core_.Menu_Delete(*args, **kwargs)
7734
7735 def DeleteItem(*args, **kwargs):
7736 """DeleteItem(self, MenuItem item) -> bool"""
7737 return _core_.Menu_DeleteItem(*args, **kwargs)
7738
7739 def Destroy(*args, **kwargs):
7740 """
7741 Destroy(self)
7742
7743 Deletes the C++ object this Python object is a proxy for.
7744 """
7745 return _core_.Menu_Destroy(*args, **kwargs)
7746
7747 def DestroyId(*args, **kwargs):
7748 """
7749 DestroyId(self, int id) -> bool
7750
7751 Deletes the C++ object this Python object is a proxy for.
7752 """
7753 return _core_.Menu_DestroyId(*args, **kwargs)
7754
7755 def DestroyItem(*args, **kwargs):
7756 """
7757 DestroyItem(self, MenuItem item) -> bool
7758
7759 Deletes the C++ object this Python object is a proxy for.
7760 """
7761 return _core_.Menu_DestroyItem(*args, **kwargs)
7762
7763 def GetMenuItemCount(*args, **kwargs):
7764 """GetMenuItemCount(self) -> size_t"""
7765 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
7766
7767 def GetMenuItems(*args, **kwargs):
7768 """GetMenuItems(self) -> PyObject"""
7769 return _core_.Menu_GetMenuItems(*args, **kwargs)
7770
7771 def FindItem(*args, **kwargs):
7772 """FindItem(self, String item) -> int"""
7773 return _core_.Menu_FindItem(*args, **kwargs)
7774
7775 def FindItemById(*args, **kwargs):
7776 """FindItemById(self, int id) -> MenuItem"""
7777 return _core_.Menu_FindItemById(*args, **kwargs)
7778
7779 def FindItemByPosition(*args, **kwargs):
7780 """FindItemByPosition(self, size_t position) -> MenuItem"""
7781 return _core_.Menu_FindItemByPosition(*args, **kwargs)
7782
7783 def Enable(*args, **kwargs):
7784 """Enable(self, int id, bool enable)"""
7785 return _core_.Menu_Enable(*args, **kwargs)
7786
7787 def IsEnabled(*args, **kwargs):
7788 """IsEnabled(self, int id) -> bool"""
7789 return _core_.Menu_IsEnabled(*args, **kwargs)
7790
7791 def Check(*args, **kwargs):
7792 """Check(self, int id, bool check)"""
7793 return _core_.Menu_Check(*args, **kwargs)
7794
7795 def IsChecked(*args, **kwargs):
7796 """IsChecked(self, int id) -> bool"""
7797 return _core_.Menu_IsChecked(*args, **kwargs)
7798
7799 def SetLabel(*args, **kwargs):
7800 """SetLabel(self, int id, String label)"""
7801 return _core_.Menu_SetLabel(*args, **kwargs)
7802
7803 def GetLabel(*args, **kwargs):
7804 """GetLabel(self, int id) -> String"""
7805 return _core_.Menu_GetLabel(*args, **kwargs)
7806
7807 def SetHelpString(*args, **kwargs):
7808 """SetHelpString(self, int id, String helpString)"""
7809 return _core_.Menu_SetHelpString(*args, **kwargs)
7810
7811 def GetHelpString(*args, **kwargs):
7812 """GetHelpString(self, int id) -> String"""
7813 return _core_.Menu_GetHelpString(*args, **kwargs)
7814
7815 def SetTitle(*args, **kwargs):
7816 """SetTitle(self, String title)"""
7817 return _core_.Menu_SetTitle(*args, **kwargs)
7818
7819 def GetTitle(*args, **kwargs):
7820 """GetTitle(self) -> String"""
7821 return _core_.Menu_GetTitle(*args, **kwargs)
7822
7823 def SetEventHandler(*args, **kwargs):
7824 """SetEventHandler(self, EvtHandler handler)"""
7825 return _core_.Menu_SetEventHandler(*args, **kwargs)
7826
7827 def GetEventHandler(*args, **kwargs):
7828 """GetEventHandler(self) -> EvtHandler"""
7829 return _core_.Menu_GetEventHandler(*args, **kwargs)
7830
7831 def SetInvokingWindow(*args, **kwargs):
7832 """SetInvokingWindow(self, Window win)"""
7833 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
7834
7835 def GetInvokingWindow(*args, **kwargs):
7836 """GetInvokingWindow(self) -> Window"""
7837 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
7838
7839 def GetStyle(*args, **kwargs):
7840 """GetStyle(self) -> long"""
7841 return _core_.Menu_GetStyle(*args, **kwargs)
7842
7843 def UpdateUI(*args, **kwargs):
7844 """UpdateUI(self, EvtHandler source=None)"""
7845 return _core_.Menu_UpdateUI(*args, **kwargs)
7846
7847 def GetMenuBar(*args, **kwargs):
7848 """GetMenuBar(self) -> MenuBar"""
7849 return _core_.Menu_GetMenuBar(*args, **kwargs)
7850
7851 def Attach(*args, **kwargs):
7852 """Attach(self, wxMenuBarBase menubar)"""
7853 return _core_.Menu_Attach(*args, **kwargs)
7854
7855 def Detach(*args, **kwargs):
7856 """Detach(self)"""
7857 return _core_.Menu_Detach(*args, **kwargs)
7858
7859 def IsAttached(*args, **kwargs):
7860 """IsAttached(self) -> bool"""
7861 return _core_.Menu_IsAttached(*args, **kwargs)
7862
7863 def SetParent(*args, **kwargs):
7864 """SetParent(self, Menu parent)"""
7865 return _core_.Menu_SetParent(*args, **kwargs)
7866
7867 def GetParent(*args, **kwargs):
7868 """GetParent(self) -> Menu"""
7869 return _core_.Menu_GetParent(*args, **kwargs)
7870
7871
7872class MenuPtr(Menu):
7873 def __init__(self, this):
7874 self.this = this
7875 if not hasattr(self,"thisown"): self.thisown = 0
7876 self.__class__ = Menu
7877_core_.Menu_swigregister(MenuPtr)
7878DefaultValidator = cvar.DefaultValidator
7879
7880#---------------------------------------------------------------------------
7881
7882class MenuBar(Window):
7883 def __repr__(self):
7884 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7885 def __init__(self, *args, **kwargs):
7886 """__init__(self, long style=0) -> MenuBar"""
7887 newobj = _core_.new_MenuBar(*args, **kwargs)
7888 self.this = newobj.this
7889 self.thisown = 1
7890 del newobj.thisown
7891 self._setOORInfo(self)
7892
7893 def Append(*args, **kwargs):
7894 """Append(self, Menu menu, String title) -> bool"""
7895 return _core_.MenuBar_Append(*args, **kwargs)
7896
7897 def Insert(*args, **kwargs):
7898 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
7899 return _core_.MenuBar_Insert(*args, **kwargs)
7900
7901 def GetMenuCount(*args, **kwargs):
7902 """GetMenuCount(self) -> size_t"""
7903 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
7904
7905 def GetMenu(*args, **kwargs):
7906 """GetMenu(self, size_t pos) -> Menu"""
7907 return _core_.MenuBar_GetMenu(*args, **kwargs)
7908
7909 def Replace(*args, **kwargs):
7910 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
7911 return _core_.MenuBar_Replace(*args, **kwargs)
7912
7913 def Remove(*args, **kwargs):
7914 """Remove(self, size_t pos) -> Menu"""
7915 return _core_.MenuBar_Remove(*args, **kwargs)
7916
7917 def EnableTop(*args, **kwargs):
7918 """EnableTop(self, size_t pos, bool enable)"""
7919 return _core_.MenuBar_EnableTop(*args, **kwargs)
7920
7921 def IsEnabledTop(*args, **kwargs):
7922 """IsEnabledTop(self, size_t pos) -> bool"""
7923 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
7924
7925 def SetLabelTop(*args, **kwargs):
7926 """SetLabelTop(self, size_t pos, String label)"""
7927 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
7928
7929 def GetLabelTop(*args, **kwargs):
7930 """GetLabelTop(self, size_t pos) -> String"""
7931 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
7932
7933 def FindMenuItem(*args, **kwargs):
7934 """FindMenuItem(self, String menu, String item) -> int"""
7935 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
7936
7937 def FindItemById(*args, **kwargs):
7938 """FindItemById(self, int id) -> MenuItem"""
7939 return _core_.MenuBar_FindItemById(*args, **kwargs)
7940
7941 def FindMenu(*args, **kwargs):
7942 """FindMenu(self, String title) -> int"""
7943 return _core_.MenuBar_FindMenu(*args, **kwargs)
7944
7945 def Enable(*args, **kwargs):
7946 """Enable(self, int id, bool enable)"""
7947 return _core_.MenuBar_Enable(*args, **kwargs)
7948
7949 def Check(*args, **kwargs):
7950 """Check(self, int id, bool check)"""
7951 return _core_.MenuBar_Check(*args, **kwargs)
7952
7953 def IsChecked(*args, **kwargs):
7954 """IsChecked(self, int id) -> bool"""
7955 return _core_.MenuBar_IsChecked(*args, **kwargs)
7956
7957 def IsEnabled(*args, **kwargs):
7958 """IsEnabled(self, int id) -> bool"""
7959 return _core_.MenuBar_IsEnabled(*args, **kwargs)
7960
7961 def SetLabel(*args, **kwargs):
7962 """SetLabel(self, int id, String label)"""
7963 return _core_.MenuBar_SetLabel(*args, **kwargs)
7964
7965 def GetLabel(*args, **kwargs):
7966 """GetLabel(self, int id) -> String"""
7967 return _core_.MenuBar_GetLabel(*args, **kwargs)
7968
7969 def SetHelpString(*args, **kwargs):
7970 """SetHelpString(self, int id, String helpString)"""
7971 return _core_.MenuBar_SetHelpString(*args, **kwargs)
7972
7973 def GetHelpString(*args, **kwargs):
7974 """GetHelpString(self, int id) -> String"""
7975 return _core_.MenuBar_GetHelpString(*args, **kwargs)
7976
7977 def GetFrame(*args, **kwargs):
7978 """GetFrame(self) -> wxFrame"""
7979 return _core_.MenuBar_GetFrame(*args, **kwargs)
7980
7981 def IsAttached(*args, **kwargs):
7982 """IsAttached(self) -> bool"""
7983 return _core_.MenuBar_IsAttached(*args, **kwargs)
7984
7985 def Attach(*args, **kwargs):
7986 """Attach(self, wxFrame frame)"""
7987 return _core_.MenuBar_Attach(*args, **kwargs)
7988
7989 def Detach(*args, **kwargs):
7990 """Detach(self)"""
7991 return _core_.MenuBar_Detach(*args, **kwargs)
7992
7993
7994class MenuBarPtr(MenuBar):
7995 def __init__(self, this):
7996 self.this = this
7997 if not hasattr(self,"thisown"): self.thisown = 0
7998 self.__class__ = MenuBar
7999_core_.MenuBar_swigregister(MenuBarPtr)
8000
8001#---------------------------------------------------------------------------
8002
8003class MenuItem(Object):
8004 def __repr__(self):
8005 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8006 def __init__(self, *args, **kwargs):
8007 """
8008 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
8009 String help=EmptyString, int kind=ITEM_NORMAL,
8010 Menu subMenu=None) -> MenuItem
8011 """
8012 newobj = _core_.new_MenuItem(*args, **kwargs)
8013 self.this = newobj.this
8014 self.thisown = 1
8015 del newobj.thisown
8016 def GetMenu(*args, **kwargs):
8017 """GetMenu(self) -> Menu"""
8018 return _core_.MenuItem_GetMenu(*args, **kwargs)
8019
8020 def SetMenu(*args, **kwargs):
8021 """SetMenu(self, Menu menu)"""
8022 return _core_.MenuItem_SetMenu(*args, **kwargs)
8023
8024 def SetId(*args, **kwargs):
8025 """SetId(self, int id)"""
8026 return _core_.MenuItem_SetId(*args, **kwargs)
8027
8028 def GetId(*args, **kwargs):
8029 """GetId(self) -> int"""
8030 return _core_.MenuItem_GetId(*args, **kwargs)
8031
8032 def IsSeparator(*args, **kwargs):
8033 """IsSeparator(self) -> bool"""
8034 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8035
8036 def SetText(*args, **kwargs):
8037 """SetText(self, String str)"""
8038 return _core_.MenuItem_SetText(*args, **kwargs)
8039
8040 def GetLabel(*args, **kwargs):
8041 """GetLabel(self) -> String"""
8042 return _core_.MenuItem_GetLabel(*args, **kwargs)
8043
8044 def GetText(*args, **kwargs):
8045 """GetText(self) -> String"""
8046 return _core_.MenuItem_GetText(*args, **kwargs)
8047
8048 def GetLabelFromText(*args, **kwargs):
d6c14a4c 8049 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
8050 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8051
8052 GetLabelFromText = staticmethod(GetLabelFromText)
8053 def GetKind(*args, **kwargs):
8054 """GetKind(self) -> int"""
8055 return _core_.MenuItem_GetKind(*args, **kwargs)
8056
8057 def SetKind(*args, **kwargs):
8058 """SetKind(self, int kind)"""
8059 return _core_.MenuItem_SetKind(*args, **kwargs)
8060
8061 def SetCheckable(*args, **kwargs):
8062 """SetCheckable(self, bool checkable)"""
8063 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8064
8065 def IsCheckable(*args, **kwargs):
8066 """IsCheckable(self) -> bool"""
8067 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8068
8069 def IsSubMenu(*args, **kwargs):
8070 """IsSubMenu(self) -> bool"""
8071 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8072
8073 def SetSubMenu(*args, **kwargs):
8074 """SetSubMenu(self, Menu menu)"""
8075 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8076
8077 def GetSubMenu(*args, **kwargs):
8078 """GetSubMenu(self) -> Menu"""
8079 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8080
8081 def Enable(*args, **kwargs):
8082 """Enable(self, bool enable=True)"""
8083 return _core_.MenuItem_Enable(*args, **kwargs)
8084
8085 def IsEnabled(*args, **kwargs):
8086 """IsEnabled(self) -> bool"""
8087 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8088
8089 def Check(*args, **kwargs):
8090 """Check(self, bool check=True)"""
8091 return _core_.MenuItem_Check(*args, **kwargs)
8092
8093 def IsChecked(*args, **kwargs):
8094 """IsChecked(self) -> bool"""
8095 return _core_.MenuItem_IsChecked(*args, **kwargs)
8096
8097 def Toggle(*args, **kwargs):
8098 """Toggle(self)"""
8099 return _core_.MenuItem_Toggle(*args, **kwargs)
8100
8101 def SetHelp(*args, **kwargs):
8102 """SetHelp(self, String str)"""
8103 return _core_.MenuItem_SetHelp(*args, **kwargs)
8104
8105 def GetHelp(*args, **kwargs):
8106 """GetHelp(self) -> String"""
8107 return _core_.MenuItem_GetHelp(*args, **kwargs)
8108
8109 def GetAccel(*args, **kwargs):
8110 """GetAccel(self) -> AcceleratorEntry"""
8111 return _core_.MenuItem_GetAccel(*args, **kwargs)
8112
8113 def SetAccel(*args, **kwargs):
8114 """SetAccel(self, AcceleratorEntry accel)"""
8115 return _core_.MenuItem_SetAccel(*args, **kwargs)
8116
8117 def GetDefaultMarginWidth(*args, **kwargs):
d6c14a4c 8118 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
8119 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8120
8121 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8122 def SetBitmap(*args, **kwargs):
8123 """SetBitmap(self, Bitmap bitmap)"""
8124 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8125
8126 def GetBitmap(*args, **kwargs):
8127 """GetBitmap(self) -> Bitmap"""
8128 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8129
8130
8131class MenuItemPtr(MenuItem):
8132 def __init__(self, this):
8133 self.this = this
8134 if not hasattr(self,"thisown"): self.thisown = 0
8135 self.__class__ = MenuItem
8136_core_.MenuItem_swigregister(MenuItemPtr)
8137
8138def MenuItem_GetLabelFromText(*args, **kwargs):
8139 """MenuItem_GetLabelFromText(String text) -> String"""
8140 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8141
8142def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8143 """MenuItem_GetDefaultMarginWidth() -> int"""
8144 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8145
8146#---------------------------------------------------------------------------
8147
8148class Control(Window):
8149 """
8150 This is the base class for a control or 'widget'.
8151
15817c7e
RD
8152 A control is generally a small window which processes user input
8153 and/or displays one or more item of data.
d55e5bfc
RD
8154 """
8155 def __repr__(self):
8156 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8157 def __init__(self, *args, **kwargs):
8158 """
bfddbb17
RD
8159 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8160 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8161 String name=ControlNameStr) -> Control
8162
15817c7e
RD
8163 Create a Control. Normally you should only call this from a subclass'
8164 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
8165 """
8166 newobj = _core_.new_Control(*args, **kwargs)
8167 self.this = newobj.this
8168 self.thisown = 1
8169 del newobj.thisown
8170 self._setOORInfo(self)
8171
8172 def Create(*args, **kwargs):
8173 """
bfddbb17
RD
8174 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8175 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8176 String name=ControlNameStr) -> bool
8177
8178 Do the 2nd phase and create the GUI control.
8179 """
8180 return _core_.Control_Create(*args, **kwargs)
8181
8182 def Command(*args, **kwargs):
8183 """
8184 Command(self, CommandEvent event)
8185
15817c7e
RD
8186 Simulates the effect of the user issuing a command to the item.
8187
8188 :see: `wx.CommandEvent`
8189
d55e5bfc
RD
8190 """
8191 return _core_.Control_Command(*args, **kwargs)
8192
8193 def GetLabel(*args, **kwargs):
8194 """
8195 GetLabel(self) -> String
8196
8197 Return a control's text.
8198 """
8199 return _core_.Control_GetLabel(*args, **kwargs)
8200
8201 def SetLabel(*args, **kwargs):
8202 """
8203 SetLabel(self, String label)
8204
8205 Sets the item's text.
8206 """
8207 return _core_.Control_SetLabel(*args, **kwargs)
8208
8209 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8210 """
8211 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8212
8213 Get the default attributes for this class. This is useful if you want
8214 to use the same font or colour in your own control as in a standard
8215 control -- which is a much better idea than hard coding specific
8216 colours or fonts which might look completely out of place on the
8217 user's system, especially if it uses themes.
8218
8219 The variant parameter is only relevant under Mac currently and is
8220 ignore under other platforms. Under Mac, it will change the size of
8221 the returned font. See `wx.Window.SetWindowVariant` for more about
8222 this.
8223 """
d55e5bfc
RD
8224 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8225
8226 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8227
8228class ControlPtr(Control):
8229 def __init__(self, this):
8230 self.this = this
8231 if not hasattr(self,"thisown"): self.thisown = 0
8232 self.__class__ = Control
8233_core_.Control_swigregister(ControlPtr)
8234ControlNameStr = cvar.ControlNameStr
8235
8236def PreControl(*args, **kwargs):
8237 """
8238 PreControl() -> Control
8239
8240 Precreate a Control control for 2-phase creation
8241 """
8242 val = _core_.new_PreControl(*args, **kwargs)
8243 val.thisown = 1
8244 return val
8245
8246def Control_GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8247 """
8248 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8249
8250 Get the default attributes for this class. This is useful if you want
8251 to use the same font or colour in your own control as in a standard
8252 control -- which is a much better idea than hard coding specific
8253 colours or fonts which might look completely out of place on the
8254 user's system, especially if it uses themes.
8255
8256 The variant parameter is only relevant under Mac currently and is
8257 ignore under other platforms. Under Mac, it will change the size of
8258 the returned font. See `wx.Window.SetWindowVariant` for more about
8259 this.
8260 """
d55e5bfc
RD
8261 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8262
8263#---------------------------------------------------------------------------
8264
8265class ItemContainer(object):
8266 """
8267 wx.ItemContainer defines an interface which is implemented by all
15817c7e
RD
8268 controls which have string subitems, each of which may be selected,
8269 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8270 `wx.ComboBox` which implements an extended interface deriving from
8271 this one.
d55e5bfc 8272
15817c7e
RD
8273 It defines the methods for accessing the control's items and although
8274 each of the derived classes implements them differently, they still
8275 all conform to the same interface.
d55e5bfc 8276
15817c7e
RD
8277 The items in a wx.ItemContainer have (non empty) string labels and,
8278 optionally, client data associated with them.
d55e5bfc
RD
8279
8280 """
8281 def __init__(self): raise RuntimeError, "No constructor defined"
8282 def __repr__(self):
8283 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8284 def Append(*args, **kwargs):
8285 """
8286 Append(self, String item, PyObject clientData=None) -> int
8287
15817c7e
RD
8288 Adds the item to the control, associating the given data with the item
8289 if not None. The return value is the index of the newly added item
8290 which may be different from the last one if the control is sorted (e.g.
8291 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
8292 """
8293 return _core_.ItemContainer_Append(*args, **kwargs)
8294
8295 def AppendItems(*args, **kwargs):
8296 """
8297 AppendItems(self, wxArrayString strings)
8298
15817c7e
RD
8299 Apend several items at once to the control. Notice that calling this
8300 method may be much faster than appending the items one by one if you
8301 need to add a lot of items.
d55e5bfc
RD
8302 """
8303 return _core_.ItemContainer_AppendItems(*args, **kwargs)
8304
8305 def Insert(*args, **kwargs):
8306 """
8307 Insert(self, String item, int pos, PyObject clientData=None) -> int
8308
15817c7e 8309 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
8310 optionally associating some data object with the item.
8311 """
8312 return _core_.ItemContainer_Insert(*args, **kwargs)
8313
8314 def Clear(*args, **kwargs):
8315 """
8316 Clear(self)
8317
8318 Removes all items from the control.
8319 """
8320 return _core_.ItemContainer_Clear(*args, **kwargs)
8321
8322 def Delete(*args, **kwargs):
8323 """
8324 Delete(self, int n)
8325
15817c7e
RD
8326 Deletes the item at the zero-based index 'n' from the control. Note
8327 that it is an error (signalled by a `wx.PyAssertionError` exception if
8328 enabled) to remove an item with the index negative or greater or equal
8329 than the number of items in the control.
d55e5bfc
RD
8330 """
8331 return _core_.ItemContainer_Delete(*args, **kwargs)
8332
8333 def GetCount(*args, **kwargs):
8334 """
8335 GetCount(self) -> int
8336
8337 Returns the number of items in the control.
8338 """
8339 return _core_.ItemContainer_GetCount(*args, **kwargs)
8340
8341 def IsEmpty(*args, **kwargs):
8342 """
8343 IsEmpty(self) -> bool
8344
8345 Returns True if the control is empty or False if it has some items.
8346 """
8347 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
8348
8349 def GetString(*args, **kwargs):
8350 """
8351 GetString(self, int n) -> String
8352
8353 Returns the label of the item with the given index.
8354 """
8355 return _core_.ItemContainer_GetString(*args, **kwargs)
8356
8357 def GetStrings(*args, **kwargs):
8358 """GetStrings(self) -> wxArrayString"""
8359 return _core_.ItemContainer_GetStrings(*args, **kwargs)
8360
8361 def SetString(*args, **kwargs):
8362 """
8363 SetString(self, int n, String s)
8364
8365 Sets the label for the given item.
8366 """
8367 return _core_.ItemContainer_SetString(*args, **kwargs)
8368
8369 def FindString(*args, **kwargs):
8370 """
8371 FindString(self, String s) -> int
8372
8373 Finds an item whose label matches the given string. Returns the
15817c7e
RD
8374 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8375 found.
d55e5bfc
RD
8376 """
8377 return _core_.ItemContainer_FindString(*args, **kwargs)
8378
8379 def Select(*args, **kwargs):
8380 """
8381 Select(self, int n)
8382
8383 Sets the item at index 'n' to be the selected item.
8384 """
8385 return _core_.ItemContainer_Select(*args, **kwargs)
8386
8387 SetSelection = Select
8388 def GetSelection(*args, **kwargs):
8389 """
8390 GetSelection(self) -> int
8391
15817c7e
RD
8392 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8393 is selected.
d55e5bfc
RD
8394 """
8395 return _core_.ItemContainer_GetSelection(*args, **kwargs)
8396
8397 def GetStringSelection(*args, **kwargs):
8398 """
8399 GetStringSelection(self) -> String
8400
15817c7e
RD
8401 Returns the label of the selected item or an empty string if no item
8402 is selected.
d55e5bfc
RD
8403 """
8404 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
8405
8406 def GetClientData(*args, **kwargs):
8407 """
8408 GetClientData(self, int n) -> PyObject
8409
8410 Returns the client data associated with the given item, (if any.)
8411 """
8412 return _core_.ItemContainer_GetClientData(*args, **kwargs)
8413
8414 def SetClientData(*args, **kwargs):
8415 """
8416 SetClientData(self, int n, PyObject clientData)
8417
8418 Associate the given client data with the item at position n.
8419 """
8420 return _core_.ItemContainer_SetClientData(*args, **kwargs)
8421
8422
8423class ItemContainerPtr(ItemContainer):
8424 def __init__(self, this):
8425 self.this = this
8426 if not hasattr(self,"thisown"): self.thisown = 0
8427 self.__class__ = ItemContainer
8428_core_.ItemContainer_swigregister(ItemContainerPtr)
8429
8430#---------------------------------------------------------------------------
8431
8432class ControlWithItems(Control,ItemContainer):
8433 """
15817c7e
RD
8434 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8435 wx.Control class, and is used for the base class of various controls
8436 that have items.
d55e5bfc
RD
8437 """
8438 def __init__(self): raise RuntimeError, "No constructor defined"
8439 def __repr__(self):
8440 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8441
8442class ControlWithItemsPtr(ControlWithItems):
8443 def __init__(self, this):
8444 self.this = this
8445 if not hasattr(self,"thisown"): self.thisown = 0
8446 self.__class__ = ControlWithItems
8447_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
8448
8449#---------------------------------------------------------------------------
8450
8451class SizerItem(Object):
bfddbb17
RD
8452 """
8453 The wx.SizerItem class is used to track the position, size and other
8454 attributes of each item managed by a `wx.Sizer`. In normal usage user
8455 code should never need to deal directly with a wx.SizerItem, but
8456 custom classes derived from `wx.PySizer` will probably need to use the
8457 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8458
8459 :see: `wx.Sizer`, `wx.GBSizerItem`
8460 """
d55e5bfc
RD
8461 def __repr__(self):
8462 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8463 def __init__(self, *args, **kwargs):
bfddbb17
RD
8464 """
8465 __init__(self) -> SizerItem
8466
8467 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8468 size will need to be set before this item can be used in a Sizer.
8469
8470 You will probably never need to create a wx.SizerItem directly as they
8471 are created automatically when the sizer's Add, Insert or Prepend
8472 methods are called.
8473
8474 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8475 """
d55e5bfc
RD
8476 newobj = _core_.new_SizerItem(*args, **kwargs)
8477 self.this = newobj.this
8478 self.thisown = 1
8479 del newobj.thisown
8480 def DeleteWindows(*args, **kwargs):
bfddbb17
RD
8481 """
8482 DeleteWindows(self)
8483
8484 Destroy the window or the windows in a subsizer, depending on the type
8485 of item.
8486 """
d55e5bfc
RD
8487 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
8488
8489 def DetachSizer(*args, **kwargs):
bfddbb17
RD
8490 """
8491 DetachSizer(self)
8492
8493 Enable deleting the SizerItem without destroying the contained sizer.
8494 """
d55e5bfc
RD
8495 return _core_.SizerItem_DetachSizer(*args, **kwargs)
8496
8497 def GetSize(*args, **kwargs):
bfddbb17
RD
8498 """
8499 GetSize(self) -> Size
8500
8501 Get the current size of the item, as set in the last Layout.
8502 """
d55e5bfc
RD
8503 return _core_.SizerItem_GetSize(*args, **kwargs)
8504
8505 def CalcMin(*args, **kwargs):
bfddbb17
RD
8506 """
8507 CalcMin(self) -> Size
8508
8509 Calculates the minimum desired size for the item, including any space
8510 needed by borders.
8511 """
d55e5bfc
RD
8512 return _core_.SizerItem_CalcMin(*args, **kwargs)
8513
8514 def SetDimension(*args, **kwargs):
bfddbb17
RD
8515 """
8516 SetDimension(self, Point pos, Size size)
8517
8518 Set the position and size of the space allocated for this item by the
8519 sizer, and adjust the position and size of the item (window or
8520 subsizer) to be within that space taking alignment and borders into
8521 account.
8522 """
d55e5bfc
RD
8523 return _core_.SizerItem_SetDimension(*args, **kwargs)
8524
8525 def GetMinSize(*args, **kwargs):
bfddbb17
RD
8526 """
8527 GetMinSize(self) -> Size
8528
8529 Get the minimum size needed for the item.
8530 """
d55e5bfc
RD
8531 return _core_.SizerItem_GetMinSize(*args, **kwargs)
8532
a001823c
RD
8533 def GetMinSizeWithBorder(*args, **kwargs):
8534 """
8535 GetMinSizeWithBorder(self) -> Size
8536
8537 Get the minimum size needed for the item with space for the borders
8538 added, if needed.
8539 """
8540 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
8541
d55e5bfc
RD
8542 def SetInitSize(*args, **kwargs):
8543 """SetInitSize(self, int x, int y)"""
8544 return _core_.SizerItem_SetInitSize(*args, **kwargs)
8545
8546 def SetRatioWH(*args, **kwargs):
bfddbb17
RD
8547 """
8548 SetRatioWH(self, int width, int height)
8549
8550 Set the ratio item attribute.
8551 """
d55e5bfc
RD
8552 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
8553
8554 def SetRatioSize(*args, **kwargs):
bfddbb17
RD
8555 """
8556 SetRatioSize(self, Size size)
8557
8558 Set the ratio item attribute.
8559 """
d55e5bfc
RD
8560 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
8561
8562 def SetRatio(*args, **kwargs):
bfddbb17
RD
8563 """
8564 SetRatio(self, float ratio)
8565
8566 Set the ratio item attribute.
8567 """
d55e5bfc
RD
8568 return _core_.SizerItem_SetRatio(*args, **kwargs)
8569
8570 def GetRatio(*args, **kwargs):
bfddbb17
RD
8571 """
8572 GetRatio(self) -> float
8573
8574 Set the ratio item attribute.
8575 """
d55e5bfc
RD
8576 return _core_.SizerItem_GetRatio(*args, **kwargs)
8577
8578 def IsWindow(*args, **kwargs):
bfddbb17
RD
8579 """
8580 IsWindow(self) -> bool
8581
8582 Is this sizer item a window?
8583 """
d55e5bfc
RD
8584 return _core_.SizerItem_IsWindow(*args, **kwargs)
8585
8586 def IsSizer(*args, **kwargs):
bfddbb17
RD
8587 """
8588 IsSizer(self) -> bool
8589
8590 Is this sizer item a subsizer?
8591 """
d55e5bfc
RD
8592 return _core_.SizerItem_IsSizer(*args, **kwargs)
8593
8594 def IsSpacer(*args, **kwargs):
bfddbb17
RD
8595 """
8596 IsSpacer(self) -> bool
8597
8598 Is this sizer item a spacer?
8599 """
d55e5bfc
RD
8600 return _core_.SizerItem_IsSpacer(*args, **kwargs)
8601
8602 def SetProportion(*args, **kwargs):
bfddbb17
RD
8603 """
8604 SetProportion(self, int proportion)
8605
8606 Set the proportion value for this item.
8607 """
d55e5bfc
RD
8608 return _core_.SizerItem_SetProportion(*args, **kwargs)
8609
8610 def GetProportion(*args, **kwargs):
bfddbb17
RD
8611 """
8612 GetProportion(self) -> int
8613
8614 Get the proportion value for this item.
8615 """
d55e5bfc
RD
8616 return _core_.SizerItem_GetProportion(*args, **kwargs)
8617
bfddbb17
RD
8618 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8619 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 8620 def SetFlag(*args, **kwargs):
bfddbb17
RD
8621 """
8622 SetFlag(self, int flag)
8623
8624 Set the flag value for this item.
8625 """
d55e5bfc
RD
8626 return _core_.SizerItem_SetFlag(*args, **kwargs)
8627
8628 def GetFlag(*args, **kwargs):
bfddbb17
RD
8629 """
8630 GetFlag(self) -> int
8631
8632 Get the flag value for this item.
8633 """
d55e5bfc
RD
8634 return _core_.SizerItem_GetFlag(*args, **kwargs)
8635
8636 def SetBorder(*args, **kwargs):
bfddbb17
RD
8637 """
8638 SetBorder(self, int border)
8639
8640 Set the border value for this item.
8641 """
d55e5bfc
RD
8642 return _core_.SizerItem_SetBorder(*args, **kwargs)
8643
8644 def GetBorder(*args, **kwargs):
bfddbb17
RD
8645 """
8646 GetBorder(self) -> int
8647
8648 Get the border value for this item.
8649 """
d55e5bfc
RD
8650 return _core_.SizerItem_GetBorder(*args, **kwargs)
8651
8652 def GetWindow(*args, **kwargs):
bfddbb17
RD
8653 """
8654 GetWindow(self) -> Window
8655
8656 Get the window (if any) that is managed by this sizer item.
8657 """
d55e5bfc
RD
8658 return _core_.SizerItem_GetWindow(*args, **kwargs)
8659
8660 def SetWindow(*args, **kwargs):
bfddbb17
RD
8661 """
8662 SetWindow(self, Window window)
8663
8664 Set the window to be managed by this sizer item.
8665 """
d55e5bfc
RD
8666 return _core_.SizerItem_SetWindow(*args, **kwargs)
8667
8668 def GetSizer(*args, **kwargs):
bfddbb17
RD
8669 """
8670 GetSizer(self) -> Sizer
8671
8672 Get the subsizer (if any) that is managed by this sizer item.
8673 """
d55e5bfc
RD
8674 return _core_.SizerItem_GetSizer(*args, **kwargs)
8675
8676 def SetSizer(*args, **kwargs):
bfddbb17
RD
8677 """
8678 SetSizer(self, Sizer sizer)
8679
8680 Set the subsizer to be managed by this sizer item.
8681 """
d55e5bfc
RD
8682 return _core_.SizerItem_SetSizer(*args, **kwargs)
8683
8684 def GetSpacer(*args, **kwargs):
bfddbb17
RD
8685 """
8686 GetSpacer(self) -> Size
8687
8688 Get the size of the spacer managed by this sizer item.
8689 """
d55e5bfc
RD
8690 return _core_.SizerItem_GetSpacer(*args, **kwargs)
8691
8692 def SetSpacer(*args, **kwargs):
bfddbb17
RD
8693 """
8694 SetSpacer(self, Size size)
8695
8696 Set the size of the spacer to be managed by this sizer item.
8697 """
d55e5bfc
RD
8698 return _core_.SizerItem_SetSpacer(*args, **kwargs)
8699
8700 def Show(*args, **kwargs):
bfddbb17
RD
8701 """
8702 Show(self, bool show)
8703
8704 Set the show item attribute, which sizers use to determine if the item
8705 is to be made part of the layout or not. If the item is tracking a
8706 window then it is shown or hidden as needed.
8707 """
d55e5bfc
RD
8708 return _core_.SizerItem_Show(*args, **kwargs)
8709
8710 def IsShown(*args, **kwargs):
bfddbb17
RD
8711 """
8712 IsShown(self) -> bool
8713
8714 Is the item to be shown in the layout?
8715 """
d55e5bfc
RD
8716 return _core_.SizerItem_IsShown(*args, **kwargs)
8717
8718 def GetPosition(*args, **kwargs):
bfddbb17
RD
8719 """
8720 GetPosition(self) -> Point
8721
8722 Returns the current position of the item, as set in the last Layout.
8723 """
d55e5bfc
RD
8724 return _core_.SizerItem_GetPosition(*args, **kwargs)
8725
8726 def GetUserData(*args, **kwargs):
bfddbb17
RD
8727 """
8728 GetUserData(self) -> PyObject
8729
8730 Returns the userData associated with this sizer item, or None if there
8731 isn't any.
8732 """
d55e5bfc
RD
8733 return _core_.SizerItem_GetUserData(*args, **kwargs)
8734
8735
8736class SizerItemPtr(SizerItem):
8737 def __init__(self, this):
8738 self.this = this
8739 if not hasattr(self,"thisown"): self.thisown = 0
8740 self.__class__ = SizerItem
8741_core_.SizerItem_swigregister(SizerItemPtr)
8742
bfddbb17 8743def SizerItemWindow(*args, **kwargs):
d55e5bfc 8744 """
bfddbb17
RD
8745 SizerItemWindow(Window window, int proportion, int flag, int border,
8746 PyObject userData=None) -> SizerItem
8747
8748 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 8749 """
bfddbb17 8750 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
8751 val.thisown = 1
8752 return val
8753
bfddbb17 8754def SizerItemSpacer(*args, **kwargs):
d55e5bfc 8755 """
bfddbb17
RD
8756 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
8757 PyObject userData=None) -> SizerItem
8758
8759 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 8760 """
bfddbb17 8761 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
8762 val.thisown = 1
8763 return val
8764
8765def SizerItemSizer(*args, **kwargs):
8766 """
8767 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
bfddbb17
RD
8768 PyObject userData=None) -> SizerItem
8769
8770 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
8771 """
8772 val = _core_.new_SizerItemSizer(*args, **kwargs)
8773 val.thisown = 1
8774 return val
8775
8776class Sizer(Object):
bfddbb17
RD
8777 """
8778 wx.Sizer is the abstract base class used for laying out subwindows in
8779 a window. You cannot use wx.Sizer directly; instead, you will have to
8780 use one of the sizer classes derived from it such as `wx.BoxSizer`,
8781 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
8782 and `wx.GridBagSizer`.
8783
8784 The concept implemented by sizers in wxWidgets is closely related to
8785 layout tools in other GUI toolkits, such as Java's AWT, the GTK
8786 toolkit or the Qt toolkit. It is based upon the idea of the individual
8787 subwindows reporting their minimal required size and their ability to
8788 get stretched if the size of the parent window has changed. This will
8789 most often mean that the programmer does not set the original size of
8790 a dialog in the beginning, rather the dialog will assigned a sizer and
8791 this sizer will be queried about the recommended size. The sizer in
8792 turn will query its children, which can be normal windows or contorls,
8793 empty space or other sizers, so that a hierarchy of sizers can be
8794 constructed. Note that wxSizer does not derive from wxWindow and thus
8795 do not interfere with tab ordering and requires very little resources
8796 compared to a real window on screen.
8797
8798 What makes sizers so well fitted for use in wxWidgets is the fact that
8799 every control reports its own minimal size and the algorithm can
8800 handle differences in font sizes or different window (dialog item)
8801 sizes on different platforms without problems. If for example the
8802 standard font as well as the overall design of Mac widgets requires
8803 more space than on Windows, then the initial size of a dialog using a
8804 sizer will automatically be bigger on Mac than on Windows.
8805 """
d55e5bfc
RD
8806 def __init__(self): raise RuntimeError, "No constructor defined"
8807 def __repr__(self):
8808 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8809 def _setOORInfo(*args, **kwargs):
8810 """_setOORInfo(self, PyObject _self)"""
8811 return _core_.Sizer__setOORInfo(*args, **kwargs)
8812
8813 def Add(*args, **kwargs):
8814 """
bfddbb17 8815 Add(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 8816 PyObject userData=None)
bfddbb17
RD
8817
8818 Appends a child item to the sizer.
d55e5bfc
RD
8819 """
8820 return _core_.Sizer_Add(*args, **kwargs)
8821
8822 def Insert(*args, **kwargs):
8823 """
bfddbb17
RD
8824 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
8825 PyObject userData=None)
8826
8827 Inserts a new item into the list of items managed by this sizer before
8828 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
8829 """
8830 return _core_.Sizer_Insert(*args, **kwargs)
8831
8832 def Prepend(*args, **kwargs):
8833 """
bfddbb17 8834 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 8835 PyObject userData=None)
bfddbb17
RD
8836
8837 Adds a new item to the begining of the list of sizer items managed by
8838 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
8839 """
8840 return _core_.Sizer_Prepend(*args, **kwargs)
8841
8842 def Remove(*args, **kwargs):
bfddbb17
RD
8843 """
8844 Remove(self, item) -> bool
8845
8846 Removes an item from the sizer and destroys it. This method does not
8847 cause any layout or resizing to take place, call `Layout` to update
8848 the layout on screen after removing a child from the sizer. The
8849 *item* parameter can be either a window, a sizer, or the zero-based
8850 index of an item to remove. Returns True if the child item was found
8851 and removed.
8852 """
d55e5bfc
RD
8853 return _core_.Sizer_Remove(*args, **kwargs)
8854
1a6bba1e 8855 def Detach(*args, **kwargs):
bfddbb17
RD
8856 """
8857 Detach(self, item) -> bool
8858
8859 Detaches an item from the sizer without destroying it. This method
8860 does not cause any layout or resizing to take place, call `Layout` to
8861 do so. The *item* parameter can be either a window, a sizer, or the
8862 zero-based index of the item to be detached. Returns True if the child item
8863 was found and detached.
8864 """
1a6bba1e
RD
8865 return _core_.Sizer_Detach(*args, **kwargs)
8866
d55e5bfc
RD
8867 def _SetItemMinSize(*args, **kwargs):
8868 """_SetItemMinSize(self, PyObject item, Size size)"""
8869 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
8870
bfddbb17
RD
8871 def SetItemMinSize(self, item, *args):
8872 """
8873 SetItemMinSize(self, item, Size size)
8874
8875 Sets the minimum size that will be allocated for an item in the sizer.
8876 The *item* parameter can be either a window, a sizer, or the
8877 zero-based index of the item. If a window or sizer is given then it
8878 will be searched for recursivly in subsizers if neccessary.
8879 """
8880 if len(args) == 2:
8881 # for backward compatibility accept separate width,height args too
8882 return self._SetItemMinSize(item, args)
8883 else:
8884 return self._SetItemMinSize(item, args[0])
8885
d55e5bfc 8886 def AddItem(*args, **kwargs):
bfddbb17
RD
8887 """
8888 AddItem(self, SizerItem item)
8889
8890 Adds a `wx.SizerItem` to the sizer.
8891 """
d55e5bfc
RD
8892 return _core_.Sizer_AddItem(*args, **kwargs)
8893
8894 def InsertItem(*args, **kwargs):
bfddbb17
RD
8895 """
8896 InsertItem(self, int index, SizerItem item)
8897
8898 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
8899 """
d55e5bfc
RD
8900 return _core_.Sizer_InsertItem(*args, **kwargs)
8901
8902 def PrependItem(*args, **kwargs):
bfddbb17
RD
8903 """
8904 PrependItem(self, SizerItem item)
8905
8906 Prepends a `wx.SizerItem` to the sizer.
8907 """
d55e5bfc
RD
8908 return _core_.Sizer_PrependItem(*args, **kwargs)
8909
bfddbb17 8910 def AddMany(self, items):
d6c14a4c
RD
8911 """
8912 AddMany is a convenience method for adding several items
8913 to a sizer at one time. Simply pass it a list of tuples,
8914 where each tuple consists of the parameters that you
8915 would normally pass to the `Add` method.
8916 """
bfddbb17
RD
8917 for item in items:
8918 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
8919 item = (item, )
8920 self.Add(*item)
d55e5bfc
RD
8921
8922 # for backwards compatibility only, please do not use in new code
d6c14a4c
RD
8923 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
8924 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
8925 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
8926 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
8927 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
8928 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
8929 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
8930 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
8931 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
8932 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
8933 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
8934 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d55e5bfc
RD
8935
8936
d55e5bfc 8937 def SetDimension(*args, **kwargs):
bfddbb17
RD
8938 """
8939 SetDimension(self, int x, int y, int width, int height)
8940
8941 Call this to force the sizer to take the given dimension and thus
8942 force the items owned by the sizer to resize themselves according to
8943 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
8944 methods.
8945 """
d55e5bfc
RD
8946 return _core_.Sizer_SetDimension(*args, **kwargs)
8947
8948 def SetMinSize(*args, **kwargs):
bfddbb17
RD
8949 """
8950 SetMinSize(self, Size size)
8951
8952 Call this to give the sizer a minimal size. Normally, the sizer will
8953 calculate its minimal size based purely on how much space its children
8954 need. After calling this method `GetMinSize` will return either the
8955 minimal size as requested by its children or the minimal size set
8956 here, depending on which is bigger.
8957 """
d55e5bfc
RD
8958 return _core_.Sizer_SetMinSize(*args, **kwargs)
8959
8960 def GetSize(*args, **kwargs):
bfddbb17
RD
8961 """
8962 GetSize(self) -> Size
8963
8964 Returns the current size of the space managed by the sizer.
8965 """
d55e5bfc
RD
8966 return _core_.Sizer_GetSize(*args, **kwargs)
8967
8968 def GetPosition(*args, **kwargs):
bfddbb17
RD
8969 """
8970 GetPosition(self) -> Point
8971
8972 Returns the current position of the sizer's managed space.
8973 """
d55e5bfc
RD
8974 return _core_.Sizer_GetPosition(*args, **kwargs)
8975
8976 def GetMinSize(*args, **kwargs):
bfddbb17
RD
8977 """
8978 GetMinSize(self) -> Size
8979
8980 Returns the minimal size of the sizer. This is either the combined
8981 minimal size of all the children and their borders or the minimal size
8982 set by SetMinSize, depending on which is bigger.
8983 """
d55e5bfc
RD
8984 return _core_.Sizer_GetMinSize(*args, **kwargs)
8985
8986 def GetSizeTuple(self):
1a6bba1e 8987 return self.GetSize().Get()
d55e5bfc 8988 def GetPositionTuple(self):
1a6bba1e 8989 return self.GetPosition().Get()
d55e5bfc 8990 def GetMinSizeTuple(self):
1a6bba1e 8991 return self.GetMinSize().Get()
d55e5bfc
RD
8992
8993 def RecalcSizes(*args, **kwargs):
bfddbb17
RD
8994 """
8995 RecalcSizes(self)
8996
8997 Using the sizes calculated by `CalcMin` reposition and resize all the
8998 items managed by this sizer. You should not need to call this directly as
8999 it is called by `Layout`.
9000 """
d55e5bfc
RD
9001 return _core_.Sizer_RecalcSizes(*args, **kwargs)
9002
9003 def CalcMin(*args, **kwargs):
bfddbb17
RD
9004 """
9005 CalcMin(self) -> Size
9006
9007 This method is where the sizer will do the actual calculation of its
9008 children's minimal sizes. You should not need to call this directly as
9009 it is called by `Layout`.
9010 """
d55e5bfc
RD
9011 return _core_.Sizer_CalcMin(*args, **kwargs)
9012
9013 def Layout(*args, **kwargs):
bfddbb17
RD
9014 """
9015 Layout(self)
9016
9017 This method will force the recalculation and layout of the items
9018 controlled by the sizer using the current space allocated to the
9019 sizer. Normally this is called automatically from the owning window's
9020 EVT_SIZE handler, but it is also useful to call it from user code when
9021 one of the items in a sizer change size, or items are added or
9022 removed.
9023 """
d55e5bfc
RD
9024 return _core_.Sizer_Layout(*args, **kwargs)
9025
9026 def Fit(*args, **kwargs):
bfddbb17
RD
9027 """
9028 Fit(self, Window window) -> Size
9029
9030 Tell the sizer to resize the *window* to match the sizer's minimal
9031 size. This is commonly done in the constructor of the window itself in
9032 order to set its initial size to match the needs of the children as
9033 determined by the sizer. Returns the new size.
9034
9035 For a top level window this is the total window size, not the client size.
9036 """
d55e5bfc
RD
9037 return _core_.Sizer_Fit(*args, **kwargs)
9038
9039 def FitInside(*args, **kwargs):
bfddbb17
RD
9040 """
9041 FitInside(self, Window window)
9042
9043 Tell the sizer to resize the *virtual size* of the *window* to match the
9044 sizer's minimal size. This will not alter the on screen size of the
9045 window, but may cause the addition/removal/alteration of scrollbars
9046 required to view the virtual area in windows which manage it.
9047
9048 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9049
9050 """
d55e5bfc
RD
9051 return _core_.Sizer_FitInside(*args, **kwargs)
9052
9053 def SetSizeHints(*args, **kwargs):
bfddbb17
RD
9054 """
9055 SetSizeHints(self, Window window)
9056
9057 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9058 match the sizer's minimal size. This is commonly done in the
9059 constructor of the window itself if the window is resizable (as are
9060 many dialogs under Unix and frames on probably all platforms) in order
9061 to prevent the window from being sized smaller than the minimal size
9062 required by the sizer.
9063 """
d55e5bfc
RD
9064 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9065
9066 def SetVirtualSizeHints(*args, **kwargs):
bfddbb17
RD
9067 """
9068 SetVirtualSizeHints(self, Window window)
9069
9070 Tell the sizer to set the minimal size of the window virtual area to
9071 match the sizer's minimal size. For windows with managed scrollbars
9072 this will set them appropriately.
9073
9074 :see: `wx.ScrolledWindow.SetScrollbars`
9075
9076 """
d55e5bfc
RD
9077 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9078
9079 def Clear(*args, **kwargs):
bfddbb17
RD
9080 """
9081 Clear(self, bool deleteWindows=False)
9082
9083 Clear all items from the sizer, optionally destroying the window items
9084 as well.
9085 """
d55e5bfc
RD
9086 return _core_.Sizer_Clear(*args, **kwargs)
9087
9088 def DeleteWindows(*args, **kwargs):
bfddbb17
RD
9089 """
9090 DeleteWindows(self)
9091
9092 Destroy all windows managed by the sizer.
9093 """
d55e5bfc
RD
9094 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9095
9096 def GetChildren(*args, **kwargs):
bfddbb17
RD
9097 """
9098 GetChildren(sefl) -> list
9099
9100 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9101 """
d55e5bfc
RD
9102 return _core_.Sizer_GetChildren(*args, **kwargs)
9103
9104 def Show(*args, **kwargs):
bfddbb17
RD
9105 """
9106 Show(self, item, bool show=True)
d55e5bfc 9107
bfddbb17
RD
9108 Shows or hides an item managed by the sizer. To make a sizer item
9109 disappear or reappear, use Show followed by `Layout`. The *item*
9110 parameter can be either a window, a sizer, or the zero-based index of
9111 the item.
9112 """
9113 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
9114
9115 def IsShown(*args, **kwargs):
bfddbb17
RD
9116 """
9117 IsShown(self, item)
9118
9119 Determines if the item is currently shown. sizer. To make a sizer
9120 item disappear or reappear, use Show followed by `Layout`. The *item*
9121 parameter can be either a window, a sizer, or the zero-based index of
9122 the item.
9123 """
d55e5bfc
RD
9124 return _core_.Sizer_IsShown(*args, **kwargs)
9125
bfddbb17
RD
9126 def Hide(self, item):
9127 """
9128 A convenience method for Show(item, False).
9129 """
9130 self.Show(item, False)
9131
d55e5bfc 9132 def ShowItems(*args, **kwargs):
bfddbb17
RD
9133 """
9134 ShowItems(self, bool show)
9135
9136 Recursively call `wx.Window.Show` on all sizer items.
9137 """
d55e5bfc
RD
9138 return _core_.Sizer_ShowItems(*args, **kwargs)
9139
9140
9141class SizerPtr(Sizer):
9142 def __init__(self, this):
9143 self.this = this
9144 if not hasattr(self,"thisown"): self.thisown = 0
9145 self.__class__ = Sizer
9146_core_.Sizer_swigregister(SizerPtr)
9147
9148class PySizer(Sizer):
bfddbb17
RD
9149 """
9150 wx.PySizer is a special version of `wx.Sizer` that has been
9151 instrumented to allow the C++ virtual methods to be overloaded in
9152 Python derived classes. You would derive from this class if you are
9153 wanting to implement a custom sizer in Python code. Simply implement
9154 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9155 For example::
9156
9157 class MySizer(wx.PySizer):
9158 def __init__(self):
9159 wx.PySizer.__init__(self)
9160
9161 def CalcMin(self):
9162 for item in self.GetChildren():
9163 # calculate the total minimum width and height needed
9164 # by all items in the sizer according to this sizer's
9165 # layout algorithm.
9166 ...
9167 return wx.Size(width, height)
9168
9169 def RecalcSizes(self):
9170 # find the space allotted to this sizer
9171 pos = self.GetPosition()
9172 size = self.GetSize()
9173 for item in self.GetChildren():
9174 # Recalculate (if necessary) the position and size of
9175 # each item and then call item.SetDimension to do the
9176 # actual positioning and sizing of the items within the
9177 # space alloted to this sizer.
9178 ...
9179 item.SetDimension(itemPos, itemSize)
9180
9181
9182 When `Layout` is called it first calls `CalcMin` followed by
9183 `RecalcSizes` so you can optimize a bit by saving the results of
9184 `CalcMin` and resuing them in `RecalcSizes`.
9185
9186 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9187
9188
9189 """
d55e5bfc
RD
9190 def __repr__(self):
9191 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9192 def __init__(self, *args, **kwargs):
bfddbb17
RD
9193 """
9194 __init__(self) -> PySizer
9195
9196 Creates a wx.PySizer. Must be called from the __init__ in the derived
9197 class.
9198 """
d55e5bfc
RD
9199 newobj = _core_.new_PySizer(*args, **kwargs)
9200 self.this = newobj.this
9201 self.thisown = 1
9202 del newobj.thisown
9203 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
9204
9205 def _setCallbackInfo(*args, **kwargs):
9206 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
9207 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
9208
9209
9210class PySizerPtr(PySizer):
9211 def __init__(self, this):
9212 self.this = this
9213 if not hasattr(self,"thisown"): self.thisown = 0
9214 self.__class__ = PySizer
9215_core_.PySizer_swigregister(PySizerPtr)
9216
9217#---------------------------------------------------------------------------
9218
9219class BoxSizer(Sizer):
bfddbb17
RD
9220 """
9221 The basic idea behind a box sizer is that windows will most often be
9222 laid out in rather simple basic geometry, typically in a row or a
9223 column or nested hierarchies of either. A wx.BoxSizer will lay out
9224 its items in a simple row or column, depending on the orientation
9225 parameter passed to the constructor.
9226 """
d55e5bfc
RD
9227 def __repr__(self):
9228 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9229 def __init__(self, *args, **kwargs):
bfddbb17
RD
9230 """
9231 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9232
9233 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9234 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9235 sizer.
9236 """
d55e5bfc
RD
9237 newobj = _core_.new_BoxSizer(*args, **kwargs)
9238 self.this = newobj.this
9239 self.thisown = 1
9240 del newobj.thisown
9241 self._setOORInfo(self)
9242
9243 def GetOrientation(*args, **kwargs):
bfddbb17
RD
9244 """
9245 GetOrientation(self) -> int
9246
9247 Returns the current orientation of the sizer.
9248 """
d55e5bfc
RD
9249 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
9250
9251 def SetOrientation(*args, **kwargs):
bfddbb17
RD
9252 """
9253 SetOrientation(self, int orient)
d55e5bfc 9254
bfddbb17
RD
9255 Resets the orientation of the sizer.
9256 """
9257 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
9258
9259
9260class BoxSizerPtr(BoxSizer):
9261 def __init__(self, this):
9262 self.this = this
9263 if not hasattr(self,"thisown"): self.thisown = 0
9264 self.__class__ = BoxSizer
9265_core_.BoxSizer_swigregister(BoxSizerPtr)
9266
9267#---------------------------------------------------------------------------
9268
9269class StaticBoxSizer(BoxSizer):
bfddbb17
RD
9270 """
9271 wx.StaticBoxSizer derives from and functions identically to the
9272 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9273 manages. Note that this static box must be created separately and
9274 passed to the sizer constructor.
9275 """
d55e5bfc
RD
9276 def __repr__(self):
9277 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9278 def __init__(self, *args, **kwargs):
bfddbb17
RD
9279 """
9280 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9281
9282 Constructor. It takes an associated static box and the orientation
9283 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9284 ``wx.HORIZONTAL``.
9285 """
d55e5bfc
RD
9286 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
9287 self.this = newobj.this
9288 self.thisown = 1
9289 del newobj.thisown
9290 self._setOORInfo(self)
9291
9292 def GetStaticBox(*args, **kwargs):
bfddbb17
RD
9293 """
9294 GetStaticBox(self) -> StaticBox
d55e5bfc 9295
bfddbb17
RD
9296 Returns the static box associated with this sizer.
9297 """
9298 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
9299
9300
9301class StaticBoxSizerPtr(StaticBoxSizer):
9302 def __init__(self, this):
9303 self.this = this
9304 if not hasattr(self,"thisown"): self.thisown = 0
9305 self.__class__ = StaticBoxSizer
9306_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
9307
9308#---------------------------------------------------------------------------
9309
9310class GridSizer(Sizer):
bfddbb17
RD
9311 """
9312 A grid sizer is a sizer which lays out its children in a
9313 two-dimensional table with all cells having the same size. In other
9314 words, the width of each cell within the grid is the width of the
9315 widest item added to the sizer and the height of each grid cell is the
9316 height of the tallest item. An optional vertical and/or horizontal
9317 gap between items can also be specified (in pixels.)
9318
9319 Items are placed in the cells of the grid in the order they are added,
9320 in row-major order. In other words, the first row is filled first,
9321 then the second, and so on until all items have been added. (If
9322 neccessary, additional rows will be added as items are added.) If you
9323 need to have greater control over the cells that items are placed in
9324 then use the `wx.GridBagSizer`.
9325
9326 """
d55e5bfc
RD
9327 def __repr__(self):
9328 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9329 def __init__(self, *args, **kwargs):
bfddbb17
RD
9330 """
9331 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9332
9333 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9334 of columns and rows in the sizer - if either of the parameters is
9335 zero, it will be calculated to from the total number of children in
9336 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9337 define extra space between all children.
9338 """
d55e5bfc
RD
9339 newobj = _core_.new_GridSizer(*args, **kwargs)
9340 self.this = newobj.this
9341 self.thisown = 1
9342 del newobj.thisown
9343 self._setOORInfo(self)
9344
d55e5bfc 9345 def SetCols(*args, **kwargs):
bfddbb17
RD
9346 """
9347 SetCols(self, int cols)
9348
9349 Sets the number of columns in the sizer.
9350 """
d55e5bfc
RD
9351 return _core_.GridSizer_SetCols(*args, **kwargs)
9352
9353 def SetRows(*args, **kwargs):
bfddbb17
RD
9354 """
9355 SetRows(self, int rows)
9356
9357 Sets the number of rows in the sizer.
9358 """
d55e5bfc
RD
9359 return _core_.GridSizer_SetRows(*args, **kwargs)
9360
9361 def SetVGap(*args, **kwargs):
bfddbb17
RD
9362 """
9363 SetVGap(self, int gap)
9364
9365 Sets the vertical gap (in pixels) between the cells in the sizer.
9366 """
d55e5bfc
RD
9367 return _core_.GridSizer_SetVGap(*args, **kwargs)
9368
9369 def SetHGap(*args, **kwargs):
bfddbb17
RD
9370 """
9371 SetHGap(self, int gap)
9372
9373 Sets the horizontal gap (in pixels) between cells in the sizer
9374 """
d55e5bfc
RD
9375 return _core_.GridSizer_SetHGap(*args, **kwargs)
9376
9377 def GetCols(*args, **kwargs):
bfddbb17
RD
9378 """
9379 GetCols(self) -> int
9380
9381 Returns the number of columns in the sizer.
9382 """
d55e5bfc
RD
9383 return _core_.GridSizer_GetCols(*args, **kwargs)
9384
9385 def GetRows(*args, **kwargs):
bfddbb17
RD
9386 """
9387 GetRows(self) -> int
9388
9389 Returns the number of rows in the sizer.
9390 """
d55e5bfc
RD
9391 return _core_.GridSizer_GetRows(*args, **kwargs)
9392
9393 def GetVGap(*args, **kwargs):
bfddbb17
RD
9394 """
9395 GetVGap(self) -> int
9396
9397 Returns the vertical gap (in pixels) between the cells in the sizer.
9398 """
d55e5bfc
RD
9399 return _core_.GridSizer_GetVGap(*args, **kwargs)
9400
9401 def GetHGap(*args, **kwargs):
bfddbb17
RD
9402 """
9403 GetHGap(self) -> int
9404
9405 Returns the horizontal gap (in pixels) between cells in the sizer.
9406 """
d55e5bfc
RD
9407 return _core_.GridSizer_GetHGap(*args, **kwargs)
9408
9409
9410class GridSizerPtr(GridSizer):
9411 def __init__(self, this):
9412 self.this = this
9413 if not hasattr(self,"thisown"): self.thisown = 0
9414 self.__class__ = GridSizer
9415_core_.GridSizer_swigregister(GridSizerPtr)
9416
9417#---------------------------------------------------------------------------
9418
9419FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9420FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9421FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
9422class FlexGridSizer(GridSizer):
bfddbb17
RD
9423 """
9424 A flex grid sizer is a sizer which lays out its children in a
9425 two-dimensional table with all table cells in one row having the same
9426 height and all cells in one column having the same width, but all
9427 rows or all columns are not necessarily the same height or width as in
9428 the `wx.GridSizer`.
9429
9430 wx.FlexGridSizer can also size items equally in one direction but
9431 unequally ("flexibly") in the other. If the sizer is only flexible
9432 in one direction (this can be changed using `SetFlexibleDirection`), it
9433 needs to be decided how the sizer should grow in the other ("non
9434 flexible") direction in order to fill the available space. The
9435 `SetNonFlexibleGrowMode` method serves this purpose.
9436
9437
9438 """
d55e5bfc
RD
9439 def __repr__(self):
9440 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9441 def __init__(self, *args, **kwargs):
bfddbb17
RD
9442 """
9443 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9444
9445 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9446 number of columns and rows in the sizer - if either of the parameters
9447 is zero, it will be calculated to from the total number of children in
9448 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9449 define extra space between all children.
9450 """
d55e5bfc
RD
9451 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
9452 self.this = newobj.this
9453 self.thisown = 1
9454 del newobj.thisown
9455 self._setOORInfo(self)
9456
bfddbb17
RD
9457 def AddGrowableRow(*args, **kwargs):
9458 """
9459 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 9460
bfddbb17
RD
9461 Specifies that row *idx* (starting from zero) should be grown if there
9462 is extra space available to the sizer.
d55e5bfc 9463
bfddbb17
RD
9464 The *proportion* parameter has the same meaning as the stretch factor
9465 for the box sizers except that if all proportions are 0, then all
9466 columns are resized equally (instead of not being resized at all).
9467 """
d55e5bfc
RD
9468 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
9469
9470 def RemoveGrowableRow(*args, **kwargs):
bfddbb17
RD
9471 """
9472 RemoveGrowableRow(self, size_t idx)
9473
9474 Specifies that row *idx* is no longer growable.
9475 """
d55e5bfc
RD
9476 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
9477
9478 def AddGrowableCol(*args, **kwargs):
bfddbb17
RD
9479 """
9480 AddGrowableCol(self, size_t idx, int proportion=0)
9481
9482 Specifies that column *idx* (starting from zero) should be grown if
9483 there is extra space available to the sizer.
9484
9485 The *proportion* parameter has the same meaning as the stretch factor
9486 for the box sizers except that if all proportions are 0, then all
9487 columns are resized equally (instead of not being resized at all).
9488 """
d55e5bfc
RD
9489 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
9490
9491 def RemoveGrowableCol(*args, **kwargs):
bfddbb17
RD
9492 """
9493 RemoveGrowableCol(self, size_t idx)
9494
9495 Specifies that column *idx* is no longer growable.
9496 """
d55e5bfc
RD
9497 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
9498
9499 def SetFlexibleDirection(*args, **kwargs):
bfddbb17
RD
9500 """
9501 SetFlexibleDirection(self, int direction)
9502
9503 Specifies whether the sizer should flexibly resize its columns, rows,
9504 or both. Argument *direction* can be one of the following values. Any
9505 other value is ignored.
9506
9507 ============== =======================================
9508 wx.VERTICAL Rows are flexibly sized.
9509 wx.HORIZONTAL Columns are flexibly sized.
9510 wx.BOTH Both rows and columns are flexibly sized
9511 (this is the default value).
9512 ============== =======================================
9513
9514 Note that this method does not trigger relayout.
9515
9516 """
d55e5bfc
RD
9517 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
9518
9519 def GetFlexibleDirection(*args, **kwargs):
bfddbb17
RD
9520 """
9521 GetFlexibleDirection(self) -> int
9522
9523 Returns a value that specifies whether the sizer
9524 flexibly resizes its columns, rows, or both (default).
9525
9526 :see: `SetFlexibleDirection`
9527 """
d55e5bfc
RD
9528 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
9529
9530 def SetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD
9531 """
9532 SetNonFlexibleGrowMode(self, int mode)
9533
9534 Specifies how the sizer should grow in the non-flexible direction if
9535 there is one (so `SetFlexibleDirection` must have been called
9536 previously). Argument *mode* can be one of the following values:
9537
9538 ========================== =================================================
9539 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9540 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9541 `AddGrowableCol` and `AddGrowableRow`. In this
9542 case equal sizing applies to minimum sizes of
9543 columns or rows (this is the default value).
9544 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9545 the non flexible direction, whether they are
9546 growable or not in the flexbile direction.
9547 ========================== =================================================
9548
9549 Note that this method does not trigger relayout.
9550
9551
9552 """
d55e5bfc
RD
9553 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
9554
9555 def GetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD
9556 """
9557 GetNonFlexibleGrowMode(self) -> int
9558
9559 Returns the value that specifies how the sizer grows in the
9560 non-flexible direction if there is one.
9561
9562 :see: `SetNonFlexibleGrowMode`
9563 """
d55e5bfc
RD
9564 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
9565
9566 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
9567 """
9568 GetRowHeights(self) -> list
9569
9570 Returns a list of integers representing the heights of each of the
9571 rows in the sizer.
9572 """
d55e5bfc
RD
9573 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
9574
9575 def GetColWidths(*args, **kwargs):
fd2dc343
RD
9576 """
9577 GetColWidths(self) -> list
9578
9579 Returns a list of integers representing the widths of each of the
9580 columns in the sizer.
9581 """
d55e5bfc
RD
9582 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
9583
9584
9585class FlexGridSizerPtr(FlexGridSizer):
9586 def __init__(self, this):
9587 self.this = this
9588 if not hasattr(self,"thisown"): self.thisown = 0
9589 self.__class__ = FlexGridSizer
9590_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
9591
9592#---------------------------------------------------------------------------
9593
9594class GBPosition(object):
bfddbb17
RD
9595 """
9596 This class represents the position of an item in a virtual grid of
9597 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9598 typemaps that will automatically convert from a 2-element sequence of
9599 integers to a wx.GBPosition, so you can use the more pythonic
9600 representation of the position nearly transparently in Python code.
9601 """
d55e5bfc
RD
9602 def __repr__(self):
9603 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9604 def __init__(self, *args, **kwargs):
bfddbb17
RD
9605 """
9606 __init__(self, int row=0, int col=0) -> GBPosition
9607
9608 This class represents the position of an item in a virtual grid of
9609 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9610 typemaps that will automatically convert from a 2-element sequence of
9611 integers to a wx.GBPosition, so you can use the more pythonic
9612 representation of the position nearly transparently in Python code.
9613 """
d55e5bfc
RD
9614 newobj = _core_.new_GBPosition(*args, **kwargs)
9615 self.this = newobj.this
9616 self.thisown = 1
9617 del newobj.thisown
9618 def GetRow(*args, **kwargs):
9619 """GetRow(self) -> int"""
9620 return _core_.GBPosition_GetRow(*args, **kwargs)
9621
9622 def GetCol(*args, **kwargs):
9623 """GetCol(self) -> int"""
9624 return _core_.GBPosition_GetCol(*args, **kwargs)
9625
9626 def SetRow(*args, **kwargs):
9627 """SetRow(self, int row)"""
9628 return _core_.GBPosition_SetRow(*args, **kwargs)
9629
9630 def SetCol(*args, **kwargs):
9631 """SetCol(self, int col)"""
9632 return _core_.GBPosition_SetCol(*args, **kwargs)
9633
9634 def __eq__(*args, **kwargs):
9635 """__eq__(self, GBPosition other) -> bool"""
9636 return _core_.GBPosition___eq__(*args, **kwargs)
9637
9638 def __ne__(*args, **kwargs):
9639 """__ne__(self, GBPosition other) -> bool"""
9640 return _core_.GBPosition___ne__(*args, **kwargs)
9641
9642 def Set(*args, **kwargs):
9643 """Set(self, int row=0, int col=0)"""
9644 return _core_.GBPosition_Set(*args, **kwargs)
9645
9646 def Get(*args, **kwargs):
9647 """Get(self) -> PyObject"""
9648 return _core_.GBPosition_Get(*args, **kwargs)
9649
15817c7e 9650 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
9651 def __str__(self): return str(self.Get())
9652 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9653 def __len__(self): return len(self.Get())
9654 def __getitem__(self, index): return self.Get()[index]
9655 def __setitem__(self, index, val):
9656 if index == 0: self.SetRow(val)
9657 elif index == 1: self.SetCol(val)
9658 else: raise IndexError
9659 def __nonzero__(self): return self.Get() != (0,0)
9660 __safe_for_unpickling__ = True
9661 def __reduce__(self): return (wx.GBPosition, self.Get())
9662
9663 row = property(GetRow, SetRow)
9664 col = property(GetCol, SetCol)
9665
9666
9667class GBPositionPtr(GBPosition):
9668 def __init__(self, this):
9669 self.this = this
9670 if not hasattr(self,"thisown"): self.thisown = 0
9671 self.__class__ = GBPosition
9672_core_.GBPosition_swigregister(GBPositionPtr)
9673
9674class GBSpan(object):
bfddbb17
RD
9675 """
9676 This class is used to hold the row and column spanning attributes of
9677 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9678 automatically convert from a 2-element sequence of integers to a
9679 wx.GBSpan, so you can use the more pythonic representation of the span
9680 nearly transparently in Python code.
9681
9682 """
d55e5bfc
RD
9683 def __repr__(self):
9684 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9685 def __init__(self, *args, **kwargs):
bfddbb17
RD
9686 """
9687 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9688
9689 Construct a new wxGBSpan, optionally setting the rowspan and
9690 colspan. The default is (1,1). (Meaning that the item occupies one
9691 cell in each direction.
9692 """
d55e5bfc
RD
9693 newobj = _core_.new_GBSpan(*args, **kwargs)
9694 self.this = newobj.this
9695 self.thisown = 1
9696 del newobj.thisown
9697 def GetRowspan(*args, **kwargs):
9698 """GetRowspan(self) -> int"""
9699 return _core_.GBSpan_GetRowspan(*args, **kwargs)
9700
9701 def GetColspan(*args, **kwargs):
9702 """GetColspan(self) -> int"""
9703 return _core_.GBSpan_GetColspan(*args, **kwargs)
9704
9705 def SetRowspan(*args, **kwargs):
9706 """SetRowspan(self, int rowspan)"""
9707 return _core_.GBSpan_SetRowspan(*args, **kwargs)
9708
9709 def SetColspan(*args, **kwargs):
9710 """SetColspan(self, int colspan)"""
9711 return _core_.GBSpan_SetColspan(*args, **kwargs)
9712
9713 def __eq__(*args, **kwargs):
9714 """__eq__(self, GBSpan other) -> bool"""
9715 return _core_.GBSpan___eq__(*args, **kwargs)
9716
9717 def __ne__(*args, **kwargs):
9718 """__ne__(self, GBSpan other) -> bool"""
9719 return _core_.GBSpan___ne__(*args, **kwargs)
9720
9721 def Set(*args, **kwargs):
9722 """Set(self, int rowspan=1, int colspan=1)"""
9723 return _core_.GBSpan_Set(*args, **kwargs)
9724
9725 def Get(*args, **kwargs):
9726 """Get(self) -> PyObject"""
9727 return _core_.GBSpan_Get(*args, **kwargs)
9728
15817c7e 9729 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
9730 def __str__(self): return str(self.Get())
9731 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
9732 def __len__(self): return len(self.Get())
9733 def __getitem__(self, index): return self.Get()[index]
9734 def __setitem__(self, index, val):
9735 if index == 0: self.SetRowspan(val)
9736 elif index == 1: self.SetColspan(val)
9737 else: raise IndexError
9738 def __nonzero__(self): return self.Get() != (0,0)
9739 __safe_for_unpickling__ = True
9740 def __reduce__(self): return (wx.GBSpan, self.Get())
9741
9742 rowspan = property(GetRowspan, SetRowspan)
9743 colspan = property(GetColspan, SetColspan)
9744
9745
9746class GBSpanPtr(GBSpan):
9747 def __init__(self, this):
9748 self.this = this
9749 if not hasattr(self,"thisown"): self.thisown = 0
9750 self.__class__ = GBSpan
9751_core_.GBSpan_swigregister(GBSpanPtr)
9752
9753class GBSizerItem(SizerItem):
bfddbb17
RD
9754 """
9755 The wx.GBSizerItem class is used to track the additional data about
9756 items in a `wx.GridBagSizer` such as the item's position in the grid
9757 and how many rows or columns it spans.
9758
9759 """
d55e5bfc
RD
9760 def __repr__(self):
9761 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9762 def __init__(self, *args, **kwargs):
bfddbb17
RD
9763 """
9764 __init__(self) -> GBSizerItem
9765
9766 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
9767 size will need to be set, as well as a position and span before this
9768 item can be used in a Sizer.
9769
9770 You will probably never need to create a wx.GBSizerItem directly as they
9771 are created automatically when the sizer's Add method is called.
9772 """
d55e5bfc
RD
9773 newobj = _core_.new_GBSizerItem(*args, **kwargs)
9774 self.this = newobj.this
9775 self.thisown = 1
9776 del newobj.thisown
9777 def GetPos(*args, **kwargs):
bfddbb17
RD
9778 """
9779 GetPos(self) -> GBPosition
9780
9781 Get the grid position of the item
9782 """
d55e5bfc
RD
9783 return _core_.GBSizerItem_GetPos(*args, **kwargs)
9784
9785 def GetPosTuple(self): return self.GetPos().Get()
9786 def GetSpan(*args, **kwargs):
bfddbb17
RD
9787 """
9788 GetSpan(self) -> GBSpan
9789
9790 Get the row and column spanning of the item
9791 """
d55e5bfc
RD
9792 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
9793
9794 def GetSpanTuple(self): return self.GetSpan().Get()
9795 def SetPos(*args, **kwargs):
bfddbb17
RD
9796 """
9797 SetPos(self, GBPosition pos) -> bool
9798
9799 If the item is already a member of a sizer then first ensure that
9800 there is no other item that would intersect with this one at the new
9801 position, then set the new position. Returns True if the change is
9802 successful and after the next Layout() the item will be moved.
9803 """
d55e5bfc
RD
9804 return _core_.GBSizerItem_SetPos(*args, **kwargs)
9805
9806 def SetSpan(*args, **kwargs):
bfddbb17
RD
9807 """
9808 SetSpan(self, GBSpan span) -> bool
9809
9810 If the item is already a member of a sizer then first ensure that
9811 there is no other item that would intersect with this one with its new
9812 spanning size, then set the new spanning. Returns True if the change
9813 is successful and after the next Layout() the item will be resized.
9814
9815 """
d55e5bfc
RD
9816 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
9817
bfddbb17 9818 def Intersects(*args, **kwargs):
d55e5bfc
RD
9819 """
9820 Intersects(self, GBSizerItem other) -> bool
bfddbb17
RD
9821
9822 Returns True if this item and the other item instersect.
d55e5bfc 9823 """
bfddbb17
RD
9824 return _core_.GBSizerItem_Intersects(*args, **kwargs)
9825
9826 def IntersectsPos(*args, **kwargs):
9827 """
9828 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
9829
9830 Returns True if the given pos/span would intersect with this item.
9831 """
9832 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
9833
9834 def GetEndPos(*args, **kwargs):
bfddbb17
RD
9835 """
9836 GetEndPos(self) -> GBPosition
9837
9838 Get the row and column of the endpoint of this item.
9839 """
d55e5bfc
RD
9840 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
9841
9842 def GetGBSizer(*args, **kwargs):
bfddbb17
RD
9843 """
9844 GetGBSizer(self) -> GridBagSizer
9845
9846 Get the sizer this item is a member of.
9847 """
d55e5bfc
RD
9848 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
9849
9850 def SetGBSizer(*args, **kwargs):
bfddbb17
RD
9851 """
9852 SetGBSizer(self, GridBagSizer sizer)
9853
9854 Set the sizer this item is a member of.
9855 """
d55e5bfc
RD
9856 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
9857
9858
9859class GBSizerItemPtr(GBSizerItem):
9860 def __init__(self, this):
9861 self.this = this
9862 if not hasattr(self,"thisown"): self.thisown = 0
9863 self.__class__ = GBSizerItem
9864_core_.GBSizerItem_swigregister(GBSizerItemPtr)
9865DefaultSpan = cvar.DefaultSpan
9866
9867def GBSizerItemWindow(*args, **kwargs):
9868 """
9869 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
bfddbb17
RD
9870 int border, PyObject userData=None) -> GBSizerItem
9871
9872 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
9873 """
9874 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
9875 val.thisown = 1
9876 return val
9877
9878def GBSizerItemSizer(*args, **kwargs):
9879 """
9880 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
bfddbb17
RD
9881 int border, PyObject userData=None) -> GBSizerItem
9882
9883 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
9884 """
9885 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
9886 val.thisown = 1
9887 return val
9888
9889def GBSizerItemSpacer(*args, **kwargs):
9890 """
9891 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
bfddbb17
RD
9892 int flag, int border, PyObject userData=None) -> GBSizerItem
9893
9894 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
9895 """
9896 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
9897 val.thisown = 1
9898 return val
9899
9900class GridBagSizer(FlexGridSizer):
bfddbb17
RD
9901 """
9902 A `wx.Sizer` that can lay out items in a virtual grid like a
9903 `wx.FlexGridSizer` but in this case explicit positioning of the items
9904 is allowed using `wx.GBPosition`, and items can optionally span more
9905 than one row and/or column using `wx.GBSpan`. The total size of the
9906 virtual grid is determined by the largest row and column that items are
9907 positioned at, adjusted for spanning.
9908
9909 """
d55e5bfc
RD
9910 def __repr__(self):
9911 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9912 def __init__(self, *args, **kwargs):
bfddbb17
RD
9913 """
9914 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
9915
9916 Constructor, with optional parameters to specify the gap between the
9917 rows and columns.
9918 """
d55e5bfc
RD
9919 newobj = _core_.new_GridBagSizer(*args, **kwargs)
9920 self.this = newobj.this
9921 self.thisown = 1
9922 del newobj.thisown
9923 def Add(*args, **kwargs):
9924 """
bfddbb17
RD
9925 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
9926 int border=0, userData=None)
9927
9928 Adds an item to the sizer at the grid cell *pos*, optionally spanning
9929 more than one row or column as specified with *span*. The remaining
9930 args behave similarly to `wx.Sizer.Add`.
9931
9932 Returns True if the item was successfully placed at the given cell
9933 position, False if something was already there.
9934
d55e5bfc
RD
9935 """
9936 return _core_.GridBagSizer_Add(*args, **kwargs)
9937
9938 def AddItem(*args, **kwargs):
bfddbb17
RD
9939 """
9940 Add(self, GBSizerItem item) -> bool
9941
9942 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
9943 the item was successfully placed at its given cell position, False if
9944 something was already there.
9945 """
d55e5bfc
RD
9946 return _core_.GridBagSizer_AddItem(*args, **kwargs)
9947
9948 def GetEmptyCellSize(*args, **kwargs):
bfddbb17
RD
9949 """
9950 GetEmptyCellSize(self) -> Size
9951
9952 Get the size used for cells in the grid with no item.
9953 """
d55e5bfc
RD
9954 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
9955
9956 def SetEmptyCellSize(*args, **kwargs):
bfddbb17
RD
9957 """
9958 SetEmptyCellSize(self, Size sz)
9959
9960 Set the size used for cells in the grid with no item.
9961 """
d55e5bfc
RD
9962 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
9963
9964 def GetItemPosition(*args):
9965 """
bfddbb17
RD
9966 GetItemPosition(self, item) -> GBPosition
9967
9968 Get the grid position of the specified *item* where *item* is either a
9969 window or subsizer that is a member of this sizer, or a zero-based
9970 index of an item.
d55e5bfc
RD
9971 """
9972 return _core_.GridBagSizer_GetItemPosition(*args)
9973
9974 def SetItemPosition(*args):
9975 """
bfddbb17
RD
9976 SetItemPosition(self, item, GBPosition pos) -> bool
9977
9978 Set the grid position of the specified *item* where *item* is either a
9979 window or subsizer that is a member of this sizer, or a zero-based
9980 index of an item. Returns True on success. If the move is not
9981 allowed (because an item is already there) then False is returned.
9982
d55e5bfc
RD
9983 """
9984 return _core_.GridBagSizer_SetItemPosition(*args)
9985
9986 def GetItemSpan(*args):
9987 """
bfddbb17
RD
9988 GetItemSpan(self, item) -> GBSpan
9989
9990 Get the row/col spanning of the specified *item* where *item* is
9991 either a window or subsizer that is a member of this sizer, or a
9992 zero-based index of an item.
d55e5bfc
RD
9993 """
9994 return _core_.GridBagSizer_GetItemSpan(*args)
9995
9996 def SetItemSpan(*args):
9997 """
bfddbb17
RD
9998 SetItemSpan(self, item, GBSpan span) -> bool
9999
10000 Set the row/col spanning of the specified *item* where *item* is
10001 either a window or subsizer that is a member of this sizer, or a
10002 zero-based index of an item. Returns True on success. If the move is
10003 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
10004 """
10005 return _core_.GridBagSizer_SetItemSpan(*args)
10006
10007 def FindItem(*args):
10008 """
bfddbb17
RD
10009 FindItem(self, item) -> GBSizerItem
10010
10011 Find the sizer item for the given window or subsizer, returns None if
10012 not found. (non-recursive)
d55e5bfc
RD
10013 """
10014 return _core_.GridBagSizer_FindItem(*args)
10015
10016 def FindItemAtPosition(*args, **kwargs):
bfddbb17
RD
10017 """
10018 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10019
10020 Return the sizer item for the given grid cell, or None if there is no
10021 item at that position. (non-recursive)
10022 """
d55e5bfc
RD
10023 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10024
10025 def FindItemAtPoint(*args, **kwargs):
bfddbb17
RD
10026 """
10027 FindItemAtPoint(self, Point pt) -> GBSizerItem
10028
10029 Return the sizer item located at the point given in *pt*, or None if
10030 there is no item at that point. The (x,y) coordinates in pt correspond
10031 to the client coordinates of the window using the sizer for
10032 layout. (non-recursive)
10033 """
d55e5bfc
RD
10034 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10035
bfddbb17
RD
10036 def CheckForIntersection(*args, **kwargs):
10037 """
10038 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10039
bfddbb17
RD
10040 Look at all items and see if any intersect (or would overlap) the
10041 given *item*. Returns True if so, False if there would be no overlap.
10042 If an *excludeItem* is given then it will not be checked for
10043 intersection, for example it may be the item we are checking the
10044 position of.
d55e5bfc 10045
bfddbb17
RD
10046 """
10047 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10048
bfddbb17 10049 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10050 """
bfddbb17
RD
10051 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10052
10053 Look at all items and see if any intersect (or would overlap) the
10054 given position and span. Returns True if so, False if there would be
10055 no overlap. If an *excludeItem* is given then it will not be checked
10056 for intersection, for example it may be the item we are checking the
10057 position of.
d55e5bfc 10058 """
bfddbb17 10059 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
10060
10061
10062class GridBagSizerPtr(GridBagSizer):
10063 def __init__(self, this):
10064 self.this = this
10065 if not hasattr(self,"thisown"): self.thisown = 0
10066 self.__class__ = GridBagSizer
10067_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10068
10069#---------------------------------------------------------------------------
10070
10071Left = _core_.Left
10072Top = _core_.Top
10073Right = _core_.Right
10074Bottom = _core_.Bottom
10075Width = _core_.Width
10076Height = _core_.Height
10077Centre = _core_.Centre
10078Center = _core_.Center
10079CentreX = _core_.CentreX
10080CentreY = _core_.CentreY
10081Unconstrained = _core_.Unconstrained
10082AsIs = _core_.AsIs
10083PercentOf = _core_.PercentOf
10084Above = _core_.Above
10085Below = _core_.Below
10086LeftOf = _core_.LeftOf
10087RightOf = _core_.RightOf
10088SameAs = _core_.SameAs
10089Absolute = _core_.Absolute
10090class IndividualLayoutConstraint(Object):
10091 """
15817c7e
RD
10092 Objects of this class are stored in the `wx.LayoutConstraints` class as
10093 one of eight possible constraints that a window can be involved in.
10094 You will never need to create an instance of
10095 wx.IndividualLayoutConstraint, rather you should create a
10096 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10097 that it contains.
d55e5bfc
RD
10098 """
10099 def __init__(self): raise RuntimeError, "No constructor defined"
10100 def __repr__(self):
10101 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10102 def Set(*args, **kwargs):
15817c7e
RD
10103 """
10104 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10105
10106 Sets the properties of the constraint. Normally called by one of the
10107 convenience functions such as Above, RightOf, SameAs.
10108 """
d55e5bfc
RD
10109 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
10110
10111 def LeftOf(*args, **kwargs):
10112 """
10113 LeftOf(self, Window sibling, int marg=0)
10114
15817c7e
RD
10115 Constrains this edge to be to the left of the given window, with an
10116 optional margin. Implicitly, this is relative to the left edge of the
10117 other window.
d55e5bfc
RD
10118 """
10119 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
10120
10121 def RightOf(*args, **kwargs):
10122 """
10123 RightOf(self, Window sibling, int marg=0)
10124
15817c7e
RD
10125 Constrains this edge to be to the right of the given window, with an
10126 optional margin. Implicitly, this is relative to the right edge of the
10127 other window.
d55e5bfc
RD
10128 """
10129 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
10130
10131 def Above(*args, **kwargs):
10132 """
10133 Above(self, Window sibling, int marg=0)
10134
15817c7e
RD
10135 Constrains this edge to be above the given window, with an optional
10136 margin. Implicitly, this is relative to the top edge of the other
10137 window.
d55e5bfc
RD
10138 """
10139 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
10140
10141 def Below(*args, **kwargs):
10142 """
10143 Below(self, Window sibling, int marg=0)
10144
15817c7e
RD
10145 Constrains this edge to be below the given window, with an optional
10146 margin. Implicitly, this is relative to the bottom edge of the other
10147 window.
d55e5bfc
RD
10148 """
10149 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
10150
10151 def SameAs(*args, **kwargs):
10152 """
10153 SameAs(self, Window otherW, int edge, int marg=0)
10154
15817c7e
RD
10155 Constrains this edge or dimension to be to the same as the edge of the
10156 given window, with an optional margin.
d55e5bfc
RD
10157 """
10158 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
10159
10160 def PercentOf(*args, **kwargs):
10161 """
10162 PercentOf(self, Window otherW, int wh, int per)
10163
15817c7e
RD
10164 Constrains this edge or dimension to be to a percentage of the given
10165 window, with an optional margin.
d55e5bfc
RD
10166 """
10167 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
10168
10169 def Absolute(*args, **kwargs):
10170 """
10171 Absolute(self, int val)
10172
15817c7e 10173 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
10174 """
10175 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
10176
10177 def Unconstrained(*args, **kwargs):
10178 """
10179 Unconstrained(self)
10180
15817c7e
RD
10181 Sets this edge or dimension to be unconstrained, that is, dependent on
10182 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
10183 """
10184 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
10185
10186 def AsIs(*args, **kwargs):
10187 """
10188 AsIs(self)
10189
15817c7e
RD
10190 Sets this edge or constraint to be whatever the window's value is at
10191 the moment. If either of the width and height constraints are *as is*,
10192 the window will not be resized, but moved instead. This is important
10193 when considering panel items which are intended to have a default
10194 size, such as a button, which may take its size from the size of the
10195 button label.
d55e5bfc
RD
10196 """
10197 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
10198
10199 def GetOtherWindow(*args, **kwargs):
10200 """GetOtherWindow(self) -> Window"""
10201 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
10202
10203 def GetMyEdge(*args, **kwargs):
10204 """GetMyEdge(self) -> int"""
10205 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
10206
10207 def SetEdge(*args, **kwargs):
10208 """SetEdge(self, int which)"""
10209 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
10210
10211 def SetValue(*args, **kwargs):
10212 """SetValue(self, int v)"""
10213 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
10214
10215 def GetMargin(*args, **kwargs):
10216 """GetMargin(self) -> int"""
10217 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
10218
10219 def SetMargin(*args, **kwargs):
10220 """SetMargin(self, int m)"""
10221 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
10222
10223 def GetValue(*args, **kwargs):
10224 """GetValue(self) -> int"""
10225 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
10226
10227 def GetPercent(*args, **kwargs):
10228 """GetPercent(self) -> int"""
10229 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
10230
10231 def GetOtherEdge(*args, **kwargs):
10232 """GetOtherEdge(self) -> int"""
10233 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
10234
10235 def GetDone(*args, **kwargs):
10236 """GetDone(self) -> bool"""
10237 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
10238
10239 def SetDone(*args, **kwargs):
10240 """SetDone(self, bool d)"""
10241 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
10242
10243 def GetRelationship(*args, **kwargs):
10244 """GetRelationship(self) -> int"""
10245 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
10246
10247 def SetRelationship(*args, **kwargs):
10248 """SetRelationship(self, int r)"""
10249 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
10250
10251 def ResetIfWin(*args, **kwargs):
10252 """
10253 ResetIfWin(self, Window otherW) -> bool
10254
10255 Reset constraint if it mentions otherWin
10256 """
10257 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
10258
10259 def SatisfyConstraint(*args, **kwargs):
10260 """
10261 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
10262
10263 Try to satisfy constraint
10264 """
10265 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
10266
10267 def GetEdge(*args, **kwargs):
10268 """
10269 GetEdge(self, int which, Window thisWin, Window other) -> int
10270
10271 Get the value of this edge or dimension, or if this
10272 is not determinable, -1.
10273 """
10274 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
10275
10276
10277class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10278 def __init__(self, this):
10279 self.this = this
10280 if not hasattr(self,"thisown"): self.thisown = 0
10281 self.__class__ = IndividualLayoutConstraint
10282_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
10283
10284class LayoutConstraints(Object):
10285 """
15817c7e
RD
10286 **Note:** constraints are now deprecated and you should use sizers
10287 instead.
d55e5bfc 10288
15817c7e
RD
10289 Objects of this class can be associated with a window to define its
10290 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
10291
10292 The class consists of the following eight constraints of class
10293 wx.IndividualLayoutConstraint, some or all of which should be accessed
10294 directly to set the appropriate constraints.
10295
10296 * left: represents the left hand edge of the window
10297 * right: represents the right hand edge of the window
10298 * top: represents the top edge of the window
10299 * bottom: represents the bottom edge of the window
10300 * width: represents the width of the window
10301 * height: represents the height of the window
10302 * centreX: represents the horizontal centre point of the window
10303 * centreY: represents the vertical centre point of the window
10304
15817c7e
RD
10305 Most constraints are initially set to have the relationship
10306 wxUnconstrained, which means that their values should be calculated by
10307 looking at known constraints. The exceptions are width and height,
10308 which are set to wxAsIs to ensure that if the user does not specify a
10309 constraint, the existing width and height will be used, to be
10310 compatible with panel items which often have take a default size. If
10311 the constraint is ``wx.AsIs``, the dimension will not be changed.
10312
10313 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
10314
10315 """
10316 def __repr__(self):
10317 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10318 left = property(_core_.LayoutConstraints_left_get)
10319 top = property(_core_.LayoutConstraints_top_get)
10320 right = property(_core_.LayoutConstraints_right_get)
10321 bottom = property(_core_.LayoutConstraints_bottom_get)
10322 width = property(_core_.LayoutConstraints_width_get)
10323 height = property(_core_.LayoutConstraints_height_get)
10324 centreX = property(_core_.LayoutConstraints_centreX_get)
10325 centreY = property(_core_.LayoutConstraints_centreY_get)
10326 def __init__(self, *args, **kwargs):
10327 """__init__(self) -> LayoutConstraints"""
10328 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
10329 self.this = newobj.this
10330 self.thisown = 1
10331 del newobj.thisown
10332 def SatisfyConstraints(*args, **kwargs):
10333 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
10334 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
10335
10336 def AreSatisfied(*args, **kwargs):
10337 """AreSatisfied(self) -> bool"""
10338 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
10339
10340
10341class LayoutConstraintsPtr(LayoutConstraints):
10342 def __init__(self, this):
10343 self.this = this
10344 if not hasattr(self,"thisown"): self.thisown = 0
10345 self.__class__ = LayoutConstraints
10346_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
10347
10348#----------------------------------------------------------------------------
10349
10350# Use Python's bool constants if available, make some if not
10351try:
10352 True
10353except NameError:
10354 __builtins__.True = 1==1
10355 __builtins__.False = 1==0
10356 def bool(value): return not not value
10357 __builtins__.bool = bool
10358
10359
10360
10361# workarounds for bad wxRTTI names
10362__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10363__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10364__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10365
10366
10367#----------------------------------------------------------------------------
10368# Load version numbers from __version__... Ensure that major and minor
10369# versions are the same for both wxPython and wxWindows.
10370
10371from __version__ import *
10372__version__ = VERSION_STRING
10373
10374assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
10375assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
10376if RELEASE_VERSION != _core_.RELEASE_VERSION:
10377 import warnings
10378 warnings.warn("wxPython/wxWindows release number mismatch")
10379
10380#----------------------------------------------------------------------------
10381
10382class PyDeadObjectError(AttributeError):
10383 pass
10384
10385class _wxPyDeadObject(object):
10386 """
10387 Instances of wx objects that are OOR capable will have their __class__
10388 changed to this class when the C++ object is deleted. This should help
10389 prevent crashes due to referencing a bogus C++ pointer.
10390 """
10391 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10392 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10393
10394 def __repr__(self):
10395 if not hasattr(self, "_name"):
10396 self._name = "[unknown]"
10397 return self.reprStr % self._name
10398
10399 def __getattr__(self, *args):
10400 if not hasattr(self, "_name"):
10401 self._name = "[unknown]"
10402 raise PyDeadObjectError(self.attrStr % self._name)
10403
10404 def __nonzero__(self):
10405 return 0
10406
10407
10408
10409class PyUnbornObjectError(AttributeError):
10410 pass
10411
10412class _wxPyUnbornObject(object):
10413 """
10414 Some stock objects are created when the wx._core module is
10415 imported, but their C++ instance is not created until the wx.App
10416 object is created and initialized. These object instances will
10417 temporarily have their __class__ changed to this class so an
10418 exception will be raised if they are used before the C++ instance
10419 is ready.
10420 """
10421
10422 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10423 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10424
10425 def __repr__(self):
10426 #if not hasattr(self, "_name"):
10427 # self._name = "[unknown]"
10428 return self.reprStr #% self._name
10429
10430 def __getattr__(self, *args):
10431 #if not hasattr(self, "_name"):
10432 # self._name = "[unknown]"
10433 raise PyUnbornObjectError(self.attrStr) # % self._name )
10434
10435 def __nonzero__(self):
10436 return 0
10437
10438
10439#----------------------------------------------------------------------------
10440_wxPyCallAfterId = None
10441
10442def CallAfter(callable, *args, **kw):
10443 """
10444 Call the specified function after the current and pending event
10445 handlers have been completed. This is also good for making GUI
0439c23b
RD
10446 method calls from non-GUI threads. Any extra positional or
10447 keyword args are passed on to the callable when it is called.
10448
10449 :see: `wx.FutureCall`
d55e5bfc
RD
10450 """
10451 app = wx.GetApp()
a001823c 10452 assert app is not None, 'No wx.App created yet'
d55e5bfc
RD
10453
10454 global _wxPyCallAfterId
10455 if _wxPyCallAfterId is None:
10456 _wxPyCallAfterId = wx.NewEventType()
10457 app.Connect(-1, -1, _wxPyCallAfterId,
10458 lambda event: event.callable(*event.args, **event.kw) )
10459 evt = wx.PyEvent()
10460 evt.SetEventType(_wxPyCallAfterId)
10461 evt.callable = callable
10462 evt.args = args
10463 evt.kw = kw
10464 wx.PostEvent(app, evt)
10465
10466
10467#----------------------------------------------------------------------------
10468
10469
10470class FutureCall:
10471 """
10472 A convenience class for wx.Timer, that calls the given callable
10473 object once after the given amount of milliseconds, passing any
10474 positional or keyword args. The return value of the callable is
0439c23b 10475 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
10476
10477 If you don't need to get the return value or restart the timer
10478 then there is no need to hold a reference to this object. It will
10479 hold a reference to itself while the timer is running (the timer
10480 has a reference to self.Notify) but the cycle will be broken when
10481 the timer completes, automatically cleaning up the wx.FutureCall
10482 object.
0439c23b
RD
10483
10484 :see: `wx.CallAfter`
d55e5bfc
RD
10485 """
10486 def __init__(self, millis, callable, *args, **kwargs):
10487 self.millis = millis
10488 self.callable = callable
10489 self.SetArgs(*args, **kwargs)
10490 self.runCount = 0
10491 self.running = False
10492 self.hasRun = False
10493 self.result = None
10494 self.timer = None
10495 self.Start()
10496
10497 def __del__(self):
10498 self.Stop()
10499
10500
10501 def Start(self, millis=None, *args, **kwargs):
10502 """
10503 (Re)start the timer
10504 """
10505 self.hasRun = False
10506 if millis is not None:
10507 self.millis = millis
10508 if args or kwargs:
10509 self.SetArgs(*args, **kwargs)
10510 self.Stop()
10511 self.timer = wx.PyTimer(self.Notify)
10512 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
10513 self.running = True
10514 Restart = Start
10515
10516
10517 def Stop(self):
10518 """
10519 Stop and destroy the timer.
10520 """
10521 if self.timer is not None:
10522 self.timer.Stop()
10523 self.timer = None
10524
10525
10526 def GetInterval(self):
10527 if self.timer is not None:
10528 return self.timer.GetInterval()
10529 else:
10530 return 0
10531
10532
10533 def IsRunning(self):
10534 return self.timer is not None and self.timer.IsRunning()
10535
10536
10537 def SetArgs(self, *args, **kwargs):
10538 """
10539 (Re)set the args passed to the callable object. This is
10540 useful in conjunction with Restart if you want to schedule a
10541 new call to the same callable object but with different
10542 parameters.
10543 """
10544 self.args = args
10545 self.kwargs = kwargs
10546
10547
10548 def HasRun(self):
10549 return self.hasRun
10550
10551 def GetResult(self):
10552 return self.result
10553
10554 def Notify(self):
10555 """
10556 The timer has expired so call the callable.
10557 """
10558 if self.callable and getattr(self.callable, 'im_self', True):
10559 self.runCount += 1
10560 self.running = False
10561 self.result = self.callable(*self.args, **self.kwargs)
10562 self.hasRun = True
10563 if not self.running:
10564 # if it wasn't restarted, then cleanup
10565 wx.CallAfter(self.Stop)
10566
10567
10568
10569#----------------------------------------------------------------------------
10570# Control which items in this module should be documented by epydoc.
10571# We allow only classes and functions, which will help reduce the size
10572# of the docs by filtering out the zillions of constants, EVT objects,
10573# and etc that don't make much sense by themselves, but are instead
10574# documented (or will be) as part of the classes/functions/methods
10575# where they should be used.
10576
d6c14a4c
RD
10577class __DocFilter:
10578 """
10579 A filter for epydoc that only allows non-Ptr classes and
10580 fucntions, in order to reduce the clutter in the API docs.
10581 """
10582 def __init__(self, globals):
10583 self._globals = globals
10584
10585 def __call__(self, name):
10586 import types
10587 obj = self._globals.get(name, None)
10588 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10589 return False
10590 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10591 return False
10592 return True
d55e5bfc
RD
10593
10594#----------------------------------------------------------------------------
10595#----------------------------------------------------------------------------
10596
10597# Import other modules in this package that should show up in the
10598# "core" wx namespace
10599from _gdi import *
10600from _windows import *
10601from _controls import *
10602from _misc import *
10603
10604
10605# Fixup the stock objects since they can't be used yet. (They will be
10606# restored in wx.PyApp.OnInit.)
10607_core_._wxPyFixStockObjects()
10608
10609#----------------------------------------------------------------------------
10610#----------------------------------------------------------------------------
10611
10612