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