]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
test wxString's char<->wchar_t ctors
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
d14a1e28
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
d14a1e28
RD
5
6#// Give a reference to the dictionary of this module to the C++ extension
7#// code.
54f9ee45 8_core_._wxPySetDictionary(vars())
d14a1e28
RD
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
66c033b4
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
54f9ee45
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
d14a1e28
RD
550#---------------------------------------------------------------------------
551
552class Object(object):
0df68c9f
RD
553 """
554 The base class for most wx objects, although in wxPython not
555 much functionality is needed nor exposed.
556 """
d14a1e28
RD
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,)
e811c8ce 560 def GetClassName(*args, **kwargs):
0df68c9f 561 """
a95a7133 562 GetClassName(self) -> String
e811c8ce 563
a95a7133 564 Returns the class name of the C++ class using wxRTTI.
0df68c9f 565 """
54f9ee45 566 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
567
568 def Destroy(*args, **kwargs):
0df68c9f 569 """
a95a7133 570 Destroy(self)
e811c8ce 571
0df68c9f
RD
572 Deletes the C++ object this Python object is a proxy for.
573 """
54f9ee45 574 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 575
d14a1e28
RD
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
54f9ee45
RD
582_core_.Object_swigregister(ObjectPtr)
583_wxPySetDictionary = _core_._wxPySetDictionary
d14a1e28 584
54f9ee45 585_wxPyFixStockObjects = _core_._wxPyFixStockObjects
3a04f143 586
54f9ee45 587cvar = _core_.cvar
196addbf 588EmptyString = cvar.EmptyString
d14a1e28
RD
589
590#---------------------------------------------------------------------------
591
54f9ee45
RD
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
d14a1e28
RD
643#---------------------------------------------------------------------------
644
645class Size(object):
0df68c9f 646 """
41e2b43e
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.
0df68c9f 651 """
e811c8ce
RD
652 def __repr__(self):
653 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
654 width = property(_core_.Size_width_get, _core_.Size_width_set)
655 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 656 x = width; y = height
d14a1e28 657 def __init__(self, *args, **kwargs):
0df68c9f 658 """
a95a7133 659 __init__(self, int w=0, int h=0) -> Size
e811c8ce 660
0df68c9f
RD
661 Creates a size object.
662 """
54f9ee45 663 newobj = _core_.new_Size(*args, **kwargs)
d14a1e28
RD
664 self.this = newobj.this
665 self.thisown = 1
666 del newobj.thisown
54f9ee45 667 def __del__(self, destroy=_core_.delete_Size):
a95a7133 668 """__del__(self)"""
d14a1e28
RD
669 try:
670 if self.thisown: destroy(self)
671 except: pass
e811c8ce
RD
672
673 def __eq__(*args, **kwargs):
0df68c9f 674 """
a95a7133 675 __eq__(self, Size sz) -> bool
e811c8ce 676
0df68c9f
RD
677 Test for equality of wx.Size objects.
678 """
54f9ee45 679 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
680
681 def __ne__(*args, **kwargs):
0df68c9f 682 """
a95a7133 683 __ne__(self, Size sz) -> bool
e811c8ce 684
0df68c9f
RD
685 Test for inequality.
686 """
54f9ee45 687 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
688
689 def __add__(*args, **kwargs):
0df68c9f 690 """
a95a7133 691 __add__(self, Size sz) -> Size
e811c8ce 692
0df68c9f
RD
693 Add sz's proprties to this and return the result.
694 """
54f9ee45 695 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
696
697 def __sub__(*args, **kwargs):
0df68c9f 698 """
a95a7133 699 __sub__(self, Size sz) -> Size
e811c8ce 700
0df68c9f
RD
701 Subtract sz's properties from this and return the result.
702 """
54f9ee45 703 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
704
705 def IncTo(*args, **kwargs):
0df68c9f 706 """
a95a7133 707 IncTo(self, Size sz)
e811c8ce 708
0df68c9f
RD
709 Increments this object so that both of its dimensions are not less
710 than the corresponding dimensions of the size.
711 """
54f9ee45 712 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
713
714 def DecTo(*args, **kwargs):
0df68c9f 715 """
a95a7133 716 DecTo(self, Size sz)
e811c8ce 717
0df68c9f
RD
718 Decrements this object so that both of its dimensions are not greater
719 than the corresponding dimensions of the size.
720 """
54f9ee45 721 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce
RD
722
723 def Set(*args, **kwargs):
0df68c9f 724 """
a95a7133 725 Set(self, int w, int h)
e811c8ce 726
0df68c9f
RD
727 Set both width and height.
728 """
54f9ee45 729 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
730
731 def SetWidth(*args, **kwargs):
a95a7133 732 """SetWidth(self, int w)"""
54f9ee45 733 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
734
735 def SetHeight(*args, **kwargs):
a95a7133 736 """SetHeight(self, int h)"""
54f9ee45 737 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
738
739 def GetWidth(*args, **kwargs):
a95a7133 740 """GetWidth(self) -> int"""
54f9ee45 741 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
742
743 def GetHeight(*args, **kwargs):
a95a7133 744 """GetHeight(self) -> int"""
54f9ee45 745 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 746
74a57fcd
RD
747 def IsFullySpecified(*args, **kwargs):
748 """
a95a7133 749 IsFullySpecified(self) -> bool
74a57fcd
RD
750
751 Returns True if both components of the size are non-default values.
752 """
54f9ee45 753 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
754
755 def SetDefaults(*args, **kwargs):
756 """
a95a7133 757 SetDefaults(self, Size size)
74a57fcd 758
41e2b43e
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.
74a57fcd 761 """
54f9ee45 762 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 763
e811c8ce 764 def Get(*args, **kwargs):
0df68c9f
RD
765 """
766 Get() -> (width,height)
e811c8ce 767
0df68c9f
RD
768 Returns the width and height properties as a tuple.
769 """
54f9ee45 770 return _core_.Size_Get(*args, **kwargs)
e811c8ce 771
41e2b43e 772 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
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]
d14a1e28
RD
777 def __setitem__(self, index, val):
778 if index == 0: self.width = val
779 elif index == 1: self.height = val
780 else: raise IndexError
e811c8ce 781 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
782 __safe_for_unpickling__ = True
783 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28
RD
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
54f9ee45 791_core_.Size_swigregister(SizePtr)
d14a1e28
RD
792
793#---------------------------------------------------------------------------
794
795class RealPoint(object):
0df68c9f 796 """
41e2b43e
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.
0df68c9f 800 """
e811c8ce
RD
801 def __repr__(self):
802 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
803 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
804 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
d14a1e28 805 def __init__(self, *args, **kwargs):
0df68c9f 806 """
a95a7133 807 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 808
0df68c9f
RD
809 Create a wx.RealPoint object
810 """
54f9ee45 811 newobj = _core_.new_RealPoint(*args, **kwargs)
d14a1e28
RD
812 self.this = newobj.this
813 self.thisown = 1
814 del newobj.thisown
54f9ee45 815 def __del__(self, destroy=_core_.delete_RealPoint):
a95a7133 816 """__del__(self)"""
d14a1e28
RD
817 try:
818 if self.thisown: destroy(self)
819 except: pass
e811c8ce
RD
820
821 def __eq__(*args, **kwargs):
0df68c9f 822 """
a95a7133 823 __eq__(self, RealPoint pt) -> bool
e811c8ce 824
0df68c9f
RD
825 Test for equality of wx.RealPoint objects.
826 """
54f9ee45 827 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
828
829 def __ne__(*args, **kwargs):
0df68c9f 830 """
a95a7133 831 __ne__(self, RealPoint pt) -> bool
e811c8ce 832
0df68c9f
RD
833 Test for inequality of wx.RealPoint objects.
834 """
54f9ee45 835 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
836
837 def __add__(*args, **kwargs):
0df68c9f 838 """
a95a7133 839 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 840
0df68c9f
RD
841 Add pt's proprties to this and return the result.
842 """
54f9ee45 843 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
844
845 def __sub__(*args, **kwargs):
0df68c9f 846 """
a95a7133 847 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 848
0df68c9f
RD
849 Subtract pt's proprties from this and return the result
850 """
54f9ee45 851 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
852
853 def Set(*args, **kwargs):
0df68c9f 854 """
a95a7133 855 Set(self, double x, double y)
e811c8ce 856
0df68c9f
RD
857 Set both the x and y properties
858 """
54f9ee45 859 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
860
861 def Get(*args, **kwargs):
0df68c9f
RD
862 """
863 Get() -> (x,y)
e811c8ce 864
0df68c9f
RD
865 Return the x and y properties as a tuple.
866 """
54f9ee45 867 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 868
41e2b43e 869 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
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]
d14a1e28 874 def __setitem__(self, index, val):
e811c8ce
RD
875 if index == 0: self.x = val
876 elif index == 1: self.y = val
d14a1e28 877 else: raise IndexError
e811c8ce 878 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
879 __safe_for_unpickling__ = True
880 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28
RD
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
54f9ee45 888_core_.RealPoint_swigregister(RealPointPtr)
d14a1e28
RD
889
890#---------------------------------------------------------------------------
891
892class Point(object):
0df68c9f 893 """
41e2b43e
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.
0df68c9f 897 """
e811c8ce
RD
898 def __repr__(self):
899 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
900 x = property(_core_.Point_x_get, _core_.Point_x_set)
901 y = property(_core_.Point_y_get, _core_.Point_y_set)
d14a1e28 902 def __init__(self, *args, **kwargs):
0df68c9f 903 """
a95a7133 904 __init__(self, int x=0, int y=0) -> Point
e811c8ce 905
0df68c9f
RD
906 Create a wx.Point object
907 """
54f9ee45 908 newobj = _core_.new_Point(*args, **kwargs)
d14a1e28
RD
909 self.this = newobj.this
910 self.thisown = 1
911 del newobj.thisown
54f9ee45 912 def __del__(self, destroy=_core_.delete_Point):
a95a7133 913 """__del__(self)"""
d14a1e28
RD
914 try:
915 if self.thisown: destroy(self)
916 except: pass
e811c8ce
RD
917
918 def __eq__(*args, **kwargs):
0df68c9f 919 """
a95a7133 920 __eq__(self, Point pt) -> bool
e811c8ce 921
0df68c9f
RD
922 Test for equality of wx.Point objects.
923 """
54f9ee45 924 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
925
926 def __ne__(*args, **kwargs):
0df68c9f 927 """
a95a7133 928 __ne__(self, Point pt) -> bool
e811c8ce 929
0df68c9f
RD
930 Test for inequality of wx.Point objects.
931 """
54f9ee45 932 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
933
934 def __add__(*args, **kwargs):
0df68c9f 935 """
a95a7133 936 __add__(self, Point pt) -> Point
e811c8ce 937
0df68c9f
RD
938 Add pt's proprties to this and return the result.
939 """
54f9ee45 940 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
941
942 def __sub__(*args, **kwargs):
0df68c9f 943 """
a95a7133 944 __sub__(self, Point pt) -> Point
e811c8ce 945
0df68c9f
RD
946 Subtract pt's proprties from this and return the result
947 """
54f9ee45 948 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
949
950 def __iadd__(*args, **kwargs):
0df68c9f 951 """
a95a7133 952 __iadd__(self, Point pt) -> Point
e811c8ce 953
0df68c9f
RD
954 Add pt to this object.
955 """
54f9ee45 956 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
957
958 def __isub__(*args, **kwargs):
0df68c9f 959 """
a95a7133 960 __isub__(self, Point pt) -> Point
e811c8ce 961
0df68c9f
RD
962 Subtract pt from this object.
963 """
54f9ee45 964 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
965
966 def Set(*args, **kwargs):
0df68c9f 967 """
a95a7133 968 Set(self, long x, long y)
e811c8ce 969
0df68c9f
RD
970 Set both the x and y properties
971 """
54f9ee45 972 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
973
974 def Get(*args, **kwargs):
0df68c9f
RD
975 """
976 Get() -> (x,y)
e811c8ce 977
0df68c9f
RD
978 Return the x and y properties as a tuple.
979 """
54f9ee45 980 return _core_.Point_Get(*args, **kwargs)
e811c8ce 981
41e2b43e 982 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
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]
d14a1e28
RD
987 def __setitem__(self, index, val):
988 if index == 0: self.x = val
989 elif index == 1: self.y = val
990 else: raise IndexError
e811c8ce 991 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
992 __safe_for_unpickling__ = True
993 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28
RD
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
54f9ee45 1001_core_.Point_swigregister(PointPtr)
d14a1e28
RD
1002
1003#---------------------------------------------------------------------------
1004
1005class Rect(object):
0df68c9f 1006 """
41e2b43e
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.
0df68c9f 1010 """
e811c8ce
RD
1011 def __repr__(self):
1012 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1013 def __init__(self, *args, **kwargs):
0df68c9f 1014 """
a95a7133 1015 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1016
0df68c9f
RD
1017 Create a new Rect object.
1018 """
54f9ee45 1019 newobj = _core_.new_Rect(*args, **kwargs)
d14a1e28
RD
1020 self.this = newobj.this
1021 self.thisown = 1
1022 del newobj.thisown
54f9ee45 1023 def __del__(self, destroy=_core_.delete_Rect):
a95a7133 1024 """__del__(self)"""
d14a1e28
RD
1025 try:
1026 if self.thisown: destroy(self)
1027 except: pass
e811c8ce
RD
1028
1029 def GetX(*args, **kwargs):
a95a7133 1030 """GetX(self) -> int"""
54f9ee45 1031 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1032
1033 def SetX(*args, **kwargs):
a95a7133 1034 """SetX(self, int x)"""
54f9ee45 1035 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1036
1037 def GetY(*args, **kwargs):
a95a7133 1038 """GetY(self) -> int"""
54f9ee45 1039 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1040
1041 def SetY(*args, **kwargs):
a95a7133 1042 """SetY(self, int y)"""
54f9ee45 1043 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1044
1045 def GetWidth(*args, **kwargs):
a95a7133 1046 """GetWidth(self) -> int"""
54f9ee45 1047 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1048
1049 def SetWidth(*args, **kwargs):
a95a7133 1050 """SetWidth(self, int w)"""
54f9ee45 1051 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1052
1053 def GetHeight(*args, **kwargs):
a95a7133 1054 """GetHeight(self) -> int"""
54f9ee45 1055 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1056
1057 def SetHeight(*args, **kwargs):
a95a7133 1058 """SetHeight(self, int h)"""
54f9ee45 1059 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1060
1061 def GetPosition(*args, **kwargs):
a95a7133 1062 """GetPosition(self) -> Point"""
54f9ee45 1063 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1064
1065 def SetPosition(*args, **kwargs):
a95a7133 1066 """SetPosition(self, Point p)"""
54f9ee45 1067 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1068
1069 def GetSize(*args, **kwargs):
a95a7133 1070 """GetSize(self) -> Size"""
54f9ee45 1071 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1072
1073 def SetSize(*args, **kwargs):
a95a7133 1074 """SetSize(self, Size s)"""
54f9ee45 1075 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1076
c9c7117a 1077 def GetTopLeft(*args, **kwargs):
a95a7133 1078 """GetTopLeft(self) -> Point"""
54f9ee45 1079 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1080
1081 def SetTopLeft(*args, **kwargs):
a95a7133 1082 """SetTopLeft(self, Point p)"""
54f9ee45 1083 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1084
1085 def GetBottomRight(*args, **kwargs):
a95a7133 1086 """GetBottomRight(self) -> Point"""
54f9ee45 1087 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1088
1089 def SetBottomRight(*args, **kwargs):
a95a7133 1090 """SetBottomRight(self, Point p)"""
54f9ee45 1091 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1092
e811c8ce 1093 def GetLeft(*args, **kwargs):
a95a7133 1094 """GetLeft(self) -> int"""
54f9ee45 1095 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1096
1097 def GetTop(*args, **kwargs):
a95a7133 1098 """GetTop(self) -> int"""
54f9ee45 1099 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1100
1101 def GetBottom(*args, **kwargs):
a95a7133 1102 """GetBottom(self) -> int"""
54f9ee45 1103 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1104
1105 def GetRight(*args, **kwargs):
a95a7133 1106 """GetRight(self) -> int"""
54f9ee45 1107 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1108
1109 def SetLeft(*args, **kwargs):
a95a7133 1110 """SetLeft(self, int left)"""
54f9ee45 1111 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1112
1113 def SetRight(*args, **kwargs):
a95a7133 1114 """SetRight(self, int right)"""
54f9ee45 1115 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1116
1117 def SetTop(*args, **kwargs):
a95a7133 1118 """SetTop(self, int top)"""
54f9ee45 1119 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1120
1121 def SetBottom(*args, **kwargs):
a95a7133 1122 """SetBottom(self, int bottom)"""
54f9ee45 1123 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
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):
0df68c9f 1133 """
a95a7133 1134 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1135
41e2b43e
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.
0df68c9f 1139 """
54f9ee45 1140 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1141
1142 def Deflate(*args, **kwargs):
0df68c9f 1143 """
a95a7133 1144 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1145
41e2b43e
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.
0df68c9f 1149 """
54f9ee45 1150 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1151
1152 def OffsetXY(*args, **kwargs):
0df68c9f 1153 """
a95a7133 1154 OffsetXY(self, int dx, int dy)
e811c8ce 1155
41e2b43e
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.
0df68c9f 1159 """
54f9ee45 1160 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1161
1162 def Offset(*args, **kwargs):
0df68c9f 1163 """
a95a7133 1164 Offset(self, Point pt)
e811c8ce 1165
0df68c9f
RD
1166 Same as OffsetXY but uses dx,dy from Point
1167 """
54f9ee45 1168 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1169
1170 def Intersect(*args, **kwargs):
0df68c9f 1171 """
a95a7133 1172 Intersect(self, Rect rect) -> Rect
e811c8ce 1173
0df68c9f
RD
1174 Return the intersectsion of this rectangle and rect.
1175 """
54f9ee45 1176 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce
RD
1177
1178 def __add__(*args, **kwargs):
0df68c9f 1179 """
a95a7133 1180 __add__(self, Rect rect) -> Rect
e811c8ce 1181
0df68c9f
RD
1182 Add the properties of rect to this rectangle and return the result.
1183 """
54f9ee45 1184 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1185
1186 def __iadd__(*args, **kwargs):
0df68c9f 1187 """
a95a7133 1188 __iadd__(self, Rect rect) -> Rect
e811c8ce 1189
0df68c9f
RD
1190 Add the properties of rect to this rectangle, updating this rectangle.
1191 """
54f9ee45 1192 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1193
1194 def __eq__(*args, **kwargs):
0df68c9f 1195 """
a95a7133 1196 __eq__(self, Rect rect) -> bool
e811c8ce 1197
0df68c9f
RD
1198 Test for equality.
1199 """
54f9ee45 1200 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1201
1202 def __ne__(*args, **kwargs):
0df68c9f 1203 """
a95a7133 1204 __ne__(self, Rect rect) -> bool
e811c8ce 1205
0df68c9f
RD
1206 Test for inequality.
1207 """
54f9ee45 1208 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce
RD
1209
1210 def InsideXY(*args, **kwargs):
0df68c9f 1211 """
a95a7133 1212 InsideXY(self, int x, int y) -> bool
e811c8ce 1213
0df68c9f
RD
1214 Return True if the point is (not strcitly) inside the rect.
1215 """
54f9ee45 1216 return _core_.Rect_InsideXY(*args, **kwargs)
e811c8ce
RD
1217
1218 def Inside(*args, **kwargs):
0df68c9f 1219 """
a95a7133 1220 Inside(self, Point pt) -> bool
e811c8ce 1221
0df68c9f
RD
1222 Return True if the point is (not strcitly) inside the rect.
1223 """
54f9ee45 1224 return _core_.Rect_Inside(*args, **kwargs)
e811c8ce
RD
1225
1226 def Intersects(*args, **kwargs):
0df68c9f 1227 """
a95a7133 1228 Intersects(self, Rect rect) -> bool
e811c8ce 1229
0df68c9f
RD
1230 Returns True if the rectangles have a non empty intersection.
1231 """
54f9ee45 1232 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1233
54f9ee45
RD
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)
e811c8ce 1238 def Set(*args, **kwargs):
0df68c9f 1239 """
a95a7133 1240 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1241
0df68c9f
RD
1242 Set all rectangle properties.
1243 """
54f9ee45 1244 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1245
1246 def Get(*args, **kwargs):
0df68c9f
RD
1247 """
1248 Get() -> (x,y,width,height)
e811c8ce 1249
0df68c9f
RD
1250 Return the rectangle properties as a tuple.
1251 """
54f9ee45 1252 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1253
41e2b43e 1254 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
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]
d14a1e28
RD
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
e811c8ce 1265 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1266 __safe_for_unpickling__ = True
1267 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28
RD
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
54f9ee45 1275_core_.Rect_swigregister(RectPtr)
d14a1e28
RD
1276
1277def RectPP(*args, **kwargs):
0df68c9f
RD
1278 """
1279 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1280
0df68c9f
RD
1281 Create a new Rect object from Points representing two corners.
1282 """
54f9ee45 1283 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1284 val.thisown = 1
1285 return val
1286
1287def RectPS(*args, **kwargs):
0df68c9f
RD
1288 """
1289 RectPS(Point pos, Size size) -> Rect
e811c8ce 1290
0df68c9f
RD
1291 Create a new Rect from a position and size.
1292 """
54f9ee45 1293 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1294 val.thisown = 1
1295 return val
1296
1297
e811c8ce 1298def IntersectRect(*args, **kwargs):
0df68c9f
RD
1299 """
1300 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1301
0df68c9f
RD
1302 Calculate and return the intersection of r1 and r2.
1303 """
54f9ee45 1304 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1305#---------------------------------------------------------------------------
1306
1307class Point2D(object):
41e2b43e
RD
1308 """
1309 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1310 with floating point values.
1311 """
e811c8ce
RD
1312 def __repr__(self):
1313 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1314 def __init__(self, *args, **kwargs):
0df68c9f 1315 """
a95a7133 1316 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1317
0df68c9f
RD
1318 Create a w.Point2D object.
1319 """
54f9ee45 1320 newobj = _core_.new_Point2D(*args, **kwargs)
d14a1e28
RD
1321 self.this = newobj.this
1322 self.thisown = 1
1323 del newobj.thisown
e811c8ce 1324 def GetFloor(*args, **kwargs):
41e2b43e 1325 """GetFloor() -> (x,y)"""
54f9ee45 1326 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1327
1328 def GetRounded(*args, **kwargs):
41e2b43e 1329 """GetRounded() -> (x,y)"""
54f9ee45 1330 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1331
1332 def GetVectorLength(*args, **kwargs):
a95a7133 1333 """GetVectorLength(self) -> double"""
54f9ee45 1334 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1335
1336 def GetVectorAngle(*args, **kwargs):
a95a7133 1337 """GetVectorAngle(self) -> double"""
54f9ee45 1338 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1339
1340 def SetVectorLength(*args, **kwargs):
a95a7133 1341 """SetVectorLength(self, double length)"""
54f9ee45 1342 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1343
1344 def SetVectorAngle(*args, **kwargs):
a95a7133 1345 """SetVectorAngle(self, double degrees)"""
54f9ee45 1346 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1347
d14a1e28
RD
1348 def SetPolarCoordinates(self, angle, length):
1349 self.SetVectorLength(length)
1350 self.SetVectorAngle(angle)
1351 def Normalize(self):
1352 self.SetVectorLength(1.0)
1353
e811c8ce 1354 def GetDistance(*args, **kwargs):
a95a7133 1355 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1356 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1357
1358 def GetDistanceSquare(*args, **kwargs):
a95a7133 1359 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1360 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1361
1362 def GetDotProduct(*args, **kwargs):
a95a7133 1363 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1364 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1365
1366 def GetCrossProduct(*args, **kwargs):
a95a7133 1367 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1368 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1369
1370 def __neg__(*args, **kwargs):
0df68c9f 1371 """
a95a7133 1372 __neg__(self) -> Point2D
e811c8ce 1373
0df68c9f
RD
1374 the reflection of this point
1375 """
54f9ee45 1376 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1377
1378 def __iadd__(*args, **kwargs):
a95a7133 1379 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1380 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1381
1382 def __isub__(*args, **kwargs):
a95a7133 1383 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1384 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1385
1386 def __imul__(*args, **kwargs):
a95a7133 1387 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1388 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1389
1390 def __idiv__(*args, **kwargs):
a95a7133 1391 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1392 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1393
1394 def __eq__(*args, **kwargs):
0df68c9f 1395 """
a95a7133 1396 __eq__(self, Point2D pt) -> bool
e811c8ce 1397
0df68c9f
RD
1398 Test for equality
1399 """
54f9ee45 1400 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1401
1402 def __ne__(*args, **kwargs):
0df68c9f 1403 """
a95a7133 1404 __ne__(self, Point2D pt) -> bool
e811c8ce 1405
0df68c9f
RD
1406 Test for inequality
1407 """
54f9ee45 1408 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1409
54f9ee45
RD
1410 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1411 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1412 def Set(*args, **kwargs):
a95a7133 1413 """Set(self, double x=0, double y=0)"""
54f9ee45 1414 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1415
1416 def Get(*args, **kwargs):
0df68c9f
RD
1417 """
1418 Get() -> (x,y)
e811c8ce 1419
0df68c9f
RD
1420 Return x and y properties as a tuple.
1421 """
54f9ee45 1422 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1423
41e2b43e 1424 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1425 def __str__(self): return str(self.Get())
1426 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1427 def __len__(self): return len(self.Get())
1428 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1429 def __setitem__(self, index, val):
e811c8ce
RD
1430 if index == 0: self.x = val
1431 elif index == 1: self.y = val
d14a1e28 1432 else: raise IndexError
e811c8ce 1433 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1434 __safe_for_unpickling__ = True
1435 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28
RD
1436
1437
1438class Point2DPtr(Point2D):
1439 def __init__(self, this):
1440 self.this = this
1441 if not hasattr(self,"thisown"): self.thisown = 0
1442 self.__class__ = Point2D
54f9ee45 1443_core_.Point2D_swigregister(Point2DPtr)
d14a1e28
RD
1444
1445def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1446 """
1447 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1448
0df68c9f
RD
1449 Create a w.Point2D object.
1450 """
54f9ee45 1451 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1452 val.thisown = 1
1453 return val
1454
1455def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1456 """
1457 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1458
0df68c9f
RD
1459 Create a w.Point2D object.
1460 """
54f9ee45 1461 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1462 val.thisown = 1
1463 return val
1464
1465#---------------------------------------------------------------------------
1466
54f9ee45
RD
1467FromStart = _core_.FromStart
1468FromCurrent = _core_.FromCurrent
1469FromEnd = _core_.FromEnd
d14a1e28 1470class InputStream(object):
e811c8ce
RD
1471 def __repr__(self):
1472 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1473 def __init__(self, *args, **kwargs):
a95a7133 1474 """__init__(self, PyObject p) -> InputStream"""
54f9ee45 1475 newobj = _core_.new_InputStream(*args, **kwargs)
d14a1e28
RD
1476 self.this = newobj.this
1477 self.thisown = 1
1478 del newobj.thisown
e811c8ce 1479 def close(*args, **kwargs):
a95a7133 1480 """close(self)"""
54f9ee45 1481 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1482
1483 def flush(*args, **kwargs):
a95a7133 1484 """flush(self)"""
54f9ee45 1485 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1486
1487 def eof(*args, **kwargs):
a95a7133 1488 """eof(self) -> bool"""
54f9ee45 1489 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1490
1491 def read(*args, **kwargs):
a95a7133 1492 """read(self, int size=-1) -> PyObject"""
54f9ee45 1493 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1494
1495 def readline(*args, **kwargs):
a95a7133 1496 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1497 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1498
1499 def readlines(*args, **kwargs):
a95a7133 1500 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1501 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1502
1503 def seek(*args, **kwargs):
a95a7133 1504 """seek(self, int offset, int whence=0)"""
54f9ee45 1505 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1506
1507 def tell(*args, **kwargs):
a95a7133 1508 """tell(self) -> int"""
54f9ee45 1509 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1510
1511 def Peek(*args, **kwargs):
a95a7133 1512 """Peek(self) -> char"""
54f9ee45 1513 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1514
1515 def GetC(*args, **kwargs):
a95a7133 1516 """GetC(self) -> char"""
54f9ee45 1517 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1518
1519 def LastRead(*args, **kwargs):
a95a7133 1520 """LastRead(self) -> size_t"""
54f9ee45 1521 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1522
1523 def CanRead(*args, **kwargs):
a95a7133 1524 """CanRead(self) -> bool"""
54f9ee45 1525 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1526
1527 def Eof(*args, **kwargs):
a95a7133 1528 """Eof(self) -> bool"""
54f9ee45 1529 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1530
1531 def Ungetch(*args, **kwargs):
a95a7133 1532 """Ungetch(self, char c) -> bool"""
54f9ee45 1533 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1534
1535 def SeekI(*args, **kwargs):
a95a7133 1536 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1537 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1538
1539 def TellI(*args, **kwargs):
a95a7133 1540 """TellI(self) -> long"""
54f9ee45 1541 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1542
d14a1e28
RD
1543
1544class InputStreamPtr(InputStream):
1545 def __init__(self, this):
1546 self.this = this
1547 if not hasattr(self,"thisown"): self.thisown = 0
1548 self.__class__ = InputStream
54f9ee45 1549_core_.InputStream_swigregister(InputStreamPtr)
d14a1e28
RD
1550DefaultPosition = cvar.DefaultPosition
1551DefaultSize = cvar.DefaultSize
1552
1553class OutputStream(object):
d14a1e28
RD
1554 def __init__(self): raise RuntimeError, "No constructor defined"
1555 def __repr__(self):
1556 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1557 def write(*args, **kwargs):
a95a7133 1558 """write(self, PyObject obj)"""
54f9ee45 1559 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1560
d14a1e28
RD
1561
1562class OutputStreamPtr(OutputStream):
1563 def __init__(self, this):
1564 self.this = this
1565 if not hasattr(self,"thisown"): self.thisown = 0
1566 self.__class__ = OutputStream
54f9ee45 1567_core_.OutputStream_swigregister(OutputStreamPtr)
d14a1e28
RD
1568
1569#---------------------------------------------------------------------------
1570
1571class FSFile(Object):
e811c8ce
RD
1572 def __repr__(self):
1573 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1574 def __init__(self, *args, **kwargs):
0df68c9f 1575 """
a95a7133 1576 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 1577 DateTime modif) -> FSFile
0df68c9f 1578 """
54f9ee45 1579 newobj = _core_.new_FSFile(*args, **kwargs)
d14a1e28
RD
1580 self.this = newobj.this
1581 self.thisown = 1
1582 del newobj.thisown
54f9ee45 1583 def __del__(self, destroy=_core_.delete_FSFile):
a95a7133 1584 """__del__(self)"""
d14a1e28
RD
1585 try:
1586 if self.thisown: destroy(self)
1587 except: pass
e811c8ce
RD
1588
1589 def GetStream(*args, **kwargs):
a95a7133 1590 """GetStream(self) -> InputStream"""
54f9ee45 1591 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce
RD
1592
1593 def GetMimeType(*args, **kwargs):
a95a7133 1594 """GetMimeType(self) -> String"""
54f9ee45 1595 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
1596
1597 def GetLocation(*args, **kwargs):
a95a7133 1598 """GetLocation(self) -> String"""
54f9ee45 1599 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
1600
1601 def GetAnchor(*args, **kwargs):
a95a7133 1602 """GetAnchor(self) -> String"""
54f9ee45 1603 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
1604
1605 def GetModificationTime(*args, **kwargs):
a95a7133 1606 """GetModificationTime(self) -> DateTime"""
54f9ee45 1607 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 1608
d14a1e28
RD
1609
1610class FSFilePtr(FSFile):
1611 def __init__(self, this):
1612 self.this = this
1613 if not hasattr(self,"thisown"): self.thisown = 0
1614 self.__class__ = FSFile
54f9ee45 1615_core_.FSFile_swigregister(FSFilePtr)
d14a1e28
RD
1616
1617class CPPFileSystemHandler(object):
1618 def __init__(self): raise RuntimeError, "No constructor defined"
1619 def __repr__(self):
1620 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1621
1622class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1623 def __init__(self, this):
1624 self.this = this
1625 if not hasattr(self,"thisown"): self.thisown = 0
1626 self.__class__ = CPPFileSystemHandler
54f9ee45 1627_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
d14a1e28
RD
1628
1629class FileSystemHandler(CPPFileSystemHandler):
e811c8ce
RD
1630 def __repr__(self):
1631 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1632 def __init__(self, *args, **kwargs):
a95a7133 1633 """__init__(self) -> FileSystemHandler"""
54f9ee45 1634 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
d14a1e28
RD
1635 self.this = newobj.this
1636 self.thisown = 1
1637 del newobj.thisown
1638 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
1639
1640 def _setCallbackInfo(*args, **kwargs):
a95a7133 1641 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 1642 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
1643
1644 def CanOpen(*args, **kwargs):
a95a7133 1645 """CanOpen(self, String location) -> bool"""
54f9ee45 1646 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1647
1648 def OpenFile(*args, **kwargs):
a95a7133 1649 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1650 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1651
1652 def FindFirst(*args, **kwargs):
a95a7133 1653 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1654 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1655
1656 def FindNext(*args, **kwargs):
a95a7133 1657 """FindNext(self) -> String"""
54f9ee45 1658 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
1659
1660 def GetProtocol(*args, **kwargs):
a95a7133 1661 """GetProtocol(self, String location) -> String"""
54f9ee45 1662 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
1663
1664 def GetLeftLocation(*args, **kwargs):
a95a7133 1665 """GetLeftLocation(self, String location) -> String"""
54f9ee45 1666 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
1667
1668 def GetAnchor(*args, **kwargs):
a95a7133 1669 """GetAnchor(self, String location) -> String"""
54f9ee45 1670 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
1671
1672 def GetRightLocation(*args, **kwargs):
a95a7133 1673 """GetRightLocation(self, String location) -> String"""
54f9ee45 1674 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
1675
1676 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 1677 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 1678 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 1679
d14a1e28
RD
1680
1681class FileSystemHandlerPtr(FileSystemHandler):
1682 def __init__(self, this):
1683 self.this = this
1684 if not hasattr(self,"thisown"): self.thisown = 0
1685 self.__class__ = FileSystemHandler
54f9ee45 1686_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
d14a1e28
RD
1687
1688class FileSystem(Object):
e811c8ce
RD
1689 def __repr__(self):
1690 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1691 def __init__(self, *args, **kwargs):
a95a7133 1692 """__init__(self) -> FileSystem"""
54f9ee45 1693 newobj = _core_.new_FileSystem(*args, **kwargs)
d14a1e28
RD
1694 self.this = newobj.this
1695 self.thisown = 1
1696 del newobj.thisown
54f9ee45 1697 def __del__(self, destroy=_core_.delete_FileSystem):
a95a7133 1698 """__del__(self)"""
d14a1e28
RD
1699 try:
1700 if self.thisown: destroy(self)
1701 except: pass
e811c8ce
RD
1702
1703 def ChangePathTo(*args, **kwargs):
a95a7133 1704 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 1705 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
1706
1707 def GetPath(*args, **kwargs):
a95a7133 1708 """GetPath(self) -> String"""
54f9ee45 1709 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
1710
1711 def OpenFile(*args, **kwargs):
a95a7133 1712 """OpenFile(self, String location) -> FSFile"""
54f9ee45 1713 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
1714
1715 def FindFirst(*args, **kwargs):
a95a7133 1716 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1717 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
1718
1719 def FindNext(*args, **kwargs):
a95a7133 1720 """FindNext(self) -> String"""
54f9ee45 1721 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
1722
1723 def AddHandler(*args, **kwargs):
66c033b4 1724 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1725 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
1726
1727 AddHandler = staticmethod(AddHandler)
1728 def CleanUpHandlers(*args, **kwargs):
66c033b4 1729 """CleanUpHandlers()"""
54f9ee45 1730 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
1731
1732 CleanUpHandlers = staticmethod(CleanUpHandlers)
1733 def FileNameToURL(*args, **kwargs):
66c033b4 1734 """FileNameToURL(String filename) -> String"""
54f9ee45 1735 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
1736
1737 FileNameToURL = staticmethod(FileNameToURL)
d14a1e28
RD
1738
1739class FileSystemPtr(FileSystem):
1740 def __init__(self, this):
1741 self.this = this
1742 if not hasattr(self,"thisown"): self.thisown = 0
1743 self.__class__ = FileSystem
54f9ee45 1744_core_.FileSystem_swigregister(FileSystemPtr)
d14a1e28 1745
e811c8ce
RD
1746def FileSystem_AddHandler(*args, **kwargs):
1747 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1748 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 1749
e811c8ce
RD
1750def FileSystem_CleanUpHandlers(*args, **kwargs):
1751 """FileSystem_CleanUpHandlers()"""
54f9ee45 1752 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d14a1e28 1753
e811c8ce 1754def FileSystem_FileNameToURL(*args, **kwargs):
196addbf 1755 """FileSystem_FileNameToURL(String filename) -> String"""
54f9ee45 1756 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28
RD
1757
1758
e811c8ce 1759def FileSystem_URLToFileName(*args, **kwargs):
196addbf 1760 """FileSystem_URLToFileName(String url) -> String"""
54f9ee45 1761 return _core_.FileSystem_URLToFileName(*args, **kwargs)
d14a1e28 1762class InternetFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1763 def __repr__(self):
1764 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1765 def __init__(self, *args, **kwargs):
a95a7133 1766 """__init__(self) -> InternetFSHandler"""
54f9ee45 1767 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
d14a1e28
RD
1768 self.this = newobj.this
1769 self.thisown = 1
1770 del newobj.thisown
e811c8ce 1771 def CanOpen(*args, **kwargs):
a95a7133 1772 """CanOpen(self, String location) -> bool"""
54f9ee45 1773 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1774
1775 def OpenFile(*args, **kwargs):
a95a7133 1776 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1777 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 1778
d14a1e28
RD
1779
1780class InternetFSHandlerPtr(InternetFSHandler):
1781 def __init__(self, this):
1782 self.this = this
1783 if not hasattr(self,"thisown"): self.thisown = 0
1784 self.__class__ = InternetFSHandler
54f9ee45 1785_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
d14a1e28
RD
1786
1787class ZipFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1788 def __repr__(self):
1789 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1790 def __init__(self, *args, **kwargs):
a95a7133 1791 """__init__(self) -> ZipFSHandler"""
54f9ee45 1792 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
d14a1e28
RD
1793 self.this = newobj.this
1794 self.thisown = 1
1795 del newobj.thisown
e811c8ce 1796 def CanOpen(*args, **kwargs):
a95a7133 1797 """CanOpen(self, String location) -> bool"""
54f9ee45 1798 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1799
1800 def OpenFile(*args, **kwargs):
a95a7133 1801 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1802 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1803
1804 def FindFirst(*args, **kwargs):
a95a7133 1805 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1806 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1807
1808 def FindNext(*args, **kwargs):
a95a7133 1809 """FindNext(self) -> String"""
54f9ee45 1810 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 1811
d14a1e28
RD
1812
1813class ZipFSHandlerPtr(ZipFSHandler):
1814 def __init__(self, this):
1815 self.this = this
1816 if not hasattr(self,"thisown"): self.thisown = 0
1817 self.__class__ = ZipFSHandler
54f9ee45 1818_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
d14a1e28
RD
1819
1820
e811c8ce 1821def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
196addbf 1822 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
54f9ee45 1823 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 1824
e811c8ce 1825def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
196addbf 1826 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
54f9ee45 1827 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 1828
e811c8ce 1829def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
196addbf 1830 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
54f9ee45 1831 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
d14a1e28
RD
1832def MemoryFSHandler_AddFile(filename, a, b=''):
1833 if isinstance(a, wx.Image):
1834 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1835 elif isinstance(a, wx.Bitmap):
1836 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1837 elif type(a) == str:
1838 __wxMemoryFSHandler_AddFile_Data(filename, a)
1839 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1840
1841class MemoryFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1842 def __repr__(self):
1843 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1844 def __init__(self, *args, **kwargs):
a95a7133 1845 """__init__(self) -> MemoryFSHandler"""
54f9ee45 1846 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
d14a1e28
RD
1847 self.this = newobj.this
1848 self.thisown = 1
1849 del newobj.thisown
e811c8ce 1850 def RemoveFile(*args, **kwargs):
66c033b4 1851 """RemoveFile(String filename)"""
54f9ee45 1852 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
1853
1854 RemoveFile = staticmethod(RemoveFile)
d14a1e28 1855 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 1856 def CanOpen(*args, **kwargs):
a95a7133 1857 """CanOpen(self, String location) -> bool"""
54f9ee45 1858 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1859
1860 def OpenFile(*args, **kwargs):
a95a7133 1861 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1862 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1863
1864 def FindFirst(*args, **kwargs):
a95a7133 1865 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1866 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1867
1868 def FindNext(*args, **kwargs):
a95a7133 1869 """FindNext(self) -> String"""
54f9ee45 1870 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 1871
d14a1e28
RD
1872
1873class MemoryFSHandlerPtr(MemoryFSHandler):
1874 def __init__(self, this):
1875 self.this = this
1876 if not hasattr(self,"thisown"): self.thisown = 0
1877 self.__class__ = MemoryFSHandler
54f9ee45 1878_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
d14a1e28 1879
e811c8ce 1880def MemoryFSHandler_RemoveFile(*args, **kwargs):
196addbf 1881 """MemoryFSHandler_RemoveFile(String filename)"""
54f9ee45 1882 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28
RD
1883
1884#---------------------------------------------------------------------------
1885
1886class ImageHandler(Object):
d14a1e28
RD
1887 def __init__(self): raise RuntimeError, "No constructor defined"
1888 def __repr__(self):
1889 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1890 def GetName(*args, **kwargs):
a95a7133 1891 """GetName(self) -> String"""
54f9ee45 1892 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
1893
1894 def GetExtension(*args, **kwargs):
a95a7133 1895 """GetExtension(self) -> String"""
54f9ee45 1896 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
1897
1898 def GetType(*args, **kwargs):
a95a7133 1899 """GetType(self) -> long"""
54f9ee45 1900 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
1901
1902 def GetMimeType(*args, **kwargs):
a95a7133 1903 """GetMimeType(self) -> String"""
54f9ee45 1904 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
1905
1906 def CanRead(*args, **kwargs):
a95a7133 1907 """CanRead(self, String name) -> bool"""
54f9ee45 1908 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce
RD
1909
1910 def SetName(*args, **kwargs):
a95a7133 1911 """SetName(self, String name)"""
54f9ee45 1912 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
1913
1914 def SetExtension(*args, **kwargs):
a95a7133 1915 """SetExtension(self, String extension)"""
54f9ee45 1916 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
1917
1918 def SetType(*args, **kwargs):
a95a7133 1919 """SetType(self, long type)"""
54f9ee45 1920 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
1921
1922 def SetMimeType(*args, **kwargs):
a95a7133 1923 """SetMimeType(self, String mimetype)"""
54f9ee45 1924 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 1925
d14a1e28
RD
1926
1927class ImageHandlerPtr(ImageHandler):
1928 def __init__(self, this):
1929 self.this = this
1930 if not hasattr(self,"thisown"): self.thisown = 0
1931 self.__class__ = ImageHandler
54f9ee45 1932_core_.ImageHandler_swigregister(ImageHandlerPtr)
d14a1e28
RD
1933
1934class ImageHistogram(object):
e811c8ce
RD
1935 def __repr__(self):
1936 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1937 def __init__(self, *args, **kwargs):
a95a7133 1938 """__init__(self) -> ImageHistogram"""
54f9ee45 1939 newobj = _core_.new_ImageHistogram(*args, **kwargs)
d14a1e28
RD
1940 self.this = newobj.this
1941 self.thisown = 1
1942 del newobj.thisown
e811c8ce 1943 def MakeKey(*args, **kwargs):
0df68c9f 1944 """
66c033b4 1945 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1946
0df68c9f
RD
1947 Get the key in the histogram for the given RGB values
1948 """
54f9ee45 1949 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
1950
1951 MakeKey = staticmethod(MakeKey)
1952 def FindFirstUnusedColour(*args, **kwargs):
41e2b43e 1953 """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
54f9ee45 1954 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 1955
d14a1e28
RD
1956
1957class ImageHistogramPtr(ImageHistogram):
1958 def __init__(self, this):
1959 self.this = this
1960 if not hasattr(self,"thisown"): self.thisown = 0
1961 self.__class__ = ImageHistogram
54f9ee45 1962_core_.ImageHistogram_swigregister(ImageHistogramPtr)
d14a1e28 1963
e811c8ce 1964def ImageHistogram_MakeKey(*args, **kwargs):
0df68c9f
RD
1965 """
1966 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1967
0df68c9f
RD
1968 Get the key in the histogram for the given RGB values
1969 """
54f9ee45 1970 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28
RD
1971
1972class Image(Object):
e811c8ce
RD
1973 def __repr__(self):
1974 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1975 def __init__(self, *args, **kwargs):
a95a7133 1976 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 1977 newobj = _core_.new_Image(*args, **kwargs)
d14a1e28
RD
1978 self.this = newobj.this
1979 self.thisown = 1
1980 del newobj.thisown
54f9ee45 1981 def __del__(self, destroy=_core_.delete_Image):
a95a7133 1982 """__del__(self)"""
d14a1e28
RD
1983 try:
1984 if self.thisown: destroy(self)
1985 except: pass
e811c8ce
RD
1986
1987 def Create(*args, **kwargs):
a95a7133 1988 """Create(self, int width, int height)"""
54f9ee45 1989 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
1990
1991 def Destroy(*args, **kwargs):
0df68c9f 1992 """
a95a7133 1993 Destroy(self)
e811c8ce 1994
0df68c9f
RD
1995 Deletes the C++ object this Python object is a proxy for.
1996 """
54f9ee45 1997 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
1998
1999 def Scale(*args, **kwargs):
a95a7133 2000 """Scale(self, int width, int height) -> Image"""
54f9ee45 2001 return _core_.Image_Scale(*args, **kwargs)
e811c8ce
RD
2002
2003 def ShrinkBy(*args, **kwargs):
a95a7133 2004 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
54f9ee45 2005 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2006
2007 def Rescale(*args, **kwargs):
a95a7133 2008 """Rescale(self, int width, int height) -> Image"""
54f9ee45 2009 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce
RD
2010
2011 def SetRGB(*args, **kwargs):
a95a7133 2012 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2013 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce
RD
2014
2015 def GetRed(*args, **kwargs):
a95a7133 2016 """GetRed(self, int x, int y) -> unsigned char"""
54f9ee45 2017 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2018
2019 def GetGreen(*args, **kwargs):
a95a7133 2020 """GetGreen(self, int x, int y) -> unsigned char"""
54f9ee45 2021 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2022
2023 def GetBlue(*args, **kwargs):
a95a7133 2024 """GetBlue(self, int x, int y) -> unsigned char"""
54f9ee45 2025 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2026
2027 def SetAlpha(*args, **kwargs):
a95a7133 2028 """SetAlpha(self, int x, int y, unsigned char alpha)"""
54f9ee45 2029 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2030
2031 def GetAlpha(*args, **kwargs):
a95a7133 2032 """GetAlpha(self, int x, int y) -> unsigned char"""
54f9ee45 2033 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2034
2035 def HasAlpha(*args, **kwargs):
a95a7133 2036 """HasAlpha(self) -> bool"""
54f9ee45 2037 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce
RD
2038
2039 def FindFirstUnusedColour(*args, **kwargs):
41e2b43e 2040 """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
54f9ee45 2041 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce
RD
2042
2043 def SetMaskFromImage(*args, **kwargs):
a95a7133 2044 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2045 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2046
2047 def CanRead(*args, **kwargs):
66c033b4 2048 """CanRead(String name) -> bool"""
54f9ee45 2049 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2050
2051 CanRead = staticmethod(CanRead)
2052 def GetImageCount(*args, **kwargs):
66c033b4 2053 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2054 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2055
2056 GetImageCount = staticmethod(GetImageCount)
2057 def LoadFile(*args, **kwargs):
a95a7133 2058 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2059 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2060
2061 def LoadMimeFile(*args, **kwargs):
a95a7133 2062 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2063 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2064
2065 def SaveFile(*args, **kwargs):
a95a7133 2066 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2067 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2068
2069 def SaveMimeFile(*args, **kwargs):
a95a7133 2070 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2071 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2072
2073 def CanReadStream(*args, **kwargs):
66c033b4 2074 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2075 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2076
2077 CanReadStream = staticmethod(CanReadStream)
2078 def LoadStream(*args, **kwargs):
a95a7133 2079 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2080 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2081
2082 def LoadMimeStream(*args, **kwargs):
a95a7133 2083 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2084 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2085
2086 def Ok(*args, **kwargs):
a95a7133 2087 """Ok(self) -> bool"""
54f9ee45 2088 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2089
2090 def GetWidth(*args, **kwargs):
a95a7133 2091 """GetWidth(self) -> int"""
54f9ee45 2092 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2093
2094 def GetHeight(*args, **kwargs):
a95a7133 2095 """GetHeight(self) -> int"""
54f9ee45 2096 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2097
b2df227b 2098 def GetSize(*args, **kwargs):
a95a7133 2099 """GetSize(self) -> Size"""
54f9ee45 2100 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2101
e811c8ce 2102 def GetSubImage(*args, **kwargs):
a95a7133 2103 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2104 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce
RD
2105
2106 def Copy(*args, **kwargs):
a95a7133 2107 """Copy(self) -> Image"""
54f9ee45 2108 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2109
2110 def Paste(*args, **kwargs):
a95a7133 2111 """Paste(self, Image image, int x, int y)"""
54f9ee45 2112 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2113
2114 def GetData(*args, **kwargs):
a95a7133 2115 """GetData(self) -> PyObject"""
54f9ee45 2116 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2117
2118 def SetData(*args, **kwargs):
a95a7133 2119 """SetData(self, PyObject data)"""
54f9ee45 2120 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2121
2122 def GetDataBuffer(*args, **kwargs):
a95a7133 2123 """GetDataBuffer(self) -> PyObject"""
54f9ee45 2124 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2125
2126 def SetDataBuffer(*args, **kwargs):
a95a7133 2127 """SetDataBuffer(self, PyObject data)"""
54f9ee45 2128 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2129
2130 def GetAlphaData(*args, **kwargs):
a95a7133 2131 """GetAlphaData(self) -> PyObject"""
54f9ee45 2132 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2133
2134 def SetAlphaData(*args, **kwargs):
a95a7133 2135 """SetAlphaData(self, PyObject data)"""
54f9ee45 2136 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2137
2138 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2139 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2140 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2141
2142 def SetAlphaBuffer(*args, **kwargs):
a95a7133 2143 """SetAlphaBuffer(self, PyObject data)"""
54f9ee45 2144 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2145
2146 def SetMaskColour(*args, **kwargs):
a95a7133 2147 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2148 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce
RD
2149
2150 def GetMaskRed(*args, **kwargs):
a95a7133 2151 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2152 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2153
2154 def GetMaskGreen(*args, **kwargs):
a95a7133 2155 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2156 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2157
2158 def GetMaskBlue(*args, **kwargs):
a95a7133 2159 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2160 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2161
2162 def SetMask(*args, **kwargs):
a95a7133 2163 """SetMask(self, bool mask=True)"""
54f9ee45 2164 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2165
2166 def HasMask(*args, **kwargs):
a95a7133 2167 """HasMask(self) -> bool"""
54f9ee45 2168 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2169
2170 def Rotate(*args, **kwargs):
0df68c9f 2171 """
a95a7133 2172 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2173 Point offset_after_rotation=None) -> Image
2174 """
54f9ee45 2175 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2176
2177 def Rotate90(*args, **kwargs):
a95a7133 2178 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2179 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2180
2181 def Mirror(*args, **kwargs):
a95a7133 2182 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2183 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2184
2185 def Replace(*args, **kwargs):
0df68c9f 2186 """
a95a7133 2187 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2188 unsigned char r2, unsigned char g2, unsigned char b2)
2189 """
54f9ee45 2190 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2191
2192 def ConvertToMono(*args, **kwargs):
a95a7133 2193 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2194 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2195
2196 def SetOption(*args, **kwargs):
a95a7133 2197 """SetOption(self, String name, String value)"""
54f9ee45 2198 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2199
2200 def SetOptionInt(*args, **kwargs):
a95a7133 2201 """SetOptionInt(self, String name, int value)"""
54f9ee45 2202 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2203
2204 def GetOption(*args, **kwargs):
a95a7133 2205 """GetOption(self, String name) -> String"""
54f9ee45 2206 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2207
2208 def GetOptionInt(*args, **kwargs):
a95a7133 2209 """GetOptionInt(self, String name) -> int"""
54f9ee45 2210 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2211
2212 def HasOption(*args, **kwargs):
a95a7133 2213 """HasOption(self, String name) -> bool"""
54f9ee45 2214 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2215
2216 def CountColours(*args, **kwargs):
a95a7133 2217 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2218 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2219
2220 def ComputeHistogram(*args, **kwargs):
a95a7133 2221 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2222 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2223
2224 def AddHandler(*args, **kwargs):
66c033b4 2225 """AddHandler(ImageHandler handler)"""
54f9ee45 2226 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2227
2228 AddHandler = staticmethod(AddHandler)
2229 def InsertHandler(*args, **kwargs):
66c033b4 2230 """InsertHandler(ImageHandler handler)"""
54f9ee45 2231 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2232
2233 InsertHandler = staticmethod(InsertHandler)
2234 def RemoveHandler(*args, **kwargs):
66c033b4 2235 """RemoveHandler(String name) -> bool"""
54f9ee45 2236 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2237
2238 RemoveHandler = staticmethod(RemoveHandler)
2239 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2240 """GetImageExtWildcard() -> String"""
54f9ee45 2241 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2242
2243 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2244 def ConvertToBitmap(*args, **kwargs):
a95a7133 2245 """ConvertToBitmap(self) -> Bitmap"""
54f9ee45 2246 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2247
2248 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2249 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2250 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2251
2252 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2253
2254class ImagePtr(Image):
2255 def __init__(self, this):
2256 self.this = this
2257 if not hasattr(self,"thisown"): self.thisown = 0
2258 self.__class__ = Image
54f9ee45 2259_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2260
2261def ImageFromMime(*args, **kwargs):
196addbf 2262 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2263 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2264 val.thisown = 1
2265 return val
2266
2267def ImageFromStream(*args, **kwargs):
196addbf 2268 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2269 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2270 val.thisown = 1
2271 return val
2272
2273def ImageFromStreamMime(*args, **kwargs):
196addbf 2274 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2275 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2276 val.thisown = 1
2277 return val
2278
66c033b4
RD
2279def EmptyImage(*args, **kwargs):
2280 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2281 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2282 val.thisown = 1
2283 return val
2284
2285def ImageFromBitmap(*args, **kwargs):
196addbf 2286 """ImageFromBitmap(Bitmap bitmap) -> Image"""
54f9ee45 2287 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2288 val.thisown = 1
2289 return val
2290
2291def ImageFromData(*args, **kwargs):
e811c8ce 2292 """ImageFromData(int width, int height, unsigned char data) -> Image"""
54f9ee45 2293 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2294 val.thisown = 1
2295 return val
2296
e811c8ce 2297def Image_CanRead(*args, **kwargs):
196addbf 2298 """Image_CanRead(String name) -> bool"""
54f9ee45 2299 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2300
e811c8ce 2301def Image_GetImageCount(*args, **kwargs):
196addbf 2302 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2303 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2304
e811c8ce 2305def Image_CanReadStream(*args, **kwargs):
196addbf 2306 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2307 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2308
e811c8ce
RD
2309def Image_AddHandler(*args, **kwargs):
2310 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2311 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2312
e811c8ce
RD
2313def Image_InsertHandler(*args, **kwargs):
2314 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2315 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2316
e811c8ce 2317def Image_RemoveHandler(*args, **kwargs):
196addbf 2318 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2319 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2320
e811c8ce 2321def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2322 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2323 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2324
5e4ca4a8
RD
2325def InitAllImageHandlers():
2326 """
2327 The former functionality of InitAllImageHanders is now done internal to
2328 the _core_ extension module and so this function has become a simple NOP.
2329 """
2330 pass
d14a1e28 2331
54f9ee45
RD
2332IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2333IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2334BMP_24BPP = _core_.BMP_24BPP
2335BMP_8BPP = _core_.BMP_8BPP
2336BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2337BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2338BMP_8BPP_RED = _core_.BMP_8BPP_RED
2339BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2340BMP_4BPP = _core_.BMP_4BPP
2341BMP_1BPP = _core_.BMP_1BPP
2342BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2343class BMPHandler(ImageHandler):
e811c8ce
RD
2344 def __repr__(self):
2345 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2346 def __init__(self, *args, **kwargs):
a95a7133 2347 """__init__(self) -> BMPHandler"""
54f9ee45 2348 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2349 self.this = newobj.this
2350 self.thisown = 1
2351 del newobj.thisown
d14a1e28
RD
2352
2353class BMPHandlerPtr(BMPHandler):
2354 def __init__(self, this):
2355 self.this = this
2356 if not hasattr(self,"thisown"): self.thisown = 0
2357 self.__class__ = BMPHandler
54f9ee45 2358_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28
RD
2359NullImage = cvar.NullImage
2360IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2361IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2362IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2363IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2364IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2365
2366class ICOHandler(BMPHandler):
e811c8ce
RD
2367 def __repr__(self):
2368 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2369 def __init__(self, *args, **kwargs):
a95a7133 2370 """__init__(self) -> ICOHandler"""
54f9ee45 2371 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2372 self.this = newobj.this
2373 self.thisown = 1
2374 del newobj.thisown
d14a1e28
RD
2375
2376class ICOHandlerPtr(ICOHandler):
2377 def __init__(self, this):
2378 self.this = this
2379 if not hasattr(self,"thisown"): self.thisown = 0
2380 self.__class__ = ICOHandler
54f9ee45 2381_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2382
2383class CURHandler(ICOHandler):
e811c8ce
RD
2384 def __repr__(self):
2385 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2386 def __init__(self, *args, **kwargs):
a95a7133 2387 """__init__(self) -> CURHandler"""
54f9ee45 2388 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2389 self.this = newobj.this
2390 self.thisown = 1
2391 del newobj.thisown
d14a1e28
RD
2392
2393class CURHandlerPtr(CURHandler):
2394 def __init__(self, this):
2395 self.this = this
2396 if not hasattr(self,"thisown"): self.thisown = 0
2397 self.__class__ = CURHandler
54f9ee45 2398_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2399
2400class ANIHandler(CURHandler):
e811c8ce
RD
2401 def __repr__(self):
2402 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2403 def __init__(self, *args, **kwargs):
a95a7133 2404 """__init__(self) -> ANIHandler"""
54f9ee45 2405 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2406 self.this = newobj.this
2407 self.thisown = 1
2408 del newobj.thisown
d14a1e28
RD
2409
2410class ANIHandlerPtr(ANIHandler):
2411 def __init__(self, this):
2412 self.this = this
2413 if not hasattr(self,"thisown"): self.thisown = 0
2414 self.__class__ = ANIHandler
54f9ee45 2415_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2416
2417class PNGHandler(ImageHandler):
e811c8ce
RD
2418 def __repr__(self):
2419 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2420 def __init__(self, *args, **kwargs):
a95a7133 2421 """__init__(self) -> PNGHandler"""
54f9ee45 2422 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2423 self.this = newobj.this
2424 self.thisown = 1
2425 del newobj.thisown
d14a1e28
RD
2426
2427class PNGHandlerPtr(PNGHandler):
2428 def __init__(self, this):
2429 self.this = this
2430 if not hasattr(self,"thisown"): self.thisown = 0
2431 self.__class__ = PNGHandler
54f9ee45 2432_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2433
2434class GIFHandler(ImageHandler):
e811c8ce
RD
2435 def __repr__(self):
2436 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2437 def __init__(self, *args, **kwargs):
a95a7133 2438 """__init__(self) -> GIFHandler"""
54f9ee45 2439 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2440 self.this = newobj.this
2441 self.thisown = 1
2442 del newobj.thisown
d14a1e28
RD
2443
2444class GIFHandlerPtr(GIFHandler):
2445 def __init__(self, this):
2446 self.this = this
2447 if not hasattr(self,"thisown"): self.thisown = 0
2448 self.__class__ = GIFHandler
54f9ee45 2449_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2450
2451class PCXHandler(ImageHandler):
e811c8ce
RD
2452 def __repr__(self):
2453 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2454 def __init__(self, *args, **kwargs):
a95a7133 2455 """__init__(self) -> PCXHandler"""
54f9ee45 2456 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2457 self.this = newobj.this
2458 self.thisown = 1
2459 del newobj.thisown
d14a1e28
RD
2460
2461class PCXHandlerPtr(PCXHandler):
2462 def __init__(self, this):
2463 self.this = this
2464 if not hasattr(self,"thisown"): self.thisown = 0
2465 self.__class__ = PCXHandler
54f9ee45 2466_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2467
2468class JPEGHandler(ImageHandler):
e811c8ce
RD
2469 def __repr__(self):
2470 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2471 def __init__(self, *args, **kwargs):
a95a7133 2472 """__init__(self) -> JPEGHandler"""
54f9ee45 2473 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2474 self.this = newobj.this
2475 self.thisown = 1
2476 del newobj.thisown
d14a1e28
RD
2477
2478class JPEGHandlerPtr(JPEGHandler):
2479 def __init__(self, this):
2480 self.this = this
2481 if not hasattr(self,"thisown"): self.thisown = 0
2482 self.__class__ = JPEGHandler
54f9ee45 2483_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2484
2485class PNMHandler(ImageHandler):
e811c8ce
RD
2486 def __repr__(self):
2487 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2488 def __init__(self, *args, **kwargs):
a95a7133 2489 """__init__(self) -> PNMHandler"""
54f9ee45 2490 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2491 self.this = newobj.this
2492 self.thisown = 1
2493 del newobj.thisown
d14a1e28
RD
2494
2495class PNMHandlerPtr(PNMHandler):
2496 def __init__(self, this):
2497 self.this = this
2498 if not hasattr(self,"thisown"): self.thisown = 0
2499 self.__class__ = PNMHandler
54f9ee45 2500_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2501
2502class XPMHandler(ImageHandler):
e811c8ce
RD
2503 def __repr__(self):
2504 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2505 def __init__(self, *args, **kwargs):
a95a7133 2506 """__init__(self) -> XPMHandler"""
54f9ee45 2507 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2508 self.this = newobj.this
2509 self.thisown = 1
2510 del newobj.thisown
d14a1e28
RD
2511
2512class XPMHandlerPtr(XPMHandler):
2513 def __init__(self, this):
2514 self.this = this
2515 if not hasattr(self,"thisown"): self.thisown = 0
2516 self.__class__ = XPMHandler
54f9ee45 2517_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2518
2519class TIFFHandler(ImageHandler):
e811c8ce
RD
2520 def __repr__(self):
2521 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2522 def __init__(self, *args, **kwargs):
a95a7133 2523 """__init__(self) -> TIFFHandler"""
54f9ee45 2524 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2525 self.this = newobj.this
2526 self.thisown = 1
2527 del newobj.thisown
d14a1e28
RD
2528
2529class TIFFHandlerPtr(TIFFHandler):
2530 def __init__(self, this):
2531 self.this = this
2532 if not hasattr(self,"thisown"): self.thisown = 0
2533 self.__class__ = TIFFHandler
54f9ee45 2534_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28
RD
2535
2536#---------------------------------------------------------------------------
2537
2538class EvtHandler(Object):
e811c8ce
RD
2539 def __repr__(self):
2540 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2541 def __init__(self, *args, **kwargs):
a95a7133 2542 """__init__(self) -> EvtHandler"""
54f9ee45 2543 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2544 self.this = newobj.this
2545 self.thisown = 1
2546 del newobj.thisown
e811c8ce 2547 def GetNextHandler(*args, **kwargs):
a95a7133 2548 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2549 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2550
2551 def GetPreviousHandler(*args, **kwargs):
a95a7133 2552 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2553 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2554
2555 def SetNextHandler(*args, **kwargs):
a95a7133 2556 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2557 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2558
2559 def SetPreviousHandler(*args, **kwargs):
a95a7133 2560 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2561 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2562
2563 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2564 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2565 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2566
2567 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2568 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2569 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2570
2571 def ProcessEvent(*args, **kwargs):
a95a7133 2572 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2573 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2574
2575 def AddPendingEvent(*args, **kwargs):
a95a7133 2576 """AddPendingEvent(self, Event event)"""
54f9ee45 2577 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2578
2579 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2580 """ProcessPendingEvents(self)"""
54f9ee45 2581 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2582
2583 def Connect(*args, **kwargs):
a95a7133 2584 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2585 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2586
2587 def Disconnect(*args, **kwargs):
a95a7133 2588 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2589 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2590
2591 def _setOORInfo(*args, **kwargs):
a95a7133 2592 """_setOORInfo(self, PyObject _self)"""
54f9ee45 2593 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2594
d14a1e28
RD
2595 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2596 """
2597 Bind an event to an event handler.
2598
db3e571a
RD
2599 :param event: One of the EVT_* objects that specifies the
2600 type of event to bind,
d14a1e28 2601
db3e571a
RD
2602 :param handler: A callable object to be invoked when the
2603 event is delivered to self. Pass None to
2604 disconnect an event handler.
d14a1e28 2605
db3e571a
RD
2606 :param source: Sometimes the event originates from a
2607 different window than self, but you still
2608 want to catch it in self. (For example, a
2609 button event delivered to a frame.) By
2610 passing the source of the event, the event
2611 handling system is able to differentiate
2612 between the same event type from different
2613 controls.
d14a1e28 2614
db3e571a
RD
2615 :param id: Used to spcify the event source by ID instead
2616 of instance.
2617
2618 :param id2: Used when it is desirable to bind a handler
2619 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2620 """
2621 if source is not None:
2622 id = source.GetId()
2623 event.Bind(self, id, id2, handler)
2624
66c033b4
RD
2625 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2626 """
2627 Disconencts the event handler binding for event from self.
2628 Returns True if successful.
2629 """
2630 if source is not None:
2631 id = source.GetId()
2632 return event.Unbind(self, id, id2)
d14a1e28 2633
d14a1e28
RD
2634
2635class EvtHandlerPtr(EvtHandler):
2636 def __init__(self, this):
2637 self.this = this
2638 if not hasattr(self,"thisown"): self.thisown = 0
2639 self.__class__ = EvtHandler
54f9ee45 2640_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
2641
2642#---------------------------------------------------------------------------
2643
2644class PyEventBinder(object):
2645 """
2646 Instances of this class are used to bind specific events to event
2647 handlers.
2648 """
2649 def __init__(self, evtType, expectedIDs=0):
2650 if expectedIDs not in [0, 1, 2]:
2651 raise ValueError, "Invalid number of expectedIDs"
2652 self.expectedIDs = expectedIDs
2653
2654 if type(evtType) == list or type(evtType) == tuple:
2655 self.evtType = evtType
2656 else:
2657 self.evtType = [evtType]
2658
2659
2660 def Bind(self, target, id1, id2, function):
2661 """Bind this set of event types to target."""
2662 for et in self.evtType:
2663 target.Connect(id1, id2, et, function)
2664
66c033b4
RD
2665
2666 def Unbind(self, target, id1, id2):
2667 """Remove an event binding."""
2668 success = 0
2669 for et in self.evtType:
2670 success += target.Disconnect(id1, id2, et)
2671 return success != 0
2672
d14a1e28
RD
2673
2674 def __call__(self, *args):
2675 """
2676 For backwards compatibility with the old EVT_* functions.
2677 Should be called with either (window, func), (window, ID,
2678 func) or (window, ID1, ID2, func) parameters depending on the
2679 type of the event.
2680 """
2681 assert len(args) == 2 + self.expectedIDs
2682 id1 = wx.ID_ANY
2683 id2 = wx.ID_ANY
2684 target = args[0]
2685 if self.expectedIDs == 0:
2686 func = args[1]
2687 elif self.expectedIDs == 1:
2688 id1 = args[1]
2689 func = args[2]
2690 elif self.expectedIDs == 2:
2691 id1 = args[1]
2692 id2 = args[2]
2693 func = args[3]
2694 else:
2695 raise ValueError, "Unexpected number of IDs"
2696
2697 self.Bind(target, id1, id2, func)
2698
2699
2700# These two are square pegs that don't fit the PyEventBinder hole...
2701def EVT_COMMAND(win, id, cmd, func):
2702 win.Connect(id, -1, cmd, func)
2703def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2704 win.Connect(id1, id2, cmd, func)
2705
2706
2707#---------------------------------------------------------------------------
2708
2709#---------------------------------------------------------------------------
2710
54f9ee45
RD
2711EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2712EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 2713
e811c8ce
RD
2714def NewEventType(*args, **kwargs):
2715 """NewEventType() -> wxEventType"""
54f9ee45
RD
2716 return _core_.NewEventType(*args, **kwargs)
2717wxEVT_NULL = _core_.wxEVT_NULL
2718wxEVT_FIRST = _core_.wxEVT_FIRST
2719wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2720wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2721wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2722wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2723wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2724wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2725wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2726wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2727wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2728wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2729wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2730wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2731wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2732wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2733wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2734wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2735wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2736wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2737wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2738wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2739wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2740wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2741wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2742wxEVT_MOTION = _core_.wxEVT_MOTION
2743wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2744wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2745wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2746wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2747wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2748wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2749wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2750wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2751wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2752wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2753wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2754wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2755wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2756wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2757wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2758wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2759wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2760wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2761wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2762wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2763wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2764wxEVT_CHAR = _core_.wxEVT_CHAR
2765wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2766wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2767wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2768wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2769wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2770wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2771wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2772wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2773wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2774wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2775wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2776wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2777wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2778wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2779wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2780wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2781wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2782wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2783wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2784wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2785wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2786wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2787wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2788wxEVT_SIZE = _core_.wxEVT_SIZE
2789wxEVT_MOVE = _core_.wxEVT_MOVE
2790wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2791wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2792wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2793wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2794wxEVT_POWER = _core_.wxEVT_POWER
2795wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2796wxEVT_CREATE = _core_.wxEVT_CREATE
2797wxEVT_DESTROY = _core_.wxEVT_DESTROY
2798wxEVT_SHOW = _core_.wxEVT_SHOW
2799wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2800wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2801wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2802wxEVT_PAINT = _core_.wxEVT_PAINT
2803wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2804wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2805wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2806wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2807wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2808wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2809wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2810wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2811wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2812wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2813wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2814wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2815wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2816wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2817wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2818wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2819wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2820wxEVT_IDLE = _core_.wxEVT_IDLE
2821wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2822wxEVT_SIZING = _core_.wxEVT_SIZING
2823wxEVT_MOVING = _core_.wxEVT_MOVING
2824wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2825wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2826wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2827wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2828wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2829wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2830wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
2831#
2832# Create some event binders
2833EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2834EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2835EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2836EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2837EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2838EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2839EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2840EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2841EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2842EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2843EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2844EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2845EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2846EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2847EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2848EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2849EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2850EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2851EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2852EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2853EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2854EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2855EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2856EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2857EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2858EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2859EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
2860EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
2861EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
2862EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
2863EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
2864EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
2865EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
2866EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
2867EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
2868EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
2869EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
2870EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
2871EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
2872EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
2873
2874EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
2875EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
2876EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
2877EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
2878EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
2879EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
2880EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
2881EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
2882EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
2883EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
2884EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
2885EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
2886EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
2887
2888EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
2889 wxEVT_LEFT_UP,
2890 wxEVT_MIDDLE_DOWN,
2891 wxEVT_MIDDLE_UP,
2892 wxEVT_RIGHT_DOWN,
2893 wxEVT_RIGHT_UP,
2894 wxEVT_MOTION,
2895 wxEVT_LEFT_DCLICK,
2896 wxEVT_MIDDLE_DCLICK,
2897 wxEVT_RIGHT_DCLICK,
2898 wxEVT_ENTER_WINDOW,
2899 wxEVT_LEAVE_WINDOW,
2900 wxEVT_MOUSEWHEEL
2901 ])
2902
2903
2904# Scrolling from wxWindow (sent to wxScrolledWindow)
2905EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
2906 wxEVT_SCROLLWIN_BOTTOM,
2907 wxEVT_SCROLLWIN_LINEUP,
2908 wxEVT_SCROLLWIN_LINEDOWN,
2909 wxEVT_SCROLLWIN_PAGEUP,
2910 wxEVT_SCROLLWIN_PAGEDOWN,
2911 wxEVT_SCROLLWIN_THUMBTRACK,
2912 wxEVT_SCROLLWIN_THUMBRELEASE,
2913 ])
2914
2915EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
2916EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
2917EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
2918EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
2919EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
2920EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
2921EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
2922EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
2923
2924# Scrolling from wxSlider and wxScrollBar
2925EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2926 wxEVT_SCROLL_BOTTOM,
2927 wxEVT_SCROLL_LINEUP,
2928 wxEVT_SCROLL_LINEDOWN,
2929 wxEVT_SCROLL_PAGEUP,
2930 wxEVT_SCROLL_PAGEDOWN,
2931 wxEVT_SCROLL_THUMBTRACK,
2932 wxEVT_SCROLL_THUMBRELEASE,
2933 wxEVT_SCROLL_ENDSCROLL,
2934 ])
2935
2936EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
2937EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
2938EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
2939EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
2940EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
2941EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
2942EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
2943EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
2944EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
2945
2946# Scrolling from wxSlider and wxScrollBar, with an id
2947EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2948 wxEVT_SCROLL_BOTTOM,
2949 wxEVT_SCROLL_LINEUP,
2950 wxEVT_SCROLL_LINEDOWN,
2951 wxEVT_SCROLL_PAGEUP,
2952 wxEVT_SCROLL_PAGEDOWN,
2953 wxEVT_SCROLL_THUMBTRACK,
2954 wxEVT_SCROLL_THUMBRELEASE,
2955 wxEVT_SCROLL_ENDSCROLL,
2956 ], 1)
2957
2958EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
2959EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
2960EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
2961EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
2962EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
2963EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
2964EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
2965EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
2966EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
2967
d14a1e28
RD
2968EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
2969EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
2970EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
2971EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
2972EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
2973EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
2974EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
2975EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
2976EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
2977EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
2978
2979EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
2980EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
2981EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
2982EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
2983EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
2984EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
2985EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
2986EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
2987EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
2988
2989
2990EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
2991EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
2992EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
2993EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
2994EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
2995EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
2996EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
2997
2998EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
2999
3000EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3001EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3002
3003EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3004
3005
3006
3007#---------------------------------------------------------------------------
3008
3009class Event(Object):
e811c8ce
RD
3010 def __init__(self): raise RuntimeError, "No constructor defined"
3011 def __repr__(self):
3012 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3013 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3014 """__del__(self)"""
d14a1e28
RD
3015 try:
3016 if self.thisown: destroy(self)
3017 except: pass
e811c8ce
RD
3018
3019 def SetEventType(*args, **kwargs):
a95a7133 3020 """SetEventType(self, wxEventType typ)"""
54f9ee45 3021 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3022
3023 def GetEventType(*args, **kwargs):
a95a7133 3024 """GetEventType(self) -> wxEventType"""
54f9ee45 3025 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3026
3027 def GetEventObject(*args, **kwargs):
a95a7133 3028 """GetEventObject(self) -> Object"""
54f9ee45 3029 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3030
3031 def SetEventObject(*args, **kwargs):
a95a7133 3032 """SetEventObject(self, Object obj)"""
54f9ee45 3033 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3034
3035 def GetTimestamp(*args, **kwargs):
a95a7133 3036 """GetTimestamp(self) -> long"""
54f9ee45 3037 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3038
3039 def SetTimestamp(*args, **kwargs):
a95a7133 3040 """SetTimestamp(self, long ts=0)"""
54f9ee45 3041 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3042
3043 def GetId(*args, **kwargs):
a95a7133 3044 """GetId(self) -> int"""
54f9ee45 3045 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3046
3047 def SetId(*args, **kwargs):
a95a7133 3048 """SetId(self, int Id)"""
54f9ee45 3049 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3050
3051 def IsCommandEvent(*args, **kwargs):
a95a7133 3052 """IsCommandEvent(self) -> bool"""
54f9ee45 3053 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3054
3055 def Skip(*args, **kwargs):
a95a7133 3056 """Skip(self, bool skip=True)"""
54f9ee45 3057 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3058
3059 def GetSkipped(*args, **kwargs):
a95a7133 3060 """GetSkipped(self) -> bool"""
54f9ee45 3061 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3062
3063 def ShouldPropagate(*args, **kwargs):
a95a7133 3064 """ShouldPropagate(self) -> bool"""
54f9ee45 3065 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3066
3067 def StopPropagation(*args, **kwargs):
a95a7133 3068 """StopPropagation(self) -> int"""
54f9ee45 3069 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3070
3071 def ResumePropagation(*args, **kwargs):
a95a7133 3072 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3073 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3074
3075 def Clone(*args, **kwargs):
a95a7133 3076 """Clone(self) -> Event"""
54f9ee45 3077 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3078
d14a1e28
RD
3079
3080class EventPtr(Event):
3081 def __init__(self, this):
3082 self.this = this
3083 if not hasattr(self,"thisown"): self.thisown = 0
3084 self.__class__ = Event
54f9ee45 3085_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3086
3087#---------------------------------------------------------------------------
3088
3089class PropagationDisabler(object):
e811c8ce
RD
3090 def __repr__(self):
3091 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3092 def __init__(self, *args, **kwargs):
a95a7133 3093 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3094 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3095 self.this = newobj.this
3096 self.thisown = 1
3097 del newobj.thisown
54f9ee45 3098 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3099 """__del__(self)"""
d14a1e28
RD
3100 try:
3101 if self.thisown: destroy(self)
3102 except: pass
e811c8ce 3103
d14a1e28
RD
3104
3105class PropagationDisablerPtr(PropagationDisabler):
3106 def __init__(self, this):
3107 self.this = this
3108 if not hasattr(self,"thisown"): self.thisown = 0
3109 self.__class__ = PropagationDisabler
54f9ee45 3110_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3111
3112class PropagateOnce(object):
e811c8ce
RD
3113 def __repr__(self):
3114 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3115 def __init__(self, *args, **kwargs):
a95a7133 3116 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3117 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3118 self.this = newobj.this
3119 self.thisown = 1
3120 del newobj.thisown
54f9ee45 3121 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3122 """__del__(self)"""
d14a1e28
RD
3123 try:
3124 if self.thisown: destroy(self)
3125 except: pass
e811c8ce 3126
d14a1e28
RD
3127
3128class PropagateOncePtr(PropagateOnce):
3129 def __init__(self, this):
3130 self.this = this
3131 if not hasattr(self,"thisown"): self.thisown = 0
3132 self.__class__ = PropagateOnce
54f9ee45 3133_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3134
3135#---------------------------------------------------------------------------
3136
3137class CommandEvent(Event):
e811c8ce
RD
3138 def __repr__(self):
3139 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3140 def __init__(self, *args, **kwargs):
a95a7133 3141 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3142 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3143 self.this = newobj.this
3144 self.thisown = 1
3145 del newobj.thisown
e811c8ce 3146 def GetSelection(*args, **kwargs):
a95a7133 3147 """GetSelection(self) -> int"""
54f9ee45 3148 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3149
3150 def SetString(*args, **kwargs):
a95a7133 3151 """SetString(self, String s)"""
54f9ee45 3152 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3153
3154 def GetString(*args, **kwargs):
a95a7133 3155 """GetString(self) -> String"""
54f9ee45 3156 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3157
3158 def IsChecked(*args, **kwargs):
a95a7133 3159 """IsChecked(self) -> bool"""
54f9ee45 3160 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3161
242b7b46 3162 Checked = IsChecked
e811c8ce 3163 def IsSelection(*args, **kwargs):
a95a7133 3164 """IsSelection(self) -> bool"""
54f9ee45 3165 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3166
3167 def SetExtraLong(*args, **kwargs):
a95a7133 3168 """SetExtraLong(self, long extraLong)"""
54f9ee45 3169 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3170
3171 def GetExtraLong(*args, **kwargs):
a95a7133 3172 """GetExtraLong(self) -> long"""
54f9ee45 3173 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3174
3175 def SetInt(*args, **kwargs):
a95a7133 3176 """SetInt(self, int i)"""
54f9ee45 3177 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3178
3179 def GetInt(*args, **kwargs):
a95a7133 3180 """GetInt(self) -> long"""
54f9ee45 3181 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3182
3183 def Clone(*args, **kwargs):
a95a7133 3184 """Clone(self) -> Event"""
54f9ee45 3185 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3186
d14a1e28
RD
3187
3188class CommandEventPtr(CommandEvent):
3189 def __init__(self, this):
3190 self.this = this
3191 if not hasattr(self,"thisown"): self.thisown = 0
3192 self.__class__ = CommandEvent
54f9ee45 3193_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3194
3195#---------------------------------------------------------------------------
3196
3197class NotifyEvent(CommandEvent):
e811c8ce
RD
3198 def __repr__(self):
3199 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3200 def __init__(self, *args, **kwargs):
a95a7133 3201 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3202 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3203 self.this = newobj.this
3204 self.thisown = 1
3205 del newobj.thisown
e811c8ce 3206 def Veto(*args, **kwargs):
a95a7133 3207 """Veto(self)"""
54f9ee45 3208 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3209
3210 def Allow(*args, **kwargs):
a95a7133 3211 """Allow(self)"""
54f9ee45 3212 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3213
3214 def IsAllowed(*args, **kwargs):
a95a7133 3215 """IsAllowed(self) -> bool"""
54f9ee45 3216 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3217
d14a1e28
RD
3218
3219class NotifyEventPtr(NotifyEvent):
3220 def __init__(self, this):
3221 self.this = this
3222 if not hasattr(self,"thisown"): self.thisown = 0
3223 self.__class__ = NotifyEvent
54f9ee45 3224_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3225
3226#---------------------------------------------------------------------------
3227
3228class ScrollEvent(CommandEvent):
e811c8ce
RD
3229 def __repr__(self):
3230 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3231 def __init__(self, *args, **kwargs):
0df68c9f 3232 """
a95a7133 3233 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3234 int orient=0) -> ScrollEvent
3235 """
54f9ee45 3236 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3237 self.this = newobj.this
3238 self.thisown = 1
3239 del newobj.thisown
e811c8ce 3240 def GetOrientation(*args, **kwargs):
a95a7133 3241 """GetOrientation(self) -> int"""
54f9ee45 3242 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3243
3244 def GetPosition(*args, **kwargs):
a95a7133 3245 """GetPosition(self) -> int"""
54f9ee45 3246 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3247
3248 def SetOrientation(*args, **kwargs):
a95a7133 3249 """SetOrientation(self, int orient)"""
54f9ee45 3250 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3251
3252 def SetPosition(*args, **kwargs):
a95a7133 3253 """SetPosition(self, int pos)"""
54f9ee45 3254 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3255
d14a1e28
RD
3256
3257class ScrollEventPtr(ScrollEvent):
3258 def __init__(self, this):
3259 self.this = this
3260 if not hasattr(self,"thisown"): self.thisown = 0
3261 self.__class__ = ScrollEvent
54f9ee45 3262_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3263
3264#---------------------------------------------------------------------------
3265
3266class ScrollWinEvent(Event):
e811c8ce
RD
3267 def __repr__(self):
3268 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3269 def __init__(self, *args, **kwargs):
a95a7133 3270 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3271 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3272 self.this = newobj.this
3273 self.thisown = 1
3274 del newobj.thisown
e811c8ce 3275 def GetOrientation(*args, **kwargs):
a95a7133 3276 """GetOrientation(self) -> int"""
54f9ee45 3277 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3278
3279 def GetPosition(*args, **kwargs):
a95a7133 3280 """GetPosition(self) -> int"""
54f9ee45 3281 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3282
3283 def SetOrientation(*args, **kwargs):
a95a7133 3284 """SetOrientation(self, int orient)"""
54f9ee45 3285 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3286
3287 def SetPosition(*args, **kwargs):
a95a7133 3288 """SetPosition(self, int pos)"""
54f9ee45 3289 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3290
d14a1e28
RD
3291
3292class ScrollWinEventPtr(ScrollWinEvent):
3293 def __init__(self, this):
3294 self.this = this
3295 if not hasattr(self,"thisown"): self.thisown = 0
3296 self.__class__ = ScrollWinEvent
54f9ee45 3297_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3298
3299#---------------------------------------------------------------------------
3300
54f9ee45
RD
3301MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3302MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3303MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3304MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3305MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3306class MouseEvent(Event):
e811c8ce
RD
3307 def __repr__(self):
3308 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3309 def __init__(self, *args, **kwargs):
a95a7133 3310 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3311 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3312 self.this = newobj.this
3313 self.thisown = 1
3314 del newobj.thisown
e811c8ce 3315 def IsButton(*args, **kwargs):
a95a7133 3316 """IsButton(self) -> bool"""
54f9ee45 3317 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3318
3319 def ButtonDown(*args, **kwargs):
a95a7133 3320 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3321 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3322
3323 def ButtonDClick(*args, **kwargs):
a95a7133 3324 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3325 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3326
3327 def ButtonUp(*args, **kwargs):
a95a7133 3328 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3329 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3330
3331 def Button(*args, **kwargs):
a95a7133 3332 """Button(self, int but) -> bool"""
54f9ee45 3333 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3334
3335 def ButtonIsDown(*args, **kwargs):
a95a7133 3336 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3337 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3338
3339 def GetButton(*args, **kwargs):
a95a7133 3340 """GetButton(self) -> int"""
54f9ee45 3341 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3342
3343 def ControlDown(*args, **kwargs):
a95a7133 3344 """ControlDown(self) -> bool"""
54f9ee45 3345 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3346
3347 def MetaDown(*args, **kwargs):
a95a7133 3348 """MetaDown(self) -> bool"""
54f9ee45 3349 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3350
3351 def AltDown(*args, **kwargs):
a95a7133 3352 """AltDown(self) -> bool"""
54f9ee45 3353 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3354
3355 def ShiftDown(*args, **kwargs):
a95a7133 3356 """ShiftDown(self) -> bool"""
54f9ee45 3357 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce
RD
3358
3359 def LeftDown(*args, **kwargs):
a95a7133 3360 """LeftDown(self) -> bool"""
54f9ee45 3361 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3362
3363 def MiddleDown(*args, **kwargs):
a95a7133 3364 """MiddleDown(self) -> bool"""
54f9ee45 3365 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3366
3367 def RightDown(*args, **kwargs):
a95a7133 3368 """RightDown(self) -> bool"""
54f9ee45 3369 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3370
3371 def LeftUp(*args, **kwargs):
a95a7133 3372 """LeftUp(self) -> bool"""
54f9ee45 3373 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3374
3375 def MiddleUp(*args, **kwargs):
a95a7133 3376 """MiddleUp(self) -> bool"""
54f9ee45 3377 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3378
3379 def RightUp(*args, **kwargs):
a95a7133 3380 """RightUp(self) -> bool"""
54f9ee45 3381 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3382
3383 def LeftDClick(*args, **kwargs):
a95a7133 3384 """LeftDClick(self) -> bool"""
54f9ee45 3385 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3386
3387 def MiddleDClick(*args, **kwargs):
a95a7133 3388 """MiddleDClick(self) -> bool"""
54f9ee45 3389 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3390
3391 def RightDClick(*args, **kwargs):
a95a7133 3392 """RightDClick(self) -> bool"""
54f9ee45 3393 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3394
3395 def LeftIsDown(*args, **kwargs):
a95a7133 3396 """LeftIsDown(self) -> bool"""
54f9ee45 3397 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3398
3399 def MiddleIsDown(*args, **kwargs):
a95a7133 3400 """MiddleIsDown(self) -> bool"""
54f9ee45 3401 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3402
3403 def RightIsDown(*args, **kwargs):
a95a7133 3404 """RightIsDown(self) -> bool"""
54f9ee45 3405 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3406
3407 def Dragging(*args, **kwargs):
a95a7133 3408 """Dragging(self) -> bool"""
54f9ee45 3409 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3410
3411 def Moving(*args, **kwargs):
a95a7133 3412 """Moving(self) -> bool"""
54f9ee45 3413 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3414
3415 def Entering(*args, **kwargs):
a95a7133 3416 """Entering(self) -> bool"""
54f9ee45 3417 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3418
3419 def Leaving(*args, **kwargs):
a95a7133 3420 """Leaving(self) -> bool"""
54f9ee45 3421 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3422
3423 def GetPosition(*args, **kwargs):
0df68c9f 3424 """
a95a7133 3425 GetPosition(self) -> Point
e811c8ce 3426
41e2b43e
RD
3427 Returns the position of the mouse in window coordinates when the event
3428 happened.
0df68c9f 3429 """
54f9ee45 3430 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3431
3432 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3433 """
3434 GetPositionTuple() -> (x,y)
e811c8ce 3435
41e2b43e
RD
3436 Returns the position of the mouse in window coordinates when the event
3437 happened.
0df68c9f 3438 """
54f9ee45 3439 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3440
3441 def GetLogicalPosition(*args, **kwargs):
a95a7133 3442 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3443 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3444
3445 def GetX(*args, **kwargs):
a95a7133 3446 """GetX(self) -> int"""
54f9ee45 3447 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3448
3449 def GetY(*args, **kwargs):
a95a7133 3450 """GetY(self) -> int"""
54f9ee45 3451 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3452
3453 def GetWheelRotation(*args, **kwargs):
a95a7133 3454 """GetWheelRotation(self) -> int"""
54f9ee45 3455 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3456
3457 def GetWheelDelta(*args, **kwargs):
a95a7133 3458 """GetWheelDelta(self) -> int"""
54f9ee45 3459 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3460
3461 def GetLinesPerAction(*args, **kwargs):
a95a7133 3462 """GetLinesPerAction(self) -> int"""
54f9ee45 3463 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3464
3465 def IsPageScroll(*args, **kwargs):
a95a7133 3466 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3467 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3468
3469 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3470 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3471 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3472 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3473 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3474 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3475 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3476 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3477 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3478 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3479 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3480 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3481
3482class MouseEventPtr(MouseEvent):
3483 def __init__(self, this):
3484 self.this = this
3485 if not hasattr(self,"thisown"): self.thisown = 0
3486 self.__class__ = MouseEvent
54f9ee45 3487_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3488
3489#---------------------------------------------------------------------------
3490
3491class SetCursorEvent(Event):
e811c8ce
RD
3492 def __repr__(self):
3493 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3494 def __init__(self, *args, **kwargs):
a95a7133 3495 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3496 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3497 self.this = newobj.this
3498 self.thisown = 1
3499 del newobj.thisown
e811c8ce 3500 def GetX(*args, **kwargs):
a95a7133 3501 """GetX(self) -> int"""
54f9ee45 3502 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3503
3504 def GetY(*args, **kwargs):
a95a7133 3505 """GetY(self) -> int"""
54f9ee45 3506 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3507
3508 def SetCursor(*args, **kwargs):
a95a7133 3509 """SetCursor(self, Cursor cursor)"""
54f9ee45 3510 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3511
3512 def GetCursor(*args, **kwargs):
a95a7133 3513 """GetCursor(self) -> Cursor"""
54f9ee45 3514 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3515
3516 def HasCursor(*args, **kwargs):
a95a7133 3517 """HasCursor(self) -> bool"""
54f9ee45 3518 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3519
d14a1e28
RD
3520
3521class SetCursorEventPtr(SetCursorEvent):
3522 def __init__(self, this):
3523 self.this = this
3524 if not hasattr(self,"thisown"): self.thisown = 0
3525 self.__class__ = SetCursorEvent
54f9ee45 3526_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3527
3528#---------------------------------------------------------------------------
3529
3530class KeyEvent(Event):
e811c8ce
RD
3531 def __repr__(self):
3532 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3533 def __init__(self, *args, **kwargs):
a95a7133 3534 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3535 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3536 self.this = newobj.this
3537 self.thisown = 1
3538 del newobj.thisown
e811c8ce 3539 def ControlDown(*args, **kwargs):
a95a7133 3540 """ControlDown(self) -> bool"""
54f9ee45 3541 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3542
3543 def MetaDown(*args, **kwargs):
a95a7133 3544 """MetaDown(self) -> bool"""
54f9ee45 3545 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3546
3547 def AltDown(*args, **kwargs):
a95a7133 3548 """AltDown(self) -> bool"""
54f9ee45 3549 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3550
3551 def ShiftDown(*args, **kwargs):
a95a7133 3552 """ShiftDown(self) -> bool"""
54f9ee45 3553 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce
RD
3554
3555 def HasModifiers(*args, **kwargs):
a95a7133 3556 """HasModifiers(self) -> bool"""
54f9ee45 3557 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3558
3559 def GetKeyCode(*args, **kwargs):
a95a7133 3560 """GetKeyCode(self) -> int"""
54f9ee45 3561 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3562
d14a1e28 3563 KeyCode = GetKeyCode
e811c8ce 3564 def GetUniChar(*args, **kwargs):
a95a7133 3565 """GetUniChar(self) -> int"""
54f9ee45 3566 return _core_.KeyEvent_GetUniChar(*args, **kwargs)
e811c8ce
RD
3567
3568 def GetRawKeyCode(*args, **kwargs):
a95a7133 3569 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3570 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3571
3572 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3573 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3574 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3575
3576 def GetPosition(*args, **kwargs):
0df68c9f 3577 """
a95a7133 3578 GetPosition(self) -> Point
e811c8ce 3579
0df68c9f
RD
3580 Find the position of the event.
3581 """
54f9ee45 3582 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3583
3584 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3585 """
3586 GetPositionTuple() -> (x,y)
e811c8ce 3587
0df68c9f
RD
3588 Find the position of the event.
3589 """
54f9ee45 3590 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3591
3592 def GetX(*args, **kwargs):
a95a7133 3593 """GetX(self) -> int"""
54f9ee45 3594 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
3595
3596 def GetY(*args, **kwargs):
a95a7133 3597 """GetY(self) -> int"""
54f9ee45
RD
3598 return _core_.KeyEvent_GetY(*args, **kwargs)
3599
3600 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3601 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3602 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3603 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3604 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3605 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3606 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3607 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3608 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3609 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
3610
3611class KeyEventPtr(KeyEvent):
3612 def __init__(self, this):
3613 self.this = this
3614 if not hasattr(self,"thisown"): self.thisown = 0
3615 self.__class__ = KeyEvent
54f9ee45 3616_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
3617
3618#---------------------------------------------------------------------------
3619
3620class SizeEvent(Event):
e811c8ce
RD
3621 def __repr__(self):
3622 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3623 def __init__(self, *args, **kwargs):
a95a7133 3624 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 3625 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
3626 self.this = newobj.this
3627 self.thisown = 1
3628 del newobj.thisown
e811c8ce 3629 def GetSize(*args, **kwargs):
a95a7133 3630 """GetSize(self) -> Size"""
54f9ee45 3631 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
3632
3633 def GetRect(*args, **kwargs):
a95a7133 3634 """GetRect(self) -> Rect"""
54f9ee45 3635 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3636
3637 def SetRect(*args, **kwargs):
a95a7133 3638 """SetRect(self, Rect rect)"""
54f9ee45 3639 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3640
3641 def SetSize(*args, **kwargs):
a95a7133 3642 """SetSize(self, Size size)"""
54f9ee45 3643 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 3644
54f9ee45
RD
3645 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3646 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
3647
3648class SizeEventPtr(SizeEvent):
3649 def __init__(self, this):
3650 self.this = this
3651 if not hasattr(self,"thisown"): self.thisown = 0
3652 self.__class__ = SizeEvent
54f9ee45 3653_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
3654
3655#---------------------------------------------------------------------------
3656
3657class MoveEvent(Event):
e811c8ce
RD
3658 def __repr__(self):
3659 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3660 def __init__(self, *args, **kwargs):
a95a7133 3661 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 3662 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
3663 self.this = newobj.this
3664 self.thisown = 1
3665 del newobj.thisown
e811c8ce 3666 def GetPosition(*args, **kwargs):
a95a7133 3667 """GetPosition(self) -> Point"""
54f9ee45 3668 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3669
3670 def GetRect(*args, **kwargs):
a95a7133 3671 """GetRect(self) -> Rect"""
54f9ee45 3672 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3673
3674 def SetRect(*args, **kwargs):
a95a7133 3675 """SetRect(self, Rect rect)"""
54f9ee45 3676 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3677
3678 def SetPosition(*args, **kwargs):
a95a7133 3679 """SetPosition(self, Point pos)"""
54f9ee45 3680 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 3681
54f9ee45
RD
3682 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3683 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
d14a1e28
RD
3684
3685class MoveEventPtr(MoveEvent):
3686 def __init__(self, this):
3687 self.this = this
3688 if not hasattr(self,"thisown"): self.thisown = 0
3689 self.__class__ = MoveEvent
54f9ee45 3690_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
3691
3692#---------------------------------------------------------------------------
3693
3694class PaintEvent(Event):
e811c8ce
RD
3695 def __repr__(self):
3696 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3697 def __init__(self, *args, **kwargs):
a95a7133 3698 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 3699 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
3700 self.this = newobj.this
3701 self.thisown = 1
3702 del newobj.thisown
d14a1e28
RD
3703
3704class PaintEventPtr(PaintEvent):
3705 def __init__(self, this):
3706 self.this = this
3707 if not hasattr(self,"thisown"): self.thisown = 0
3708 self.__class__ = PaintEvent
54f9ee45 3709_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
3710
3711class NcPaintEvent(Event):
e811c8ce
RD
3712 def __repr__(self):
3713 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3714 def __init__(self, *args, **kwargs):
a95a7133 3715 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 3716 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
3717 self.this = newobj.this
3718 self.thisown = 1
3719 del newobj.thisown
d14a1e28
RD
3720
3721class NcPaintEventPtr(NcPaintEvent):
3722 def __init__(self, this):
3723 self.this = this
3724 if not hasattr(self,"thisown"): self.thisown = 0
3725 self.__class__ = NcPaintEvent
54f9ee45 3726_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
3727
3728#---------------------------------------------------------------------------
3729
3730class EraseEvent(Event):
e811c8ce
RD
3731 def __repr__(self):
3732 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3733 def __init__(self, *args, **kwargs):
a95a7133 3734 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 3735 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
3736 self.this = newobj.this
3737 self.thisown = 1
3738 del newobj.thisown
e811c8ce 3739 def GetDC(*args, **kwargs):
a95a7133 3740 """GetDC(self) -> DC"""
54f9ee45 3741 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 3742
d14a1e28
RD
3743
3744class EraseEventPtr(EraseEvent):
3745 def __init__(self, this):
3746 self.this = this
3747 if not hasattr(self,"thisown"): self.thisown = 0
3748 self.__class__ = EraseEvent
54f9ee45 3749_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
3750
3751#---------------------------------------------------------------------------
3752
3753class FocusEvent(Event):
e811c8ce
RD
3754 def __repr__(self):
3755 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3756 def __init__(self, *args, **kwargs):
a95a7133 3757 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 3758 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
3759 self.this = newobj.this
3760 self.thisown = 1
3761 del newobj.thisown
e811c8ce 3762 def GetWindow(*args, **kwargs):
a95a7133 3763 """GetWindow(self) -> Window"""
54f9ee45 3764 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
3765
3766 def SetWindow(*args, **kwargs):
a95a7133 3767 """SetWindow(self, Window win)"""
54f9ee45 3768 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 3769
d14a1e28
RD
3770
3771class FocusEventPtr(FocusEvent):
3772 def __init__(self, this):
3773 self.this = this
3774 if not hasattr(self,"thisown"): self.thisown = 0
3775 self.__class__ = FocusEvent
54f9ee45 3776_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
3777
3778#---------------------------------------------------------------------------
3779
3780class ChildFocusEvent(CommandEvent):
e811c8ce
RD
3781 def __repr__(self):
3782 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3783 def __init__(self, *args, **kwargs):
a95a7133 3784 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 3785 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
3786 self.this = newobj.this
3787 self.thisown = 1
3788 del newobj.thisown
e811c8ce 3789 def GetWindow(*args, **kwargs):
a95a7133 3790 """GetWindow(self) -> Window"""
54f9ee45 3791 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 3792
d14a1e28
RD
3793
3794class ChildFocusEventPtr(ChildFocusEvent):
3795 def __init__(self, this):
3796 self.this = this
3797 if not hasattr(self,"thisown"): self.thisown = 0
3798 self.__class__ = ChildFocusEvent
54f9ee45 3799_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
3800
3801#---------------------------------------------------------------------------
3802
3803class ActivateEvent(Event):
e811c8ce
RD
3804 def __repr__(self):
3805 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3806 def __init__(self, *args, **kwargs):
a95a7133 3807 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 3808 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
3809 self.this = newobj.this
3810 self.thisown = 1
3811 del newobj.thisown
e811c8ce 3812 def GetActive(*args, **kwargs):
a95a7133 3813 """GetActive(self) -> bool"""
54f9ee45 3814 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 3815
d14a1e28
RD
3816
3817class ActivateEventPtr(ActivateEvent):
3818 def __init__(self, this):
3819 self.this = this
3820 if not hasattr(self,"thisown"): self.thisown = 0
3821 self.__class__ = ActivateEvent
54f9ee45 3822_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
3823
3824#---------------------------------------------------------------------------
3825
3826class InitDialogEvent(Event):
e811c8ce
RD
3827 def __repr__(self):
3828 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3829 def __init__(self, *args, **kwargs):
a95a7133 3830 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 3831 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
3832 self.this = newobj.this
3833 self.thisown = 1
3834 del newobj.thisown
d14a1e28
RD
3835
3836class InitDialogEventPtr(InitDialogEvent):
3837 def __init__(self, this):
3838 self.this = this
3839 if not hasattr(self,"thisown"): self.thisown = 0
3840 self.__class__ = InitDialogEvent
54f9ee45 3841_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
3842
3843#---------------------------------------------------------------------------
3844
3845class MenuEvent(Event):
e811c8ce
RD
3846 def __repr__(self):
3847 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3848 def __init__(self, *args, **kwargs):
a95a7133 3849 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 3850 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
3851 self.this = newobj.this
3852 self.thisown = 1
3853 del newobj.thisown
e811c8ce 3854 def GetMenuId(*args, **kwargs):
a95a7133 3855 """GetMenuId(self) -> int"""
54f9ee45 3856 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
3857
3858 def IsPopup(*args, **kwargs):
a95a7133 3859 """IsPopup(self) -> bool"""
54f9ee45 3860 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
3861
3862 def GetMenu(*args, **kwargs):
a95a7133 3863 """GetMenu(self) -> Menu"""
54f9ee45 3864 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 3865
d14a1e28
RD
3866
3867class MenuEventPtr(MenuEvent):
3868 def __init__(self, this):
3869 self.this = this
3870 if not hasattr(self,"thisown"): self.thisown = 0
3871 self.__class__ = MenuEvent
54f9ee45 3872_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
3873
3874#---------------------------------------------------------------------------
3875
3876class CloseEvent(Event):
e811c8ce
RD
3877 def __repr__(self):
3878 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3879 def __init__(self, *args, **kwargs):
a95a7133 3880 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 3881 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
3882 self.this = newobj.this
3883 self.thisown = 1
3884 del newobj.thisown
e811c8ce 3885 def SetLoggingOff(*args, **kwargs):
a95a7133 3886 """SetLoggingOff(self, bool logOff)"""
54f9ee45 3887 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
3888
3889 def GetLoggingOff(*args, **kwargs):
a95a7133 3890 """GetLoggingOff(self) -> bool"""
54f9ee45 3891 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
3892
3893 def Veto(*args, **kwargs):
a95a7133 3894 """Veto(self, bool veto=True)"""
54f9ee45 3895 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
3896
3897 def SetCanVeto(*args, **kwargs):
a95a7133 3898 """SetCanVeto(self, bool canVeto)"""
54f9ee45 3899 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
3900
3901 def CanVeto(*args, **kwargs):
a95a7133 3902 """CanVeto(self) -> bool"""
54f9ee45 3903 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
3904
3905 def GetVeto(*args, **kwargs):
a95a7133 3906 """GetVeto(self) -> bool"""
54f9ee45 3907 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 3908
d14a1e28
RD
3909
3910class CloseEventPtr(CloseEvent):
3911 def __init__(self, this):
3912 self.this = this
3913 if not hasattr(self,"thisown"): self.thisown = 0
3914 self.__class__ = CloseEvent
54f9ee45 3915_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
3916
3917#---------------------------------------------------------------------------
3918
3919class ShowEvent(Event):
e811c8ce
RD
3920 def __repr__(self):
3921 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3922 def __init__(self, *args, **kwargs):
a95a7133 3923 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 3924 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
3925 self.this = newobj.this
3926 self.thisown = 1
3927 del newobj.thisown
e811c8ce 3928 def SetShow(*args, **kwargs):
a95a7133 3929 """SetShow(self, bool show)"""
54f9ee45 3930 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
3931
3932 def GetShow(*args, **kwargs):
a95a7133 3933 """GetShow(self) -> bool"""
54f9ee45 3934 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 3935
d14a1e28
RD
3936
3937class ShowEventPtr(ShowEvent):
3938 def __init__(self, this):
3939 self.this = this
3940 if not hasattr(self,"thisown"): self.thisown = 0
3941 self.__class__ = ShowEvent
54f9ee45 3942_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
3943
3944#---------------------------------------------------------------------------
3945
3946class IconizeEvent(Event):
e811c8ce
RD
3947 def __repr__(self):
3948 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3949 def __init__(self, *args, **kwargs):
a95a7133 3950 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
54f9ee45 3951 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
3952 self.this = newobj.this
3953 self.thisown = 1
3954 del newobj.thisown
e811c8ce 3955 def Iconized(*args, **kwargs):
a95a7133 3956 """Iconized(self) -> bool"""
54f9ee45 3957 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 3958
d14a1e28
RD
3959
3960class IconizeEventPtr(IconizeEvent):
3961 def __init__(self, this):
3962 self.this = this
3963 if not hasattr(self,"thisown"): self.thisown = 0
3964 self.__class__ = IconizeEvent
54f9ee45 3965_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
3966
3967#---------------------------------------------------------------------------
3968
3969class MaximizeEvent(Event):
e811c8ce
RD
3970 def __repr__(self):
3971 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3972 def __init__(self, *args, **kwargs):
a95a7133 3973 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 3974 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
3975 self.this = newobj.this
3976 self.thisown = 1
3977 del newobj.thisown
d14a1e28
RD
3978
3979class MaximizeEventPtr(MaximizeEvent):
3980 def __init__(self, this):
3981 self.this = this
3982 if not hasattr(self,"thisown"): self.thisown = 0
3983 self.__class__ = MaximizeEvent
54f9ee45 3984_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
3985
3986#---------------------------------------------------------------------------
3987
3988class DropFilesEvent(Event):
d14a1e28
RD
3989 def __init__(self): raise RuntimeError, "No constructor defined"
3990 def __repr__(self):
3991 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 3992 def GetPosition(*args, **kwargs):
a95a7133 3993 """GetPosition(self) -> Point"""
54f9ee45 3994 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3995
3996 def GetNumberOfFiles(*args, **kwargs):
a95a7133 3997 """GetNumberOfFiles(self) -> int"""
54f9ee45 3998 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
3999
4000 def GetFiles(*args, **kwargs):
a95a7133 4001 """GetFiles(self) -> PyObject"""
54f9ee45 4002 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4003
d14a1e28
RD
4004
4005class DropFilesEventPtr(DropFilesEvent):
4006 def __init__(self, this):
4007 self.this = this
4008 if not hasattr(self,"thisown"): self.thisown = 0
4009 self.__class__ = DropFilesEvent
54f9ee45 4010_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4011
4012#---------------------------------------------------------------------------
4013
54f9ee45
RD
4014UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4015UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4016class UpdateUIEvent(CommandEvent):
e811c8ce
RD
4017 def __repr__(self):
4018 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4019 def __init__(self, *args, **kwargs):
a95a7133 4020 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4021 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4022 self.this = newobj.this
4023 self.thisown = 1
4024 del newobj.thisown
e811c8ce 4025 def GetChecked(*args, **kwargs):
a95a7133 4026 """GetChecked(self) -> bool"""
54f9ee45 4027 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4028
4029 def GetEnabled(*args, **kwargs):
a95a7133 4030 """GetEnabled(self) -> bool"""
54f9ee45 4031 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4032
4033 def GetText(*args, **kwargs):
a95a7133 4034 """GetText(self) -> String"""
54f9ee45 4035 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4036
4037 def GetSetText(*args, **kwargs):
a95a7133 4038 """GetSetText(self) -> bool"""
54f9ee45 4039 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4040
4041 def GetSetChecked(*args, **kwargs):
a95a7133 4042 """GetSetChecked(self) -> bool"""
54f9ee45 4043 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4044
4045 def GetSetEnabled(*args, **kwargs):
a95a7133 4046 """GetSetEnabled(self) -> bool"""
54f9ee45 4047 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4048
4049 def Check(*args, **kwargs):
a95a7133 4050 """Check(self, bool check)"""
54f9ee45 4051 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4052
4053 def Enable(*args, **kwargs):
a95a7133 4054 """Enable(self, bool enable)"""
54f9ee45 4055 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4056
4057 def SetText(*args, **kwargs):
a95a7133 4058 """SetText(self, String text)"""
54f9ee45 4059 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4060
4061 def SetUpdateInterval(*args, **kwargs):
66c033b4 4062 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4063 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4064
4065 SetUpdateInterval = staticmethod(SetUpdateInterval)
4066 def GetUpdateInterval(*args, **kwargs):
66c033b4 4067 """GetUpdateInterval() -> long"""
54f9ee45 4068 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4069
4070 GetUpdateInterval = staticmethod(GetUpdateInterval)
4071 def CanUpdate(*args, **kwargs):
66c033b4 4072 """CanUpdate(Window win) -> bool"""
54f9ee45 4073 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4074
4075 CanUpdate = staticmethod(CanUpdate)
4076 def ResetUpdateTime(*args, **kwargs):
66c033b4 4077 """ResetUpdateTime()"""
54f9ee45 4078 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4079
4080 ResetUpdateTime = staticmethod(ResetUpdateTime)
4081 def SetMode(*args, **kwargs):
66c033b4 4082 """SetMode(int mode)"""
54f9ee45 4083 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4084
4085 SetMode = staticmethod(SetMode)
4086 def GetMode(*args, **kwargs):
66c033b4 4087 """GetMode() -> int"""
54f9ee45 4088 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4089
4090 GetMode = staticmethod(GetMode)
d14a1e28
RD
4091
4092class UpdateUIEventPtr(UpdateUIEvent):
4093 def __init__(self, this):
4094 self.this = this
4095 if not hasattr(self,"thisown"): self.thisown = 0
4096 self.__class__ = UpdateUIEvent
54f9ee45 4097_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4098
e811c8ce
RD
4099def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4100 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4101 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4102
e811c8ce
RD
4103def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4104 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4105 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4106
e811c8ce
RD
4107def UpdateUIEvent_CanUpdate(*args, **kwargs):
4108 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4109 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4110
e811c8ce
RD
4111def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4112 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4113 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4114
e811c8ce 4115def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4116 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4117 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4118
e811c8ce 4119def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4120 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4121 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4122
4123#---------------------------------------------------------------------------
4124
4125class SysColourChangedEvent(Event):
e811c8ce
RD
4126 def __repr__(self):
4127 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4128 def __init__(self, *args, **kwargs):
a95a7133 4129 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4130 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4131 self.this = newobj.this
4132 self.thisown = 1
4133 del newobj.thisown
d14a1e28
RD
4134
4135class SysColourChangedEventPtr(SysColourChangedEvent):
4136 def __init__(self, this):
4137 self.this = this
4138 if not hasattr(self,"thisown"): self.thisown = 0
4139 self.__class__ = SysColourChangedEvent
54f9ee45 4140_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4141
4142#---------------------------------------------------------------------------
4143
4144class MouseCaptureChangedEvent(Event):
e811c8ce
RD
4145 def __repr__(self):
4146 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4147 def __init__(self, *args, **kwargs):
a95a7133 4148 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4149 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4150 self.this = newobj.this
4151 self.thisown = 1
4152 del newobj.thisown
e811c8ce 4153 def GetCapturedWindow(*args, **kwargs):
a95a7133 4154 """GetCapturedWindow(self) -> Window"""
54f9ee45 4155 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4156
d14a1e28
RD
4157
4158class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4159 def __init__(self, this):
4160 self.this = this
4161 if not hasattr(self,"thisown"): self.thisown = 0
4162 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4163_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4164
4165#---------------------------------------------------------------------------
4166
4167class DisplayChangedEvent(Event):
e811c8ce
RD
4168 def __repr__(self):
4169 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4170 def __init__(self, *args, **kwargs):
a95a7133 4171 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4172 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4173 self.this = newobj.this
4174 self.thisown = 1
4175 del newobj.thisown
d14a1e28
RD
4176
4177class DisplayChangedEventPtr(DisplayChangedEvent):
4178 def __init__(self, this):
4179 self.this = this
4180 if not hasattr(self,"thisown"): self.thisown = 0
4181 self.__class__ = DisplayChangedEvent
54f9ee45 4182_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4183
4184#---------------------------------------------------------------------------
4185
4186class PaletteChangedEvent(Event):
e811c8ce
RD
4187 def __repr__(self):
4188 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4189 def __init__(self, *args, **kwargs):
a95a7133 4190 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4191 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4192 self.this = newobj.this
4193 self.thisown = 1
4194 del newobj.thisown
e811c8ce 4195 def SetChangedWindow(*args, **kwargs):
a95a7133 4196 """SetChangedWindow(self, Window win)"""
54f9ee45 4197 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4198
4199 def GetChangedWindow(*args, **kwargs):
a95a7133 4200 """GetChangedWindow(self) -> Window"""
54f9ee45 4201 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4202
d14a1e28
RD
4203
4204class PaletteChangedEventPtr(PaletteChangedEvent):
4205 def __init__(self, this):
4206 self.this = this
4207 if not hasattr(self,"thisown"): self.thisown = 0
4208 self.__class__ = PaletteChangedEvent
54f9ee45 4209_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4210
4211#---------------------------------------------------------------------------
4212
4213class QueryNewPaletteEvent(Event):
e811c8ce
RD
4214 def __repr__(self):
4215 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4216 def __init__(self, *args, **kwargs):
a95a7133 4217 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4218 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4219 self.this = newobj.this
4220 self.thisown = 1
4221 del newobj.thisown
e811c8ce 4222 def SetPaletteRealized(*args, **kwargs):
a95a7133 4223 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4224 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4225
4226 def GetPaletteRealized(*args, **kwargs):
a95a7133 4227 """GetPaletteRealized(self) -> bool"""
54f9ee45 4228 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4229
d14a1e28
RD
4230
4231class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4232 def __init__(self, this):
4233 self.this = this
4234 if not hasattr(self,"thisown"): self.thisown = 0
4235 self.__class__ = QueryNewPaletteEvent
54f9ee45 4236_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4237
4238#---------------------------------------------------------------------------
4239
4240class NavigationKeyEvent(Event):
e811c8ce
RD
4241 def __repr__(self):
4242 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4243 def __init__(self, *args, **kwargs):
a95a7133 4244 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4245 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4246 self.this = newobj.this
4247 self.thisown = 1
4248 del newobj.thisown
e811c8ce 4249 def GetDirection(*args, **kwargs):
a95a7133 4250 """GetDirection(self) -> bool"""
54f9ee45 4251 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4252
4253 def SetDirection(*args, **kwargs):
a95a7133 4254 """SetDirection(self, bool bForward)"""
54f9ee45 4255 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4256
4257 def IsWindowChange(*args, **kwargs):
a95a7133 4258 """IsWindowChange(self) -> bool"""
54f9ee45 4259 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4260
4261 def SetWindowChange(*args, **kwargs):
a95a7133 4262 """SetWindowChange(self, bool bIs)"""
54f9ee45 4263 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce
RD
4264
4265 def GetCurrentFocus(*args, **kwargs):
a95a7133 4266 """GetCurrentFocus(self) -> Window"""
54f9ee45 4267 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4268
4269 def SetCurrentFocus(*args, **kwargs):
a95a7133 4270 """SetCurrentFocus(self, Window win)"""
54f9ee45 4271 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4272
d14a1e28
RD
4273
4274class NavigationKeyEventPtr(NavigationKeyEvent):
4275 def __init__(self, this):
4276 self.this = this
4277 if not hasattr(self,"thisown"): self.thisown = 0
4278 self.__class__ = NavigationKeyEvent
54f9ee45 4279_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4280
4281#---------------------------------------------------------------------------
4282
4283class WindowCreateEvent(CommandEvent):
e811c8ce
RD
4284 def __repr__(self):
4285 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4286 def __init__(self, *args, **kwargs):
a95a7133 4287 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4288 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4289 self.this = newobj.this
4290 self.thisown = 1
4291 del newobj.thisown
e811c8ce 4292 def GetWindow(*args, **kwargs):
a95a7133 4293 """GetWindow(self) -> Window"""
54f9ee45 4294 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4295
d14a1e28
RD
4296
4297class WindowCreateEventPtr(WindowCreateEvent):
4298 def __init__(self, this):
4299 self.this = this
4300 if not hasattr(self,"thisown"): self.thisown = 0
4301 self.__class__ = WindowCreateEvent
54f9ee45 4302_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4303
4304class WindowDestroyEvent(CommandEvent):
e811c8ce
RD
4305 def __repr__(self):
4306 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4307 def __init__(self, *args, **kwargs):
a95a7133 4308 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4309 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4310 self.this = newobj.this
4311 self.thisown = 1
4312 del newobj.thisown
e811c8ce 4313 def GetWindow(*args, **kwargs):
a95a7133 4314 """GetWindow(self) -> Window"""
54f9ee45 4315 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4316
d14a1e28
RD
4317
4318class WindowDestroyEventPtr(WindowDestroyEvent):
4319 def __init__(self, this):
4320 self.this = this
4321 if not hasattr(self,"thisown"): self.thisown = 0
4322 self.__class__ = WindowDestroyEvent
54f9ee45 4323_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4324
4325#---------------------------------------------------------------------------
4326
4327class ContextMenuEvent(CommandEvent):
e811c8ce
RD
4328 def __repr__(self):
4329 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4330 def __init__(self, *args, **kwargs):
a95a7133 4331 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4332 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4333 self.this = newobj.this
4334 self.thisown = 1
4335 del newobj.thisown
e811c8ce 4336 def GetPosition(*args, **kwargs):
a95a7133 4337 """GetPosition(self) -> Point"""
54f9ee45 4338 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4339
4340 def SetPosition(*args, **kwargs):
a95a7133 4341 """SetPosition(self, Point pos)"""
54f9ee45 4342 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4343
d14a1e28
RD
4344
4345class ContextMenuEventPtr(ContextMenuEvent):
4346 def __init__(self, this):
4347 self.this = this
4348 if not hasattr(self,"thisown"): self.thisown = 0
4349 self.__class__ = ContextMenuEvent
54f9ee45 4350_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4351
4352#---------------------------------------------------------------------------
4353
54f9ee45
RD
4354IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4355IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4356class IdleEvent(Event):
e811c8ce
RD
4357 def __repr__(self):
4358 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4359 def __init__(self, *args, **kwargs):
a95a7133 4360 """__init__(self) -> IdleEvent"""
54f9ee45 4361 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4362 self.this = newobj.this
4363 self.thisown = 1
4364 del newobj.thisown
e811c8ce 4365 def RequestMore(*args, **kwargs):
a95a7133 4366 """RequestMore(self, bool needMore=True)"""
54f9ee45 4367 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4368
4369 def MoreRequested(*args, **kwargs):
a95a7133 4370 """MoreRequested(self) -> bool"""
54f9ee45 4371 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4372
4373 def SetMode(*args, **kwargs):
66c033b4 4374 """SetMode(int mode)"""
54f9ee45 4375 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4376
4377 SetMode = staticmethod(SetMode)
4378 def GetMode(*args, **kwargs):
66c033b4 4379 """GetMode() -> int"""
54f9ee45 4380 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4381
4382 GetMode = staticmethod(GetMode)
4383 def CanSend(*args, **kwargs):
66c033b4 4384 """CanSend(Window win) -> bool"""
54f9ee45 4385 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4386
4387 CanSend = staticmethod(CanSend)
d14a1e28
RD
4388
4389class IdleEventPtr(IdleEvent):
4390 def __init__(self, this):
4391 self.this = this
4392 if not hasattr(self,"thisown"): self.thisown = 0
4393 self.__class__ = IdleEvent
54f9ee45 4394_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4395
e811c8ce 4396def IdleEvent_SetMode(*args, **kwargs):
196addbf 4397 """IdleEvent_SetMode(int mode)"""
54f9ee45 4398 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4399
e811c8ce 4400def IdleEvent_GetMode(*args, **kwargs):
196addbf 4401 """IdleEvent_GetMode() -> int"""
54f9ee45 4402 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4403
e811c8ce
RD
4404def IdleEvent_CanSend(*args, **kwargs):
4405 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4406 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4407
4408#---------------------------------------------------------------------------
4409
4410class PyEvent(Event):
e811c8ce
RD
4411 def __repr__(self):
4412 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4413 def __init__(self, *args, **kwargs):
a95a7133 4414 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4415 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4416 self.this = newobj.this
4417 self.thisown = 1
4418 del newobj.thisown
4419 self.SetSelf(self)
e811c8ce 4420
54f9ee45 4421 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4422 """__del__(self)"""
d14a1e28
RD
4423 try:
4424 if self.thisown: destroy(self)
4425 except: pass
e811c8ce
RD
4426
4427 def SetSelf(*args, **kwargs):
a95a7133 4428 """SetSelf(self, PyObject self)"""
54f9ee45 4429 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4430
4431 def GetSelf(*args, **kwargs):
a95a7133 4432 """GetSelf(self) -> PyObject"""
54f9ee45 4433 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4434
d14a1e28
RD
4435
4436class PyEventPtr(PyEvent):
4437 def __init__(self, this):
4438 self.this = this
4439 if not hasattr(self,"thisown"): self.thisown = 0
4440 self.__class__ = PyEvent
54f9ee45 4441_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4442
4443class PyCommandEvent(CommandEvent):
e811c8ce
RD
4444 def __repr__(self):
4445 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4446 def __init__(self, *args, **kwargs):
a95a7133 4447 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4448 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4449 self.this = newobj.this
4450 self.thisown = 1
4451 del newobj.thisown
4452 self.SetSelf(self)
e811c8ce 4453
54f9ee45 4454 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4455 """__del__(self)"""
d14a1e28
RD
4456 try:
4457 if self.thisown: destroy(self)
4458 except: pass
e811c8ce
RD
4459
4460 def SetSelf(*args, **kwargs):
a95a7133 4461 """SetSelf(self, PyObject self)"""
54f9ee45 4462 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4463
4464 def GetSelf(*args, **kwargs):
a95a7133 4465 """GetSelf(self) -> PyObject"""
54f9ee45 4466 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4467
d14a1e28
RD
4468
4469class PyCommandEventPtr(PyCommandEvent):
4470 def __init__(self, this):
4471 self.this = this
4472 if not hasattr(self,"thisown"): self.thisown = 0
4473 self.__class__ = PyCommandEvent
54f9ee45 4474_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28
RD
4475
4476#---------------------------------------------------------------------------
4477
54f9ee45
RD
4478PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4479PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4480PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4481PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4482PRINT_WINDOWS = _core_.PRINT_WINDOWS
4483PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4484class PyApp(EvtHandler):
66c033b4
RD
4485 """
4486 The ``wx.PyApp`` class is an *implementation detail*, please use the
4487 `wx.App` class (or some other derived class) instead.
4488 """
e811c8ce
RD
4489 def __repr__(self):
4490 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4491 def __init__(self, *args, **kwargs):
98e665d3 4492 """
a95a7133 4493 __init__(self) -> PyApp
98e665d3
RD
4494
4495 Create a new application object, starting the bootstrap process.
4496 """
54f9ee45 4497 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4498 self.this = newobj.this
4499 self.thisown = 1
4500 del newobj.thisown
4501 self._setCallbackInfo(self, PyApp)
4502 self._setOORInfo(self)
e811c8ce 4503
54f9ee45 4504 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 4505 """__del__(self)"""
d14a1e28
RD
4506 try:
4507 if self.thisown: destroy(self)
4508 except: pass
e811c8ce
RD
4509
4510 def _setCallbackInfo(*args, **kwargs):
a95a7133 4511 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 4512 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
4513
4514 def GetAppName(*args, **kwargs):
0df68c9f 4515 """
a95a7133 4516 GetAppName(self) -> String
6c3b4aae 4517
0df68c9f
RD
4518 Get the application name.
4519 """
54f9ee45 4520 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
4521
4522 def SetAppName(*args, **kwargs):
0df68c9f 4523 """
a95a7133 4524 SetAppName(self, String name)
6c3b4aae 4525
66c033b4
RD
4526 Set the application name. This value may be used automatically by
4527 `wx.Config` and such.
0df68c9f 4528 """
54f9ee45 4529 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
4530
4531 def GetClassName(*args, **kwargs):
0df68c9f 4532 """
a95a7133 4533 GetClassName(self) -> String
e811c8ce 4534
0df68c9f
RD
4535 Get the application's class name.
4536 """
54f9ee45 4537 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
4538
4539 def SetClassName(*args, **kwargs):
0df68c9f 4540 """
a95a7133 4541 SetClassName(self, String name)
6c3b4aae 4542
66c033b4
RD
4543 Set the application's class name. This value may be used for
4544 X-resources if applicable for the platform
0df68c9f 4545 """
54f9ee45 4546 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
4547
4548 def GetVendorName(*args, **kwargs):
0df68c9f 4549 """
a95a7133 4550 GetVendorName(self) -> String
6c3b4aae 4551
0df68c9f
RD
4552 Get the application's vendor name.
4553 """
54f9ee45 4554 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
4555
4556 def SetVendorName(*args, **kwargs):
0df68c9f 4557 """
a95a7133 4558 SetVendorName(self, String name)
6c3b4aae 4559
66c033b4
RD
4560 Set the application's vendor name. This value may be used
4561 automatically by `wx.Config` and such.
0df68c9f 4562 """
54f9ee45 4563 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
4564
4565 def GetTraits(*args, **kwargs):
0df68c9f 4566 """
a95a7133 4567 GetTraits(self) -> wxAppTraits
6c3b4aae 4568
66c033b4
RD
4569 Return (and create if necessary) the app traits object to which we
4570 delegate for everything which either should be configurable by the
4571 user (then he can change the default behaviour simply by overriding
4572 CreateTraits() and returning his own traits object) or which is
4573 GUI/console dependent as then wx.AppTraits allows us to abstract the
4574 differences behind the common facade.
4575
4576 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 4577 """
54f9ee45 4578 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
4579
4580 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 4581 """
a95a7133 4582 ProcessPendingEvents(self)
6c3b4aae 4583
66c033b4
RD
4584 Process all events in the Pending Events list -- it is necessary to
4585 call this function to process posted events. This normally happens
4586 during each event loop iteration.
0df68c9f 4587 """
54f9ee45 4588 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
4589
4590 def Yield(*args, **kwargs):
0df68c9f 4591 """
a95a7133 4592 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 4593
66c033b4
RD
4594 Process all currently pending events right now, instead of waiting
4595 until return to the event loop. It is an error to call ``Yield``
4596 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 4597
66c033b4 4598 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
4599 reentrancies (i.e. when called from an event handler it may
4600 result in calling the same event handler again), use with
4601 extreme care or, better, don't use at all!
0df68c9f 4602
66c033b4 4603 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 4604
0df68c9f 4605 """
54f9ee45 4606 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
4607
4608 def WakeUpIdle(*args, **kwargs):
0df68c9f 4609 """
a95a7133 4610 WakeUpIdle(self)
6c3b4aae 4611
66c033b4
RD
4612 Make sure that idle events are sent again.
4613 :see: `wx.WakeUpIdle`
0df68c9f 4614 """
54f9ee45 4615 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce
RD
4616
4617 def MainLoop(*args, **kwargs):
0df68c9f 4618 """
a95a7133 4619 MainLoop(self) -> int
6c3b4aae 4620
66c033b4
RD
4621 Execute the main GUI loop, the function doesn't normally return until
4622 all top level windows have been closed and destroyed.
0df68c9f 4623 """
54f9ee45 4624 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
4625
4626 def Exit(*args, **kwargs):
0df68c9f 4627 """
a95a7133 4628 Exit(self)
6c3b4aae 4629
0df68c9f 4630 Exit the main loop thus terminating the application.
66c033b4 4631 :see: `wx.Exit`
0df68c9f 4632 """
54f9ee45 4633 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
4634
4635 def ExitMainLoop(*args, **kwargs):
0df68c9f 4636 """
a95a7133 4637 ExitMainLoop(self)
6c3b4aae 4638
66c033b4
RD
4639 Exit the main GUI loop during the next iteration of the main
4640 loop, (i.e. it does not stop the program immediately!)
0df68c9f 4641 """
54f9ee45 4642 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
4643
4644 def Pending(*args, **kwargs):
0df68c9f 4645 """
a95a7133 4646 Pending(self) -> bool
6c3b4aae 4647
0df68c9f
RD
4648 Returns True if there are unprocessed events in the event queue.
4649 """
54f9ee45 4650 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
4651
4652 def Dispatch(*args, **kwargs):
0df68c9f 4653 """
a95a7133 4654 Dispatch(self) -> bool
6c3b4aae 4655
0df68c9f
RD
4656 Process the first event in the event queue (blocks until an event
4657 appears if there are none currently)
4658 """
54f9ee45 4659 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
4660
4661 def ProcessIdle(*args, **kwargs):
0df68c9f 4662 """
a95a7133 4663 ProcessIdle(self) -> bool
6c3b4aae 4664
66c033b4
RD
4665 Called from the MainLoop when the application becomes idle (there are
4666 no pending events) and sends a `wx.IdleEvent` to all interested
4667 parties. Returns True if more idle events are needed, False if not.
0df68c9f 4668 """
54f9ee45 4669 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
4670
4671 def SendIdleEvents(*args, **kwargs):
0df68c9f 4672 """
a95a7133 4673 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 4674
66c033b4
RD
4675 Send idle event to window and all subwindows. Returns True if more
4676 idle time is requested.
0df68c9f 4677 """
54f9ee45 4678 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
4679
4680 def IsActive(*args, **kwargs):
0df68c9f 4681 """
a95a7133 4682 IsActive(self) -> bool
6c3b4aae 4683
0df68c9f
RD
4684 Return True if our app has focus.
4685 """
54f9ee45 4686 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
4687
4688 def SetTopWindow(*args, **kwargs):
0df68c9f 4689 """
a95a7133 4690 SetTopWindow(self, Window win)
6c3b4aae 4691
66c033b4 4692 Set the *main* top level window
0df68c9f 4693 """
54f9ee45 4694 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
4695
4696 def GetTopWindow(*args, **kwargs):
0df68c9f 4697 """
a95a7133 4698 GetTopWindow(self) -> Window
6c3b4aae 4699
66c033b4
RD
4700 Return the *main* top level window (if it hadn't been set previously
4701 with SetTopWindow(), will return just some top level window and, if
4702 there not any, will return None)
0df68c9f 4703 """
54f9ee45 4704 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
4705
4706 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4707 """
a95a7133 4708 SetExitOnFrameDelete(self, bool flag)
0df68c9f 4709
66c033b4
RD
4710 Control the exit behaviour: by default, the program will exit the main
4711 loop (and so, usually, terminate) when the last top-level program
4712 window is deleted. Beware that if you disable this behaviour (with
4713 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4714 explicitly from somewhere.
0df68c9f 4715 """
54f9ee45 4716 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4717
4718 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4719 """
a95a7133 4720 GetExitOnFrameDelete(self) -> bool
6c3b4aae 4721
0df68c9f
RD
4722 Get the current exit behaviour setting.
4723 """
54f9ee45 4724 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4725
4726 def SetUseBestVisual(*args, **kwargs):
0df68c9f 4727 """
a95a7133 4728 SetUseBestVisual(self, bool flag)
6c3b4aae 4729
66c033b4
RD
4730 Set whether the app should try to use the best available visual on
4731 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 4732 """
54f9ee45 4733 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4734
4735 def GetUseBestVisual(*args, **kwargs):
0df68c9f 4736 """
a95a7133 4737 GetUseBestVisual(self) -> bool
6c3b4aae 4738
0df68c9f
RD
4739 Get current UseBestVisual setting.
4740 """
54f9ee45 4741 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4742
4743 def SetPrintMode(*args, **kwargs):
a95a7133 4744 """SetPrintMode(self, int mode)"""
54f9ee45 4745 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
4746
4747 def GetPrintMode(*args, **kwargs):
a95a7133 4748 """GetPrintMode(self) -> int"""
54f9ee45 4749 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 4750
e811c8ce 4751 def SetAssertMode(*args, **kwargs):
0df68c9f 4752 """
a95a7133 4753 SetAssertMode(self, int mode)
6c3b4aae 4754
41e2b43e 4755 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 4756 """
54f9ee45 4757 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 4758
6c3b4aae 4759 def GetAssertMode(*args, **kwargs):
0df68c9f 4760 """
a95a7133 4761 GetAssertMode(self) -> int
6c3b4aae 4762
0df68c9f
RD
4763 Get the current OnAssert behaviour setting.
4764 """
54f9ee45 4765 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 4766
e811c8ce 4767 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4768 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4769 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4770
4771 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4772 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4773 """GetMacAboutMenuItemId() -> long"""
54f9ee45 4774 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4775
4776 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4777 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4778 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4779 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4780
4781 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4782 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 4783 """GetMacExitMenuItemId() -> long"""
54f9ee45 4784 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4785
4786 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4787 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4788 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 4789 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4790
4791 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4792 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4793 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4794 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4795
4796 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4797 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4798 """SetMacAboutMenuItemId(long val)"""
54f9ee45 4799 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4800
4801 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4802 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4803 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4804 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4805
4806 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4807 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 4808 """SetMacExitMenuItemId(long val)"""
54f9ee45 4809 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4810
4811 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4812 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4813 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 4814 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4815
4816 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4817 def _BootstrapApp(*args, **kwargs):
0df68c9f 4818 """
a95a7133 4819 _BootstrapApp(self)
6c3b4aae 4820
0df68c9f
RD
4821 For internal use only
4822 """
54f9ee45 4823 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
4824
4825 def GetComCtl32Version(*args, **kwargs):
0df68c9f 4826 """
66c033b4 4827 GetComCtl32Version() -> int
6c3b4aae 4828
66c033b4
RD
4829 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4830 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4831 """
54f9ee45 4832 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
4833
4834 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
4835
4836class PyAppPtr(PyApp):
4837 def __init__(self, this):
4838 self.this = this
4839 if not hasattr(self,"thisown"): self.thisown = 0
4840 self.__class__ = PyApp
54f9ee45 4841_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 4842
e811c8ce
RD
4843def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4844 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4845 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4846
e811c8ce
RD
4847def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4848 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 4849 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4850
e811c8ce
RD
4851def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4852 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4853 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4854
e811c8ce
RD
4855def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4856 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 4857 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4858
e811c8ce 4859def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4860 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 4861 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4862
e811c8ce
RD
4863def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4864 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4865 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4866
e811c8ce
RD
4867def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
4868 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 4869 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4870
e811c8ce
RD
4871def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
4872 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4873 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4874
e811c8ce
RD
4875def PyApp_SetMacExitMenuItemId(*args, **kwargs):
4876 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 4877 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4878
e811c8ce 4879def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4880 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 4881 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4882
e811c8ce 4883def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
4884 """
4885 PyApp_GetComCtl32Version() -> int
6c3b4aae 4886
66c033b4
RD
4887 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4888 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4889 """
54f9ee45 4890 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
4891
4892#---------------------------------------------------------------------------
4893
4894
e811c8ce 4895def Exit(*args, **kwargs):
0df68c9f
RD
4896 """
4897 Exit()
6c3b4aae 4898
0df68c9f
RD
4899 Force an exit of the application. Convenience for wx.GetApp().Exit()
4900 """
54f9ee45 4901 return _core_.Exit(*args, **kwargs)
d14a1e28 4902
e811c8ce 4903def Yield(*args, **kwargs):
0df68c9f
RD
4904 """
4905 Yield() -> bool
6c3b4aae 4906
0df68c9f
RD
4907 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
4908 """
54f9ee45 4909 return _core_.Yield(*args, **kwargs)
d14a1e28 4910
e811c8ce 4911def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
4912 """
4913 YieldIfNeeded() -> bool
6c3b4aae 4914
0df68c9f
RD
4915 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
4916 """
54f9ee45 4917 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 4918
e811c8ce 4919def SafeYield(*args, **kwargs):
0df68c9f
RD
4920 """
4921 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 4922
66c033b4
RD
4923 This function is similar to `wx.Yield`, except that it disables the
4924 user input to all program windows before calling `wx.Yield` and
4925 re-enables it again afterwards. If ``win`` is not None, this window
4926 will remain enabled, allowing the implementation of some limited user
4927 interaction.
6c3b4aae 4928
66c033b4 4929 :Returns: the result of the call to `wx.Yield`.
0df68c9f 4930 """
54f9ee45 4931 return _core_.SafeYield(*args, **kwargs)
d14a1e28 4932
e811c8ce 4933def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
4934 """
4935 WakeUpIdle()
6c3b4aae 4936
66c033b4
RD
4937 Cause the message queue to become empty again, so idle events will be
4938 sent.
0df68c9f 4939 """
54f9ee45 4940 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 4941
e811c8ce 4942def PostEvent(*args, **kwargs):
0df68c9f
RD
4943 """
4944 PostEvent(EvtHandler dest, Event event)
6c3b4aae 4945
66c033b4
RD
4946 Send an event to a window or other wx.EvtHandler to be processed
4947 later.
0df68c9f 4948 """
54f9ee45 4949 return _core_.PostEvent(*args, **kwargs)
d14a1e28 4950
e811c8ce 4951def App_CleanUp(*args, **kwargs):
0df68c9f
RD
4952 """
4953 App_CleanUp()
6c3b4aae 4954
41e2b43e 4955 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 4956 Python shuts down.
0df68c9f 4957 """
54f9ee45 4958 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 4959
e811c8ce 4960def GetApp(*args, **kwargs):
0df68c9f
RD
4961 """
4962 GetApp() -> PyApp
6c3b4aae 4963
196addbf 4964 Return a reference to the current wx.App object.
0df68c9f 4965 """
54f9ee45 4966 return _core_.GetApp(*args, **kwargs)
d14a1e28
RD
4967#----------------------------------------------------------------------
4968
4969class PyOnDemandOutputWindow:
6c3b4aae
RD
4970 """
4971 A class that can be used for redirecting Python's stdout and
4972 stderr streams. It will do nothing until something is wrriten to
4973 the stream at which point it will create a Frame with a text area
4974 and write the text there.
4975 """
d14a1e28
RD
4976 def __init__(self, title = "wxPython: stdout/stderr"):
4977 self.frame = None
4978 self.title = title
4979 self.parent = None
4980
4981 def SetParent(self, parent):
6c3b4aae 4982 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
4983 self.parent = parent
4984
6c3b4aae
RD
4985
4986 def CreateOutputWindow(self, st):
4987 self.frame = wx.Frame(self.parent, -1, self.title,
4988 style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE)
196addbf
RD
4989 self.text = wx.TextCtrl(self.frame, -1, "",
4990 style = wx.TE_MULTILINE | wx.TE_READONLY)
d1e20054 4991 self.text.AppendText(st)
6c3b4aae
RD
4992 self.frame.SetSize((450, 300))
4993 self.frame.Show(True)
4994 EVT_CLOSE(self.frame, self.OnCloseWindow)
4995
d14a1e28 4996
7409c0c6
RD
4997 def OnCloseWindow(self, event):
4998 if self.frame is not None:
4999 self.frame.Destroy()
5000 self.frame = None
5001 self.text = None
5002
5003
d14a1e28 5004 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5005 def write(self, text):
5006 """
5007 Create the output window if needed and write the string to it.
5008 If not called in the context of the gui thread then uses
5009 CallAfter to do the work there.
5010 """
5011 if self.frame is None:
5012 if not wx.Thread_IsMain():
5013 wx.CallAfter(self.CreateOutputWindow, text)
5014 else:
5015 self.CreateOutputWindow(text)
5016 else:
5017 if not wx.Thread_IsMain():
5018 wx.CallAfter(self.text.AppendText, text)
5019 else:
5020 self.text.AppendText(text)
5021
d14a1e28
RD
5022
5023 def close(self):
6c3b4aae
RD
5024 if self.frame is not None:
5025 wx.CallAfter(self.frame.Close)
5026
d14a1e28
RD
5027
5028
5029#----------------------------------------------------------------------
d14a1e28
RD
5030
5031_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5032
5033class App(wx.PyApp):
6c3b4aae 5034 """
66c033b4
RD
5035 The ``wx.App`` class represents the application and is used to:
5036
5037 * bootstrap the wxPython system and initialize the underlying
5038 gui toolkit
5039 * set and get application-wide properties
5040 * implement the windowing system main message or event loop,
5041 and to dispatch events to window instances
5042 * etc.
5043
5044 Every application must have a ``wx.App`` instance, and all
5045 creation of UI objects should be delayed until after the
03e37cd5
RD
5046 ``wx.App`` object has been created in order to ensure that the gui
5047 platform and wxWidgets have been fully initialized.
66c033b4
RD
5048
5049 Normally you would derive from this class and implement an
5050 ``OnInit`` method that creates a frame and then calls
5051 ``self.SetTopWindow(frame)``.
5052
03e37cd5 5053 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5054 directly.
6c3b4aae 5055 """
66c033b4 5056
d14a1e28
RD
5057 outputWindowClass = PyOnDemandOutputWindow
5058
03e37cd5
RD
5059 def __init__(self, redirect=_defRedirect, filename=None,
5060 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5061 """
5062 Construct a ``wx.App`` object.
5063
03e37cd5
RD
5064 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5065 redirected? Defaults to True on Windows and Mac, False
5066 otherwise. If `filename` is None then output will be
5067 redirected to a window that pops up as needed. (You can
5068 control what kind of window is created for the output by
5069 resetting the class variable ``outputWindowClass`` to a
5070 class of your choosing.)
66c033b4 5071
03e37cd5
RD
5072 :param filename: The name of a file to redirect output to, if
5073 redirect is True.
66c033b4
RD
5074
5075 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5076 available visual provided by the system (only relevant on
5077 systems that have more than one visual.) This parameter
5078 must be used instead of calling `SetUseBestVisual` later
5079 on because it must be set before the underlying GUI
5080 toolkit is initialized.
5081
5082 :param clearSigInt: Should SIGINT be cleared? This allows the
5083 app to terminate upon a Ctrl-C in the console like other
5084 GUI apps will.
66c033b4
RD
5085
5086 :note: You should override OnInit to do applicaition
5087 initialization to ensure that the system, toolkit and
5088 wxWidgets are fully initialized.
5089 """
d14a1e28
RD
5090 wx.PyApp.__init__(self)
5091
5092 if wx.Platform == "__WXMAC__":
5093 try:
5094 import MacOS
5095 if not MacOS.WMAvailable():
5096 print """\
5097This program needs access to the screen. Please run with 'pythonw',
5098not 'python', and only when you are logged in on the main display of
5099your Mac."""
5100 _sys.exit(1)
36cadbf7
RD
5101 except SystemExit:
5102 raise
d14a1e28
RD
5103 except:
5104 pass
5105
5106 # This has to be done before OnInit
5107 self.SetUseBestVisual(useBestVisual)
5108
5109 # Set the default handler for SIGINT. This fixes a problem
5110 # where if Ctrl-C is pressed in the console that started this
5111 # app then it will not appear to do anything, (not even send
5112 # KeyboardInterrupt???) but will later segfault on exit. By
5113 # setting the default handler then the app will exit, as
5114 # expected (depending on platform.)
03e37cd5
RD
5115 if clearSigInt:
5116 try:
5117 import signal
5118 signal.signal(signal.SIGINT, signal.SIG_DFL)
5119 except:
5120 pass
d14a1e28
RD
5121
5122 # Save and redirect the stdio to a window?
5123 self.stdioWin = None
5124 self.saveStdio = (_sys.stdout, _sys.stderr)
5125 if redirect:
5126 self.RedirectStdio(filename)
5127
5128 # This finishes the initialization of wxWindows and then calls
5129 # the OnInit that should be present in the derived class
5130 self._BootstrapApp()
5131
5132
5133 def __del__(self):
5134 try:
5135 self.RestoreStdio() # Just in case the MainLoop was overridden
5136 except:
5137 pass
5138
5139
5140 def SetTopWindow(self, frame):
1e0c8722 5141 """Set the \"main\" top level window"""
d14a1e28
RD
5142 if self.stdioWin:
5143 self.stdioWin.SetParent(frame)
5144 wx.PyApp.SetTopWindow(self, frame)
5145
5146
5147 def MainLoop(self):
1e0c8722 5148 """Execute the main GUI event loop"""
d14a1e28
RD
5149 wx.PyApp.MainLoop(self)
5150 self.RestoreStdio()
5151
5152
7409c0c6 5153 def RedirectStdio(self, filename=None):
1e0c8722 5154 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5155 if filename:
5156 _sys.stdout = _sys.stderr = open(filename, 'a')
5157 else:
5158 self.stdioWin = self.outputWindowClass()
5159 _sys.stdout = _sys.stderr = self.stdioWin
5160
5161
5162 def RestoreStdio(self):
5163 _sys.stdout, _sys.stderr = self.saveStdio
5164
5165
5166
66c033b4 5167# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5168App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5169App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5170App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5171App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5172App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5173App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5174App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5175App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5176App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5177App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5178App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5179
5180#----------------------------------------------------------------------------
5181
5182class PySimpleApp(wx.App):
6c3b4aae
RD
5183 """
5184 A simple application class. You can just create one of these and
5185 then then make your top level windows later, and not have to worry
66c033b4
RD
5186 about OnInit. For example::
5187
5188 app = wx.PySimpleApp()
5189 frame = wx.Frame(None, title='Hello World')
5190 frame.Show()
5191 app.MainLoop()
5192
5193 :see: `wx.App`
5194 """
6c3b4aae 5195
03e37cd5
RD
5196 def __init__(self, redirect=False, filename=None,
5197 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5198 """
5199 :see: `wx.App.__init__`
5200 """
03e37cd5 5201 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5202
d14a1e28 5203 def OnInit(self):
d14a1e28
RD
5204 return True
5205
5206
66c033b4 5207
6c3b4aae 5208# Is anybody using this one?
d14a1e28
RD
5209class PyWidgetTester(wx.App):
5210 def __init__(self, size = (250, 100)):
5211 self.size = size
5212 wx.App.__init__(self, 0)
5213
5214 def OnInit(self):
196addbf 5215 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5216 self.SetTopWindow(self.frame)
5217 return True
5218
66c033b4
RD
5219 def SetWidget(self, widgetClass, *args, **kwargs):
5220 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5221 self.frame.Show(True)
5222
5223#----------------------------------------------------------------------------
5224# DO NOT hold any other references to this object. This is how we
66c033b4 5225# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5226# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5227# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5228
5229class __wxPyCleanup:
5230 def __init__(self):
54f9ee45 5231 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5232 def __del__(self):
5233 self.cleanup()
5234
5235_sys.__wxPythonCleanup = __wxPyCleanup()
5236
5237## # another possible solution, but it gets called too early...
66c033b4
RD
5238## import atexit
5239## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5240
5241
5242#----------------------------------------------------------------------------
5243
5244#---------------------------------------------------------------------------
5245
1e0c8722 5246class AcceleratorEntry(object):
66c033b4
RD
5247 """
5248 A class used to define items in an `wx.AcceleratorTable`. wxPython
5249 programs can choose to use wx.AcceleratorEntry objects, but using a
5250 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5251 as well. See `__init__` for of the tuple values.
66c033b4
RD
5252
5253 :see: `wx.AcceleratorTable`
5254 """
1e0c8722
RD
5255 def __repr__(self):
5256 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5257 def __init__(self, *args, **kwargs):
66c033b4
RD
5258 """
5259 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5260
5261 Construct a wx.AcceleratorEntry.
66c033b4 5262 """
54f9ee45 5263 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
1e0c8722
RD
5264 self.this = newobj.this
5265 self.thisown = 1
5266 del newobj.thisown
54f9ee45 5267 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
a95a7133 5268 """__del__(self)"""
1e0c8722
RD
5269 try:
5270 if self.thisown: destroy(self)
5271 except: pass
5272
5273 def Set(*args, **kwargs):
66c033b4
RD
5274 """
5275 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5276
66c033b4
RD
5277 (Re)set the attributes of a wx.AcceleratorEntry.
5278 :see `__init__`
5279 """
5280 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5281
5282 def GetFlags(*args, **kwargs):
66c033b4
RD
5283 """
5284 GetFlags(self) -> int
5285
5286 Get the AcceleratorEntry's flags.
5287 """
54f9ee45 5288 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5289
5290 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5291 """
5292 GetKeyCode(self) -> int
5293
5294 Get the AcceleratorEntry's keycode.
5295 """
54f9ee45 5296 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5297
5298 def GetCommand(*args, **kwargs):
66c033b4
RD
5299 """
5300 GetCommand(self) -> int
5301
5302 Get the AcceleratorEntry's command ID.
5303 """
54f9ee45 5304 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5305
5306
5307class AcceleratorEntryPtr(AcceleratorEntry):
5308 def __init__(self, this):
5309 self.this = this
5310 if not hasattr(self,"thisown"): self.thisown = 0
5311 self.__class__ = AcceleratorEntry
54f9ee45 5312_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5313
5314class AcceleratorTable(Object):
66c033b4
RD
5315 """
5316 An accelerator table allows the application to specify a table of
5317 keyboard shortcuts for menus or other commands. On Windows, menu or
5318 button commands are supported; on GTK, only menu commands are
5319 supported.
66c033b4 5320 """
1e0c8722
RD
5321 def __repr__(self):
5322 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5323 def __init__(self, *args, **kwargs):
0df68c9f
RD
5324 """
5325 __init__(entries) -> AcceleratorTable
1e0c8722 5326
66c033b4
RD
5327 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5328 items or or of 3-tuples (flags, keyCode, cmdID)
5329
5330 :see: `wx.AcceleratorEntry`
0df68c9f 5331 """
54f9ee45 5332 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5333 self.this = newobj.this
5334 self.thisown = 1
5335 del newobj.thisown
54f9ee45 5336 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5337 """__del__(self)"""
1e0c8722
RD
5338 try:
5339 if self.thisown: destroy(self)
5340 except: pass
5341
5342 def Ok(*args, **kwargs):
a95a7133 5343 """Ok(self) -> bool"""
54f9ee45 5344 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5345
5346
5347class AcceleratorTablePtr(AcceleratorTable):
5348 def __init__(self, this):
5349 self.this = this
5350 if not hasattr(self,"thisown"): self.thisown = 0
5351 self.__class__ = AcceleratorTable
54f9ee45 5352_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5353
5354
5355def GetAccelFromString(*args, **kwargs):
196addbf 5356 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5357 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5358#---------------------------------------------------------------------------
5359
74a57fcd
RD
5360class VisualAttributes(object):
5361 """struct containing all the visual attributes of a control"""
5362 def __repr__(self):
5363 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5364 def __init__(self, *args, **kwargs):
5365 """
a95a7133 5366 __init__(self) -> VisualAttributes
74a57fcd
RD
5367
5368 struct containing all the visual attributes of a control
5369 """
54f9ee45 5370 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5371 self.this = newobj.this
5372 self.thisown = 1
5373 del newobj.thisown
54f9ee45 5374 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 5375 """__del__(self)"""
74a57fcd
RD
5376 try:
5377 if self.thisown: destroy(self)
5378 except: pass
5379
54f9ee45
RD
5380 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5381 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5382 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
5383
5384class VisualAttributesPtr(VisualAttributes):
5385 def __init__(self, this):
5386 self.this = this
5387 if not hasattr(self,"thisown"): self.thisown = 0
5388 self.__class__ = VisualAttributes
54f9ee45 5389_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
5390NullAcceleratorTable = cvar.NullAcceleratorTable
5391PanelNameStr = cvar.PanelNameStr
5392
54f9ee45
RD
5393WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5394WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5395WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5396WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5397WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 5398class Window(EvtHandler):
15afbcd0
RD
5399 """
5400 wx.Window is the base class for all windows and represents any visible
5401 object on the screen. All controls, top level windows and so on are
5402 wx.Windows. Sizers and device contexts are not however, as they don't
5403 appear on screen themselves.
5404
5405 """
e811c8ce
RD
5406 def __repr__(self):
5407 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 5408 def __init__(self, *args, **kwargs):
0df68c9f 5409 """
a95a7133 5410 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5411 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
5412
5413 Construct and show a generic Window.
0df68c9f 5414 """
54f9ee45 5415 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
5416 self.this = newobj.this
5417 self.thisown = 1
5418 del newobj.thisown
5419 self._setOORInfo(self)
d14a1e28 5420
e811c8ce 5421 def Create(*args, **kwargs):
0df68c9f 5422 """
a95a7133 5423 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5424 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
5425
5426 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 5427 """
54f9ee45 5428 return _core_.Window_Create(*args, **kwargs)
d14a1e28 5429
e811c8ce 5430 def Close(*args, **kwargs):
15afbcd0 5431 """
a95a7133 5432 Close(self, bool force=False) -> bool
15afbcd0
RD
5433
5434 This function simply generates a EVT_CLOSE event whose handler usually
5435 tries to close the window. It doesn't close the window itself,
5436 however. If force is False (the default) then the window's close
5437 handler will be allowed to veto the destruction of the window.
15afbcd0 5438 """
54f9ee45 5439 return _core_.Window_Close(*args, **kwargs)
d14a1e28 5440
e811c8ce 5441 def Destroy(*args, **kwargs):
0df68c9f 5442 """
a95a7133 5443 Destroy(self) -> bool
d14a1e28 5444
15afbcd0
RD
5445 Destroys the window safely. Frames and dialogs are not destroyed
5446 immediately when this function is called -- they are added to a list
5447 of windows to be deleted on idle time, when all the window's events
5448 have been processed. This prevents problems with events being sent to
5449 non-existent windows.
5450
5451 Returns True if the window has either been successfully deleted, or it
5452 has been added to the list of windows pending real deletion.
0df68c9f 5453 """
54f9ee45 5454 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 5455
e811c8ce 5456 def DestroyChildren(*args, **kwargs):
15afbcd0 5457 """
a95a7133 5458 DestroyChildren(self) -> bool
15afbcd0 5459
41e2b43e
RD
5460 Destroys all children of a window. Called automatically by the
5461 destructor.
15afbcd0 5462 """
54f9ee45 5463 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 5464
e811c8ce 5465 def IsBeingDeleted(*args, **kwargs):
15afbcd0 5466 """
a95a7133 5467 IsBeingDeleted(self) -> bool
15afbcd0
RD
5468
5469 Is the window in the process of being deleted?
5470 """
54f9ee45 5471 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 5472
e811c8ce 5473 def SetTitle(*args, **kwargs):
15afbcd0 5474 """
a95a7133 5475 SetTitle(self, String title)
15afbcd0
RD
5476
5477 Sets the window's title. Applicable only to frames and dialogs.
5478 """
54f9ee45 5479 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 5480
e811c8ce 5481 def GetTitle(*args, **kwargs):
15afbcd0 5482 """
a95a7133 5483 GetTitle(self) -> String
15afbcd0
RD
5484
5485 Gets the window's title. Applicable only to frames and dialogs.
5486 """
54f9ee45 5487 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 5488
e811c8ce 5489 def SetLabel(*args, **kwargs):
15afbcd0 5490 """
a95a7133 5491 SetLabel(self, String label)
15afbcd0
RD
5492
5493 Set the text which the window shows in its label if applicable.
5494 """
54f9ee45 5495 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 5496
e811c8ce 5497 def GetLabel(*args, **kwargs):
15afbcd0 5498 """
a95a7133 5499 GetLabel(self) -> String
15afbcd0 5500
41e2b43e
RD
5501 Generic way of getting a label from any window, for identification
5502 purposes. The interpretation of this function differs from class to
5503 class. For frames and dialogs, the value returned is the title. For
5504 buttons or static text controls, it is the button text. This function
5505 can be useful for meta-programs such as testing tools or special-needs
5506 access programs)which need to identify windows by name.
15afbcd0 5507 """
54f9ee45 5508 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 5509
e811c8ce 5510 def SetName(*args, **kwargs):
15afbcd0 5511 """
a95a7133 5512 SetName(self, String name)
15afbcd0 5513
41e2b43e
RD
5514 Sets the window's name. The window name is used for ressource setting
5515 in X, it is not the same as the window title/label
15afbcd0 5516 """
54f9ee45 5517 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 5518
e811c8ce 5519 def GetName(*args, **kwargs):
15afbcd0 5520 """
a95a7133 5521 GetName(self) -> String
15afbcd0 5522
41e2b43e
RD
5523 Returns the windows name. This name is not guaranteed to be unique;
5524 it is up to the programmer to supply an appropriate name in the window
5525 constructor or via wx.Window.SetName.
15afbcd0 5526 """
54f9ee45 5527 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 5528
4276dc52
RD
5529 def SetWindowVariant(*args, **kwargs):
5530 """
a95a7133 5531 SetWindowVariant(self, int variant)
4276dc52 5532
41e2b43e
RD
5533 Sets the variant of the window/font size to use for this window, if
5534 the platform supports variants, for example, wxMac.
4276dc52 5535 """
54f9ee45 5536 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
5537
5538 def GetWindowVariant(*args, **kwargs):
a95a7133 5539 """GetWindowVariant(self) -> int"""
54f9ee45 5540 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 5541
e811c8ce 5542 def SetId(*args, **kwargs):
15afbcd0 5543 """
a95a7133 5544 SetId(self, int winid)
15afbcd0
RD
5545
5546 Sets the identifier of the window. Each window has an integer
5547 identifier. If the application has not provided one, an identifier
5548 will be generated. Normally, the identifier should be provided on
5549 creation and should not be modified subsequently.
5550 """
54f9ee45 5551 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 5552
e811c8ce 5553 def GetId(*args, **kwargs):
15afbcd0 5554 """
a95a7133 5555 GetId(self) -> int
15afbcd0
RD
5556
5557 Returns the identifier of the window. Each window has an integer
5558 identifier. If the application has not provided one (or the default Id
5559 -1 is used) then an unique identifier with a negative value will be
5560 generated.
5561 """
54f9ee45 5562 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 5563
e811c8ce 5564 def NewControlId(*args, **kwargs):
15afbcd0 5565 """
66c033b4 5566 NewControlId() -> int
15afbcd0
RD
5567
5568 Generate a control id for the controls which were not given one.
5569 """
54f9ee45 5570 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 5571
e811c8ce
RD
5572 NewControlId = staticmethod(NewControlId)
5573 def NextControlId(*args, **kwargs):
15afbcd0 5574 """
66c033b4 5575 NextControlId(int winid) -> int
15afbcd0
RD
5576
5577 Get the id of the control following the one with the given
41e2b43e 5578 autogenerated) id
15afbcd0 5579 """
54f9ee45 5580 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 5581
e811c8ce
RD
5582 NextControlId = staticmethod(NextControlId)
5583 def PrevControlId(*args, **kwargs):
15afbcd0 5584 """
66c033b4 5585 PrevControlId(int winid) -> int
15afbcd0
RD
5586
5587 Get the id of the control preceding the one with the given
41e2b43e 5588 autogenerated) id
15afbcd0 5589 """
54f9ee45 5590 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 5591
e811c8ce
RD
5592 PrevControlId = staticmethod(PrevControlId)
5593 def SetSize(*args, **kwargs):
15afbcd0 5594 """
a95a7133 5595 SetSize(self, Size size)
15afbcd0
RD
5596
5597 Sets the size of the window in pixels.
5598 """
54f9ee45 5599 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 5600
e811c8ce 5601 def SetDimensions(*args, **kwargs):
15afbcd0 5602 """
a95a7133 5603 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5604
5605 Sets the position and size of the window in pixels. The sizeFlags
5606 parameter indicates the interpretation of the other params if they are
5607 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5608 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5609 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5610 dimensions of -1 and less to be interpreted as real dimensions, not
5611 default values.
5612 """
54f9ee45 5613 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 5614
e811c8ce 5615 def SetRect(*args, **kwargs):
15afbcd0 5616 """
a95a7133 5617 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5618
5619 Sets the position and size of the window in pixels using a wx.Rect.
5620 """
54f9ee45 5621 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 5622
e811c8ce 5623 def SetSizeWH(*args, **kwargs):
15afbcd0 5624 """
a95a7133 5625 SetSizeWH(self, int width, int height)
15afbcd0
RD
5626
5627 Sets the size of the window in pixels.
5628 """
54f9ee45 5629 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 5630
e811c8ce 5631 def Move(*args, **kwargs):
15afbcd0 5632 """
a95a7133 5633 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5634
5635 Moves the window to the given position.
5636 """
54f9ee45 5637 return _core_.Window_Move(*args, **kwargs)
d14a1e28 5638
e811c8ce
RD
5639 SetPosition = Move
5640 def MoveXY(*args, **kwargs):
15afbcd0 5641 """
a95a7133 5642 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5643
5644 Moves the window to the given position.
5645 """
54f9ee45 5646 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce
RD
5647
5648 def Raise(*args, **kwargs):
15afbcd0 5649 """
a95a7133 5650 Raise(self)
15afbcd0
RD
5651
5652 Raises the window to the top of the window hierarchy if it is a
5653 managed window (dialog or frame).
5654 """
54f9ee45 5655 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
5656
5657 def Lower(*args, **kwargs):
15afbcd0 5658 """
a95a7133 5659 Lower(self)
15afbcd0
RD
5660
5661 Lowers the window to the bottom of the window hierarchy if it is a
5662 managed window (dialog or frame).
5663 """
54f9ee45 5664 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
5665
5666 def SetClientSize(*args, **kwargs):
15afbcd0 5667 """
a95a7133 5668 SetClientSize(self, Size size)
15afbcd0
RD
5669
5670 This sets the size of the window client area in pixels. Using this
5671 function to size a window tends to be more device-independent than
5672 wx.Window.SetSize, since the application need not worry about what
5673 dimensions the border or title bar have when trying to fit the window
5674 around panel items, for example.
5675 """
54f9ee45 5676 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
5677
5678 def SetClientSizeWH(*args, **kwargs):
15afbcd0 5679 """
a95a7133 5680 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
5681
5682 This sets the size of the window client area in pixels. Using this
5683 function to size a window tends to be more device-independent than
5684 wx.Window.SetSize, since the application need not worry about what
5685 dimensions the border or title bar have when trying to fit the window
5686 around panel items, for example.
5687 """
54f9ee45 5688 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
5689
5690 def SetClientRect(*args, **kwargs):
15afbcd0 5691 """
a95a7133 5692 SetClientRect(self, Rect rect)
15afbcd0
RD
5693
5694 This sets the size of the window client area in pixels. Using this
5695 function to size a window tends to be more device-independent than
5696 wx.Window.SetSize, since the application need not worry about what
5697 dimensions the border or title bar have when trying to fit the window
5698 around panel items, for example.
5699 """
54f9ee45 5700 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
5701
5702 def GetPosition(*args, **kwargs):
0df68c9f 5703 """
a95a7133 5704 GetPosition(self) -> Point
e811c8ce 5705
0df68c9f
RD
5706 Get the window's position.
5707 """
54f9ee45 5708 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
5709
5710 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5711 """
5712 GetPositionTuple() -> (x,y)
e811c8ce 5713
0df68c9f
RD
5714 Get the window's position.
5715 """
54f9ee45 5716 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5717
5718 def GetSize(*args, **kwargs):
0df68c9f 5719 """
a95a7133 5720 GetSize(self) -> Size
e811c8ce 5721
0df68c9f
RD
5722 Get the window size.
5723 """
54f9ee45 5724 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
5725
5726 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
5727 """
5728 GetSizeTuple() -> (width, height)
e811c8ce 5729
0df68c9f
RD
5730 Get the window size.
5731 """
54f9ee45 5732 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
5733
5734 def GetRect(*args, **kwargs):
15afbcd0 5735 """
a95a7133 5736 GetRect(self) -> Rect
15afbcd0
RD
5737
5738 Returns the size and position of the window as a wx.Rect object.
5739 """
54f9ee45 5740 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
5741
5742 def GetClientSize(*args, **kwargs):
0df68c9f 5743 """
a95a7133 5744 GetClientSize(self) -> Size
e811c8ce 5745
15afbcd0
RD
5746 This gets the size of the window's 'client area' in pixels. The client
5747 area is the area which may be drawn on by the programmer, excluding
5748 title bar, border, scrollbars, etc.
0df68c9f 5749 """
54f9ee45 5750 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
5751
5752 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
5753 """
5754 GetClientSizeTuple() -> (width, height)
e811c8ce 5755
15afbcd0
RD
5756 This gets the size of the window's 'client area' in pixels. The client
5757 area is the area which may be drawn on by the programmer, excluding
5758 title bar, border, scrollbars, etc.
0df68c9f 5759 """
54f9ee45 5760 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
5761
5762 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 5763 """
a95a7133 5764 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
5765
5766 Get the origin of the client area of the window relative to the
5767 window's top left corner (the client area may be shifted because of
5768 the borders, scrollbars, other decorations...)
5769 """
54f9ee45 5770 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
5771
5772 def GetClientRect(*args, **kwargs):
15afbcd0 5773 """
a95a7133 5774 GetClientRect(self) -> Rect
15afbcd0 5775
61863841 5776 Get the client area position and size as a `wx.Rect` object.
15afbcd0 5777 """
54f9ee45 5778 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
5779
5780 def GetBestSize(*args, **kwargs):
0df68c9f 5781 """
a95a7133 5782 GetBestSize(self) -> Size
e811c8ce 5783
248ed943 5784 This function returns the best acceptable minimal size for the
41e2b43e
RD
5785 window, if applicable. For example, for a static text control, it will
5786 be the minimal size such that the control label is not truncated. For
5787 windows containing subwindows (suzh aswx.Panel), the size returned by
5788 this function will be the same as the size the window would have had
5789 after calling Fit.
0df68c9f 5790 """
54f9ee45 5791 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
5792
5793 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
5794 """
5795 GetBestSizeTuple() -> (width, height)
e811c8ce 5796
248ed943 5797 This function returns the best acceptable minimal size for the
41e2b43e
RD
5798 window, if applicable. For example, for a static text control, it will
5799 be the minimal size such that the control label is not truncated. For
5800 windows containing subwindows (suzh aswx.Panel), the size returned by
5801 this function will be the same as the size the window would have had
5802 after calling Fit.
0df68c9f 5803 """
54f9ee45 5804 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce
RD
5805
5806 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 5807 """
a95a7133 5808 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
5809
5810 This method is similar to GetBestSize, except in one
5811 thing. GetBestSize should return the minimum untruncated size of the
5812 window, while this method will return the largest of BestSize and any
5813 user specified minimum size. ie. it is the minimum size the window
5814 should currently be drawn at, not the minimal size it can possibly
5815 tolerate.
5816 """
54f9ee45 5817 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
5818
5819 def Center(*args, **kwargs):
15afbcd0 5820 """
a95a7133 5821 Center(self, int direction=BOTH)
15afbcd0
RD
5822
5823 Centers the window. The parameter specifies the direction for
5824 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
5825 also include wx.CENTER_ON_SCREEN flag if you want to center the window
5826 on the entire screen and not on its parent window. If it is a
5827 top-level window and has no parent then it will always be centered
5828 relative to the screen.
5829 """
54f9ee45 5830 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
5831
5832 Centre = Center
5833 def CenterOnScreen(*args, **kwargs):
15afbcd0 5834 """
a95a7133 5835 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
5836
5837 Center on screen (only works for top level windows)
5838 """
54f9ee45 5839 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
5840
5841 CentreOnScreen = CenterOnScreen
5842 def CenterOnParent(*args, **kwargs):
15afbcd0 5843 """
a95a7133 5844 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
5845
5846 Center with respect to the the parent window
5847 """
54f9ee45 5848 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
5849
5850 CentreOnParent = CenterOnParent
5851 def Fit(*args, **kwargs):
15afbcd0 5852 """
a95a7133 5853 Fit(self)
15afbcd0
RD
5854
5855 Sizes the window so that it fits around its subwindows. This function
5856 won't do anything if there are no subwindows and will only really work
5857 correctly if sizers are used for the subwindows layout. Also, if the
5858 window has exactly one subwindow it is better (faster and the result
5859 is more precise as Fit adds some margin to account for fuzziness of
5860 its calculations) to call window.SetClientSize(child.GetSize())
5861 instead of calling Fit.
5862 """
54f9ee45 5863 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
5864
5865 def FitInside(*args, **kwargs):
15afbcd0 5866 """
a95a7133 5867 FitInside(self)
15afbcd0
RD
5868
5869 Similar to Fit, but sizes the interior (virtual) size of a
5870 window. Mainly useful with scrolled windows to reset scrollbars after
5871 sizing changes that do not trigger a size event, and/or scrolled
5872 windows without an interior sizer. This function similarly won't do
5873 anything if there are no subwindows.
5874 """
54f9ee45 5875 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 5876
74a57fcd 5877 def SetSizeHints(*args):
0df68c9f 5878 """
a95a7133 5879 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 5880 int incH=-1)
a95a7133 5881 SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
15afbcd0
RD
5882
5883 Allows specification of minimum and maximum window sizes, and window
5884 size increments. If a pair of values is not set (or set to -1), the
5885 default values will be used. If this function is called, the user
5886 will not be able to size the window outside the given bounds. The
5887 resizing increments are only significant under Motif or Xt.
0df68c9f 5888 """
54f9ee45 5889 return _core_.Window_SetSizeHints(*args)
e811c8ce 5890
74a57fcd 5891 def SetVirtualSizeHints(*args):
15afbcd0 5892 """
a95a7133
RD
5893 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
5894 SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
15afbcd0
RD
5895
5896 Allows specification of minimum and maximum virtual window sizes. If a
5897 pair of values is not set (or set to -1), the default values will be
5898 used. If this function is called, the user will not be able to size
5899 the virtual area of the window outside the given bounds.
5900 """
54f9ee45 5901 return _core_.Window_SetVirtualSizeHints(*args)
e811c8ce
RD
5902
5903 def GetMinWidth(*args, **kwargs):
a95a7133 5904 """GetMinWidth(self) -> int"""
54f9ee45 5905 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
5906
5907 def GetMinHeight(*args, **kwargs):
a95a7133 5908 """GetMinHeight(self) -> int"""
54f9ee45 5909 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
5910
5911 def GetMaxWidth(*args, **kwargs):
a95a7133 5912 """GetMaxWidth(self) -> int"""
54f9ee45 5913 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
5914
5915 def GetMaxHeight(*args, **kwargs):
a95a7133 5916 """GetMaxHeight(self) -> int"""
54f9ee45 5917 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce
RD
5918
5919 def GetMaxSize(*args, **kwargs):
a95a7133 5920 """GetMaxSize(self) -> Size"""
54f9ee45 5921 return _core_.Window_GetMaxSize(*args, **kwargs)
e811c8ce 5922
74a57fcd 5923 def GetMinSize(*args, **kwargs):
a95a7133 5924 """GetMinSize(self) -> Size"""
54f9ee45 5925 return _core_.Window_GetMinSize(*args, **kwargs)
74a57fcd 5926
e811c8ce 5927 def SetVirtualSize(*args, **kwargs):
0df68c9f 5928 """
a95a7133 5929 SetVirtualSize(self, Size size)
e811c8ce 5930
15afbcd0
RD
5931 Set the the virtual size of a window in pixels. For most windows this
5932 is just the client area of the window, but for some like scrolled
5933 windows it is more or less independent of the screen window size.
0df68c9f 5934 """
54f9ee45 5935 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
5936
5937 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 5938 """
a95a7133 5939 SetVirtualSizeWH(self, int w, int h)
e811c8ce 5940
15afbcd0
RD
5941 Set the the virtual size of a window in pixels. For most windows this
5942 is just the client area of the window, but for some like scrolled
5943 windows it is more or less independent of the screen window size.
0df68c9f 5944 """
54f9ee45 5945 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
5946
5947 def GetVirtualSize(*args, **kwargs):
0df68c9f 5948 """
a95a7133 5949 GetVirtualSize(self) -> Size
e811c8ce 5950
15afbcd0
RD
5951 Get the the virtual size of the window in pixels. For most windows
5952 this is just the client area of the window, but for some like scrolled
5953 windows it is more or less independent of the screen window size.
0df68c9f 5954 """
54f9ee45 5955 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
5956
5957 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
5958 """
5959 GetVirtualSizeTuple() -> (width, height)
e811c8ce 5960
15afbcd0
RD
5961 Get the the virtual size of the window in pixels. For most windows
5962 this is just the client area of the window, but for some like scrolled
5963 windows it is more or less independent of the screen window size.
0df68c9f 5964 """
54f9ee45 5965 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
5966
5967 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 5968 """
a95a7133 5969 GetBestVirtualSize(self) -> Size
15afbcd0
RD
5970
5971 Return the largest of ClientSize and BestSize (as determined by a
5972 sizer, interior children, or other means)
5973 """
54f9ee45 5974 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
5975
5976 def Show(*args, **kwargs):
15afbcd0 5977 """
a95a7133 5978 Show(self, bool show=True) -> bool
15afbcd0
RD
5979
5980 Shows or hides the window. You may need to call Raise for a top level
5981 window if you want to bring it to top, although this is not needed if
5982 Show is called immediately after the frame creation. Returns True if
5983 the window has been shown or hidden or False if nothing was done
5984 because it already was in the requested state.
5985 """
54f9ee45 5986 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
5987
5988 def Hide(*args, **kwargs):
15afbcd0 5989 """
a95a7133 5990 Hide(self) -> bool
15afbcd0
RD
5991
5992 Equivalent to calling Show(False).
5993 """
54f9ee45 5994 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
5995
5996 def Enable(*args, **kwargs):
15afbcd0 5997 """
a95a7133 5998 Enable(self, bool enable=True) -> bool
15afbcd0
RD
5999
6000 Enable or disable the window for user input. Note that when a parent
6001 window is disabled, all of its children are disabled as well and they
6002 are reenabled again when the parent is. Returns true if the window
6003 has been enabled or disabled, false if nothing was done, i.e. if the
6004 window had already been in the specified state.
6005 """
54f9ee45 6006 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6007
6008 def Disable(*args, **kwargs):
15afbcd0 6009 """
a95a7133 6010 Disable(self) -> bool
15afbcd0
RD
6011
6012 Disables the window, same as Enable(false).
6013 """
54f9ee45 6014 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6015
6016 def IsShown(*args, **kwargs):
15afbcd0 6017 """
a95a7133 6018 IsShown(self) -> bool
15afbcd0
RD
6019
6020 Returns true if the window is shown, false if it has been hidden.
6021 """
54f9ee45 6022 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6023
6024 def IsEnabled(*args, **kwargs):
15afbcd0 6025 """
a95a7133 6026 IsEnabled(self) -> bool
15afbcd0
RD
6027
6028 Returns true if the window is enabled for input, false otherwise.
6029 """
54f9ee45 6030 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6031
6032 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6033 """
a95a7133 6034 SetWindowStyleFlag(self, long style)
15afbcd0 6035
41e2b43e
RD
6036 Sets the style of the window. Please note that some styles cannot be
6037 changed after the window creation and that Refresh() might need to be
6038 called after changing the others for the change to take place
6039 immediately.
15afbcd0 6040 """
54f9ee45 6041 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6042
6043 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6044 """
a95a7133 6045 GetWindowStyleFlag(self) -> long
e811c8ce 6046
15afbcd0
RD
6047 Gets the window style that was passed to the constructor or Create
6048 method.
6049 """
54f9ee45 6050 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6051
15afbcd0 6052 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6053 def HasFlag(*args, **kwargs):
15afbcd0 6054 """
a95a7133 6055 HasFlag(self, int flag) -> bool
15afbcd0
RD
6056
6057 Test if the given style is set for this window.
6058 """
54f9ee45 6059 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6060
6061 def IsRetained(*args, **kwargs):
15afbcd0 6062 """
a95a7133 6063 IsRetained(self) -> bool
15afbcd0
RD
6064
6065 Returns true if the window is retained, false otherwise. Retained
6066 windows are only available on X platforms.
6067 """
54f9ee45 6068 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6069
6070 def SetExtraStyle(*args, **kwargs):
15afbcd0 6071 """
a95a7133 6072 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6073
6074 Sets the extra style bits for the window. Extra styles are the less
6075 often used style bits which can't be set with the constructor or with
6076 SetWindowStyleFlag()
6077 """
54f9ee45 6078 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6079
6080 def GetExtraStyle(*args, **kwargs):
15afbcd0 6081 """
a95a7133 6082 GetExtraStyle(self) -> long
15afbcd0
RD
6083
6084 Returns the extra style bits for the window.
6085 """
54f9ee45 6086 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6087
6088 def MakeModal(*args, **kwargs):
15afbcd0 6089 """
a95a7133 6090 MakeModal(self, bool modal=True)
15afbcd0
RD
6091
6092 Disables all other windows in the application so that the user can
6093 only interact with this window. Passing False will reverse this
6094 effect.
6095 """
54f9ee45 6096 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6097
6098 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6099 """
a95a7133 6100 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6101
6102 This function tells a window if it should use the system's "theme"
6103 code to draw the windows' background instead if its own background
6104 drawing code. This will only have an effect on platforms that support
6105 the notion of themes in user defined windows. One such platform is
6106 GTK+ where windows can have (very colourful) backgrounds defined by a
6107 user's selected theme.
6108
6109 Dialogs, notebook pages and the status bar have this flag set to true
6110 by default so that the default look and feel is simulated best.
6111 """
54f9ee45 6112 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6113
6114 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6115 """
a95a7133 6116 GetThemeEnabled(self) -> bool
e811c8ce 6117
15afbcd0
RD
6118 Return the themeEnabled flag.
6119 """
54f9ee45 6120 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6121
6122 def SetFocus(*args, **kwargs):
15afbcd0 6123 """
a95a7133 6124 SetFocus(self)
15afbcd0
RD
6125
6126 Set's the focus to this window, allowing it to receive keyboard input.
6127 """
54f9ee45 6128 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6129
6130 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6131 """
a95a7133 6132 SetFocusFromKbd(self)
15afbcd0
RD
6133
6134 Set focus to this window as the result of a keyboard action. Normally
6135 only called internally.
6136 """
54f9ee45 6137 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6138
6139 def FindFocus(*args, **kwargs):
15afbcd0 6140 """
66c033b4 6141 FindFocus() -> Window
15afbcd0
RD
6142
6143 Returns the window or control that currently has the keyboard focus,
6144 or None.
6145 """
54f9ee45 6146 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6147
6148 FindFocus = staticmethod(FindFocus)
6149 def AcceptsFocus(*args, **kwargs):
15afbcd0 6150 """
a95a7133 6151 AcceptsFocus(self) -> bool
15afbcd0
RD
6152
6153 Can this window have focus?
6154 """
54f9ee45 6155 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6156
6157 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6158 """
a95a7133 6159 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6160
6161 Can this window be given focus by keyboard navigation? if not, the
6162 only way to give it focus (provided it accepts it at all) is to click
6163 it.
6164 """
54f9ee45 6165 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6166
6167 def GetDefaultItem(*args, **kwargs):
15afbcd0 6168 """
a95a7133 6169 GetDefaultItem(self) -> Window
15afbcd0
RD
6170
6171 Get the default child of this parent, i.e. the one which is activated
6172 by pressing <Enter> such as the OK button on a wx.Dialog.
6173 """
54f9ee45 6174 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6175
6176 def SetDefaultItem(*args, **kwargs):
15afbcd0 6177 """
a95a7133 6178 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6179
6180 Set this child as default, return the old default.
6181 """
54f9ee45 6182 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6183
6184 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6185 """
a95a7133 6186 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6187
6188 Set this child as temporary default
6189 """
54f9ee45 6190 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce
RD
6191
6192 def GetChildren(*args, **kwargs):
15afbcd0 6193 """
a95a7133 6194 GetChildren(self) -> PyObject
15afbcd0
RD
6195
6196 Returns a list of the window's children. NOTE: Currently this is a
6197 copy of the child window list maintained by the window, so the return
6198 value of this function is only valid as long as the window's children
6199 do not change.
6200 """
54f9ee45 6201 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6202
6203 def GetParent(*args, **kwargs):
15afbcd0 6204 """
a95a7133 6205 GetParent(self) -> Window
15afbcd0
RD
6206
6207 Returns the parent window of this window, or None if there isn't one.
6208 """
54f9ee45 6209 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6210
6211 def GetGrandParent(*args, **kwargs):
15afbcd0 6212 """
a95a7133 6213 GetGrandParent(self) -> Window
15afbcd0 6214
41e2b43e
RD
6215 Returns the parent of the parent of this window, or None if there
6216 isn't one.
15afbcd0 6217 """
54f9ee45 6218 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6219
6220 def IsTopLevel(*args, **kwargs):
15afbcd0 6221 """
a95a7133 6222 IsTopLevel(self) -> bool
15afbcd0
RD
6223
6224 Returns true if the given window is a top-level one. Currently all
6225 frames and dialogs are always considered to be top-level windows (even
6226 if they have a parent window).
6227 """
54f9ee45 6228 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6229
6230 def Reparent(*args, **kwargs):
15afbcd0 6231 """
a95a7133 6232 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6233
6234 Reparents the window, i.e the window will be removed from its current
6235 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6236 re-inserted into another. Available on Windows and GTK. Returns True
6237 if the parent was changed, False otherwise (error or newParent ==
6238 oldParent)
6239 """
54f9ee45 6240 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6241
6242 def AddChild(*args, **kwargs):
15afbcd0 6243 """
a95a7133 6244 AddChild(self, Window child)
15afbcd0
RD
6245
6246 Adds a child window. This is called automatically by window creation
6247 functions so should not be required by the application programmer.
6248 """
54f9ee45 6249 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6250
6251 def RemoveChild(*args, **kwargs):
15afbcd0 6252 """
a95a7133 6253 RemoveChild(self, Window child)
15afbcd0
RD
6254
6255 Removes a child window. This is called automatically by window
6256 deletion functions so should not be required by the application
6257 programmer.
6258 """
54f9ee45 6259 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
6260
6261 def FindWindowById(*args, **kwargs):
15afbcd0 6262 """
a95a7133 6263 FindWindowById(self, long winid) -> Window
15afbcd0
RD
6264
6265 Find a chld of this window by window ID
6266 """
54f9ee45 6267 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
6268
6269 def FindWindowByName(*args, **kwargs):
15afbcd0 6270 """
a95a7133 6271 FindWindowByName(self, String name) -> Window
15afbcd0
RD
6272
6273 Find a child of this window by name
6274 """
54f9ee45 6275 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
6276
6277 def GetEventHandler(*args, **kwargs):
15afbcd0 6278 """
a95a7133 6279 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
6280
6281 Returns the event handler for this window. By default, the window is
6282 its own event handler.
6283 """
54f9ee45 6284 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
6285
6286 def SetEventHandler(*args, **kwargs):
15afbcd0 6287 """
a95a7133 6288 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
6289
6290 Sets the event handler for this window. An event handler is an object
6291 that is capable of processing the events sent to a window. By default,
6292 the window is its own event handler, but an application may wish to
6293 substitute another, for example to allow central implementation of
6294 event-handling for a variety of different window classes.
6295
41e2b43e 6296 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
6297 up a chain of event handlers, where an event not handled by one event
6298 handler is handed to the next one in the chain.
6299 """
54f9ee45 6300 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
6301
6302 def PushEventHandler(*args, **kwargs):
15afbcd0 6303 """
a95a7133 6304 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
6305
6306 Pushes this event handler onto the event handler stack for the window.
6307 An event handler is an object that is capable of processing the events
6308 sent to a window. By default, the window is its own event handler, but
6309 an application may wish to substitute another, for example to allow
6310 central implementation of event-handling for a variety of different
6311 window classes.
6312
6313 wx.Window.PushEventHandler allows an application to set up a chain of
6314 event handlers, where an event not handled by one event handler is
41e2b43e 6315 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
6316 remove the event handler.
6317 """
54f9ee45 6318 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
6319
6320 def PopEventHandler(*args, **kwargs):
15afbcd0 6321 """
a95a7133 6322 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
6323
6324 Removes and returns the top-most event handler on the event handler
6325 stack. If deleteHandler is True then the wx.EvtHandler object will be
6326 destroyed after it is popped.
6327 """
54f9ee45 6328 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
6329
6330 def RemoveEventHandler(*args, **kwargs):
15afbcd0 6331 """
a95a7133 6332 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 6333
41e2b43e
RD
6334 Find the given handler in the event handler chain and remove (but not
6335 delete) it from the event handler chain, return True if it was found
6336 and False otherwise (this also results in an assert failure so this
6337 function should only be called when the handler is supposed to be
6338 there.)
15afbcd0 6339 """
54f9ee45 6340 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
6341
6342 def SetValidator(*args, **kwargs):
15afbcd0 6343 """
a95a7133 6344 SetValidator(self, Validator validator)
15afbcd0
RD
6345
6346 Deletes the current validator (if any) and sets the window validator,
6347 having called wx.Validator.Clone to create a new validator of this
6348 type.
6349 """
54f9ee45 6350 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
6351
6352 def GetValidator(*args, **kwargs):
15afbcd0 6353 """
a95a7133 6354 GetValidator(self) -> Validator
15afbcd0
RD
6355
6356 Returns a pointer to the current validator for the window, or None if
6357 there is none.
6358 """
54f9ee45 6359 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 6360
74a57fcd
RD
6361 def Validate(*args, **kwargs):
6362 """
a95a7133 6363 Validate(self) -> bool
74a57fcd
RD
6364
6365 Validates the current values of the child controls using their
41e2b43e
RD
6366 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6367 style flag set, the method will also call Validate() of all child
6368 windows. Returns false if any of the validations failed.
74a57fcd 6369 """
54f9ee45 6370 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
6371
6372 def TransferDataToWindow(*args, **kwargs):
6373 """
a95a7133 6374 TransferDataToWindow(self) -> bool
74a57fcd 6375
41e2b43e
RD
6376 Transfers values to child controls from data areas specified by their
6377 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6378 style flag set, the method will also call TransferDataToWindow() of
6379 all child windows.
74a57fcd 6380 """
54f9ee45 6381 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
6382
6383 def TransferDataFromWindow(*args, **kwargs):
6384 """
a95a7133 6385 TransferDataFromWindow(self) -> bool
74a57fcd 6386
41e2b43e
RD
6387 Transfers values from child controls to data areas specified by their
6388 validators. Returns false if a transfer failed. If the window has
6389 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6390 also call TransferDataFromWindow() of all child windows.
74a57fcd 6391 """
54f9ee45 6392 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
6393
6394 def InitDialog(*args, **kwargs):
6395 """
a95a7133 6396 InitDialog(self)
74a57fcd 6397
41e2b43e
RD
6398 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6399 to the dialog via validators.
74a57fcd 6400 """
54f9ee45 6401 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 6402
e811c8ce 6403 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 6404 """
a95a7133 6405 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
6406
6407 Sets the accelerator table for this window.
6408 """
54f9ee45 6409 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6410
6411 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 6412 """
a95a7133 6413 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
6414
6415 Gets the accelerator table for this window.
6416 """
54f9ee45 6417 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6418
6419 def RegisterHotKey(*args, **kwargs):
15afbcd0 6420 """
a95a7133 6421 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
6422
6423 Registers a system wide hotkey. Every time the user presses the hotkey
6424 registered here, this window will receive a hotkey event. It will
6425 receive the event even if the application is in the background and
6426 does not have the input focus because the user is working with some
6427 other application. To bind an event handler function to this hotkey
6428 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6429 hotkey was registered successfully.
6430 """
54f9ee45 6431 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
6432
6433 def UnregisterHotKey(*args, **kwargs):
15afbcd0 6434 """
a95a7133 6435 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
6436
6437 Unregisters a system wide hotkey.
6438 """
54f9ee45 6439 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
6440
6441 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 6442 """
a95a7133 6443 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
6444
6445 Converts a point or size from dialog units to pixels. Dialog units
6446 are used for maintaining a dialog's proportions even if the font
6447 changes. For the x dimension, the dialog units are multiplied by the
6448 average character width and then divided by 4. For the y dimension,
6449 the dialog units are multiplied by the average character height and
6450 then divided by 8.
6451 """
54f9ee45 6452 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
6453
6454 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 6455 """
a95a7133 6456 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
6457
6458 Converts a point or size from dialog units to pixels. Dialog units
6459 are used for maintaining a dialog's proportions even if the font
6460 changes. For the x dimension, the dialog units are multiplied by the
6461 average character width and then divided by 4. For the y dimension,
6462 the dialog units are multiplied by the average character height and
6463 then divided by 8.
6464 """
54f9ee45 6465 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
6466
6467 def DLG_PNT(*args, **kwargs):
15afbcd0 6468 """
a95a7133 6469 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
6470
6471 Converts a point or size from dialog units to pixels. Dialog units
6472 are used for maintaining a dialog's proportions even if the font
6473 changes. For the x dimension, the dialog units are multiplied by the
6474 average character width and then divided by 4. For the y dimension,
6475 the dialog units are multiplied by the average character height and
6476 then divided by 8.
6477 """
54f9ee45 6478 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
6479
6480 def DLG_SZE(*args, **kwargs):
15afbcd0 6481 """
a95a7133 6482 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
6483
6484 Converts a point or size from dialog units to pixels. Dialog units
6485 are used for maintaining a dialog's proportions even if the font
6486 changes. For the x dimension, the dialog units are multiplied by the
6487 average character width and then divided by 4. For the y dimension,
6488 the dialog units are multiplied by the average character height and
6489 then divided by 8.
6490 """
54f9ee45 6491 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
6492
6493 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 6494 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 6495 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
6496
6497 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 6498 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 6499 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
6500
6501 def WarpPointer(*args, **kwargs):
15afbcd0 6502 """
a95a7133 6503 WarpPointer(self, int x, int y)
15afbcd0
RD
6504
6505 Moves the pointer to the given position on the window.
6506
6507 NOTE: This function is not supported under Mac because Apple Human
6508 Interface Guidelines forbid moving the mouse cursor programmatically.
6509 """
54f9ee45 6510 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
6511
6512 def CaptureMouse(*args, **kwargs):
15afbcd0 6513 """
a95a7133 6514 CaptureMouse(self)
15afbcd0
RD
6515
6516 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6517 release the capture.
6518
6519 Note that wxWindows maintains the stack of windows having captured the
6520 mouse and when the mouse is released the capture returns to the window
6521 which had had captured it previously and it is only really released if
6522 there were no previous window. In particular, this means that you must
6523 release the mouse as many times as you capture it.
6524 """
54f9ee45 6525 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
6526
6527 def ReleaseMouse(*args, **kwargs):
15afbcd0 6528 """
a95a7133 6529 ReleaseMouse(self)
15afbcd0
RD
6530
6531 Releases mouse input captured with wx.Window.CaptureMouse.
6532 """
54f9ee45 6533 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
6534
6535 def GetCapture(*args, **kwargs):
15afbcd0 6536 """
66c033b4 6537 GetCapture() -> Window
15afbcd0
RD
6538
6539 Returns the window which currently captures the mouse or None
6540 """
54f9ee45 6541 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
6542
6543 GetCapture = staticmethod(GetCapture)
6544 def HasCapture(*args, **kwargs):
15afbcd0 6545 """
a95a7133 6546 HasCapture(self) -> bool
15afbcd0
RD
6547
6548 Returns true if this window has the current mouse capture.
6549 """
54f9ee45 6550 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
6551
6552 def Refresh(*args, **kwargs):
15afbcd0 6553 """
a95a7133 6554 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
6555
6556 Mark the specified rectangle (or the whole window) as "dirty" so it
6557 will be repainted. Causes an EVT_PAINT event to be generated and sent
6558 to the window.
6559 """
54f9ee45 6560 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
6561
6562 def RefreshRect(*args, **kwargs):
15afbcd0 6563 """
a95a7133 6564 RefreshRect(self, Rect rect)
15afbcd0
RD
6565
6566 Redraws the contents of the given rectangle: the area inside it will
6567 be repainted. This is the same as Refresh but has a nicer syntax.
6568 """
54f9ee45 6569 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
6570
6571 def Update(*args, **kwargs):
15afbcd0 6572 """
a95a7133 6573 Update(self)
15afbcd0
RD
6574
6575 Calling this method immediately repaints the invalidated area of the
6576 window instead of waiting for the EVT_PAINT event to happen, (normally
6577 this would usually only happen when the flow of control returns to the
6578 event loop.) Notice that this function doesn't refresh the window and
6579 does nothing if the window has been already repainted. Use Refresh
6580 first if you want to immediately redraw the window (or some portion of
6581 it) unconditionally.
6582 """
54f9ee45 6583 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
6584
6585 def ClearBackground(*args, **kwargs):
15afbcd0 6586 """
a95a7133 6587 ClearBackground(self)
15afbcd0
RD
6588
6589 Clears the window by filling it with the current background
6590 colour. Does not cause an erase background event to be generated.
6591 """
54f9ee45 6592 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
6593
6594 def Freeze(*args, **kwargs):
15afbcd0 6595 """
a95a7133 6596 Freeze(self)
15afbcd0 6597
41e2b43e
RD
6598 Freezes the window or, in other words, prevents any updates from
6599 taking place on screen, the window is not redrawn at all. Thaw must be
6600 called to reenable window redrawing. Calls to Freeze/Thaw may be
6601 nested, with the actual Thaw being delayed until all the nesting has
6602 been undone.
15afbcd0
RD
6603
6604 This method is useful for visual appearance optimization (for example,
6605 it is a good idea to use it before inserting large amount of text into
6606 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6607 for all controls so it is mostly just a hint to wxWindows and not a
6608 mandatory directive.
6609 """
54f9ee45 6610 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
6611
6612 def Thaw(*args, **kwargs):
15afbcd0 6613 """
a95a7133 6614 Thaw(self)
15afbcd0 6615
4276dc52 6616 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
6617 Freeze/Thaw may be nested, so Thaw must be called the same number of
6618 times that Freeze was before the window will be updated.
15afbcd0 6619 """
54f9ee45 6620 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
6621
6622 def PrepareDC(*args, **kwargs):
15afbcd0 6623 """
a95a7133 6624 PrepareDC(self, DC dc)
15afbcd0
RD
6625
6626 Call this function to prepare the device context for drawing a
6627 scrolled image. It sets the device origin according to the current
6628 scroll position.
6629 """
54f9ee45 6630 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
6631
6632 def GetUpdateRegion(*args, **kwargs):
15afbcd0 6633 """
a95a7133 6634 GetUpdateRegion(self) -> Region
15afbcd0
RD
6635
6636 Returns the region specifying which parts of the window have been
6637 damaged. Should only be called within an EVT_PAINT handler.
6638 """
54f9ee45 6639 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
6640
6641 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 6642 """
a95a7133 6643 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
6644
6645 Get the update rectangle region bounding box in client coords.
6646 """
54f9ee45 6647 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
6648
6649 def IsExposed(*args, **kwargs):
15afbcd0 6650 """
a95a7133 6651 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
6652
6653 Returns true if the given point or rectangle area has been exposed
6654 since the last repaint. Call this in an paint event handler to
6655 optimize redrawing by only redrawing those areas, which have been
6656 exposed.
6657 """
54f9ee45 6658 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
6659
6660 def IsExposedPoint(*args, **kwargs):
15afbcd0 6661 """
a95a7133 6662 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
6663
6664 Returns true if the given point or rectangle area has been exposed
6665 since the last repaint. Call this in an paint event handler to
6666 optimize redrawing by only redrawing those areas, which have been
6667 exposed.
6668 """
54f9ee45 6669 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 6670
4276dc52 6671 def IsExposedRect(*args, **kwargs):
15afbcd0 6672 """
a95a7133 6673 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
6674
6675 Returns true if the given point or rectangle area has been exposed
6676 since the last repaint. Call this in an paint event handler to
6677 optimize redrawing by only redrawing those areas, which have been
6678 exposed.
6679 """
54f9ee45 6680 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 6681
74a57fcd
RD
6682 def GetDefaultAttributes(*args, **kwargs):
6683 """
a95a7133 6684 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 6685
41e2b43e
RD
6686 Get the default attributes for an instance of this class. This is
6687 useful if you want to use the same font or colour in your own control
6688 as in a standard control -- which is a much better idea than hard
6689 coding specific colours or fonts which might look completely out of
db3e571a 6690 place on the user's system, especially if it uses themes.
74a57fcd 6691 """
54f9ee45 6692 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6693
6694 def GetClassDefaultAttributes(*args, **kwargs):
6695 """
66c033b4 6696 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 6697
41e2b43e
RD
6698 Get the default attributes for this class. This is useful if you want
6699 to use the same font or colour in your own control as in a standard
6700 control -- which is a much better idea than hard coding specific
db3e571a
RD
6701 colours or fonts which might look completely out of place on the
6702 user's system, especially if it uses themes.
74a57fcd
RD
6703
6704 The variant parameter is only relevant under Mac currently and is
41e2b43e 6705 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
6706 the returned font. See `wx.Window.SetWindowVariant` for more about
6707 this.
74a57fcd 6708 """
54f9ee45 6709 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6710
6711 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 6712 def SetBackgroundColour(*args, **kwargs):
15afbcd0 6713 """
a95a7133 6714 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
6715
6716 Sets the background colour of the window. Returns True if the colour
6717 was changed. The background colour is usually painted by the default
6718 EVT_ERASE_BACKGROUND event handler function under Windows and
6719 automatically under GTK.
6720
db3e571a 6721 Note that setting the background colour may not cause an immediate
15afbcd0
RD
6722 refresh, so you may wish to call ClearBackground or Refresh after
6723 calling this function.
6724
6725 Use this function with care under GTK+ as the new appearance of the
6726 window might not look equally well when used with themes, i.e GTK+'s
6727 ability to change its look as the user wishes with run-time loadable
6728 modules.
6729 """
54f9ee45 6730 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 6731
b2df227b 6732 def SetDefaultBackgroundColour(*args, **kwargs):
a95a7133 6733 """SetDefaultBackgroundColour(self, Colour colour)"""
54f9ee45 6734 return _core_.Window_SetDefaultBackgroundColour(*args, **kwargs)
b2df227b 6735
e811c8ce 6736 def SetForegroundColour(*args, **kwargs):
15afbcd0 6737 """
a95a7133 6738 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
6739
6740 Sets the foreground colour of the window. Returns True is the colour
6741 was changed. The interpretation of foreground colour is dependent on
6742 the window class; it may be the text colour or other colour, or it may
6743 not be used at all.
6744 """
54f9ee45 6745 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 6746
b2df227b 6747 def SetDefaultForegroundColour(*args, **kwargs):
a95a7133 6748 """SetDefaultForegroundColour(self, Colour colour)"""
54f9ee45 6749 return _core_.Window_SetDefaultForegroundColour(*args, **kwargs)
b2df227b 6750
e811c8ce 6751 def GetBackgroundColour(*args, **kwargs):
15afbcd0 6752 """
a95a7133 6753 GetBackgroundColour(self) -> Colour
15afbcd0
RD
6754
6755 Returns the background colour of the window.
6756 """
54f9ee45 6757 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
6758
6759 def GetForegroundColour(*args, **kwargs):
15afbcd0 6760 """
a95a7133 6761 GetForegroundColour(self) -> Colour
15afbcd0
RD
6762
6763 Returns the foreground colour of the window. The interpretation of
6764 foreground colour is dependent on the window class; it may be the text
6765 colour or other colour, or it may not be used at all.
6766 """
54f9ee45 6767 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce
RD
6768
6769 def SetCursor(*args, **kwargs):
15afbcd0 6770 """
a95a7133 6771 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
6772
6773 Sets the window's cursor. Notice that the window cursor also sets it
6774 for the children of the window implicitly.
6775
6776 The cursor may be wx.NullCursor in which case the window cursor will
6777 be reset back to default.
6778 """
54f9ee45 6779 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
6780
6781 def GetCursor(*args, **kwargs):
15afbcd0 6782 """
a95a7133 6783 GetCursor(self) -> Cursor
15afbcd0
RD
6784
6785 Return the cursor associated with this window.
6786 """
54f9ee45 6787 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
6788
6789 def SetFont(*args, **kwargs):
15afbcd0 6790 """
a95a7133 6791 SetFont(self, Font font) -> bool
15afbcd0
RD
6792
6793 Sets the font for this window.
6794 """
54f9ee45 6795 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 6796
b2df227b 6797 def SetDefaultFont(*args, **kwargs):
a95a7133 6798 """SetDefaultFont(self, Font font)"""
54f9ee45 6799 return _core_.Window_SetDefaultFont(*args, **kwargs)
b2df227b 6800
e811c8ce 6801 def GetFont(*args, **kwargs):
15afbcd0 6802 """
a95a7133 6803 GetFont(self) -> Font
15afbcd0 6804
4276dc52 6805 Returns the default font used for this window.
15afbcd0 6806 """
54f9ee45 6807 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
6808
6809 def SetCaret(*args, **kwargs):
15afbcd0 6810 """
a95a7133 6811 SetCaret(self, Caret caret)
15afbcd0
RD
6812
6813 Sets the caret associated with the window.
6814 """
54f9ee45 6815 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
6816
6817 def GetCaret(*args, **kwargs):
15afbcd0 6818 """
a95a7133 6819 GetCaret(self) -> Caret
15afbcd0
RD
6820
6821 Returns the caret associated with the window.
6822 """
54f9ee45 6823 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
6824
6825 def GetCharHeight(*args, **kwargs):
15afbcd0 6826 """
a95a7133 6827 GetCharHeight(self) -> int
15afbcd0
RD
6828
6829 Get the (average) character size for the current font.
6830 """
54f9ee45 6831 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
6832
6833 def GetCharWidth(*args, **kwargs):
15afbcd0 6834 """
a95a7133 6835 GetCharWidth(self) -> int
15afbcd0
RD
6836
6837 Get the (average) character size for the current font.
6838 """
54f9ee45 6839 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
6840
6841 def GetTextExtent(*args, **kwargs):
41e2b43e 6842 """GetTextExtent(String string) -> (width, height)"""
54f9ee45 6843 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
6844
6845 def GetFullTextExtent(*args, **kwargs):
0df68c9f 6846 """
196addbf 6847 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 6848 (width, height, descent, externalLeading)
e811c8ce 6849
15afbcd0
RD
6850 Get the width, height, decent and leading of the text using the
6851 current or specified font.
0df68c9f 6852 """
54f9ee45 6853 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
6854
6855 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
6856 """
6857 ClientToScreenXY(int x, int y) -> (x,y)
6858
6859 Converts to screen coordinates from coordinates relative to this window.
6860 """
54f9ee45 6861 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
6862
6863 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
6864 """
6865 ScreenToClientXY(int x, int y) -> (x,y)
6866
6867 Converts from screen to client window coordinates.
6868 """
54f9ee45 6869 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
6870
6871 def ClientToScreen(*args, **kwargs):
15afbcd0 6872 """
a95a7133 6873 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
6874
6875 Converts to screen coordinates from coordinates relative to this window.
6876 """
54f9ee45 6877 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
6878
6879 def ScreenToClient(*args, **kwargs):
15afbcd0 6880 """
a95a7133 6881 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
6882
6883 Converts from screen to client window coordinates.
6884 """
54f9ee45 6885 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
6886
6887 def HitTestXY(*args, **kwargs):
15afbcd0 6888 """
a95a7133 6889 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
6890
6891 Test where the given (in client coords) point lies
6892 """
54f9ee45 6893 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
6894
6895 def HitTest(*args, **kwargs):
15afbcd0 6896 """
a95a7133 6897 HitTest(self, Point pt) -> int
15afbcd0
RD
6898
6899 Test where the given (in client coords) point lies
6900 """
54f9ee45 6901 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 6902
15afbcd0
RD
6903 def GetBorder(*args):
6904 """
a95a7133
RD
6905 GetBorder(self, long flags) -> int
6906 GetBorder(self) -> int
e811c8ce 6907
15afbcd0
RD
6908 Get border for the flags of this window
6909 """
54f9ee45 6910 return _core_.Window_GetBorder(*args)
e811c8ce
RD
6911
6912 def UpdateWindowUI(*args, **kwargs):
15afbcd0 6913 """
a95a7133 6914 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
6915
6916 This function sends EVT_UPDATE_UI events to the window. The particular
6917 implementation depends on the window; for example a wx.ToolBar will
6918 send an update UI event for each toolbar button, and a wx.Frame will
6919 send an update UI event for each menubar menu item. You can call this
6920 function from your application to ensure that your UI is up-to-date at
6921 a particular point in time (as far as your EVT_UPDATE_UI handlers are
6922 concerned). This may be necessary if you have called
6923 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
6924 limit the overhead that wxWindows incurs by sending update UI events
6925 in idle time.
15afbcd0 6926 """
54f9ee45 6927 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
6928
6929 def PopupMenuXY(*args, **kwargs):
15afbcd0 6930 """
a95a7133 6931 PopupMenuXY(self, Menu menu, int x, int y) -> bool
15afbcd0
RD
6932
6933 Pops up the given menu at the specified coordinates, relative to this
6934 window, and returns control when the user has dismissed the menu. If a
6935 menu item is selected, the corresponding menu event is generated and
6936 will be processed as usual.
6937 """
54f9ee45 6938 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 6939
15afbcd0
RD
6940 def PopupMenu(*args, **kwargs):
6941 """
a95a7133 6942 PopupMenu(self, Menu menu, Point pos) -> bool
15afbcd0
RD
6943
6944 Pops up the given menu at the specified coordinates, relative to this
6945 window, and returns control when the user has dismissed the menu. If a
6946 menu item is selected, the corresponding menu event is generated and
6947 will be processed as usual.
6948 """
54f9ee45 6949 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
6950
6951 def GetHandle(*args, **kwargs):
6952 """
a95a7133 6953 GetHandle(self) -> long
15afbcd0
RD
6954
6955 Returns the platform-specific handle (as a long integer) of the
6956 physical window. Currently on wxMac it returns the handle of the
6957 toplevel parent of the window.
6958 """
54f9ee45 6959 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0
RD
6960
6961 def HasScrollbar(*args, **kwargs):
6962 """
a95a7133 6963 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
6964
6965 Does the window have the scrollbar for this orientation?
6966 """
54f9ee45 6967 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
6968
6969 def SetScrollbar(*args, **kwargs):
6970 """
41e2b43e 6971 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
6972 bool refresh=True)
6973
6974 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 6975 """
54f9ee45 6976 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
6977
6978 def SetScrollPos(*args, **kwargs):
15afbcd0 6979 """
a95a7133 6980 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
6981
6982 Sets the position of one of the built-in scrollbars.
6983 """
54f9ee45 6984 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
6985
6986 def GetScrollPos(*args, **kwargs):
15afbcd0 6987 """
a95a7133 6988 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
6989
6990 Returns the built-in scrollbar position.
6991 """
54f9ee45 6992 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
6993
6994 def GetScrollThumb(*args, **kwargs):
15afbcd0 6995 """
a95a7133 6996 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
6997
6998 Returns the built-in scrollbar thumb size.
6999 """
54f9ee45 7000 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7001
7002 def GetScrollRange(*args, **kwargs):
15afbcd0 7003 """
a95a7133 7004 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7005
7006 Returns the built-in scrollbar range.
7007 """
54f9ee45 7008 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7009
7010 def ScrollWindow(*args, **kwargs):
15afbcd0 7011 """
a95a7133 7012 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7013
7014 Physically scrolls the pixels in the window and move child windows
7015 accordingly. Use this function to optimise your scrolling
7016 implementations, to minimise the area that must be redrawn. Note that
7017 it is rarely required to call this function from a user program.
15afbcd0 7018 """
54f9ee45 7019 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7020
7021 def ScrollLines(*args, **kwargs):
15afbcd0 7022 """
a95a7133 7023 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7024
7025 If the platform and window class supports it, scrolls the window by
7026 the given number of lines down, if lines is positive, or up if lines
7027 is negative. Returns True if the window was scrolled, False if it was
7028 already on top/bottom and nothing was done.
7029 """
54f9ee45 7030 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7031
7032 def ScrollPages(*args, **kwargs):
15afbcd0 7033 """
a95a7133 7034 ScrollPages(self, int pages) -> bool
15afbcd0 7035
41e2b43e 7036 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7037 the given number of pages down, if pages is positive, or up if pages
7038 is negative. Returns True if the window was scrolled, False if it was
7039 already on top/bottom and nothing was done.
7040 """
54f9ee45 7041 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7042
7043 def LineUp(*args, **kwargs):
15afbcd0 7044 """
a95a7133 7045 LineUp(self) -> bool
15afbcd0
RD
7046
7047 This is just a wrapper for ScrollLines(-1).
7048 """
54f9ee45 7049 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7050
7051 def LineDown(*args, **kwargs):
15afbcd0 7052 """
a95a7133 7053 LineDown(self) -> bool
15afbcd0
RD
7054
7055 This is just a wrapper for ScrollLines(1).
7056 """
54f9ee45 7057 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7058
7059 def PageUp(*args, **kwargs):
15afbcd0 7060 """
a95a7133 7061 PageUp(self) -> bool
15afbcd0
RD
7062
7063 This is just a wrapper for ScrollPages(-1).
7064 """
54f9ee45 7065 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7066
7067 def PageDown(*args, **kwargs):
15afbcd0 7068 """
a95a7133 7069 PageDown(self) -> bool
15afbcd0
RD
7070
7071 This is just a wrapper for ScrollPages(1).
7072 """
54f9ee45 7073 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7074
7075 def SetHelpText(*args, **kwargs):
15afbcd0 7076 """
a95a7133 7077 SetHelpText(self, String text)
15afbcd0
RD
7078
7079 Sets the help text to be used as context-sensitive help for this
7080 window. Note that the text is actually stored by the current
7081 wxHelpProvider implementation, and not in the window object itself.
7082 """
54f9ee45 7083 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7084
7085 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7086 """
a95a7133 7087 SetHelpTextForId(self, String text)
15afbcd0
RD
7088
7089 Associate this help text with all windows with the same id as this
7090 one.
7091 """
54f9ee45 7092 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7093
7094 def GetHelpText(*args, **kwargs):
15afbcd0 7095 """
a95a7133 7096 GetHelpText(self) -> String
15afbcd0
RD
7097
7098 Gets the help text to be used as context-sensitive help for this
7099 window. Note that the text is actually stored by the current
7100 wxHelpProvider implementation, and not in the window object itself.
7101 """
54f9ee45 7102 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7103
7104 def SetToolTipString(*args, **kwargs):
15afbcd0 7105 """
a95a7133 7106 SetToolTipString(self, String tip)
15afbcd0
RD
7107
7108 Attach a tooltip to the window.
7109 """
54f9ee45 7110 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7111
7112 def SetToolTip(*args, **kwargs):
15afbcd0 7113 """
a95a7133 7114 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7115
7116 Attach a tooltip to the window.
7117 """
54f9ee45 7118 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7119
7120 def GetToolTip(*args, **kwargs):
15afbcd0 7121 """
a95a7133 7122 GetToolTip(self) -> ToolTip
15afbcd0
RD
7123
7124 get the associated tooltip or None if none
7125 """
54f9ee45 7126 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7127
7128 def SetDropTarget(*args, **kwargs):
15afbcd0 7129 """
a95a7133 7130 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7131
7132 Associates a drop target with this window. If the window already has
7133 a drop target, it is deleted.
7134 """
54f9ee45 7135 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7136
7137 def GetDropTarget(*args, **kwargs):
15afbcd0 7138 """
a95a7133 7139 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7140
7141 Returns the associated drop target, which may be None.
7142 """
54f9ee45 7143 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7144
7145 def SetConstraints(*args, **kwargs):
15afbcd0 7146 """
a95a7133 7147 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7148
7149 Sets the window to have the given layout constraints. If an existing
7150 layout constraints object is already owned by the window, it will be
7151 deleted. Pass None to disassociate and delete the window's current
7152 constraints.
7153
7154 You must call SetAutoLayout to tell a window to use the constraints
7155 automatically in its default EVT_SIZE handler; otherwise, you must
7156 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7157 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7158 effect.
7159 """
54f9ee45 7160 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7161
7162 def GetConstraints(*args, **kwargs):
15afbcd0 7163 """
a95a7133 7164 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7165
7166 Returns a pointer to the window's layout constraints, or None if there
7167 are none.
7168 """
54f9ee45 7169 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7170
7171 def SetAutoLayout(*args, **kwargs):
15afbcd0 7172 """
a95a7133 7173 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7174
7175 Determines whether the Layout function will be called automatically
7176 when the window is resized. It is called implicitly by SetSizer but
7177 if you use SetConstraints you should call it manually or otherwise the
7178 window layout won't be correctly updated when its size changes.
7179 """
54f9ee45 7180 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
7181
7182 def GetAutoLayout(*args, **kwargs):
15afbcd0 7183 """
a95a7133 7184 GetAutoLayout(self) -> bool
15afbcd0
RD
7185
7186 Returns the current autoLayout setting
7187 """
54f9ee45 7188 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
7189
7190 def Layout(*args, **kwargs):
15afbcd0 7191 """
a95a7133 7192 Layout(self) -> bool
15afbcd0
RD
7193
7194 Invokes the constraint-based layout algorithm or the sizer-based
7195 algorithm for this window. See SetAutoLayout: when auto layout is on,
7196 this function gets called automatically by the default EVT_SIZE
7197 handler when the window is resized.
7198 """
54f9ee45 7199 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
7200
7201 def SetSizer(*args, **kwargs):
15afbcd0 7202 """
a95a7133 7203 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7204
7205 Sets the window to have the given layout sizer. The window will then
7206 own the object, and will take care of its deletion. If an existing
7207 layout sizer object is already owned by the window, it will be deleted
7208 if the deleteOld parameter is true. Note that this function will also
7209 call SetAutoLayout implicitly with a True parameter if the sizer is
7210 non-NoneL and False otherwise.
7211 """
54f9ee45 7212 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
7213
7214 def SetSizerAndFit(*args, **kwargs):
15afbcd0 7215 """
a95a7133 7216 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7217
7218 The same as SetSizer, except it also sets the size hints for the
7219 window based on the sizer's minimum size.
7220 """
54f9ee45 7221 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
7222
7223 def GetSizer(*args, **kwargs):
15afbcd0 7224 """
a95a7133 7225 GetSizer(self) -> Sizer
15afbcd0
RD
7226
7227 Return the sizer associated with the window by a previous call to
7228 SetSizer or None if there isn't one.
7229 """
54f9ee45 7230 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
7231
7232 def SetContainingSizer(*args, **kwargs):
15afbcd0 7233 """
a95a7133 7234 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
7235
7236 This normally does not need to be called by application code. It is
7237 called internally when a window is added to a sizer, and is used so
7238 the window can remove itself from the sizer when it is destroyed.
7239 """
54f9ee45 7240 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
7241
7242 def GetContainingSizer(*args, **kwargs):
15afbcd0 7243 """
a95a7133 7244 GetContainingSizer(self) -> Sizer
15afbcd0
RD
7245
7246 Return the sizer that this window is a member of, if any, otherwise None.
7247 """
54f9ee45 7248 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 7249
a95a7133
RD
7250 def InheritAttributes(*args, **kwargs):
7251 """
7252 InheritAttributes(self)
7253
41e2b43e
RD
7254 This function is (or should be, in case of custom controls) called
7255 during window creation to intelligently set up the window visual
7256 attributes, that is the font and the foreground and background
7257 colours.
7258
7259 By 'intelligently' the following is meant: by default, all windows use
7260 their own default attributes. However if some of the parent's
7261 attributes are explicitly changed (that is, using SetFont and not
7262 SetDefaultFont) and if the corresponding attribute hadn't been
7263 explicitly set for this window itself, then this window takes the same
7264 value as used by the parent. In addition, if the window overrides
7265 ShouldInheritColours to return false, the colours will not be changed
7266 no matter what and only the font might.
7267
7268 This rather complicated logic is necessary in order to accomodate the
7269 different usage scenarius. The most common one is when all default
7270 attributes are used and in this case, nothing should be inherited as
7271 in modern GUIs different controls use different fonts (and colours)
7272 than their siblings so they can't inherit the same value from the
7273 parent. However it was also deemed desirable to allow to simply change
7274 the attributes of all children at once by just changing the font or
7275 colour of their common parent, hence in this case we do inherit the
7276 parents attributes.
7277
a95a7133 7278 """
54f9ee45 7279 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
7280
7281 def ShouldInheritColours(*args, **kwargs):
7282 """
7283 ShouldInheritColours(self) -> bool
7284
7285 Return true from here to allow the colours of this window to be
41e2b43e
RD
7286 changed by InheritAttributes, returning false forbids inheriting them
7287 from the parent window.
a95a7133 7288
41e2b43e
RD
7289 The base class version returns false, but this method is overridden in
7290 wxControl where it returns true.
a95a7133 7291 """
54f9ee45 7292 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 7293
e811c8ce 7294 def PostCreate(self, pre):
15afbcd0
RD
7295 """
7296 Phase 3 of the 2-phase create <wink!>
7297 Call this method after precreating the window with the 2-phase create method.
7298 """
e811c8ce
RD
7299 self.this = pre.this
7300 self.thisown = pre.thisown
7301 pre.thisown = 0
7302 if hasattr(self, '_setOORInfo'):
7303 self._setOORInfo(self)
7304 if hasattr(self, '_setCallbackInfo'):
7305 self._setCallbackInfo(self, self.__class__)
7306
7307
7308class WindowPtr(Window):
7309 def __init__(self, this):
7310 self.this = this
7311 if not hasattr(self,"thisown"): self.thisown = 0
7312 self.__class__ = Window
54f9ee45 7313_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
7314
7315def PreWindow(*args, **kwargs):
15afbcd0
RD
7316 """
7317 PreWindow() -> Window
7318
7319 Precreate a Window for 2-phase creation.
7320 """
54f9ee45 7321 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
7322 val.thisown = 1
7323 return val
7324
7325def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
7326 """
7327 Window_NewControlId() -> int
7328
7329 Generate a control id for the controls which were not given one.
7330 """
54f9ee45 7331 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
7332
7333def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
7334 """
7335 Window_NextControlId(int winid) -> int
7336
7337 Get the id of the control following the one with the given
41e2b43e 7338 autogenerated) id
15afbcd0 7339 """
54f9ee45 7340 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
7341
7342def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
7343 """
7344 Window_PrevControlId(int winid) -> int
7345
7346 Get the id of the control preceding the one with the given
41e2b43e 7347 autogenerated) id
15afbcd0 7348 """
54f9ee45 7349 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
7350
7351def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
7352 """
7353 Window_FindFocus() -> Window
7354
7355 Returns the window or control that currently has the keyboard focus,
7356 or None.
7357 """
54f9ee45 7358 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
7359
7360def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
7361 """
7362 Window_GetCapture() -> Window
7363
7364 Returns the window which currently captures the mouse or None
7365 """
54f9ee45 7366 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 7367
74a57fcd
RD
7368def Window_GetClassDefaultAttributes(*args, **kwargs):
7369 """
7370 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7371
41e2b43e
RD
7372 Get the default attributes for this class. This is useful if you want
7373 to use the same font or colour in your own control as in a standard
7374 control -- which is a much better idea than hard coding specific
db3e571a
RD
7375 colours or fonts which might look completely out of place on the
7376 user's system, especially if it uses themes.
74a57fcd
RD
7377
7378 The variant parameter is only relevant under Mac currently and is
41e2b43e 7379 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7380 the returned font. See `wx.Window.SetWindowVariant` for more about
7381 this.
74a57fcd 7382 """
54f9ee45 7383 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 7384
e811c8ce 7385def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
7386 """
7387 Convenience function for converting a Point or (x,y) in
7388 dialog units to pixel units.
7389 """
e811c8ce
RD
7390 if y is None:
7391 return win.ConvertDialogPointToPixels(point_or_x)
7392 else:
fd3f2efe 7393 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
7394
7395def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
7396 """
7397 Convenience function for converting a Size or (w,h) in
7398 dialog units to pixel units.
7399 """
e811c8ce
RD
7400 if height is None:
7401 return win.ConvertDialogSizeToPixels(size_width)
7402 else:
fd3f2efe 7403 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
7404
7405
7406def FindWindowById(*args, **kwargs):
15afbcd0
RD
7407 """
7408 FindWindowById(long id, Window parent=None) -> Window
7409
7410 Find the first window in the application with the given id. If parent
7411 is None, the search will start from all top-level frames and dialog
7412 boxes; if non-None, the search will be limited to the given window
7413 hierarchy. The search is recursive in both cases.
7414 """
54f9ee45 7415 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
7416
7417def FindWindowByName(*args, **kwargs):
15afbcd0
RD
7418 """
7419 FindWindowByName(String name, Window parent=None) -> Window
7420
7421 Find a window by its name (as given in a window constructor or Create
7422 function call). If parent is None, the search will start from all
7423 top-level frames and dialog boxes; if non-None, the search will be
7424 limited to the given window hierarchy. The search is recursive in both
7425 cases.
7426
7427 If no window with such name is found, wx.FindWindowByLabel is called.
7428 """
54f9ee45 7429 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
7430
7431def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
7432 """
7433 FindWindowByLabel(String label, Window parent=None) -> Window
7434
7435 Find a window by its label. Depending on the type of window, the label
7436 may be a window title or panel item label. If parent is None, the
7437 search will start from all top-level frames and dialog boxes; if
7438 non-None, the search will be limited to the given window
7439 hierarchy. The search is recursive in both cases.
7440 """
54f9ee45 7441 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
7442
7443def Window_FromHWND(*args, **kwargs):
4276dc52 7444 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 7445 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
7446#---------------------------------------------------------------------------
7447
7448class Validator(EvtHandler):
e811c8ce
RD
7449 def __repr__(self):
7450 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7451 def __init__(self, *args, **kwargs):
a95a7133 7452 """__init__(self) -> Validator"""
54f9ee45 7453 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
7454 self.this = newobj.this
7455 self.thisown = 1
7456 del newobj.thisown
7457 self._setOORInfo(self)
e811c8ce
RD
7458
7459 def Clone(*args, **kwargs):
a95a7133 7460 """Clone(self) -> Validator"""
54f9ee45 7461 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
7462
7463 def Validate(*args, **kwargs):
a95a7133 7464 """Validate(self, Window parent) -> bool"""
54f9ee45 7465 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
7466
7467 def TransferToWindow(*args, **kwargs):
a95a7133 7468 """TransferToWindow(self) -> bool"""
54f9ee45 7469 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
7470
7471 def TransferFromWindow(*args, **kwargs):
a95a7133 7472 """TransferFromWindow(self) -> bool"""
54f9ee45 7473 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
7474
7475 def GetWindow(*args, **kwargs):
a95a7133 7476 """GetWindow(self) -> Window"""
54f9ee45 7477 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
7478
7479 def SetWindow(*args, **kwargs):
a95a7133 7480 """SetWindow(self, Window window)"""
54f9ee45 7481 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
7482
7483 def IsSilent(*args, **kwargs):
66c033b4 7484 """IsSilent() -> bool"""
54f9ee45 7485 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7486
7487 IsSilent = staticmethod(IsSilent)
7488 def SetBellOnError(*args, **kwargs):
66c033b4 7489 """SetBellOnError(int doIt=True)"""
54f9ee45 7490 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7491
7492 SetBellOnError = staticmethod(SetBellOnError)
7493
7494class ValidatorPtr(Validator):
7495 def __init__(self, this):
7496 self.this = this
7497 if not hasattr(self,"thisown"): self.thisown = 0
7498 self.__class__ = Validator
54f9ee45 7499_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
7500
7501def Validator_IsSilent(*args, **kwargs):
7502 """Validator_IsSilent() -> bool"""
54f9ee45 7503 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7504
7505def Validator_SetBellOnError(*args, **kwargs):
7506 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 7507 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7508
7509class PyValidator(Validator):
e811c8ce
RD
7510 def __repr__(self):
7511 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7512 def __init__(self, *args, **kwargs):
a95a7133 7513 """__init__(self) -> PyValidator"""
54f9ee45 7514 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
7515 self.this = newobj.this
7516 self.thisown = 1
7517 del newobj.thisown
7518
7519 self._setCallbackInfo(self, PyValidator, 1)
7520 self._setOORInfo(self)
7521
7522 def _setCallbackInfo(*args, **kwargs):
a95a7133 7523 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 7524 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7525
7526
7527class PyValidatorPtr(PyValidator):
7528 def __init__(self, this):
7529 self.this = this
7530 if not hasattr(self,"thisown"): self.thisown = 0
7531 self.__class__ = PyValidator
54f9ee45 7532_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
7533
7534#---------------------------------------------------------------------------
7535
7536class Menu(EvtHandler):
d14a1e28
RD
7537 def __repr__(self):
7538 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 7539 def __init__(self, *args, **kwargs):
a95a7133 7540 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 7541 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
7542 self.this = newobj.this
7543 self.thisown = 1
7544 del newobj.thisown
7545 self._setOORInfo(self)
7546
7547 def Append(*args, **kwargs):
a95a7133 7548 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7549 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
7550
7551 def AppendSeparator(*args, **kwargs):
a95a7133 7552 """AppendSeparator(self) -> MenuItem"""
54f9ee45 7553 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
7554
7555 def AppendCheckItem(*args, **kwargs):
a95a7133 7556 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7557 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
7558
7559 def AppendRadioItem(*args, **kwargs):
a95a7133 7560 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7561 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
7562
7563 def AppendMenu(*args, **kwargs):
a95a7133 7564 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7565 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
7566
7567 def AppendItem(*args, **kwargs):
a95a7133 7568 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7569 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
7570
7571 def Break(*args, **kwargs):
a95a7133 7572 """Break(self)"""
54f9ee45 7573 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
7574
7575 def InsertItem(*args, **kwargs):
a95a7133 7576 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 7577 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
7578
7579 def Insert(*args, **kwargs):
0df68c9f 7580 """
a95a7133 7581 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 7582 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 7583 """
54f9ee45 7584 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
7585
7586 def InsertSeparator(*args, **kwargs):
a95a7133 7587 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 7588 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
7589
7590 def InsertCheckItem(*args, **kwargs):
a95a7133 7591 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7592 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
7593
7594 def InsertRadioItem(*args, **kwargs):
a95a7133 7595 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7596 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
7597
7598 def InsertMenu(*args, **kwargs):
a95a7133 7599 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7600 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
7601
7602 def PrependItem(*args, **kwargs):
a95a7133 7603 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7604 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
7605
7606 def Prepend(*args, **kwargs):
a95a7133 7607 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7608 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
7609
7610 def PrependSeparator(*args, **kwargs):
a95a7133 7611 """PrependSeparator(self) -> MenuItem"""
54f9ee45 7612 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
7613
7614 def PrependCheckItem(*args, **kwargs):
a95a7133 7615 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7616 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
7617
7618 def PrependRadioItem(*args, **kwargs):
a95a7133 7619 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7620 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
7621
7622 def PrependMenu(*args, **kwargs):
a95a7133 7623 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7624 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
7625
7626 def Remove(*args, **kwargs):
a95a7133 7627 """Remove(self, int id) -> MenuItem"""
54f9ee45 7628 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
7629
7630 def RemoveItem(*args, **kwargs):
a95a7133 7631 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7632 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
7633
7634 def Delete(*args, **kwargs):
a95a7133 7635 """Delete(self, int id) -> bool"""
54f9ee45 7636 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
7637
7638 def DeleteItem(*args, **kwargs):
a95a7133 7639 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 7640 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
7641
7642 def Destroy(*args, **kwargs):
0df68c9f 7643 """
a95a7133 7644 Destroy(self)
e811c8ce 7645
0df68c9f
RD
7646 Deletes the C++ object this Python object is a proxy for.
7647 """
54f9ee45 7648 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
7649
7650 def DestroyId(*args, **kwargs):
0df68c9f 7651 """
a95a7133 7652 DestroyId(self, int id) -> bool
e811c8ce 7653
0df68c9f
RD
7654 Deletes the C++ object this Python object is a proxy for.
7655 """
54f9ee45 7656 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
7657
7658 def DestroyItem(*args, **kwargs):
0df68c9f 7659 """
a95a7133 7660 DestroyItem(self, MenuItem item) -> bool
e811c8ce 7661
0df68c9f
RD
7662 Deletes the C++ object this Python object is a proxy for.
7663 """
54f9ee45 7664 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
7665
7666 def GetMenuItemCount(*args, **kwargs):
a95a7133 7667 """GetMenuItemCount(self) -> size_t"""
54f9ee45 7668 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
7669
7670 def GetMenuItems(*args, **kwargs):
a95a7133 7671 """GetMenuItems(self) -> PyObject"""
54f9ee45 7672 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
7673
7674 def FindItem(*args, **kwargs):
a95a7133 7675 """FindItem(self, String item) -> int"""
54f9ee45 7676 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
7677
7678 def FindItemById(*args, **kwargs):
a95a7133 7679 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7680 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
7681
7682 def FindItemByPosition(*args, **kwargs):
a95a7133 7683 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 7684 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
7685
7686 def Enable(*args, **kwargs):
a95a7133 7687 """Enable(self, int id, bool enable)"""
54f9ee45 7688 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
7689
7690 def IsEnabled(*args, **kwargs):
a95a7133 7691 """IsEnabled(self, int id) -> bool"""
54f9ee45 7692 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
7693
7694 def Check(*args, **kwargs):
a95a7133 7695 """Check(self, int id, bool check)"""
54f9ee45 7696 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
7697
7698 def IsChecked(*args, **kwargs):
a95a7133 7699 """IsChecked(self, int id) -> bool"""
54f9ee45 7700 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
7701
7702 def SetLabel(*args, **kwargs):
a95a7133 7703 """SetLabel(self, int id, String label)"""
54f9ee45 7704 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
7705
7706 def GetLabel(*args, **kwargs):
a95a7133 7707 """GetLabel(self, int id) -> String"""
54f9ee45 7708 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
7709
7710 def SetHelpString(*args, **kwargs):
a95a7133 7711 """SetHelpString(self, int id, String helpString)"""
54f9ee45 7712 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
7713
7714 def GetHelpString(*args, **kwargs):
a95a7133 7715 """GetHelpString(self, int id) -> String"""
54f9ee45 7716 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
7717
7718 def SetTitle(*args, **kwargs):
a95a7133 7719 """SetTitle(self, String title)"""
54f9ee45 7720 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
7721
7722 def GetTitle(*args, **kwargs):
a95a7133 7723 """GetTitle(self) -> String"""
54f9ee45 7724 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
7725
7726 def SetEventHandler(*args, **kwargs):
a95a7133 7727 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 7728 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
7729
7730 def GetEventHandler(*args, **kwargs):
a95a7133 7731 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 7732 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
7733
7734 def SetInvokingWindow(*args, **kwargs):
a95a7133 7735 """SetInvokingWindow(self, Window win)"""
54f9ee45 7736 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7737
7738 def GetInvokingWindow(*args, **kwargs):
a95a7133 7739 """GetInvokingWindow(self) -> Window"""
54f9ee45 7740 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7741
7742 def GetStyle(*args, **kwargs):
a95a7133 7743 """GetStyle(self) -> long"""
54f9ee45 7744 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
7745
7746 def UpdateUI(*args, **kwargs):
a95a7133 7747 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 7748 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
7749
7750 def GetMenuBar(*args, **kwargs):
a95a7133 7751 """GetMenuBar(self) -> MenuBar"""
54f9ee45 7752 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
7753
7754 def Attach(*args, **kwargs):
a95a7133 7755 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 7756 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
7757
7758 def Detach(*args, **kwargs):
a95a7133 7759 """Detach(self)"""
54f9ee45 7760 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
7761
7762 def IsAttached(*args, **kwargs):
a95a7133 7763 """IsAttached(self) -> bool"""
54f9ee45 7764 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
7765
7766 def SetParent(*args, **kwargs):
a95a7133 7767 """SetParent(self, Menu parent)"""
54f9ee45 7768 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
7769
7770 def GetParent(*args, **kwargs):
a95a7133 7771 """GetParent(self) -> Menu"""
54f9ee45 7772 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 7773
d14a1e28
RD
7774
7775class MenuPtr(Menu):
7776 def __init__(self, this):
7777 self.this = this
7778 if not hasattr(self,"thisown"): self.thisown = 0
7779 self.__class__ = Menu
54f9ee45 7780_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
7781DefaultValidator = cvar.DefaultValidator
7782
7783#---------------------------------------------------------------------------
7784
7785class MenuBar(Window):
e811c8ce
RD
7786 def __repr__(self):
7787 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 7788 def __init__(self, *args, **kwargs):
a95a7133 7789 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 7790 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
7791 self.this = newobj.this
7792 self.thisown = 1
7793 del newobj.thisown
7794 self._setOORInfo(self)
e811c8ce
RD
7795
7796 def Append(*args, **kwargs):
a95a7133 7797 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 7798 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
7799
7800 def Insert(*args, **kwargs):
a95a7133 7801 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 7802 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
7803
7804 def GetMenuCount(*args, **kwargs):
a95a7133 7805 """GetMenuCount(self) -> size_t"""
54f9ee45 7806 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
7807
7808 def GetMenu(*args, **kwargs):
a95a7133 7809 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 7810 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
7811
7812 def Replace(*args, **kwargs):
a95a7133 7813 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 7814 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
7815
7816 def Remove(*args, **kwargs):
a95a7133 7817 """Remove(self, size_t pos) -> Menu"""
54f9ee45 7818 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
7819
7820 def EnableTop(*args, **kwargs):
a95a7133 7821 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 7822 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
7823
7824 def IsEnabledTop(*args, **kwargs):
a95a7133 7825 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 7826 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
7827
7828 def SetLabelTop(*args, **kwargs):
a95a7133 7829 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 7830 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
7831
7832 def GetLabelTop(*args, **kwargs):
a95a7133 7833 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 7834 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
7835
7836 def FindMenuItem(*args, **kwargs):
a95a7133 7837 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 7838 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
7839
7840 def FindItemById(*args, **kwargs):
a95a7133 7841 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7842 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
7843
7844 def FindMenu(*args, **kwargs):
a95a7133 7845 """FindMenu(self, String title) -> int"""
54f9ee45 7846 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
7847
7848 def Enable(*args, **kwargs):
a95a7133 7849 """Enable(self, int id, bool enable)"""
54f9ee45 7850 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
7851
7852 def Check(*args, **kwargs):
a95a7133 7853 """Check(self, int id, bool check)"""
54f9ee45 7854 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
7855
7856 def IsChecked(*args, **kwargs):
a95a7133 7857 """IsChecked(self, int id) -> bool"""
54f9ee45 7858 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
7859
7860 def IsEnabled(*args, **kwargs):
a95a7133 7861 """IsEnabled(self, int id) -> bool"""
54f9ee45 7862 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
7863
7864 def SetLabel(*args, **kwargs):
a95a7133 7865 """SetLabel(self, int id, String label)"""
54f9ee45 7866 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
7867
7868 def GetLabel(*args, **kwargs):
a95a7133 7869 """GetLabel(self, int id) -> String"""
54f9ee45 7870 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
7871
7872 def SetHelpString(*args, **kwargs):
a95a7133 7873 """SetHelpString(self, int id, String helpString)"""
54f9ee45 7874 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
7875
7876 def GetHelpString(*args, **kwargs):
a95a7133 7877 """GetHelpString(self, int id) -> String"""
54f9ee45 7878 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
7879
7880 def GetFrame(*args, **kwargs):
a95a7133 7881 """GetFrame(self) -> wxFrame"""
54f9ee45 7882 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
7883
7884 def IsAttached(*args, **kwargs):
a95a7133 7885 """IsAttached(self) -> bool"""
54f9ee45 7886 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
7887
7888 def Attach(*args, **kwargs):
a95a7133 7889 """Attach(self, wxFrame frame)"""
54f9ee45 7890 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
7891
7892 def Detach(*args, **kwargs):
a95a7133 7893 """Detach(self)"""
54f9ee45 7894 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 7895
d14a1e28
RD
7896
7897class MenuBarPtr(MenuBar):
7898 def __init__(self, this):
7899 self.this = this
7900 if not hasattr(self,"thisown"): self.thisown = 0
7901 self.__class__ = MenuBar
54f9ee45 7902_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
7903
7904#---------------------------------------------------------------------------
7905
7906class MenuItem(Object):
e811c8ce
RD
7907 def __repr__(self):
7908 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 7909 def __init__(self, *args, **kwargs):
0df68c9f 7910 """
a95a7133 7911 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
7912 String help=EmptyString, int kind=ITEM_NORMAL,
7913 Menu subMenu=None) -> MenuItem
0df68c9f 7914 """
54f9ee45 7915 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
7916 self.this = newobj.this
7917 self.thisown = 1
7918 del newobj.thisown
e811c8ce 7919 def GetMenu(*args, **kwargs):
a95a7133 7920 """GetMenu(self) -> Menu"""
54f9ee45 7921 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
7922
7923 def SetMenu(*args, **kwargs):
a95a7133 7924 """SetMenu(self, Menu menu)"""
54f9ee45 7925 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
7926
7927 def SetId(*args, **kwargs):
a95a7133 7928 """SetId(self, int id)"""
54f9ee45 7929 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
7930
7931 def GetId(*args, **kwargs):
a95a7133 7932 """GetId(self) -> int"""
54f9ee45 7933 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
7934
7935 def IsSeparator(*args, **kwargs):
a95a7133 7936 """IsSeparator(self) -> bool"""
54f9ee45 7937 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
7938
7939 def SetText(*args, **kwargs):
a95a7133 7940 """SetText(self, String str)"""
54f9ee45 7941 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
7942
7943 def GetLabel(*args, **kwargs):
a95a7133 7944 """GetLabel(self) -> String"""
54f9ee45 7945 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
7946
7947 def GetText(*args, **kwargs):
a95a7133 7948 """GetText(self) -> String"""
54f9ee45 7949 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
7950
7951 def GetLabelFromText(*args, **kwargs):
66c033b4 7952 """GetLabelFromText(String text) -> String"""
54f9ee45 7953 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
7954
7955 GetLabelFromText = staticmethod(GetLabelFromText)
7956 def GetKind(*args, **kwargs):
a95a7133 7957 """GetKind(self) -> int"""
54f9ee45 7958 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 7959
a95a7133
RD
7960 def SetKind(*args, **kwargs):
7961 """SetKind(self, int kind)"""
54f9ee45 7962 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 7963
e811c8ce 7964 def SetCheckable(*args, **kwargs):
a95a7133 7965 """SetCheckable(self, bool checkable)"""
54f9ee45 7966 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
7967
7968 def IsCheckable(*args, **kwargs):
a95a7133 7969 """IsCheckable(self) -> bool"""
54f9ee45 7970 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
7971
7972 def IsSubMenu(*args, **kwargs):
a95a7133 7973 """IsSubMenu(self) -> bool"""
54f9ee45 7974 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
7975
7976 def SetSubMenu(*args, **kwargs):
a95a7133 7977 """SetSubMenu(self, Menu menu)"""
54f9ee45 7978 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
7979
7980 def GetSubMenu(*args, **kwargs):
a95a7133 7981 """GetSubMenu(self) -> Menu"""
54f9ee45 7982 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
7983
7984 def Enable(*args, **kwargs):
a95a7133 7985 """Enable(self, bool enable=True)"""
54f9ee45 7986 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
7987
7988 def IsEnabled(*args, **kwargs):
a95a7133 7989 """IsEnabled(self) -> bool"""
54f9ee45 7990 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
7991
7992 def Check(*args, **kwargs):
a95a7133 7993 """Check(self, bool check=True)"""
54f9ee45 7994 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
7995
7996 def IsChecked(*args, **kwargs):
a95a7133 7997 """IsChecked(self) -> bool"""
54f9ee45 7998 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
7999
8000 def Toggle(*args, **kwargs):
a95a7133 8001 """Toggle(self)"""
54f9ee45 8002 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8003
8004 def SetHelp(*args, **kwargs):
a95a7133 8005 """SetHelp(self, String str)"""
54f9ee45 8006 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8007
8008 def GetHelp(*args, **kwargs):
a95a7133 8009 """GetHelp(self) -> String"""
54f9ee45 8010 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8011
8012 def GetAccel(*args, **kwargs):
a95a7133 8013 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8014 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8015
8016 def SetAccel(*args, **kwargs):
a95a7133 8017 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8018 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce
RD
8019
8020 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8021 """GetDefaultMarginWidth() -> int"""
54f9ee45 8022 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8023
8024 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8025 def SetBitmap(*args, **kwargs):
a95a7133 8026 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8027 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8028
8029 def GetBitmap(*args, **kwargs):
a95a7133 8030 """GetBitmap(self) -> Bitmap"""
54f9ee45 8031 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8032
d14a1e28
RD
8033
8034class MenuItemPtr(MenuItem):
8035 def __init__(self, this):
8036 self.this = this
8037 if not hasattr(self,"thisown"): self.thisown = 0
8038 self.__class__ = MenuItem
54f9ee45 8039_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8040
e811c8ce 8041def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8042 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8043 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8044
e811c8ce
RD
8045def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8046 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8047 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8048
8049#---------------------------------------------------------------------------
8050
8051class Control(Window):
15afbcd0
RD
8052 """
8053 This is the base class for a control or 'widget'.
8054
41e2b43e
RD
8055 A control is generally a small window which processes user input
8056 and/or displays one or more item of data.
15afbcd0 8057 """
e811c8ce
RD
8058 def __repr__(self):
8059 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8060 def __init__(self, *args, **kwargs):
0df68c9f 8061 """
248ed943
RD
8062 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8063 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8064 String name=ControlNameStr) -> Control
15afbcd0 8065
41e2b43e
RD
8066 Create a Control. Normally you should only call this from a subclass'
8067 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8068 """
54f9ee45 8069 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8070 self.this = newobj.this
8071 self.thisown = 1
8072 del newobj.thisown
8073 self._setOORInfo(self)
e811c8ce
RD
8074
8075 def Create(*args, **kwargs):
0df68c9f 8076 """
248ed943
RD
8077 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8078 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8079 String name=ControlNameStr) -> bool
15afbcd0
RD
8080
8081 Do the 2nd phase and create the GUI control.
0df68c9f 8082 """
54f9ee45 8083 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8084
8085 def Command(*args, **kwargs):
15afbcd0 8086 """
a95a7133 8087 Command(self, CommandEvent event)
15afbcd0 8088
41e2b43e
RD
8089 Simulates the effect of the user issuing a command to the item.
8090
8091 :see: `wx.CommandEvent`
8092
15afbcd0 8093 """
54f9ee45 8094 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8095
8096 def GetLabel(*args, **kwargs):
15afbcd0 8097 """
a95a7133 8098 GetLabel(self) -> String
15afbcd0
RD
8099
8100 Return a control's text.
8101 """
54f9ee45 8102 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8103
8104 def SetLabel(*args, **kwargs):
15afbcd0 8105 """
a95a7133 8106 SetLabel(self, String label)
15afbcd0
RD
8107
8108 Sets the item's text.
8109 """
54f9ee45 8110 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8111
74a57fcd
RD
8112 def GetClassDefaultAttributes(*args, **kwargs):
8113 """
66c033b4 8114 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 8115
41e2b43e
RD
8116 Get the default attributes for this class. This is useful if you want
8117 to use the same font or colour in your own control as in a standard
8118 control -- which is a much better idea than hard coding specific
db3e571a
RD
8119 colours or fonts which might look completely out of place on the
8120 user's system, especially if it uses themes.
74a57fcd
RD
8121
8122 The variant parameter is only relevant under Mac currently and is
41e2b43e 8123 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8124 the returned font. See `wx.Window.SetWindowVariant` for more about
8125 this.
74a57fcd 8126 """
54f9ee45 8127 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
8128
8129 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
8130
8131class ControlPtr(Control):
8132 def __init__(self, this):
8133 self.this = this
8134 if not hasattr(self,"thisown"): self.thisown = 0
8135 self.__class__ = Control
54f9ee45 8136_core_.Control_swigregister(ControlPtr)
b2dc1044 8137ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
8138
8139def PreControl(*args, **kwargs):
15afbcd0
RD
8140 """
8141 PreControl() -> Control
8142
8143 Precreate a Control control for 2-phase creation
8144 """
54f9ee45 8145 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
8146 val.thisown = 1
8147 return val
8148
74a57fcd
RD
8149def Control_GetClassDefaultAttributes(*args, **kwargs):
8150 """
8151 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8152
41e2b43e
RD
8153 Get the default attributes for this class. This is useful if you want
8154 to use the same font or colour in your own control as in a standard
8155 control -- which is a much better idea than hard coding specific
db3e571a
RD
8156 colours or fonts which might look completely out of place on the
8157 user's system, especially if it uses themes.
74a57fcd
RD
8158
8159 The variant parameter is only relevant under Mac currently and is
41e2b43e 8160 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8161 the returned font. See `wx.Window.SetWindowVariant` for more about
8162 this.
74a57fcd 8163 """
54f9ee45 8164 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8165
d14a1e28
RD
8166#---------------------------------------------------------------------------
8167
8168class ItemContainer(object):
15afbcd0
RD
8169 """
8170 wx.ItemContainer defines an interface which is implemented by all
41e2b43e
RD
8171 controls which have string subitems, each of which may be selected,
8172 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8173 `wx.ComboBox` which implements an extended interface deriving from
8174 this one.
15afbcd0 8175
41e2b43e
RD
8176 It defines the methods for accessing the control's items and although
8177 each of the derived classes implements them differently, they still
8178 all conform to the same interface.
15afbcd0 8179
41e2b43e
RD
8180 The items in a wx.ItemContainer have (non empty) string labels and,
8181 optionally, client data associated with them.
15afbcd0
RD
8182
8183 """
d14a1e28
RD
8184 def __init__(self): raise RuntimeError, "No constructor defined"
8185 def __repr__(self):
8186 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8187 def Append(*args, **kwargs):
15afbcd0 8188 """
a95a7133 8189 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 8190
41e2b43e
RD
8191 Adds the item to the control, associating the given data with the item
8192 if not None. The return value is the index of the newly added item
8193 which may be different from the last one if the control is sorted (e.g.
8194 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 8195 """
54f9ee45 8196 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
8197
8198 def AppendItems(*args, **kwargs):
15afbcd0 8199 """
a95a7133 8200 AppendItems(self, wxArrayString strings)
15afbcd0 8201
41e2b43e
RD
8202 Apend several items at once to the control. Notice that calling this
8203 method may be much faster than appending the items one by one if you
8204 need to add a lot of items.
15afbcd0 8205 """
54f9ee45 8206 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
8207
8208 def Insert(*args, **kwargs):
15afbcd0 8209 """
a95a7133 8210 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 8211
41e2b43e 8212 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
8213 optionally associating some data object with the item.
8214 """
54f9ee45 8215 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
8216
8217 def Clear(*args, **kwargs):
15afbcd0 8218 """
a95a7133 8219 Clear(self)
15afbcd0
RD
8220
8221 Removes all items from the control.
8222 """
54f9ee45 8223 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
8224
8225 def Delete(*args, **kwargs):
15afbcd0 8226 """
a95a7133 8227 Delete(self, int n)
15afbcd0 8228
41e2b43e
RD
8229 Deletes the item at the zero-based index 'n' from the control. Note
8230 that it is an error (signalled by a `wx.PyAssertionError` exception if
8231 enabled) to remove an item with the index negative or greater or equal
8232 than the number of items in the control.
15afbcd0 8233 """
54f9ee45 8234 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce
RD
8235
8236 def GetCount(*args, **kwargs):
15afbcd0 8237 """
a95a7133 8238 GetCount(self) -> int
15afbcd0
RD
8239
8240 Returns the number of items in the control.
8241 """
54f9ee45 8242 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
8243
8244 def IsEmpty(*args, **kwargs):
15afbcd0 8245 """
a95a7133 8246 IsEmpty(self) -> bool
15afbcd0
RD
8247
8248 Returns True if the control is empty or False if it has some items.
8249 """
54f9ee45 8250 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
8251
8252 def GetString(*args, **kwargs):
15afbcd0 8253 """
a95a7133 8254 GetString(self, int n) -> String
15afbcd0
RD
8255
8256 Returns the label of the item with the given index.
8257 """
54f9ee45 8258 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
8259
8260 def GetStrings(*args, **kwargs):
a95a7133 8261 """GetStrings(self) -> wxArrayString"""
54f9ee45 8262 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
8263
8264 def SetString(*args, **kwargs):
15afbcd0 8265 """
a95a7133 8266 SetString(self, int n, String s)
15afbcd0
RD
8267
8268 Sets the label for the given item.
8269 """
54f9ee45 8270 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
8271
8272 def FindString(*args, **kwargs):
15afbcd0 8273 """
a95a7133 8274 FindString(self, String s) -> int
15afbcd0
RD
8275
8276 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
8277 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8278 found.
15afbcd0 8279 """
54f9ee45 8280 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce
RD
8281
8282 def Select(*args, **kwargs):
15afbcd0 8283 """
a95a7133 8284 Select(self, int n)
15afbcd0
RD
8285
8286 Sets the item at index 'n' to be the selected item.
8287 """
54f9ee45 8288 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 8289
15afbcd0 8290 SetSelection = Select
e811c8ce 8291 def GetSelection(*args, **kwargs):
15afbcd0 8292 """
a95a7133 8293 GetSelection(self) -> int
15afbcd0 8294
41e2b43e
RD
8295 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8296 is selected.
15afbcd0 8297 """
54f9ee45 8298 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce
RD
8299
8300 def GetStringSelection(*args, **kwargs):
15afbcd0 8301 """
a95a7133 8302 GetStringSelection(self) -> String
15afbcd0 8303
41e2b43e
RD
8304 Returns the label of the selected item or an empty string if no item
8305 is selected.
15afbcd0 8306 """
54f9ee45 8307 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce
RD
8308
8309 def GetClientData(*args, **kwargs):
15afbcd0 8310 """
a95a7133 8311 GetClientData(self, int n) -> PyObject
15afbcd0
RD
8312
8313 Returns the client data associated with the given item, (if any.)
8314 """
54f9ee45 8315 return _core_.ItemContainer_GetClientData(*args, **kwargs)
e811c8ce
RD
8316
8317 def SetClientData(*args, **kwargs):
15afbcd0 8318 """
a95a7133 8319 SetClientData(self, int n, PyObject clientData)
15afbcd0
RD
8320
8321 Associate the given client data with the item at position n.
8322 """
54f9ee45 8323 return _core_.ItemContainer_SetClientData(*args, **kwargs)
e811c8ce 8324
d14a1e28
RD
8325
8326class ItemContainerPtr(ItemContainer):
8327 def __init__(self, this):
8328 self.this = this
8329 if not hasattr(self,"thisown"): self.thisown = 0
8330 self.__class__ = ItemContainer
54f9ee45 8331_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
8332
8333#---------------------------------------------------------------------------
8334
8335class ControlWithItems(Control,ItemContainer):
15afbcd0 8336 """
41e2b43e
RD
8337 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8338 wx.Control class, and is used for the base class of various controls
8339 that have items.
15afbcd0 8340 """
d14a1e28
RD
8341 def __init__(self): raise RuntimeError, "No constructor defined"
8342 def __repr__(self):
8343 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8344
8345class ControlWithItemsPtr(ControlWithItems):
8346 def __init__(self, this):
8347 self.this = this
8348 if not hasattr(self,"thisown"): self.thisown = 0
8349 self.__class__ = ControlWithItems
54f9ee45 8350_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
8351
8352#---------------------------------------------------------------------------
8353
8354class SizerItem(Object):
248ed943
RD
8355 """
8356 The wx.SizerItem class is used to track the position, size and other
8357 attributes of each item managed by a `wx.Sizer`. In normal usage user
8358 code should never need to deal directly with a wx.SizerItem, but
8359 custom classes derived from `wx.PySizer` will probably need to use the
8360 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8361
8362 :see: `wx.Sizer`, `wx.GBSizerItem`
8363 """
e811c8ce
RD
8364 def __repr__(self):
8365 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8366 def __init__(self, *args, **kwargs):
248ed943
RD
8367 """
8368 __init__(self) -> SizerItem
8369
8370 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8371 size will need to be set before this item can be used in a Sizer.
8372
8373 You will probably never need to create a wx.SizerItem directly as they
8374 are created automatically when the sizer's Add, Insert or Prepend
8375 methods are called.
8376
8377 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8378 """
54f9ee45 8379 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
8380 self.this = newobj.this
8381 self.thisown = 1
8382 del newobj.thisown
e811c8ce 8383 def DeleteWindows(*args, **kwargs):
248ed943
RD
8384 """
8385 DeleteWindows(self)
8386
8387 Destroy the window or the windows in a subsizer, depending on the type
8388 of item.
8389 """
54f9ee45 8390 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
8391
8392 def DetachSizer(*args, **kwargs):
248ed943
RD
8393 """
8394 DetachSizer(self)
8395
8396 Enable deleting the SizerItem without destroying the contained sizer.
8397 """
54f9ee45 8398 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
8399
8400 def GetSize(*args, **kwargs):
248ed943
RD
8401 """
8402 GetSize(self) -> Size
8403
8404 Get the current size of the item, as set in the last Layout.
8405 """
54f9ee45 8406 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
8407
8408 def CalcMin(*args, **kwargs):
248ed943
RD
8409 """
8410 CalcMin(self) -> Size
8411
8412 Calculates the minimum desired size for the item, including any space
8413 needed by borders.
8414 """
54f9ee45 8415 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
8416
8417 def SetDimension(*args, **kwargs):
248ed943
RD
8418 """
8419 SetDimension(self, Point pos, Size size)
8420
8421 Set the position and size of the space allocated for this item by the
8422 sizer, and adjust the position and size of the item (window or
8423 subsizer) to be within that space taking alignment and borders into
8424 account.
8425 """
54f9ee45 8426 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
8427
8428 def GetMinSize(*args, **kwargs):
248ed943
RD
8429 """
8430 GetMinSize(self) -> Size
8431
8432 Get the minimum size needed for the item.
8433 """
54f9ee45 8434 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce
RD
8435
8436 def SetInitSize(*args, **kwargs):
a95a7133 8437 """SetInitSize(self, int x, int y)"""
54f9ee45 8438 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
8439
8440 def SetRatioWH(*args, **kwargs):
248ed943
RD
8441 """
8442 SetRatioWH(self, int width, int height)
8443
8444 Set the ratio item attribute.
8445 """
54f9ee45 8446 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
8447
8448 def SetRatioSize(*args, **kwargs):
248ed943
RD
8449 """
8450 SetRatioSize(self, Size size)
8451
8452 Set the ratio item attribute.
8453 """
54f9ee45 8454 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
8455
8456 def SetRatio(*args, **kwargs):
248ed943
RD
8457 """
8458 SetRatio(self, float ratio)
8459
8460 Set the ratio item attribute.
8461 """
54f9ee45 8462 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
8463
8464 def GetRatio(*args, **kwargs):
248ed943
RD
8465 """
8466 GetRatio(self) -> float
8467
8468 Set the ratio item attribute.
8469 """
54f9ee45 8470 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce
RD
8471
8472 def IsWindow(*args, **kwargs):
248ed943
RD
8473 """
8474 IsWindow(self) -> bool
8475
8476 Is this sizer item a window?
8477 """
54f9ee45 8478 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
8479
8480 def IsSizer(*args, **kwargs):
248ed943
RD
8481 """
8482 IsSizer(self) -> bool
8483
8484 Is this sizer item a subsizer?
8485 """
54f9ee45 8486 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
8487
8488 def IsSpacer(*args, **kwargs):
248ed943
RD
8489 """
8490 IsSpacer(self) -> bool
8491
8492 Is this sizer item a spacer?
8493 """
54f9ee45 8494 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
8495
8496 def SetProportion(*args, **kwargs):
248ed943
RD
8497 """
8498 SetProportion(self, int proportion)
8499
8500 Set the proportion value for this item.
8501 """
54f9ee45 8502 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
8503
8504 def GetProportion(*args, **kwargs):
248ed943
RD
8505 """
8506 GetProportion(self) -> int
8507
8508 Get the proportion value for this item.
8509 """
54f9ee45 8510 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 8511
248ed943
RD
8512 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8513 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 8514 def SetFlag(*args, **kwargs):
248ed943
RD
8515 """
8516 SetFlag(self, int flag)
8517
8518 Set the flag value for this item.
8519 """
54f9ee45 8520 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
8521
8522 def GetFlag(*args, **kwargs):
248ed943
RD
8523 """
8524 GetFlag(self) -> int
8525
8526 Get the flag value for this item.
8527 """
54f9ee45 8528 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
8529
8530 def SetBorder(*args, **kwargs):
248ed943
RD
8531 """
8532 SetBorder(self, int border)
8533
8534 Set the border value for this item.
8535 """
54f9ee45 8536 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
8537
8538 def GetBorder(*args, **kwargs):
248ed943
RD
8539 """
8540 GetBorder(self) -> int
8541
8542 Get the border value for this item.
8543 """
54f9ee45 8544 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
8545
8546 def GetWindow(*args, **kwargs):
248ed943
RD
8547 """
8548 GetWindow(self) -> Window
8549
8550 Get the window (if any) that is managed by this sizer item.
8551 """
54f9ee45 8552 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
8553
8554 def SetWindow(*args, **kwargs):
248ed943
RD
8555 """
8556 SetWindow(self, Window window)
8557
8558 Set the window to be managed by this sizer item.
8559 """
54f9ee45 8560 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
8561
8562 def GetSizer(*args, **kwargs):
248ed943
RD
8563 """
8564 GetSizer(self) -> Sizer
8565
8566 Get the subsizer (if any) that is managed by this sizer item.
8567 """
54f9ee45 8568 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
8569
8570 def SetSizer(*args, **kwargs):
248ed943
RD
8571 """
8572 SetSizer(self, Sizer sizer)
8573
8574 Set the subsizer to be managed by this sizer item.
8575 """
54f9ee45 8576 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
8577
8578 def GetSpacer(*args, **kwargs):
248ed943
RD
8579 """
8580 GetSpacer(self) -> Size
8581
8582 Get the size of the spacer managed by this sizer item.
8583 """
54f9ee45 8584 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
8585
8586 def SetSpacer(*args, **kwargs):
248ed943
RD
8587 """
8588 SetSpacer(self, Size size)
8589
8590 Set the size of the spacer to be managed by this sizer item.
8591 """
54f9ee45 8592 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
8593
8594 def Show(*args, **kwargs):
248ed943
RD
8595 """
8596 Show(self, bool show)
8597
8598 Set the show item attribute, which sizers use to determine if the item
8599 is to be made part of the layout or not. If the item is tracking a
8600 window then it is shown or hidden as needed.
8601 """
54f9ee45 8602 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
8603
8604 def IsShown(*args, **kwargs):
248ed943
RD
8605 """
8606 IsShown(self) -> bool
8607
8608 Is the item to be shown in the layout?
8609 """
54f9ee45 8610 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
8611
8612 def GetPosition(*args, **kwargs):
248ed943
RD
8613 """
8614 GetPosition(self) -> Point
8615
8616 Returns the current position of the item, as set in the last Layout.
8617 """
54f9ee45 8618 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
8619
8620 def GetUserData(*args, **kwargs):
248ed943
RD
8621 """
8622 GetUserData(self) -> PyObject
8623
8624 Returns the userData associated with this sizer item, or None if there
8625 isn't any.
8626 """
54f9ee45 8627 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 8628
d14a1e28
RD
8629
8630class SizerItemPtr(SizerItem):
8631 def __init__(self, this):
8632 self.this = this
8633 if not hasattr(self,"thisown"): self.thisown = 0
8634 self.__class__ = SizerItem
54f9ee45 8635_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 8636
248ed943 8637def SizerItemWindow(*args, **kwargs):
0df68c9f 8638 """
248ed943
RD
8639 SizerItemWindow(Window window, int proportion, int flag, int border,
8640 PyObject userData=None) -> SizerItem
8641
8642 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 8643 """
248ed943 8644 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
8645 val.thisown = 1
8646 return val
8647
248ed943 8648def SizerItemSpacer(*args, **kwargs):
0df68c9f 8649 """
248ed943
RD
8650 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
8651 PyObject userData=None) -> SizerItem
8652
8653 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 8654 """
248ed943 8655 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
8656 val.thisown = 1
8657 return val
8658
8659def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
8660 """
8661 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
8662 PyObject userData=None) -> SizerItem
8663
8664 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 8665 """
54f9ee45 8666 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
8667 val.thisown = 1
8668 return val
8669
8670class Sizer(Object):
248ed943
RD
8671 """
8672 wx.Sizer is the abstract base class used for laying out subwindows in
8673 a window. You cannot use wx.Sizer directly; instead, you will have to
8674 use one of the sizer classes derived from it such as `wx.BoxSizer`,
8675 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
8676 and `wx.GridBagSizer`.
8677
8678 The concept implemented by sizers in wxWidgets is closely related to
8679 layout tools in other GUI toolkits, such as Java's AWT, the GTK
8680 toolkit or the Qt toolkit. It is based upon the idea of the individual
8681 subwindows reporting their minimal required size and their ability to
8682 get stretched if the size of the parent window has changed. This will
8683 most often mean that the programmer does not set the original size of
8684 a dialog in the beginning, rather the dialog will assigned a sizer and
8685 this sizer will be queried about the recommended size. The sizer in
8686 turn will query its children, which can be normal windows or contorls,
8687 empty space or other sizers, so that a hierarchy of sizers can be
8688 constructed. Note that wxSizer does not derive from wxWindow and thus
8689 do not interfere with tab ordering and requires very little resources
8690 compared to a real window on screen.
8691
8692 What makes sizers so well fitted for use in wxWidgets is the fact that
8693 every control reports its own minimal size and the algorithm can
8694 handle differences in font sizes or different window (dialog item)
8695 sizes on different platforms without problems. If for example the
8696 standard font as well as the overall design of Mac widgets requires
8697 more space than on Windows, then the initial size of a dialog using a
8698 sizer will automatically be bigger on Mac than on Windows.
8699 """
e811c8ce
RD
8700 def __init__(self): raise RuntimeError, "No constructor defined"
8701 def __repr__(self):
8702 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8703 def _setOORInfo(*args, **kwargs):
a95a7133 8704 """_setOORInfo(self, PyObject _self)"""
54f9ee45 8705 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
8706
8707 def Add(*args, **kwargs):
0df68c9f 8708 """
248ed943 8709 Add(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8710 PyObject userData=None)
248ed943
RD
8711
8712 Appends a child item to the sizer.
0df68c9f 8713 """
54f9ee45 8714 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
8715
8716 def Insert(*args, **kwargs):
0df68c9f 8717 """
248ed943
RD
8718 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
8719 PyObject userData=None)
8720
8721 Inserts a new item into the list of items managed by this sizer before
8722 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 8723 """
54f9ee45 8724 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
8725
8726 def Prepend(*args, **kwargs):
0df68c9f 8727 """
248ed943 8728 Prepend(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8729 PyObject userData=None)
248ed943
RD
8730
8731 Adds a new item to the begining of the list of sizer items managed by
8732 this sizer. See `Add` for a description of the parameters.
0df68c9f 8733 """
54f9ee45 8734 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
8735
8736 def Remove(*args, **kwargs):
248ed943
RD
8737 """
8738 Remove(self, item) -> bool
8739
8740 Removes an item from the sizer and destroys it. This method does not
8741 cause any layout or resizing to take place, call `Layout` to update
8742 the layout on screen after removing a child from the sizer. The
8743 *item* parameter can be either a window, a sizer, or the zero-based
8744 index of an item to remove. Returns True if the child item was found
8745 and removed.
8746 """
54f9ee45 8747 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 8748
1c0f361b 8749 def Detach(*args, **kwargs):
248ed943
RD
8750 """
8751 Detach(self, item) -> bool
8752
8753 Detaches an item from the sizer without destroying it. This method
8754 does not cause any layout or resizing to take place, call `Layout` to
8755 do so. The *item* parameter can be either a window, a sizer, or the
8756 zero-based index of the item to be detached. Returns True if the child item
8757 was found and detached.
8758 """
1c0f361b
RD
8759 return _core_.Sizer_Detach(*args, **kwargs)
8760
e811c8ce 8761 def _SetItemMinSize(*args, **kwargs):
a95a7133 8762 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 8763 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 8764
248ed943
RD
8765 def SetItemMinSize(self, item, *args):
8766 """
8767 SetItemMinSize(self, item, Size size)
8768
8769 Sets the minimum size that will be allocated for an item in the sizer.
8770 The *item* parameter can be either a window, a sizer, or the
8771 zero-based index of the item. If a window or sizer is given then it
8772 will be searched for recursivly in subsizers if neccessary.
8773 """
8774 if len(args) == 2:
8775 # for backward compatibility accept separate width,height args too
8776 return self._SetItemMinSize(item, args)
8777 else:
8778 return self._SetItemMinSize(item, args[0])
8779
e811c8ce 8780 def AddItem(*args, **kwargs):
248ed943
RD
8781 """
8782 AddItem(self, SizerItem item)
8783
8784 Adds a `wx.SizerItem` to the sizer.
8785 """
54f9ee45 8786 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
8787
8788 def InsertItem(*args, **kwargs):
248ed943
RD
8789 """
8790 InsertItem(self, int index, SizerItem item)
8791
8792 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
8793 """
54f9ee45 8794 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
8795
8796 def PrependItem(*args, **kwargs):
248ed943
RD
8797 """
8798 PrependItem(self, SizerItem item)
8799
8800 Prepends a `wx.SizerItem` to the sizer.
8801 """
54f9ee45 8802 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 8803
248ed943 8804 def AddMany(self, items):
66c033b4
RD
8805 """
8806 AddMany is a convenience method for adding several items
8807 to a sizer at one time. Simply pass it a list of tuples,
8808 where each tuple consists of the parameters that you
8809 would normally pass to the `Add` method.
8810 """
248ed943
RD
8811 for item in items:
8812 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
8813 item = (item, )
8814 self.Add(*item)
d14a1e28 8815
74e96f3d 8816 # for backwards compatibility only, please do not use in new code
66c033b4
RD
8817 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
8818 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
8819 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
8820 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
8821 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
8822 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
8823 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
8824 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
8825 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
8826 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
8827 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
8828 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d14a1e28
RD
8829
8830
e811c8ce 8831 def SetDimension(*args, **kwargs):
248ed943
RD
8832 """
8833 SetDimension(self, int x, int y, int width, int height)
8834
8835 Call this to force the sizer to take the given dimension and thus
8836 force the items owned by the sizer to resize themselves according to
8837 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
8838 methods.
8839 """
54f9ee45 8840 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
8841
8842 def SetMinSize(*args, **kwargs):
248ed943
RD
8843 """
8844 SetMinSize(self, Size size)
8845
8846 Call this to give the sizer a minimal size. Normally, the sizer will
8847 calculate its minimal size based purely on how much space its children
8848 need. After calling this method `GetMinSize` will return either the
8849 minimal size as requested by its children or the minimal size set
8850 here, depending on which is bigger.
8851 """
54f9ee45 8852 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
8853
8854 def GetSize(*args, **kwargs):
248ed943
RD
8855 """
8856 GetSize(self) -> Size
8857
8858 Returns the current size of the space managed by the sizer.
8859 """
54f9ee45 8860 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
8861
8862 def GetPosition(*args, **kwargs):
248ed943
RD
8863 """
8864 GetPosition(self) -> Point
8865
8866 Returns the current position of the sizer's managed space.
8867 """
54f9ee45 8868 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
8869
8870 def GetMinSize(*args, **kwargs):
248ed943
RD
8871 """
8872 GetMinSize(self) -> Size
8873
8874 Returns the minimal size of the sizer. This is either the combined
8875 minimal size of all the children and their borders or the minimal size
8876 set by SetMinSize, depending on which is bigger.
8877 """
54f9ee45 8878 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 8879
d14a1e28 8880 def GetSizeTuple(self):
1c0f361b 8881 return self.GetSize().Get()
d14a1e28 8882 def GetPositionTuple(self):
1c0f361b 8883 return self.GetPosition().Get()
d14a1e28 8884 def GetMinSizeTuple(self):
1c0f361b 8885 return self.GetMinSize().Get()
d14a1e28 8886
e811c8ce 8887 def RecalcSizes(*args, **kwargs):
248ed943
RD
8888 """
8889 RecalcSizes(self)
8890
8891 Using the sizes calculated by `CalcMin` reposition and resize all the
8892 items managed by this sizer. You should not need to call this directly as
8893 it is called by `Layout`.
8894 """
54f9ee45 8895 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
8896
8897 def CalcMin(*args, **kwargs):
248ed943
RD
8898 """
8899 CalcMin(self) -> Size
8900
8901 This method is where the sizer will do the actual calculation of its
8902 children's minimal sizes. You should not need to call this directly as
8903 it is called by `Layout`.
8904 """
54f9ee45 8905 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
8906
8907 def Layout(*args, **kwargs):
248ed943
RD
8908 """
8909 Layout(self)
8910
8911 This method will force the recalculation and layout of the items
8912 controlled by the sizer using the current space allocated to the
8913 sizer. Normally this is called automatically from the owning window's
8914 EVT_SIZE handler, but it is also useful to call it from user code when
8915 one of the items in a sizer change size, or items are added or
8916 removed.
8917 """
54f9ee45 8918 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
8919
8920 def Fit(*args, **kwargs):
248ed943
RD
8921 """
8922 Fit(self, Window window) -> Size
8923
8924 Tell the sizer to resize the *window* to match the sizer's minimal
8925 size. This is commonly done in the constructor of the window itself in
8926 order to set its initial size to match the needs of the children as
8927 determined by the sizer. Returns the new size.
8928
8929 For a top level window this is the total window size, not the client size.
8930 """
54f9ee45 8931 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
8932
8933 def FitInside(*args, **kwargs):
248ed943
RD
8934 """
8935 FitInside(self, Window window)
8936
8937 Tell the sizer to resize the *virtual size* of the *window* to match the
8938 sizer's minimal size. This will not alter the on screen size of the
8939 window, but may cause the addition/removal/alteration of scrollbars
8940 required to view the virtual area in windows which manage it.
8941
8942 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
8943
8944 """
54f9ee45 8945 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
8946
8947 def SetSizeHints(*args, **kwargs):
248ed943
RD
8948 """
8949 SetSizeHints(self, Window window)
8950
8951 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
8952 match the sizer's minimal size. This is commonly done in the
8953 constructor of the window itself if the window is resizable (as are
8954 many dialogs under Unix and frames on probably all platforms) in order
8955 to prevent the window from being sized smaller than the minimal size
8956 required by the sizer.
8957 """
54f9ee45 8958 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
8959
8960 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
8961 """
8962 SetVirtualSizeHints(self, Window window)
8963
8964 Tell the sizer to set the minimal size of the window virtual area to
8965 match the sizer's minimal size. For windows with managed scrollbars
8966 this will set them appropriately.
8967
8968 :see: `wx.ScrolledWindow.SetScrollbars`
8969
8970 """
54f9ee45 8971 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
8972
8973 def Clear(*args, **kwargs):
248ed943
RD
8974 """
8975 Clear(self, bool deleteWindows=False)
8976
8977 Clear all items from the sizer, optionally destroying the window items
8978 as well.
8979 """
54f9ee45 8980 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
8981
8982 def DeleteWindows(*args, **kwargs):
248ed943
RD
8983 """
8984 DeleteWindows(self)
8985
8986 Destroy all windows managed by the sizer.
8987 """
54f9ee45 8988 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
8989
8990 def GetChildren(*args, **kwargs):
248ed943
RD
8991 """
8992 GetChildren(sefl) -> list
8993
8994 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
8995 """
54f9ee45 8996 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
8997
8998 def Show(*args, **kwargs):
248ed943
RD
8999 """
9000 Show(self, item, bool show=True)
e811c8ce 9001
248ed943
RD
9002 Shows or hides an item managed by the sizer. To make a sizer item
9003 disappear or reappear, use Show followed by `Layout`. The *item*
9004 parameter can be either a window, a sizer, or the zero-based index of
9005 the item.
9006 """
9007 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9008
9009 def IsShown(*args, **kwargs):
248ed943
RD
9010 """
9011 IsShown(self, item)
9012
9013 Determines if the item is currently shown. sizer. To make a sizer
9014 item disappear or reappear, use Show followed by `Layout`. The *item*
9015 parameter can be either a window, a sizer, or the zero-based index of
9016 the item.
9017 """
54f9ee45 9018 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9019
248ed943
RD
9020 def Hide(self, item):
9021 """
9022 A convenience method for Show(item, False).
9023 """
9024 self.Show(item, False)
9025
e811c8ce 9026 def ShowItems(*args, **kwargs):
248ed943
RD
9027 """
9028 ShowItems(self, bool show)
9029
9030 Recursively call `wx.Window.Show` on all sizer items.
9031 """
54f9ee45 9032 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9033
d14a1e28
RD
9034
9035class SizerPtr(Sizer):
9036 def __init__(self, this):
9037 self.this = this
9038 if not hasattr(self,"thisown"): self.thisown = 0
9039 self.__class__ = Sizer
54f9ee45 9040_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9041
9042class PySizer(Sizer):
248ed943
RD
9043 """
9044 wx.PySizer is a special version of `wx.Sizer` that has been
9045 instrumented to allow the C++ virtual methods to be overloaded in
9046 Python derived classes. You would derive from this class if you are
9047 wanting to implement a custom sizer in Python code. Simply implement
9048 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9049 For example::
9050
9051 class MySizer(wx.PySizer):
9052 def __init__(self):
9053 wx.PySizer.__init__(self)
9054
9055 def CalcMin(self):
9056 for item in self.GetChildren():
9057 # calculate the total minimum width and height needed
9058 # by all items in the sizer according to this sizer's
9059 # layout algorithm.
9060 ...
9061 return wx.Size(width, height)
9062
9063 def RecalcSizes(self):
9064 # find the space allotted to this sizer
9065 pos = self.GetPosition()
9066 size = self.GetSize()
9067 for item in self.GetChildren():
9068 # Recalculate (if necessary) the position and size of
9069 # each item and then call item.SetDimension to do the
9070 # actual positioning and sizing of the items within the
9071 # space alloted to this sizer.
9072 ...
9073 item.SetDimension(itemPos, itemSize)
9074
9075
9076 When `Layout` is called it first calls `CalcMin` followed by
9077 `RecalcSizes` so you can optimize a bit by saving the results of
9078 `CalcMin` and resuing them in `RecalcSizes`.
9079
9080 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9081
9082
9083 """
e811c8ce
RD
9084 def __repr__(self):
9085 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9086 def __init__(self, *args, **kwargs):
248ed943
RD
9087 """
9088 __init__(self) -> PySizer
9089
9090 Creates a wx.PySizer. Must be called from the __init__ in the derived
9091 class.
9092 """
54f9ee45 9093 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
9094 self.this = newobj.this
9095 self.thisown = 1
9096 del newobj.thisown
9097 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
9098
9099 def _setCallbackInfo(*args, **kwargs):
a95a7133 9100 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 9101 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 9102
d14a1e28
RD
9103
9104class PySizerPtr(PySizer):
9105 def __init__(self, this):
9106 self.this = this
9107 if not hasattr(self,"thisown"): self.thisown = 0
9108 self.__class__ = PySizer
54f9ee45 9109_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
9110
9111#---------------------------------------------------------------------------
9112
9113class BoxSizer(Sizer):
248ed943
RD
9114 """
9115 The basic idea behind a box sizer is that windows will most often be
9116 laid out in rather simple basic geometry, typically in a row or a
9117 column or nested hierarchies of either. A wx.BoxSizer will lay out
9118 its items in a simple row or column, depending on the orientation
9119 parameter passed to the constructor.
9120 """
e811c8ce
RD
9121 def __repr__(self):
9122 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9123 def __init__(self, *args, **kwargs):
248ed943
RD
9124 """
9125 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9126
9127 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9128 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9129 sizer.
9130 """
54f9ee45 9131 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
9132 self.this = newobj.this
9133 self.thisown = 1
9134 del newobj.thisown
9135 self._setOORInfo(self)
e811c8ce
RD
9136
9137 def GetOrientation(*args, **kwargs):
248ed943
RD
9138 """
9139 GetOrientation(self) -> int
9140
9141 Returns the current orientation of the sizer.
9142 """
54f9ee45 9143 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
9144
9145 def SetOrientation(*args, **kwargs):
248ed943
RD
9146 """
9147 SetOrientation(self, int orient)
e811c8ce 9148
248ed943
RD
9149 Resets the orientation of the sizer.
9150 """
9151 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 9152
d14a1e28
RD
9153
9154class BoxSizerPtr(BoxSizer):
9155 def __init__(self, this):
9156 self.this = this
9157 if not hasattr(self,"thisown"): self.thisown = 0
9158 self.__class__ = BoxSizer
54f9ee45 9159_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
9160
9161#---------------------------------------------------------------------------
9162
9163class StaticBoxSizer(BoxSizer):
248ed943
RD
9164 """
9165 wx.StaticBoxSizer derives from and functions identically to the
9166 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9167 manages. Note that this static box must be created separately and
9168 passed to the sizer constructor.
9169 """
e811c8ce
RD
9170 def __repr__(self):
9171 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9172 def __init__(self, *args, **kwargs):
248ed943
RD
9173 """
9174 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9175
9176 Constructor. It takes an associated static box and the orientation
9177 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9178 ``wx.HORIZONTAL``.
9179 """
54f9ee45 9180 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
9181 self.this = newobj.this
9182 self.thisown = 1
9183 del newobj.thisown
9184 self._setOORInfo(self)
e811c8ce
RD
9185
9186 def GetStaticBox(*args, **kwargs):
248ed943
RD
9187 """
9188 GetStaticBox(self) -> StaticBox
e811c8ce 9189
248ed943
RD
9190 Returns the static box associated with this sizer.
9191 """
9192 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 9193
d14a1e28
RD
9194
9195class StaticBoxSizerPtr(StaticBoxSizer):
9196 def __init__(self, this):
9197 self.this = this
9198 if not hasattr(self,"thisown"): self.thisown = 0
9199 self.__class__ = StaticBoxSizer
54f9ee45 9200_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
9201
9202#---------------------------------------------------------------------------
9203
9204class GridSizer(Sizer):
248ed943
RD
9205 """
9206 A grid sizer is a sizer which lays out its children in a
9207 two-dimensional table with all cells having the same size. In other
9208 words, the width of each cell within the grid is the width of the
9209 widest item added to the sizer and the height of each grid cell is the
9210 height of the tallest item. An optional vertical and/or horizontal
9211 gap between items can also be specified (in pixels.)
9212
9213 Items are placed in the cells of the grid in the order they are added,
9214 in row-major order. In other words, the first row is filled first,
9215 then the second, and so on until all items have been added. (If
9216 neccessary, additional rows will be added as items are added.) If you
9217 need to have greater control over the cells that items are placed in
9218 then use the `wx.GridBagSizer`.
9219
9220 """
e811c8ce
RD
9221 def __repr__(self):
9222 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9223 def __init__(self, *args, **kwargs):
248ed943
RD
9224 """
9225 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9226
9227 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9228 of columns and rows in the sizer - if either of the parameters is
9229 zero, it will be calculated to from the total number of children in
9230 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9231 define extra space between all children.
9232 """
54f9ee45 9233 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
9234 self.this = newobj.this
9235 self.thisown = 1
9236 del newobj.thisown
9237 self._setOORInfo(self)
e811c8ce 9238
e811c8ce 9239 def SetCols(*args, **kwargs):
248ed943
RD
9240 """
9241 SetCols(self, int cols)
9242
9243 Sets the number of columns in the sizer.
9244 """
54f9ee45 9245 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
9246
9247 def SetRows(*args, **kwargs):
248ed943
RD
9248 """
9249 SetRows(self, int rows)
9250
9251 Sets the number of rows in the sizer.
9252 """
54f9ee45 9253 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
9254
9255 def SetVGap(*args, **kwargs):
248ed943
RD
9256 """
9257 SetVGap(self, int gap)
9258
9259 Sets the vertical gap (in pixels) between the cells in the sizer.
9260 """
54f9ee45 9261 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
9262
9263 def SetHGap(*args, **kwargs):
248ed943
RD
9264 """
9265 SetHGap(self, int gap)
9266
9267 Sets the horizontal gap (in pixels) between cells in the sizer
9268 """
54f9ee45 9269 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
9270
9271 def GetCols(*args, **kwargs):
248ed943
RD
9272 """
9273 GetCols(self) -> int
9274
9275 Returns the number of columns in the sizer.
9276 """
54f9ee45 9277 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
9278
9279 def GetRows(*args, **kwargs):
248ed943
RD
9280 """
9281 GetRows(self) -> int
9282
9283 Returns the number of rows in the sizer.
9284 """
54f9ee45 9285 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
9286
9287 def GetVGap(*args, **kwargs):
248ed943
RD
9288 """
9289 GetVGap(self) -> int
9290
9291 Returns the vertical gap (in pixels) between the cells in the sizer.
9292 """
54f9ee45 9293 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
9294
9295 def GetHGap(*args, **kwargs):
248ed943
RD
9296 """
9297 GetHGap(self) -> int
9298
9299 Returns the horizontal gap (in pixels) between cells in the sizer.
9300 """
54f9ee45 9301 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 9302
d14a1e28
RD
9303
9304class GridSizerPtr(GridSizer):
9305 def __init__(self, this):
9306 self.this = this
9307 if not hasattr(self,"thisown"): self.thisown = 0
9308 self.__class__ = GridSizer
54f9ee45 9309_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
9310
9311#---------------------------------------------------------------------------
9312
54f9ee45
RD
9313FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9314FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9315FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 9316class FlexGridSizer(GridSizer):
248ed943
RD
9317 """
9318 A flex grid sizer is a sizer which lays out its children in a
9319 two-dimensional table with all table cells in one row having the same
9320 height and all cells in one column having the same width, but all
9321 rows or all columns are not necessarily the same height or width as in
9322 the `wx.GridSizer`.
9323
9324 wx.FlexGridSizer can also size items equally in one direction but
9325 unequally ("flexibly") in the other. If the sizer is only flexible
9326 in one direction (this can be changed using `SetFlexibleDirection`), it
9327 needs to be decided how the sizer should grow in the other ("non
9328 flexible") direction in order to fill the available space. The
9329 `SetNonFlexibleGrowMode` method serves this purpose.
9330
9331
9332 """
e811c8ce
RD
9333 def __repr__(self):
9334 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9335 def __init__(self, *args, **kwargs):
248ed943
RD
9336 """
9337 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9338
9339 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9340 number of columns and rows in the sizer - if either of the parameters
9341 is zero, it will be calculated to from the total number of children in
9342 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9343 define extra space between all children.
9344 """
54f9ee45 9345 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
9346 self.this = newobj.this
9347 self.thisown = 1
9348 del newobj.thisown
9349 self._setOORInfo(self)
e811c8ce 9350
248ed943
RD
9351 def AddGrowableRow(*args, **kwargs):
9352 """
9353 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 9354
248ed943
RD
9355 Specifies that row *idx* (starting from zero) should be grown if there
9356 is extra space available to the sizer.
e811c8ce 9357
248ed943
RD
9358 The *proportion* parameter has the same meaning as the stretch factor
9359 for the box sizers except that if all proportions are 0, then all
9360 columns are resized equally (instead of not being resized at all).
9361 """
54f9ee45 9362 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
9363
9364 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
9365 """
9366 RemoveGrowableRow(self, size_t idx)
9367
9368 Specifies that row *idx* is no longer growable.
9369 """
54f9ee45 9370 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
9371
9372 def AddGrowableCol(*args, **kwargs):
248ed943
RD
9373 """
9374 AddGrowableCol(self, size_t idx, int proportion=0)
9375
9376 Specifies that column *idx* (starting from zero) should be grown if
9377 there is extra space available to the sizer.
9378
9379 The *proportion* parameter has the same meaning as the stretch factor
9380 for the box sizers except that if all proportions are 0, then all
9381 columns are resized equally (instead of not being resized at all).
9382 """
54f9ee45 9383 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
9384
9385 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
9386 """
9387 RemoveGrowableCol(self, size_t idx)
9388
9389 Specifies that column *idx* is no longer growable.
9390 """
54f9ee45 9391 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
9392
9393 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
9394 """
9395 SetFlexibleDirection(self, int direction)
9396
9397 Specifies whether the sizer should flexibly resize its columns, rows,
9398 or both. Argument *direction* can be one of the following values. Any
9399 other value is ignored.
9400
9401 ============== =======================================
9402 wx.VERTICAL Rows are flexibly sized.
9403 wx.HORIZONTAL Columns are flexibly sized.
9404 wx.BOTH Both rows and columns are flexibly sized
9405 (this is the default value).
9406 ============== =======================================
9407
9408 Note that this method does not trigger relayout.
9409
9410 """
54f9ee45 9411 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9412
9413 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
9414 """
9415 GetFlexibleDirection(self) -> int
9416
9417 Returns a value that specifies whether the sizer
9418 flexibly resizes its columns, rows, or both (default).
9419
9420 :see: `SetFlexibleDirection`
9421 """
54f9ee45 9422 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9423
9424 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9425 """
9426 SetNonFlexibleGrowMode(self, int mode)
9427
9428 Specifies how the sizer should grow in the non-flexible direction if
9429 there is one (so `SetFlexibleDirection` must have been called
9430 previously). Argument *mode* can be one of the following values:
9431
9432 ========================== =================================================
9433 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9434 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9435 `AddGrowableCol` and `AddGrowableRow`. In this
9436 case equal sizing applies to minimum sizes of
9437 columns or rows (this is the default value).
9438 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9439 the non flexible direction, whether they are
9440 growable or not in the flexbile direction.
9441 ========================== =================================================
9442
9443 Note that this method does not trigger relayout.
9444
9445
9446 """
54f9ee45 9447 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9448
9449 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9450 """
9451 GetNonFlexibleGrowMode(self) -> int
9452
9453 Returns the value that specifies how the sizer grows in the
9454 non-flexible direction if there is one.
9455
9456 :see: `SetNonFlexibleGrowMode`
9457 """
54f9ee45 9458 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9459
9460 def GetRowHeights(*args, **kwargs):
248ed943 9461 """GetRowHeights(self) -> list"""
54f9ee45 9462 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
9463
9464 def GetColWidths(*args, **kwargs):
248ed943 9465 """GetColWidths(self) -> list"""
54f9ee45 9466 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 9467
d14a1e28
RD
9468
9469class FlexGridSizerPtr(FlexGridSizer):
9470 def __init__(self, this):
9471 self.this = this
9472 if not hasattr(self,"thisown"): self.thisown = 0
9473 self.__class__ = FlexGridSizer
54f9ee45 9474_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28
RD
9475
9476#---------------------------------------------------------------------------
9477
9478class GBPosition(object):
248ed943
RD
9479 """
9480 This class represents the position of an item in a virtual grid of
9481 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9482 typemaps that will automatically convert from a 2-element sequence of
9483 integers to a wx.GBPosition, so you can use the more pythonic
9484 representation of the position nearly transparently in Python code.
9485 """
e811c8ce
RD
9486 def __repr__(self):
9487 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9488 def __init__(self, *args, **kwargs):
248ed943
RD
9489 """
9490 __init__(self, int row=0, int col=0) -> GBPosition
9491
9492 This class represents the position of an item in a virtual grid of
9493 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9494 typemaps that will automatically convert from a 2-element sequence of
9495 integers to a wx.GBPosition, so you can use the more pythonic
9496 representation of the position nearly transparently in Python code.
9497 """
54f9ee45 9498 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
9499 self.this = newobj.this
9500 self.thisown = 1
9501 del newobj.thisown
e811c8ce 9502 def GetRow(*args, **kwargs):
a95a7133 9503 """GetRow(self) -> int"""
54f9ee45 9504 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
9505
9506 def GetCol(*args, **kwargs):
a95a7133 9507 """GetCol(self) -> int"""
54f9ee45 9508 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
9509
9510 def SetRow(*args, **kwargs):
a95a7133 9511 """SetRow(self, int row)"""
54f9ee45 9512 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
9513
9514 def SetCol(*args, **kwargs):
a95a7133 9515 """SetCol(self, int col)"""
54f9ee45 9516 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
9517
9518 def __eq__(*args, **kwargs):
a95a7133 9519 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 9520 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
9521
9522 def __ne__(*args, **kwargs):
a95a7133 9523 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 9524 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
9525
9526 def Set(*args, **kwargs):
a95a7133 9527 """Set(self, int row=0, int col=0)"""
54f9ee45 9528 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
9529
9530 def Get(*args, **kwargs):
a95a7133 9531 """Get(self) -> PyObject"""
54f9ee45 9532 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 9533
41e2b43e 9534 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9535 def __str__(self): return str(self.Get())
9536 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9537 def __len__(self): return len(self.Get())
9538 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9539 def __setitem__(self, index, val):
9540 if index == 0: self.SetRow(val)
9541 elif index == 1: self.SetCol(val)
9542 else: raise IndexError
e811c8ce 9543 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9544 __safe_for_unpickling__ = True
9545 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
9546
9547 row = property(GetRow, SetRow)
9548 col = property(GetCol, SetCol)
9549
9550
9551class GBPositionPtr(GBPosition):
9552 def __init__(self, this):
9553 self.this = this
9554 if not hasattr(self,"thisown"): self.thisown = 0
9555 self.__class__ = GBPosition
54f9ee45 9556_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
9557
9558class GBSpan(object):
248ed943
RD
9559 """
9560 This class is used to hold the row and column spanning attributes of
9561 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9562 automatically convert from a 2-element sequence of integers to a
9563 wx.GBSpan, so you can use the more pythonic representation of the span
9564 nearly transparently in Python code.
9565
9566 """
e811c8ce
RD
9567 def __repr__(self):
9568 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9569 def __init__(self, *args, **kwargs):
248ed943
RD
9570 """
9571 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9572
9573 Construct a new wxGBSpan, optionally setting the rowspan and
9574 colspan. The default is (1,1). (Meaning that the item occupies one
9575 cell in each direction.
9576 """
54f9ee45 9577 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
9578 self.this = newobj.this
9579 self.thisown = 1
9580 del newobj.thisown
e811c8ce 9581 def GetRowspan(*args, **kwargs):
a95a7133 9582 """GetRowspan(self) -> int"""
54f9ee45 9583 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
9584
9585 def GetColspan(*args, **kwargs):
a95a7133 9586 """GetColspan(self) -> int"""
54f9ee45 9587 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
9588
9589 def SetRowspan(*args, **kwargs):
a95a7133 9590 """SetRowspan(self, int rowspan)"""
54f9ee45 9591 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
9592
9593 def SetColspan(*args, **kwargs):
a95a7133 9594 """SetColspan(self, int colspan)"""
54f9ee45 9595 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
9596
9597 def __eq__(*args, **kwargs):
a95a7133 9598 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 9599 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
9600
9601 def __ne__(*args, **kwargs):
a95a7133 9602 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 9603 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
9604
9605 def Set(*args, **kwargs):
a95a7133 9606 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 9607 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
9608
9609 def Get(*args, **kwargs):
a95a7133 9610 """Get(self) -> PyObject"""
54f9ee45 9611 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 9612
41e2b43e 9613 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9614 def __str__(self): return str(self.Get())
9615 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
9616 def __len__(self): return len(self.Get())
9617 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9618 def __setitem__(self, index, val):
9619 if index == 0: self.SetRowspan(val)
9620 elif index == 1: self.SetColspan(val)
9621 else: raise IndexError
e811c8ce 9622 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9623 __safe_for_unpickling__ = True
9624 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
9625
9626 rowspan = property(GetRowspan, SetRowspan)
9627 colspan = property(GetColspan, SetColspan)
9628
9629
9630class GBSpanPtr(GBSpan):
9631 def __init__(self, this):
9632 self.this = this
9633 if not hasattr(self,"thisown"): self.thisown = 0
9634 self.__class__ = GBSpan
54f9ee45 9635_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
9636
9637class GBSizerItem(SizerItem):
248ed943
RD
9638 """
9639 The wx.GBSizerItem class is used to track the additional data about
9640 items in a `wx.GridBagSizer` such as the item's position in the grid
9641 and how many rows or columns it spans.
9642
9643 """
e811c8ce
RD
9644 def __repr__(self):
9645 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9646 def __init__(self, *args, **kwargs):
248ed943
RD
9647 """
9648 __init__(self) -> GBSizerItem
9649
9650 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
9651 size will need to be set, as well as a position and span before this
9652 item can be used in a Sizer.
9653
9654 You will probably never need to create a wx.GBSizerItem directly as they
9655 are created automatically when the sizer's Add method is called.
9656 """
54f9ee45 9657 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
9658 self.this = newobj.this
9659 self.thisown = 1
9660 del newobj.thisown
e811c8ce 9661 def GetPos(*args, **kwargs):
248ed943
RD
9662 """
9663 GetPos(self) -> GBPosition
9664
9665 Get the grid position of the item
9666 """
54f9ee45 9667 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
9668
9669 def GetPosTuple(self): return self.GetPos().Get()
9670 def GetSpan(*args, **kwargs):
248ed943
RD
9671 """
9672 GetSpan(self) -> GBSpan
9673
9674 Get the row and column spanning of the item
9675 """
54f9ee45 9676 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
9677
9678 def GetSpanTuple(self): return self.GetSpan().Get()
9679 def SetPos(*args, **kwargs):
248ed943
RD
9680 """
9681 SetPos(self, GBPosition pos) -> bool
9682
9683 If the item is already a member of a sizer then first ensure that
9684 there is no other item that would intersect with this one at the new
9685 position, then set the new position. Returns True if the change is
9686 successful and after the next Layout() the item will be moved.
9687 """
54f9ee45 9688 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
9689
9690 def SetSpan(*args, **kwargs):
248ed943
RD
9691 """
9692 SetSpan(self, GBSpan span) -> bool
9693
9694 If the item is already a member of a sizer then first ensure that
9695 there is no other item that would intersect with this one with its new
9696 spanning size, then set the new spanning. Returns True if the change
9697 is successful and after the next Layout() the item will be resized.
9698
9699 """
54f9ee45 9700 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 9701
248ed943 9702 def Intersects(*args, **kwargs):
0df68c9f 9703 """
a95a7133 9704 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
9705
9706 Returns True if this item and the other item instersect.
0df68c9f 9707 """
248ed943
RD
9708 return _core_.GBSizerItem_Intersects(*args, **kwargs)
9709
9710 def IntersectsPos(*args, **kwargs):
9711 """
9712 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
9713
9714 Returns True if the given pos/span would intersect with this item.
9715 """
9716 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
9717
9718 def GetEndPos(*args, **kwargs):
248ed943
RD
9719 """
9720 GetEndPos(self) -> GBPosition
9721
9722 Get the row and column of the endpoint of this item.
9723 """
54f9ee45 9724 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
9725
9726 def GetGBSizer(*args, **kwargs):
248ed943
RD
9727 """
9728 GetGBSizer(self) -> GridBagSizer
9729
9730 Get the sizer this item is a member of.
9731 """
54f9ee45 9732 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
9733
9734 def SetGBSizer(*args, **kwargs):
248ed943
RD
9735 """
9736 SetGBSizer(self, GridBagSizer sizer)
9737
9738 Set the sizer this item is a member of.
9739 """
54f9ee45 9740 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 9741
d14a1e28
RD
9742
9743class GBSizerItemPtr(GBSizerItem):
9744 def __init__(self, this):
9745 self.this = this
9746 if not hasattr(self,"thisown"): self.thisown = 0
9747 self.__class__ = GBSizerItem
54f9ee45 9748_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
9749DefaultSpan = cvar.DefaultSpan
9750
9751def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
9752 """
9753 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9754 int border, PyObject userData=None) -> GBSizerItem
9755
9756 Construct a `wx.GBSizerItem` for a window.
0df68c9f 9757 """
54f9ee45 9758 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
9759 val.thisown = 1
9760 return val
9761
9762def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
9763 """
9764 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9765 int border, PyObject userData=None) -> GBSizerItem
9766
9767 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 9768 """
54f9ee45 9769 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
9770 val.thisown = 1
9771 return val
9772
9773def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
9774 """
9775 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
9776 int flag, int border, PyObject userData=None) -> GBSizerItem
9777
9778 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 9779 """
54f9ee45 9780 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9781 val.thisown = 1
9782 return val
9783
9784class GridBagSizer(FlexGridSizer):
248ed943
RD
9785 """
9786 A `wx.Sizer` that can lay out items in a virtual grid like a
9787 `wx.FlexGridSizer` but in this case explicit positioning of the items
9788 is allowed using `wx.GBPosition`, and items can optionally span more
9789 than one row and/or column using `wx.GBSpan`. The total size of the
9790 virtual grid is determined by the largest row and column that items are
9791 positioned at, adjusted for spanning.
9792
9793 """
e811c8ce
RD
9794 def __repr__(self):
9795 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9796 def __init__(self, *args, **kwargs):
248ed943
RD
9797 """
9798 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
9799
9800 Constructor, with optional parameters to specify the gap between the
9801 rows and columns.
9802 """
54f9ee45 9803 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
9804 self.this = newobj.this
9805 self.thisown = 1
9806 del newobj.thisown
e811c8ce 9807 def Add(*args, **kwargs):
0df68c9f 9808 """
248ed943
RD
9809 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
9810 int border=0, userData=None)
9811
9812 Adds an item to the sizer at the grid cell *pos*, optionally spanning
9813 more than one row or column as specified with *span*. The remaining
9814 args behave similarly to `wx.Sizer.Add`.
9815
9816 Returns True if the item was successfully placed at the given cell
9817 position, False if something was already there.
9818
0df68c9f 9819 """
54f9ee45 9820 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
9821
9822 def AddItem(*args, **kwargs):
248ed943
RD
9823 """
9824 Add(self, GBSizerItem item) -> bool
9825
9826 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
9827 the item was successfully placed at its given cell position, False if
9828 something was already there.
9829 """
54f9ee45 9830 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce
RD
9831
9832 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
9833 """
9834 GetEmptyCellSize(self) -> Size
9835
9836 Get the size used for cells in the grid with no item.
9837 """
54f9ee45 9838 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
9839
9840 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
9841 """
9842 SetEmptyCellSize(self, Size sz)
9843
9844 Set the size used for cells in the grid with no item.
9845 """
54f9ee45 9846 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
9847
9848 def GetItemPosition(*args):
0df68c9f 9849 """
248ed943
RD
9850 GetItemPosition(self, item) -> GBPosition
9851
9852 Get the grid position of the specified *item* where *item* is either a
9853 window or subsizer that is a member of this sizer, or a zero-based
9854 index of an item.
0df68c9f 9855 """
54f9ee45 9856 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
9857
9858 def SetItemPosition(*args):
0df68c9f 9859 """
248ed943
RD
9860 SetItemPosition(self, item, GBPosition pos) -> bool
9861
9862 Set the grid position of the specified *item* where *item* is either a
9863 window or subsizer that is a member of this sizer, or a zero-based
9864 index of an item. Returns True on success. If the move is not
9865 allowed (because an item is already there) then False is returned.
9866
0df68c9f 9867 """
54f9ee45 9868 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
9869
9870 def GetItemSpan(*args):
0df68c9f 9871 """
248ed943
RD
9872 GetItemSpan(self, item) -> GBSpan
9873
9874 Get the row/col spanning of the specified *item* where *item* is
9875 either a window or subsizer that is a member of this sizer, or a
9876 zero-based index of an item.
0df68c9f 9877 """
54f9ee45 9878 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
9879
9880 def SetItemSpan(*args):
0df68c9f 9881 """
248ed943
RD
9882 SetItemSpan(self, item, GBSpan span) -> bool
9883
9884 Set the row/col spanning of the specified *item* where *item* is
9885 either a window or subsizer that is a member of this sizer, or a
9886 zero-based index of an item. Returns True on success. If the move is
9887 not allowed (because an item is already there) then False is returned.
0df68c9f 9888 """
54f9ee45 9889 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
9890
9891 def FindItem(*args):
0df68c9f 9892 """
248ed943
RD
9893 FindItem(self, item) -> GBSizerItem
9894
9895 Find the sizer item for the given window or subsizer, returns None if
9896 not found. (non-recursive)
0df68c9f 9897 """
54f9ee45 9898 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
9899
9900 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
9901 """
9902 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
9903
9904 Return the sizer item for the given grid cell, or None if there is no
9905 item at that position. (non-recursive)
9906 """
54f9ee45 9907 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
9908
9909 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
9910 """
9911 FindItemAtPoint(self, Point pt) -> GBSizerItem
9912
9913 Return the sizer item located at the point given in *pt*, or None if
9914 there is no item at that point. The (x,y) coordinates in pt correspond
9915 to the client coordinates of the window using the sizer for
9916 layout. (non-recursive)
9917 """
54f9ee45 9918 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 9919
248ed943
RD
9920 def CheckForIntersection(*args, **kwargs):
9921 """
9922 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 9923
248ed943
RD
9924 Look at all items and see if any intersect (or would overlap) the
9925 given *item*. Returns True if so, False if there would be no overlap.
9926 If an *excludeItem* is given then it will not be checked for
9927 intersection, for example it may be the item we are checking the
9928 position of.
e811c8ce 9929
248ed943
RD
9930 """
9931 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 9932
248ed943 9933 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 9934 """
248ed943
RD
9935 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
9936
9937 Look at all items and see if any intersect (or would overlap) the
9938 given position and span. Returns True if so, False if there would be
9939 no overlap. If an *excludeItem* is given then it will not be checked
9940 for intersection, for example it may be the item we are checking the
9941 position of.
0df68c9f 9942 """
248ed943 9943 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 9944
d14a1e28
RD
9945
9946class GridBagSizerPtr(GridBagSizer):
9947 def __init__(self, this):
9948 self.this = this
9949 if not hasattr(self,"thisown"): self.thisown = 0
9950 self.__class__ = GridBagSizer
54f9ee45 9951_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
9952
9953#---------------------------------------------------------------------------
9954
54f9ee45
RD
9955Left = _core_.Left
9956Top = _core_.Top
9957Right = _core_.Right
9958Bottom = _core_.Bottom
9959Width = _core_.Width
9960Height = _core_.Height
9961Centre = _core_.Centre
9962Center = _core_.Center
9963CentreX = _core_.CentreX
9964CentreY = _core_.CentreY
9965Unconstrained = _core_.Unconstrained
9966AsIs = _core_.AsIs
9967PercentOf = _core_.PercentOf
9968Above = _core_.Above
9969Below = _core_.Below
9970LeftOf = _core_.LeftOf
9971RightOf = _core_.RightOf
9972SameAs = _core_.SameAs
9973Absolute = _core_.Absolute
d14a1e28 9974class IndividualLayoutConstraint(Object):
15afbcd0 9975 """
41e2b43e
RD
9976 Objects of this class are stored in the `wx.LayoutConstraints` class as
9977 one of eight possible constraints that a window can be involved in.
9978 You will never need to create an instance of
9979 wx.IndividualLayoutConstraint, rather you should create a
9980 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 9981 that it contains.
15afbcd0 9982 """
d14a1e28
RD
9983 def __init__(self): raise RuntimeError, "No constructor defined"
9984 def __repr__(self):
9985 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 9986 def Set(*args, **kwargs):
41e2b43e
RD
9987 """
9988 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
9989
9990 Sets the properties of the constraint. Normally called by one of the
9991 convenience functions such as Above, RightOf, SameAs.
9992 """
54f9ee45 9993 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
9994
9995 def LeftOf(*args, **kwargs):
15afbcd0 9996 """
a95a7133 9997 LeftOf(self, Window sibling, int marg=0)
15afbcd0 9998
41e2b43e
RD
9999 Constrains this edge to be to the left of the given window, with an
10000 optional margin. Implicitly, this is relative to the left edge of the
10001 other window.
15afbcd0 10002 """
54f9ee45 10003 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
10004
10005 def RightOf(*args, **kwargs):
15afbcd0 10006 """
a95a7133 10007 RightOf(self, Window sibling, int marg=0)
15afbcd0 10008
41e2b43e
RD
10009 Constrains this edge to be to the right of the given window, with an
10010 optional margin. Implicitly, this is relative to the right edge of the
10011 other window.
15afbcd0 10012 """
54f9ee45 10013 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
10014
10015 def Above(*args, **kwargs):
15afbcd0 10016 """
a95a7133 10017 Above(self, Window sibling, int marg=0)
15afbcd0 10018
41e2b43e
RD
10019 Constrains this edge to be above the given window, with an optional
10020 margin. Implicitly, this is relative to the top edge of the other
10021 window.
15afbcd0 10022 """
54f9ee45 10023 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
10024
10025 def Below(*args, **kwargs):
15afbcd0 10026 """
a95a7133 10027 Below(self, Window sibling, int marg=0)
15afbcd0 10028
41e2b43e
RD
10029 Constrains this edge to be below the given window, with an optional
10030 margin. Implicitly, this is relative to the bottom edge of the other
10031 window.
15afbcd0 10032 """
54f9ee45 10033 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
10034
10035 def SameAs(*args, **kwargs):
15afbcd0 10036 """
a95a7133 10037 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 10038
41e2b43e
RD
10039 Constrains this edge or dimension to be to the same as the edge of the
10040 given window, with an optional margin.
15afbcd0 10041 """
54f9ee45 10042 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
10043
10044 def PercentOf(*args, **kwargs):
15afbcd0 10045 """
a95a7133 10046 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 10047
41e2b43e
RD
10048 Constrains this edge or dimension to be to a percentage of the given
10049 window, with an optional margin.
15afbcd0 10050 """
54f9ee45 10051 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
10052
10053 def Absolute(*args, **kwargs):
15afbcd0 10054 """
a95a7133 10055 Absolute(self, int val)
15afbcd0 10056
41e2b43e 10057 Constrains this edge or dimension to be the given absolute value.
15afbcd0 10058 """
54f9ee45 10059 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
10060
10061 def Unconstrained(*args, **kwargs):
15afbcd0 10062 """
a95a7133 10063 Unconstrained(self)
15afbcd0 10064
41e2b43e
RD
10065 Sets this edge or dimension to be unconstrained, that is, dependent on
10066 other edges and dimensions from which this value can be deduced.
15afbcd0 10067 """
54f9ee45 10068 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
10069
10070 def AsIs(*args, **kwargs):
15afbcd0 10071 """
a95a7133 10072 AsIs(self)
15afbcd0 10073
41e2b43e
RD
10074 Sets this edge or constraint to be whatever the window's value is at
10075 the moment. If either of the width and height constraints are *as is*,
10076 the window will not be resized, but moved instead. This is important
10077 when considering panel items which are intended to have a default
10078 size, such as a button, which may take its size from the size of the
10079 button label.
15afbcd0 10080 """
54f9ee45 10081 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
10082
10083 def GetOtherWindow(*args, **kwargs):
a95a7133 10084 """GetOtherWindow(self) -> Window"""
54f9ee45 10085 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
10086
10087 def GetMyEdge(*args, **kwargs):
a95a7133 10088 """GetMyEdge(self) -> int"""
54f9ee45 10089 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
10090
10091 def SetEdge(*args, **kwargs):
a95a7133 10092 """SetEdge(self, int which)"""
54f9ee45 10093 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
10094
10095 def SetValue(*args, **kwargs):
a95a7133 10096 """SetValue(self, int v)"""
54f9ee45 10097 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
10098
10099 def GetMargin(*args, **kwargs):
a95a7133 10100 """GetMargin(self) -> int"""
54f9ee45 10101 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
10102
10103 def SetMargin(*args, **kwargs):
a95a7133 10104 """SetMargin(self, int m)"""
54f9ee45 10105 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
10106
10107 def GetValue(*args, **kwargs):
a95a7133 10108 """GetValue(self) -> int"""
54f9ee45 10109 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
10110
10111 def GetPercent(*args, **kwargs):
a95a7133 10112 """GetPercent(self) -> int"""
54f9ee45 10113 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
10114
10115 def GetOtherEdge(*args, **kwargs):
a95a7133 10116 """GetOtherEdge(self) -> int"""
54f9ee45 10117 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
10118
10119 def GetDone(*args, **kwargs):
a95a7133 10120 """GetDone(self) -> bool"""
54f9ee45 10121 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
10122
10123 def SetDone(*args, **kwargs):
a95a7133 10124 """SetDone(self, bool d)"""
54f9ee45 10125 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
10126
10127 def GetRelationship(*args, **kwargs):
a95a7133 10128 """GetRelationship(self) -> int"""
54f9ee45 10129 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
10130
10131 def SetRelationship(*args, **kwargs):
a95a7133 10132 """SetRelationship(self, int r)"""
54f9ee45 10133 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
10134
10135 def ResetIfWin(*args, **kwargs):
15afbcd0 10136 """
a95a7133 10137 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
10138
10139 Reset constraint if it mentions otherWin
10140 """
54f9ee45 10141 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
10142
10143 def SatisfyConstraint(*args, **kwargs):
15afbcd0 10144 """
a95a7133 10145 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
10146
10147 Try to satisfy constraint
10148 """
54f9ee45 10149 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
10150
10151 def GetEdge(*args, **kwargs):
15afbcd0 10152 """
a95a7133 10153 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
10154
10155 Get the value of this edge or dimension, or if this
10156 is not determinable, -1.
10157 """
54f9ee45 10158 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 10159
d14a1e28
RD
10160
10161class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10162 def __init__(self, this):
10163 self.this = this
10164 if not hasattr(self,"thisown"): self.thisown = 0
10165 self.__class__ = IndividualLayoutConstraint
54f9ee45 10166_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
10167
10168class LayoutConstraints(Object):
15afbcd0 10169 """
41e2b43e
RD
10170 **Note:** constraints are now deprecated and you should use sizers
10171 instead.
15afbcd0 10172
41e2b43e
RD
10173 Objects of this class can be associated with a window to define its
10174 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
10175
10176 The class consists of the following eight constraints of class
10177 wx.IndividualLayoutConstraint, some or all of which should be accessed
10178 directly to set the appropriate constraints.
10179
10180 * left: represents the left hand edge of the window
10181 * right: represents the right hand edge of the window
10182 * top: represents the top edge of the window
10183 * bottom: represents the bottom edge of the window
10184 * width: represents the width of the window
10185 * height: represents the height of the window
10186 * centreX: represents the horizontal centre point of the window
10187 * centreY: represents the vertical centre point of the window
10188
41e2b43e
RD
10189 Most constraints are initially set to have the relationship
10190 wxUnconstrained, which means that their values should be calculated by
10191 looking at known constraints. The exceptions are width and height,
10192 which are set to wxAsIs to ensure that if the user does not specify a
10193 constraint, the existing width and height will be used, to be
10194 compatible with panel items which often have take a default size. If
10195 the constraint is ``wx.AsIs``, the dimension will not be changed.
10196
10197 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
10198
10199 """
e811c8ce
RD
10200 def __repr__(self):
10201 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
10202 left = property(_core_.LayoutConstraints_left_get)
10203 top = property(_core_.LayoutConstraints_top_get)
10204 right = property(_core_.LayoutConstraints_right_get)
10205 bottom = property(_core_.LayoutConstraints_bottom_get)
10206 width = property(_core_.LayoutConstraints_width_get)
10207 height = property(_core_.LayoutConstraints_height_get)
10208 centreX = property(_core_.LayoutConstraints_centreX_get)
10209 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 10210 def __init__(self, *args, **kwargs):
a95a7133 10211 """__init__(self) -> LayoutConstraints"""
54f9ee45 10212 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
10213 self.this = newobj.this
10214 self.thisown = 1
10215 del newobj.thisown
e811c8ce 10216 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 10217 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 10218 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
10219
10220 def AreSatisfied(*args, **kwargs):
a95a7133 10221 """AreSatisfied(self) -> bool"""
54f9ee45 10222 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 10223
d14a1e28
RD
10224
10225class LayoutConstraintsPtr(LayoutConstraints):
10226 def __init__(self, this):
10227 self.this = this
10228 if not hasattr(self,"thisown"): self.thisown = 0
10229 self.__class__ = LayoutConstraints
54f9ee45 10230_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
10231
10232#----------------------------------------------------------------------------
10233
322913ce 10234# Use Python's bool constants if available, make some if not
d14a1e28
RD
10235try:
10236 True
10237except NameError:
322913ce
RD
10238 __builtins__.True = 1==1
10239 __builtins__.False = 1==0
4f89f6a3
RD
10240 def bool(value): return not not value
10241 __builtins__.bool = bool
d14a1e28 10242
d14a1e28
RD
10243
10244
10245# workarounds for bad wxRTTI names
10246__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10247__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10248__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10249
10250
10251#----------------------------------------------------------------------------
10252# Load version numbers from __version__... Ensure that major and minor
10253# versions are the same for both wxPython and wxWindows.
10254
10255from __version__ import *
10256__version__ = VERSION_STRING
10257
54f9ee45
RD
10258assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
10259assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
10260if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28
RD
10261 import warnings
10262 warnings.warn("wxPython/wxWindows release number mismatch")
10263
10264#----------------------------------------------------------------------------
10265
10266class PyDeadObjectError(AttributeError):
10267 pass
10268
d14a1e28
RD
10269class _wxPyDeadObject(object):
10270 """
10271 Instances of wx objects that are OOR capable will have their __class__
10272 changed to this class when the C++ object is deleted. This should help
10273 prevent crashes due to referencing a bogus C++ pointer.
10274 """
10275 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10276 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10277
3a04f143 10278 def __repr__(self):
d14a1e28
RD
10279 if not hasattr(self, "_name"):
10280 self._name = "[unknown]"
10281 return self.reprStr % self._name
10282
3a04f143 10283 def __getattr__(self, *args):
d14a1e28
RD
10284 if not hasattr(self, "_name"):
10285 self._name = "[unknown]"
3a04f143
RD
10286 raise PyDeadObjectError(self.attrStr % self._name)
10287
10288 def __nonzero__(self):
10289 return 0
10290
10291
10292
10293class PyUnbornObjectError(AttributeError):
10294 pass
10295
10296class _wxPyUnbornObject(object):
10297 """
54f9ee45 10298 Some stock objects are created when the wx._core module is
3a04f143
RD
10299 imported, but their C++ instance is not created until the wx.App
10300 object is created and initialized. These object instances will
10301 temporarily have their __class__ changed to this class so an
10302 exception will be raised if they are used before the C++ instance
10303 is ready.
10304 """
10305
10306 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10307 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10308
10309 def __repr__(self):
10310 #if not hasattr(self, "_name"):
10311 # self._name = "[unknown]"
10312 return self.reprStr #% self._name
10313
10314 def __getattr__(self, *args):
10315 #if not hasattr(self, "_name"):
10316 # self._name = "[unknown]"
10317 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
10318
10319 def __nonzero__(self):
10320 return 0
10321
10322
10323#----------------------------------------------------------------------------
10324_wxPyCallAfterId = None
10325
10326def CallAfter(callable, *args, **kw):
10327 """
10328 Call the specified function after the current and pending event
10329 handlers have been completed. This is also good for making GUI
61863841
RD
10330 method calls from non-GUI threads. Any extra positional or
10331 keyword args are passed on to the callable when it is called.
10332
10333 :see: `wx.FutureCall`
d14a1e28
RD
10334 """
10335 app = wx.GetApp()
10336 assert app, 'No wxApp created yet'
10337
10338 global _wxPyCallAfterId
10339 if _wxPyCallAfterId is None:
10340 _wxPyCallAfterId = wx.NewEventType()
10341 app.Connect(-1, -1, _wxPyCallAfterId,
10342 lambda event: event.callable(*event.args, **event.kw) )
10343 evt = wx.PyEvent()
10344 evt.SetEventType(_wxPyCallAfterId)
10345 evt.callable = callable
10346 evt.args = args
10347 evt.kw = kw
10348 wx.PostEvent(app, evt)
10349
10350
10351#----------------------------------------------------------------------------
10352
10353
10354class FutureCall:
10355 """
4276dc52 10356 A convenience class for wx.Timer, that calls the given callable
d14a1e28
RD
10357 object once after the given amount of milliseconds, passing any
10358 positional or keyword args. The return value of the callable is
61863841 10359 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
10360
10361 If you don't need to get the return value or restart the timer
10362 then there is no need to hold a reference to this object. It will
10363 hold a reference to itself while the timer is running (the timer
10364 has a reference to self.Notify) but the cycle will be broken when
10365 the timer completes, automatically cleaning up the wx.FutureCall
10366 object.
61863841
RD
10367
10368 :see: `wx.CallAfter`
d14a1e28
RD
10369 """
10370 def __init__(self, millis, callable, *args, **kwargs):
10371 self.millis = millis
10372 self.callable = callable
10373 self.SetArgs(*args, **kwargs)
10374 self.runCount = 0
4276dc52 10375 self.running = False
d14a1e28
RD
10376 self.hasRun = False
10377 self.result = None
10378 self.timer = None
10379 self.Start()
10380
10381 def __del__(self):
10382 self.Stop()
10383
10384
10385 def Start(self, millis=None, *args, **kwargs):
10386 """
10387 (Re)start the timer
10388 """
10389 self.hasRun = False
10390 if millis is not None:
10391 self.millis = millis
10392 if args or kwargs:
10393 self.SetArgs(*args, **kwargs)
10394 self.Stop()
10395 self.timer = wx.PyTimer(self.Notify)
10396 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 10397 self.running = True
d14a1e28
RD
10398 Restart = Start
10399
10400
10401 def Stop(self):
10402 """
10403 Stop and destroy the timer.
10404 """
10405 if self.timer is not None:
10406 self.timer.Stop()
10407 self.timer = None
10408
10409
10410 def GetInterval(self):
10411 if self.timer is not None:
10412 return self.timer.GetInterval()
10413 else:
10414 return 0
10415
10416
10417 def IsRunning(self):
10418 return self.timer is not None and self.timer.IsRunning()
10419
10420
10421 def SetArgs(self, *args, **kwargs):
10422 """
10423 (Re)set the args passed to the callable object. This is
10424 useful in conjunction with Restart if you want to schedule a
10425 new call to the same callable object but with different
10426 parameters.
10427 """
10428 self.args = args
10429 self.kwargs = kwargs
10430
10431
10432 def HasRun(self):
10433 return self.hasRun
10434
10435 def GetResult(self):
10436 return self.result
10437
10438 def Notify(self):
10439 """
10440 The timer has expired so call the callable.
10441 """
10442 if self.callable and getattr(self.callable, 'im_self', True):
10443 self.runCount += 1
4276dc52 10444 self.running = False
d14a1e28
RD
10445 self.result = self.callable(*self.args, **self.kwargs)
10446 self.hasRun = True
4276dc52
RD
10447 if not self.running:
10448 # if it wasn't restarted, then cleanup
10449 wx.CallAfter(self.Stop)
d14a1e28
RD
10450
10451
a95a7133
RD
10452
10453#----------------------------------------------------------------------------
10454# Control which items in this module should be documented by epydoc.
10455# We allow only classes and functions, which will help reduce the size
10456# of the docs by filtering out the zillions of constants, EVT objects,
10457# and etc that don't make much sense by themselves, but are instead
10458# documented (or will be) as part of the classes/functions/methods
10459# where they should be used.
10460
66c033b4
RD
10461class __DocFilter:
10462 """
10463 A filter for epydoc that only allows non-Ptr classes and
10464 fucntions, in order to reduce the clutter in the API docs.
10465 """
10466 def __init__(self, globals):
10467 self._globals = globals
10468
10469 def __call__(self, name):
10470 import types
10471 obj = self._globals.get(name, None)
10472 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10473 return False
10474 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10475 return False
10476 return True
a95a7133 10477
d14a1e28
RD
10478#----------------------------------------------------------------------------
10479#----------------------------------------------------------------------------
10480
10481# Import other modules in this package that should show up in the
10482# "core" wx namespace
54f9ee45
RD
10483from _gdi import *
10484from _windows import *
10485from _controls import *
10486from _misc import *
d14a1e28 10487
3a04f143
RD
10488
10489# Fixup the stock objects since they can't be used yet. (They will be
10490# restored in wx.PyApp.OnInit.)
54f9ee45 10491_core_._wxPyFixStockObjects()
3a04f143 10492
d14a1e28
RD
10493#----------------------------------------------------------------------------
10494#----------------------------------------------------------------------------
10495
10496