]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
docstrign tweaks
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
d14a1e28
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
d14a1e28
RD
5
6#// Give a reference to the dictionary of this module to the C++ extension
7#// code.
54f9ee45 8_core_._wxPySetDictionary(vars())
d14a1e28
RD
9
10#// A little trick to make 'wx' be a reference to this module so wx.Names can
11#// be used here.
12import sys as _sys
13wx = _sys.modules[__name__]
14
66c033b4
RD
15
16#----------------------------------------------------------------------------
17
18def _deprecated(callable, msg=None):
19 """
20 Create a wrapper function that will raise a DeprecationWarning
21 before calling the callable.
22 """
23 if msg is None:
24 msg = "%s is deprecated" % callable
25 def deprecatedWrapper(*args, **kwargs):
26 import warnings
27 warnings.warn(msg, DeprecationWarning, stacklevel=2)
28 return callable(*args, **kwargs)
29 deprecatedWrapper.__doc__ = msg
30 return deprecatedWrapper
31
32
33#----------------------------------------------------------------------------
34
54f9ee45
RD
35NOT_FOUND = _core_.NOT_FOUND
36VSCROLL = _core_.VSCROLL
37HSCROLL = _core_.HSCROLL
38CAPTION = _core_.CAPTION
39DOUBLE_BORDER = _core_.DOUBLE_BORDER
40SUNKEN_BORDER = _core_.SUNKEN_BORDER
41RAISED_BORDER = _core_.RAISED_BORDER
42BORDER = _core_.BORDER
43SIMPLE_BORDER = _core_.SIMPLE_BORDER
44STATIC_BORDER = _core_.STATIC_BORDER
45TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
46NO_BORDER = _core_.NO_BORDER
47TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
48WANTS_CHARS = _core_.WANTS_CHARS
49POPUP_WINDOW = _core_.POPUP_WINDOW
50CENTER_FRAME = _core_.CENTER_FRAME
51CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
52CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
53ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
54ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
55ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
56ED_STATIC_LINE = _core_.ED_STATIC_LINE
57EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
58CLIP_CHILDREN = _core_.CLIP_CHILDREN
59CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
60ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
61RETAINED = _core_.RETAINED
62BACKINGSTORE = _core_.BACKINGSTORE
63COLOURED = _core_.COLOURED
64FIXED_LENGTH = _core_.FIXED_LENGTH
65LB_NEEDED_SB = _core_.LB_NEEDED_SB
66LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
67LB_SORT = _core_.LB_SORT
68LB_SINGLE = _core_.LB_SINGLE
69LB_MULTIPLE = _core_.LB_MULTIPLE
70LB_EXTENDED = _core_.LB_EXTENDED
71LB_OWNERDRAW = _core_.LB_OWNERDRAW
72LB_HSCROLL = _core_.LB_HSCROLL
73PROCESS_ENTER = _core_.PROCESS_ENTER
74PASSWORD = _core_.PASSWORD
75CB_SIMPLE = _core_.CB_SIMPLE
76CB_DROPDOWN = _core_.CB_DROPDOWN
77CB_SORT = _core_.CB_SORT
78CB_READONLY = _core_.CB_READONLY
79RA_HORIZONTAL = _core_.RA_HORIZONTAL
80RA_VERTICAL = _core_.RA_VERTICAL
81RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
82RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
83RB_GROUP = _core_.RB_GROUP
84RB_SINGLE = _core_.RB_SINGLE
85SL_HORIZONTAL = _core_.SL_HORIZONTAL
86SL_VERTICAL = _core_.SL_VERTICAL
87SL_AUTOTICKS = _core_.SL_AUTOTICKS
88SL_LABELS = _core_.SL_LABELS
89SL_LEFT = _core_.SL_LEFT
90SL_TOP = _core_.SL_TOP
91SL_RIGHT = _core_.SL_RIGHT
92SL_BOTTOM = _core_.SL_BOTTOM
93SL_BOTH = _core_.SL_BOTH
94SL_SELRANGE = _core_.SL_SELRANGE
95SB_HORIZONTAL = _core_.SB_HORIZONTAL
96SB_VERTICAL = _core_.SB_VERTICAL
97ST_SIZEGRIP = _core_.ST_SIZEGRIP
98ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
99FLOOD_SURFACE = _core_.FLOOD_SURFACE
100FLOOD_BORDER = _core_.FLOOD_BORDER
101ODDEVEN_RULE = _core_.ODDEVEN_RULE
102WINDING_RULE = _core_.WINDING_RULE
103TOOL_TOP = _core_.TOOL_TOP
104TOOL_BOTTOM = _core_.TOOL_BOTTOM
105TOOL_LEFT = _core_.TOOL_LEFT
106TOOL_RIGHT = _core_.TOOL_RIGHT
107OK = _core_.OK
108YES_NO = _core_.YES_NO
109CANCEL = _core_.CANCEL
110YES = _core_.YES
111NO = _core_.NO
112NO_DEFAULT = _core_.NO_DEFAULT
113YES_DEFAULT = _core_.YES_DEFAULT
114ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
115ICON_HAND = _core_.ICON_HAND
116ICON_QUESTION = _core_.ICON_QUESTION
117ICON_INFORMATION = _core_.ICON_INFORMATION
118ICON_STOP = _core_.ICON_STOP
119ICON_ASTERISK = _core_.ICON_ASTERISK
120ICON_MASK = _core_.ICON_MASK
121ICON_WARNING = _core_.ICON_WARNING
122ICON_ERROR = _core_.ICON_ERROR
123FORWARD = _core_.FORWARD
124BACKWARD = _core_.BACKWARD
125RESET = _core_.RESET
126HELP = _core_.HELP
127MORE = _core_.MORE
128SETUP = _core_.SETUP
129SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
130SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
131SIZE_AUTO = _core_.SIZE_AUTO
132SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
133SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
134PORTRAIT = _core_.PORTRAIT
135LANDSCAPE = _core_.LANDSCAPE
136PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
137PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
138PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
139PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
140ID_ANY = _core_.ID_ANY
141ID_SEPARATOR = _core_.ID_SEPARATOR
142ID_LOWEST = _core_.ID_LOWEST
143ID_OPEN = _core_.ID_OPEN
144ID_CLOSE = _core_.ID_CLOSE
145ID_NEW = _core_.ID_NEW
146ID_SAVE = _core_.ID_SAVE
147ID_SAVEAS = _core_.ID_SAVEAS
148ID_REVERT = _core_.ID_REVERT
149ID_EXIT = _core_.ID_EXIT
150ID_UNDO = _core_.ID_UNDO
151ID_REDO = _core_.ID_REDO
152ID_HELP = _core_.ID_HELP
153ID_PRINT = _core_.ID_PRINT
154ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
155ID_PREVIEW = _core_.ID_PREVIEW
156ID_ABOUT = _core_.ID_ABOUT
157ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
158ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
159ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
160ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
161ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
162ID_PREFERENCES = _core_.ID_PREFERENCES
163ID_CUT = _core_.ID_CUT
164ID_COPY = _core_.ID_COPY
165ID_PASTE = _core_.ID_PASTE
166ID_CLEAR = _core_.ID_CLEAR
167ID_FIND = _core_.ID_FIND
168ID_DUPLICATE = _core_.ID_DUPLICATE
169ID_SELECTALL = _core_.ID_SELECTALL
170ID_DELETE = _core_.ID_DELETE
171ID_REPLACE = _core_.ID_REPLACE
172ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
173ID_PROPERTIES = _core_.ID_PROPERTIES
174ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
175ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
176ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
177ID_VIEW_LIST = _core_.ID_VIEW_LIST
178ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
179ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
180ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
181ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
182ID_FILE1 = _core_.ID_FILE1
183ID_FILE2 = _core_.ID_FILE2
184ID_FILE3 = _core_.ID_FILE3
185ID_FILE4 = _core_.ID_FILE4
186ID_FILE5 = _core_.ID_FILE5
187ID_FILE6 = _core_.ID_FILE6
188ID_FILE7 = _core_.ID_FILE7
189ID_FILE8 = _core_.ID_FILE8
190ID_FILE9 = _core_.ID_FILE9
191ID_OK = _core_.ID_OK
192ID_CANCEL = _core_.ID_CANCEL
193ID_APPLY = _core_.ID_APPLY
194ID_YES = _core_.ID_YES
195ID_NO = _core_.ID_NO
196ID_STATIC = _core_.ID_STATIC
197ID_FORWARD = _core_.ID_FORWARD
198ID_BACKWARD = _core_.ID_BACKWARD
199ID_DEFAULT = _core_.ID_DEFAULT
200ID_MORE = _core_.ID_MORE
201ID_SETUP = _core_.ID_SETUP
202ID_RESET = _core_.ID_RESET
203ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
204ID_YESTOALL = _core_.ID_YESTOALL
205ID_NOTOALL = _core_.ID_NOTOALL
206ID_ABORT = _core_.ID_ABORT
207ID_RETRY = _core_.ID_RETRY
208ID_IGNORE = _core_.ID_IGNORE
209ID_HIGHEST = _core_.ID_HIGHEST
210OPEN = _core_.OPEN
211SAVE = _core_.SAVE
212HIDE_READONLY = _core_.HIDE_READONLY
213OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
214FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
215MULTIPLE = _core_.MULTIPLE
216CHANGE_DIR = _core_.CHANGE_DIR
217ACCEL_ALT = _core_.ACCEL_ALT
218ACCEL_CTRL = _core_.ACCEL_CTRL
219ACCEL_SHIFT = _core_.ACCEL_SHIFT
220ACCEL_NORMAL = _core_.ACCEL_NORMAL
221PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
222PD_APP_MODAL = _core_.PD_APP_MODAL
223PD_CAN_ABORT = _core_.PD_CAN_ABORT
224PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
225PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
226PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
227DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
228DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
229MENU_TEAROFF = _core_.MENU_TEAROFF
230MB_DOCKABLE = _core_.MB_DOCKABLE
231NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
232FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
233LI_HORIZONTAL = _core_.LI_HORIZONTAL
234LI_VERTICAL = _core_.LI_VERTICAL
235WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
236WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
237WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
238WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
239WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
240WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
241MM_TEXT = _core_.MM_TEXT
242MM_LOMETRIC = _core_.MM_LOMETRIC
243MM_HIMETRIC = _core_.MM_HIMETRIC
244MM_LOENGLISH = _core_.MM_LOENGLISH
245MM_HIENGLISH = _core_.MM_HIENGLISH
246MM_TWIPS = _core_.MM_TWIPS
247MM_ISOTROPIC = _core_.MM_ISOTROPIC
248MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
249MM_POINTS = _core_.MM_POINTS
250MM_METRIC = _core_.MM_METRIC
251CENTRE = _core_.CENTRE
252CENTER = _core_.CENTER
253HORIZONTAL = _core_.HORIZONTAL
254VERTICAL = _core_.VERTICAL
255BOTH = _core_.BOTH
256LEFT = _core_.LEFT
257RIGHT = _core_.RIGHT
258UP = _core_.UP
259DOWN = _core_.DOWN
260TOP = _core_.TOP
261BOTTOM = _core_.BOTTOM
262NORTH = _core_.NORTH
263SOUTH = _core_.SOUTH
264WEST = _core_.WEST
265EAST = _core_.EAST
266ALL = _core_.ALL
267ALIGN_NOT = _core_.ALIGN_NOT
268ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
269ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
270ALIGN_LEFT = _core_.ALIGN_LEFT
271ALIGN_TOP = _core_.ALIGN_TOP
272ALIGN_RIGHT = _core_.ALIGN_RIGHT
273ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
274ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
275ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
276ALIGN_CENTER = _core_.ALIGN_CENTER
277ALIGN_CENTRE = _core_.ALIGN_CENTRE
278ALIGN_MASK = _core_.ALIGN_MASK
279STRETCH_NOT = _core_.STRETCH_NOT
280SHRINK = _core_.SHRINK
281GROW = _core_.GROW
282EXPAND = _core_.EXPAND
283SHAPED = _core_.SHAPED
284FIXED_MINSIZE = _core_.FIXED_MINSIZE
285TILE = _core_.TILE
286ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
287BORDER_DEFAULT = _core_.BORDER_DEFAULT
288BORDER_NONE = _core_.BORDER_NONE
289BORDER_STATIC = _core_.BORDER_STATIC
290BORDER_SIMPLE = _core_.BORDER_SIMPLE
291BORDER_RAISED = _core_.BORDER_RAISED
292BORDER_SUNKEN = _core_.BORDER_SUNKEN
293BORDER_DOUBLE = _core_.BORDER_DOUBLE
294BORDER_MASK = _core_.BORDER_MASK
295DEFAULT = _core_.DEFAULT
296DECORATIVE = _core_.DECORATIVE
297ROMAN = _core_.ROMAN
298SCRIPT = _core_.SCRIPT
299SWISS = _core_.SWISS
300MODERN = _core_.MODERN
301TELETYPE = _core_.TELETYPE
302VARIABLE = _core_.VARIABLE
303FIXED = _core_.FIXED
304NORMAL = _core_.NORMAL
305LIGHT = _core_.LIGHT
306BOLD = _core_.BOLD
307ITALIC = _core_.ITALIC
308SLANT = _core_.SLANT
309SOLID = _core_.SOLID
310DOT = _core_.DOT
311LONG_DASH = _core_.LONG_DASH
312SHORT_DASH = _core_.SHORT_DASH
313DOT_DASH = _core_.DOT_DASH
314USER_DASH = _core_.USER_DASH
315TRANSPARENT = _core_.TRANSPARENT
316STIPPLE = _core_.STIPPLE
317BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
318CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
319FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
320CROSS_HATCH = _core_.CROSS_HATCH
321HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
322VERTICAL_HATCH = _core_.VERTICAL_HATCH
323JOIN_BEVEL = _core_.JOIN_BEVEL
324JOIN_MITER = _core_.JOIN_MITER
325JOIN_ROUND = _core_.JOIN_ROUND
326CAP_ROUND = _core_.CAP_ROUND
327CAP_PROJECTING = _core_.CAP_PROJECTING
328CAP_BUTT = _core_.CAP_BUTT
329CLEAR = _core_.CLEAR
330XOR = _core_.XOR
331INVERT = _core_.INVERT
332OR_REVERSE = _core_.OR_REVERSE
333AND_REVERSE = _core_.AND_REVERSE
334COPY = _core_.COPY
335AND = _core_.AND
336AND_INVERT = _core_.AND_INVERT
337NO_OP = _core_.NO_OP
338NOR = _core_.NOR
339EQUIV = _core_.EQUIV
340SRC_INVERT = _core_.SRC_INVERT
341OR_INVERT = _core_.OR_INVERT
342NAND = _core_.NAND
343OR = _core_.OR
344SET = _core_.SET
345WXK_BACK = _core_.WXK_BACK
346WXK_TAB = _core_.WXK_TAB
347WXK_RETURN = _core_.WXK_RETURN
348WXK_ESCAPE = _core_.WXK_ESCAPE
349WXK_SPACE = _core_.WXK_SPACE
350WXK_DELETE = _core_.WXK_DELETE
351WXK_START = _core_.WXK_START
352WXK_LBUTTON = _core_.WXK_LBUTTON
353WXK_RBUTTON = _core_.WXK_RBUTTON
354WXK_CANCEL = _core_.WXK_CANCEL
355WXK_MBUTTON = _core_.WXK_MBUTTON
356WXK_CLEAR = _core_.WXK_CLEAR
357WXK_SHIFT = _core_.WXK_SHIFT
358WXK_ALT = _core_.WXK_ALT
359WXK_CONTROL = _core_.WXK_CONTROL
360WXK_MENU = _core_.WXK_MENU
361WXK_PAUSE = _core_.WXK_PAUSE
362WXK_CAPITAL = _core_.WXK_CAPITAL
363WXK_PRIOR = _core_.WXK_PRIOR
364WXK_NEXT = _core_.WXK_NEXT
365WXK_END = _core_.WXK_END
366WXK_HOME = _core_.WXK_HOME
367WXK_LEFT = _core_.WXK_LEFT
368WXK_UP = _core_.WXK_UP
369WXK_RIGHT = _core_.WXK_RIGHT
370WXK_DOWN = _core_.WXK_DOWN
371WXK_SELECT = _core_.WXK_SELECT
372WXK_PRINT = _core_.WXK_PRINT
373WXK_EXECUTE = _core_.WXK_EXECUTE
374WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
375WXK_INSERT = _core_.WXK_INSERT
376WXK_HELP = _core_.WXK_HELP
377WXK_NUMPAD0 = _core_.WXK_NUMPAD0
378WXK_NUMPAD1 = _core_.WXK_NUMPAD1
379WXK_NUMPAD2 = _core_.WXK_NUMPAD2
380WXK_NUMPAD3 = _core_.WXK_NUMPAD3
381WXK_NUMPAD4 = _core_.WXK_NUMPAD4
382WXK_NUMPAD5 = _core_.WXK_NUMPAD5
383WXK_NUMPAD6 = _core_.WXK_NUMPAD6
384WXK_NUMPAD7 = _core_.WXK_NUMPAD7
385WXK_NUMPAD8 = _core_.WXK_NUMPAD8
386WXK_NUMPAD9 = _core_.WXK_NUMPAD9
387WXK_MULTIPLY = _core_.WXK_MULTIPLY
388WXK_ADD = _core_.WXK_ADD
389WXK_SEPARATOR = _core_.WXK_SEPARATOR
390WXK_SUBTRACT = _core_.WXK_SUBTRACT
391WXK_DECIMAL = _core_.WXK_DECIMAL
392WXK_DIVIDE = _core_.WXK_DIVIDE
393WXK_F1 = _core_.WXK_F1
394WXK_F2 = _core_.WXK_F2
395WXK_F3 = _core_.WXK_F3
396WXK_F4 = _core_.WXK_F4
397WXK_F5 = _core_.WXK_F5
398WXK_F6 = _core_.WXK_F6
399WXK_F7 = _core_.WXK_F7
400WXK_F8 = _core_.WXK_F8
401WXK_F9 = _core_.WXK_F9
402WXK_F10 = _core_.WXK_F10
403WXK_F11 = _core_.WXK_F11
404WXK_F12 = _core_.WXK_F12
405WXK_F13 = _core_.WXK_F13
406WXK_F14 = _core_.WXK_F14
407WXK_F15 = _core_.WXK_F15
408WXK_F16 = _core_.WXK_F16
409WXK_F17 = _core_.WXK_F17
410WXK_F18 = _core_.WXK_F18
411WXK_F19 = _core_.WXK_F19
412WXK_F20 = _core_.WXK_F20
413WXK_F21 = _core_.WXK_F21
414WXK_F22 = _core_.WXK_F22
415WXK_F23 = _core_.WXK_F23
416WXK_F24 = _core_.WXK_F24
417WXK_NUMLOCK = _core_.WXK_NUMLOCK
418WXK_SCROLL = _core_.WXK_SCROLL
419WXK_PAGEUP = _core_.WXK_PAGEUP
420WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
421WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
422WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
423WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
424WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
425WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
426WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
427WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
428WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
429WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
430WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
431WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
432WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
433WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
434WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
435WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
436WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
437WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
438WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
439WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
440WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
441WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
442WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
443WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
444WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
445WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
446WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
447WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
448WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
449WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
450WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
451PAPER_NONE = _core_.PAPER_NONE
452PAPER_LETTER = _core_.PAPER_LETTER
453PAPER_LEGAL = _core_.PAPER_LEGAL
454PAPER_A4 = _core_.PAPER_A4
455PAPER_CSHEET = _core_.PAPER_CSHEET
456PAPER_DSHEET = _core_.PAPER_DSHEET
457PAPER_ESHEET = _core_.PAPER_ESHEET
458PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
459PAPER_TABLOID = _core_.PAPER_TABLOID
460PAPER_LEDGER = _core_.PAPER_LEDGER
461PAPER_STATEMENT = _core_.PAPER_STATEMENT
462PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
463PAPER_A3 = _core_.PAPER_A3
464PAPER_A4SMALL = _core_.PAPER_A4SMALL
465PAPER_A5 = _core_.PAPER_A5
466PAPER_B4 = _core_.PAPER_B4
467PAPER_B5 = _core_.PAPER_B5
468PAPER_FOLIO = _core_.PAPER_FOLIO
469PAPER_QUARTO = _core_.PAPER_QUARTO
470PAPER_10X14 = _core_.PAPER_10X14
471PAPER_11X17 = _core_.PAPER_11X17
472PAPER_NOTE = _core_.PAPER_NOTE
473PAPER_ENV_9 = _core_.PAPER_ENV_9
474PAPER_ENV_10 = _core_.PAPER_ENV_10
475PAPER_ENV_11 = _core_.PAPER_ENV_11
476PAPER_ENV_12 = _core_.PAPER_ENV_12
477PAPER_ENV_14 = _core_.PAPER_ENV_14
478PAPER_ENV_DL = _core_.PAPER_ENV_DL
479PAPER_ENV_C5 = _core_.PAPER_ENV_C5
480PAPER_ENV_C3 = _core_.PAPER_ENV_C3
481PAPER_ENV_C4 = _core_.PAPER_ENV_C4
482PAPER_ENV_C6 = _core_.PAPER_ENV_C6
483PAPER_ENV_C65 = _core_.PAPER_ENV_C65
484PAPER_ENV_B4 = _core_.PAPER_ENV_B4
485PAPER_ENV_B5 = _core_.PAPER_ENV_B5
486PAPER_ENV_B6 = _core_.PAPER_ENV_B6
487PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
488PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
489PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
490PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
491PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
492PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
493PAPER_ISO_B4 = _core_.PAPER_ISO_B4
494PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
495PAPER_9X11 = _core_.PAPER_9X11
496PAPER_10X11 = _core_.PAPER_10X11
497PAPER_15X11 = _core_.PAPER_15X11
498PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
499PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
500PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
501PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
502PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
503PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
504PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
505PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
506PAPER_A_PLUS = _core_.PAPER_A_PLUS
507PAPER_B_PLUS = _core_.PAPER_B_PLUS
508PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
509PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
510PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
511PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
512PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
513PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
514PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
515PAPER_A2 = _core_.PAPER_A2
516PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
517PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
518DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
519DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
520DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
521ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
522ITEM_NORMAL = _core_.ITEM_NORMAL
523ITEM_CHECK = _core_.ITEM_CHECK
524ITEM_RADIO = _core_.ITEM_RADIO
525ITEM_MAX = _core_.ITEM_MAX
526HT_NOWHERE = _core_.HT_NOWHERE
527HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
528HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
529HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
530HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
531HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
532HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
533HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
534HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
535HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
536HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
537HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
538HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
539HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
540HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
541HT_MAX = _core_.HT_MAX
542MOD_NONE = _core_.MOD_NONE
543MOD_ALT = _core_.MOD_ALT
544MOD_CONTROL = _core_.MOD_CONTROL
545MOD_SHIFT = _core_.MOD_SHIFT
546MOD_WIN = _core_.MOD_WIN
547UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
548UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
549UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
d14a1e28
RD
550#---------------------------------------------------------------------------
551
552class Object(object):
0df68c9f
RD
553 """
554 The base class for most wx objects, although in wxPython not
555 much functionality is needed nor exposed.
556 """
d14a1e28
RD
557 def __init__(self): raise RuntimeError, "No constructor defined"
558 def __repr__(self):
559 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 560 def GetClassName(*args, **kwargs):
0df68c9f 561 """
a95a7133 562 GetClassName(self) -> String
e811c8ce 563
a95a7133 564 Returns the class name of the C++ class using wxRTTI.
0df68c9f 565 """
54f9ee45 566 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
567
568 def Destroy(*args, **kwargs):
0df68c9f 569 """
a95a7133 570 Destroy(self)
e811c8ce 571
0df68c9f
RD
572 Deletes the C++ object this Python object is a proxy for.
573 """
54f9ee45 574 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 575
d14a1e28
RD
576
577class ObjectPtr(Object):
578 def __init__(self, this):
579 self.this = this
580 if not hasattr(self,"thisown"): self.thisown = 0
581 self.__class__ = Object
54f9ee45
RD
582_core_.Object_swigregister(ObjectPtr)
583_wxPySetDictionary = _core_._wxPySetDictionary
d14a1e28 584
54f9ee45 585_wxPyFixStockObjects = _core_._wxPyFixStockObjects
3a04f143 586
54f9ee45 587cvar = _core_.cvar
196addbf 588EmptyString = cvar.EmptyString
d14a1e28
RD
589
590#---------------------------------------------------------------------------
591
54f9ee45
RD
592BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
593BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
594BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
595BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
596BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
597BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
598BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
599BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
600BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
601BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
602BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
603BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
604BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
605BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
606BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
607BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
608BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
609BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
610BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
611BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
612CURSOR_NONE = _core_.CURSOR_NONE
613CURSOR_ARROW = _core_.CURSOR_ARROW
614CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
615CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
616CURSOR_CHAR = _core_.CURSOR_CHAR
617CURSOR_CROSS = _core_.CURSOR_CROSS
618CURSOR_HAND = _core_.CURSOR_HAND
619CURSOR_IBEAM = _core_.CURSOR_IBEAM
620CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
621CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
622CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
623CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
624CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
625CURSOR_PENCIL = _core_.CURSOR_PENCIL
626CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
627CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
628CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
629CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
630CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
631CURSOR_SIZENS = _core_.CURSOR_SIZENS
632CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
633CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
634CURSOR_SIZING = _core_.CURSOR_SIZING
635CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
636CURSOR_WAIT = _core_.CURSOR_WAIT
637CURSOR_WATCH = _core_.CURSOR_WATCH
638CURSOR_BLANK = _core_.CURSOR_BLANK
639CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
640CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
641CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
642CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD
643#---------------------------------------------------------------------------
644
645class Size(object):
0df68c9f 646 """
41e2b43e
RD
647 wx.Size is a useful data structure used to represent the size of
648 something. It simply contians integer width and height proprtites.
649 In most places in wxPython where a wx.Size is expected a
650 (width,height) tuple can be used instead.
0df68c9f 651 """
e811c8ce
RD
652 def __repr__(self):
653 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
654 width = property(_core_.Size_width_get, _core_.Size_width_set)
655 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 656 x = width; y = height
d14a1e28 657 def __init__(self, *args, **kwargs):
0df68c9f 658 """
a95a7133 659 __init__(self, int w=0, int h=0) -> Size
e811c8ce 660
0df68c9f
RD
661 Creates a size object.
662 """
54f9ee45 663 newobj = _core_.new_Size(*args, **kwargs)
d14a1e28
RD
664 self.this = newobj.this
665 self.thisown = 1
666 del newobj.thisown
54f9ee45 667 def __del__(self, destroy=_core_.delete_Size):
a95a7133 668 """__del__(self)"""
d14a1e28
RD
669 try:
670 if self.thisown: destroy(self)
671 except: pass
e811c8ce
RD
672
673 def __eq__(*args, **kwargs):
0df68c9f 674 """
a95a7133 675 __eq__(self, Size sz) -> bool
e811c8ce 676
0df68c9f
RD
677 Test for equality of wx.Size objects.
678 """
54f9ee45 679 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
680
681 def __ne__(*args, **kwargs):
0df68c9f 682 """
a95a7133 683 __ne__(self, Size sz) -> bool
e811c8ce 684
0df68c9f
RD
685 Test for inequality.
686 """
54f9ee45 687 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
688
689 def __add__(*args, **kwargs):
0df68c9f 690 """
a95a7133 691 __add__(self, Size sz) -> Size
e811c8ce 692
0df68c9f
RD
693 Add sz's proprties to this and return the result.
694 """
54f9ee45 695 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
696
697 def __sub__(*args, **kwargs):
0df68c9f 698 """
a95a7133 699 __sub__(self, Size sz) -> Size
e811c8ce 700
0df68c9f
RD
701 Subtract sz's properties from this and return the result.
702 """
54f9ee45 703 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
704
705 def IncTo(*args, **kwargs):
0df68c9f 706 """
a95a7133 707 IncTo(self, Size sz)
e811c8ce 708
0df68c9f
RD
709 Increments this object so that both of its dimensions are not less
710 than the corresponding dimensions of the size.
711 """
54f9ee45 712 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
713
714 def DecTo(*args, **kwargs):
0df68c9f 715 """
a95a7133 716 DecTo(self, Size sz)
e811c8ce 717
0df68c9f
RD
718 Decrements this object so that both of its dimensions are not greater
719 than the corresponding dimensions of the size.
720 """
54f9ee45 721 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce
RD
722
723 def Set(*args, **kwargs):
0df68c9f 724 """
a95a7133 725 Set(self, int w, int h)
e811c8ce 726
0df68c9f
RD
727 Set both width and height.
728 """
54f9ee45 729 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
730
731 def SetWidth(*args, **kwargs):
a95a7133 732 """SetWidth(self, int w)"""
54f9ee45 733 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
734
735 def SetHeight(*args, **kwargs):
a95a7133 736 """SetHeight(self, int h)"""
54f9ee45 737 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
738
739 def GetWidth(*args, **kwargs):
a95a7133 740 """GetWidth(self) -> int"""
54f9ee45 741 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
742
743 def GetHeight(*args, **kwargs):
a95a7133 744 """GetHeight(self) -> int"""
54f9ee45 745 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 746
74a57fcd
RD
747 def IsFullySpecified(*args, **kwargs):
748 """
a95a7133 749 IsFullySpecified(self) -> bool
74a57fcd
RD
750
751 Returns True if both components of the size are non-default values.
752 """
54f9ee45 753 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
754
755 def SetDefaults(*args, **kwargs):
756 """
a95a7133 757 SetDefaults(self, Size size)
74a57fcd 758
41e2b43e
RD
759 Combine this size with the other one replacing the default components
760 of this object (i.e. equal to -1) with those of the other.
74a57fcd 761 """
54f9ee45 762 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 763
e811c8ce 764 def Get(*args, **kwargs):
0df68c9f
RD
765 """
766 Get() -> (width,height)
e811c8ce 767
0df68c9f
RD
768 Returns the width and height properties as a tuple.
769 """
54f9ee45 770 return _core_.Size_Get(*args, **kwargs)
e811c8ce 771
41e2b43e 772 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
773 def __str__(self): return str(self.Get())
774 def __repr__(self): return 'wx.Size'+str(self.Get())
775 def __len__(self): return len(self.Get())
776 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
777 def __setitem__(self, index, val):
778 if index == 0: self.width = val
779 elif index == 1: self.height = val
780 else: raise IndexError
e811c8ce 781 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
782 __safe_for_unpickling__ = True
783 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28
RD
784
785
786class SizePtr(Size):
787 def __init__(self, this):
788 self.this = this
789 if not hasattr(self,"thisown"): self.thisown = 0
790 self.__class__ = Size
54f9ee45 791_core_.Size_swigregister(SizePtr)
d14a1e28
RD
792
793#---------------------------------------------------------------------------
794
795class RealPoint(object):
0df68c9f 796 """
41e2b43e
RD
797 A data structure for representing a point or position with floating
798 point x and y properties. In wxPython most places that expect a
799 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 800 """
e811c8ce
RD
801 def __repr__(self):
802 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
803 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
804 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
d14a1e28 805 def __init__(self, *args, **kwargs):
0df68c9f 806 """
a95a7133 807 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 808
0df68c9f
RD
809 Create a wx.RealPoint object
810 """
54f9ee45 811 newobj = _core_.new_RealPoint(*args, **kwargs)
d14a1e28
RD
812 self.this = newobj.this
813 self.thisown = 1
814 del newobj.thisown
54f9ee45 815 def __del__(self, destroy=_core_.delete_RealPoint):
a95a7133 816 """__del__(self)"""
d14a1e28
RD
817 try:
818 if self.thisown: destroy(self)
819 except: pass
e811c8ce
RD
820
821 def __eq__(*args, **kwargs):
0df68c9f 822 """
a95a7133 823 __eq__(self, RealPoint pt) -> bool
e811c8ce 824
0df68c9f
RD
825 Test for equality of wx.RealPoint objects.
826 """
54f9ee45 827 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
828
829 def __ne__(*args, **kwargs):
0df68c9f 830 """
a95a7133 831 __ne__(self, RealPoint pt) -> bool
e811c8ce 832
0df68c9f
RD
833 Test for inequality of wx.RealPoint objects.
834 """
54f9ee45 835 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
836
837 def __add__(*args, **kwargs):
0df68c9f 838 """
a95a7133 839 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 840
0df68c9f
RD
841 Add pt's proprties to this and return the result.
842 """
54f9ee45 843 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
844
845 def __sub__(*args, **kwargs):
0df68c9f 846 """
a95a7133 847 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 848
0df68c9f
RD
849 Subtract pt's proprties from this and return the result
850 """
54f9ee45 851 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
852
853 def Set(*args, **kwargs):
0df68c9f 854 """
a95a7133 855 Set(self, double x, double y)
e811c8ce 856
0df68c9f
RD
857 Set both the x and y properties
858 """
54f9ee45 859 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
860
861 def Get(*args, **kwargs):
0df68c9f
RD
862 """
863 Get() -> (x,y)
e811c8ce 864
0df68c9f
RD
865 Return the x and y properties as a tuple.
866 """
54f9ee45 867 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 868
41e2b43e 869 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
870 def __str__(self): return str(self.Get())
871 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
872 def __len__(self): return len(self.Get())
873 def __getitem__(self, index): return self.Get()[index]
d14a1e28 874 def __setitem__(self, index, val):
e811c8ce
RD
875 if index == 0: self.x = val
876 elif index == 1: self.y = val
d14a1e28 877 else: raise IndexError
e811c8ce 878 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
879 __safe_for_unpickling__ = True
880 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28
RD
881
882
883class RealPointPtr(RealPoint):
884 def __init__(self, this):
885 self.this = this
886 if not hasattr(self,"thisown"): self.thisown = 0
887 self.__class__ = RealPoint
54f9ee45 888_core_.RealPoint_swigregister(RealPointPtr)
d14a1e28
RD
889
890#---------------------------------------------------------------------------
891
892class Point(object):
0df68c9f 893 """
41e2b43e
RD
894 A data structure for representing a point or position with integer x
895 and y properties. Most places in wxPython that expect a wx.Point can
896 also accept a (x,y) tuple.
0df68c9f 897 """
e811c8ce
RD
898 def __repr__(self):
899 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
900 x = property(_core_.Point_x_get, _core_.Point_x_set)
901 y = property(_core_.Point_y_get, _core_.Point_y_set)
d14a1e28 902 def __init__(self, *args, **kwargs):
0df68c9f 903 """
a95a7133 904 __init__(self, int x=0, int y=0) -> Point
e811c8ce 905
0df68c9f
RD
906 Create a wx.Point object
907 """
54f9ee45 908 newobj = _core_.new_Point(*args, **kwargs)
d14a1e28
RD
909 self.this = newobj.this
910 self.thisown = 1
911 del newobj.thisown
54f9ee45 912 def __del__(self, destroy=_core_.delete_Point):
a95a7133 913 """__del__(self)"""
d14a1e28
RD
914 try:
915 if self.thisown: destroy(self)
916 except: pass
e811c8ce
RD
917
918 def __eq__(*args, **kwargs):
0df68c9f 919 """
a95a7133 920 __eq__(self, Point pt) -> bool
e811c8ce 921
0df68c9f
RD
922 Test for equality of wx.Point objects.
923 """
54f9ee45 924 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
925
926 def __ne__(*args, **kwargs):
0df68c9f 927 """
a95a7133 928 __ne__(self, Point pt) -> bool
e811c8ce 929
0df68c9f
RD
930 Test for inequality of wx.Point objects.
931 """
54f9ee45 932 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
933
934 def __add__(*args, **kwargs):
0df68c9f 935 """
a95a7133 936 __add__(self, Point pt) -> Point
e811c8ce 937
0df68c9f
RD
938 Add pt's proprties to this and return the result.
939 """
54f9ee45 940 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
941
942 def __sub__(*args, **kwargs):
0df68c9f 943 """
a95a7133 944 __sub__(self, Point pt) -> Point
e811c8ce 945
0df68c9f
RD
946 Subtract pt's proprties from this and return the result
947 """
54f9ee45 948 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
949
950 def __iadd__(*args, **kwargs):
0df68c9f 951 """
a95a7133 952 __iadd__(self, Point pt) -> Point
e811c8ce 953
0df68c9f
RD
954 Add pt to this object.
955 """
54f9ee45 956 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
957
958 def __isub__(*args, **kwargs):
0df68c9f 959 """
a95a7133 960 __isub__(self, Point pt) -> Point
e811c8ce 961
0df68c9f
RD
962 Subtract pt from this object.
963 """
54f9ee45 964 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
965
966 def Set(*args, **kwargs):
0df68c9f 967 """
a95a7133 968 Set(self, long x, long y)
e811c8ce 969
0df68c9f
RD
970 Set both the x and y properties
971 """
54f9ee45 972 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
973
974 def Get(*args, **kwargs):
0df68c9f
RD
975 """
976 Get() -> (x,y)
e811c8ce 977
0df68c9f
RD
978 Return the x and y properties as a tuple.
979 """
54f9ee45 980 return _core_.Point_Get(*args, **kwargs)
e811c8ce 981
41e2b43e 982 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
983 def __str__(self): return str(self.Get())
984 def __repr__(self): return 'wx.Point'+str(self.Get())
985 def __len__(self): return len(self.Get())
986 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
987 def __setitem__(self, index, val):
988 if index == 0: self.x = val
989 elif index == 1: self.y = val
990 else: raise IndexError
e811c8ce 991 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
992 __safe_for_unpickling__ = True
993 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28
RD
994
995
996class PointPtr(Point):
997 def __init__(self, this):
998 self.this = this
999 if not hasattr(self,"thisown"): self.thisown = 0
1000 self.__class__ = Point
54f9ee45 1001_core_.Point_swigregister(PointPtr)
d14a1e28
RD
1002
1003#---------------------------------------------------------------------------
1004
1005class Rect(object):
0df68c9f 1006 """
41e2b43e
RD
1007 A class for representing and manipulating rectangles. It has x, y,
1008 width and height properties. In wxPython most palces that expect a
1009 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1010 """
e811c8ce
RD
1011 def __repr__(self):
1012 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1013 def __init__(self, *args, **kwargs):
0df68c9f 1014 """
a95a7133 1015 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1016
0df68c9f
RD
1017 Create a new Rect object.
1018 """
54f9ee45 1019 newobj = _core_.new_Rect(*args, **kwargs)
d14a1e28
RD
1020 self.this = newobj.this
1021 self.thisown = 1
1022 del newobj.thisown
54f9ee45 1023 def __del__(self, destroy=_core_.delete_Rect):
a95a7133 1024 """__del__(self)"""
d14a1e28
RD
1025 try:
1026 if self.thisown: destroy(self)
1027 except: pass
e811c8ce
RD
1028
1029 def GetX(*args, **kwargs):
a95a7133 1030 """GetX(self) -> int"""
54f9ee45 1031 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1032
1033 def SetX(*args, **kwargs):
a95a7133 1034 """SetX(self, int x)"""
54f9ee45 1035 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1036
1037 def GetY(*args, **kwargs):
a95a7133 1038 """GetY(self) -> int"""
54f9ee45 1039 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1040
1041 def SetY(*args, **kwargs):
a95a7133 1042 """SetY(self, int y)"""
54f9ee45 1043 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1044
1045 def GetWidth(*args, **kwargs):
a95a7133 1046 """GetWidth(self) -> int"""
54f9ee45 1047 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1048
1049 def SetWidth(*args, **kwargs):
a95a7133 1050 """SetWidth(self, int w)"""
54f9ee45 1051 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1052
1053 def GetHeight(*args, **kwargs):
a95a7133 1054 """GetHeight(self) -> int"""
54f9ee45 1055 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1056
1057 def SetHeight(*args, **kwargs):
a95a7133 1058 """SetHeight(self, int h)"""
54f9ee45 1059 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1060
1061 def GetPosition(*args, **kwargs):
a95a7133 1062 """GetPosition(self) -> Point"""
54f9ee45 1063 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1064
1065 def SetPosition(*args, **kwargs):
a95a7133 1066 """SetPosition(self, Point p)"""
54f9ee45 1067 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1068
1069 def GetSize(*args, **kwargs):
a95a7133 1070 """GetSize(self) -> Size"""
54f9ee45 1071 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1072
1073 def SetSize(*args, **kwargs):
a95a7133 1074 """SetSize(self, Size s)"""
54f9ee45 1075 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1076
c9c7117a 1077 def GetTopLeft(*args, **kwargs):
a95a7133 1078 """GetTopLeft(self) -> Point"""
54f9ee45 1079 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1080
1081 def SetTopLeft(*args, **kwargs):
a95a7133 1082 """SetTopLeft(self, Point p)"""
54f9ee45 1083 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1084
1085 def GetBottomRight(*args, **kwargs):
a95a7133 1086 """GetBottomRight(self) -> Point"""
54f9ee45 1087 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1088
1089 def SetBottomRight(*args, **kwargs):
a95a7133 1090 """SetBottomRight(self, Point p)"""
54f9ee45 1091 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1092
e811c8ce 1093 def GetLeft(*args, **kwargs):
a95a7133 1094 """GetLeft(self) -> int"""
54f9ee45 1095 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1096
1097 def GetTop(*args, **kwargs):
a95a7133 1098 """GetTop(self) -> int"""
54f9ee45 1099 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1100
1101 def GetBottom(*args, **kwargs):
a95a7133 1102 """GetBottom(self) -> int"""
54f9ee45 1103 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1104
1105 def GetRight(*args, **kwargs):
a95a7133 1106 """GetRight(self) -> int"""
54f9ee45 1107 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1108
1109 def SetLeft(*args, **kwargs):
a95a7133 1110 """SetLeft(self, int left)"""
54f9ee45 1111 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1112
1113 def SetRight(*args, **kwargs):
a95a7133 1114 """SetRight(self, int right)"""
54f9ee45 1115 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1116
1117 def SetTop(*args, **kwargs):
a95a7133 1118 """SetTop(self, int top)"""
54f9ee45 1119 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1120
1121 def SetBottom(*args, **kwargs):
a95a7133 1122 """SetBottom(self, int bottom)"""
54f9ee45 1123 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
1124
1125 position = property(GetPosition, SetPosition)
1126 size = property(GetSize, SetSize)
1127 left = property(GetLeft, SetLeft)
1128 right = property(GetRight, SetRight)
1129 top = property(GetTop, SetTop)
1130 bottom = property(GetBottom, SetBottom)
1131
1132 def Inflate(*args, **kwargs):
0df68c9f 1133 """
a95a7133 1134 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1135
41e2b43e
RD
1136 Increase the rectangle size by dx in x direction and dy in y
1137 direction. Both or one of) parameters may be negative to decrease the
1138 rectangle size.
0df68c9f 1139 """
54f9ee45 1140 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1141
1142 def Deflate(*args, **kwargs):
0df68c9f 1143 """
a95a7133 1144 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1145
41e2b43e
RD
1146 Decrease the rectangle size by dx in x direction and dy in y
1147 direction. Both or one of) parameters may be negative to increase the
1148 rectngle size. This method is the opposite of Inflate.
0df68c9f 1149 """
54f9ee45 1150 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1151
1152 def OffsetXY(*args, **kwargs):
0df68c9f 1153 """
a95a7133 1154 OffsetXY(self, int dx, int dy)
e811c8ce 1155
41e2b43e
RD
1156 Moves the rectangle by the specified offset. If dx is positive, the
1157 rectangle is moved to the right, if dy is positive, it is moved to the
1158 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1159 """
54f9ee45 1160 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1161
1162 def Offset(*args, **kwargs):
0df68c9f 1163 """
a95a7133 1164 Offset(self, Point pt)
e811c8ce 1165
0df68c9f
RD
1166 Same as OffsetXY but uses dx,dy from Point
1167 """
54f9ee45 1168 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1169
1170 def Intersect(*args, **kwargs):
0df68c9f 1171 """
a95a7133 1172 Intersect(self, Rect rect) -> Rect
e811c8ce 1173
0df68c9f
RD
1174 Return the intersectsion of this rectangle and rect.
1175 """
54f9ee45 1176 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce
RD
1177
1178 def __add__(*args, **kwargs):
0df68c9f 1179 """
a95a7133 1180 __add__(self, Rect rect) -> Rect
e811c8ce 1181
0df68c9f
RD
1182 Add the properties of rect to this rectangle and return the result.
1183 """
54f9ee45 1184 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1185
1186 def __iadd__(*args, **kwargs):
0df68c9f 1187 """
a95a7133 1188 __iadd__(self, Rect rect) -> Rect
e811c8ce 1189
0df68c9f
RD
1190 Add the properties of rect to this rectangle, updating this rectangle.
1191 """
54f9ee45 1192 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1193
1194 def __eq__(*args, **kwargs):
0df68c9f 1195 """
a95a7133 1196 __eq__(self, Rect rect) -> bool
e811c8ce 1197
0df68c9f
RD
1198 Test for equality.
1199 """
54f9ee45 1200 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1201
1202 def __ne__(*args, **kwargs):
0df68c9f 1203 """
a95a7133 1204 __ne__(self, Rect rect) -> bool
e811c8ce 1205
0df68c9f
RD
1206 Test for inequality.
1207 """
54f9ee45 1208 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce
RD
1209
1210 def InsideXY(*args, **kwargs):
0df68c9f 1211 """
a95a7133 1212 InsideXY(self, int x, int y) -> bool
e811c8ce 1213
0df68c9f
RD
1214 Return True if the point is (not strcitly) inside the rect.
1215 """
54f9ee45 1216 return _core_.Rect_InsideXY(*args, **kwargs)
e811c8ce
RD
1217
1218 def Inside(*args, **kwargs):
0df68c9f 1219 """
a95a7133 1220 Inside(self, Point pt) -> bool
e811c8ce 1221
0df68c9f
RD
1222 Return True if the point is (not strcitly) inside the rect.
1223 """
54f9ee45 1224 return _core_.Rect_Inside(*args, **kwargs)
e811c8ce
RD
1225
1226 def Intersects(*args, **kwargs):
0df68c9f 1227 """
a95a7133 1228 Intersects(self, Rect rect) -> bool
e811c8ce 1229
0df68c9f
RD
1230 Returns True if the rectangles have a non empty intersection.
1231 """
54f9ee45 1232 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1233
54f9ee45
RD
1234 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1235 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1236 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1237 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1238 def Set(*args, **kwargs):
0df68c9f 1239 """
a95a7133 1240 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1241
0df68c9f
RD
1242 Set all rectangle properties.
1243 """
54f9ee45 1244 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1245
1246 def Get(*args, **kwargs):
0df68c9f
RD
1247 """
1248 Get() -> (x,y,width,height)
e811c8ce 1249
0df68c9f
RD
1250 Return the rectangle properties as a tuple.
1251 """
54f9ee45 1252 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1253
41e2b43e 1254 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1255 def __str__(self): return str(self.Get())
1256 def __repr__(self): return 'wx.Rect'+str(self.Get())
1257 def __len__(self): return len(self.Get())
1258 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1259 def __setitem__(self, index, val):
1260 if index == 0: self.x = val
1261 elif index == 1: self.y = val
1262 elif index == 2: self.width = val
1263 elif index == 3: self.height = val
1264 else: raise IndexError
e811c8ce 1265 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1266 __safe_for_unpickling__ = True
1267 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28
RD
1268
1269
1270class RectPtr(Rect):
1271 def __init__(self, this):
1272 self.this = this
1273 if not hasattr(self,"thisown"): self.thisown = 0
1274 self.__class__ = Rect
54f9ee45 1275_core_.Rect_swigregister(RectPtr)
d14a1e28
RD
1276
1277def RectPP(*args, **kwargs):
0df68c9f
RD
1278 """
1279 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1280
0df68c9f
RD
1281 Create a new Rect object from Points representing two corners.
1282 """
54f9ee45 1283 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1284 val.thisown = 1
1285 return val
1286
1287def RectPS(*args, **kwargs):
0df68c9f
RD
1288 """
1289 RectPS(Point pos, Size size) -> Rect
e811c8ce 1290
0df68c9f
RD
1291 Create a new Rect from a position and size.
1292 """
54f9ee45 1293 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1294 val.thisown = 1
1295 return val
1296
1297
e811c8ce 1298def IntersectRect(*args, **kwargs):
0df68c9f
RD
1299 """
1300 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1301
0df68c9f
RD
1302 Calculate and return the intersection of r1 and r2.
1303 """
54f9ee45 1304 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1305#---------------------------------------------------------------------------
1306
1307class Point2D(object):
41e2b43e
RD
1308 """
1309 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1310 with floating point values.
1311 """
e811c8ce
RD
1312 def __repr__(self):
1313 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1314 def __init__(self, *args, **kwargs):
0df68c9f 1315 """
a95a7133 1316 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1317
0df68c9f
RD
1318 Create a w.Point2D object.
1319 """
54f9ee45 1320 newobj = _core_.new_Point2D(*args, **kwargs)
d14a1e28
RD
1321 self.this = newobj.this
1322 self.thisown = 1
1323 del newobj.thisown
e811c8ce 1324 def GetFloor(*args, **kwargs):
41e2b43e 1325 """GetFloor() -> (x,y)"""
54f9ee45 1326 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1327
1328 def GetRounded(*args, **kwargs):
41e2b43e 1329 """GetRounded() -> (x,y)"""
54f9ee45 1330 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1331
1332 def GetVectorLength(*args, **kwargs):
a95a7133 1333 """GetVectorLength(self) -> double"""
54f9ee45 1334 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1335
1336 def GetVectorAngle(*args, **kwargs):
a95a7133 1337 """GetVectorAngle(self) -> double"""
54f9ee45 1338 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1339
1340 def SetVectorLength(*args, **kwargs):
a95a7133 1341 """SetVectorLength(self, double length)"""
54f9ee45 1342 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1343
1344 def SetVectorAngle(*args, **kwargs):
a95a7133 1345 """SetVectorAngle(self, double degrees)"""
54f9ee45 1346 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1347
d14a1e28
RD
1348 def SetPolarCoordinates(self, angle, length):
1349 self.SetVectorLength(length)
1350 self.SetVectorAngle(angle)
1351 def Normalize(self):
1352 self.SetVectorLength(1.0)
1353
e811c8ce 1354 def GetDistance(*args, **kwargs):
a95a7133 1355 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1356 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1357
1358 def GetDistanceSquare(*args, **kwargs):
a95a7133 1359 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1360 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1361
1362 def GetDotProduct(*args, **kwargs):
a95a7133 1363 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1364 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1365
1366 def GetCrossProduct(*args, **kwargs):
a95a7133 1367 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1368 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1369
1370 def __neg__(*args, **kwargs):
0df68c9f 1371 """
a95a7133 1372 __neg__(self) -> Point2D
e811c8ce 1373
0df68c9f
RD
1374 the reflection of this point
1375 """
54f9ee45 1376 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1377
1378 def __iadd__(*args, **kwargs):
a95a7133 1379 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1380 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1381
1382 def __isub__(*args, **kwargs):
a95a7133 1383 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1384 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1385
1386 def __imul__(*args, **kwargs):
a95a7133 1387 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1388 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1389
1390 def __idiv__(*args, **kwargs):
a95a7133 1391 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1392 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1393
1394 def __eq__(*args, **kwargs):
0df68c9f 1395 """
a95a7133 1396 __eq__(self, Point2D pt) -> bool
e811c8ce 1397
0df68c9f
RD
1398 Test for equality
1399 """
54f9ee45 1400 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1401
1402 def __ne__(*args, **kwargs):
0df68c9f 1403 """
a95a7133 1404 __ne__(self, Point2D pt) -> bool
e811c8ce 1405
0df68c9f
RD
1406 Test for inequality
1407 """
54f9ee45 1408 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1409
54f9ee45
RD
1410 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1411 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1412 def Set(*args, **kwargs):
a95a7133 1413 """Set(self, double x=0, double y=0)"""
54f9ee45 1414 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1415
1416 def Get(*args, **kwargs):
0df68c9f
RD
1417 """
1418 Get() -> (x,y)
e811c8ce 1419
0df68c9f
RD
1420 Return x and y properties as a tuple.
1421 """
54f9ee45 1422 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1423
41e2b43e 1424 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1425 def __str__(self): return str(self.Get())
1426 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1427 def __len__(self): return len(self.Get())
1428 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1429 def __setitem__(self, index, val):
e811c8ce
RD
1430 if index == 0: self.x = val
1431 elif index == 1: self.y = val
d14a1e28 1432 else: raise IndexError
e811c8ce 1433 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1434 __safe_for_unpickling__ = True
1435 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28
RD
1436
1437
1438class Point2DPtr(Point2D):
1439 def __init__(self, this):
1440 self.this = this
1441 if not hasattr(self,"thisown"): self.thisown = 0
1442 self.__class__ = Point2D
54f9ee45 1443_core_.Point2D_swigregister(Point2DPtr)
d14a1e28
RD
1444
1445def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1446 """
1447 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1448
0df68c9f
RD
1449 Create a w.Point2D object.
1450 """
54f9ee45 1451 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1452 val.thisown = 1
1453 return val
1454
1455def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1456 """
1457 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1458
0df68c9f
RD
1459 Create a w.Point2D object.
1460 """
54f9ee45 1461 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1462 val.thisown = 1
1463 return val
1464
1465#---------------------------------------------------------------------------
1466
54f9ee45
RD
1467FromStart = _core_.FromStart
1468FromCurrent = _core_.FromCurrent
1469FromEnd = _core_.FromEnd
d14a1e28 1470class InputStream(object):
e811c8ce
RD
1471 def __repr__(self):
1472 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1473 def __init__(self, *args, **kwargs):
a95a7133 1474 """__init__(self, PyObject p) -> InputStream"""
54f9ee45 1475 newobj = _core_.new_InputStream(*args, **kwargs)
d14a1e28
RD
1476 self.this = newobj.this
1477 self.thisown = 1
1478 del newobj.thisown
e811c8ce 1479 def close(*args, **kwargs):
a95a7133 1480 """close(self)"""
54f9ee45 1481 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1482
1483 def flush(*args, **kwargs):
a95a7133 1484 """flush(self)"""
54f9ee45 1485 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1486
1487 def eof(*args, **kwargs):
a95a7133 1488 """eof(self) -> bool"""
54f9ee45 1489 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1490
1491 def read(*args, **kwargs):
a95a7133 1492 """read(self, int size=-1) -> PyObject"""
54f9ee45 1493 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1494
1495 def readline(*args, **kwargs):
a95a7133 1496 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1497 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1498
1499 def readlines(*args, **kwargs):
a95a7133 1500 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1501 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1502
1503 def seek(*args, **kwargs):
a95a7133 1504 """seek(self, int offset, int whence=0)"""
54f9ee45 1505 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1506
1507 def tell(*args, **kwargs):
a95a7133 1508 """tell(self) -> int"""
54f9ee45 1509 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1510
1511 def Peek(*args, **kwargs):
a95a7133 1512 """Peek(self) -> char"""
54f9ee45 1513 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1514
1515 def GetC(*args, **kwargs):
a95a7133 1516 """GetC(self) -> char"""
54f9ee45 1517 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1518
1519 def LastRead(*args, **kwargs):
a95a7133 1520 """LastRead(self) -> size_t"""
54f9ee45 1521 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1522
1523 def CanRead(*args, **kwargs):
a95a7133 1524 """CanRead(self) -> bool"""
54f9ee45 1525 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1526
1527 def Eof(*args, **kwargs):
a95a7133 1528 """Eof(self) -> bool"""
54f9ee45 1529 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1530
1531 def Ungetch(*args, **kwargs):
a95a7133 1532 """Ungetch(self, char c) -> bool"""
54f9ee45 1533 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1534
1535 def SeekI(*args, **kwargs):
a95a7133 1536 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1537 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1538
1539 def TellI(*args, **kwargs):
a95a7133 1540 """TellI(self) -> long"""
54f9ee45 1541 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1542
d14a1e28
RD
1543
1544class InputStreamPtr(InputStream):
1545 def __init__(self, this):
1546 self.this = this
1547 if not hasattr(self,"thisown"): self.thisown = 0
1548 self.__class__ = InputStream
54f9ee45 1549_core_.InputStream_swigregister(InputStreamPtr)
d14a1e28
RD
1550DefaultPosition = cvar.DefaultPosition
1551DefaultSize = cvar.DefaultSize
1552
1553class OutputStream(object):
d14a1e28
RD
1554 def __init__(self): raise RuntimeError, "No constructor defined"
1555 def __repr__(self):
1556 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1557 def write(*args, **kwargs):
a95a7133 1558 """write(self, PyObject obj)"""
54f9ee45 1559 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1560
d14a1e28
RD
1561
1562class OutputStreamPtr(OutputStream):
1563 def __init__(self, this):
1564 self.this = this
1565 if not hasattr(self,"thisown"): self.thisown = 0
1566 self.__class__ = OutputStream
54f9ee45 1567_core_.OutputStream_swigregister(OutputStreamPtr)
d14a1e28
RD
1568
1569#---------------------------------------------------------------------------
1570
1571class FSFile(Object):
e811c8ce
RD
1572 def __repr__(self):
1573 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1574 def __init__(self, *args, **kwargs):
0df68c9f 1575 """
a95a7133 1576 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 1577 DateTime modif) -> FSFile
0df68c9f 1578 """
54f9ee45 1579 newobj = _core_.new_FSFile(*args, **kwargs)
d14a1e28
RD
1580 self.this = newobj.this
1581 self.thisown = 1
1582 del newobj.thisown
54f9ee45 1583 def __del__(self, destroy=_core_.delete_FSFile):
a95a7133 1584 """__del__(self)"""
d14a1e28
RD
1585 try:
1586 if self.thisown: destroy(self)
1587 except: pass
e811c8ce
RD
1588
1589 def GetStream(*args, **kwargs):
a95a7133 1590 """GetStream(self) -> InputStream"""
54f9ee45 1591 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce
RD
1592
1593 def GetMimeType(*args, **kwargs):
a95a7133 1594 """GetMimeType(self) -> String"""
54f9ee45 1595 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
1596
1597 def GetLocation(*args, **kwargs):
a95a7133 1598 """GetLocation(self) -> String"""
54f9ee45 1599 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
1600
1601 def GetAnchor(*args, **kwargs):
a95a7133 1602 """GetAnchor(self) -> String"""
54f9ee45 1603 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
1604
1605 def GetModificationTime(*args, **kwargs):
a95a7133 1606 """GetModificationTime(self) -> DateTime"""
54f9ee45 1607 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 1608
d14a1e28
RD
1609
1610class FSFilePtr(FSFile):
1611 def __init__(self, this):
1612 self.this = this
1613 if not hasattr(self,"thisown"): self.thisown = 0
1614 self.__class__ = FSFile
54f9ee45 1615_core_.FSFile_swigregister(FSFilePtr)
d14a1e28
RD
1616
1617class CPPFileSystemHandler(object):
1618 def __init__(self): raise RuntimeError, "No constructor defined"
1619 def __repr__(self):
1620 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1621
1622class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1623 def __init__(self, this):
1624 self.this = this
1625 if not hasattr(self,"thisown"): self.thisown = 0
1626 self.__class__ = CPPFileSystemHandler
54f9ee45 1627_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
d14a1e28
RD
1628
1629class FileSystemHandler(CPPFileSystemHandler):
e811c8ce
RD
1630 def __repr__(self):
1631 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1632 def __init__(self, *args, **kwargs):
a95a7133 1633 """__init__(self) -> FileSystemHandler"""
54f9ee45 1634 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
d14a1e28
RD
1635 self.this = newobj.this
1636 self.thisown = 1
1637 del newobj.thisown
1638 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
1639
1640 def _setCallbackInfo(*args, **kwargs):
a95a7133 1641 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 1642 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
1643
1644 def CanOpen(*args, **kwargs):
a95a7133 1645 """CanOpen(self, String location) -> bool"""
54f9ee45 1646 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1647
1648 def OpenFile(*args, **kwargs):
a95a7133 1649 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1650 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1651
1652 def FindFirst(*args, **kwargs):
a95a7133 1653 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1654 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1655
1656 def FindNext(*args, **kwargs):
a95a7133 1657 """FindNext(self) -> String"""
54f9ee45 1658 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
1659
1660 def GetProtocol(*args, **kwargs):
a95a7133 1661 """GetProtocol(self, String location) -> String"""
54f9ee45 1662 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
1663
1664 def GetLeftLocation(*args, **kwargs):
a95a7133 1665 """GetLeftLocation(self, String location) -> String"""
54f9ee45 1666 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
1667
1668 def GetAnchor(*args, **kwargs):
a95a7133 1669 """GetAnchor(self, String location) -> String"""
54f9ee45 1670 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
1671
1672 def GetRightLocation(*args, **kwargs):
a95a7133 1673 """GetRightLocation(self, String location) -> String"""
54f9ee45 1674 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
1675
1676 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 1677 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 1678 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 1679
d14a1e28
RD
1680
1681class FileSystemHandlerPtr(FileSystemHandler):
1682 def __init__(self, this):
1683 self.this = this
1684 if not hasattr(self,"thisown"): self.thisown = 0
1685 self.__class__ = FileSystemHandler
54f9ee45 1686_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
d14a1e28
RD
1687
1688class FileSystem(Object):
e811c8ce
RD
1689 def __repr__(self):
1690 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1691 def __init__(self, *args, **kwargs):
a95a7133 1692 """__init__(self) -> FileSystem"""
54f9ee45 1693 newobj = _core_.new_FileSystem(*args, **kwargs)
d14a1e28
RD
1694 self.this = newobj.this
1695 self.thisown = 1
1696 del newobj.thisown
54f9ee45 1697 def __del__(self, destroy=_core_.delete_FileSystem):
a95a7133 1698 """__del__(self)"""
d14a1e28
RD
1699 try:
1700 if self.thisown: destroy(self)
1701 except: pass
e811c8ce
RD
1702
1703 def ChangePathTo(*args, **kwargs):
a95a7133 1704 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 1705 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
1706
1707 def GetPath(*args, **kwargs):
a95a7133 1708 """GetPath(self) -> String"""
54f9ee45 1709 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
1710
1711 def OpenFile(*args, **kwargs):
a95a7133 1712 """OpenFile(self, String location) -> FSFile"""
54f9ee45 1713 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
1714
1715 def FindFirst(*args, **kwargs):
a95a7133 1716 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1717 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
1718
1719 def FindNext(*args, **kwargs):
a95a7133 1720 """FindNext(self) -> String"""
54f9ee45 1721 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
1722
1723 def AddHandler(*args, **kwargs):
66c033b4 1724 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1725 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
1726
1727 AddHandler = staticmethod(AddHandler)
1728 def CleanUpHandlers(*args, **kwargs):
66c033b4 1729 """CleanUpHandlers()"""
54f9ee45 1730 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
1731
1732 CleanUpHandlers = staticmethod(CleanUpHandlers)
1733 def FileNameToURL(*args, **kwargs):
66c033b4 1734 """FileNameToURL(String filename) -> String"""
54f9ee45 1735 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
1736
1737 FileNameToURL = staticmethod(FileNameToURL)
d14a1e28
RD
1738
1739class FileSystemPtr(FileSystem):
1740 def __init__(self, this):
1741 self.this = this
1742 if not hasattr(self,"thisown"): self.thisown = 0
1743 self.__class__ = FileSystem
54f9ee45 1744_core_.FileSystem_swigregister(FileSystemPtr)
d14a1e28 1745
e811c8ce
RD
1746def FileSystem_AddHandler(*args, **kwargs):
1747 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1748 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 1749
e811c8ce
RD
1750def FileSystem_CleanUpHandlers(*args, **kwargs):
1751 """FileSystem_CleanUpHandlers()"""
54f9ee45 1752 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d14a1e28 1753
e811c8ce 1754def FileSystem_FileNameToURL(*args, **kwargs):
196addbf 1755 """FileSystem_FileNameToURL(String filename) -> String"""
54f9ee45 1756 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28
RD
1757
1758
e811c8ce 1759def FileSystem_URLToFileName(*args, **kwargs):
196addbf 1760 """FileSystem_URLToFileName(String url) -> String"""
54f9ee45 1761 return _core_.FileSystem_URLToFileName(*args, **kwargs)
d14a1e28 1762class InternetFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1763 def __repr__(self):
1764 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1765 def __init__(self, *args, **kwargs):
a95a7133 1766 """__init__(self) -> InternetFSHandler"""
54f9ee45 1767 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
d14a1e28
RD
1768 self.this = newobj.this
1769 self.thisown = 1
1770 del newobj.thisown
e811c8ce 1771 def CanOpen(*args, **kwargs):
a95a7133 1772 """CanOpen(self, String location) -> bool"""
54f9ee45 1773 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1774
1775 def OpenFile(*args, **kwargs):
a95a7133 1776 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1777 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 1778
d14a1e28
RD
1779
1780class InternetFSHandlerPtr(InternetFSHandler):
1781 def __init__(self, this):
1782 self.this = this
1783 if not hasattr(self,"thisown"): self.thisown = 0
1784 self.__class__ = InternetFSHandler
54f9ee45 1785_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
d14a1e28
RD
1786
1787class ZipFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1788 def __repr__(self):
1789 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1790 def __init__(self, *args, **kwargs):
a95a7133 1791 """__init__(self) -> ZipFSHandler"""
54f9ee45 1792 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
d14a1e28
RD
1793 self.this = newobj.this
1794 self.thisown = 1
1795 del newobj.thisown
e811c8ce 1796 def CanOpen(*args, **kwargs):
a95a7133 1797 """CanOpen(self, String location) -> bool"""
54f9ee45 1798 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1799
1800 def OpenFile(*args, **kwargs):
a95a7133 1801 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1802 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1803
1804 def FindFirst(*args, **kwargs):
a95a7133 1805 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1806 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1807
1808 def FindNext(*args, **kwargs):
a95a7133 1809 """FindNext(self) -> String"""
54f9ee45 1810 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 1811
d14a1e28
RD
1812
1813class ZipFSHandlerPtr(ZipFSHandler):
1814 def __init__(self, this):
1815 self.this = this
1816 if not hasattr(self,"thisown"): self.thisown = 0
1817 self.__class__ = ZipFSHandler
54f9ee45 1818_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
d14a1e28
RD
1819
1820
e811c8ce 1821def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
196addbf 1822 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
54f9ee45 1823 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 1824
e811c8ce 1825def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
196addbf 1826 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
54f9ee45 1827 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 1828
e811c8ce 1829def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
196addbf 1830 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
54f9ee45 1831 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
d14a1e28
RD
1832def MemoryFSHandler_AddFile(filename, a, b=''):
1833 if isinstance(a, wx.Image):
1834 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1835 elif isinstance(a, wx.Bitmap):
1836 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1837 elif type(a) == str:
1838 __wxMemoryFSHandler_AddFile_Data(filename, a)
1839 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1840
1841class MemoryFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1842 def __repr__(self):
1843 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1844 def __init__(self, *args, **kwargs):
a95a7133 1845 """__init__(self) -> MemoryFSHandler"""
54f9ee45 1846 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
d14a1e28
RD
1847 self.this = newobj.this
1848 self.thisown = 1
1849 del newobj.thisown
e811c8ce 1850 def RemoveFile(*args, **kwargs):
66c033b4 1851 """RemoveFile(String filename)"""
54f9ee45 1852 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
1853
1854 RemoveFile = staticmethod(RemoveFile)
d14a1e28 1855 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 1856 def CanOpen(*args, **kwargs):
a95a7133 1857 """CanOpen(self, String location) -> bool"""
54f9ee45 1858 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1859
1860 def OpenFile(*args, **kwargs):
a95a7133 1861 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1862 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1863
1864 def FindFirst(*args, **kwargs):
a95a7133 1865 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1866 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1867
1868 def FindNext(*args, **kwargs):
a95a7133 1869 """FindNext(self) -> String"""
54f9ee45 1870 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 1871
d14a1e28
RD
1872
1873class MemoryFSHandlerPtr(MemoryFSHandler):
1874 def __init__(self, this):
1875 self.this = this
1876 if not hasattr(self,"thisown"): self.thisown = 0
1877 self.__class__ = MemoryFSHandler
54f9ee45 1878_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
d14a1e28 1879
e811c8ce 1880def MemoryFSHandler_RemoveFile(*args, **kwargs):
196addbf 1881 """MemoryFSHandler_RemoveFile(String filename)"""
54f9ee45 1882 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28
RD
1883
1884#---------------------------------------------------------------------------
1885
1886class ImageHandler(Object):
d14a1e28
RD
1887 def __init__(self): raise RuntimeError, "No constructor defined"
1888 def __repr__(self):
1889 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1890 def GetName(*args, **kwargs):
a95a7133 1891 """GetName(self) -> String"""
54f9ee45 1892 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
1893
1894 def GetExtension(*args, **kwargs):
a95a7133 1895 """GetExtension(self) -> String"""
54f9ee45 1896 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
1897
1898 def GetType(*args, **kwargs):
a95a7133 1899 """GetType(self) -> long"""
54f9ee45 1900 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
1901
1902 def GetMimeType(*args, **kwargs):
a95a7133 1903 """GetMimeType(self) -> String"""
54f9ee45 1904 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
1905
1906 def CanRead(*args, **kwargs):
a95a7133 1907 """CanRead(self, String name) -> bool"""
54f9ee45 1908 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce
RD
1909
1910 def SetName(*args, **kwargs):
a95a7133 1911 """SetName(self, String name)"""
54f9ee45 1912 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
1913
1914 def SetExtension(*args, **kwargs):
a95a7133 1915 """SetExtension(self, String extension)"""
54f9ee45 1916 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
1917
1918 def SetType(*args, **kwargs):
a95a7133 1919 """SetType(self, long type)"""
54f9ee45 1920 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
1921
1922 def SetMimeType(*args, **kwargs):
a95a7133 1923 """SetMimeType(self, String mimetype)"""
54f9ee45 1924 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 1925
d14a1e28
RD
1926
1927class ImageHandlerPtr(ImageHandler):
1928 def __init__(self, this):
1929 self.this = this
1930 if not hasattr(self,"thisown"): self.thisown = 0
1931 self.__class__ = ImageHandler
54f9ee45 1932_core_.ImageHandler_swigregister(ImageHandlerPtr)
d14a1e28
RD
1933
1934class ImageHistogram(object):
e811c8ce
RD
1935 def __repr__(self):
1936 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1937 def __init__(self, *args, **kwargs):
a95a7133 1938 """__init__(self) -> ImageHistogram"""
54f9ee45 1939 newobj = _core_.new_ImageHistogram(*args, **kwargs)
d14a1e28
RD
1940 self.this = newobj.this
1941 self.thisown = 1
1942 del newobj.thisown
e811c8ce 1943 def MakeKey(*args, **kwargs):
0df68c9f 1944 """
66c033b4 1945 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1946
0df68c9f
RD
1947 Get the key in the histogram for the given RGB values
1948 """
54f9ee45 1949 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
1950
1951 MakeKey = staticmethod(MakeKey)
1952 def FindFirstUnusedColour(*args, **kwargs):
41e2b43e 1953 """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
54f9ee45 1954 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 1955
d14a1e28
RD
1956
1957class ImageHistogramPtr(ImageHistogram):
1958 def __init__(self, this):
1959 self.this = this
1960 if not hasattr(self,"thisown"): self.thisown = 0
1961 self.__class__ = ImageHistogram
54f9ee45 1962_core_.ImageHistogram_swigregister(ImageHistogramPtr)
d14a1e28 1963
e811c8ce 1964def ImageHistogram_MakeKey(*args, **kwargs):
0df68c9f
RD
1965 """
1966 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1967
0df68c9f
RD
1968 Get the key in the histogram for the given RGB values
1969 """
54f9ee45 1970 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28
RD
1971
1972class Image(Object):
e811c8ce
RD
1973 def __repr__(self):
1974 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1975 def __init__(self, *args, **kwargs):
a95a7133 1976 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 1977 newobj = _core_.new_Image(*args, **kwargs)
d14a1e28
RD
1978 self.this = newobj.this
1979 self.thisown = 1
1980 del newobj.thisown
54f9ee45 1981 def __del__(self, destroy=_core_.delete_Image):
a95a7133 1982 """__del__(self)"""
d14a1e28
RD
1983 try:
1984 if self.thisown: destroy(self)
1985 except: pass
e811c8ce
RD
1986
1987 def Create(*args, **kwargs):
a95a7133 1988 """Create(self, int width, int height)"""
54f9ee45 1989 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
1990
1991 def Destroy(*args, **kwargs):
0df68c9f 1992 """
a95a7133 1993 Destroy(self)
e811c8ce 1994
0df68c9f
RD
1995 Deletes the C++ object this Python object is a proxy for.
1996 """
54f9ee45 1997 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
1998
1999 def Scale(*args, **kwargs):
a95a7133 2000 """Scale(self, int width, int height) -> Image"""
54f9ee45 2001 return _core_.Image_Scale(*args, **kwargs)
e811c8ce
RD
2002
2003 def ShrinkBy(*args, **kwargs):
a95a7133 2004 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
54f9ee45 2005 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2006
2007 def Rescale(*args, **kwargs):
a95a7133 2008 """Rescale(self, int width, int height) -> Image"""
54f9ee45 2009 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce
RD
2010
2011 def SetRGB(*args, **kwargs):
a95a7133 2012 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2013 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce
RD
2014
2015 def GetRed(*args, **kwargs):
a95a7133 2016 """GetRed(self, int x, int y) -> unsigned char"""
54f9ee45 2017 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2018
2019 def GetGreen(*args, **kwargs):
a95a7133 2020 """GetGreen(self, int x, int y) -> unsigned char"""
54f9ee45 2021 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2022
2023 def GetBlue(*args, **kwargs):
a95a7133 2024 """GetBlue(self, int x, int y) -> unsigned char"""
54f9ee45 2025 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2026
2027 def SetAlpha(*args, **kwargs):
a95a7133 2028 """SetAlpha(self, int x, int y, unsigned char alpha)"""
54f9ee45 2029 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2030
2031 def GetAlpha(*args, **kwargs):
a95a7133 2032 """GetAlpha(self, int x, int y) -> unsigned char"""
54f9ee45 2033 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2034
2035 def HasAlpha(*args, **kwargs):
a95a7133 2036 """HasAlpha(self) -> bool"""
54f9ee45 2037 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce
RD
2038
2039 def FindFirstUnusedColour(*args, **kwargs):
41e2b43e 2040 """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
54f9ee45 2041 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce
RD
2042
2043 def SetMaskFromImage(*args, **kwargs):
a95a7133 2044 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2045 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2046
2047 def CanRead(*args, **kwargs):
66c033b4 2048 """CanRead(String name) -> bool"""
54f9ee45 2049 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2050
2051 CanRead = staticmethod(CanRead)
2052 def GetImageCount(*args, **kwargs):
66c033b4 2053 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2054 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2055
2056 GetImageCount = staticmethod(GetImageCount)
2057 def LoadFile(*args, **kwargs):
a95a7133 2058 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2059 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2060
2061 def LoadMimeFile(*args, **kwargs):
a95a7133 2062 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2063 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2064
2065 def SaveFile(*args, **kwargs):
a95a7133 2066 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2067 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2068
2069 def SaveMimeFile(*args, **kwargs):
a95a7133 2070 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2071 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2072
2073 def CanReadStream(*args, **kwargs):
66c033b4 2074 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2075 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2076
2077 CanReadStream = staticmethod(CanReadStream)
2078 def LoadStream(*args, **kwargs):
a95a7133 2079 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2080 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2081
2082 def LoadMimeStream(*args, **kwargs):
a95a7133 2083 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2084 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2085
2086 def Ok(*args, **kwargs):
a95a7133 2087 """Ok(self) -> bool"""
54f9ee45 2088 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2089
2090 def GetWidth(*args, **kwargs):
a95a7133 2091 """GetWidth(self) -> int"""
54f9ee45 2092 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2093
2094 def GetHeight(*args, **kwargs):
a95a7133 2095 """GetHeight(self) -> int"""
54f9ee45 2096 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2097
b2df227b 2098 def GetSize(*args, **kwargs):
a95a7133 2099 """GetSize(self) -> Size"""
54f9ee45 2100 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2101
e811c8ce 2102 def GetSubImage(*args, **kwargs):
a95a7133 2103 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2104 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce
RD
2105
2106 def Copy(*args, **kwargs):
a95a7133 2107 """Copy(self) -> Image"""
54f9ee45 2108 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2109
2110 def Paste(*args, **kwargs):
a95a7133 2111 """Paste(self, Image image, int x, int y)"""
54f9ee45 2112 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2113
2114 def GetData(*args, **kwargs):
a95a7133 2115 """GetData(self) -> PyObject"""
54f9ee45 2116 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2117
2118 def SetData(*args, **kwargs):
a95a7133 2119 """SetData(self, PyObject data)"""
54f9ee45 2120 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2121
2122 def GetDataBuffer(*args, **kwargs):
a95a7133 2123 """GetDataBuffer(self) -> PyObject"""
54f9ee45 2124 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2125
2126 def SetDataBuffer(*args, **kwargs):
a95a7133 2127 """SetDataBuffer(self, PyObject data)"""
54f9ee45 2128 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2129
2130 def GetAlphaData(*args, **kwargs):
a95a7133 2131 """GetAlphaData(self) -> PyObject"""
54f9ee45 2132 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2133
2134 def SetAlphaData(*args, **kwargs):
a95a7133 2135 """SetAlphaData(self, PyObject data)"""
54f9ee45 2136 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2137
2138 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2139 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2140 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2141
2142 def SetAlphaBuffer(*args, **kwargs):
a95a7133 2143 """SetAlphaBuffer(self, PyObject data)"""
54f9ee45 2144 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2145
2146 def SetMaskColour(*args, **kwargs):
a95a7133 2147 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2148 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce
RD
2149
2150 def GetMaskRed(*args, **kwargs):
a95a7133 2151 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2152 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2153
2154 def GetMaskGreen(*args, **kwargs):
a95a7133 2155 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2156 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2157
2158 def GetMaskBlue(*args, **kwargs):
a95a7133 2159 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2160 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2161
2162 def SetMask(*args, **kwargs):
a95a7133 2163 """SetMask(self, bool mask=True)"""
54f9ee45 2164 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2165
2166 def HasMask(*args, **kwargs):
a95a7133 2167 """HasMask(self) -> bool"""
54f9ee45 2168 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2169
2170 def Rotate(*args, **kwargs):
0df68c9f 2171 """
a95a7133 2172 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2173 Point offset_after_rotation=None) -> Image
2174 """
54f9ee45 2175 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2176
2177 def Rotate90(*args, **kwargs):
a95a7133 2178 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2179 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2180
2181 def Mirror(*args, **kwargs):
a95a7133 2182 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2183 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2184
2185 def Replace(*args, **kwargs):
0df68c9f 2186 """
a95a7133 2187 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2188 unsigned char r2, unsigned char g2, unsigned char b2)
2189 """
54f9ee45 2190 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2191
2192 def ConvertToMono(*args, **kwargs):
a95a7133 2193 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2194 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2195
2196 def SetOption(*args, **kwargs):
a95a7133 2197 """SetOption(self, String name, String value)"""
54f9ee45 2198 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2199
2200 def SetOptionInt(*args, **kwargs):
a95a7133 2201 """SetOptionInt(self, String name, int value)"""
54f9ee45 2202 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2203
2204 def GetOption(*args, **kwargs):
a95a7133 2205 """GetOption(self, String name) -> String"""
54f9ee45 2206 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2207
2208 def GetOptionInt(*args, **kwargs):
a95a7133 2209 """GetOptionInt(self, String name) -> int"""
54f9ee45 2210 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2211
2212 def HasOption(*args, **kwargs):
a95a7133 2213 """HasOption(self, String name) -> bool"""
54f9ee45 2214 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2215
2216 def CountColours(*args, **kwargs):
a95a7133 2217 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2218 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2219
2220 def ComputeHistogram(*args, **kwargs):
a95a7133 2221 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2222 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2223
2224 def AddHandler(*args, **kwargs):
66c033b4 2225 """AddHandler(ImageHandler handler)"""
54f9ee45 2226 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2227
2228 AddHandler = staticmethod(AddHandler)
2229 def InsertHandler(*args, **kwargs):
66c033b4 2230 """InsertHandler(ImageHandler handler)"""
54f9ee45 2231 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2232
2233 InsertHandler = staticmethod(InsertHandler)
2234 def RemoveHandler(*args, **kwargs):
66c033b4 2235 """RemoveHandler(String name) -> bool"""
54f9ee45 2236 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2237
2238 RemoveHandler = staticmethod(RemoveHandler)
2239 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2240 """GetImageExtWildcard() -> String"""
54f9ee45 2241 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2242
2243 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2244 def ConvertToBitmap(*args, **kwargs):
a95a7133 2245 """ConvertToBitmap(self) -> Bitmap"""
54f9ee45 2246 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2247
2248 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2249 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2250 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2251
2252 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2253
2254class ImagePtr(Image):
2255 def __init__(self, this):
2256 self.this = this
2257 if not hasattr(self,"thisown"): self.thisown = 0
2258 self.__class__ = Image
54f9ee45 2259_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2260
2261def ImageFromMime(*args, **kwargs):
196addbf 2262 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2263 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2264 val.thisown = 1
2265 return val
2266
2267def ImageFromStream(*args, **kwargs):
196addbf 2268 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2269 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2270 val.thisown = 1
2271 return val
2272
2273def ImageFromStreamMime(*args, **kwargs):
196addbf 2274 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2275 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2276 val.thisown = 1
2277 return val
2278
66c033b4
RD
2279def EmptyImage(*args, **kwargs):
2280 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2281 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2282 val.thisown = 1
2283 return val
2284
2285def ImageFromBitmap(*args, **kwargs):
196addbf 2286 """ImageFromBitmap(Bitmap bitmap) -> Image"""
54f9ee45 2287 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2288 val.thisown = 1
2289 return val
2290
2291def ImageFromData(*args, **kwargs):
e811c8ce 2292 """ImageFromData(int width, int height, unsigned char data) -> Image"""
54f9ee45 2293 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2294 val.thisown = 1
2295 return val
2296
e811c8ce 2297def Image_CanRead(*args, **kwargs):
196addbf 2298 """Image_CanRead(String name) -> bool"""
54f9ee45 2299 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2300
e811c8ce 2301def Image_GetImageCount(*args, **kwargs):
196addbf 2302 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2303 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2304
e811c8ce 2305def Image_CanReadStream(*args, **kwargs):
196addbf 2306 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2307 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2308
e811c8ce
RD
2309def Image_AddHandler(*args, **kwargs):
2310 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2311 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2312
e811c8ce
RD
2313def Image_InsertHandler(*args, **kwargs):
2314 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2315 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2316
e811c8ce 2317def Image_RemoveHandler(*args, **kwargs):
196addbf 2318 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2319 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2320
e811c8ce 2321def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2322 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2323 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2324
5e4ca4a8
RD
2325def InitAllImageHandlers():
2326 """
2327 The former functionality of InitAllImageHanders is now done internal to
2328 the _core_ extension module and so this function has become a simple NOP.
2329 """
2330 pass
d14a1e28 2331
54f9ee45
RD
2332IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2333IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2334BMP_24BPP = _core_.BMP_24BPP
2335BMP_8BPP = _core_.BMP_8BPP
2336BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2337BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2338BMP_8BPP_RED = _core_.BMP_8BPP_RED
2339BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2340BMP_4BPP = _core_.BMP_4BPP
2341BMP_1BPP = _core_.BMP_1BPP
2342BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2343class BMPHandler(ImageHandler):
e811c8ce
RD
2344 def __repr__(self):
2345 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2346 def __init__(self, *args, **kwargs):
a95a7133 2347 """__init__(self) -> BMPHandler"""
54f9ee45 2348 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2349 self.this = newobj.this
2350 self.thisown = 1
2351 del newobj.thisown
d14a1e28
RD
2352
2353class BMPHandlerPtr(BMPHandler):
2354 def __init__(self, this):
2355 self.this = this
2356 if not hasattr(self,"thisown"): self.thisown = 0
2357 self.__class__ = BMPHandler
54f9ee45 2358_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28
RD
2359NullImage = cvar.NullImage
2360IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2361IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2362IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2363IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2364IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2365
2366class ICOHandler(BMPHandler):
e811c8ce
RD
2367 def __repr__(self):
2368 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2369 def __init__(self, *args, **kwargs):
a95a7133 2370 """__init__(self) -> ICOHandler"""
54f9ee45 2371 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2372 self.this = newobj.this
2373 self.thisown = 1
2374 del newobj.thisown
d14a1e28
RD
2375
2376class ICOHandlerPtr(ICOHandler):
2377 def __init__(self, this):
2378 self.this = this
2379 if not hasattr(self,"thisown"): self.thisown = 0
2380 self.__class__ = ICOHandler
54f9ee45 2381_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2382
2383class CURHandler(ICOHandler):
e811c8ce
RD
2384 def __repr__(self):
2385 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2386 def __init__(self, *args, **kwargs):
a95a7133 2387 """__init__(self) -> CURHandler"""
54f9ee45 2388 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2389 self.this = newobj.this
2390 self.thisown = 1
2391 del newobj.thisown
d14a1e28
RD
2392
2393class CURHandlerPtr(CURHandler):
2394 def __init__(self, this):
2395 self.this = this
2396 if not hasattr(self,"thisown"): self.thisown = 0
2397 self.__class__ = CURHandler
54f9ee45 2398_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2399
2400class ANIHandler(CURHandler):
e811c8ce
RD
2401 def __repr__(self):
2402 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2403 def __init__(self, *args, **kwargs):
a95a7133 2404 """__init__(self) -> ANIHandler"""
54f9ee45 2405 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2406 self.this = newobj.this
2407 self.thisown = 1
2408 del newobj.thisown
d14a1e28
RD
2409
2410class ANIHandlerPtr(ANIHandler):
2411 def __init__(self, this):
2412 self.this = this
2413 if not hasattr(self,"thisown"): self.thisown = 0
2414 self.__class__ = ANIHandler
54f9ee45 2415_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2416
2417class PNGHandler(ImageHandler):
e811c8ce
RD
2418 def __repr__(self):
2419 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2420 def __init__(self, *args, **kwargs):
a95a7133 2421 """__init__(self) -> PNGHandler"""
54f9ee45 2422 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2423 self.this = newobj.this
2424 self.thisown = 1
2425 del newobj.thisown
d14a1e28
RD
2426
2427class PNGHandlerPtr(PNGHandler):
2428 def __init__(self, this):
2429 self.this = this
2430 if not hasattr(self,"thisown"): self.thisown = 0
2431 self.__class__ = PNGHandler
54f9ee45 2432_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2433
2434class GIFHandler(ImageHandler):
e811c8ce
RD
2435 def __repr__(self):
2436 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2437 def __init__(self, *args, **kwargs):
a95a7133 2438 """__init__(self) -> GIFHandler"""
54f9ee45 2439 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2440 self.this = newobj.this
2441 self.thisown = 1
2442 del newobj.thisown
d14a1e28
RD
2443
2444class GIFHandlerPtr(GIFHandler):
2445 def __init__(self, this):
2446 self.this = this
2447 if not hasattr(self,"thisown"): self.thisown = 0
2448 self.__class__ = GIFHandler
54f9ee45 2449_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2450
2451class PCXHandler(ImageHandler):
e811c8ce
RD
2452 def __repr__(self):
2453 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2454 def __init__(self, *args, **kwargs):
a95a7133 2455 """__init__(self) -> PCXHandler"""
54f9ee45 2456 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2457 self.this = newobj.this
2458 self.thisown = 1
2459 del newobj.thisown
d14a1e28
RD
2460
2461class PCXHandlerPtr(PCXHandler):
2462 def __init__(self, this):
2463 self.this = this
2464 if not hasattr(self,"thisown"): self.thisown = 0
2465 self.__class__ = PCXHandler
54f9ee45 2466_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2467
2468class JPEGHandler(ImageHandler):
e811c8ce
RD
2469 def __repr__(self):
2470 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2471 def __init__(self, *args, **kwargs):
a95a7133 2472 """__init__(self) -> JPEGHandler"""
54f9ee45 2473 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2474 self.this = newobj.this
2475 self.thisown = 1
2476 del newobj.thisown
d14a1e28
RD
2477
2478class JPEGHandlerPtr(JPEGHandler):
2479 def __init__(self, this):
2480 self.this = this
2481 if not hasattr(self,"thisown"): self.thisown = 0
2482 self.__class__ = JPEGHandler
54f9ee45 2483_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2484
2485class PNMHandler(ImageHandler):
e811c8ce
RD
2486 def __repr__(self):
2487 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2488 def __init__(self, *args, **kwargs):
a95a7133 2489 """__init__(self) -> PNMHandler"""
54f9ee45 2490 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2491 self.this = newobj.this
2492 self.thisown = 1
2493 del newobj.thisown
d14a1e28
RD
2494
2495class PNMHandlerPtr(PNMHandler):
2496 def __init__(self, this):
2497 self.this = this
2498 if not hasattr(self,"thisown"): self.thisown = 0
2499 self.__class__ = PNMHandler
54f9ee45 2500_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2501
2502class XPMHandler(ImageHandler):
e811c8ce
RD
2503 def __repr__(self):
2504 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2505 def __init__(self, *args, **kwargs):
a95a7133 2506 """__init__(self) -> XPMHandler"""
54f9ee45 2507 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2508 self.this = newobj.this
2509 self.thisown = 1
2510 del newobj.thisown
d14a1e28
RD
2511
2512class XPMHandlerPtr(XPMHandler):
2513 def __init__(self, this):
2514 self.this = this
2515 if not hasattr(self,"thisown"): self.thisown = 0
2516 self.__class__ = XPMHandler
54f9ee45 2517_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2518
2519class TIFFHandler(ImageHandler):
e811c8ce
RD
2520 def __repr__(self):
2521 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2522 def __init__(self, *args, **kwargs):
a95a7133 2523 """__init__(self) -> TIFFHandler"""
54f9ee45 2524 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2525 self.this = newobj.this
2526 self.thisown = 1
2527 del newobj.thisown
d14a1e28
RD
2528
2529class TIFFHandlerPtr(TIFFHandler):
2530 def __init__(self, this):
2531 self.this = this
2532 if not hasattr(self,"thisown"): self.thisown = 0
2533 self.__class__ = TIFFHandler
54f9ee45 2534_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28
RD
2535
2536#---------------------------------------------------------------------------
2537
2538class EvtHandler(Object):
e811c8ce
RD
2539 def __repr__(self):
2540 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2541 def __init__(self, *args, **kwargs):
a95a7133 2542 """__init__(self) -> EvtHandler"""
54f9ee45 2543 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2544 self.this = newobj.this
2545 self.thisown = 1
2546 del newobj.thisown
e811c8ce 2547 def GetNextHandler(*args, **kwargs):
a95a7133 2548 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2549 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2550
2551 def GetPreviousHandler(*args, **kwargs):
a95a7133 2552 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2553 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2554
2555 def SetNextHandler(*args, **kwargs):
a95a7133 2556 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2557 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2558
2559 def SetPreviousHandler(*args, **kwargs):
a95a7133 2560 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2561 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2562
2563 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2564 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2565 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2566
2567 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2568 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2569 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2570
2571 def ProcessEvent(*args, **kwargs):
a95a7133 2572 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2573 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2574
2575 def AddPendingEvent(*args, **kwargs):
a95a7133 2576 """AddPendingEvent(self, Event event)"""
54f9ee45 2577 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2578
2579 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2580 """ProcessPendingEvents(self)"""
54f9ee45 2581 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2582
2583 def Connect(*args, **kwargs):
a95a7133 2584 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2585 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2586
2587 def Disconnect(*args, **kwargs):
a95a7133 2588 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2589 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2590
2591 def _setOORInfo(*args, **kwargs):
a95a7133 2592 """_setOORInfo(self, PyObject _self)"""
54f9ee45 2593 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2594
d14a1e28
RD
2595 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2596 """
2597 Bind an event to an event handler.
2598
db3e571a
RD
2599 :param event: One of the EVT_* objects that specifies the
2600 type of event to bind,
d14a1e28 2601
db3e571a
RD
2602 :param handler: A callable object to be invoked when the
2603 event is delivered to self. Pass None to
2604 disconnect an event handler.
d14a1e28 2605
db3e571a
RD
2606 :param source: Sometimes the event originates from a
2607 different window than self, but you still
2608 want to catch it in self. (For example, a
2609 button event delivered to a frame.) By
2610 passing the source of the event, the event
2611 handling system is able to differentiate
2612 between the same event type from different
2613 controls.
d14a1e28 2614
db3e571a
RD
2615 :param id: Used to spcify the event source by ID instead
2616 of instance.
2617
2618 :param id2: Used when it is desirable to bind a handler
2619 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2620 """
2621 if source is not None:
2622 id = source.GetId()
2623 event.Bind(self, id, id2, handler)
2624
66c033b4
RD
2625 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2626 """
2627 Disconencts the event handler binding for event from self.
2628 Returns True if successful.
2629 """
2630 if source is not None:
2631 id = source.GetId()
2632 return event.Unbind(self, id, id2)
d14a1e28 2633
d14a1e28
RD
2634
2635class EvtHandlerPtr(EvtHandler):
2636 def __init__(self, this):
2637 self.this = this
2638 if not hasattr(self,"thisown"): self.thisown = 0
2639 self.__class__ = EvtHandler
54f9ee45 2640_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
2641
2642#---------------------------------------------------------------------------
2643
2644class PyEventBinder(object):
2645 """
2646 Instances of this class are used to bind specific events to event
2647 handlers.
2648 """
2649 def __init__(self, evtType, expectedIDs=0):
2650 if expectedIDs not in [0, 1, 2]:
2651 raise ValueError, "Invalid number of expectedIDs"
2652 self.expectedIDs = expectedIDs
2653
2654 if type(evtType) == list or type(evtType) == tuple:
2655 self.evtType = evtType
2656 else:
2657 self.evtType = [evtType]
2658
2659
2660 def Bind(self, target, id1, id2, function):
2661 """Bind this set of event types to target."""
2662 for et in self.evtType:
2663 target.Connect(id1, id2, et, function)
2664
66c033b4
RD
2665
2666 def Unbind(self, target, id1, id2):
2667 """Remove an event binding."""
2668 success = 0
2669 for et in self.evtType:
2670 success += target.Disconnect(id1, id2, et)
2671 return success != 0
2672
d14a1e28
RD
2673
2674 def __call__(self, *args):
2675 """
2676 For backwards compatibility with the old EVT_* functions.
2677 Should be called with either (window, func), (window, ID,
2678 func) or (window, ID1, ID2, func) parameters depending on the
2679 type of the event.
2680 """
2681 assert len(args) == 2 + self.expectedIDs
2682 id1 = wx.ID_ANY
2683 id2 = wx.ID_ANY
2684 target = args[0]
2685 if self.expectedIDs == 0:
2686 func = args[1]
2687 elif self.expectedIDs == 1:
2688 id1 = args[1]
2689 func = args[2]
2690 elif self.expectedIDs == 2:
2691 id1 = args[1]
2692 id2 = args[2]
2693 func = args[3]
2694 else:
2695 raise ValueError, "Unexpected number of IDs"
2696
2697 self.Bind(target, id1, id2, func)
2698
2699
2700# These two are square pegs that don't fit the PyEventBinder hole...
2701def EVT_COMMAND(win, id, cmd, func):
2702 win.Connect(id, -1, cmd, func)
2703def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2704 win.Connect(id1, id2, cmd, func)
2705
2706
2707#---------------------------------------------------------------------------
2708
2709#---------------------------------------------------------------------------
2710
54f9ee45
RD
2711EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2712EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 2713
e811c8ce
RD
2714def NewEventType(*args, **kwargs):
2715 """NewEventType() -> wxEventType"""
54f9ee45
RD
2716 return _core_.NewEventType(*args, **kwargs)
2717wxEVT_NULL = _core_.wxEVT_NULL
2718wxEVT_FIRST = _core_.wxEVT_FIRST
2719wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2720wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2721wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2722wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2723wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2724wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2725wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2726wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2727wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2728wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2729wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2730wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2731wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2732wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2733wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2734wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2735wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2736wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2737wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2738wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2739wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2740wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2741wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2742wxEVT_MOTION = _core_.wxEVT_MOTION
2743wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2744wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2745wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2746wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2747wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2748wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2749wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2750wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2751wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2752wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2753wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2754wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2755wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2756wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2757wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2758wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2759wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2760wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2761wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2762wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2763wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2764wxEVT_CHAR = _core_.wxEVT_CHAR
2765wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2766wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2767wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2768wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2769wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2770wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2771wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2772wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2773wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2774wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2775wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2776wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2777wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2778wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2779wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2780wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2781wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2782wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2783wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2784wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2785wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2786wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2787wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2788wxEVT_SIZE = _core_.wxEVT_SIZE
2789wxEVT_MOVE = _core_.wxEVT_MOVE
2790wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2791wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2792wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2793wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2794wxEVT_POWER = _core_.wxEVT_POWER
2795wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2796wxEVT_CREATE = _core_.wxEVT_CREATE
2797wxEVT_DESTROY = _core_.wxEVT_DESTROY
2798wxEVT_SHOW = _core_.wxEVT_SHOW
2799wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2800wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2801wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2802wxEVT_PAINT = _core_.wxEVT_PAINT
2803wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2804wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2805wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2806wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2807wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2808wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2809wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2810wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2811wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2812wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2813wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2814wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2815wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2816wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2817wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2818wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2819wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2820wxEVT_IDLE = _core_.wxEVT_IDLE
2821wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2822wxEVT_SIZING = _core_.wxEVT_SIZING
2823wxEVT_MOVING = _core_.wxEVT_MOVING
2824wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2825wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2826wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2827wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2828wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2829wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2830wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
2831#
2832# Create some event binders
2833EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2834EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2835EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2836EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2837EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2838EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2839EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2840EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2841EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2842EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2843EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2844EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2845EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2846EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2847EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2848EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2849EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2850EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2851EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2852EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2853EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2854EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2855EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2856EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2857EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2858EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2859EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
2860EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
2861EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
2862EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
2863EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
2864EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
2865EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
2866EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
2867EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
2868EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
2869EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
2870EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
2871EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
2872EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
2873
2874EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
2875EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
2876EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
2877EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
2878EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
2879EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
2880EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
2881EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
2882EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
2883EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
2884EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
2885EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
2886EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
2887
2888EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
2889 wxEVT_LEFT_UP,
2890 wxEVT_MIDDLE_DOWN,
2891 wxEVT_MIDDLE_UP,
2892 wxEVT_RIGHT_DOWN,
2893 wxEVT_RIGHT_UP,
2894 wxEVT_MOTION,
2895 wxEVT_LEFT_DCLICK,
2896 wxEVT_MIDDLE_DCLICK,
2897 wxEVT_RIGHT_DCLICK,
2898 wxEVT_ENTER_WINDOW,
2899 wxEVT_LEAVE_WINDOW,
2900 wxEVT_MOUSEWHEEL
2901 ])
2902
2903
2904# Scrolling from wxWindow (sent to wxScrolledWindow)
2905EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
2906 wxEVT_SCROLLWIN_BOTTOM,
2907 wxEVT_SCROLLWIN_LINEUP,
2908 wxEVT_SCROLLWIN_LINEDOWN,
2909 wxEVT_SCROLLWIN_PAGEUP,
2910 wxEVT_SCROLLWIN_PAGEDOWN,
2911 wxEVT_SCROLLWIN_THUMBTRACK,
2912 wxEVT_SCROLLWIN_THUMBRELEASE,
2913 ])
2914
2915EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
2916EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
2917EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
2918EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
2919EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
2920EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
2921EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
2922EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
2923
2924# Scrolling from wxSlider and wxScrollBar
2925EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2926 wxEVT_SCROLL_BOTTOM,
2927 wxEVT_SCROLL_LINEUP,
2928 wxEVT_SCROLL_LINEDOWN,
2929 wxEVT_SCROLL_PAGEUP,
2930 wxEVT_SCROLL_PAGEDOWN,
2931 wxEVT_SCROLL_THUMBTRACK,
2932 wxEVT_SCROLL_THUMBRELEASE,
2933 wxEVT_SCROLL_ENDSCROLL,
2934 ])
2935
2936EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
2937EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
2938EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
2939EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
2940EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
2941EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
2942EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
2943EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
2944EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
2945
2946# Scrolling from wxSlider and wxScrollBar, with an id
2947EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2948 wxEVT_SCROLL_BOTTOM,
2949 wxEVT_SCROLL_LINEUP,
2950 wxEVT_SCROLL_LINEDOWN,
2951 wxEVT_SCROLL_PAGEUP,
2952 wxEVT_SCROLL_PAGEDOWN,
2953 wxEVT_SCROLL_THUMBTRACK,
2954 wxEVT_SCROLL_THUMBRELEASE,
2955 wxEVT_SCROLL_ENDSCROLL,
2956 ], 1)
2957
2958EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
2959EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
2960EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
2961EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
2962EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
2963EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
2964EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
2965EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
2966EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
2967
d14a1e28
RD
2968EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
2969EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
2970EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
2971EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
2972EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
2973EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
2974EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
2975EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
2976EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
2977EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
2978
2979EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
2980EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
2981EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
2982EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
2983EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
2984EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
2985EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
2986EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
2987EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
2988
2989
2990EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
2991EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
2992EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
2993EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
2994EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
2995EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
2996EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
2997
2998EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
2999
3000EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3001EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3002
3003EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3004
3005
3006
3007#---------------------------------------------------------------------------
3008
3009class Event(Object):
e811c8ce
RD
3010 def __init__(self): raise RuntimeError, "No constructor defined"
3011 def __repr__(self):
3012 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3013 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3014 """__del__(self)"""
d14a1e28
RD
3015 try:
3016 if self.thisown: destroy(self)
3017 except: pass
e811c8ce
RD
3018
3019 def SetEventType(*args, **kwargs):
a95a7133 3020 """SetEventType(self, wxEventType typ)"""
54f9ee45 3021 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3022
3023 def GetEventType(*args, **kwargs):
a95a7133 3024 """GetEventType(self) -> wxEventType"""
54f9ee45 3025 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3026
3027 def GetEventObject(*args, **kwargs):
a95a7133 3028 """GetEventObject(self) -> Object"""
54f9ee45 3029 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3030
3031 def SetEventObject(*args, **kwargs):
a95a7133 3032 """SetEventObject(self, Object obj)"""
54f9ee45 3033 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3034
3035 def GetTimestamp(*args, **kwargs):
a95a7133 3036 """GetTimestamp(self) -> long"""
54f9ee45 3037 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3038
3039 def SetTimestamp(*args, **kwargs):
a95a7133 3040 """SetTimestamp(self, long ts=0)"""
54f9ee45 3041 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3042
3043 def GetId(*args, **kwargs):
a95a7133 3044 """GetId(self) -> int"""
54f9ee45 3045 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3046
3047 def SetId(*args, **kwargs):
a95a7133 3048 """SetId(self, int Id)"""
54f9ee45 3049 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3050
3051 def IsCommandEvent(*args, **kwargs):
a95a7133 3052 """IsCommandEvent(self) -> bool"""
54f9ee45 3053 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3054
3055 def Skip(*args, **kwargs):
a95a7133 3056 """Skip(self, bool skip=True)"""
54f9ee45 3057 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3058
3059 def GetSkipped(*args, **kwargs):
a95a7133 3060 """GetSkipped(self) -> bool"""
54f9ee45 3061 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3062
3063 def ShouldPropagate(*args, **kwargs):
a95a7133 3064 """ShouldPropagate(self) -> bool"""
54f9ee45 3065 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3066
3067 def StopPropagation(*args, **kwargs):
a95a7133 3068 """StopPropagation(self) -> int"""
54f9ee45 3069 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3070
3071 def ResumePropagation(*args, **kwargs):
a95a7133 3072 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3073 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3074
3075 def Clone(*args, **kwargs):
a95a7133 3076 """Clone(self) -> Event"""
54f9ee45 3077 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3078
d14a1e28
RD
3079
3080class EventPtr(Event):
3081 def __init__(self, this):
3082 self.this = this
3083 if not hasattr(self,"thisown"): self.thisown = 0
3084 self.__class__ = Event
54f9ee45 3085_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3086
3087#---------------------------------------------------------------------------
3088
3089class PropagationDisabler(object):
e811c8ce
RD
3090 def __repr__(self):
3091 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3092 def __init__(self, *args, **kwargs):
a95a7133 3093 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3094 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3095 self.this = newobj.this
3096 self.thisown = 1
3097 del newobj.thisown
54f9ee45 3098 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3099 """__del__(self)"""
d14a1e28
RD
3100 try:
3101 if self.thisown: destroy(self)
3102 except: pass
e811c8ce 3103
d14a1e28
RD
3104
3105class PropagationDisablerPtr(PropagationDisabler):
3106 def __init__(self, this):
3107 self.this = this
3108 if not hasattr(self,"thisown"): self.thisown = 0
3109 self.__class__ = PropagationDisabler
54f9ee45 3110_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3111
3112class PropagateOnce(object):
e811c8ce
RD
3113 def __repr__(self):
3114 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3115 def __init__(self, *args, **kwargs):
a95a7133 3116 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3117 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3118 self.this = newobj.this
3119 self.thisown = 1
3120 del newobj.thisown
54f9ee45 3121 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3122 """__del__(self)"""
d14a1e28
RD
3123 try:
3124 if self.thisown: destroy(self)
3125 except: pass
e811c8ce 3126
d14a1e28
RD
3127
3128class PropagateOncePtr(PropagateOnce):
3129 def __init__(self, this):
3130 self.this = this
3131 if not hasattr(self,"thisown"): self.thisown = 0
3132 self.__class__ = PropagateOnce
54f9ee45 3133_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3134
3135#---------------------------------------------------------------------------
3136
3137class CommandEvent(Event):
e811c8ce
RD
3138 def __repr__(self):
3139 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3140 def __init__(self, *args, **kwargs):
a95a7133 3141 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3142 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3143 self.this = newobj.this
3144 self.thisown = 1
3145 del newobj.thisown
e811c8ce 3146 def GetSelection(*args, **kwargs):
a95a7133 3147 """GetSelection(self) -> int"""
54f9ee45 3148 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3149
3150 def SetString(*args, **kwargs):
a95a7133 3151 """SetString(self, String s)"""
54f9ee45 3152 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3153
3154 def GetString(*args, **kwargs):
a95a7133 3155 """GetString(self) -> String"""
54f9ee45 3156 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3157
3158 def IsChecked(*args, **kwargs):
a95a7133 3159 """IsChecked(self) -> bool"""
54f9ee45 3160 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3161
242b7b46 3162 Checked = IsChecked
e811c8ce 3163 def IsSelection(*args, **kwargs):
a95a7133 3164 """IsSelection(self) -> bool"""
54f9ee45 3165 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3166
3167 def SetExtraLong(*args, **kwargs):
a95a7133 3168 """SetExtraLong(self, long extraLong)"""
54f9ee45 3169 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3170
3171 def GetExtraLong(*args, **kwargs):
a95a7133 3172 """GetExtraLong(self) -> long"""
54f9ee45 3173 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3174
3175 def SetInt(*args, **kwargs):
a95a7133 3176 """SetInt(self, int i)"""
54f9ee45 3177 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3178
3179 def GetInt(*args, **kwargs):
a95a7133 3180 """GetInt(self) -> long"""
54f9ee45 3181 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3182
3183 def Clone(*args, **kwargs):
a95a7133 3184 """Clone(self) -> Event"""
54f9ee45 3185 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3186
d14a1e28
RD
3187
3188class CommandEventPtr(CommandEvent):
3189 def __init__(self, this):
3190 self.this = this
3191 if not hasattr(self,"thisown"): self.thisown = 0
3192 self.__class__ = CommandEvent
54f9ee45 3193_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3194
3195#---------------------------------------------------------------------------
3196
3197class NotifyEvent(CommandEvent):
e811c8ce
RD
3198 def __repr__(self):
3199 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3200 def __init__(self, *args, **kwargs):
a95a7133 3201 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3202 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3203 self.this = newobj.this
3204 self.thisown = 1
3205 del newobj.thisown
e811c8ce 3206 def Veto(*args, **kwargs):
a95a7133 3207 """Veto(self)"""
54f9ee45 3208 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3209
3210 def Allow(*args, **kwargs):
a95a7133 3211 """Allow(self)"""
54f9ee45 3212 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3213
3214 def IsAllowed(*args, **kwargs):
a95a7133 3215 """IsAllowed(self) -> bool"""
54f9ee45 3216 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3217
d14a1e28
RD
3218
3219class NotifyEventPtr(NotifyEvent):
3220 def __init__(self, this):
3221 self.this = this
3222 if not hasattr(self,"thisown"): self.thisown = 0
3223 self.__class__ = NotifyEvent
54f9ee45 3224_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3225
3226#---------------------------------------------------------------------------
3227
3228class ScrollEvent(CommandEvent):
e811c8ce
RD
3229 def __repr__(self):
3230 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3231 def __init__(self, *args, **kwargs):
0df68c9f 3232 """
a95a7133 3233 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3234 int orient=0) -> ScrollEvent
3235 """
54f9ee45 3236 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3237 self.this = newobj.this
3238 self.thisown = 1
3239 del newobj.thisown
e811c8ce 3240 def GetOrientation(*args, **kwargs):
a95a7133 3241 """GetOrientation(self) -> int"""
54f9ee45 3242 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3243
3244 def GetPosition(*args, **kwargs):
a95a7133 3245 """GetPosition(self) -> int"""
54f9ee45 3246 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3247
3248 def SetOrientation(*args, **kwargs):
a95a7133 3249 """SetOrientation(self, int orient)"""
54f9ee45 3250 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3251
3252 def SetPosition(*args, **kwargs):
a95a7133 3253 """SetPosition(self, int pos)"""
54f9ee45 3254 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3255
d14a1e28
RD
3256
3257class ScrollEventPtr(ScrollEvent):
3258 def __init__(self, this):
3259 self.this = this
3260 if not hasattr(self,"thisown"): self.thisown = 0
3261 self.__class__ = ScrollEvent
54f9ee45 3262_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3263
3264#---------------------------------------------------------------------------
3265
3266class ScrollWinEvent(Event):
e811c8ce
RD
3267 def __repr__(self):
3268 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3269 def __init__(self, *args, **kwargs):
a95a7133 3270 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3271 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3272 self.this = newobj.this
3273 self.thisown = 1
3274 del newobj.thisown
e811c8ce 3275 def GetOrientation(*args, **kwargs):
a95a7133 3276 """GetOrientation(self) -> int"""
54f9ee45 3277 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3278
3279 def GetPosition(*args, **kwargs):
a95a7133 3280 """GetPosition(self) -> int"""
54f9ee45 3281 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3282
3283 def SetOrientation(*args, **kwargs):
a95a7133 3284 """SetOrientation(self, int orient)"""
54f9ee45 3285 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3286
3287 def SetPosition(*args, **kwargs):
a95a7133 3288 """SetPosition(self, int pos)"""
54f9ee45 3289 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3290
d14a1e28
RD
3291
3292class ScrollWinEventPtr(ScrollWinEvent):
3293 def __init__(self, this):
3294 self.this = this
3295 if not hasattr(self,"thisown"): self.thisown = 0
3296 self.__class__ = ScrollWinEvent
54f9ee45 3297_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3298
3299#---------------------------------------------------------------------------
3300
54f9ee45
RD
3301MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3302MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3303MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3304MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3305MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3306class MouseEvent(Event):
e811c8ce
RD
3307 def __repr__(self):
3308 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3309 def __init__(self, *args, **kwargs):
a95a7133 3310 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3311 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3312 self.this = newobj.this
3313 self.thisown = 1
3314 del newobj.thisown
e811c8ce 3315 def IsButton(*args, **kwargs):
a95a7133 3316 """IsButton(self) -> bool"""
54f9ee45 3317 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3318
3319 def ButtonDown(*args, **kwargs):
a95a7133 3320 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3321 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3322
3323 def ButtonDClick(*args, **kwargs):
a95a7133 3324 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3325 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3326
3327 def ButtonUp(*args, **kwargs):
a95a7133 3328 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3329 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3330
3331 def Button(*args, **kwargs):
a95a7133 3332 """Button(self, int but) -> bool"""
54f9ee45 3333 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3334
3335 def ButtonIsDown(*args, **kwargs):
a95a7133 3336 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3337 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3338
3339 def GetButton(*args, **kwargs):
a95a7133 3340 """GetButton(self) -> int"""
54f9ee45 3341 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3342
3343 def ControlDown(*args, **kwargs):
a95a7133 3344 """ControlDown(self) -> bool"""
54f9ee45 3345 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3346
3347 def MetaDown(*args, **kwargs):
a95a7133 3348 """MetaDown(self) -> bool"""
54f9ee45 3349 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3350
3351 def AltDown(*args, **kwargs):
a95a7133 3352 """AltDown(self) -> bool"""
54f9ee45 3353 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3354
3355 def ShiftDown(*args, **kwargs):
a95a7133 3356 """ShiftDown(self) -> bool"""
54f9ee45 3357 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce
RD
3358
3359 def LeftDown(*args, **kwargs):
a95a7133 3360 """LeftDown(self) -> bool"""
54f9ee45 3361 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3362
3363 def MiddleDown(*args, **kwargs):
a95a7133 3364 """MiddleDown(self) -> bool"""
54f9ee45 3365 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3366
3367 def RightDown(*args, **kwargs):
a95a7133 3368 """RightDown(self) -> bool"""
54f9ee45 3369 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3370
3371 def LeftUp(*args, **kwargs):
a95a7133 3372 """LeftUp(self) -> bool"""
54f9ee45 3373 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3374
3375 def MiddleUp(*args, **kwargs):
a95a7133 3376 """MiddleUp(self) -> bool"""
54f9ee45 3377 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3378
3379 def RightUp(*args, **kwargs):
a95a7133 3380 """RightUp(self) -> bool"""
54f9ee45 3381 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3382
3383 def LeftDClick(*args, **kwargs):
a95a7133 3384 """LeftDClick(self) -> bool"""
54f9ee45 3385 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3386
3387 def MiddleDClick(*args, **kwargs):
a95a7133 3388 """MiddleDClick(self) -> bool"""
54f9ee45 3389 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3390
3391 def RightDClick(*args, **kwargs):
a95a7133 3392 """RightDClick(self) -> bool"""
54f9ee45 3393 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3394
3395 def LeftIsDown(*args, **kwargs):
a95a7133 3396 """LeftIsDown(self) -> bool"""
54f9ee45 3397 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3398
3399 def MiddleIsDown(*args, **kwargs):
a95a7133 3400 """MiddleIsDown(self) -> bool"""
54f9ee45 3401 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3402
3403 def RightIsDown(*args, **kwargs):
a95a7133 3404 """RightIsDown(self) -> bool"""
54f9ee45 3405 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3406
3407 def Dragging(*args, **kwargs):
a95a7133 3408 """Dragging(self) -> bool"""
54f9ee45 3409 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3410
3411 def Moving(*args, **kwargs):
a95a7133 3412 """Moving(self) -> bool"""
54f9ee45 3413 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3414
3415 def Entering(*args, **kwargs):
a95a7133 3416 """Entering(self) -> bool"""
54f9ee45 3417 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3418
3419 def Leaving(*args, **kwargs):
a95a7133 3420 """Leaving(self) -> bool"""
54f9ee45 3421 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3422
3423 def GetPosition(*args, **kwargs):
0df68c9f 3424 """
a95a7133 3425 GetPosition(self) -> Point
e811c8ce 3426
41e2b43e
RD
3427 Returns the position of the mouse in window coordinates when the event
3428 happened.
0df68c9f 3429 """
54f9ee45 3430 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3431
3432 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3433 """
3434 GetPositionTuple() -> (x,y)
e811c8ce 3435
41e2b43e
RD
3436 Returns the position of the mouse in window coordinates when the event
3437 happened.
0df68c9f 3438 """
54f9ee45 3439 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3440
3441 def GetLogicalPosition(*args, **kwargs):
a95a7133 3442 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3443 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3444
3445 def GetX(*args, **kwargs):
a95a7133 3446 """GetX(self) -> int"""
54f9ee45 3447 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3448
3449 def GetY(*args, **kwargs):
a95a7133 3450 """GetY(self) -> int"""
54f9ee45 3451 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3452
3453 def GetWheelRotation(*args, **kwargs):
a95a7133 3454 """GetWheelRotation(self) -> int"""
54f9ee45 3455 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3456
3457 def GetWheelDelta(*args, **kwargs):
a95a7133 3458 """GetWheelDelta(self) -> int"""
54f9ee45 3459 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3460
3461 def GetLinesPerAction(*args, **kwargs):
a95a7133 3462 """GetLinesPerAction(self) -> int"""
54f9ee45 3463 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3464
3465 def IsPageScroll(*args, **kwargs):
a95a7133 3466 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3467 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3468
3469 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3470 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3471 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3472 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3473 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3474 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3475 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3476 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3477 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3478 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3479 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3480 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3481
3482class MouseEventPtr(MouseEvent):
3483 def __init__(self, this):
3484 self.this = this
3485 if not hasattr(self,"thisown"): self.thisown = 0
3486 self.__class__ = MouseEvent
54f9ee45 3487_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3488
3489#---------------------------------------------------------------------------
3490
3491class SetCursorEvent(Event):
e811c8ce
RD
3492 def __repr__(self):
3493 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3494 def __init__(self, *args, **kwargs):
a95a7133 3495 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3496 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3497 self.this = newobj.this
3498 self.thisown = 1
3499 del newobj.thisown
e811c8ce 3500 def GetX(*args, **kwargs):
a95a7133 3501 """GetX(self) -> int"""
54f9ee45 3502 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3503
3504 def GetY(*args, **kwargs):
a95a7133 3505 """GetY(self) -> int"""
54f9ee45 3506 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3507
3508 def SetCursor(*args, **kwargs):
a95a7133 3509 """SetCursor(self, Cursor cursor)"""
54f9ee45 3510 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3511
3512 def GetCursor(*args, **kwargs):
a95a7133 3513 """GetCursor(self) -> Cursor"""
54f9ee45 3514 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3515
3516 def HasCursor(*args, **kwargs):
a95a7133 3517 """HasCursor(self) -> bool"""
54f9ee45 3518 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3519
d14a1e28
RD
3520
3521class SetCursorEventPtr(SetCursorEvent):
3522 def __init__(self, this):
3523 self.this = this
3524 if not hasattr(self,"thisown"): self.thisown = 0
3525 self.__class__ = SetCursorEvent
54f9ee45 3526_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3527
3528#---------------------------------------------------------------------------
3529
3530class KeyEvent(Event):
e811c8ce
RD
3531 def __repr__(self):
3532 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3533 def __init__(self, *args, **kwargs):
a95a7133 3534 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3535 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3536 self.this = newobj.this
3537 self.thisown = 1
3538 del newobj.thisown
e811c8ce 3539 def ControlDown(*args, **kwargs):
a95a7133 3540 """ControlDown(self) -> bool"""
54f9ee45 3541 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3542
3543 def MetaDown(*args, **kwargs):
a95a7133 3544 """MetaDown(self) -> bool"""
54f9ee45 3545 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3546
3547 def AltDown(*args, **kwargs):
a95a7133 3548 """AltDown(self) -> bool"""
54f9ee45 3549 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3550
3551 def ShiftDown(*args, **kwargs):
a95a7133 3552 """ShiftDown(self) -> bool"""
54f9ee45 3553 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce
RD
3554
3555 def HasModifiers(*args, **kwargs):
a95a7133 3556 """HasModifiers(self) -> bool"""
54f9ee45 3557 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3558
3559 def GetKeyCode(*args, **kwargs):
a95a7133 3560 """GetKeyCode(self) -> int"""
54f9ee45 3561 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3562
d14a1e28 3563 KeyCode = GetKeyCode
e811c8ce 3564 def GetUniChar(*args, **kwargs):
a95a7133 3565 """GetUniChar(self) -> int"""
54f9ee45 3566 return _core_.KeyEvent_GetUniChar(*args, **kwargs)
e811c8ce
RD
3567
3568 def GetRawKeyCode(*args, **kwargs):
a95a7133 3569 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3570 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3571
3572 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3573 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3574 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3575
3576 def GetPosition(*args, **kwargs):
0df68c9f 3577 """
a95a7133 3578 GetPosition(self) -> Point
e811c8ce 3579
0df68c9f
RD
3580 Find the position of the event.
3581 """
54f9ee45 3582 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3583
3584 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3585 """
3586 GetPositionTuple() -> (x,y)
e811c8ce 3587
0df68c9f
RD
3588 Find the position of the event.
3589 """
54f9ee45 3590 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3591
3592 def GetX(*args, **kwargs):
a95a7133 3593 """GetX(self) -> int"""
54f9ee45 3594 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
3595
3596 def GetY(*args, **kwargs):
a95a7133 3597 """GetY(self) -> int"""
54f9ee45
RD
3598 return _core_.KeyEvent_GetY(*args, **kwargs)
3599
3600 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3601 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3602 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3603 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3604 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3605 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3606 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3607 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3608 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3609 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
3610
3611class KeyEventPtr(KeyEvent):
3612 def __init__(self, this):
3613 self.this = this
3614 if not hasattr(self,"thisown"): self.thisown = 0
3615 self.__class__ = KeyEvent
54f9ee45 3616_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
3617
3618#---------------------------------------------------------------------------
3619
3620class SizeEvent(Event):
e811c8ce
RD
3621 def __repr__(self):
3622 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3623 def __init__(self, *args, **kwargs):
a95a7133 3624 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 3625 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
3626 self.this = newobj.this
3627 self.thisown = 1
3628 del newobj.thisown
e811c8ce 3629 def GetSize(*args, **kwargs):
a95a7133 3630 """GetSize(self) -> Size"""
54f9ee45 3631 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
3632
3633 def GetRect(*args, **kwargs):
a95a7133 3634 """GetRect(self) -> Rect"""
54f9ee45 3635 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3636
3637 def SetRect(*args, **kwargs):
a95a7133 3638 """SetRect(self, Rect rect)"""
54f9ee45 3639 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3640
3641 def SetSize(*args, **kwargs):
a95a7133 3642 """SetSize(self, Size size)"""
54f9ee45 3643 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 3644
54f9ee45
RD
3645 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3646 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
3647
3648class SizeEventPtr(SizeEvent):
3649 def __init__(self, this):
3650 self.this = this
3651 if not hasattr(self,"thisown"): self.thisown = 0
3652 self.__class__ = SizeEvent
54f9ee45 3653_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
3654
3655#---------------------------------------------------------------------------
3656
3657class MoveEvent(Event):
e811c8ce
RD
3658 def __repr__(self):
3659 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3660 def __init__(self, *args, **kwargs):
a95a7133 3661 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 3662 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
3663 self.this = newobj.this
3664 self.thisown = 1
3665 del newobj.thisown
e811c8ce 3666 def GetPosition(*args, **kwargs):
a95a7133 3667 """GetPosition(self) -> Point"""
54f9ee45 3668 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3669
3670 def GetRect(*args, **kwargs):
a95a7133 3671 """GetRect(self) -> Rect"""
54f9ee45 3672 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3673
3674 def SetRect(*args, **kwargs):
a95a7133 3675 """SetRect(self, Rect rect)"""
54f9ee45 3676 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3677
3678 def SetPosition(*args, **kwargs):
a95a7133 3679 """SetPosition(self, Point pos)"""
54f9ee45 3680 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 3681
54f9ee45
RD
3682 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3683 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
d14a1e28
RD
3684
3685class MoveEventPtr(MoveEvent):
3686 def __init__(self, this):
3687 self.this = this
3688 if not hasattr(self,"thisown"): self.thisown = 0
3689 self.__class__ = MoveEvent
54f9ee45 3690_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
3691
3692#---------------------------------------------------------------------------
3693
3694class PaintEvent(Event):
e811c8ce
RD
3695 def __repr__(self):
3696 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3697 def __init__(self, *args, **kwargs):
a95a7133 3698 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 3699 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
3700 self.this = newobj.this
3701 self.thisown = 1
3702 del newobj.thisown
d14a1e28
RD
3703
3704class PaintEventPtr(PaintEvent):
3705 def __init__(self, this):
3706 self.this = this
3707 if not hasattr(self,"thisown"): self.thisown = 0
3708 self.__class__ = PaintEvent
54f9ee45 3709_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
3710
3711class NcPaintEvent(Event):
e811c8ce
RD
3712 def __repr__(self):
3713 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3714 def __init__(self, *args, **kwargs):
a95a7133 3715 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 3716 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
3717 self.this = newobj.this
3718 self.thisown = 1
3719 del newobj.thisown
d14a1e28
RD
3720
3721class NcPaintEventPtr(NcPaintEvent):
3722 def __init__(self, this):
3723 self.this = this
3724 if not hasattr(self,"thisown"): self.thisown = 0
3725 self.__class__ = NcPaintEvent
54f9ee45 3726_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
3727
3728#---------------------------------------------------------------------------
3729
3730class EraseEvent(Event):
e811c8ce
RD
3731 def __repr__(self):
3732 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3733 def __init__(self, *args, **kwargs):
a95a7133 3734 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 3735 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
3736 self.this = newobj.this
3737 self.thisown = 1
3738 del newobj.thisown
e811c8ce 3739 def GetDC(*args, **kwargs):
a95a7133 3740 """GetDC(self) -> DC"""
54f9ee45 3741 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 3742
d14a1e28
RD
3743
3744class EraseEventPtr(EraseEvent):
3745 def __init__(self, this):
3746 self.this = this
3747 if not hasattr(self,"thisown"): self.thisown = 0
3748 self.__class__ = EraseEvent
54f9ee45 3749_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
3750
3751#---------------------------------------------------------------------------
3752
3753class FocusEvent(Event):
e811c8ce
RD
3754 def __repr__(self):
3755 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3756 def __init__(self, *args, **kwargs):
a95a7133 3757 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 3758 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
3759 self.this = newobj.this
3760 self.thisown = 1
3761 del newobj.thisown
e811c8ce 3762 def GetWindow(*args, **kwargs):
a95a7133 3763 """GetWindow(self) -> Window"""
54f9ee45 3764 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
3765
3766 def SetWindow(*args, **kwargs):
a95a7133 3767 """SetWindow(self, Window win)"""
54f9ee45 3768 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 3769
d14a1e28
RD
3770
3771class FocusEventPtr(FocusEvent):
3772 def __init__(self, this):
3773 self.this = this
3774 if not hasattr(self,"thisown"): self.thisown = 0
3775 self.__class__ = FocusEvent
54f9ee45 3776_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
3777
3778#---------------------------------------------------------------------------
3779
3780class ChildFocusEvent(CommandEvent):
e811c8ce
RD
3781 def __repr__(self):
3782 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3783 def __init__(self, *args, **kwargs):
a95a7133 3784 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 3785 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
3786 self.this = newobj.this
3787 self.thisown = 1
3788 del newobj.thisown
e811c8ce 3789 def GetWindow(*args, **kwargs):
a95a7133 3790 """GetWindow(self) -> Window"""
54f9ee45 3791 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 3792
d14a1e28
RD
3793
3794class ChildFocusEventPtr(ChildFocusEvent):
3795 def __init__(self, this):
3796 self.this = this
3797 if not hasattr(self,"thisown"): self.thisown = 0
3798 self.__class__ = ChildFocusEvent
54f9ee45 3799_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
3800
3801#---------------------------------------------------------------------------
3802
3803class ActivateEvent(Event):
e811c8ce
RD
3804 def __repr__(self):
3805 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3806 def __init__(self, *args, **kwargs):
a95a7133 3807 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 3808 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
3809 self.this = newobj.this
3810 self.thisown = 1
3811 del newobj.thisown
e811c8ce 3812 def GetActive(*args, **kwargs):
a95a7133 3813 """GetActive(self) -> bool"""
54f9ee45 3814 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 3815
d14a1e28
RD
3816
3817class ActivateEventPtr(ActivateEvent):
3818 def __init__(self, this):
3819 self.this = this
3820 if not hasattr(self,"thisown"): self.thisown = 0
3821 self.__class__ = ActivateEvent
54f9ee45 3822_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
3823
3824#---------------------------------------------------------------------------
3825
3826class InitDialogEvent(Event):
e811c8ce
RD
3827 def __repr__(self):
3828 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3829 def __init__(self, *args, **kwargs):
a95a7133 3830 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 3831 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
3832 self.this = newobj.this
3833 self.thisown = 1
3834 del newobj.thisown
d14a1e28
RD
3835
3836class InitDialogEventPtr(InitDialogEvent):
3837 def __init__(self, this):
3838 self.this = this
3839 if not hasattr(self,"thisown"): self.thisown = 0
3840 self.__class__ = InitDialogEvent
54f9ee45 3841_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
3842
3843#---------------------------------------------------------------------------
3844
3845class MenuEvent(Event):
e811c8ce
RD
3846 def __repr__(self):
3847 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3848 def __init__(self, *args, **kwargs):
a95a7133 3849 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 3850 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
3851 self.this = newobj.this
3852 self.thisown = 1
3853 del newobj.thisown
e811c8ce 3854 def GetMenuId(*args, **kwargs):
a95a7133 3855 """GetMenuId(self) -> int"""
54f9ee45 3856 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
3857
3858 def IsPopup(*args, **kwargs):
a95a7133 3859 """IsPopup(self) -> bool"""
54f9ee45 3860 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
3861
3862 def GetMenu(*args, **kwargs):
a95a7133 3863 """GetMenu(self) -> Menu"""
54f9ee45 3864 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 3865
d14a1e28
RD
3866
3867class MenuEventPtr(MenuEvent):
3868 def __init__(self, this):
3869 self.this = this
3870 if not hasattr(self,"thisown"): self.thisown = 0
3871 self.__class__ = MenuEvent
54f9ee45 3872_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
3873
3874#---------------------------------------------------------------------------
3875
3876class CloseEvent(Event):
e811c8ce
RD
3877 def __repr__(self):
3878 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3879 def __init__(self, *args, **kwargs):
a95a7133 3880 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 3881 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
3882 self.this = newobj.this
3883 self.thisown = 1
3884 del newobj.thisown
e811c8ce 3885 def SetLoggingOff(*args, **kwargs):
a95a7133 3886 """SetLoggingOff(self, bool logOff)"""
54f9ee45 3887 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
3888
3889 def GetLoggingOff(*args, **kwargs):
a95a7133 3890 """GetLoggingOff(self) -> bool"""
54f9ee45 3891 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
3892
3893 def Veto(*args, **kwargs):
a95a7133 3894 """Veto(self, bool veto=True)"""
54f9ee45 3895 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
3896
3897 def SetCanVeto(*args, **kwargs):
a95a7133 3898 """SetCanVeto(self, bool canVeto)"""
54f9ee45 3899 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
3900
3901 def CanVeto(*args, **kwargs):
a95a7133 3902 """CanVeto(self) -> bool"""
54f9ee45 3903 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
3904
3905 def GetVeto(*args, **kwargs):
a95a7133 3906 """GetVeto(self) -> bool"""
54f9ee45 3907 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 3908
d14a1e28
RD
3909
3910class CloseEventPtr(CloseEvent):
3911 def __init__(self, this):
3912 self.this = this
3913 if not hasattr(self,"thisown"): self.thisown = 0
3914 self.__class__ = CloseEvent
54f9ee45 3915_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
3916
3917#---------------------------------------------------------------------------
3918
3919class ShowEvent(Event):
e811c8ce
RD
3920 def __repr__(self):
3921 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3922 def __init__(self, *args, **kwargs):
a95a7133 3923 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 3924 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
3925 self.this = newobj.this
3926 self.thisown = 1
3927 del newobj.thisown
e811c8ce 3928 def SetShow(*args, **kwargs):
a95a7133 3929 """SetShow(self, bool show)"""
54f9ee45 3930 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
3931
3932 def GetShow(*args, **kwargs):
a95a7133 3933 """GetShow(self) -> bool"""
54f9ee45 3934 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 3935
d14a1e28
RD
3936
3937class ShowEventPtr(ShowEvent):
3938 def __init__(self, this):
3939 self.this = this
3940 if not hasattr(self,"thisown"): self.thisown = 0
3941 self.__class__ = ShowEvent
54f9ee45 3942_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
3943
3944#---------------------------------------------------------------------------
3945
3946class IconizeEvent(Event):
e811c8ce
RD
3947 def __repr__(self):
3948 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3949 def __init__(self, *args, **kwargs):
a95a7133 3950 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
54f9ee45 3951 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
3952 self.this = newobj.this
3953 self.thisown = 1
3954 del newobj.thisown
e811c8ce 3955 def Iconized(*args, **kwargs):
a95a7133 3956 """Iconized(self) -> bool"""
54f9ee45 3957 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 3958
d14a1e28
RD
3959
3960class IconizeEventPtr(IconizeEvent):
3961 def __init__(self, this):
3962 self.this = this
3963 if not hasattr(self,"thisown"): self.thisown = 0
3964 self.__class__ = IconizeEvent
54f9ee45 3965_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
3966
3967#---------------------------------------------------------------------------
3968
3969class MaximizeEvent(Event):
e811c8ce
RD
3970 def __repr__(self):
3971 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3972 def __init__(self, *args, **kwargs):
a95a7133 3973 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 3974 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
3975 self.this = newobj.this
3976 self.thisown = 1
3977 del newobj.thisown
d14a1e28
RD
3978
3979class MaximizeEventPtr(MaximizeEvent):
3980 def __init__(self, this):
3981 self.this = this
3982 if not hasattr(self,"thisown"): self.thisown = 0
3983 self.__class__ = MaximizeEvent
54f9ee45 3984_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
3985
3986#---------------------------------------------------------------------------
3987
3988class DropFilesEvent(Event):
d14a1e28
RD
3989 def __init__(self): raise RuntimeError, "No constructor defined"
3990 def __repr__(self):
3991 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 3992 def GetPosition(*args, **kwargs):
a95a7133 3993 """GetPosition(self) -> Point"""
54f9ee45 3994 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3995
3996 def GetNumberOfFiles(*args, **kwargs):
a95a7133 3997 """GetNumberOfFiles(self) -> int"""
54f9ee45 3998 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
3999
4000 def GetFiles(*args, **kwargs):
a95a7133 4001 """GetFiles(self) -> PyObject"""
54f9ee45 4002 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4003
d14a1e28
RD
4004
4005class DropFilesEventPtr(DropFilesEvent):
4006 def __init__(self, this):
4007 self.this = this
4008 if not hasattr(self,"thisown"): self.thisown = 0
4009 self.__class__ = DropFilesEvent
54f9ee45 4010_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4011
4012#---------------------------------------------------------------------------
4013
54f9ee45
RD
4014UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4015UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4016class UpdateUIEvent(CommandEvent):
e811c8ce
RD
4017 def __repr__(self):
4018 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4019 def __init__(self, *args, **kwargs):
a95a7133 4020 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4021 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4022 self.this = newobj.this
4023 self.thisown = 1
4024 del newobj.thisown
e811c8ce 4025 def GetChecked(*args, **kwargs):
a95a7133 4026 """GetChecked(self) -> bool"""
54f9ee45 4027 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4028
4029 def GetEnabled(*args, **kwargs):
a95a7133 4030 """GetEnabled(self) -> bool"""
54f9ee45 4031 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4032
4033 def GetText(*args, **kwargs):
a95a7133 4034 """GetText(self) -> String"""
54f9ee45 4035 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4036
4037 def GetSetText(*args, **kwargs):
a95a7133 4038 """GetSetText(self) -> bool"""
54f9ee45 4039 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4040
4041 def GetSetChecked(*args, **kwargs):
a95a7133 4042 """GetSetChecked(self) -> bool"""
54f9ee45 4043 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4044
4045 def GetSetEnabled(*args, **kwargs):
a95a7133 4046 """GetSetEnabled(self) -> bool"""
54f9ee45 4047 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4048
4049 def Check(*args, **kwargs):
a95a7133 4050 """Check(self, bool check)"""
54f9ee45 4051 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4052
4053 def Enable(*args, **kwargs):
a95a7133 4054 """Enable(self, bool enable)"""
54f9ee45 4055 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4056
4057 def SetText(*args, **kwargs):
a95a7133 4058 """SetText(self, String text)"""
54f9ee45 4059 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4060
4061 def SetUpdateInterval(*args, **kwargs):
66c033b4 4062 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4063 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4064
4065 SetUpdateInterval = staticmethod(SetUpdateInterval)
4066 def GetUpdateInterval(*args, **kwargs):
66c033b4 4067 """GetUpdateInterval() -> long"""
54f9ee45 4068 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4069
4070 GetUpdateInterval = staticmethod(GetUpdateInterval)
4071 def CanUpdate(*args, **kwargs):
66c033b4 4072 """CanUpdate(Window win) -> bool"""
54f9ee45 4073 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4074
4075 CanUpdate = staticmethod(CanUpdate)
4076 def ResetUpdateTime(*args, **kwargs):
66c033b4 4077 """ResetUpdateTime()"""
54f9ee45 4078 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4079
4080 ResetUpdateTime = staticmethod(ResetUpdateTime)
4081 def SetMode(*args, **kwargs):
66c033b4 4082 """SetMode(int mode)"""
54f9ee45 4083 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4084
4085 SetMode = staticmethod(SetMode)
4086 def GetMode(*args, **kwargs):
66c033b4 4087 """GetMode() -> int"""
54f9ee45 4088 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4089
4090 GetMode = staticmethod(GetMode)
d14a1e28
RD
4091
4092class UpdateUIEventPtr(UpdateUIEvent):
4093 def __init__(self, this):
4094 self.this = this
4095 if not hasattr(self,"thisown"): self.thisown = 0
4096 self.__class__ = UpdateUIEvent
54f9ee45 4097_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4098
e811c8ce
RD
4099def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4100 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4101 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4102
e811c8ce
RD
4103def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4104 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4105 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4106
e811c8ce
RD
4107def UpdateUIEvent_CanUpdate(*args, **kwargs):
4108 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4109 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4110
e811c8ce
RD
4111def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4112 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4113 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4114
e811c8ce 4115def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4116 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4117 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4118
e811c8ce 4119def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4120 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4121 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4122
4123#---------------------------------------------------------------------------
4124
4125class SysColourChangedEvent(Event):
e811c8ce
RD
4126 def __repr__(self):
4127 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4128 def __init__(self, *args, **kwargs):
a95a7133 4129 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4130 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4131 self.this = newobj.this
4132 self.thisown = 1
4133 del newobj.thisown
d14a1e28
RD
4134
4135class SysColourChangedEventPtr(SysColourChangedEvent):
4136 def __init__(self, this):
4137 self.this = this
4138 if not hasattr(self,"thisown"): self.thisown = 0
4139 self.__class__ = SysColourChangedEvent
54f9ee45 4140_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4141
4142#---------------------------------------------------------------------------
4143
4144class MouseCaptureChangedEvent(Event):
e811c8ce
RD
4145 def __repr__(self):
4146 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4147 def __init__(self, *args, **kwargs):
a95a7133 4148 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4149 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4150 self.this = newobj.this
4151 self.thisown = 1
4152 del newobj.thisown
e811c8ce 4153 def GetCapturedWindow(*args, **kwargs):
a95a7133 4154 """GetCapturedWindow(self) -> Window"""
54f9ee45 4155 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4156
d14a1e28
RD
4157
4158class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4159 def __init__(self, this):
4160 self.this = this
4161 if not hasattr(self,"thisown"): self.thisown = 0
4162 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4163_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4164
4165#---------------------------------------------------------------------------
4166
4167class DisplayChangedEvent(Event):
e811c8ce
RD
4168 def __repr__(self):
4169 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4170 def __init__(self, *args, **kwargs):
a95a7133 4171 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4172 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4173 self.this = newobj.this
4174 self.thisown = 1
4175 del newobj.thisown
d14a1e28
RD
4176
4177class DisplayChangedEventPtr(DisplayChangedEvent):
4178 def __init__(self, this):
4179 self.this = this
4180 if not hasattr(self,"thisown"): self.thisown = 0
4181 self.__class__ = DisplayChangedEvent
54f9ee45 4182_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4183
4184#---------------------------------------------------------------------------
4185
4186class PaletteChangedEvent(Event):
e811c8ce
RD
4187 def __repr__(self):
4188 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4189 def __init__(self, *args, **kwargs):
a95a7133 4190 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4191 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4192 self.this = newobj.this
4193 self.thisown = 1
4194 del newobj.thisown
e811c8ce 4195 def SetChangedWindow(*args, **kwargs):
a95a7133 4196 """SetChangedWindow(self, Window win)"""
54f9ee45 4197 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4198
4199 def GetChangedWindow(*args, **kwargs):
a95a7133 4200 """GetChangedWindow(self) -> Window"""
54f9ee45 4201 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4202
d14a1e28
RD
4203
4204class PaletteChangedEventPtr(PaletteChangedEvent):
4205 def __init__(self, this):
4206 self.this = this
4207 if not hasattr(self,"thisown"): self.thisown = 0
4208 self.__class__ = PaletteChangedEvent
54f9ee45 4209_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4210
4211#---------------------------------------------------------------------------
4212
4213class QueryNewPaletteEvent(Event):
e811c8ce
RD
4214 def __repr__(self):
4215 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4216 def __init__(self, *args, **kwargs):
a95a7133 4217 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4218 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4219 self.this = newobj.this
4220 self.thisown = 1
4221 del newobj.thisown
e811c8ce 4222 def SetPaletteRealized(*args, **kwargs):
a95a7133 4223 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4224 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4225
4226 def GetPaletteRealized(*args, **kwargs):
a95a7133 4227 """GetPaletteRealized(self) -> bool"""
54f9ee45 4228 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4229
d14a1e28
RD
4230
4231class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4232 def __init__(self, this):
4233 self.this = this
4234 if not hasattr(self,"thisown"): self.thisown = 0
4235 self.__class__ = QueryNewPaletteEvent
54f9ee45 4236_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4237
4238#---------------------------------------------------------------------------
4239
4240class NavigationKeyEvent(Event):
e811c8ce
RD
4241 def __repr__(self):
4242 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4243 def __init__(self, *args, **kwargs):
a95a7133 4244 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4245 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4246 self.this = newobj.this
4247 self.thisown = 1
4248 del newobj.thisown
e811c8ce 4249 def GetDirection(*args, **kwargs):
a95a7133 4250 """GetDirection(self) -> bool"""
54f9ee45 4251 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4252
4253 def SetDirection(*args, **kwargs):
908b74cd 4254 """SetDirection(self, bool forward)"""
54f9ee45 4255 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4256
4257 def IsWindowChange(*args, **kwargs):
a95a7133 4258 """IsWindowChange(self) -> bool"""
54f9ee45 4259 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4260
4261 def SetWindowChange(*args, **kwargs):
908b74cd 4262 """SetWindowChange(self, bool ischange)"""
54f9ee45 4263 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 4264
908b74cd
RD
4265 def SetFlags(*args, **kwargs):
4266 """SetFlags(self, long flags)"""
4267 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4268
e811c8ce 4269 def GetCurrentFocus(*args, **kwargs):
a95a7133 4270 """GetCurrentFocus(self) -> Window"""
54f9ee45 4271 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4272
4273 def SetCurrentFocus(*args, **kwargs):
a95a7133 4274 """SetCurrentFocus(self, Window win)"""
54f9ee45 4275 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4276
908b74cd
RD
4277 IsForward = _core_.NavigationKeyEvent_IsForward
4278 WinChange = _core_.NavigationKeyEvent_WinChange
d14a1e28
RD
4279
4280class NavigationKeyEventPtr(NavigationKeyEvent):
4281 def __init__(self, this):
4282 self.this = this
4283 if not hasattr(self,"thisown"): self.thisown = 0
4284 self.__class__ = NavigationKeyEvent
54f9ee45 4285_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4286
4287#---------------------------------------------------------------------------
4288
4289class WindowCreateEvent(CommandEvent):
e811c8ce
RD
4290 def __repr__(self):
4291 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4292 def __init__(self, *args, **kwargs):
a95a7133 4293 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4294 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4295 self.this = newobj.this
4296 self.thisown = 1
4297 del newobj.thisown
e811c8ce 4298 def GetWindow(*args, **kwargs):
a95a7133 4299 """GetWindow(self) -> Window"""
54f9ee45 4300 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4301
d14a1e28
RD
4302
4303class WindowCreateEventPtr(WindowCreateEvent):
4304 def __init__(self, this):
4305 self.this = this
4306 if not hasattr(self,"thisown"): self.thisown = 0
4307 self.__class__ = WindowCreateEvent
54f9ee45 4308_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4309
4310class WindowDestroyEvent(CommandEvent):
e811c8ce
RD
4311 def __repr__(self):
4312 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4313 def __init__(self, *args, **kwargs):
a95a7133 4314 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4315 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4316 self.this = newobj.this
4317 self.thisown = 1
4318 del newobj.thisown
e811c8ce 4319 def GetWindow(*args, **kwargs):
a95a7133 4320 """GetWindow(self) -> Window"""
54f9ee45 4321 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4322
d14a1e28
RD
4323
4324class WindowDestroyEventPtr(WindowDestroyEvent):
4325 def __init__(self, this):
4326 self.this = this
4327 if not hasattr(self,"thisown"): self.thisown = 0
4328 self.__class__ = WindowDestroyEvent
54f9ee45 4329_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4330
4331#---------------------------------------------------------------------------
4332
4333class ContextMenuEvent(CommandEvent):
e811c8ce
RD
4334 def __repr__(self):
4335 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4336 def __init__(self, *args, **kwargs):
a95a7133 4337 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4338 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4339 self.this = newobj.this
4340 self.thisown = 1
4341 del newobj.thisown
e811c8ce 4342 def GetPosition(*args, **kwargs):
a95a7133 4343 """GetPosition(self) -> Point"""
54f9ee45 4344 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4345
4346 def SetPosition(*args, **kwargs):
a95a7133 4347 """SetPosition(self, Point pos)"""
54f9ee45 4348 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4349
d14a1e28
RD
4350
4351class ContextMenuEventPtr(ContextMenuEvent):
4352 def __init__(self, this):
4353 self.this = this
4354 if not hasattr(self,"thisown"): self.thisown = 0
4355 self.__class__ = ContextMenuEvent
54f9ee45 4356_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4357
4358#---------------------------------------------------------------------------
4359
54f9ee45
RD
4360IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4361IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4362class IdleEvent(Event):
e811c8ce
RD
4363 def __repr__(self):
4364 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4365 def __init__(self, *args, **kwargs):
a95a7133 4366 """__init__(self) -> IdleEvent"""
54f9ee45 4367 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4368 self.this = newobj.this
4369 self.thisown = 1
4370 del newobj.thisown
e811c8ce 4371 def RequestMore(*args, **kwargs):
a95a7133 4372 """RequestMore(self, bool needMore=True)"""
54f9ee45 4373 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4374
4375 def MoreRequested(*args, **kwargs):
a95a7133 4376 """MoreRequested(self) -> bool"""
54f9ee45 4377 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4378
4379 def SetMode(*args, **kwargs):
66c033b4 4380 """SetMode(int mode)"""
54f9ee45 4381 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4382
4383 SetMode = staticmethod(SetMode)
4384 def GetMode(*args, **kwargs):
66c033b4 4385 """GetMode() -> int"""
54f9ee45 4386 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4387
4388 GetMode = staticmethod(GetMode)
4389 def CanSend(*args, **kwargs):
66c033b4 4390 """CanSend(Window win) -> bool"""
54f9ee45 4391 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4392
4393 CanSend = staticmethod(CanSend)
d14a1e28
RD
4394
4395class IdleEventPtr(IdleEvent):
4396 def __init__(self, this):
4397 self.this = this
4398 if not hasattr(self,"thisown"): self.thisown = 0
4399 self.__class__ = IdleEvent
54f9ee45 4400_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4401
e811c8ce 4402def IdleEvent_SetMode(*args, **kwargs):
196addbf 4403 """IdleEvent_SetMode(int mode)"""
54f9ee45 4404 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4405
e811c8ce 4406def IdleEvent_GetMode(*args, **kwargs):
196addbf 4407 """IdleEvent_GetMode() -> int"""
54f9ee45 4408 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4409
e811c8ce
RD
4410def IdleEvent_CanSend(*args, **kwargs):
4411 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4412 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4413
4414#---------------------------------------------------------------------------
4415
4416class PyEvent(Event):
e811c8ce
RD
4417 def __repr__(self):
4418 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4419 def __init__(self, *args, **kwargs):
a95a7133 4420 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4421 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4422 self.this = newobj.this
4423 self.thisown = 1
4424 del newobj.thisown
4425 self.SetSelf(self)
e811c8ce 4426
54f9ee45 4427 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4428 """__del__(self)"""
d14a1e28
RD
4429 try:
4430 if self.thisown: destroy(self)
4431 except: pass
e811c8ce
RD
4432
4433 def SetSelf(*args, **kwargs):
a95a7133 4434 """SetSelf(self, PyObject self)"""
54f9ee45 4435 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4436
4437 def GetSelf(*args, **kwargs):
a95a7133 4438 """GetSelf(self) -> PyObject"""
54f9ee45 4439 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4440
d14a1e28
RD
4441
4442class PyEventPtr(PyEvent):
4443 def __init__(self, this):
4444 self.this = this
4445 if not hasattr(self,"thisown"): self.thisown = 0
4446 self.__class__ = PyEvent
54f9ee45 4447_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4448
4449class PyCommandEvent(CommandEvent):
e811c8ce
RD
4450 def __repr__(self):
4451 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4452 def __init__(self, *args, **kwargs):
a95a7133 4453 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4454 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4455 self.this = newobj.this
4456 self.thisown = 1
4457 del newobj.thisown
4458 self.SetSelf(self)
e811c8ce 4459
54f9ee45 4460 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4461 """__del__(self)"""
d14a1e28
RD
4462 try:
4463 if self.thisown: destroy(self)
4464 except: pass
e811c8ce
RD
4465
4466 def SetSelf(*args, **kwargs):
a95a7133 4467 """SetSelf(self, PyObject self)"""
54f9ee45 4468 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4469
4470 def GetSelf(*args, **kwargs):
a95a7133 4471 """GetSelf(self) -> PyObject"""
54f9ee45 4472 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4473
d14a1e28
RD
4474
4475class PyCommandEventPtr(PyCommandEvent):
4476 def __init__(self, this):
4477 self.this = this
4478 if not hasattr(self,"thisown"): self.thisown = 0
4479 self.__class__ = PyCommandEvent
54f9ee45 4480_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28
RD
4481
4482#---------------------------------------------------------------------------
4483
54f9ee45
RD
4484PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4485PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4486PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4487PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4488PRINT_WINDOWS = _core_.PRINT_WINDOWS
4489PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4490class PyApp(EvtHandler):
66c033b4
RD
4491 """
4492 The ``wx.PyApp`` class is an *implementation detail*, please use the
4493 `wx.App` class (or some other derived class) instead.
4494 """
e811c8ce
RD
4495 def __repr__(self):
4496 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4497 def __init__(self, *args, **kwargs):
98e665d3 4498 """
a95a7133 4499 __init__(self) -> PyApp
98e665d3
RD
4500
4501 Create a new application object, starting the bootstrap process.
4502 """
54f9ee45 4503 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4504 self.this = newobj.this
4505 self.thisown = 1
4506 del newobj.thisown
4507 self._setCallbackInfo(self, PyApp)
4508 self._setOORInfo(self)
e811c8ce 4509
54f9ee45 4510 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 4511 """__del__(self)"""
d14a1e28
RD
4512 try:
4513 if self.thisown: destroy(self)
4514 except: pass
e811c8ce
RD
4515
4516 def _setCallbackInfo(*args, **kwargs):
a95a7133 4517 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 4518 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
4519
4520 def GetAppName(*args, **kwargs):
0df68c9f 4521 """
a95a7133 4522 GetAppName(self) -> String
6c3b4aae 4523
0df68c9f
RD
4524 Get the application name.
4525 """
54f9ee45 4526 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
4527
4528 def SetAppName(*args, **kwargs):
0df68c9f 4529 """
a95a7133 4530 SetAppName(self, String name)
6c3b4aae 4531
66c033b4
RD
4532 Set the application name. This value may be used automatically by
4533 `wx.Config` and such.
0df68c9f 4534 """
54f9ee45 4535 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
4536
4537 def GetClassName(*args, **kwargs):
0df68c9f 4538 """
a95a7133 4539 GetClassName(self) -> String
e811c8ce 4540
0df68c9f
RD
4541 Get the application's class name.
4542 """
54f9ee45 4543 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
4544
4545 def SetClassName(*args, **kwargs):
0df68c9f 4546 """
a95a7133 4547 SetClassName(self, String name)
6c3b4aae 4548
66c033b4
RD
4549 Set the application's class name. This value may be used for
4550 X-resources if applicable for the platform
0df68c9f 4551 """
54f9ee45 4552 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
4553
4554 def GetVendorName(*args, **kwargs):
0df68c9f 4555 """
a95a7133 4556 GetVendorName(self) -> String
6c3b4aae 4557
0df68c9f
RD
4558 Get the application's vendor name.
4559 """
54f9ee45 4560 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
4561
4562 def SetVendorName(*args, **kwargs):
0df68c9f 4563 """
a95a7133 4564 SetVendorName(self, String name)
6c3b4aae 4565
66c033b4
RD
4566 Set the application's vendor name. This value may be used
4567 automatically by `wx.Config` and such.
0df68c9f 4568 """
54f9ee45 4569 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
4570
4571 def GetTraits(*args, **kwargs):
0df68c9f 4572 """
a95a7133 4573 GetTraits(self) -> wxAppTraits
6c3b4aae 4574
66c033b4
RD
4575 Return (and create if necessary) the app traits object to which we
4576 delegate for everything which either should be configurable by the
4577 user (then he can change the default behaviour simply by overriding
4578 CreateTraits() and returning his own traits object) or which is
4579 GUI/console dependent as then wx.AppTraits allows us to abstract the
4580 differences behind the common facade.
4581
4582 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 4583 """
54f9ee45 4584 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
4585
4586 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 4587 """
a95a7133 4588 ProcessPendingEvents(self)
6c3b4aae 4589
66c033b4
RD
4590 Process all events in the Pending Events list -- it is necessary to
4591 call this function to process posted events. This normally happens
4592 during each event loop iteration.
0df68c9f 4593 """
54f9ee45 4594 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
4595
4596 def Yield(*args, **kwargs):
0df68c9f 4597 """
a95a7133 4598 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 4599
66c033b4
RD
4600 Process all currently pending events right now, instead of waiting
4601 until return to the event loop. It is an error to call ``Yield``
4602 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 4603
66c033b4 4604 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
4605 reentrancies (i.e. when called from an event handler it may
4606 result in calling the same event handler again), use with
4607 extreme care or, better, don't use at all!
0df68c9f 4608
66c033b4 4609 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 4610
0df68c9f 4611 """
54f9ee45 4612 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
4613
4614 def WakeUpIdle(*args, **kwargs):
0df68c9f 4615 """
a95a7133 4616 WakeUpIdle(self)
6c3b4aae 4617
66c033b4
RD
4618 Make sure that idle events are sent again.
4619 :see: `wx.WakeUpIdle`
0df68c9f 4620 """
54f9ee45 4621 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce
RD
4622
4623 def MainLoop(*args, **kwargs):
0df68c9f 4624 """
a95a7133 4625 MainLoop(self) -> int
6c3b4aae 4626
66c033b4
RD
4627 Execute the main GUI loop, the function doesn't normally return until
4628 all top level windows have been closed and destroyed.
0df68c9f 4629 """
54f9ee45 4630 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
4631
4632 def Exit(*args, **kwargs):
0df68c9f 4633 """
a95a7133 4634 Exit(self)
6c3b4aae 4635
0df68c9f 4636 Exit the main loop thus terminating the application.
66c033b4 4637 :see: `wx.Exit`
0df68c9f 4638 """
54f9ee45 4639 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
4640
4641 def ExitMainLoop(*args, **kwargs):
0df68c9f 4642 """
a95a7133 4643 ExitMainLoop(self)
6c3b4aae 4644
66c033b4
RD
4645 Exit the main GUI loop during the next iteration of the main
4646 loop, (i.e. it does not stop the program immediately!)
0df68c9f 4647 """
54f9ee45 4648 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
4649
4650 def Pending(*args, **kwargs):
0df68c9f 4651 """
a95a7133 4652 Pending(self) -> bool
6c3b4aae 4653
0df68c9f
RD
4654 Returns True if there are unprocessed events in the event queue.
4655 """
54f9ee45 4656 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
4657
4658 def Dispatch(*args, **kwargs):
0df68c9f 4659 """
a95a7133 4660 Dispatch(self) -> bool
6c3b4aae 4661
0df68c9f
RD
4662 Process the first event in the event queue (blocks until an event
4663 appears if there are none currently)
4664 """
54f9ee45 4665 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
4666
4667 def ProcessIdle(*args, **kwargs):
0df68c9f 4668 """
a95a7133 4669 ProcessIdle(self) -> bool
6c3b4aae 4670
66c033b4
RD
4671 Called from the MainLoop when the application becomes idle (there are
4672 no pending events) and sends a `wx.IdleEvent` to all interested
4673 parties. Returns True if more idle events are needed, False if not.
0df68c9f 4674 """
54f9ee45 4675 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
4676
4677 def SendIdleEvents(*args, **kwargs):
0df68c9f 4678 """
a95a7133 4679 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 4680
66c033b4
RD
4681 Send idle event to window and all subwindows. Returns True if more
4682 idle time is requested.
0df68c9f 4683 """
54f9ee45 4684 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
4685
4686 def IsActive(*args, **kwargs):
0df68c9f 4687 """
a95a7133 4688 IsActive(self) -> bool
6c3b4aae 4689
0df68c9f
RD
4690 Return True if our app has focus.
4691 """
54f9ee45 4692 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
4693
4694 def SetTopWindow(*args, **kwargs):
0df68c9f 4695 """
a95a7133 4696 SetTopWindow(self, Window win)
6c3b4aae 4697
66c033b4 4698 Set the *main* top level window
0df68c9f 4699 """
54f9ee45 4700 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
4701
4702 def GetTopWindow(*args, **kwargs):
0df68c9f 4703 """
a95a7133 4704 GetTopWindow(self) -> Window
6c3b4aae 4705
66c033b4
RD
4706 Return the *main* top level window (if it hadn't been set previously
4707 with SetTopWindow(), will return just some top level window and, if
4708 there not any, will return None)
0df68c9f 4709 """
54f9ee45 4710 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
4711
4712 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4713 """
a95a7133 4714 SetExitOnFrameDelete(self, bool flag)
0df68c9f 4715
66c033b4
RD
4716 Control the exit behaviour: by default, the program will exit the main
4717 loop (and so, usually, terminate) when the last top-level program
4718 window is deleted. Beware that if you disable this behaviour (with
4719 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4720 explicitly from somewhere.
0df68c9f 4721 """
54f9ee45 4722 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4723
4724 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4725 """
a95a7133 4726 GetExitOnFrameDelete(self) -> bool
6c3b4aae 4727
0df68c9f
RD
4728 Get the current exit behaviour setting.
4729 """
54f9ee45 4730 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4731
4732 def SetUseBestVisual(*args, **kwargs):
0df68c9f 4733 """
a95a7133 4734 SetUseBestVisual(self, bool flag)
6c3b4aae 4735
66c033b4
RD
4736 Set whether the app should try to use the best available visual on
4737 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 4738 """
54f9ee45 4739 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4740
4741 def GetUseBestVisual(*args, **kwargs):
0df68c9f 4742 """
a95a7133 4743 GetUseBestVisual(self) -> bool
6c3b4aae 4744
0df68c9f
RD
4745 Get current UseBestVisual setting.
4746 """
54f9ee45 4747 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4748
4749 def SetPrintMode(*args, **kwargs):
a95a7133 4750 """SetPrintMode(self, int mode)"""
54f9ee45 4751 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
4752
4753 def GetPrintMode(*args, **kwargs):
a95a7133 4754 """GetPrintMode(self) -> int"""
54f9ee45 4755 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 4756
e811c8ce 4757 def SetAssertMode(*args, **kwargs):
0df68c9f 4758 """
a95a7133 4759 SetAssertMode(self, int mode)
6c3b4aae 4760
41e2b43e 4761 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 4762 """
54f9ee45 4763 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 4764
6c3b4aae 4765 def GetAssertMode(*args, **kwargs):
0df68c9f 4766 """
a95a7133 4767 GetAssertMode(self) -> int
6c3b4aae 4768
0df68c9f
RD
4769 Get the current OnAssert behaviour setting.
4770 """
54f9ee45 4771 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 4772
e811c8ce 4773 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4774 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4775 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4776
4777 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4778 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4779 """GetMacAboutMenuItemId() -> long"""
54f9ee45 4780 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4781
4782 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4783 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4784 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4785 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4786
4787 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4788 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 4789 """GetMacExitMenuItemId() -> long"""
54f9ee45 4790 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4791
4792 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4793 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4794 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 4795 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4796
4797 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4798 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4799 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4800 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4801
4802 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4803 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4804 """SetMacAboutMenuItemId(long val)"""
54f9ee45 4805 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4806
4807 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4808 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4809 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4810 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4811
4812 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4813 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 4814 """SetMacExitMenuItemId(long val)"""
54f9ee45 4815 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4816
4817 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4818 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4819 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 4820 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4821
4822 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4823 def _BootstrapApp(*args, **kwargs):
0df68c9f 4824 """
a95a7133 4825 _BootstrapApp(self)
6c3b4aae 4826
0df68c9f
RD
4827 For internal use only
4828 """
54f9ee45 4829 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
4830
4831 def GetComCtl32Version(*args, **kwargs):
0df68c9f 4832 """
66c033b4 4833 GetComCtl32Version() -> int
6c3b4aae 4834
66c033b4
RD
4835 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4836 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4837 """
54f9ee45 4838 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
4839
4840 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
4841
4842class PyAppPtr(PyApp):
4843 def __init__(self, this):
4844 self.this = this
4845 if not hasattr(self,"thisown"): self.thisown = 0
4846 self.__class__ = PyApp
54f9ee45 4847_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 4848
e811c8ce
RD
4849def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4850 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4851 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4852
e811c8ce
RD
4853def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4854 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 4855 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4856
e811c8ce
RD
4857def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4858 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4859 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4860
e811c8ce
RD
4861def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4862 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 4863 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4864
e811c8ce 4865def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4866 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 4867 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4868
e811c8ce
RD
4869def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4870 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4871 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4872
e811c8ce
RD
4873def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
4874 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 4875 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4876
e811c8ce
RD
4877def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
4878 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4879 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4880
e811c8ce
RD
4881def PyApp_SetMacExitMenuItemId(*args, **kwargs):
4882 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 4883 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4884
e811c8ce 4885def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4886 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 4887 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4888
e811c8ce 4889def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
4890 """
4891 PyApp_GetComCtl32Version() -> int
6c3b4aae 4892
66c033b4
RD
4893 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4894 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4895 """
54f9ee45 4896 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
4897
4898#---------------------------------------------------------------------------
4899
4900
e811c8ce 4901def Exit(*args, **kwargs):
0df68c9f
RD
4902 """
4903 Exit()
6c3b4aae 4904
0df68c9f
RD
4905 Force an exit of the application. Convenience for wx.GetApp().Exit()
4906 """
54f9ee45 4907 return _core_.Exit(*args, **kwargs)
d14a1e28 4908
e811c8ce 4909def Yield(*args, **kwargs):
0df68c9f
RD
4910 """
4911 Yield() -> bool
6c3b4aae 4912
0df68c9f
RD
4913 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
4914 """
54f9ee45 4915 return _core_.Yield(*args, **kwargs)
d14a1e28 4916
e811c8ce 4917def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
4918 """
4919 YieldIfNeeded() -> bool
6c3b4aae 4920
0df68c9f
RD
4921 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
4922 """
54f9ee45 4923 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 4924
e811c8ce 4925def SafeYield(*args, **kwargs):
0df68c9f
RD
4926 """
4927 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 4928
66c033b4
RD
4929 This function is similar to `wx.Yield`, except that it disables the
4930 user input to all program windows before calling `wx.Yield` and
4931 re-enables it again afterwards. If ``win`` is not None, this window
4932 will remain enabled, allowing the implementation of some limited user
4933 interaction.
6c3b4aae 4934
66c033b4 4935 :Returns: the result of the call to `wx.Yield`.
0df68c9f 4936 """
54f9ee45 4937 return _core_.SafeYield(*args, **kwargs)
d14a1e28 4938
e811c8ce 4939def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
4940 """
4941 WakeUpIdle()
6c3b4aae 4942
66c033b4
RD
4943 Cause the message queue to become empty again, so idle events will be
4944 sent.
0df68c9f 4945 """
54f9ee45 4946 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 4947
e811c8ce 4948def PostEvent(*args, **kwargs):
0df68c9f
RD
4949 """
4950 PostEvent(EvtHandler dest, Event event)
6c3b4aae 4951
66c033b4
RD
4952 Send an event to a window or other wx.EvtHandler to be processed
4953 later.
0df68c9f 4954 """
54f9ee45 4955 return _core_.PostEvent(*args, **kwargs)
d14a1e28 4956
e811c8ce 4957def App_CleanUp(*args, **kwargs):
0df68c9f
RD
4958 """
4959 App_CleanUp()
6c3b4aae 4960
41e2b43e 4961 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 4962 Python shuts down.
0df68c9f 4963 """
54f9ee45 4964 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 4965
e811c8ce 4966def GetApp(*args, **kwargs):
0df68c9f
RD
4967 """
4968 GetApp() -> PyApp
6c3b4aae 4969
196addbf 4970 Return a reference to the current wx.App object.
0df68c9f 4971 """
54f9ee45 4972 return _core_.GetApp(*args, **kwargs)
d14a1e28
RD
4973#----------------------------------------------------------------------
4974
4975class PyOnDemandOutputWindow:
6c3b4aae
RD
4976 """
4977 A class that can be used for redirecting Python's stdout and
4978 stderr streams. It will do nothing until something is wrriten to
4979 the stream at which point it will create a Frame with a text area
4980 and write the text there.
4981 """
d14a1e28
RD
4982 def __init__(self, title = "wxPython: stdout/stderr"):
4983 self.frame = None
4984 self.title = title
4985 self.parent = None
4986
4987 def SetParent(self, parent):
6c3b4aae 4988 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
4989 self.parent = parent
4990
6c3b4aae
RD
4991
4992 def CreateOutputWindow(self, st):
4993 self.frame = wx.Frame(self.parent, -1, self.title,
4994 style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE)
196addbf
RD
4995 self.text = wx.TextCtrl(self.frame, -1, "",
4996 style = wx.TE_MULTILINE | wx.TE_READONLY)
d1e20054 4997 self.text.AppendText(st)
6c3b4aae
RD
4998 self.frame.SetSize((450, 300))
4999 self.frame.Show(True)
5000 EVT_CLOSE(self.frame, self.OnCloseWindow)
5001
d14a1e28 5002
7409c0c6
RD
5003 def OnCloseWindow(self, event):
5004 if self.frame is not None:
5005 self.frame.Destroy()
5006 self.frame = None
5007 self.text = None
5008
5009
d14a1e28 5010 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5011 def write(self, text):
5012 """
5013 Create the output window if needed and write the string to it.
5014 If not called in the context of the gui thread then uses
5015 CallAfter to do the work there.
5016 """
5017 if self.frame is None:
5018 if not wx.Thread_IsMain():
5019 wx.CallAfter(self.CreateOutputWindow, text)
5020 else:
5021 self.CreateOutputWindow(text)
5022 else:
5023 if not wx.Thread_IsMain():
5024 wx.CallAfter(self.text.AppendText, text)
5025 else:
5026 self.text.AppendText(text)
5027
d14a1e28
RD
5028
5029 def close(self):
6c3b4aae
RD
5030 if self.frame is not None:
5031 wx.CallAfter(self.frame.Close)
5032
d14a1e28
RD
5033
5034
5035#----------------------------------------------------------------------
d14a1e28
RD
5036
5037_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5038
5039class App(wx.PyApp):
6c3b4aae 5040 """
66c033b4
RD
5041 The ``wx.App`` class represents the application and is used to:
5042
5043 * bootstrap the wxPython system and initialize the underlying
5044 gui toolkit
5045 * set and get application-wide properties
5046 * implement the windowing system main message or event loop,
5047 and to dispatch events to window instances
5048 * etc.
5049
5050 Every application must have a ``wx.App`` instance, and all
5051 creation of UI objects should be delayed until after the
03e37cd5
RD
5052 ``wx.App`` object has been created in order to ensure that the gui
5053 platform and wxWidgets have been fully initialized.
66c033b4
RD
5054
5055 Normally you would derive from this class and implement an
5056 ``OnInit`` method that creates a frame and then calls
5057 ``self.SetTopWindow(frame)``.
5058
03e37cd5 5059 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5060 directly.
6c3b4aae 5061 """
66c033b4 5062
d14a1e28
RD
5063 outputWindowClass = PyOnDemandOutputWindow
5064
03e37cd5
RD
5065 def __init__(self, redirect=_defRedirect, filename=None,
5066 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5067 """
5068 Construct a ``wx.App`` object.
5069
03e37cd5
RD
5070 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5071 redirected? Defaults to True on Windows and Mac, False
5072 otherwise. If `filename` is None then output will be
5073 redirected to a window that pops up as needed. (You can
5074 control what kind of window is created for the output by
5075 resetting the class variable ``outputWindowClass`` to a
5076 class of your choosing.)
66c033b4 5077
03e37cd5
RD
5078 :param filename: The name of a file to redirect output to, if
5079 redirect is True.
66c033b4
RD
5080
5081 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5082 available visual provided by the system (only relevant on
5083 systems that have more than one visual.) This parameter
5084 must be used instead of calling `SetUseBestVisual` later
5085 on because it must be set before the underlying GUI
5086 toolkit is initialized.
5087
5088 :param clearSigInt: Should SIGINT be cleared? This allows the
5089 app to terminate upon a Ctrl-C in the console like other
5090 GUI apps will.
66c033b4
RD
5091
5092 :note: You should override OnInit to do applicaition
5093 initialization to ensure that the system, toolkit and
5094 wxWidgets are fully initialized.
5095 """
d14a1e28
RD
5096 wx.PyApp.__init__(self)
5097
5098 if wx.Platform == "__WXMAC__":
5099 try:
5100 import MacOS
5101 if not MacOS.WMAvailable():
5102 print """\
5103This program needs access to the screen. Please run with 'pythonw',
5104not 'python', and only when you are logged in on the main display of
5105your Mac."""
5106 _sys.exit(1)
36cadbf7
RD
5107 except SystemExit:
5108 raise
d14a1e28
RD
5109 except:
5110 pass
5111
5112 # This has to be done before OnInit
5113 self.SetUseBestVisual(useBestVisual)
5114
5115 # Set the default handler for SIGINT. This fixes a problem
5116 # where if Ctrl-C is pressed in the console that started this
5117 # app then it will not appear to do anything, (not even send
5118 # KeyboardInterrupt???) but will later segfault on exit. By
5119 # setting the default handler then the app will exit, as
5120 # expected (depending on platform.)
03e37cd5
RD
5121 if clearSigInt:
5122 try:
5123 import signal
5124 signal.signal(signal.SIGINT, signal.SIG_DFL)
5125 except:
5126 pass
d14a1e28
RD
5127
5128 # Save and redirect the stdio to a window?
5129 self.stdioWin = None
5130 self.saveStdio = (_sys.stdout, _sys.stderr)
5131 if redirect:
5132 self.RedirectStdio(filename)
5133
5134 # This finishes the initialization of wxWindows and then calls
5135 # the OnInit that should be present in the derived class
5136 self._BootstrapApp()
5137
5138
5139 def __del__(self):
5140 try:
5141 self.RestoreStdio() # Just in case the MainLoop was overridden
5142 except:
5143 pass
5144
5145
5146 def SetTopWindow(self, frame):
1e0c8722 5147 """Set the \"main\" top level window"""
d14a1e28
RD
5148 if self.stdioWin:
5149 self.stdioWin.SetParent(frame)
5150 wx.PyApp.SetTopWindow(self, frame)
5151
5152
5153 def MainLoop(self):
1e0c8722 5154 """Execute the main GUI event loop"""
d14a1e28
RD
5155 wx.PyApp.MainLoop(self)
5156 self.RestoreStdio()
5157
5158
7409c0c6 5159 def RedirectStdio(self, filename=None):
1e0c8722 5160 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5161 if filename:
5162 _sys.stdout = _sys.stderr = open(filename, 'a')
5163 else:
5164 self.stdioWin = self.outputWindowClass()
5165 _sys.stdout = _sys.stderr = self.stdioWin
5166
5167
5168 def RestoreStdio(self):
5169 _sys.stdout, _sys.stderr = self.saveStdio
5170
5171
5172
66c033b4 5173# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5174App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5175App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5176App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5177App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5178App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5179App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5180App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5181App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5182App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5183App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5184App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5185
5186#----------------------------------------------------------------------------
5187
5188class PySimpleApp(wx.App):
6c3b4aae
RD
5189 """
5190 A simple application class. You can just create one of these and
5191 then then make your top level windows later, and not have to worry
66c033b4
RD
5192 about OnInit. For example::
5193
5194 app = wx.PySimpleApp()
5195 frame = wx.Frame(None, title='Hello World')
5196 frame.Show()
5197 app.MainLoop()
5198
5199 :see: `wx.App`
5200 """
6c3b4aae 5201
03e37cd5
RD
5202 def __init__(self, redirect=False, filename=None,
5203 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5204 """
5205 :see: `wx.App.__init__`
5206 """
03e37cd5 5207 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5208
d14a1e28 5209 def OnInit(self):
d14a1e28
RD
5210 return True
5211
5212
66c033b4 5213
6c3b4aae 5214# Is anybody using this one?
d14a1e28
RD
5215class PyWidgetTester(wx.App):
5216 def __init__(self, size = (250, 100)):
5217 self.size = size
5218 wx.App.__init__(self, 0)
5219
5220 def OnInit(self):
196addbf 5221 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5222 self.SetTopWindow(self.frame)
5223 return True
5224
66c033b4
RD
5225 def SetWidget(self, widgetClass, *args, **kwargs):
5226 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5227 self.frame.Show(True)
5228
5229#----------------------------------------------------------------------------
5230# DO NOT hold any other references to this object. This is how we
66c033b4 5231# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5232# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5233# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5234
5235class __wxPyCleanup:
5236 def __init__(self):
54f9ee45 5237 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5238 def __del__(self):
5239 self.cleanup()
5240
5241_sys.__wxPythonCleanup = __wxPyCleanup()
5242
5243## # another possible solution, but it gets called too early...
66c033b4
RD
5244## import atexit
5245## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5246
5247
5248#----------------------------------------------------------------------------
5249
5250#---------------------------------------------------------------------------
5251
1e0c8722 5252class AcceleratorEntry(object):
66c033b4
RD
5253 """
5254 A class used to define items in an `wx.AcceleratorTable`. wxPython
5255 programs can choose to use wx.AcceleratorEntry objects, but using a
5256 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5257 as well. See `__init__` for of the tuple values.
66c033b4
RD
5258
5259 :see: `wx.AcceleratorTable`
5260 """
1e0c8722
RD
5261 def __repr__(self):
5262 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5263 def __init__(self, *args, **kwargs):
66c033b4
RD
5264 """
5265 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5266
5267 Construct a wx.AcceleratorEntry.
66c033b4 5268 """
54f9ee45 5269 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
1e0c8722
RD
5270 self.this = newobj.this
5271 self.thisown = 1
5272 del newobj.thisown
54f9ee45 5273 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
a95a7133 5274 """__del__(self)"""
1e0c8722
RD
5275 try:
5276 if self.thisown: destroy(self)
5277 except: pass
5278
5279 def Set(*args, **kwargs):
66c033b4
RD
5280 """
5281 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5282
66c033b4
RD
5283 (Re)set the attributes of a wx.AcceleratorEntry.
5284 :see `__init__`
5285 """
5286 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5287
5288 def GetFlags(*args, **kwargs):
66c033b4
RD
5289 """
5290 GetFlags(self) -> int
5291
5292 Get the AcceleratorEntry's flags.
5293 """
54f9ee45 5294 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5295
5296 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5297 """
5298 GetKeyCode(self) -> int
5299
5300 Get the AcceleratorEntry's keycode.
5301 """
54f9ee45 5302 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5303
5304 def GetCommand(*args, **kwargs):
66c033b4
RD
5305 """
5306 GetCommand(self) -> int
5307
5308 Get the AcceleratorEntry's command ID.
5309 """
54f9ee45 5310 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5311
5312
5313class AcceleratorEntryPtr(AcceleratorEntry):
5314 def __init__(self, this):
5315 self.this = this
5316 if not hasattr(self,"thisown"): self.thisown = 0
5317 self.__class__ = AcceleratorEntry
54f9ee45 5318_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5319
5320class AcceleratorTable(Object):
66c033b4
RD
5321 """
5322 An accelerator table allows the application to specify a table of
5323 keyboard shortcuts for menus or other commands. On Windows, menu or
5324 button commands are supported; on GTK, only menu commands are
5325 supported.
66c033b4 5326 """
1e0c8722
RD
5327 def __repr__(self):
5328 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5329 def __init__(self, *args, **kwargs):
0df68c9f
RD
5330 """
5331 __init__(entries) -> AcceleratorTable
1e0c8722 5332
66c033b4
RD
5333 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5334 items or or of 3-tuples (flags, keyCode, cmdID)
5335
5336 :see: `wx.AcceleratorEntry`
0df68c9f 5337 """
54f9ee45 5338 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5339 self.this = newobj.this
5340 self.thisown = 1
5341 del newobj.thisown
54f9ee45 5342 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5343 """__del__(self)"""
1e0c8722
RD
5344 try:
5345 if self.thisown: destroy(self)
5346 except: pass
5347
5348 def Ok(*args, **kwargs):
a95a7133 5349 """Ok(self) -> bool"""
54f9ee45 5350 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5351
5352
5353class AcceleratorTablePtr(AcceleratorTable):
5354 def __init__(self, this):
5355 self.this = this
5356 if not hasattr(self,"thisown"): self.thisown = 0
5357 self.__class__ = AcceleratorTable
54f9ee45 5358_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5359
5360
5361def GetAccelFromString(*args, **kwargs):
196addbf 5362 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5363 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5364#---------------------------------------------------------------------------
5365
74a57fcd
RD
5366class VisualAttributes(object):
5367 """struct containing all the visual attributes of a control"""
5368 def __repr__(self):
5369 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5370 def __init__(self, *args, **kwargs):
5371 """
a95a7133 5372 __init__(self) -> VisualAttributes
74a57fcd
RD
5373
5374 struct containing all the visual attributes of a control
5375 """
54f9ee45 5376 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5377 self.this = newobj.this
5378 self.thisown = 1
5379 del newobj.thisown
54f9ee45 5380 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 5381 """__del__(self)"""
74a57fcd
RD
5382 try:
5383 if self.thisown: destroy(self)
5384 except: pass
5385
54f9ee45
RD
5386 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5387 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5388 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
5389
5390class VisualAttributesPtr(VisualAttributes):
5391 def __init__(self, this):
5392 self.this = this
5393 if not hasattr(self,"thisown"): self.thisown = 0
5394 self.__class__ = VisualAttributes
54f9ee45 5395_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
5396NullAcceleratorTable = cvar.NullAcceleratorTable
5397PanelNameStr = cvar.PanelNameStr
5398
54f9ee45
RD
5399WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5400WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5401WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5402WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5403WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 5404class Window(EvtHandler):
15afbcd0
RD
5405 """
5406 wx.Window is the base class for all windows and represents any visible
5407 object on the screen. All controls, top level windows and so on are
5408 wx.Windows. Sizers and device contexts are not however, as they don't
5409 appear on screen themselves.
5410
5411 """
e811c8ce
RD
5412 def __repr__(self):
5413 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 5414 def __init__(self, *args, **kwargs):
0df68c9f 5415 """
a95a7133 5416 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5417 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
5418
5419 Construct and show a generic Window.
0df68c9f 5420 """
54f9ee45 5421 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
5422 self.this = newobj.this
5423 self.thisown = 1
5424 del newobj.thisown
5425 self._setOORInfo(self)
d14a1e28 5426
e811c8ce 5427 def Create(*args, **kwargs):
0df68c9f 5428 """
a95a7133 5429 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5430 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
5431
5432 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 5433 """
54f9ee45 5434 return _core_.Window_Create(*args, **kwargs)
d14a1e28 5435
e811c8ce 5436 def Close(*args, **kwargs):
15afbcd0 5437 """
a95a7133 5438 Close(self, bool force=False) -> bool
15afbcd0
RD
5439
5440 This function simply generates a EVT_CLOSE event whose handler usually
5441 tries to close the window. It doesn't close the window itself,
5442 however. If force is False (the default) then the window's close
5443 handler will be allowed to veto the destruction of the window.
15afbcd0 5444 """
54f9ee45 5445 return _core_.Window_Close(*args, **kwargs)
d14a1e28 5446
e811c8ce 5447 def Destroy(*args, **kwargs):
0df68c9f 5448 """
a95a7133 5449 Destroy(self) -> bool
d14a1e28 5450
15afbcd0
RD
5451 Destroys the window safely. Frames and dialogs are not destroyed
5452 immediately when this function is called -- they are added to a list
5453 of windows to be deleted on idle time, when all the window's events
5454 have been processed. This prevents problems with events being sent to
5455 non-existent windows.
5456
5457 Returns True if the window has either been successfully deleted, or it
5458 has been added to the list of windows pending real deletion.
0df68c9f 5459 """
54f9ee45 5460 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 5461
e811c8ce 5462 def DestroyChildren(*args, **kwargs):
15afbcd0 5463 """
a95a7133 5464 DestroyChildren(self) -> bool
15afbcd0 5465
41e2b43e
RD
5466 Destroys all children of a window. Called automatically by the
5467 destructor.
15afbcd0 5468 """
54f9ee45 5469 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 5470
e811c8ce 5471 def IsBeingDeleted(*args, **kwargs):
15afbcd0 5472 """
a95a7133 5473 IsBeingDeleted(self) -> bool
15afbcd0
RD
5474
5475 Is the window in the process of being deleted?
5476 """
54f9ee45 5477 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 5478
e811c8ce 5479 def SetTitle(*args, **kwargs):
15afbcd0 5480 """
a95a7133 5481 SetTitle(self, String title)
15afbcd0
RD
5482
5483 Sets the window's title. Applicable only to frames and dialogs.
5484 """
54f9ee45 5485 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 5486
e811c8ce 5487 def GetTitle(*args, **kwargs):
15afbcd0 5488 """
a95a7133 5489 GetTitle(self) -> String
15afbcd0
RD
5490
5491 Gets the window's title. Applicable only to frames and dialogs.
5492 """
54f9ee45 5493 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 5494
e811c8ce 5495 def SetLabel(*args, **kwargs):
15afbcd0 5496 """
a95a7133 5497 SetLabel(self, String label)
15afbcd0
RD
5498
5499 Set the text which the window shows in its label if applicable.
5500 """
54f9ee45 5501 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 5502
e811c8ce 5503 def GetLabel(*args, **kwargs):
15afbcd0 5504 """
a95a7133 5505 GetLabel(self) -> String
15afbcd0 5506
41e2b43e
RD
5507 Generic way of getting a label from any window, for identification
5508 purposes. The interpretation of this function differs from class to
5509 class. For frames and dialogs, the value returned is the title. For
5510 buttons or static text controls, it is the button text. This function
5511 can be useful for meta-programs such as testing tools or special-needs
5512 access programs)which need to identify windows by name.
15afbcd0 5513 """
54f9ee45 5514 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 5515
e811c8ce 5516 def SetName(*args, **kwargs):
15afbcd0 5517 """
a95a7133 5518 SetName(self, String name)
15afbcd0 5519
41e2b43e
RD
5520 Sets the window's name. The window name is used for ressource setting
5521 in X, it is not the same as the window title/label
15afbcd0 5522 """
54f9ee45 5523 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 5524
e811c8ce 5525 def GetName(*args, **kwargs):
15afbcd0 5526 """
a95a7133 5527 GetName(self) -> String
15afbcd0 5528
41e2b43e
RD
5529 Returns the windows name. This name is not guaranteed to be unique;
5530 it is up to the programmer to supply an appropriate name in the window
5531 constructor or via wx.Window.SetName.
15afbcd0 5532 """
54f9ee45 5533 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 5534
4276dc52
RD
5535 def SetWindowVariant(*args, **kwargs):
5536 """
a95a7133 5537 SetWindowVariant(self, int variant)
4276dc52 5538
41e2b43e
RD
5539 Sets the variant of the window/font size to use for this window, if
5540 the platform supports variants, for example, wxMac.
4276dc52 5541 """
54f9ee45 5542 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
5543
5544 def GetWindowVariant(*args, **kwargs):
a95a7133 5545 """GetWindowVariant(self) -> int"""
54f9ee45 5546 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 5547
e811c8ce 5548 def SetId(*args, **kwargs):
15afbcd0 5549 """
a95a7133 5550 SetId(self, int winid)
15afbcd0
RD
5551
5552 Sets the identifier of the window. Each window has an integer
5553 identifier. If the application has not provided one, an identifier
5554 will be generated. Normally, the identifier should be provided on
5555 creation and should not be modified subsequently.
5556 """
54f9ee45 5557 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 5558
e811c8ce 5559 def GetId(*args, **kwargs):
15afbcd0 5560 """
a95a7133 5561 GetId(self) -> int
15afbcd0
RD
5562
5563 Returns the identifier of the window. Each window has an integer
5564 identifier. If the application has not provided one (or the default Id
5565 -1 is used) then an unique identifier with a negative value will be
5566 generated.
5567 """
54f9ee45 5568 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 5569
e811c8ce 5570 def NewControlId(*args, **kwargs):
15afbcd0 5571 """
66c033b4 5572 NewControlId() -> int
15afbcd0
RD
5573
5574 Generate a control id for the controls which were not given one.
5575 """
54f9ee45 5576 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 5577
e811c8ce
RD
5578 NewControlId = staticmethod(NewControlId)
5579 def NextControlId(*args, **kwargs):
15afbcd0 5580 """
66c033b4 5581 NextControlId(int winid) -> int
15afbcd0
RD
5582
5583 Get the id of the control following the one with the given
41e2b43e 5584 autogenerated) id
15afbcd0 5585 """
54f9ee45 5586 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 5587
e811c8ce
RD
5588 NextControlId = staticmethod(NextControlId)
5589 def PrevControlId(*args, **kwargs):
15afbcd0 5590 """
66c033b4 5591 PrevControlId(int winid) -> int
15afbcd0
RD
5592
5593 Get the id of the control preceding the one with the given
41e2b43e 5594 autogenerated) id
15afbcd0 5595 """
54f9ee45 5596 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 5597
e811c8ce
RD
5598 PrevControlId = staticmethod(PrevControlId)
5599 def SetSize(*args, **kwargs):
15afbcd0 5600 """
a95a7133 5601 SetSize(self, Size size)
15afbcd0
RD
5602
5603 Sets the size of the window in pixels.
5604 """
54f9ee45 5605 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 5606
e811c8ce 5607 def SetDimensions(*args, **kwargs):
15afbcd0 5608 """
a95a7133 5609 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5610
5611 Sets the position and size of the window in pixels. The sizeFlags
5612 parameter indicates the interpretation of the other params if they are
5613 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5614 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5615 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5616 dimensions of -1 and less to be interpreted as real dimensions, not
5617 default values.
5618 """
54f9ee45 5619 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 5620
e811c8ce 5621 def SetRect(*args, **kwargs):
15afbcd0 5622 """
a95a7133 5623 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5624
5625 Sets the position and size of the window in pixels using a wx.Rect.
5626 """
54f9ee45 5627 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 5628
e811c8ce 5629 def SetSizeWH(*args, **kwargs):
15afbcd0 5630 """
a95a7133 5631 SetSizeWH(self, int width, int height)
15afbcd0
RD
5632
5633 Sets the size of the window in pixels.
5634 """
54f9ee45 5635 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 5636
e811c8ce 5637 def Move(*args, **kwargs):
15afbcd0 5638 """
a95a7133 5639 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5640
5641 Moves the window to the given position.
5642 """
54f9ee45 5643 return _core_.Window_Move(*args, **kwargs)
d14a1e28 5644
e811c8ce
RD
5645 SetPosition = Move
5646 def MoveXY(*args, **kwargs):
15afbcd0 5647 """
a95a7133 5648 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5649
5650 Moves the window to the given position.
5651 """
54f9ee45 5652 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce
RD
5653
5654 def Raise(*args, **kwargs):
15afbcd0 5655 """
a95a7133 5656 Raise(self)
15afbcd0
RD
5657
5658 Raises the window to the top of the window hierarchy if it is a
5659 managed window (dialog or frame).
5660 """
54f9ee45 5661 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
5662
5663 def Lower(*args, **kwargs):
15afbcd0 5664 """
a95a7133 5665 Lower(self)
15afbcd0
RD
5666
5667 Lowers the window to the bottom of the window hierarchy if it is a
5668 managed window (dialog or frame).
5669 """
54f9ee45 5670 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
5671
5672 def SetClientSize(*args, **kwargs):
15afbcd0 5673 """
a95a7133 5674 SetClientSize(self, Size size)
15afbcd0
RD
5675
5676 This sets the size of the window client area in pixels. Using this
5677 function to size a window tends to be more device-independent than
5678 wx.Window.SetSize, since the application need not worry about what
5679 dimensions the border or title bar have when trying to fit the window
5680 around panel items, for example.
5681 """
54f9ee45 5682 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
5683
5684 def SetClientSizeWH(*args, **kwargs):
15afbcd0 5685 """
a95a7133 5686 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
5687
5688 This sets the size of the window client area in pixels. Using this
5689 function to size a window tends to be more device-independent than
5690 wx.Window.SetSize, since the application need not worry about what
5691 dimensions the border or title bar have when trying to fit the window
5692 around panel items, for example.
5693 """
54f9ee45 5694 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
5695
5696 def SetClientRect(*args, **kwargs):
15afbcd0 5697 """
a95a7133 5698 SetClientRect(self, Rect rect)
15afbcd0
RD
5699
5700 This sets the size of the window client area in pixels. Using this
5701 function to size a window tends to be more device-independent than
5702 wx.Window.SetSize, since the application need not worry about what
5703 dimensions the border or title bar have when trying to fit the window
5704 around panel items, for example.
5705 """
54f9ee45 5706 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
5707
5708 def GetPosition(*args, **kwargs):
0df68c9f 5709 """
a95a7133 5710 GetPosition(self) -> Point
e811c8ce 5711
0df68c9f
RD
5712 Get the window's position.
5713 """
54f9ee45 5714 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
5715
5716 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5717 """
5718 GetPositionTuple() -> (x,y)
e811c8ce 5719
0df68c9f
RD
5720 Get the window's position.
5721 """
54f9ee45 5722 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5723
5724 def GetSize(*args, **kwargs):
0df68c9f 5725 """
a95a7133 5726 GetSize(self) -> Size
e811c8ce 5727
0df68c9f
RD
5728 Get the window size.
5729 """
54f9ee45 5730 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
5731
5732 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
5733 """
5734 GetSizeTuple() -> (width, height)
e811c8ce 5735
0df68c9f
RD
5736 Get the window size.
5737 """
54f9ee45 5738 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
5739
5740 def GetRect(*args, **kwargs):
15afbcd0 5741 """
a95a7133 5742 GetRect(self) -> Rect
15afbcd0
RD
5743
5744 Returns the size and position of the window as a wx.Rect object.
5745 """
54f9ee45 5746 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
5747
5748 def GetClientSize(*args, **kwargs):
0df68c9f 5749 """
a95a7133 5750 GetClientSize(self) -> Size
e811c8ce 5751
15afbcd0
RD
5752 This gets the size of the window's 'client area' in pixels. The client
5753 area is the area which may be drawn on by the programmer, excluding
5754 title bar, border, scrollbars, etc.
0df68c9f 5755 """
54f9ee45 5756 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
5757
5758 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
5759 """
5760 GetClientSizeTuple() -> (width, height)
e811c8ce 5761
15afbcd0
RD
5762 This gets the size of the window's 'client area' in pixels. The client
5763 area is the area which may be drawn on by the programmer, excluding
5764 title bar, border, scrollbars, etc.
0df68c9f 5765 """
54f9ee45 5766 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
5767
5768 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 5769 """
a95a7133 5770 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
5771
5772 Get the origin of the client area of the window relative to the
5773 window's top left corner (the client area may be shifted because of
5774 the borders, scrollbars, other decorations...)
5775 """
54f9ee45 5776 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
5777
5778 def GetClientRect(*args, **kwargs):
15afbcd0 5779 """
a95a7133 5780 GetClientRect(self) -> Rect
15afbcd0 5781
61863841 5782 Get the client area position and size as a `wx.Rect` object.
15afbcd0 5783 """
54f9ee45 5784 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
5785
5786 def GetBestSize(*args, **kwargs):
0df68c9f 5787 """
a95a7133 5788 GetBestSize(self) -> Size
e811c8ce 5789
248ed943 5790 This function returns the best acceptable minimal size for the
41e2b43e
RD
5791 window, if applicable. For example, for a static text control, it will
5792 be the minimal size such that the control label is not truncated. For
5793 windows containing subwindows (suzh aswx.Panel), the size returned by
5794 this function will be the same as the size the window would have had
5795 after calling Fit.
0df68c9f 5796 """
54f9ee45 5797 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
5798
5799 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
5800 """
5801 GetBestSizeTuple() -> (width, height)
e811c8ce 5802
248ed943 5803 This function returns the best acceptable minimal size for the
41e2b43e
RD
5804 window, if applicable. For example, for a static text control, it will
5805 be the minimal size such that the control label is not truncated. For
5806 windows containing subwindows (suzh aswx.Panel), the size returned by
5807 this function will be the same as the size the window would have had
5808 after calling Fit.
0df68c9f 5809 """
54f9ee45 5810 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce
RD
5811
5812 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 5813 """
a95a7133 5814 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
5815
5816 This method is similar to GetBestSize, except in one
5817 thing. GetBestSize should return the minimum untruncated size of the
5818 window, while this method will return the largest of BestSize and any
5819 user specified minimum size. ie. it is the minimum size the window
5820 should currently be drawn at, not the minimal size it can possibly
5821 tolerate.
5822 """
54f9ee45 5823 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
5824
5825 def Center(*args, **kwargs):
15afbcd0 5826 """
a95a7133 5827 Center(self, int direction=BOTH)
15afbcd0
RD
5828
5829 Centers the window. The parameter specifies the direction for
5830 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
5831 also include wx.CENTER_ON_SCREEN flag if you want to center the window
5832 on the entire screen and not on its parent window. If it is a
5833 top-level window and has no parent then it will always be centered
5834 relative to the screen.
5835 """
54f9ee45 5836 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
5837
5838 Centre = Center
5839 def CenterOnScreen(*args, **kwargs):
15afbcd0 5840 """
a95a7133 5841 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
5842
5843 Center on screen (only works for top level windows)
5844 """
54f9ee45 5845 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
5846
5847 CentreOnScreen = CenterOnScreen
5848 def CenterOnParent(*args, **kwargs):
15afbcd0 5849 """
a95a7133 5850 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
5851
5852 Center with respect to the the parent window
5853 """
54f9ee45 5854 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
5855
5856 CentreOnParent = CenterOnParent
5857 def Fit(*args, **kwargs):
15afbcd0 5858 """
a95a7133 5859 Fit(self)
15afbcd0
RD
5860
5861 Sizes the window so that it fits around its subwindows. This function
5862 won't do anything if there are no subwindows and will only really work
5863 correctly if sizers are used for the subwindows layout. Also, if the
5864 window has exactly one subwindow it is better (faster and the result
5865 is more precise as Fit adds some margin to account for fuzziness of
5866 its calculations) to call window.SetClientSize(child.GetSize())
5867 instead of calling Fit.
5868 """
54f9ee45 5869 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
5870
5871 def FitInside(*args, **kwargs):
15afbcd0 5872 """
a95a7133 5873 FitInside(self)
15afbcd0
RD
5874
5875 Similar to Fit, but sizes the interior (virtual) size of a
5876 window. Mainly useful with scrolled windows to reset scrollbars after
5877 sizing changes that do not trigger a size event, and/or scrolled
5878 windows without an interior sizer. This function similarly won't do
5879 anything if there are no subwindows.
5880 """
54f9ee45 5881 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 5882
74a57fcd 5883 def SetSizeHints(*args):
0df68c9f 5884 """
908b74cd 5885 SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
a95a7133 5886 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 5887 int incH=-1)
15afbcd0
RD
5888
5889 Allows specification of minimum and maximum window sizes, and window
5890 size increments. If a pair of values is not set (or set to -1), the
5891 default values will be used. If this function is called, the user
908b74cd
RD
5892 will not be able to size the window outside the given bounds (if it is
5893 a top-level window.) Sizers will also inspect the minimum window size
5894 and will use that value if set when calculating layout.
5895
5896 The resizing increments are only significant under Motif or Xt.
0df68c9f 5897 """
54f9ee45 5898 return _core_.Window_SetSizeHints(*args)
e811c8ce 5899
74a57fcd 5900 def SetVirtualSizeHints(*args):
15afbcd0 5901 """
a95a7133 5902 SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
908b74cd 5903 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
5904
5905 Allows specification of minimum and maximum virtual window sizes. If a
5906 pair of values is not set (or set to -1), the default values will be
5907 used. If this function is called, the user will not be able to size
5908 the virtual area of the window outside the given bounds.
5909 """
54f9ee45 5910 return _core_.Window_SetVirtualSizeHints(*args)
e811c8ce 5911
908b74cd
RD
5912 def GetMaxSize(*args, **kwargs):
5913 """GetMaxSize(self) -> Size"""
5914 return _core_.Window_GetMaxSize(*args, **kwargs)
5915
5916 def GetMinSize(*args, **kwargs):
5917 """GetMinSize(self) -> Size"""
5918 return _core_.Window_GetMinSize(*args, **kwargs)
5919
5920 def SetMinSize(*args, **kwargs):
5921 """
5922 SetMinSize(self, Size minSize)
5923
5924 A more convenient method than `SetSizeHints` for setting just the
5925 min size.
5926 """
5927 return _core_.Window_SetMinSize(*args, **kwargs)
5928
5929 def SetMaxSize(*args, **kwargs):
5930 """
5931 SetMaxSize(self, Size maxSize)
5932
5933 A more convenient method than `SetSizeHints` for setting just the
5934 max size.
5935 """
5936 return _core_.Window_SetMaxSize(*args, **kwargs)
5937
e811c8ce 5938 def GetMinWidth(*args, **kwargs):
a95a7133 5939 """GetMinWidth(self) -> int"""
54f9ee45 5940 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
5941
5942 def GetMinHeight(*args, **kwargs):
a95a7133 5943 """GetMinHeight(self) -> int"""
54f9ee45 5944 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
5945
5946 def GetMaxWidth(*args, **kwargs):
a95a7133 5947 """GetMaxWidth(self) -> int"""
54f9ee45 5948 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
5949
5950 def GetMaxHeight(*args, **kwargs):
a95a7133 5951 """GetMaxHeight(self) -> int"""
54f9ee45 5952 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 5953
e811c8ce 5954 def SetVirtualSize(*args, **kwargs):
0df68c9f 5955 """
a95a7133 5956 SetVirtualSize(self, Size size)
e811c8ce 5957
15afbcd0
RD
5958 Set the the virtual size of a window in pixels. For most windows this
5959 is just the client area of the window, but for some like scrolled
5960 windows it is more or less independent of the screen window size.
0df68c9f 5961 """
54f9ee45 5962 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
5963
5964 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 5965 """
a95a7133 5966 SetVirtualSizeWH(self, int w, int h)
e811c8ce 5967
15afbcd0
RD
5968 Set the the virtual size of a window in pixels. For most windows this
5969 is just the client area of the window, but for some like scrolled
5970 windows it is more or less independent of the screen window size.
0df68c9f 5971 """
54f9ee45 5972 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
5973
5974 def GetVirtualSize(*args, **kwargs):
0df68c9f 5975 """
a95a7133 5976 GetVirtualSize(self) -> Size
e811c8ce 5977
15afbcd0
RD
5978 Get the the virtual size of the window in pixels. For most windows
5979 this is just the client area of the window, but for some like scrolled
5980 windows it is more or less independent of the screen window size.
0df68c9f 5981 """
54f9ee45 5982 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
5983
5984 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
5985 """
5986 GetVirtualSizeTuple() -> (width, height)
e811c8ce 5987
15afbcd0
RD
5988 Get the the virtual size of the window in pixels. For most windows
5989 this is just the client area of the window, but for some like scrolled
5990 windows it is more or less independent of the screen window size.
0df68c9f 5991 """
54f9ee45 5992 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
5993
5994 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 5995 """
a95a7133 5996 GetBestVirtualSize(self) -> Size
15afbcd0
RD
5997
5998 Return the largest of ClientSize and BestSize (as determined by a
5999 sizer, interior children, or other means)
6000 """
54f9ee45 6001 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
6002
6003 def Show(*args, **kwargs):
15afbcd0 6004 """
a95a7133 6005 Show(self, bool show=True) -> bool
15afbcd0
RD
6006
6007 Shows or hides the window. You may need to call Raise for a top level
6008 window if you want to bring it to top, although this is not needed if
6009 Show is called immediately after the frame creation. Returns True if
6010 the window has been shown or hidden or False if nothing was done
6011 because it already was in the requested state.
6012 """
54f9ee45 6013 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
6014
6015 def Hide(*args, **kwargs):
15afbcd0 6016 """
a95a7133 6017 Hide(self) -> bool
15afbcd0
RD
6018
6019 Equivalent to calling Show(False).
6020 """
54f9ee45 6021 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
6022
6023 def Enable(*args, **kwargs):
15afbcd0 6024 """
a95a7133 6025 Enable(self, bool enable=True) -> bool
15afbcd0
RD
6026
6027 Enable or disable the window for user input. Note that when a parent
6028 window is disabled, all of its children are disabled as well and they
6029 are reenabled again when the parent is. Returns true if the window
6030 has been enabled or disabled, false if nothing was done, i.e. if the
6031 window had already been in the specified state.
6032 """
54f9ee45 6033 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6034
6035 def Disable(*args, **kwargs):
15afbcd0 6036 """
a95a7133 6037 Disable(self) -> bool
15afbcd0
RD
6038
6039 Disables the window, same as Enable(false).
6040 """
54f9ee45 6041 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6042
6043 def IsShown(*args, **kwargs):
15afbcd0 6044 """
a95a7133 6045 IsShown(self) -> bool
15afbcd0
RD
6046
6047 Returns true if the window is shown, false if it has been hidden.
6048 """
54f9ee45 6049 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6050
6051 def IsEnabled(*args, **kwargs):
15afbcd0 6052 """
a95a7133 6053 IsEnabled(self) -> bool
15afbcd0
RD
6054
6055 Returns true if the window is enabled for input, false otherwise.
6056 """
54f9ee45 6057 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6058
6059 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6060 """
a95a7133 6061 SetWindowStyleFlag(self, long style)
15afbcd0 6062
41e2b43e
RD
6063 Sets the style of the window. Please note that some styles cannot be
6064 changed after the window creation and that Refresh() might need to be
6065 called after changing the others for the change to take place
6066 immediately.
15afbcd0 6067 """
54f9ee45 6068 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6069
6070 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6071 """
a95a7133 6072 GetWindowStyleFlag(self) -> long
e811c8ce 6073
15afbcd0
RD
6074 Gets the window style that was passed to the constructor or Create
6075 method.
6076 """
54f9ee45 6077 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6078
15afbcd0 6079 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6080 def HasFlag(*args, **kwargs):
15afbcd0 6081 """
a95a7133 6082 HasFlag(self, int flag) -> bool
15afbcd0
RD
6083
6084 Test if the given style is set for this window.
6085 """
54f9ee45 6086 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6087
6088 def IsRetained(*args, **kwargs):
15afbcd0 6089 """
a95a7133 6090 IsRetained(self) -> bool
15afbcd0
RD
6091
6092 Returns true if the window is retained, false otherwise. Retained
6093 windows are only available on X platforms.
6094 """
54f9ee45 6095 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6096
6097 def SetExtraStyle(*args, **kwargs):
15afbcd0 6098 """
a95a7133 6099 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6100
6101 Sets the extra style bits for the window. Extra styles are the less
6102 often used style bits which can't be set with the constructor or with
6103 SetWindowStyleFlag()
6104 """
54f9ee45 6105 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6106
6107 def GetExtraStyle(*args, **kwargs):
15afbcd0 6108 """
a95a7133 6109 GetExtraStyle(self) -> long
15afbcd0
RD
6110
6111 Returns the extra style bits for the window.
6112 """
54f9ee45 6113 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6114
6115 def MakeModal(*args, **kwargs):
15afbcd0 6116 """
a95a7133 6117 MakeModal(self, bool modal=True)
15afbcd0
RD
6118
6119 Disables all other windows in the application so that the user can
6120 only interact with this window. Passing False will reverse this
6121 effect.
6122 """
54f9ee45 6123 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6124
6125 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6126 """
a95a7133 6127 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6128
6129 This function tells a window if it should use the system's "theme"
6130 code to draw the windows' background instead if its own background
6131 drawing code. This will only have an effect on platforms that support
6132 the notion of themes in user defined windows. One such platform is
6133 GTK+ where windows can have (very colourful) backgrounds defined by a
6134 user's selected theme.
6135
6136 Dialogs, notebook pages and the status bar have this flag set to true
6137 by default so that the default look and feel is simulated best.
6138 """
54f9ee45 6139 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6140
6141 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6142 """
a95a7133 6143 GetThemeEnabled(self) -> bool
e811c8ce 6144
15afbcd0
RD
6145 Return the themeEnabled flag.
6146 """
54f9ee45 6147 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6148
6149 def SetFocus(*args, **kwargs):
15afbcd0 6150 """
a95a7133 6151 SetFocus(self)
15afbcd0
RD
6152
6153 Set's the focus to this window, allowing it to receive keyboard input.
6154 """
54f9ee45 6155 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6156
6157 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6158 """
a95a7133 6159 SetFocusFromKbd(self)
15afbcd0
RD
6160
6161 Set focus to this window as the result of a keyboard action. Normally
6162 only called internally.
6163 """
54f9ee45 6164 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6165
6166 def FindFocus(*args, **kwargs):
15afbcd0 6167 """
66c033b4 6168 FindFocus() -> Window
15afbcd0
RD
6169
6170 Returns the window or control that currently has the keyboard focus,
6171 or None.
6172 """
54f9ee45 6173 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6174
6175 FindFocus = staticmethod(FindFocus)
6176 def AcceptsFocus(*args, **kwargs):
15afbcd0 6177 """
a95a7133 6178 AcceptsFocus(self) -> bool
15afbcd0
RD
6179
6180 Can this window have focus?
6181 """
54f9ee45 6182 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6183
6184 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6185 """
a95a7133 6186 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6187
6188 Can this window be given focus by keyboard navigation? if not, the
6189 only way to give it focus (provided it accepts it at all) is to click
6190 it.
6191 """
54f9ee45 6192 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6193
6194 def GetDefaultItem(*args, **kwargs):
15afbcd0 6195 """
a95a7133 6196 GetDefaultItem(self) -> Window
15afbcd0
RD
6197
6198 Get the default child of this parent, i.e. the one which is activated
6199 by pressing <Enter> such as the OK button on a wx.Dialog.
6200 """
54f9ee45 6201 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6202
6203 def SetDefaultItem(*args, **kwargs):
15afbcd0 6204 """
a95a7133 6205 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6206
6207 Set this child as default, return the old default.
6208 """
54f9ee45 6209 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6210
6211 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6212 """
a95a7133 6213 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6214
6215 Set this child as temporary default
6216 """
54f9ee45 6217 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce 6218
908b74cd
RD
6219 def Navigate(*args, **kwargs):
6220 """
6221 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6222
6223 :param flags: A combination of the ``IsForward`` and ``WinChange``
6224 values in the `wx.NavigationKeyEvent` class, which
6225 determine if the navigation should be in forward or
6226 reverse order, and if it should be able to cross
6227 parent window boundaries, such as between notebook
6228 pages or MDI child frames. Typically the status of
6229 the Shift key (for forward or reverse) or the
6230 Control key (for WinChange) would be used to
6231 determine how to set the flags.
6232
6233 situation in which you may wish to call this method is from a text
6234 rol custom keypress handler to do the default navigation behaviour
6235 the tab key, since the standard default behaviour for a multiline
6236 control with the wx.TE_PROCESS_TAB style is to insert a tab and
6237 navigate to the next control.
6238 """
6239 return _core_.Window_Navigate(*args, **kwargs)
6240
e811c8ce 6241 def GetChildren(*args, **kwargs):
15afbcd0 6242 """
a95a7133 6243 GetChildren(self) -> PyObject
15afbcd0
RD
6244
6245 Returns a list of the window's children. NOTE: Currently this is a
6246 copy of the child window list maintained by the window, so the return
6247 value of this function is only valid as long as the window's children
6248 do not change.
6249 """
54f9ee45 6250 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6251
6252 def GetParent(*args, **kwargs):
15afbcd0 6253 """
a95a7133 6254 GetParent(self) -> Window
15afbcd0
RD
6255
6256 Returns the parent window of this window, or None if there isn't one.
6257 """
54f9ee45 6258 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6259
6260 def GetGrandParent(*args, **kwargs):
15afbcd0 6261 """
a95a7133 6262 GetGrandParent(self) -> Window
15afbcd0 6263
41e2b43e
RD
6264 Returns the parent of the parent of this window, or None if there
6265 isn't one.
15afbcd0 6266 """
54f9ee45 6267 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6268
6269 def IsTopLevel(*args, **kwargs):
15afbcd0 6270 """
a95a7133 6271 IsTopLevel(self) -> bool
15afbcd0
RD
6272
6273 Returns true if the given window is a top-level one. Currently all
6274 frames and dialogs are always considered to be top-level windows (even
6275 if they have a parent window).
6276 """
54f9ee45 6277 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6278
6279 def Reparent(*args, **kwargs):
15afbcd0 6280 """
a95a7133 6281 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6282
6283 Reparents the window, i.e the window will be removed from its current
6284 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6285 re-inserted into another. Available on Windows and GTK. Returns True
6286 if the parent was changed, False otherwise (error or newParent ==
6287 oldParent)
6288 """
54f9ee45 6289 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6290
6291 def AddChild(*args, **kwargs):
15afbcd0 6292 """
a95a7133 6293 AddChild(self, Window child)
15afbcd0
RD
6294
6295 Adds a child window. This is called automatically by window creation
6296 functions so should not be required by the application programmer.
6297 """
54f9ee45 6298 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6299
6300 def RemoveChild(*args, **kwargs):
15afbcd0 6301 """
a95a7133 6302 RemoveChild(self, Window child)
15afbcd0
RD
6303
6304 Removes a child window. This is called automatically by window
6305 deletion functions so should not be required by the application
6306 programmer.
6307 """
54f9ee45 6308 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
6309
6310 def FindWindowById(*args, **kwargs):
15afbcd0 6311 """
a95a7133 6312 FindWindowById(self, long winid) -> Window
15afbcd0
RD
6313
6314 Find a chld of this window by window ID
6315 """
54f9ee45 6316 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
6317
6318 def FindWindowByName(*args, **kwargs):
15afbcd0 6319 """
a95a7133 6320 FindWindowByName(self, String name) -> Window
15afbcd0
RD
6321
6322 Find a child of this window by name
6323 """
54f9ee45 6324 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
6325
6326 def GetEventHandler(*args, **kwargs):
15afbcd0 6327 """
a95a7133 6328 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
6329
6330 Returns the event handler for this window. By default, the window is
6331 its own event handler.
6332 """
54f9ee45 6333 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
6334
6335 def SetEventHandler(*args, **kwargs):
15afbcd0 6336 """
a95a7133 6337 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
6338
6339 Sets the event handler for this window. An event handler is an object
6340 that is capable of processing the events sent to a window. By default,
6341 the window is its own event handler, but an application may wish to
6342 substitute another, for example to allow central implementation of
6343 event-handling for a variety of different window classes.
6344
41e2b43e 6345 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
6346 up a chain of event handlers, where an event not handled by one event
6347 handler is handed to the next one in the chain.
6348 """
54f9ee45 6349 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
6350
6351 def PushEventHandler(*args, **kwargs):
15afbcd0 6352 """
a95a7133 6353 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
6354
6355 Pushes this event handler onto the event handler stack for the window.
6356 An event handler is an object that is capable of processing the events
6357 sent to a window. By default, the window is its own event handler, but
6358 an application may wish to substitute another, for example to allow
6359 central implementation of event-handling for a variety of different
6360 window classes.
6361
6362 wx.Window.PushEventHandler allows an application to set up a chain of
6363 event handlers, where an event not handled by one event handler is
41e2b43e 6364 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
6365 remove the event handler.
6366 """
54f9ee45 6367 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
6368
6369 def PopEventHandler(*args, **kwargs):
15afbcd0 6370 """
a95a7133 6371 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
6372
6373 Removes and returns the top-most event handler on the event handler
6374 stack. If deleteHandler is True then the wx.EvtHandler object will be
6375 destroyed after it is popped.
6376 """
54f9ee45 6377 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
6378
6379 def RemoveEventHandler(*args, **kwargs):
15afbcd0 6380 """
a95a7133 6381 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 6382
41e2b43e
RD
6383 Find the given handler in the event handler chain and remove (but not
6384 delete) it from the event handler chain, return True if it was found
6385 and False otherwise (this also results in an assert failure so this
6386 function should only be called when the handler is supposed to be
6387 there.)
15afbcd0 6388 """
54f9ee45 6389 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
6390
6391 def SetValidator(*args, **kwargs):
15afbcd0 6392 """
a95a7133 6393 SetValidator(self, Validator validator)
15afbcd0
RD
6394
6395 Deletes the current validator (if any) and sets the window validator,
6396 having called wx.Validator.Clone to create a new validator of this
6397 type.
6398 """
54f9ee45 6399 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
6400
6401 def GetValidator(*args, **kwargs):
15afbcd0 6402 """
a95a7133 6403 GetValidator(self) -> Validator
15afbcd0
RD
6404
6405 Returns a pointer to the current validator for the window, or None if
6406 there is none.
6407 """
54f9ee45 6408 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 6409
74a57fcd
RD
6410 def Validate(*args, **kwargs):
6411 """
a95a7133 6412 Validate(self) -> bool
74a57fcd
RD
6413
6414 Validates the current values of the child controls using their
41e2b43e
RD
6415 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6416 style flag set, the method will also call Validate() of all child
6417 windows. Returns false if any of the validations failed.
74a57fcd 6418 """
54f9ee45 6419 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
6420
6421 def TransferDataToWindow(*args, **kwargs):
6422 """
a95a7133 6423 TransferDataToWindow(self) -> bool
74a57fcd 6424
41e2b43e
RD
6425 Transfers values to child controls from data areas specified by their
6426 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6427 style flag set, the method will also call TransferDataToWindow() of
6428 all child windows.
74a57fcd 6429 """
54f9ee45 6430 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
6431
6432 def TransferDataFromWindow(*args, **kwargs):
6433 """
a95a7133 6434 TransferDataFromWindow(self) -> bool
74a57fcd 6435
41e2b43e
RD
6436 Transfers values from child controls to data areas specified by their
6437 validators. Returns false if a transfer failed. If the window has
6438 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6439 also call TransferDataFromWindow() of all child windows.
74a57fcd 6440 """
54f9ee45 6441 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
6442
6443 def InitDialog(*args, **kwargs):
6444 """
a95a7133 6445 InitDialog(self)
74a57fcd 6446
41e2b43e
RD
6447 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6448 to the dialog via validators.
74a57fcd 6449 """
54f9ee45 6450 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 6451
e811c8ce 6452 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 6453 """
a95a7133 6454 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
6455
6456 Sets the accelerator table for this window.
6457 """
54f9ee45 6458 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6459
6460 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 6461 """
a95a7133 6462 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
6463
6464 Gets the accelerator table for this window.
6465 """
54f9ee45 6466 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6467
6468 def RegisterHotKey(*args, **kwargs):
15afbcd0 6469 """
a95a7133 6470 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
6471
6472 Registers a system wide hotkey. Every time the user presses the hotkey
6473 registered here, this window will receive a hotkey event. It will
6474 receive the event even if the application is in the background and
6475 does not have the input focus because the user is working with some
6476 other application. To bind an event handler function to this hotkey
6477 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6478 hotkey was registered successfully.
6479 """
54f9ee45 6480 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
6481
6482 def UnregisterHotKey(*args, **kwargs):
15afbcd0 6483 """
a95a7133 6484 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
6485
6486 Unregisters a system wide hotkey.
6487 """
54f9ee45 6488 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
6489
6490 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 6491 """
a95a7133 6492 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
6493
6494 Converts a point or size from dialog units to pixels. Dialog units
6495 are used for maintaining a dialog's proportions even if the font
6496 changes. For the x dimension, the dialog units are multiplied by the
6497 average character width and then divided by 4. For the y dimension,
6498 the dialog units are multiplied by the average character height and
6499 then divided by 8.
6500 """
54f9ee45 6501 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
6502
6503 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 6504 """
a95a7133 6505 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
6506
6507 Converts a point or size from dialog units to pixels. Dialog units
6508 are used for maintaining a dialog's proportions even if the font
6509 changes. For the x dimension, the dialog units are multiplied by the
6510 average character width and then divided by 4. For the y dimension,
6511 the dialog units are multiplied by the average character height and
6512 then divided by 8.
6513 """
54f9ee45 6514 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
6515
6516 def DLG_PNT(*args, **kwargs):
15afbcd0 6517 """
a95a7133 6518 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
6519
6520 Converts a point or size from dialog units to pixels. Dialog units
6521 are used for maintaining a dialog's proportions even if the font
6522 changes. For the x dimension, the dialog units are multiplied by the
6523 average character width and then divided by 4. For the y dimension,
6524 the dialog units are multiplied by the average character height and
6525 then divided by 8.
6526 """
54f9ee45 6527 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
6528
6529 def DLG_SZE(*args, **kwargs):
15afbcd0 6530 """
a95a7133 6531 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
6532
6533 Converts a point or size from dialog units to pixels. Dialog units
6534 are used for maintaining a dialog's proportions even if the font
6535 changes. For the x dimension, the dialog units are multiplied by the
6536 average character width and then divided by 4. For the y dimension,
6537 the dialog units are multiplied by the average character height and
6538 then divided by 8.
6539 """
54f9ee45 6540 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
6541
6542 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 6543 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 6544 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
6545
6546 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 6547 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 6548 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
6549
6550 def WarpPointer(*args, **kwargs):
15afbcd0 6551 """
a95a7133 6552 WarpPointer(self, int x, int y)
15afbcd0
RD
6553
6554 Moves the pointer to the given position on the window.
6555
6556 NOTE: This function is not supported under Mac because Apple Human
6557 Interface Guidelines forbid moving the mouse cursor programmatically.
6558 """
54f9ee45 6559 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
6560
6561 def CaptureMouse(*args, **kwargs):
15afbcd0 6562 """
a95a7133 6563 CaptureMouse(self)
15afbcd0
RD
6564
6565 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6566 release the capture.
6567
6568 Note that wxWindows maintains the stack of windows having captured the
6569 mouse and when the mouse is released the capture returns to the window
6570 which had had captured it previously and it is only really released if
6571 there were no previous window. In particular, this means that you must
6572 release the mouse as many times as you capture it.
6573 """
54f9ee45 6574 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
6575
6576 def ReleaseMouse(*args, **kwargs):
15afbcd0 6577 """
a95a7133 6578 ReleaseMouse(self)
15afbcd0
RD
6579
6580 Releases mouse input captured with wx.Window.CaptureMouse.
6581 """
54f9ee45 6582 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
6583
6584 def GetCapture(*args, **kwargs):
15afbcd0 6585 """
66c033b4 6586 GetCapture() -> Window
15afbcd0
RD
6587
6588 Returns the window which currently captures the mouse or None
6589 """
54f9ee45 6590 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
6591
6592 GetCapture = staticmethod(GetCapture)
6593 def HasCapture(*args, **kwargs):
15afbcd0 6594 """
a95a7133 6595 HasCapture(self) -> bool
15afbcd0
RD
6596
6597 Returns true if this window has the current mouse capture.
6598 """
54f9ee45 6599 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
6600
6601 def Refresh(*args, **kwargs):
15afbcd0 6602 """
a95a7133 6603 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
6604
6605 Mark the specified rectangle (or the whole window) as "dirty" so it
6606 will be repainted. Causes an EVT_PAINT event to be generated and sent
6607 to the window.
6608 """
54f9ee45 6609 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
6610
6611 def RefreshRect(*args, **kwargs):
15afbcd0 6612 """
a95a7133 6613 RefreshRect(self, Rect rect)
15afbcd0
RD
6614
6615 Redraws the contents of the given rectangle: the area inside it will
6616 be repainted. This is the same as Refresh but has a nicer syntax.
6617 """
54f9ee45 6618 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
6619
6620 def Update(*args, **kwargs):
15afbcd0 6621 """
a95a7133 6622 Update(self)
15afbcd0
RD
6623
6624 Calling this method immediately repaints the invalidated area of the
6625 window instead of waiting for the EVT_PAINT event to happen, (normally
6626 this would usually only happen when the flow of control returns to the
6627 event loop.) Notice that this function doesn't refresh the window and
6628 does nothing if the window has been already repainted. Use Refresh
6629 first if you want to immediately redraw the window (or some portion of
6630 it) unconditionally.
6631 """
54f9ee45 6632 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
6633
6634 def ClearBackground(*args, **kwargs):
15afbcd0 6635 """
a95a7133 6636 ClearBackground(self)
15afbcd0
RD
6637
6638 Clears the window by filling it with the current background
6639 colour. Does not cause an erase background event to be generated.
6640 """
54f9ee45 6641 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
6642
6643 def Freeze(*args, **kwargs):
15afbcd0 6644 """
a95a7133 6645 Freeze(self)
15afbcd0 6646
41e2b43e
RD
6647 Freezes the window or, in other words, prevents any updates from
6648 taking place on screen, the window is not redrawn at all. Thaw must be
6649 called to reenable window redrawing. Calls to Freeze/Thaw may be
6650 nested, with the actual Thaw being delayed until all the nesting has
6651 been undone.
15afbcd0
RD
6652
6653 This method is useful for visual appearance optimization (for example,
6654 it is a good idea to use it before inserting large amount of text into
6655 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6656 for all controls so it is mostly just a hint to wxWindows and not a
6657 mandatory directive.
6658 """
54f9ee45 6659 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
6660
6661 def Thaw(*args, **kwargs):
15afbcd0 6662 """
a95a7133 6663 Thaw(self)
15afbcd0 6664
4276dc52 6665 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
6666 Freeze/Thaw may be nested, so Thaw must be called the same number of
6667 times that Freeze was before the window will be updated.
15afbcd0 6668 """
54f9ee45 6669 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
6670
6671 def PrepareDC(*args, **kwargs):
15afbcd0 6672 """
a95a7133 6673 PrepareDC(self, DC dc)
15afbcd0
RD
6674
6675 Call this function to prepare the device context for drawing a
6676 scrolled image. It sets the device origin according to the current
6677 scroll position.
6678 """
54f9ee45 6679 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
6680
6681 def GetUpdateRegion(*args, **kwargs):
15afbcd0 6682 """
a95a7133 6683 GetUpdateRegion(self) -> Region
15afbcd0
RD
6684
6685 Returns the region specifying which parts of the window have been
6686 damaged. Should only be called within an EVT_PAINT handler.
6687 """
54f9ee45 6688 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
6689
6690 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 6691 """
a95a7133 6692 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
6693
6694 Get the update rectangle region bounding box in client coords.
6695 """
54f9ee45 6696 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
6697
6698 def IsExposed(*args, **kwargs):
15afbcd0 6699 """
a95a7133 6700 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
6701
6702 Returns true if the given point or rectangle area has been exposed
6703 since the last repaint. Call this in an paint event handler to
6704 optimize redrawing by only redrawing those areas, which have been
6705 exposed.
6706 """
54f9ee45 6707 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
6708
6709 def IsExposedPoint(*args, **kwargs):
15afbcd0 6710 """
a95a7133 6711 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
6712
6713 Returns true if the given point or rectangle area has been exposed
6714 since the last repaint. Call this in an paint event handler to
6715 optimize redrawing by only redrawing those areas, which have been
6716 exposed.
6717 """
54f9ee45 6718 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 6719
4276dc52 6720 def IsExposedRect(*args, **kwargs):
15afbcd0 6721 """
a95a7133 6722 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
6723
6724 Returns true if the given point or rectangle area has been exposed
6725 since the last repaint. Call this in an paint event handler to
6726 optimize redrawing by only redrawing those areas, which have been
6727 exposed.
6728 """
54f9ee45 6729 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 6730
74a57fcd
RD
6731 def GetDefaultAttributes(*args, **kwargs):
6732 """
a95a7133 6733 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 6734
41e2b43e
RD
6735 Get the default attributes for an instance of this class. This is
6736 useful if you want to use the same font or colour in your own control
6737 as in a standard control -- which is a much better idea than hard
6738 coding specific colours or fonts which might look completely out of
db3e571a 6739 place on the user's system, especially if it uses themes.
74a57fcd 6740 """
54f9ee45 6741 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6742
6743 def GetClassDefaultAttributes(*args, **kwargs):
6744 """
66c033b4 6745 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 6746
41e2b43e
RD
6747 Get the default attributes for this class. This is useful if you want
6748 to use the same font or colour in your own control as in a standard
6749 control -- which is a much better idea than hard coding specific
db3e571a
RD
6750 colours or fonts which might look completely out of place on the
6751 user's system, especially if it uses themes.
74a57fcd
RD
6752
6753 The variant parameter is only relevant under Mac currently and is
41e2b43e 6754 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
6755 the returned font. See `wx.Window.SetWindowVariant` for more about
6756 this.
74a57fcd 6757 """
54f9ee45 6758 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6759
6760 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 6761 def SetBackgroundColour(*args, **kwargs):
15afbcd0 6762 """
a95a7133 6763 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
6764
6765 Sets the background colour of the window. Returns True if the colour
6766 was changed. The background colour is usually painted by the default
6767 EVT_ERASE_BACKGROUND event handler function under Windows and
6768 automatically under GTK.
6769
db3e571a 6770 Note that setting the background colour may not cause an immediate
15afbcd0
RD
6771 refresh, so you may wish to call ClearBackground or Refresh after
6772 calling this function.
6773
6774 Use this function with care under GTK+ as the new appearance of the
6775 window might not look equally well when used with themes, i.e GTK+'s
6776 ability to change its look as the user wishes with run-time loadable
6777 modules.
6778 """
54f9ee45 6779 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 6780
b2df227b 6781 def SetDefaultBackgroundColour(*args, **kwargs):
a95a7133 6782 """SetDefaultBackgroundColour(self, Colour colour)"""
54f9ee45 6783 return _core_.Window_SetDefaultBackgroundColour(*args, **kwargs)
b2df227b 6784
e811c8ce 6785 def SetForegroundColour(*args, **kwargs):
15afbcd0 6786 """
a95a7133 6787 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
6788
6789 Sets the foreground colour of the window. Returns True is the colour
6790 was changed. The interpretation of foreground colour is dependent on
6791 the window class; it may be the text colour or other colour, or it may
6792 not be used at all.
6793 """
54f9ee45 6794 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 6795
b2df227b 6796 def SetDefaultForegroundColour(*args, **kwargs):
a95a7133 6797 """SetDefaultForegroundColour(self, Colour colour)"""
54f9ee45 6798 return _core_.Window_SetDefaultForegroundColour(*args, **kwargs)
b2df227b 6799
e811c8ce 6800 def GetBackgroundColour(*args, **kwargs):
15afbcd0 6801 """
a95a7133 6802 GetBackgroundColour(self) -> Colour
15afbcd0
RD
6803
6804 Returns the background colour of the window.
6805 """
54f9ee45 6806 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
6807
6808 def GetForegroundColour(*args, **kwargs):
15afbcd0 6809 """
a95a7133 6810 GetForegroundColour(self) -> Colour
15afbcd0
RD
6811
6812 Returns the foreground colour of the window. The interpretation of
6813 foreground colour is dependent on the window class; it may be the text
6814 colour or other colour, or it may not be used at all.
6815 """
54f9ee45 6816 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce
RD
6817
6818 def SetCursor(*args, **kwargs):
15afbcd0 6819 """
a95a7133 6820 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
6821
6822 Sets the window's cursor. Notice that the window cursor also sets it
6823 for the children of the window implicitly.
6824
6825 The cursor may be wx.NullCursor in which case the window cursor will
6826 be reset back to default.
6827 """
54f9ee45 6828 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
6829
6830 def GetCursor(*args, **kwargs):
15afbcd0 6831 """
a95a7133 6832 GetCursor(self) -> Cursor
15afbcd0
RD
6833
6834 Return the cursor associated with this window.
6835 """
54f9ee45 6836 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
6837
6838 def SetFont(*args, **kwargs):
15afbcd0 6839 """
a95a7133 6840 SetFont(self, Font font) -> bool
15afbcd0
RD
6841
6842 Sets the font for this window.
6843 """
54f9ee45 6844 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 6845
b2df227b 6846 def SetDefaultFont(*args, **kwargs):
a95a7133 6847 """SetDefaultFont(self, Font font)"""
54f9ee45 6848 return _core_.Window_SetDefaultFont(*args, **kwargs)
b2df227b 6849
e811c8ce 6850 def GetFont(*args, **kwargs):
15afbcd0 6851 """
a95a7133 6852 GetFont(self) -> Font
15afbcd0 6853
4276dc52 6854 Returns the default font used for this window.
15afbcd0 6855 """
54f9ee45 6856 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
6857
6858 def SetCaret(*args, **kwargs):
15afbcd0 6859 """
a95a7133 6860 SetCaret(self, Caret caret)
15afbcd0
RD
6861
6862 Sets the caret associated with the window.
6863 """
54f9ee45 6864 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
6865
6866 def GetCaret(*args, **kwargs):
15afbcd0 6867 """
a95a7133 6868 GetCaret(self) -> Caret
15afbcd0
RD
6869
6870 Returns the caret associated with the window.
6871 """
54f9ee45 6872 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
6873
6874 def GetCharHeight(*args, **kwargs):
15afbcd0 6875 """
a95a7133 6876 GetCharHeight(self) -> int
15afbcd0
RD
6877
6878 Get the (average) character size for the current font.
6879 """
54f9ee45 6880 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
6881
6882 def GetCharWidth(*args, **kwargs):
15afbcd0 6883 """
a95a7133 6884 GetCharWidth(self) -> int
15afbcd0
RD
6885
6886 Get the (average) character size for the current font.
6887 """
54f9ee45 6888 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
6889
6890 def GetTextExtent(*args, **kwargs):
41e2b43e 6891 """GetTextExtent(String string) -> (width, height)"""
54f9ee45 6892 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
6893
6894 def GetFullTextExtent(*args, **kwargs):
0df68c9f 6895 """
196addbf 6896 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 6897 (width, height, descent, externalLeading)
e811c8ce 6898
15afbcd0
RD
6899 Get the width, height, decent and leading of the text using the
6900 current or specified font.
0df68c9f 6901 """
54f9ee45 6902 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
6903
6904 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
6905 """
6906 ClientToScreenXY(int x, int y) -> (x,y)
6907
6908 Converts to screen coordinates from coordinates relative to this window.
6909 """
54f9ee45 6910 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
6911
6912 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
6913 """
6914 ScreenToClientXY(int x, int y) -> (x,y)
6915
6916 Converts from screen to client window coordinates.
6917 """
54f9ee45 6918 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
6919
6920 def ClientToScreen(*args, **kwargs):
15afbcd0 6921 """
a95a7133 6922 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
6923
6924 Converts to screen coordinates from coordinates relative to this window.
6925 """
54f9ee45 6926 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
6927
6928 def ScreenToClient(*args, **kwargs):
15afbcd0 6929 """
a95a7133 6930 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
6931
6932 Converts from screen to client window coordinates.
6933 """
54f9ee45 6934 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
6935
6936 def HitTestXY(*args, **kwargs):
15afbcd0 6937 """
a95a7133 6938 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
6939
6940 Test where the given (in client coords) point lies
6941 """
54f9ee45 6942 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
6943
6944 def HitTest(*args, **kwargs):
15afbcd0 6945 """
a95a7133 6946 HitTest(self, Point pt) -> int
15afbcd0
RD
6947
6948 Test where the given (in client coords) point lies
6949 """
54f9ee45 6950 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 6951
15afbcd0
RD
6952 def GetBorder(*args):
6953 """
a95a7133
RD
6954 GetBorder(self, long flags) -> int
6955 GetBorder(self) -> int
e811c8ce 6956
15afbcd0
RD
6957 Get border for the flags of this window
6958 """
54f9ee45 6959 return _core_.Window_GetBorder(*args)
e811c8ce
RD
6960
6961 def UpdateWindowUI(*args, **kwargs):
15afbcd0 6962 """
a95a7133 6963 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
6964
6965 This function sends EVT_UPDATE_UI events to the window. The particular
6966 implementation depends on the window; for example a wx.ToolBar will
6967 send an update UI event for each toolbar button, and a wx.Frame will
6968 send an update UI event for each menubar menu item. You can call this
6969 function from your application to ensure that your UI is up-to-date at
6970 a particular point in time (as far as your EVT_UPDATE_UI handlers are
6971 concerned). This may be necessary if you have called
6972 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
6973 limit the overhead that wxWindows incurs by sending update UI events
6974 in idle time.
15afbcd0 6975 """
54f9ee45 6976 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
6977
6978 def PopupMenuXY(*args, **kwargs):
15afbcd0 6979 """
b0503257 6980 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 6981
b0503257
RD
6982 Pops up the given menu at the specified coordinates, relative to this window,
6983 and returns control when the user has dismissed the menu. If a menu item is
6984 selected, the corresponding menu event is generated and will be processed as
6985 usual. If the default position is given then the current position of the
6986 mouse cursor will be used.
15afbcd0 6987 """
54f9ee45 6988 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 6989
15afbcd0
RD
6990 def PopupMenu(*args, **kwargs):
6991 """
b0503257 6992 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 6993
b0503257
RD
6994 Pops up the given menu at the specified coordinates, relative to this window,
6995 and returns control when the user has dismissed the menu. If a menu item is
6996 selected, the corresponding menu event is generated and will be processed as
6997 usual. If the default position is given then the current position of the
6998 mouse cursor will be used.
15afbcd0 6999 """
54f9ee45 7000 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
7001
7002 def GetHandle(*args, **kwargs):
7003 """
a95a7133 7004 GetHandle(self) -> long
15afbcd0
RD
7005
7006 Returns the platform-specific handle (as a long integer) of the
7007 physical window. Currently on wxMac it returns the handle of the
7008 toplevel parent of the window.
7009 """
54f9ee45 7010 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0
RD
7011
7012 def HasScrollbar(*args, **kwargs):
7013 """
a95a7133 7014 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
7015
7016 Does the window have the scrollbar for this orientation?
7017 """
54f9ee45 7018 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
7019
7020 def SetScrollbar(*args, **kwargs):
7021 """
41e2b43e 7022 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
7023 bool refresh=True)
7024
7025 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 7026 """
54f9ee45 7027 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
7028
7029 def SetScrollPos(*args, **kwargs):
15afbcd0 7030 """
a95a7133 7031 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
7032
7033 Sets the position of one of the built-in scrollbars.
7034 """
54f9ee45 7035 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
7036
7037 def GetScrollPos(*args, **kwargs):
15afbcd0 7038 """
a95a7133 7039 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
7040
7041 Returns the built-in scrollbar position.
7042 """
54f9ee45 7043 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
7044
7045 def GetScrollThumb(*args, **kwargs):
15afbcd0 7046 """
a95a7133 7047 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
7048
7049 Returns the built-in scrollbar thumb size.
7050 """
54f9ee45 7051 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7052
7053 def GetScrollRange(*args, **kwargs):
15afbcd0 7054 """
a95a7133 7055 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7056
7057 Returns the built-in scrollbar range.
7058 """
54f9ee45 7059 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7060
7061 def ScrollWindow(*args, **kwargs):
15afbcd0 7062 """
a95a7133 7063 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7064
7065 Physically scrolls the pixels in the window and move child windows
7066 accordingly. Use this function to optimise your scrolling
7067 implementations, to minimise the area that must be redrawn. Note that
7068 it is rarely required to call this function from a user program.
15afbcd0 7069 """
54f9ee45 7070 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7071
7072 def ScrollLines(*args, **kwargs):
15afbcd0 7073 """
a95a7133 7074 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7075
7076 If the platform and window class supports it, scrolls the window by
7077 the given number of lines down, if lines is positive, or up if lines
7078 is negative. Returns True if the window was scrolled, False if it was
7079 already on top/bottom and nothing was done.
7080 """
54f9ee45 7081 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7082
7083 def ScrollPages(*args, **kwargs):
15afbcd0 7084 """
a95a7133 7085 ScrollPages(self, int pages) -> bool
15afbcd0 7086
41e2b43e 7087 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7088 the given number of pages down, if pages is positive, or up if pages
7089 is negative. Returns True if the window was scrolled, False if it was
7090 already on top/bottom and nothing was done.
7091 """
54f9ee45 7092 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7093
7094 def LineUp(*args, **kwargs):
15afbcd0 7095 """
a95a7133 7096 LineUp(self) -> bool
15afbcd0
RD
7097
7098 This is just a wrapper for ScrollLines(-1).
7099 """
54f9ee45 7100 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7101
7102 def LineDown(*args, **kwargs):
15afbcd0 7103 """
a95a7133 7104 LineDown(self) -> bool
15afbcd0
RD
7105
7106 This is just a wrapper for ScrollLines(1).
7107 """
54f9ee45 7108 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7109
7110 def PageUp(*args, **kwargs):
15afbcd0 7111 """
a95a7133 7112 PageUp(self) -> bool
15afbcd0
RD
7113
7114 This is just a wrapper for ScrollPages(-1).
7115 """
54f9ee45 7116 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7117
7118 def PageDown(*args, **kwargs):
15afbcd0 7119 """
a95a7133 7120 PageDown(self) -> bool
15afbcd0
RD
7121
7122 This is just a wrapper for ScrollPages(1).
7123 """
54f9ee45 7124 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7125
7126 def SetHelpText(*args, **kwargs):
15afbcd0 7127 """
a95a7133 7128 SetHelpText(self, String text)
15afbcd0
RD
7129
7130 Sets the help text to be used as context-sensitive help for this
7131 window. Note that the text is actually stored by the current
7132 wxHelpProvider implementation, and not in the window object itself.
7133 """
54f9ee45 7134 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7135
7136 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7137 """
a95a7133 7138 SetHelpTextForId(self, String text)
15afbcd0
RD
7139
7140 Associate this help text with all windows with the same id as this
7141 one.
7142 """
54f9ee45 7143 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7144
7145 def GetHelpText(*args, **kwargs):
15afbcd0 7146 """
a95a7133 7147 GetHelpText(self) -> String
15afbcd0
RD
7148
7149 Gets the help text to be used as context-sensitive help for this
7150 window. Note that the text is actually stored by the current
7151 wxHelpProvider implementation, and not in the window object itself.
7152 """
54f9ee45 7153 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7154
7155 def SetToolTipString(*args, **kwargs):
15afbcd0 7156 """
a95a7133 7157 SetToolTipString(self, String tip)
15afbcd0
RD
7158
7159 Attach a tooltip to the window.
7160 """
54f9ee45 7161 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7162
7163 def SetToolTip(*args, **kwargs):
15afbcd0 7164 """
a95a7133 7165 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7166
7167 Attach a tooltip to the window.
7168 """
54f9ee45 7169 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7170
7171 def GetToolTip(*args, **kwargs):
15afbcd0 7172 """
a95a7133 7173 GetToolTip(self) -> ToolTip
15afbcd0
RD
7174
7175 get the associated tooltip or None if none
7176 """
54f9ee45 7177 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7178
7179 def SetDropTarget(*args, **kwargs):
15afbcd0 7180 """
a95a7133 7181 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7182
7183 Associates a drop target with this window. If the window already has
7184 a drop target, it is deleted.
7185 """
54f9ee45 7186 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7187
7188 def GetDropTarget(*args, **kwargs):
15afbcd0 7189 """
a95a7133 7190 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7191
7192 Returns the associated drop target, which may be None.
7193 """
54f9ee45 7194 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7195
7196 def SetConstraints(*args, **kwargs):
15afbcd0 7197 """
a95a7133 7198 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7199
7200 Sets the window to have the given layout constraints. If an existing
7201 layout constraints object is already owned by the window, it will be
7202 deleted. Pass None to disassociate and delete the window's current
7203 constraints.
7204
7205 You must call SetAutoLayout to tell a window to use the constraints
7206 automatically in its default EVT_SIZE handler; otherwise, you must
7207 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7208 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7209 effect.
7210 """
54f9ee45 7211 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7212
7213 def GetConstraints(*args, **kwargs):
15afbcd0 7214 """
a95a7133 7215 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7216
7217 Returns a pointer to the window's layout constraints, or None if there
7218 are none.
7219 """
54f9ee45 7220 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7221
7222 def SetAutoLayout(*args, **kwargs):
15afbcd0 7223 """
a95a7133 7224 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7225
7226 Determines whether the Layout function will be called automatically
7227 when the window is resized. It is called implicitly by SetSizer but
7228 if you use SetConstraints you should call it manually or otherwise the
7229 window layout won't be correctly updated when its size changes.
7230 """
54f9ee45 7231 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
7232
7233 def GetAutoLayout(*args, **kwargs):
15afbcd0 7234 """
a95a7133 7235 GetAutoLayout(self) -> bool
15afbcd0
RD
7236
7237 Returns the current autoLayout setting
7238 """
54f9ee45 7239 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
7240
7241 def Layout(*args, **kwargs):
15afbcd0 7242 """
a95a7133 7243 Layout(self) -> bool
15afbcd0
RD
7244
7245 Invokes the constraint-based layout algorithm or the sizer-based
7246 algorithm for this window. See SetAutoLayout: when auto layout is on,
7247 this function gets called automatically by the default EVT_SIZE
7248 handler when the window is resized.
7249 """
54f9ee45 7250 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
7251
7252 def SetSizer(*args, **kwargs):
15afbcd0 7253 """
a95a7133 7254 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7255
7256 Sets the window to have the given layout sizer. The window will then
7257 own the object, and will take care of its deletion. If an existing
7258 layout sizer object is already owned by the window, it will be deleted
7259 if the deleteOld parameter is true. Note that this function will also
7260 call SetAutoLayout implicitly with a True parameter if the sizer is
7261 non-NoneL and False otherwise.
7262 """
54f9ee45 7263 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
7264
7265 def SetSizerAndFit(*args, **kwargs):
15afbcd0 7266 """
a95a7133 7267 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7268
7269 The same as SetSizer, except it also sets the size hints for the
7270 window based on the sizer's minimum size.
7271 """
54f9ee45 7272 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
7273
7274 def GetSizer(*args, **kwargs):
15afbcd0 7275 """
a95a7133 7276 GetSizer(self) -> Sizer
15afbcd0
RD
7277
7278 Return the sizer associated with the window by a previous call to
7279 SetSizer or None if there isn't one.
7280 """
54f9ee45 7281 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
7282
7283 def SetContainingSizer(*args, **kwargs):
15afbcd0 7284 """
a95a7133 7285 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
7286
7287 This normally does not need to be called by application code. It is
7288 called internally when a window is added to a sizer, and is used so
7289 the window can remove itself from the sizer when it is destroyed.
7290 """
54f9ee45 7291 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
7292
7293 def GetContainingSizer(*args, **kwargs):
15afbcd0 7294 """
a95a7133 7295 GetContainingSizer(self) -> Sizer
15afbcd0
RD
7296
7297 Return the sizer that this window is a member of, if any, otherwise None.
7298 """
54f9ee45 7299 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 7300
a95a7133
RD
7301 def InheritAttributes(*args, **kwargs):
7302 """
7303 InheritAttributes(self)
7304
41e2b43e
RD
7305 This function is (or should be, in case of custom controls) called
7306 during window creation to intelligently set up the window visual
7307 attributes, that is the font and the foreground and background
7308 colours.
7309
7310 By 'intelligently' the following is meant: by default, all windows use
7311 their own default attributes. However if some of the parent's
7312 attributes are explicitly changed (that is, using SetFont and not
7313 SetDefaultFont) and if the corresponding attribute hadn't been
7314 explicitly set for this window itself, then this window takes the same
7315 value as used by the parent. In addition, if the window overrides
7316 ShouldInheritColours to return false, the colours will not be changed
7317 no matter what and only the font might.
7318
7319 This rather complicated logic is necessary in order to accomodate the
7320 different usage scenarius. The most common one is when all default
7321 attributes are used and in this case, nothing should be inherited as
7322 in modern GUIs different controls use different fonts (and colours)
7323 than their siblings so they can't inherit the same value from the
7324 parent. However it was also deemed desirable to allow to simply change
7325 the attributes of all children at once by just changing the font or
7326 colour of their common parent, hence in this case we do inherit the
7327 parents attributes.
7328
a95a7133 7329 """
54f9ee45 7330 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
7331
7332 def ShouldInheritColours(*args, **kwargs):
7333 """
7334 ShouldInheritColours(self) -> bool
7335
7336 Return true from here to allow the colours of this window to be
41e2b43e
RD
7337 changed by InheritAttributes, returning false forbids inheriting them
7338 from the parent window.
a95a7133 7339
41e2b43e
RD
7340 The base class version returns false, but this method is overridden in
7341 wxControl where it returns true.
a95a7133 7342 """
54f9ee45 7343 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 7344
e811c8ce 7345 def PostCreate(self, pre):
15afbcd0
RD
7346 """
7347 Phase 3 of the 2-phase create <wink!>
7348 Call this method after precreating the window with the 2-phase create method.
7349 """
e811c8ce
RD
7350 self.this = pre.this
7351 self.thisown = pre.thisown
7352 pre.thisown = 0
7353 if hasattr(self, '_setOORInfo'):
7354 self._setOORInfo(self)
7355 if hasattr(self, '_setCallbackInfo'):
7356 self._setCallbackInfo(self, self.__class__)
7357
7358
7359class WindowPtr(Window):
7360 def __init__(self, this):
7361 self.this = this
7362 if not hasattr(self,"thisown"): self.thisown = 0
7363 self.__class__ = Window
54f9ee45 7364_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
7365
7366def PreWindow(*args, **kwargs):
15afbcd0
RD
7367 """
7368 PreWindow() -> Window
7369
7370 Precreate a Window for 2-phase creation.
7371 """
54f9ee45 7372 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
7373 val.thisown = 1
7374 return val
7375
7376def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
7377 """
7378 Window_NewControlId() -> int
7379
7380 Generate a control id for the controls which were not given one.
7381 """
54f9ee45 7382 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
7383
7384def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
7385 """
7386 Window_NextControlId(int winid) -> int
7387
7388 Get the id of the control following the one with the given
41e2b43e 7389 autogenerated) id
15afbcd0 7390 """
54f9ee45 7391 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
7392
7393def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
7394 """
7395 Window_PrevControlId(int winid) -> int
7396
7397 Get the id of the control preceding the one with the given
41e2b43e 7398 autogenerated) id
15afbcd0 7399 """
54f9ee45 7400 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
7401
7402def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
7403 """
7404 Window_FindFocus() -> Window
7405
7406 Returns the window or control that currently has the keyboard focus,
7407 or None.
7408 """
54f9ee45 7409 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
7410
7411def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
7412 """
7413 Window_GetCapture() -> Window
7414
7415 Returns the window which currently captures the mouse or None
7416 """
54f9ee45 7417 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 7418
74a57fcd
RD
7419def Window_GetClassDefaultAttributes(*args, **kwargs):
7420 """
7421 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7422
41e2b43e
RD
7423 Get the default attributes for this class. This is useful if you want
7424 to use the same font or colour in your own control as in a standard
7425 control -- which is a much better idea than hard coding specific
db3e571a
RD
7426 colours or fonts which might look completely out of place on the
7427 user's system, especially if it uses themes.
74a57fcd
RD
7428
7429 The variant parameter is only relevant under Mac currently and is
41e2b43e 7430 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7431 the returned font. See `wx.Window.SetWindowVariant` for more about
7432 this.
74a57fcd 7433 """
54f9ee45 7434 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 7435
e811c8ce 7436def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
7437 """
7438 Convenience function for converting a Point or (x,y) in
7439 dialog units to pixel units.
7440 """
e811c8ce
RD
7441 if y is None:
7442 return win.ConvertDialogPointToPixels(point_or_x)
7443 else:
fd3f2efe 7444 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
7445
7446def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
7447 """
7448 Convenience function for converting a Size or (w,h) in
7449 dialog units to pixel units.
7450 """
e811c8ce
RD
7451 if height is None:
7452 return win.ConvertDialogSizeToPixels(size_width)
7453 else:
fd3f2efe 7454 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
7455
7456
7457def FindWindowById(*args, **kwargs):
15afbcd0
RD
7458 """
7459 FindWindowById(long id, Window parent=None) -> Window
7460
7461 Find the first window in the application with the given id. If parent
7462 is None, the search will start from all top-level frames and dialog
7463 boxes; if non-None, the search will be limited to the given window
7464 hierarchy. The search is recursive in both cases.
7465 """
54f9ee45 7466 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
7467
7468def FindWindowByName(*args, **kwargs):
15afbcd0
RD
7469 """
7470 FindWindowByName(String name, Window parent=None) -> Window
7471
7472 Find a window by its name (as given in a window constructor or Create
7473 function call). If parent is None, the search will start from all
7474 top-level frames and dialog boxes; if non-None, the search will be
7475 limited to the given window hierarchy. The search is recursive in both
7476 cases.
7477
7478 If no window with such name is found, wx.FindWindowByLabel is called.
7479 """
54f9ee45 7480 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
7481
7482def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
7483 """
7484 FindWindowByLabel(String label, Window parent=None) -> Window
7485
7486 Find a window by its label. Depending on the type of window, the label
7487 may be a window title or panel item label. If parent is None, the
7488 search will start from all top-level frames and dialog boxes; if
7489 non-None, the search will be limited to the given window
7490 hierarchy. The search is recursive in both cases.
7491 """
54f9ee45 7492 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
7493
7494def Window_FromHWND(*args, **kwargs):
4276dc52 7495 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 7496 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
7497#---------------------------------------------------------------------------
7498
7499class Validator(EvtHandler):
e811c8ce
RD
7500 def __repr__(self):
7501 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7502 def __init__(self, *args, **kwargs):
a95a7133 7503 """__init__(self) -> Validator"""
54f9ee45 7504 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
7505 self.this = newobj.this
7506 self.thisown = 1
7507 del newobj.thisown
7508 self._setOORInfo(self)
e811c8ce
RD
7509
7510 def Clone(*args, **kwargs):
a95a7133 7511 """Clone(self) -> Validator"""
54f9ee45 7512 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
7513
7514 def Validate(*args, **kwargs):
a95a7133 7515 """Validate(self, Window parent) -> bool"""
54f9ee45 7516 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
7517
7518 def TransferToWindow(*args, **kwargs):
a95a7133 7519 """TransferToWindow(self) -> bool"""
54f9ee45 7520 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
7521
7522 def TransferFromWindow(*args, **kwargs):
a95a7133 7523 """TransferFromWindow(self) -> bool"""
54f9ee45 7524 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
7525
7526 def GetWindow(*args, **kwargs):
a95a7133 7527 """GetWindow(self) -> Window"""
54f9ee45 7528 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
7529
7530 def SetWindow(*args, **kwargs):
a95a7133 7531 """SetWindow(self, Window window)"""
54f9ee45 7532 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
7533
7534 def IsSilent(*args, **kwargs):
66c033b4 7535 """IsSilent() -> bool"""
54f9ee45 7536 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7537
7538 IsSilent = staticmethod(IsSilent)
7539 def SetBellOnError(*args, **kwargs):
66c033b4 7540 """SetBellOnError(int doIt=True)"""
54f9ee45 7541 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7542
7543 SetBellOnError = staticmethod(SetBellOnError)
7544
7545class ValidatorPtr(Validator):
7546 def __init__(self, this):
7547 self.this = this
7548 if not hasattr(self,"thisown"): self.thisown = 0
7549 self.__class__ = Validator
54f9ee45 7550_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
7551
7552def Validator_IsSilent(*args, **kwargs):
7553 """Validator_IsSilent() -> bool"""
54f9ee45 7554 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7555
7556def Validator_SetBellOnError(*args, **kwargs):
7557 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 7558 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7559
7560class PyValidator(Validator):
e811c8ce
RD
7561 def __repr__(self):
7562 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7563 def __init__(self, *args, **kwargs):
a95a7133 7564 """__init__(self) -> PyValidator"""
54f9ee45 7565 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
7566 self.this = newobj.this
7567 self.thisown = 1
7568 del newobj.thisown
7569
7570 self._setCallbackInfo(self, PyValidator, 1)
7571 self._setOORInfo(self)
7572
7573 def _setCallbackInfo(*args, **kwargs):
a95a7133 7574 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 7575 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7576
7577
7578class PyValidatorPtr(PyValidator):
7579 def __init__(self, this):
7580 self.this = this
7581 if not hasattr(self,"thisown"): self.thisown = 0
7582 self.__class__ = PyValidator
54f9ee45 7583_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
7584
7585#---------------------------------------------------------------------------
7586
7587class Menu(EvtHandler):
d14a1e28
RD
7588 def __repr__(self):
7589 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 7590 def __init__(self, *args, **kwargs):
a95a7133 7591 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 7592 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
7593 self.this = newobj.this
7594 self.thisown = 1
7595 del newobj.thisown
7596 self._setOORInfo(self)
7597
7598 def Append(*args, **kwargs):
a95a7133 7599 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7600 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
7601
7602 def AppendSeparator(*args, **kwargs):
a95a7133 7603 """AppendSeparator(self) -> MenuItem"""
54f9ee45 7604 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
7605
7606 def AppendCheckItem(*args, **kwargs):
a95a7133 7607 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7608 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
7609
7610 def AppendRadioItem(*args, **kwargs):
a95a7133 7611 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7612 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
7613
7614 def AppendMenu(*args, **kwargs):
a95a7133 7615 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7616 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
7617
7618 def AppendItem(*args, **kwargs):
a95a7133 7619 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7620 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
7621
7622 def Break(*args, **kwargs):
a95a7133 7623 """Break(self)"""
54f9ee45 7624 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
7625
7626 def InsertItem(*args, **kwargs):
a95a7133 7627 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 7628 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
7629
7630 def Insert(*args, **kwargs):
0df68c9f 7631 """
a95a7133 7632 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 7633 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 7634 """
54f9ee45 7635 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
7636
7637 def InsertSeparator(*args, **kwargs):
a95a7133 7638 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 7639 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
7640
7641 def InsertCheckItem(*args, **kwargs):
a95a7133 7642 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7643 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
7644
7645 def InsertRadioItem(*args, **kwargs):
a95a7133 7646 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7647 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
7648
7649 def InsertMenu(*args, **kwargs):
a95a7133 7650 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7651 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
7652
7653 def PrependItem(*args, **kwargs):
a95a7133 7654 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7655 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
7656
7657 def Prepend(*args, **kwargs):
a95a7133 7658 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7659 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
7660
7661 def PrependSeparator(*args, **kwargs):
a95a7133 7662 """PrependSeparator(self) -> MenuItem"""
54f9ee45 7663 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
7664
7665 def PrependCheckItem(*args, **kwargs):
a95a7133 7666 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7667 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
7668
7669 def PrependRadioItem(*args, **kwargs):
a95a7133 7670 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7671 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
7672
7673 def PrependMenu(*args, **kwargs):
a95a7133 7674 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7675 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
7676
7677 def Remove(*args, **kwargs):
a95a7133 7678 """Remove(self, int id) -> MenuItem"""
54f9ee45 7679 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
7680
7681 def RemoveItem(*args, **kwargs):
a95a7133 7682 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7683 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
7684
7685 def Delete(*args, **kwargs):
a95a7133 7686 """Delete(self, int id) -> bool"""
54f9ee45 7687 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
7688
7689 def DeleteItem(*args, **kwargs):
a95a7133 7690 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 7691 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
7692
7693 def Destroy(*args, **kwargs):
0df68c9f 7694 """
a95a7133 7695 Destroy(self)
e811c8ce 7696
0df68c9f
RD
7697 Deletes the C++ object this Python object is a proxy for.
7698 """
54f9ee45 7699 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
7700
7701 def DestroyId(*args, **kwargs):
0df68c9f 7702 """
a95a7133 7703 DestroyId(self, int id) -> bool
e811c8ce 7704
0df68c9f
RD
7705 Deletes the C++ object this Python object is a proxy for.
7706 """
54f9ee45 7707 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
7708
7709 def DestroyItem(*args, **kwargs):
0df68c9f 7710 """
a95a7133 7711 DestroyItem(self, MenuItem item) -> bool
e811c8ce 7712
0df68c9f
RD
7713 Deletes the C++ object this Python object is a proxy for.
7714 """
54f9ee45 7715 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
7716
7717 def GetMenuItemCount(*args, **kwargs):
a95a7133 7718 """GetMenuItemCount(self) -> size_t"""
54f9ee45 7719 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
7720
7721 def GetMenuItems(*args, **kwargs):
a95a7133 7722 """GetMenuItems(self) -> PyObject"""
54f9ee45 7723 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
7724
7725 def FindItem(*args, **kwargs):
a95a7133 7726 """FindItem(self, String item) -> int"""
54f9ee45 7727 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
7728
7729 def FindItemById(*args, **kwargs):
a95a7133 7730 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7731 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
7732
7733 def FindItemByPosition(*args, **kwargs):
a95a7133 7734 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 7735 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
7736
7737 def Enable(*args, **kwargs):
a95a7133 7738 """Enable(self, int id, bool enable)"""
54f9ee45 7739 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
7740
7741 def IsEnabled(*args, **kwargs):
a95a7133 7742 """IsEnabled(self, int id) -> bool"""
54f9ee45 7743 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
7744
7745 def Check(*args, **kwargs):
a95a7133 7746 """Check(self, int id, bool check)"""
54f9ee45 7747 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
7748
7749 def IsChecked(*args, **kwargs):
a95a7133 7750 """IsChecked(self, int id) -> bool"""
54f9ee45 7751 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
7752
7753 def SetLabel(*args, **kwargs):
a95a7133 7754 """SetLabel(self, int id, String label)"""
54f9ee45 7755 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
7756
7757 def GetLabel(*args, **kwargs):
a95a7133 7758 """GetLabel(self, int id) -> String"""
54f9ee45 7759 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
7760
7761 def SetHelpString(*args, **kwargs):
a95a7133 7762 """SetHelpString(self, int id, String helpString)"""
54f9ee45 7763 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
7764
7765 def GetHelpString(*args, **kwargs):
a95a7133 7766 """GetHelpString(self, int id) -> String"""
54f9ee45 7767 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
7768
7769 def SetTitle(*args, **kwargs):
a95a7133 7770 """SetTitle(self, String title)"""
54f9ee45 7771 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
7772
7773 def GetTitle(*args, **kwargs):
a95a7133 7774 """GetTitle(self) -> String"""
54f9ee45 7775 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
7776
7777 def SetEventHandler(*args, **kwargs):
a95a7133 7778 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 7779 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
7780
7781 def GetEventHandler(*args, **kwargs):
a95a7133 7782 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 7783 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
7784
7785 def SetInvokingWindow(*args, **kwargs):
a95a7133 7786 """SetInvokingWindow(self, Window win)"""
54f9ee45 7787 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7788
7789 def GetInvokingWindow(*args, **kwargs):
a95a7133 7790 """GetInvokingWindow(self) -> Window"""
54f9ee45 7791 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7792
7793 def GetStyle(*args, **kwargs):
a95a7133 7794 """GetStyle(self) -> long"""
54f9ee45 7795 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
7796
7797 def UpdateUI(*args, **kwargs):
a95a7133 7798 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 7799 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
7800
7801 def GetMenuBar(*args, **kwargs):
a95a7133 7802 """GetMenuBar(self) -> MenuBar"""
54f9ee45 7803 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
7804
7805 def Attach(*args, **kwargs):
a95a7133 7806 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 7807 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
7808
7809 def Detach(*args, **kwargs):
a95a7133 7810 """Detach(self)"""
54f9ee45 7811 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
7812
7813 def IsAttached(*args, **kwargs):
a95a7133 7814 """IsAttached(self) -> bool"""
54f9ee45 7815 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
7816
7817 def SetParent(*args, **kwargs):
a95a7133 7818 """SetParent(self, Menu parent)"""
54f9ee45 7819 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
7820
7821 def GetParent(*args, **kwargs):
a95a7133 7822 """GetParent(self) -> Menu"""
54f9ee45 7823 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 7824
d14a1e28
RD
7825
7826class MenuPtr(Menu):
7827 def __init__(self, this):
7828 self.this = this
7829 if not hasattr(self,"thisown"): self.thisown = 0
7830 self.__class__ = Menu
54f9ee45 7831_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
7832DefaultValidator = cvar.DefaultValidator
7833
7834#---------------------------------------------------------------------------
7835
7836class MenuBar(Window):
e811c8ce
RD
7837 def __repr__(self):
7838 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 7839 def __init__(self, *args, **kwargs):
a95a7133 7840 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 7841 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
7842 self.this = newobj.this
7843 self.thisown = 1
7844 del newobj.thisown
7845 self._setOORInfo(self)
e811c8ce
RD
7846
7847 def Append(*args, **kwargs):
a95a7133 7848 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 7849 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
7850
7851 def Insert(*args, **kwargs):
a95a7133 7852 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 7853 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
7854
7855 def GetMenuCount(*args, **kwargs):
a95a7133 7856 """GetMenuCount(self) -> size_t"""
54f9ee45 7857 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
7858
7859 def GetMenu(*args, **kwargs):
a95a7133 7860 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 7861 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
7862
7863 def Replace(*args, **kwargs):
a95a7133 7864 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 7865 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
7866
7867 def Remove(*args, **kwargs):
a95a7133 7868 """Remove(self, size_t pos) -> Menu"""
54f9ee45 7869 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
7870
7871 def EnableTop(*args, **kwargs):
a95a7133 7872 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 7873 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
7874
7875 def IsEnabledTop(*args, **kwargs):
a95a7133 7876 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 7877 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
7878
7879 def SetLabelTop(*args, **kwargs):
a95a7133 7880 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 7881 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
7882
7883 def GetLabelTop(*args, **kwargs):
a95a7133 7884 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 7885 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
7886
7887 def FindMenuItem(*args, **kwargs):
a95a7133 7888 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 7889 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
7890
7891 def FindItemById(*args, **kwargs):
a95a7133 7892 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7893 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
7894
7895 def FindMenu(*args, **kwargs):
a95a7133 7896 """FindMenu(self, String title) -> int"""
54f9ee45 7897 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
7898
7899 def Enable(*args, **kwargs):
a95a7133 7900 """Enable(self, int id, bool enable)"""
54f9ee45 7901 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
7902
7903 def Check(*args, **kwargs):
a95a7133 7904 """Check(self, int id, bool check)"""
54f9ee45 7905 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
7906
7907 def IsChecked(*args, **kwargs):
a95a7133 7908 """IsChecked(self, int id) -> bool"""
54f9ee45 7909 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
7910
7911 def IsEnabled(*args, **kwargs):
a95a7133 7912 """IsEnabled(self, int id) -> bool"""
54f9ee45 7913 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
7914
7915 def SetLabel(*args, **kwargs):
a95a7133 7916 """SetLabel(self, int id, String label)"""
54f9ee45 7917 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
7918
7919 def GetLabel(*args, **kwargs):
a95a7133 7920 """GetLabel(self, int id) -> String"""
54f9ee45 7921 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
7922
7923 def SetHelpString(*args, **kwargs):
a95a7133 7924 """SetHelpString(self, int id, String helpString)"""
54f9ee45 7925 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
7926
7927 def GetHelpString(*args, **kwargs):
a95a7133 7928 """GetHelpString(self, int id) -> String"""
54f9ee45 7929 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
7930
7931 def GetFrame(*args, **kwargs):
a95a7133 7932 """GetFrame(self) -> wxFrame"""
54f9ee45 7933 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
7934
7935 def IsAttached(*args, **kwargs):
a95a7133 7936 """IsAttached(self) -> bool"""
54f9ee45 7937 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
7938
7939 def Attach(*args, **kwargs):
a95a7133 7940 """Attach(self, wxFrame frame)"""
54f9ee45 7941 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
7942
7943 def Detach(*args, **kwargs):
a95a7133 7944 """Detach(self)"""
54f9ee45 7945 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 7946
d14a1e28
RD
7947
7948class MenuBarPtr(MenuBar):
7949 def __init__(self, this):
7950 self.this = this
7951 if not hasattr(self,"thisown"): self.thisown = 0
7952 self.__class__ = MenuBar
54f9ee45 7953_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
7954
7955#---------------------------------------------------------------------------
7956
7957class MenuItem(Object):
e811c8ce
RD
7958 def __repr__(self):
7959 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 7960 def __init__(self, *args, **kwargs):
0df68c9f 7961 """
a95a7133 7962 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
7963 String help=EmptyString, int kind=ITEM_NORMAL,
7964 Menu subMenu=None) -> MenuItem
0df68c9f 7965 """
54f9ee45 7966 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
7967 self.this = newobj.this
7968 self.thisown = 1
7969 del newobj.thisown
e811c8ce 7970 def GetMenu(*args, **kwargs):
a95a7133 7971 """GetMenu(self) -> Menu"""
54f9ee45 7972 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
7973
7974 def SetMenu(*args, **kwargs):
a95a7133 7975 """SetMenu(self, Menu menu)"""
54f9ee45 7976 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
7977
7978 def SetId(*args, **kwargs):
a95a7133 7979 """SetId(self, int id)"""
54f9ee45 7980 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
7981
7982 def GetId(*args, **kwargs):
a95a7133 7983 """GetId(self) -> int"""
54f9ee45 7984 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
7985
7986 def IsSeparator(*args, **kwargs):
a95a7133 7987 """IsSeparator(self) -> bool"""
54f9ee45 7988 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
7989
7990 def SetText(*args, **kwargs):
a95a7133 7991 """SetText(self, String str)"""
54f9ee45 7992 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
7993
7994 def GetLabel(*args, **kwargs):
a95a7133 7995 """GetLabel(self) -> String"""
54f9ee45 7996 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
7997
7998 def GetText(*args, **kwargs):
a95a7133 7999 """GetText(self) -> String"""
54f9ee45 8000 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
8001
8002 def GetLabelFromText(*args, **kwargs):
66c033b4 8003 """GetLabelFromText(String text) -> String"""
54f9ee45 8004 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
8005
8006 GetLabelFromText = staticmethod(GetLabelFromText)
8007 def GetKind(*args, **kwargs):
a95a7133 8008 """GetKind(self) -> int"""
54f9ee45 8009 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 8010
a95a7133
RD
8011 def SetKind(*args, **kwargs):
8012 """SetKind(self, int kind)"""
54f9ee45 8013 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 8014
e811c8ce 8015 def SetCheckable(*args, **kwargs):
a95a7133 8016 """SetCheckable(self, bool checkable)"""
54f9ee45 8017 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
8018
8019 def IsCheckable(*args, **kwargs):
a95a7133 8020 """IsCheckable(self) -> bool"""
54f9ee45 8021 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
8022
8023 def IsSubMenu(*args, **kwargs):
a95a7133 8024 """IsSubMenu(self) -> bool"""
54f9ee45 8025 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
8026
8027 def SetSubMenu(*args, **kwargs):
a95a7133 8028 """SetSubMenu(self, Menu menu)"""
54f9ee45 8029 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
8030
8031 def GetSubMenu(*args, **kwargs):
a95a7133 8032 """GetSubMenu(self) -> Menu"""
54f9ee45 8033 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
8034
8035 def Enable(*args, **kwargs):
a95a7133 8036 """Enable(self, bool enable=True)"""
54f9ee45 8037 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
8038
8039 def IsEnabled(*args, **kwargs):
a95a7133 8040 """IsEnabled(self) -> bool"""
54f9ee45 8041 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
8042
8043 def Check(*args, **kwargs):
a95a7133 8044 """Check(self, bool check=True)"""
54f9ee45 8045 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
8046
8047 def IsChecked(*args, **kwargs):
a95a7133 8048 """IsChecked(self) -> bool"""
54f9ee45 8049 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
8050
8051 def Toggle(*args, **kwargs):
a95a7133 8052 """Toggle(self)"""
54f9ee45 8053 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8054
8055 def SetHelp(*args, **kwargs):
a95a7133 8056 """SetHelp(self, String str)"""
54f9ee45 8057 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8058
8059 def GetHelp(*args, **kwargs):
a95a7133 8060 """GetHelp(self) -> String"""
54f9ee45 8061 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8062
8063 def GetAccel(*args, **kwargs):
a95a7133 8064 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8065 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8066
8067 def SetAccel(*args, **kwargs):
a95a7133 8068 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8069 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce
RD
8070
8071 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8072 """GetDefaultMarginWidth() -> int"""
54f9ee45 8073 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8074
8075 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8076 def SetBitmap(*args, **kwargs):
a95a7133 8077 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8078 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8079
8080 def GetBitmap(*args, **kwargs):
a95a7133 8081 """GetBitmap(self) -> Bitmap"""
54f9ee45 8082 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8083
d14a1e28
RD
8084
8085class MenuItemPtr(MenuItem):
8086 def __init__(self, this):
8087 self.this = this
8088 if not hasattr(self,"thisown"): self.thisown = 0
8089 self.__class__ = MenuItem
54f9ee45 8090_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8091
e811c8ce 8092def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8093 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8094 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8095
e811c8ce
RD
8096def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8097 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8098 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8099
8100#---------------------------------------------------------------------------
8101
8102class Control(Window):
15afbcd0
RD
8103 """
8104 This is the base class for a control or 'widget'.
8105
41e2b43e
RD
8106 A control is generally a small window which processes user input
8107 and/or displays one or more item of data.
15afbcd0 8108 """
e811c8ce
RD
8109 def __repr__(self):
8110 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8111 def __init__(self, *args, **kwargs):
0df68c9f 8112 """
248ed943
RD
8113 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8114 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8115 String name=ControlNameStr) -> Control
15afbcd0 8116
41e2b43e
RD
8117 Create a Control. Normally you should only call this from a subclass'
8118 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8119 """
54f9ee45 8120 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8121 self.this = newobj.this
8122 self.thisown = 1
8123 del newobj.thisown
8124 self._setOORInfo(self)
e811c8ce
RD
8125
8126 def Create(*args, **kwargs):
0df68c9f 8127 """
248ed943
RD
8128 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8129 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8130 String name=ControlNameStr) -> bool
15afbcd0
RD
8131
8132 Do the 2nd phase and create the GUI control.
0df68c9f 8133 """
54f9ee45 8134 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8135
8136 def Command(*args, **kwargs):
15afbcd0 8137 """
a95a7133 8138 Command(self, CommandEvent event)
15afbcd0 8139
41e2b43e
RD
8140 Simulates the effect of the user issuing a command to the item.
8141
8142 :see: `wx.CommandEvent`
8143
15afbcd0 8144 """
54f9ee45 8145 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8146
8147 def GetLabel(*args, **kwargs):
15afbcd0 8148 """
a95a7133 8149 GetLabel(self) -> String
15afbcd0
RD
8150
8151 Return a control's text.
8152 """
54f9ee45 8153 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8154
8155 def SetLabel(*args, **kwargs):
15afbcd0 8156 """
a95a7133 8157 SetLabel(self, String label)
15afbcd0
RD
8158
8159 Sets the item's text.
8160 """
54f9ee45 8161 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8162
74a57fcd
RD
8163 def GetClassDefaultAttributes(*args, **kwargs):
8164 """
66c033b4 8165 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 8166
41e2b43e
RD
8167 Get the default attributes for this class. This is useful if you want
8168 to use the same font or colour in your own control as in a standard
8169 control -- which is a much better idea than hard coding specific
db3e571a
RD
8170 colours or fonts which might look completely out of place on the
8171 user's system, especially if it uses themes.
74a57fcd
RD
8172
8173 The variant parameter is only relevant under Mac currently and is
41e2b43e 8174 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8175 the returned font. See `wx.Window.SetWindowVariant` for more about
8176 this.
74a57fcd 8177 """
54f9ee45 8178 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
8179
8180 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
8181
8182class ControlPtr(Control):
8183 def __init__(self, this):
8184 self.this = this
8185 if not hasattr(self,"thisown"): self.thisown = 0
8186 self.__class__ = Control
54f9ee45 8187_core_.Control_swigregister(ControlPtr)
b2dc1044 8188ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
8189
8190def PreControl(*args, **kwargs):
15afbcd0
RD
8191 """
8192 PreControl() -> Control
8193
8194 Precreate a Control control for 2-phase creation
8195 """
54f9ee45 8196 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
8197 val.thisown = 1
8198 return val
8199
74a57fcd
RD
8200def Control_GetClassDefaultAttributes(*args, **kwargs):
8201 """
8202 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8203
41e2b43e
RD
8204 Get the default attributes for this class. This is useful if you want
8205 to use the same font or colour in your own control as in a standard
8206 control -- which is a much better idea than hard coding specific
db3e571a
RD
8207 colours or fonts which might look completely out of place on the
8208 user's system, especially if it uses themes.
74a57fcd
RD
8209
8210 The variant parameter is only relevant under Mac currently and is
41e2b43e 8211 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
8212 the returned font. See `wx.Window.SetWindowVariant` for more about
8213 this.
74a57fcd 8214 """
54f9ee45 8215 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8216
d14a1e28
RD
8217#---------------------------------------------------------------------------
8218
8219class ItemContainer(object):
15afbcd0
RD
8220 """
8221 wx.ItemContainer defines an interface which is implemented by all
41e2b43e
RD
8222 controls which have string subitems, each of which may be selected,
8223 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8224 `wx.ComboBox` which implements an extended interface deriving from
8225 this one.
15afbcd0 8226
41e2b43e
RD
8227 It defines the methods for accessing the control's items and although
8228 each of the derived classes implements them differently, they still
8229 all conform to the same interface.
15afbcd0 8230
41e2b43e
RD
8231 The items in a wx.ItemContainer have (non empty) string labels and,
8232 optionally, client data associated with them.
15afbcd0
RD
8233
8234 """
d14a1e28
RD
8235 def __init__(self): raise RuntimeError, "No constructor defined"
8236 def __repr__(self):
8237 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8238 def Append(*args, **kwargs):
15afbcd0 8239 """
a95a7133 8240 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 8241
41e2b43e
RD
8242 Adds the item to the control, associating the given data with the item
8243 if not None. The return value is the index of the newly added item
8244 which may be different from the last one if the control is sorted (e.g.
8245 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 8246 """
54f9ee45 8247 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
8248
8249 def AppendItems(*args, **kwargs):
15afbcd0 8250 """
a95a7133 8251 AppendItems(self, wxArrayString strings)
15afbcd0 8252
41e2b43e
RD
8253 Apend several items at once to the control. Notice that calling this
8254 method may be much faster than appending the items one by one if you
8255 need to add a lot of items.
15afbcd0 8256 """
54f9ee45 8257 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
8258
8259 def Insert(*args, **kwargs):
15afbcd0 8260 """
a95a7133 8261 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 8262
41e2b43e 8263 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
8264 optionally associating some data object with the item.
8265 """
54f9ee45 8266 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
8267
8268 def Clear(*args, **kwargs):
15afbcd0 8269 """
a95a7133 8270 Clear(self)
15afbcd0
RD
8271
8272 Removes all items from the control.
8273 """
54f9ee45 8274 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
8275
8276 def Delete(*args, **kwargs):
15afbcd0 8277 """
a95a7133 8278 Delete(self, int n)
15afbcd0 8279
41e2b43e
RD
8280 Deletes the item at the zero-based index 'n' from the control. Note
8281 that it is an error (signalled by a `wx.PyAssertionError` exception if
8282 enabled) to remove an item with the index negative or greater or equal
8283 than the number of items in the control.
15afbcd0 8284 """
54f9ee45 8285 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce
RD
8286
8287 def GetCount(*args, **kwargs):
15afbcd0 8288 """
a95a7133 8289 GetCount(self) -> int
15afbcd0
RD
8290
8291 Returns the number of items in the control.
8292 """
54f9ee45 8293 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
8294
8295 def IsEmpty(*args, **kwargs):
15afbcd0 8296 """
a95a7133 8297 IsEmpty(self) -> bool
15afbcd0
RD
8298
8299 Returns True if the control is empty or False if it has some items.
8300 """
54f9ee45 8301 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
8302
8303 def GetString(*args, **kwargs):
15afbcd0 8304 """
a95a7133 8305 GetString(self, int n) -> String
15afbcd0
RD
8306
8307 Returns the label of the item with the given index.
8308 """
54f9ee45 8309 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
8310
8311 def GetStrings(*args, **kwargs):
a95a7133 8312 """GetStrings(self) -> wxArrayString"""
54f9ee45 8313 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
8314
8315 def SetString(*args, **kwargs):
15afbcd0 8316 """
a95a7133 8317 SetString(self, int n, String s)
15afbcd0
RD
8318
8319 Sets the label for the given item.
8320 """
54f9ee45 8321 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
8322
8323 def FindString(*args, **kwargs):
15afbcd0 8324 """
a95a7133 8325 FindString(self, String s) -> int
15afbcd0
RD
8326
8327 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
8328 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8329 found.
15afbcd0 8330 """
54f9ee45 8331 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce
RD
8332
8333 def Select(*args, **kwargs):
15afbcd0 8334 """
a95a7133 8335 Select(self, int n)
15afbcd0
RD
8336
8337 Sets the item at index 'n' to be the selected item.
8338 """
54f9ee45 8339 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 8340
15afbcd0 8341 SetSelection = Select
e811c8ce 8342 def GetSelection(*args, **kwargs):
15afbcd0 8343 """
a95a7133 8344 GetSelection(self) -> int
15afbcd0 8345
41e2b43e
RD
8346 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8347 is selected.
15afbcd0 8348 """
54f9ee45 8349 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce
RD
8350
8351 def GetStringSelection(*args, **kwargs):
15afbcd0 8352 """
a95a7133 8353 GetStringSelection(self) -> String
15afbcd0 8354
41e2b43e
RD
8355 Returns the label of the selected item or an empty string if no item
8356 is selected.
15afbcd0 8357 """
54f9ee45 8358 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce
RD
8359
8360 def GetClientData(*args, **kwargs):
15afbcd0 8361 """
a95a7133 8362 GetClientData(self, int n) -> PyObject
15afbcd0
RD
8363
8364 Returns the client data associated with the given item, (if any.)
8365 """
54f9ee45 8366 return _core_.ItemContainer_GetClientData(*args, **kwargs)
e811c8ce
RD
8367
8368 def SetClientData(*args, **kwargs):
15afbcd0 8369 """
a95a7133 8370 SetClientData(self, int n, PyObject clientData)
15afbcd0
RD
8371
8372 Associate the given client data with the item at position n.
8373 """
54f9ee45 8374 return _core_.ItemContainer_SetClientData(*args, **kwargs)
e811c8ce 8375
d14a1e28
RD
8376
8377class ItemContainerPtr(ItemContainer):
8378 def __init__(self, this):
8379 self.this = this
8380 if not hasattr(self,"thisown"): self.thisown = 0
8381 self.__class__ = ItemContainer
54f9ee45 8382_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
8383
8384#---------------------------------------------------------------------------
8385
8386class ControlWithItems(Control,ItemContainer):
15afbcd0 8387 """
41e2b43e
RD
8388 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8389 wx.Control class, and is used for the base class of various controls
8390 that have items.
15afbcd0 8391 """
d14a1e28
RD
8392 def __init__(self): raise RuntimeError, "No constructor defined"
8393 def __repr__(self):
8394 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8395
8396class ControlWithItemsPtr(ControlWithItems):
8397 def __init__(self, this):
8398 self.this = this
8399 if not hasattr(self,"thisown"): self.thisown = 0
8400 self.__class__ = ControlWithItems
54f9ee45 8401_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
8402
8403#---------------------------------------------------------------------------
8404
8405class SizerItem(Object):
248ed943
RD
8406 """
8407 The wx.SizerItem class is used to track the position, size and other
8408 attributes of each item managed by a `wx.Sizer`. In normal usage user
8409 code should never need to deal directly with a wx.SizerItem, but
8410 custom classes derived from `wx.PySizer` will probably need to use the
8411 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8412
8413 :see: `wx.Sizer`, `wx.GBSizerItem`
8414 """
e811c8ce
RD
8415 def __repr__(self):
8416 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8417 def __init__(self, *args, **kwargs):
248ed943
RD
8418 """
8419 __init__(self) -> SizerItem
8420
8421 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8422 size will need to be set before this item can be used in a Sizer.
8423
8424 You will probably never need to create a wx.SizerItem directly as they
8425 are created automatically when the sizer's Add, Insert or Prepend
8426 methods are called.
8427
8428 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8429 """
54f9ee45 8430 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
8431 self.this = newobj.this
8432 self.thisown = 1
8433 del newobj.thisown
e811c8ce 8434 def DeleteWindows(*args, **kwargs):
248ed943
RD
8435 """
8436 DeleteWindows(self)
8437
8438 Destroy the window or the windows in a subsizer, depending on the type
8439 of item.
8440 """
54f9ee45 8441 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
8442
8443 def DetachSizer(*args, **kwargs):
248ed943
RD
8444 """
8445 DetachSizer(self)
8446
8447 Enable deleting the SizerItem without destroying the contained sizer.
8448 """
54f9ee45 8449 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
8450
8451 def GetSize(*args, **kwargs):
248ed943
RD
8452 """
8453 GetSize(self) -> Size
8454
8455 Get the current size of the item, as set in the last Layout.
8456 """
54f9ee45 8457 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
8458
8459 def CalcMin(*args, **kwargs):
248ed943
RD
8460 """
8461 CalcMin(self) -> Size
8462
8463 Calculates the minimum desired size for the item, including any space
8464 needed by borders.
8465 """
54f9ee45 8466 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
8467
8468 def SetDimension(*args, **kwargs):
248ed943
RD
8469 """
8470 SetDimension(self, Point pos, Size size)
8471
8472 Set the position and size of the space allocated for this item by the
8473 sizer, and adjust the position and size of the item (window or
8474 subsizer) to be within that space taking alignment and borders into
8475 account.
8476 """
54f9ee45 8477 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
8478
8479 def GetMinSize(*args, **kwargs):
248ed943
RD
8480 """
8481 GetMinSize(self) -> Size
8482
8483 Get the minimum size needed for the item.
8484 """
54f9ee45 8485 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce
RD
8486
8487 def SetInitSize(*args, **kwargs):
a95a7133 8488 """SetInitSize(self, int x, int y)"""
54f9ee45 8489 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
8490
8491 def SetRatioWH(*args, **kwargs):
248ed943
RD
8492 """
8493 SetRatioWH(self, int width, int height)
8494
8495 Set the ratio item attribute.
8496 """
54f9ee45 8497 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
8498
8499 def SetRatioSize(*args, **kwargs):
248ed943
RD
8500 """
8501 SetRatioSize(self, Size size)
8502
8503 Set the ratio item attribute.
8504 """
54f9ee45 8505 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
8506
8507 def SetRatio(*args, **kwargs):
248ed943
RD
8508 """
8509 SetRatio(self, float ratio)
8510
8511 Set the ratio item attribute.
8512 """
54f9ee45 8513 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
8514
8515 def GetRatio(*args, **kwargs):
248ed943
RD
8516 """
8517 GetRatio(self) -> float
8518
8519 Set the ratio item attribute.
8520 """
54f9ee45 8521 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce
RD
8522
8523 def IsWindow(*args, **kwargs):
248ed943
RD
8524 """
8525 IsWindow(self) -> bool
8526
8527 Is this sizer item a window?
8528 """
54f9ee45 8529 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
8530
8531 def IsSizer(*args, **kwargs):
248ed943
RD
8532 """
8533 IsSizer(self) -> bool
8534
8535 Is this sizer item a subsizer?
8536 """
54f9ee45 8537 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
8538
8539 def IsSpacer(*args, **kwargs):
248ed943
RD
8540 """
8541 IsSpacer(self) -> bool
8542
8543 Is this sizer item a spacer?
8544 """
54f9ee45 8545 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
8546
8547 def SetProportion(*args, **kwargs):
248ed943
RD
8548 """
8549 SetProportion(self, int proportion)
8550
8551 Set the proportion value for this item.
8552 """
54f9ee45 8553 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
8554
8555 def GetProportion(*args, **kwargs):
248ed943
RD
8556 """
8557 GetProportion(self) -> int
8558
8559 Get the proportion value for this item.
8560 """
54f9ee45 8561 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 8562
248ed943
RD
8563 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8564 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 8565 def SetFlag(*args, **kwargs):
248ed943
RD
8566 """
8567 SetFlag(self, int flag)
8568
8569 Set the flag value for this item.
8570 """
54f9ee45 8571 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
8572
8573 def GetFlag(*args, **kwargs):
248ed943
RD
8574 """
8575 GetFlag(self) -> int
8576
8577 Get the flag value for this item.
8578 """
54f9ee45 8579 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
8580
8581 def SetBorder(*args, **kwargs):
248ed943
RD
8582 """
8583 SetBorder(self, int border)
8584
8585 Set the border value for this item.
8586 """
54f9ee45 8587 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
8588
8589 def GetBorder(*args, **kwargs):
248ed943
RD
8590 """
8591 GetBorder(self) -> int
8592
8593 Get the border value for this item.
8594 """
54f9ee45 8595 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
8596
8597 def GetWindow(*args, **kwargs):
248ed943
RD
8598 """
8599 GetWindow(self) -> Window
8600
8601 Get the window (if any) that is managed by this sizer item.
8602 """
54f9ee45 8603 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
8604
8605 def SetWindow(*args, **kwargs):
248ed943
RD
8606 """
8607 SetWindow(self, Window window)
8608
8609 Set the window to be managed by this sizer item.
8610 """
54f9ee45 8611 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
8612
8613 def GetSizer(*args, **kwargs):
248ed943
RD
8614 """
8615 GetSizer(self) -> Sizer
8616
8617 Get the subsizer (if any) that is managed by this sizer item.
8618 """
54f9ee45 8619 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
8620
8621 def SetSizer(*args, **kwargs):
248ed943
RD
8622 """
8623 SetSizer(self, Sizer sizer)
8624
8625 Set the subsizer to be managed by this sizer item.
8626 """
54f9ee45 8627 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
8628
8629 def GetSpacer(*args, **kwargs):
248ed943
RD
8630 """
8631 GetSpacer(self) -> Size
8632
8633 Get the size of the spacer managed by this sizer item.
8634 """
54f9ee45 8635 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
8636
8637 def SetSpacer(*args, **kwargs):
248ed943
RD
8638 """
8639 SetSpacer(self, Size size)
8640
8641 Set the size of the spacer to be managed by this sizer item.
8642 """
54f9ee45 8643 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
8644
8645 def Show(*args, **kwargs):
248ed943
RD
8646 """
8647 Show(self, bool show)
8648
8649 Set the show item attribute, which sizers use to determine if the item
8650 is to be made part of the layout or not. If the item is tracking a
8651 window then it is shown or hidden as needed.
8652 """
54f9ee45 8653 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
8654
8655 def IsShown(*args, **kwargs):
248ed943
RD
8656 """
8657 IsShown(self) -> bool
8658
8659 Is the item to be shown in the layout?
8660 """
54f9ee45 8661 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
8662
8663 def GetPosition(*args, **kwargs):
248ed943
RD
8664 """
8665 GetPosition(self) -> Point
8666
8667 Returns the current position of the item, as set in the last Layout.
8668 """
54f9ee45 8669 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
8670
8671 def GetUserData(*args, **kwargs):
248ed943
RD
8672 """
8673 GetUserData(self) -> PyObject
8674
8675 Returns the userData associated with this sizer item, or None if there
8676 isn't any.
8677 """
54f9ee45 8678 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 8679
d14a1e28
RD
8680
8681class SizerItemPtr(SizerItem):
8682 def __init__(self, this):
8683 self.this = this
8684 if not hasattr(self,"thisown"): self.thisown = 0
8685 self.__class__ = SizerItem
54f9ee45 8686_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 8687
248ed943 8688def SizerItemWindow(*args, **kwargs):
0df68c9f 8689 """
248ed943
RD
8690 SizerItemWindow(Window window, int proportion, int flag, int border,
8691 PyObject userData=None) -> SizerItem
8692
8693 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 8694 """
248ed943 8695 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
8696 val.thisown = 1
8697 return val
8698
248ed943 8699def SizerItemSpacer(*args, **kwargs):
0df68c9f 8700 """
248ed943
RD
8701 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
8702 PyObject userData=None) -> SizerItem
8703
8704 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 8705 """
248ed943 8706 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
8707 val.thisown = 1
8708 return val
8709
8710def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
8711 """
8712 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
8713 PyObject userData=None) -> SizerItem
8714
8715 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 8716 """
54f9ee45 8717 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
8718 val.thisown = 1
8719 return val
8720
8721class Sizer(Object):
248ed943
RD
8722 """
8723 wx.Sizer is the abstract base class used for laying out subwindows in
8724 a window. You cannot use wx.Sizer directly; instead, you will have to
8725 use one of the sizer classes derived from it such as `wx.BoxSizer`,
8726 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
8727 and `wx.GridBagSizer`.
8728
8729 The concept implemented by sizers in wxWidgets is closely related to
8730 layout tools in other GUI toolkits, such as Java's AWT, the GTK
8731 toolkit or the Qt toolkit. It is based upon the idea of the individual
8732 subwindows reporting their minimal required size and their ability to
8733 get stretched if the size of the parent window has changed. This will
8734 most often mean that the programmer does not set the original size of
8735 a dialog in the beginning, rather the dialog will assigned a sizer and
8736 this sizer will be queried about the recommended size. The sizer in
8737 turn will query its children, which can be normal windows or contorls,
8738 empty space or other sizers, so that a hierarchy of sizers can be
8739 constructed. Note that wxSizer does not derive from wxWindow and thus
8740 do not interfere with tab ordering and requires very little resources
8741 compared to a real window on screen.
8742
8743 What makes sizers so well fitted for use in wxWidgets is the fact that
8744 every control reports its own minimal size and the algorithm can
8745 handle differences in font sizes or different window (dialog item)
8746 sizes on different platforms without problems. If for example the
8747 standard font as well as the overall design of Mac widgets requires
8748 more space than on Windows, then the initial size of a dialog using a
8749 sizer will automatically be bigger on Mac than on Windows.
8750 """
e811c8ce
RD
8751 def __init__(self): raise RuntimeError, "No constructor defined"
8752 def __repr__(self):
8753 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8754 def _setOORInfo(*args, **kwargs):
a95a7133 8755 """_setOORInfo(self, PyObject _self)"""
54f9ee45 8756 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
8757
8758 def Add(*args, **kwargs):
0df68c9f 8759 """
248ed943 8760 Add(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8761 PyObject userData=None)
248ed943
RD
8762
8763 Appends a child item to the sizer.
0df68c9f 8764 """
54f9ee45 8765 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
8766
8767 def Insert(*args, **kwargs):
0df68c9f 8768 """
248ed943
RD
8769 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
8770 PyObject userData=None)
8771
8772 Inserts a new item into the list of items managed by this sizer before
8773 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 8774 """
54f9ee45 8775 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
8776
8777 def Prepend(*args, **kwargs):
0df68c9f 8778 """
248ed943 8779 Prepend(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8780 PyObject userData=None)
248ed943
RD
8781
8782 Adds a new item to the begining of the list of sizer items managed by
8783 this sizer. See `Add` for a description of the parameters.
0df68c9f 8784 """
54f9ee45 8785 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
8786
8787 def Remove(*args, **kwargs):
248ed943
RD
8788 """
8789 Remove(self, item) -> bool
8790
8791 Removes an item from the sizer and destroys it. This method does not
8792 cause any layout or resizing to take place, call `Layout` to update
8793 the layout on screen after removing a child from the sizer. The
8794 *item* parameter can be either a window, a sizer, or the zero-based
8795 index of an item to remove. Returns True if the child item was found
8796 and removed.
8797 """
54f9ee45 8798 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 8799
1c0f361b 8800 def Detach(*args, **kwargs):
248ed943
RD
8801 """
8802 Detach(self, item) -> bool
8803
8804 Detaches an item from the sizer without destroying it. This method
8805 does not cause any layout or resizing to take place, call `Layout` to
8806 do so. The *item* parameter can be either a window, a sizer, or the
8807 zero-based index of the item to be detached. Returns True if the child item
8808 was found and detached.
8809 """
1c0f361b
RD
8810 return _core_.Sizer_Detach(*args, **kwargs)
8811
e811c8ce 8812 def _SetItemMinSize(*args, **kwargs):
a95a7133 8813 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 8814 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 8815
248ed943
RD
8816 def SetItemMinSize(self, item, *args):
8817 """
8818 SetItemMinSize(self, item, Size size)
8819
8820 Sets the minimum size that will be allocated for an item in the sizer.
8821 The *item* parameter can be either a window, a sizer, or the
8822 zero-based index of the item. If a window or sizer is given then it
8823 will be searched for recursivly in subsizers if neccessary.
8824 """
8825 if len(args) == 2:
8826 # for backward compatibility accept separate width,height args too
8827 return self._SetItemMinSize(item, args)
8828 else:
8829 return self._SetItemMinSize(item, args[0])
8830
e811c8ce 8831 def AddItem(*args, **kwargs):
248ed943
RD
8832 """
8833 AddItem(self, SizerItem item)
8834
8835 Adds a `wx.SizerItem` to the sizer.
8836 """
54f9ee45 8837 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
8838
8839 def InsertItem(*args, **kwargs):
248ed943
RD
8840 """
8841 InsertItem(self, int index, SizerItem item)
8842
8843 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
8844 """
54f9ee45 8845 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
8846
8847 def PrependItem(*args, **kwargs):
248ed943
RD
8848 """
8849 PrependItem(self, SizerItem item)
8850
8851 Prepends a `wx.SizerItem` to the sizer.
8852 """
54f9ee45 8853 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 8854
248ed943 8855 def AddMany(self, items):
66c033b4
RD
8856 """
8857 AddMany is a convenience method for adding several items
8858 to a sizer at one time. Simply pass it a list of tuples,
8859 where each tuple consists of the parameters that you
8860 would normally pass to the `Add` method.
8861 """
248ed943
RD
8862 for item in items:
8863 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
8864 item = (item, )
8865 self.Add(*item)
d14a1e28 8866
74e96f3d 8867 # for backwards compatibility only, please do not use in new code
66c033b4
RD
8868 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
8869 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
8870 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
8871 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
8872 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
8873 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
8874 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
8875 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
8876 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
8877 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
8878 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
8879 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d14a1e28
RD
8880
8881
e811c8ce 8882 def SetDimension(*args, **kwargs):
248ed943
RD
8883 """
8884 SetDimension(self, int x, int y, int width, int height)
8885
8886 Call this to force the sizer to take the given dimension and thus
8887 force the items owned by the sizer to resize themselves according to
8888 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
8889 methods.
8890 """
54f9ee45 8891 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
8892
8893 def SetMinSize(*args, **kwargs):
248ed943
RD
8894 """
8895 SetMinSize(self, Size size)
8896
8897 Call this to give the sizer a minimal size. Normally, the sizer will
8898 calculate its minimal size based purely on how much space its children
8899 need. After calling this method `GetMinSize` will return either the
8900 minimal size as requested by its children or the minimal size set
8901 here, depending on which is bigger.
8902 """
54f9ee45 8903 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
8904
8905 def GetSize(*args, **kwargs):
248ed943
RD
8906 """
8907 GetSize(self) -> Size
8908
8909 Returns the current size of the space managed by the sizer.
8910 """
54f9ee45 8911 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
8912
8913 def GetPosition(*args, **kwargs):
248ed943
RD
8914 """
8915 GetPosition(self) -> Point
8916
8917 Returns the current position of the sizer's managed space.
8918 """
54f9ee45 8919 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
8920
8921 def GetMinSize(*args, **kwargs):
248ed943
RD
8922 """
8923 GetMinSize(self) -> Size
8924
8925 Returns the minimal size of the sizer. This is either the combined
8926 minimal size of all the children and their borders or the minimal size
8927 set by SetMinSize, depending on which is bigger.
8928 """
54f9ee45 8929 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 8930
d14a1e28 8931 def GetSizeTuple(self):
1c0f361b 8932 return self.GetSize().Get()
d14a1e28 8933 def GetPositionTuple(self):
1c0f361b 8934 return self.GetPosition().Get()
d14a1e28 8935 def GetMinSizeTuple(self):
1c0f361b 8936 return self.GetMinSize().Get()
d14a1e28 8937
e811c8ce 8938 def RecalcSizes(*args, **kwargs):
248ed943
RD
8939 """
8940 RecalcSizes(self)
8941
8942 Using the sizes calculated by `CalcMin` reposition and resize all the
8943 items managed by this sizer. You should not need to call this directly as
8944 it is called by `Layout`.
8945 """
54f9ee45 8946 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
8947
8948 def CalcMin(*args, **kwargs):
248ed943
RD
8949 """
8950 CalcMin(self) -> Size
8951
8952 This method is where the sizer will do the actual calculation of its
8953 children's minimal sizes. You should not need to call this directly as
8954 it is called by `Layout`.
8955 """
54f9ee45 8956 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
8957
8958 def Layout(*args, **kwargs):
248ed943
RD
8959 """
8960 Layout(self)
8961
8962 This method will force the recalculation and layout of the items
8963 controlled by the sizer using the current space allocated to the
8964 sizer. Normally this is called automatically from the owning window's
8965 EVT_SIZE handler, but it is also useful to call it from user code when
8966 one of the items in a sizer change size, or items are added or
8967 removed.
8968 """
54f9ee45 8969 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
8970
8971 def Fit(*args, **kwargs):
248ed943
RD
8972 """
8973 Fit(self, Window window) -> Size
8974
8975 Tell the sizer to resize the *window* to match the sizer's minimal
8976 size. This is commonly done in the constructor of the window itself in
8977 order to set its initial size to match the needs of the children as
8978 determined by the sizer. Returns the new size.
8979
8980 For a top level window this is the total window size, not the client size.
8981 """
54f9ee45 8982 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
8983
8984 def FitInside(*args, **kwargs):
248ed943
RD
8985 """
8986 FitInside(self, Window window)
8987
8988 Tell the sizer to resize the *virtual size* of the *window* to match the
8989 sizer's minimal size. This will not alter the on screen size of the
8990 window, but may cause the addition/removal/alteration of scrollbars
8991 required to view the virtual area in windows which manage it.
8992
8993 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
8994
8995 """
54f9ee45 8996 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
8997
8998 def SetSizeHints(*args, **kwargs):
248ed943
RD
8999 """
9000 SetSizeHints(self, Window window)
9001
9002 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9003 match the sizer's minimal size. This is commonly done in the
9004 constructor of the window itself if the window is resizable (as are
9005 many dialogs under Unix and frames on probably all platforms) in order
9006 to prevent the window from being sized smaller than the minimal size
9007 required by the sizer.
9008 """
54f9ee45 9009 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
9010
9011 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9012 """
9013 SetVirtualSizeHints(self, Window window)
9014
9015 Tell the sizer to set the minimal size of the window virtual area to
9016 match the sizer's minimal size. For windows with managed scrollbars
9017 this will set them appropriately.
9018
9019 :see: `wx.ScrolledWindow.SetScrollbars`
9020
9021 """
54f9ee45 9022 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
9023
9024 def Clear(*args, **kwargs):
248ed943
RD
9025 """
9026 Clear(self, bool deleteWindows=False)
9027
9028 Clear all items from the sizer, optionally destroying the window items
9029 as well.
9030 """
54f9ee45 9031 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
9032
9033 def DeleteWindows(*args, **kwargs):
248ed943
RD
9034 """
9035 DeleteWindows(self)
9036
9037 Destroy all windows managed by the sizer.
9038 """
54f9ee45 9039 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9040
9041 def GetChildren(*args, **kwargs):
248ed943
RD
9042 """
9043 GetChildren(sefl) -> list
9044
9045 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9046 """
54f9ee45 9047 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
9048
9049 def Show(*args, **kwargs):
248ed943
RD
9050 """
9051 Show(self, item, bool show=True)
e811c8ce 9052
248ed943
RD
9053 Shows or hides an item managed by the sizer. To make a sizer item
9054 disappear or reappear, use Show followed by `Layout`. The *item*
9055 parameter can be either a window, a sizer, or the zero-based index of
9056 the item.
9057 """
9058 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9059
9060 def IsShown(*args, **kwargs):
248ed943
RD
9061 """
9062 IsShown(self, item)
9063
9064 Determines if the item is currently shown. sizer. To make a sizer
9065 item disappear or reappear, use Show followed by `Layout`. The *item*
9066 parameter can be either a window, a sizer, or the zero-based index of
9067 the item.
9068 """
54f9ee45 9069 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9070
248ed943
RD
9071 def Hide(self, item):
9072 """
9073 A convenience method for Show(item, False).
9074 """
9075 self.Show(item, False)
9076
e811c8ce 9077 def ShowItems(*args, **kwargs):
248ed943
RD
9078 """
9079 ShowItems(self, bool show)
9080
9081 Recursively call `wx.Window.Show` on all sizer items.
9082 """
54f9ee45 9083 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9084
d14a1e28
RD
9085
9086class SizerPtr(Sizer):
9087 def __init__(self, this):
9088 self.this = this
9089 if not hasattr(self,"thisown"): self.thisown = 0
9090 self.__class__ = Sizer
54f9ee45 9091_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9092
9093class PySizer(Sizer):
248ed943
RD
9094 """
9095 wx.PySizer is a special version of `wx.Sizer` that has been
9096 instrumented to allow the C++ virtual methods to be overloaded in
9097 Python derived classes. You would derive from this class if you are
9098 wanting to implement a custom sizer in Python code. Simply implement
9099 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9100 For example::
9101
9102 class MySizer(wx.PySizer):
9103 def __init__(self):
9104 wx.PySizer.__init__(self)
9105
9106 def CalcMin(self):
9107 for item in self.GetChildren():
9108 # calculate the total minimum width and height needed
9109 # by all items in the sizer according to this sizer's
9110 # layout algorithm.
9111 ...
9112 return wx.Size(width, height)
9113
9114 def RecalcSizes(self):
9115 # find the space allotted to this sizer
9116 pos = self.GetPosition()
9117 size = self.GetSize()
9118 for item in self.GetChildren():
9119 # Recalculate (if necessary) the position and size of
9120 # each item and then call item.SetDimension to do the
9121 # actual positioning and sizing of the items within the
9122 # space alloted to this sizer.
9123 ...
9124 item.SetDimension(itemPos, itemSize)
9125
9126
9127 When `Layout` is called it first calls `CalcMin` followed by
9128 `RecalcSizes` so you can optimize a bit by saving the results of
9129 `CalcMin` and resuing them in `RecalcSizes`.
9130
9131 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9132
9133
9134 """
e811c8ce
RD
9135 def __repr__(self):
9136 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9137 def __init__(self, *args, **kwargs):
248ed943
RD
9138 """
9139 __init__(self) -> PySizer
9140
9141 Creates a wx.PySizer. Must be called from the __init__ in the derived
9142 class.
9143 """
54f9ee45 9144 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
9145 self.this = newobj.this
9146 self.thisown = 1
9147 del newobj.thisown
9148 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
9149
9150 def _setCallbackInfo(*args, **kwargs):
a95a7133 9151 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 9152 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 9153
d14a1e28
RD
9154
9155class PySizerPtr(PySizer):
9156 def __init__(self, this):
9157 self.this = this
9158 if not hasattr(self,"thisown"): self.thisown = 0
9159 self.__class__ = PySizer
54f9ee45 9160_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
9161
9162#---------------------------------------------------------------------------
9163
9164class BoxSizer(Sizer):
248ed943
RD
9165 """
9166 The basic idea behind a box sizer is that windows will most often be
9167 laid out in rather simple basic geometry, typically in a row or a
9168 column or nested hierarchies of either. A wx.BoxSizer will lay out
9169 its items in a simple row or column, depending on the orientation
9170 parameter passed to the constructor.
9171 """
e811c8ce
RD
9172 def __repr__(self):
9173 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9174 def __init__(self, *args, **kwargs):
248ed943
RD
9175 """
9176 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9177
9178 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9179 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9180 sizer.
9181 """
54f9ee45 9182 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
9183 self.this = newobj.this
9184 self.thisown = 1
9185 del newobj.thisown
9186 self._setOORInfo(self)
e811c8ce
RD
9187
9188 def GetOrientation(*args, **kwargs):
248ed943
RD
9189 """
9190 GetOrientation(self) -> int
9191
9192 Returns the current orientation of the sizer.
9193 """
54f9ee45 9194 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
9195
9196 def SetOrientation(*args, **kwargs):
248ed943
RD
9197 """
9198 SetOrientation(self, int orient)
e811c8ce 9199
248ed943
RD
9200 Resets the orientation of the sizer.
9201 """
9202 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 9203
d14a1e28
RD
9204
9205class BoxSizerPtr(BoxSizer):
9206 def __init__(self, this):
9207 self.this = this
9208 if not hasattr(self,"thisown"): self.thisown = 0
9209 self.__class__ = BoxSizer
54f9ee45 9210_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
9211
9212#---------------------------------------------------------------------------
9213
9214class StaticBoxSizer(BoxSizer):
248ed943
RD
9215 """
9216 wx.StaticBoxSizer derives from and functions identically to the
9217 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9218 manages. Note that this static box must be created separately and
9219 passed to the sizer constructor.
9220 """
e811c8ce
RD
9221 def __repr__(self):
9222 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9223 def __init__(self, *args, **kwargs):
248ed943
RD
9224 """
9225 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9226
9227 Constructor. It takes an associated static box and the orientation
9228 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9229 ``wx.HORIZONTAL``.
9230 """
54f9ee45 9231 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
9232 self.this = newobj.this
9233 self.thisown = 1
9234 del newobj.thisown
9235 self._setOORInfo(self)
e811c8ce
RD
9236
9237 def GetStaticBox(*args, **kwargs):
248ed943
RD
9238 """
9239 GetStaticBox(self) -> StaticBox
e811c8ce 9240
248ed943
RD
9241 Returns the static box associated with this sizer.
9242 """
9243 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 9244
d14a1e28
RD
9245
9246class StaticBoxSizerPtr(StaticBoxSizer):
9247 def __init__(self, this):
9248 self.this = this
9249 if not hasattr(self,"thisown"): self.thisown = 0
9250 self.__class__ = StaticBoxSizer
54f9ee45 9251_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
9252
9253#---------------------------------------------------------------------------
9254
9255class GridSizer(Sizer):
248ed943
RD
9256 """
9257 A grid sizer is a sizer which lays out its children in a
9258 two-dimensional table with all cells having the same size. In other
9259 words, the width of each cell within the grid is the width of the
9260 widest item added to the sizer and the height of each grid cell is the
9261 height of the tallest item. An optional vertical and/or horizontal
9262 gap between items can also be specified (in pixels.)
9263
9264 Items are placed in the cells of the grid in the order they are added,
9265 in row-major order. In other words, the first row is filled first,
9266 then the second, and so on until all items have been added. (If
9267 neccessary, additional rows will be added as items are added.) If you
9268 need to have greater control over the cells that items are placed in
9269 then use the `wx.GridBagSizer`.
9270
9271 """
e811c8ce
RD
9272 def __repr__(self):
9273 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9274 def __init__(self, *args, **kwargs):
248ed943
RD
9275 """
9276 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9277
9278 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9279 of columns and rows in the sizer - if either of the parameters is
9280 zero, it will be calculated to from the total number of children in
9281 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9282 define extra space between all children.
9283 """
54f9ee45 9284 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
9285 self.this = newobj.this
9286 self.thisown = 1
9287 del newobj.thisown
9288 self._setOORInfo(self)
e811c8ce 9289
e811c8ce 9290 def SetCols(*args, **kwargs):
248ed943
RD
9291 """
9292 SetCols(self, int cols)
9293
9294 Sets the number of columns in the sizer.
9295 """
54f9ee45 9296 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
9297
9298 def SetRows(*args, **kwargs):
248ed943
RD
9299 """
9300 SetRows(self, int rows)
9301
9302 Sets the number of rows in the sizer.
9303 """
54f9ee45 9304 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
9305
9306 def SetVGap(*args, **kwargs):
248ed943
RD
9307 """
9308 SetVGap(self, int gap)
9309
9310 Sets the vertical gap (in pixels) between the cells in the sizer.
9311 """
54f9ee45 9312 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
9313
9314 def SetHGap(*args, **kwargs):
248ed943
RD
9315 """
9316 SetHGap(self, int gap)
9317
9318 Sets the horizontal gap (in pixels) between cells in the sizer
9319 """
54f9ee45 9320 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
9321
9322 def GetCols(*args, **kwargs):
248ed943
RD
9323 """
9324 GetCols(self) -> int
9325
9326 Returns the number of columns in the sizer.
9327 """
54f9ee45 9328 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
9329
9330 def GetRows(*args, **kwargs):
248ed943
RD
9331 """
9332 GetRows(self) -> int
9333
9334 Returns the number of rows in the sizer.
9335 """
54f9ee45 9336 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
9337
9338 def GetVGap(*args, **kwargs):
248ed943
RD
9339 """
9340 GetVGap(self) -> int
9341
9342 Returns the vertical gap (in pixels) between the cells in the sizer.
9343 """
54f9ee45 9344 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
9345
9346 def GetHGap(*args, **kwargs):
248ed943
RD
9347 """
9348 GetHGap(self) -> int
9349
9350 Returns the horizontal gap (in pixels) between cells in the sizer.
9351 """
54f9ee45 9352 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 9353
d14a1e28
RD
9354
9355class GridSizerPtr(GridSizer):
9356 def __init__(self, this):
9357 self.this = this
9358 if not hasattr(self,"thisown"): self.thisown = 0
9359 self.__class__ = GridSizer
54f9ee45 9360_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
9361
9362#---------------------------------------------------------------------------
9363
54f9ee45
RD
9364FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9365FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9366FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 9367class FlexGridSizer(GridSizer):
248ed943
RD
9368 """
9369 A flex grid sizer is a sizer which lays out its children in a
9370 two-dimensional table with all table cells in one row having the same
9371 height and all cells in one column having the same width, but all
9372 rows or all columns are not necessarily the same height or width as in
9373 the `wx.GridSizer`.
9374
9375 wx.FlexGridSizer can also size items equally in one direction but
9376 unequally ("flexibly") in the other. If the sizer is only flexible
9377 in one direction (this can be changed using `SetFlexibleDirection`), it
9378 needs to be decided how the sizer should grow in the other ("non
9379 flexible") direction in order to fill the available space. The
9380 `SetNonFlexibleGrowMode` method serves this purpose.
9381
9382
9383 """
e811c8ce
RD
9384 def __repr__(self):
9385 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9386 def __init__(self, *args, **kwargs):
248ed943
RD
9387 """
9388 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9389
9390 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9391 number of columns and rows in the sizer - if either of the parameters
9392 is zero, it will be calculated to from the total number of children in
9393 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9394 define extra space between all children.
9395 """
54f9ee45 9396 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
9397 self.this = newobj.this
9398 self.thisown = 1
9399 del newobj.thisown
9400 self._setOORInfo(self)
e811c8ce 9401
248ed943
RD
9402 def AddGrowableRow(*args, **kwargs):
9403 """
9404 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 9405
248ed943
RD
9406 Specifies that row *idx* (starting from zero) should be grown if there
9407 is extra space available to the sizer.
e811c8ce 9408
248ed943
RD
9409 The *proportion* parameter has the same meaning as the stretch factor
9410 for the box sizers except that if all proportions are 0, then all
9411 columns are resized equally (instead of not being resized at all).
9412 """
54f9ee45 9413 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
9414
9415 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
9416 """
9417 RemoveGrowableRow(self, size_t idx)
9418
9419 Specifies that row *idx* is no longer growable.
9420 """
54f9ee45 9421 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
9422
9423 def AddGrowableCol(*args, **kwargs):
248ed943
RD
9424 """
9425 AddGrowableCol(self, size_t idx, int proportion=0)
9426
9427 Specifies that column *idx* (starting from zero) should be grown if
9428 there is extra space available to the sizer.
9429
9430 The *proportion* parameter has the same meaning as the stretch factor
9431 for the box sizers except that if all proportions are 0, then all
9432 columns are resized equally (instead of not being resized at all).
9433 """
54f9ee45 9434 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
9435
9436 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
9437 """
9438 RemoveGrowableCol(self, size_t idx)
9439
9440 Specifies that column *idx* is no longer growable.
9441 """
54f9ee45 9442 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
9443
9444 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
9445 """
9446 SetFlexibleDirection(self, int direction)
9447
9448 Specifies whether the sizer should flexibly resize its columns, rows,
9449 or both. Argument *direction* can be one of the following values. Any
9450 other value is ignored.
9451
9452 ============== =======================================
9453 wx.VERTICAL Rows are flexibly sized.
9454 wx.HORIZONTAL Columns are flexibly sized.
9455 wx.BOTH Both rows and columns are flexibly sized
9456 (this is the default value).
9457 ============== =======================================
9458
9459 Note that this method does not trigger relayout.
9460
9461 """
54f9ee45 9462 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9463
9464 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
9465 """
9466 GetFlexibleDirection(self) -> int
9467
9468 Returns a value that specifies whether the sizer
9469 flexibly resizes its columns, rows, or both (default).
9470
9471 :see: `SetFlexibleDirection`
9472 """
54f9ee45 9473 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9474
9475 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9476 """
9477 SetNonFlexibleGrowMode(self, int mode)
9478
9479 Specifies how the sizer should grow in the non-flexible direction if
9480 there is one (so `SetFlexibleDirection` must have been called
9481 previously). Argument *mode* can be one of the following values:
9482
9483 ========================== =================================================
9484 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9485 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9486 `AddGrowableCol` and `AddGrowableRow`. In this
9487 case equal sizing applies to minimum sizes of
9488 columns or rows (this is the default value).
9489 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9490 the non flexible direction, whether they are
9491 growable or not in the flexbile direction.
9492 ========================== =================================================
9493
9494 Note that this method does not trigger relayout.
9495
9496
9497 """
54f9ee45 9498 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9499
9500 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9501 """
9502 GetNonFlexibleGrowMode(self) -> int
9503
9504 Returns the value that specifies how the sizer grows in the
9505 non-flexible direction if there is one.
9506
9507 :see: `SetNonFlexibleGrowMode`
9508 """
54f9ee45 9509 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9510
9511 def GetRowHeights(*args, **kwargs):
248ed943 9512 """GetRowHeights(self) -> list"""
54f9ee45 9513 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
9514
9515 def GetColWidths(*args, **kwargs):
248ed943 9516 """GetColWidths(self) -> list"""
54f9ee45 9517 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 9518
d14a1e28
RD
9519
9520class FlexGridSizerPtr(FlexGridSizer):
9521 def __init__(self, this):
9522 self.this = this
9523 if not hasattr(self,"thisown"): self.thisown = 0
9524 self.__class__ = FlexGridSizer
54f9ee45 9525_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28
RD
9526
9527#---------------------------------------------------------------------------
9528
9529class GBPosition(object):
248ed943
RD
9530 """
9531 This class represents the position of an item in a virtual grid of
9532 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9533 typemaps that will automatically convert from a 2-element sequence of
9534 integers to a wx.GBPosition, so you can use the more pythonic
9535 representation of the position nearly transparently in Python code.
9536 """
e811c8ce
RD
9537 def __repr__(self):
9538 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9539 def __init__(self, *args, **kwargs):
248ed943
RD
9540 """
9541 __init__(self, int row=0, int col=0) -> GBPosition
9542
9543 This class represents the position of an item in a virtual grid of
9544 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9545 typemaps that will automatically convert from a 2-element sequence of
9546 integers to a wx.GBPosition, so you can use the more pythonic
9547 representation of the position nearly transparently in Python code.
9548 """
54f9ee45 9549 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
9550 self.this = newobj.this
9551 self.thisown = 1
9552 del newobj.thisown
e811c8ce 9553 def GetRow(*args, **kwargs):
a95a7133 9554 """GetRow(self) -> int"""
54f9ee45 9555 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
9556
9557 def GetCol(*args, **kwargs):
a95a7133 9558 """GetCol(self) -> int"""
54f9ee45 9559 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
9560
9561 def SetRow(*args, **kwargs):
a95a7133 9562 """SetRow(self, int row)"""
54f9ee45 9563 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
9564
9565 def SetCol(*args, **kwargs):
a95a7133 9566 """SetCol(self, int col)"""
54f9ee45 9567 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
9568
9569 def __eq__(*args, **kwargs):
a95a7133 9570 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 9571 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
9572
9573 def __ne__(*args, **kwargs):
a95a7133 9574 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 9575 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
9576
9577 def Set(*args, **kwargs):
a95a7133 9578 """Set(self, int row=0, int col=0)"""
54f9ee45 9579 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
9580
9581 def Get(*args, **kwargs):
a95a7133 9582 """Get(self) -> PyObject"""
54f9ee45 9583 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 9584
41e2b43e 9585 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9586 def __str__(self): return str(self.Get())
9587 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9588 def __len__(self): return len(self.Get())
9589 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9590 def __setitem__(self, index, val):
9591 if index == 0: self.SetRow(val)
9592 elif index == 1: self.SetCol(val)
9593 else: raise IndexError
e811c8ce 9594 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9595 __safe_for_unpickling__ = True
9596 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
9597
9598 row = property(GetRow, SetRow)
9599 col = property(GetCol, SetCol)
9600
9601
9602class GBPositionPtr(GBPosition):
9603 def __init__(self, this):
9604 self.this = this
9605 if not hasattr(self,"thisown"): self.thisown = 0
9606 self.__class__ = GBPosition
54f9ee45 9607_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
9608
9609class GBSpan(object):
248ed943
RD
9610 """
9611 This class is used to hold the row and column spanning attributes of
9612 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9613 automatically convert from a 2-element sequence of integers to a
9614 wx.GBSpan, so you can use the more pythonic representation of the span
9615 nearly transparently in Python code.
9616
9617 """
e811c8ce
RD
9618 def __repr__(self):
9619 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9620 def __init__(self, *args, **kwargs):
248ed943
RD
9621 """
9622 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9623
9624 Construct a new wxGBSpan, optionally setting the rowspan and
9625 colspan. The default is (1,1). (Meaning that the item occupies one
9626 cell in each direction.
9627 """
54f9ee45 9628 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
9629 self.this = newobj.this
9630 self.thisown = 1
9631 del newobj.thisown
e811c8ce 9632 def GetRowspan(*args, **kwargs):
a95a7133 9633 """GetRowspan(self) -> int"""
54f9ee45 9634 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
9635
9636 def GetColspan(*args, **kwargs):
a95a7133 9637 """GetColspan(self) -> int"""
54f9ee45 9638 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
9639
9640 def SetRowspan(*args, **kwargs):
a95a7133 9641 """SetRowspan(self, int rowspan)"""
54f9ee45 9642 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
9643
9644 def SetColspan(*args, **kwargs):
a95a7133 9645 """SetColspan(self, int colspan)"""
54f9ee45 9646 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
9647
9648 def __eq__(*args, **kwargs):
a95a7133 9649 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 9650 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
9651
9652 def __ne__(*args, **kwargs):
a95a7133 9653 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 9654 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
9655
9656 def Set(*args, **kwargs):
a95a7133 9657 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 9658 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
9659
9660 def Get(*args, **kwargs):
a95a7133 9661 """Get(self) -> PyObject"""
54f9ee45 9662 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 9663
41e2b43e 9664 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9665 def __str__(self): return str(self.Get())
9666 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
9667 def __len__(self): return len(self.Get())
9668 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9669 def __setitem__(self, index, val):
9670 if index == 0: self.SetRowspan(val)
9671 elif index == 1: self.SetColspan(val)
9672 else: raise IndexError
e811c8ce 9673 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9674 __safe_for_unpickling__ = True
9675 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
9676
9677 rowspan = property(GetRowspan, SetRowspan)
9678 colspan = property(GetColspan, SetColspan)
9679
9680
9681class GBSpanPtr(GBSpan):
9682 def __init__(self, this):
9683 self.this = this
9684 if not hasattr(self,"thisown"): self.thisown = 0
9685 self.__class__ = GBSpan
54f9ee45 9686_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
9687
9688class GBSizerItem(SizerItem):
248ed943
RD
9689 """
9690 The wx.GBSizerItem class is used to track the additional data about
9691 items in a `wx.GridBagSizer` such as the item's position in the grid
9692 and how many rows or columns it spans.
9693
9694 """
e811c8ce
RD
9695 def __repr__(self):
9696 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9697 def __init__(self, *args, **kwargs):
248ed943
RD
9698 """
9699 __init__(self) -> GBSizerItem
9700
9701 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
9702 size will need to be set, as well as a position and span before this
9703 item can be used in a Sizer.
9704
9705 You will probably never need to create a wx.GBSizerItem directly as they
9706 are created automatically when the sizer's Add method is called.
9707 """
54f9ee45 9708 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
9709 self.this = newobj.this
9710 self.thisown = 1
9711 del newobj.thisown
e811c8ce 9712 def GetPos(*args, **kwargs):
248ed943
RD
9713 """
9714 GetPos(self) -> GBPosition
9715
9716 Get the grid position of the item
9717 """
54f9ee45 9718 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
9719
9720 def GetPosTuple(self): return self.GetPos().Get()
9721 def GetSpan(*args, **kwargs):
248ed943
RD
9722 """
9723 GetSpan(self) -> GBSpan
9724
9725 Get the row and column spanning of the item
9726 """
54f9ee45 9727 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
9728
9729 def GetSpanTuple(self): return self.GetSpan().Get()
9730 def SetPos(*args, **kwargs):
248ed943
RD
9731 """
9732 SetPos(self, GBPosition pos) -> bool
9733
9734 If the item is already a member of a sizer then first ensure that
9735 there is no other item that would intersect with this one at the new
9736 position, then set the new position. Returns True if the change is
9737 successful and after the next Layout() the item will be moved.
9738 """
54f9ee45 9739 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
9740
9741 def SetSpan(*args, **kwargs):
248ed943
RD
9742 """
9743 SetSpan(self, GBSpan span) -> bool
9744
9745 If the item is already a member of a sizer then first ensure that
9746 there is no other item that would intersect with this one with its new
9747 spanning size, then set the new spanning. Returns True if the change
9748 is successful and after the next Layout() the item will be resized.
9749
9750 """
54f9ee45 9751 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 9752
248ed943 9753 def Intersects(*args, **kwargs):
0df68c9f 9754 """
a95a7133 9755 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
9756
9757 Returns True if this item and the other item instersect.
0df68c9f 9758 """
248ed943
RD
9759 return _core_.GBSizerItem_Intersects(*args, **kwargs)
9760
9761 def IntersectsPos(*args, **kwargs):
9762 """
9763 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
9764
9765 Returns True if the given pos/span would intersect with this item.
9766 """
9767 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
9768
9769 def GetEndPos(*args, **kwargs):
248ed943
RD
9770 """
9771 GetEndPos(self) -> GBPosition
9772
9773 Get the row and column of the endpoint of this item.
9774 """
54f9ee45 9775 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
9776
9777 def GetGBSizer(*args, **kwargs):
248ed943
RD
9778 """
9779 GetGBSizer(self) -> GridBagSizer
9780
9781 Get the sizer this item is a member of.
9782 """
54f9ee45 9783 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
9784
9785 def SetGBSizer(*args, **kwargs):
248ed943
RD
9786 """
9787 SetGBSizer(self, GridBagSizer sizer)
9788
9789 Set the sizer this item is a member of.
9790 """
54f9ee45 9791 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 9792
d14a1e28
RD
9793
9794class GBSizerItemPtr(GBSizerItem):
9795 def __init__(self, this):
9796 self.this = this
9797 if not hasattr(self,"thisown"): self.thisown = 0
9798 self.__class__ = GBSizerItem
54f9ee45 9799_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
9800DefaultSpan = cvar.DefaultSpan
9801
9802def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
9803 """
9804 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9805 int border, PyObject userData=None) -> GBSizerItem
9806
9807 Construct a `wx.GBSizerItem` for a window.
0df68c9f 9808 """
54f9ee45 9809 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
9810 val.thisown = 1
9811 return val
9812
9813def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
9814 """
9815 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9816 int border, PyObject userData=None) -> GBSizerItem
9817
9818 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 9819 """
54f9ee45 9820 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
9821 val.thisown = 1
9822 return val
9823
9824def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
9825 """
9826 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
9827 int flag, int border, PyObject userData=None) -> GBSizerItem
9828
9829 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 9830 """
54f9ee45 9831 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9832 val.thisown = 1
9833 return val
9834
9835class GridBagSizer(FlexGridSizer):
248ed943
RD
9836 """
9837 A `wx.Sizer` that can lay out items in a virtual grid like a
9838 `wx.FlexGridSizer` but in this case explicit positioning of the items
9839 is allowed using `wx.GBPosition`, and items can optionally span more
9840 than one row and/or column using `wx.GBSpan`. The total size of the
9841 virtual grid is determined by the largest row and column that items are
9842 positioned at, adjusted for spanning.
9843
9844 """
e811c8ce
RD
9845 def __repr__(self):
9846 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9847 def __init__(self, *args, **kwargs):
248ed943
RD
9848 """
9849 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
9850
9851 Constructor, with optional parameters to specify the gap between the
9852 rows and columns.
9853 """
54f9ee45 9854 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
9855 self.this = newobj.this
9856 self.thisown = 1
9857 del newobj.thisown
e811c8ce 9858 def Add(*args, **kwargs):
0df68c9f 9859 """
248ed943
RD
9860 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
9861 int border=0, userData=None)
9862
9863 Adds an item to the sizer at the grid cell *pos*, optionally spanning
9864 more than one row or column as specified with *span*. The remaining
9865 args behave similarly to `wx.Sizer.Add`.
9866
9867 Returns True if the item was successfully placed at the given cell
9868 position, False if something was already there.
9869
0df68c9f 9870 """
54f9ee45 9871 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
9872
9873 def AddItem(*args, **kwargs):
248ed943
RD
9874 """
9875 Add(self, GBSizerItem item) -> bool
9876
9877 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
9878 the item was successfully placed at its given cell position, False if
9879 something was already there.
9880 """
54f9ee45 9881 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce
RD
9882
9883 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
9884 """
9885 GetEmptyCellSize(self) -> Size
9886
9887 Get the size used for cells in the grid with no item.
9888 """
54f9ee45 9889 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
9890
9891 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
9892 """
9893 SetEmptyCellSize(self, Size sz)
9894
9895 Set the size used for cells in the grid with no item.
9896 """
54f9ee45 9897 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
9898
9899 def GetItemPosition(*args):
0df68c9f 9900 """
248ed943
RD
9901 GetItemPosition(self, item) -> GBPosition
9902
9903 Get the grid position of the specified *item* where *item* is either a
9904 window or subsizer that is a member of this sizer, or a zero-based
9905 index of an item.
0df68c9f 9906 """
54f9ee45 9907 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
9908
9909 def SetItemPosition(*args):
0df68c9f 9910 """
248ed943
RD
9911 SetItemPosition(self, item, GBPosition pos) -> bool
9912
9913 Set the grid position of the specified *item* where *item* is either a
9914 window or subsizer that is a member of this sizer, or a zero-based
9915 index of an item. Returns True on success. If the move is not
9916 allowed (because an item is already there) then False is returned.
9917
0df68c9f 9918 """
54f9ee45 9919 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
9920
9921 def GetItemSpan(*args):
0df68c9f 9922 """
248ed943
RD
9923 GetItemSpan(self, item) -> GBSpan
9924
9925 Get the row/col spanning of the specified *item* where *item* is
9926 either a window or subsizer that is a member of this sizer, or a
9927 zero-based index of an item.
0df68c9f 9928 """
54f9ee45 9929 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
9930
9931 def SetItemSpan(*args):
0df68c9f 9932 """
248ed943
RD
9933 SetItemSpan(self, item, GBSpan span) -> bool
9934
9935 Set the row/col spanning of the specified *item* where *item* is
9936 either a window or subsizer that is a member of this sizer, or a
9937 zero-based index of an item. Returns True on success. If the move is
9938 not allowed (because an item is already there) then False is returned.
0df68c9f 9939 """
54f9ee45 9940 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
9941
9942 def FindItem(*args):
0df68c9f 9943 """
248ed943
RD
9944 FindItem(self, item) -> GBSizerItem
9945
9946 Find the sizer item for the given window or subsizer, returns None if
9947 not found. (non-recursive)
0df68c9f 9948 """
54f9ee45 9949 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
9950
9951 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
9952 """
9953 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
9954
9955 Return the sizer item for the given grid cell, or None if there is no
9956 item at that position. (non-recursive)
9957 """
54f9ee45 9958 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
9959
9960 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
9961 """
9962 FindItemAtPoint(self, Point pt) -> GBSizerItem
9963
9964 Return the sizer item located at the point given in *pt*, or None if
9965 there is no item at that point. The (x,y) coordinates in pt correspond
9966 to the client coordinates of the window using the sizer for
9967 layout. (non-recursive)
9968 """
54f9ee45 9969 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 9970
248ed943
RD
9971 def CheckForIntersection(*args, **kwargs):
9972 """
9973 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 9974
248ed943
RD
9975 Look at all items and see if any intersect (or would overlap) the
9976 given *item*. Returns True if so, False if there would be no overlap.
9977 If an *excludeItem* is given then it will not be checked for
9978 intersection, for example it may be the item we are checking the
9979 position of.
e811c8ce 9980
248ed943
RD
9981 """
9982 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 9983
248ed943 9984 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 9985 """
248ed943
RD
9986 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
9987
9988 Look at all items and see if any intersect (or would overlap) the
9989 given position and span. Returns True if so, False if there would be
9990 no overlap. If an *excludeItem* is given then it will not be checked
9991 for intersection, for example it may be the item we are checking the
9992 position of.
0df68c9f 9993 """
248ed943 9994 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 9995
d14a1e28
RD
9996
9997class GridBagSizerPtr(GridBagSizer):
9998 def __init__(self, this):
9999 self.this = this
10000 if not hasattr(self,"thisown"): self.thisown = 0
10001 self.__class__ = GridBagSizer
54f9ee45 10002_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
10003
10004#---------------------------------------------------------------------------
10005
54f9ee45
RD
10006Left = _core_.Left
10007Top = _core_.Top
10008Right = _core_.Right
10009Bottom = _core_.Bottom
10010Width = _core_.Width
10011Height = _core_.Height
10012Centre = _core_.Centre
10013Center = _core_.Center
10014CentreX = _core_.CentreX
10015CentreY = _core_.CentreY
10016Unconstrained = _core_.Unconstrained
10017AsIs = _core_.AsIs
10018PercentOf = _core_.PercentOf
10019Above = _core_.Above
10020Below = _core_.Below
10021LeftOf = _core_.LeftOf
10022RightOf = _core_.RightOf
10023SameAs = _core_.SameAs
10024Absolute = _core_.Absolute
d14a1e28 10025class IndividualLayoutConstraint(Object):
15afbcd0 10026 """
41e2b43e
RD
10027 Objects of this class are stored in the `wx.LayoutConstraints` class as
10028 one of eight possible constraints that a window can be involved in.
10029 You will never need to create an instance of
10030 wx.IndividualLayoutConstraint, rather you should create a
10031 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 10032 that it contains.
15afbcd0 10033 """
d14a1e28
RD
10034 def __init__(self): raise RuntimeError, "No constructor defined"
10035 def __repr__(self):
10036 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 10037 def Set(*args, **kwargs):
41e2b43e
RD
10038 """
10039 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10040
10041 Sets the properties of the constraint. Normally called by one of the
10042 convenience functions such as Above, RightOf, SameAs.
10043 """
54f9ee45 10044 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
10045
10046 def LeftOf(*args, **kwargs):
15afbcd0 10047 """
a95a7133 10048 LeftOf(self, Window sibling, int marg=0)
15afbcd0 10049
41e2b43e
RD
10050 Constrains this edge to be to the left of the given window, with an
10051 optional margin. Implicitly, this is relative to the left edge of the
10052 other window.
15afbcd0 10053 """
54f9ee45 10054 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
10055
10056 def RightOf(*args, **kwargs):
15afbcd0 10057 """
a95a7133 10058 RightOf(self, Window sibling, int marg=0)
15afbcd0 10059
41e2b43e
RD
10060 Constrains this edge to be to the right of the given window, with an
10061 optional margin. Implicitly, this is relative to the right edge of the
10062 other window.
15afbcd0 10063 """
54f9ee45 10064 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
10065
10066 def Above(*args, **kwargs):
15afbcd0 10067 """
a95a7133 10068 Above(self, Window sibling, int marg=0)
15afbcd0 10069
41e2b43e
RD
10070 Constrains this edge to be above the given window, with an optional
10071 margin. Implicitly, this is relative to the top edge of the other
10072 window.
15afbcd0 10073 """
54f9ee45 10074 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
10075
10076 def Below(*args, **kwargs):
15afbcd0 10077 """
a95a7133 10078 Below(self, Window sibling, int marg=0)
15afbcd0 10079
41e2b43e
RD
10080 Constrains this edge to be below the given window, with an optional
10081 margin. Implicitly, this is relative to the bottom edge of the other
10082 window.
15afbcd0 10083 """
54f9ee45 10084 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
10085
10086 def SameAs(*args, **kwargs):
15afbcd0 10087 """
a95a7133 10088 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 10089
41e2b43e
RD
10090 Constrains this edge or dimension to be to the same as the edge of the
10091 given window, with an optional margin.
15afbcd0 10092 """
54f9ee45 10093 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
10094
10095 def PercentOf(*args, **kwargs):
15afbcd0 10096 """
a95a7133 10097 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 10098
41e2b43e
RD
10099 Constrains this edge or dimension to be to a percentage of the given
10100 window, with an optional margin.
15afbcd0 10101 """
54f9ee45 10102 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
10103
10104 def Absolute(*args, **kwargs):
15afbcd0 10105 """
a95a7133 10106 Absolute(self, int val)
15afbcd0 10107
41e2b43e 10108 Constrains this edge or dimension to be the given absolute value.
15afbcd0 10109 """
54f9ee45 10110 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
10111
10112 def Unconstrained(*args, **kwargs):
15afbcd0 10113 """
a95a7133 10114 Unconstrained(self)
15afbcd0 10115
41e2b43e
RD
10116 Sets this edge or dimension to be unconstrained, that is, dependent on
10117 other edges and dimensions from which this value can be deduced.
15afbcd0 10118 """
54f9ee45 10119 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
10120
10121 def AsIs(*args, **kwargs):
15afbcd0 10122 """
a95a7133 10123 AsIs(self)
15afbcd0 10124
41e2b43e
RD
10125 Sets this edge or constraint to be whatever the window's value is at
10126 the moment. If either of the width and height constraints are *as is*,
10127 the window will not be resized, but moved instead. This is important
10128 when considering panel items which are intended to have a default
10129 size, such as a button, which may take its size from the size of the
10130 button label.
15afbcd0 10131 """
54f9ee45 10132 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
10133
10134 def GetOtherWindow(*args, **kwargs):
a95a7133 10135 """GetOtherWindow(self) -> Window"""
54f9ee45 10136 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
10137
10138 def GetMyEdge(*args, **kwargs):
a95a7133 10139 """GetMyEdge(self) -> int"""
54f9ee45 10140 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
10141
10142 def SetEdge(*args, **kwargs):
a95a7133 10143 """SetEdge(self, int which)"""
54f9ee45 10144 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
10145
10146 def SetValue(*args, **kwargs):
a95a7133 10147 """SetValue(self, int v)"""
54f9ee45 10148 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
10149
10150 def GetMargin(*args, **kwargs):
a95a7133 10151 """GetMargin(self) -> int"""
54f9ee45 10152 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
10153
10154 def SetMargin(*args, **kwargs):
a95a7133 10155 """SetMargin(self, int m)"""
54f9ee45 10156 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
10157
10158 def GetValue(*args, **kwargs):
a95a7133 10159 """GetValue(self) -> int"""
54f9ee45 10160 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
10161
10162 def GetPercent(*args, **kwargs):
a95a7133 10163 """GetPercent(self) -> int"""
54f9ee45 10164 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
10165
10166 def GetOtherEdge(*args, **kwargs):
a95a7133 10167 """GetOtherEdge(self) -> int"""
54f9ee45 10168 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
10169
10170 def GetDone(*args, **kwargs):
a95a7133 10171 """GetDone(self) -> bool"""
54f9ee45 10172 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
10173
10174 def SetDone(*args, **kwargs):
a95a7133 10175 """SetDone(self, bool d)"""
54f9ee45 10176 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
10177
10178 def GetRelationship(*args, **kwargs):
a95a7133 10179 """GetRelationship(self) -> int"""
54f9ee45 10180 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
10181
10182 def SetRelationship(*args, **kwargs):
a95a7133 10183 """SetRelationship(self, int r)"""
54f9ee45 10184 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
10185
10186 def ResetIfWin(*args, **kwargs):
15afbcd0 10187 """
a95a7133 10188 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
10189
10190 Reset constraint if it mentions otherWin
10191 """
54f9ee45 10192 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
10193
10194 def SatisfyConstraint(*args, **kwargs):
15afbcd0 10195 """
a95a7133 10196 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
10197
10198 Try to satisfy constraint
10199 """
54f9ee45 10200 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
10201
10202 def GetEdge(*args, **kwargs):
15afbcd0 10203 """
a95a7133 10204 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
10205
10206 Get the value of this edge or dimension, or if this
10207 is not determinable, -1.
10208 """
54f9ee45 10209 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 10210
d14a1e28
RD
10211
10212class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10213 def __init__(self, this):
10214 self.this = this
10215 if not hasattr(self,"thisown"): self.thisown = 0
10216 self.__class__ = IndividualLayoutConstraint
54f9ee45 10217_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
10218
10219class LayoutConstraints(Object):
15afbcd0 10220 """
41e2b43e
RD
10221 **Note:** constraints are now deprecated and you should use sizers
10222 instead.
15afbcd0 10223
41e2b43e
RD
10224 Objects of this class can be associated with a window to define its
10225 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
10226
10227 The class consists of the following eight constraints of class
10228 wx.IndividualLayoutConstraint, some or all of which should be accessed
10229 directly to set the appropriate constraints.
10230
10231 * left: represents the left hand edge of the window
10232 * right: represents the right hand edge of the window
10233 * top: represents the top edge of the window
10234 * bottom: represents the bottom edge of the window
10235 * width: represents the width of the window
10236 * height: represents the height of the window
10237 * centreX: represents the horizontal centre point of the window
10238 * centreY: represents the vertical centre point of the window
10239
41e2b43e
RD
10240 Most constraints are initially set to have the relationship
10241 wxUnconstrained, which means that their values should be calculated by
10242 looking at known constraints. The exceptions are width and height,
10243 which are set to wxAsIs to ensure that if the user does not specify a
10244 constraint, the existing width and height will be used, to be
10245 compatible with panel items which often have take a default size. If
10246 the constraint is ``wx.AsIs``, the dimension will not be changed.
10247
10248 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
10249
10250 """
e811c8ce
RD
10251 def __repr__(self):
10252 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
10253 left = property(_core_.LayoutConstraints_left_get)
10254 top = property(_core_.LayoutConstraints_top_get)
10255 right = property(_core_.LayoutConstraints_right_get)
10256 bottom = property(_core_.LayoutConstraints_bottom_get)
10257 width = property(_core_.LayoutConstraints_width_get)
10258 height = property(_core_.LayoutConstraints_height_get)
10259 centreX = property(_core_.LayoutConstraints_centreX_get)
10260 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 10261 def __init__(self, *args, **kwargs):
a95a7133 10262 """__init__(self) -> LayoutConstraints"""
54f9ee45 10263 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
10264 self.this = newobj.this
10265 self.thisown = 1
10266 del newobj.thisown
e811c8ce 10267 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 10268 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 10269 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
10270
10271 def AreSatisfied(*args, **kwargs):
a95a7133 10272 """AreSatisfied(self) -> bool"""
54f9ee45 10273 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 10274
d14a1e28
RD
10275
10276class LayoutConstraintsPtr(LayoutConstraints):
10277 def __init__(self, this):
10278 self.this = this
10279 if not hasattr(self,"thisown"): self.thisown = 0
10280 self.__class__ = LayoutConstraints
54f9ee45 10281_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
10282
10283#----------------------------------------------------------------------------
10284
322913ce 10285# Use Python's bool constants if available, make some if not
d14a1e28
RD
10286try:
10287 True
10288except NameError:
322913ce
RD
10289 __builtins__.True = 1==1
10290 __builtins__.False = 1==0
4f89f6a3
RD
10291 def bool(value): return not not value
10292 __builtins__.bool = bool
d14a1e28 10293
d14a1e28
RD
10294
10295
10296# workarounds for bad wxRTTI names
10297__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10298__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10299__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10300
10301
10302#----------------------------------------------------------------------------
10303# Load version numbers from __version__... Ensure that major and minor
10304# versions are the same for both wxPython and wxWindows.
10305
10306from __version__ import *
10307__version__ = VERSION_STRING
10308
54f9ee45
RD
10309assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
10310assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
10311if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28
RD
10312 import warnings
10313 warnings.warn("wxPython/wxWindows release number mismatch")
10314
10315#----------------------------------------------------------------------------
10316
10317class PyDeadObjectError(AttributeError):
10318 pass
10319
d14a1e28
RD
10320class _wxPyDeadObject(object):
10321 """
10322 Instances of wx objects that are OOR capable will have their __class__
10323 changed to this class when the C++ object is deleted. This should help
10324 prevent crashes due to referencing a bogus C++ pointer.
10325 """
10326 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10327 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10328
3a04f143 10329 def __repr__(self):
d14a1e28
RD
10330 if not hasattr(self, "_name"):
10331 self._name = "[unknown]"
10332 return self.reprStr % self._name
10333
3a04f143 10334 def __getattr__(self, *args):
d14a1e28
RD
10335 if not hasattr(self, "_name"):
10336 self._name = "[unknown]"
3a04f143
RD
10337 raise PyDeadObjectError(self.attrStr % self._name)
10338
10339 def __nonzero__(self):
10340 return 0
10341
10342
10343
10344class PyUnbornObjectError(AttributeError):
10345 pass
10346
10347class _wxPyUnbornObject(object):
10348 """
54f9ee45 10349 Some stock objects are created when the wx._core module is
3a04f143
RD
10350 imported, but their C++ instance is not created until the wx.App
10351 object is created and initialized. These object instances will
10352 temporarily have their __class__ changed to this class so an
10353 exception will be raised if they are used before the C++ instance
10354 is ready.
10355 """
10356
10357 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10358 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10359
10360 def __repr__(self):
10361 #if not hasattr(self, "_name"):
10362 # self._name = "[unknown]"
10363 return self.reprStr #% self._name
10364
10365 def __getattr__(self, *args):
10366 #if not hasattr(self, "_name"):
10367 # self._name = "[unknown]"
10368 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
10369
10370 def __nonzero__(self):
10371 return 0
10372
10373
10374#----------------------------------------------------------------------------
10375_wxPyCallAfterId = None
10376
10377def CallAfter(callable, *args, **kw):
10378 """
10379 Call the specified function after the current and pending event
10380 handlers have been completed. This is also good for making GUI
61863841
RD
10381 method calls from non-GUI threads. Any extra positional or
10382 keyword args are passed on to the callable when it is called.
10383
10384 :see: `wx.FutureCall`
d14a1e28
RD
10385 """
10386 app = wx.GetApp()
10387 assert app, 'No wxApp created yet'
10388
10389 global _wxPyCallAfterId
10390 if _wxPyCallAfterId is None:
10391 _wxPyCallAfterId = wx.NewEventType()
10392 app.Connect(-1, -1, _wxPyCallAfterId,
10393 lambda event: event.callable(*event.args, **event.kw) )
10394 evt = wx.PyEvent()
10395 evt.SetEventType(_wxPyCallAfterId)
10396 evt.callable = callable
10397 evt.args = args
10398 evt.kw = kw
10399 wx.PostEvent(app, evt)
10400
10401
10402#----------------------------------------------------------------------------
10403
10404
10405class FutureCall:
10406 """
4276dc52 10407 A convenience class for wx.Timer, that calls the given callable
d14a1e28
RD
10408 object once after the given amount of milliseconds, passing any
10409 positional or keyword args. The return value of the callable is
61863841 10410 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
10411
10412 If you don't need to get the return value or restart the timer
10413 then there is no need to hold a reference to this object. It will
10414 hold a reference to itself while the timer is running (the timer
10415 has a reference to self.Notify) but the cycle will be broken when
10416 the timer completes, automatically cleaning up the wx.FutureCall
10417 object.
61863841
RD
10418
10419 :see: `wx.CallAfter`
d14a1e28
RD
10420 """
10421 def __init__(self, millis, callable, *args, **kwargs):
10422 self.millis = millis
10423 self.callable = callable
10424 self.SetArgs(*args, **kwargs)
10425 self.runCount = 0
4276dc52 10426 self.running = False
d14a1e28
RD
10427 self.hasRun = False
10428 self.result = None
10429 self.timer = None
10430 self.Start()
10431
10432 def __del__(self):
10433 self.Stop()
10434
10435
10436 def Start(self, millis=None, *args, **kwargs):
10437 """
10438 (Re)start the timer
10439 """
10440 self.hasRun = False
10441 if millis is not None:
10442 self.millis = millis
10443 if args or kwargs:
10444 self.SetArgs(*args, **kwargs)
10445 self.Stop()
10446 self.timer = wx.PyTimer(self.Notify)
10447 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 10448 self.running = True
d14a1e28
RD
10449 Restart = Start
10450
10451
10452 def Stop(self):
10453 """
10454 Stop and destroy the timer.
10455 """
10456 if self.timer is not None:
10457 self.timer.Stop()
10458 self.timer = None
10459
10460
10461 def GetInterval(self):
10462 if self.timer is not None:
10463 return self.timer.GetInterval()
10464 else:
10465 return 0
10466
10467
10468 def IsRunning(self):
10469 return self.timer is not None and self.timer.IsRunning()
10470
10471
10472 def SetArgs(self, *args, **kwargs):
10473 """
10474 (Re)set the args passed to the callable object. This is
10475 useful in conjunction with Restart if you want to schedule a
10476 new call to the same callable object but with different
10477 parameters.
10478 """
10479 self.args = args
10480 self.kwargs = kwargs
10481
10482
10483 def HasRun(self):
10484 return self.hasRun
10485
10486 def GetResult(self):
10487 return self.result
10488
10489 def Notify(self):
10490 """
10491 The timer has expired so call the callable.
10492 """
10493 if self.callable and getattr(self.callable, 'im_self', True):
10494 self.runCount += 1
4276dc52 10495 self.running = False
d14a1e28
RD
10496 self.result = self.callable(*self.args, **self.kwargs)
10497 self.hasRun = True
4276dc52
RD
10498 if not self.running:
10499 # if it wasn't restarted, then cleanup
10500 wx.CallAfter(self.Stop)
d14a1e28
RD
10501
10502
a95a7133
RD
10503
10504#----------------------------------------------------------------------------
10505# Control which items in this module should be documented by epydoc.
10506# We allow only classes and functions, which will help reduce the size
10507# of the docs by filtering out the zillions of constants, EVT objects,
10508# and etc that don't make much sense by themselves, but are instead
10509# documented (or will be) as part of the classes/functions/methods
10510# where they should be used.
10511
66c033b4
RD
10512class __DocFilter:
10513 """
10514 A filter for epydoc that only allows non-Ptr classes and
10515 fucntions, in order to reduce the clutter in the API docs.
10516 """
10517 def __init__(self, globals):
10518 self._globals = globals
10519
10520 def __call__(self, name):
10521 import types
10522 obj = self._globals.get(name, None)
10523 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10524 return False
10525 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10526 return False
10527 return True
a95a7133 10528
d14a1e28
RD
10529#----------------------------------------------------------------------------
10530#----------------------------------------------------------------------------
10531
10532# Import other modules in this package that should show up in the
10533# "core" wx namespace
54f9ee45
RD
10534from _gdi import *
10535from _windows import *
10536from _controls import *
10537from _misc import *
d14a1e28 10538
3a04f143
RD
10539
10540# Fixup the stock objects since they can't be used yet. (They will be
10541# restored in wx.PyApp.OnInit.)
54f9ee45 10542_core_._wxPyFixStockObjects()
3a04f143 10543
d14a1e28
RD
10544#----------------------------------------------------------------------------
10545#----------------------------------------------------------------------------
10546
10547