]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_core.py
little tweaks to match recent CVS changes
[wxWidgets.git] / wxPython / src / gtk / _core.py
CommitLineData
d14a1e28
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
54f9ee45 4import _core_
d14a1e28
RD
5
6#// Give a reference to the dictionary of this module to the C++ extension
7#// code.
54f9ee45 8_core_._wxPySetDictionary(vars())
d14a1e28
RD
9
10#// A little trick to make 'wx' be a reference to this module so wx.Names can
11#// be used here.
12import sys as _sys
13wx = _sys.modules[__name__]
14
66c033b4
RD
15
16#----------------------------------------------------------------------------
17
18def _deprecated(callable, msg=None):
19 """
20 Create a wrapper function that will raise a DeprecationWarning
21 before calling the callable.
22 """
23 if msg is None:
24 msg = "%s is deprecated" % callable
25 def deprecatedWrapper(*args, **kwargs):
26 import warnings
27 warnings.warn(msg, DeprecationWarning, stacklevel=2)
28 return callable(*args, **kwargs)
29 deprecatedWrapper.__doc__ = msg
30 return deprecatedWrapper
31
32
33#----------------------------------------------------------------------------
34
54f9ee45
RD
35NOT_FOUND = _core_.NOT_FOUND
36VSCROLL = _core_.VSCROLL
37HSCROLL = _core_.HSCROLL
38CAPTION = _core_.CAPTION
39DOUBLE_BORDER = _core_.DOUBLE_BORDER
40SUNKEN_BORDER = _core_.SUNKEN_BORDER
41RAISED_BORDER = _core_.RAISED_BORDER
42BORDER = _core_.BORDER
43SIMPLE_BORDER = _core_.SIMPLE_BORDER
44STATIC_BORDER = _core_.STATIC_BORDER
45TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
46NO_BORDER = _core_.NO_BORDER
47TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
48WANTS_CHARS = _core_.WANTS_CHARS
49POPUP_WINDOW = _core_.POPUP_WINDOW
50CENTER_FRAME = _core_.CENTER_FRAME
51CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
52CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
53ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
54ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
55ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
56ED_STATIC_LINE = _core_.ED_STATIC_LINE
57EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
58CLIP_CHILDREN = _core_.CLIP_CHILDREN
59CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
60ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
61RETAINED = _core_.RETAINED
62BACKINGSTORE = _core_.BACKINGSTORE
63COLOURED = _core_.COLOURED
64FIXED_LENGTH = _core_.FIXED_LENGTH
65LB_NEEDED_SB = _core_.LB_NEEDED_SB
66LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
67LB_SORT = _core_.LB_SORT
68LB_SINGLE = _core_.LB_SINGLE
69LB_MULTIPLE = _core_.LB_MULTIPLE
70LB_EXTENDED = _core_.LB_EXTENDED
71LB_OWNERDRAW = _core_.LB_OWNERDRAW
72LB_HSCROLL = _core_.LB_HSCROLL
73PROCESS_ENTER = _core_.PROCESS_ENTER
74PASSWORD = _core_.PASSWORD
75CB_SIMPLE = _core_.CB_SIMPLE
76CB_DROPDOWN = _core_.CB_DROPDOWN
77CB_SORT = _core_.CB_SORT
78CB_READONLY = _core_.CB_READONLY
79RA_HORIZONTAL = _core_.RA_HORIZONTAL
80RA_VERTICAL = _core_.RA_VERTICAL
81RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
82RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
83RB_GROUP = _core_.RB_GROUP
84RB_SINGLE = _core_.RB_SINGLE
85SL_HORIZONTAL = _core_.SL_HORIZONTAL
86SL_VERTICAL = _core_.SL_VERTICAL
87SL_AUTOTICKS = _core_.SL_AUTOTICKS
88SL_LABELS = _core_.SL_LABELS
89SL_LEFT = _core_.SL_LEFT
90SL_TOP = _core_.SL_TOP
91SL_RIGHT = _core_.SL_RIGHT
92SL_BOTTOM = _core_.SL_BOTTOM
93SL_BOTH = _core_.SL_BOTH
94SL_SELRANGE = _core_.SL_SELRANGE
95SB_HORIZONTAL = _core_.SB_HORIZONTAL
96SB_VERTICAL = _core_.SB_VERTICAL
97ST_SIZEGRIP = _core_.ST_SIZEGRIP
98ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
99FLOOD_SURFACE = _core_.FLOOD_SURFACE
100FLOOD_BORDER = _core_.FLOOD_BORDER
101ODDEVEN_RULE = _core_.ODDEVEN_RULE
102WINDING_RULE = _core_.WINDING_RULE
103TOOL_TOP = _core_.TOOL_TOP
104TOOL_BOTTOM = _core_.TOOL_BOTTOM
105TOOL_LEFT = _core_.TOOL_LEFT
106TOOL_RIGHT = _core_.TOOL_RIGHT
107OK = _core_.OK
108YES_NO = _core_.YES_NO
109CANCEL = _core_.CANCEL
110YES = _core_.YES
111NO = _core_.NO
112NO_DEFAULT = _core_.NO_DEFAULT
113YES_DEFAULT = _core_.YES_DEFAULT
114ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
115ICON_HAND = _core_.ICON_HAND
116ICON_QUESTION = _core_.ICON_QUESTION
117ICON_INFORMATION = _core_.ICON_INFORMATION
118ICON_STOP = _core_.ICON_STOP
119ICON_ASTERISK = _core_.ICON_ASTERISK
120ICON_MASK = _core_.ICON_MASK
121ICON_WARNING = _core_.ICON_WARNING
122ICON_ERROR = _core_.ICON_ERROR
123FORWARD = _core_.FORWARD
124BACKWARD = _core_.BACKWARD
125RESET = _core_.RESET
126HELP = _core_.HELP
127MORE = _core_.MORE
128SETUP = _core_.SETUP
129SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
130SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
131SIZE_AUTO = _core_.SIZE_AUTO
132SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
133SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
134PORTRAIT = _core_.PORTRAIT
135LANDSCAPE = _core_.LANDSCAPE
136PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
137PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
138PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
139PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
140ID_ANY = _core_.ID_ANY
141ID_SEPARATOR = _core_.ID_SEPARATOR
142ID_LOWEST = _core_.ID_LOWEST
143ID_OPEN = _core_.ID_OPEN
144ID_CLOSE = _core_.ID_CLOSE
145ID_NEW = _core_.ID_NEW
146ID_SAVE = _core_.ID_SAVE
147ID_SAVEAS = _core_.ID_SAVEAS
148ID_REVERT = _core_.ID_REVERT
149ID_EXIT = _core_.ID_EXIT
150ID_UNDO = _core_.ID_UNDO
151ID_REDO = _core_.ID_REDO
152ID_HELP = _core_.ID_HELP
153ID_PRINT = _core_.ID_PRINT
154ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
155ID_PREVIEW = _core_.ID_PREVIEW
156ID_ABOUT = _core_.ID_ABOUT
157ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
158ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
159ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
160ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
161ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
162ID_PREFERENCES = _core_.ID_PREFERENCES
163ID_CUT = _core_.ID_CUT
164ID_COPY = _core_.ID_COPY
165ID_PASTE = _core_.ID_PASTE
166ID_CLEAR = _core_.ID_CLEAR
167ID_FIND = _core_.ID_FIND
168ID_DUPLICATE = _core_.ID_DUPLICATE
169ID_SELECTALL = _core_.ID_SELECTALL
170ID_DELETE = _core_.ID_DELETE
171ID_REPLACE = _core_.ID_REPLACE
172ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
173ID_PROPERTIES = _core_.ID_PROPERTIES
174ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
175ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
176ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
177ID_VIEW_LIST = _core_.ID_VIEW_LIST
178ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
179ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
180ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
181ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
182ID_FILE1 = _core_.ID_FILE1
183ID_FILE2 = _core_.ID_FILE2
184ID_FILE3 = _core_.ID_FILE3
185ID_FILE4 = _core_.ID_FILE4
186ID_FILE5 = _core_.ID_FILE5
187ID_FILE6 = _core_.ID_FILE6
188ID_FILE7 = _core_.ID_FILE7
189ID_FILE8 = _core_.ID_FILE8
190ID_FILE9 = _core_.ID_FILE9
191ID_OK = _core_.ID_OK
192ID_CANCEL = _core_.ID_CANCEL
193ID_APPLY = _core_.ID_APPLY
194ID_YES = _core_.ID_YES
195ID_NO = _core_.ID_NO
196ID_STATIC = _core_.ID_STATIC
197ID_FORWARD = _core_.ID_FORWARD
198ID_BACKWARD = _core_.ID_BACKWARD
199ID_DEFAULT = _core_.ID_DEFAULT
200ID_MORE = _core_.ID_MORE
201ID_SETUP = _core_.ID_SETUP
202ID_RESET = _core_.ID_RESET
203ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
204ID_YESTOALL = _core_.ID_YESTOALL
205ID_NOTOALL = _core_.ID_NOTOALL
206ID_ABORT = _core_.ID_ABORT
207ID_RETRY = _core_.ID_RETRY
208ID_IGNORE = _core_.ID_IGNORE
209ID_HIGHEST = _core_.ID_HIGHEST
210OPEN = _core_.OPEN
211SAVE = _core_.SAVE
212HIDE_READONLY = _core_.HIDE_READONLY
213OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
214FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
215MULTIPLE = _core_.MULTIPLE
216CHANGE_DIR = _core_.CHANGE_DIR
217ACCEL_ALT = _core_.ACCEL_ALT
218ACCEL_CTRL = _core_.ACCEL_CTRL
219ACCEL_SHIFT = _core_.ACCEL_SHIFT
220ACCEL_NORMAL = _core_.ACCEL_NORMAL
221PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
222PD_APP_MODAL = _core_.PD_APP_MODAL
223PD_CAN_ABORT = _core_.PD_CAN_ABORT
224PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
225PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
226PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
227DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
228DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
229MENU_TEAROFF = _core_.MENU_TEAROFF
230MB_DOCKABLE = _core_.MB_DOCKABLE
231NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
232FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
233LI_HORIZONTAL = _core_.LI_HORIZONTAL
234LI_VERTICAL = _core_.LI_VERTICAL
235WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
236WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
237WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
238WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
239WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
240WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
241MM_TEXT = _core_.MM_TEXT
242MM_LOMETRIC = _core_.MM_LOMETRIC
243MM_HIMETRIC = _core_.MM_HIMETRIC
244MM_LOENGLISH = _core_.MM_LOENGLISH
245MM_HIENGLISH = _core_.MM_HIENGLISH
246MM_TWIPS = _core_.MM_TWIPS
247MM_ISOTROPIC = _core_.MM_ISOTROPIC
248MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
249MM_POINTS = _core_.MM_POINTS
250MM_METRIC = _core_.MM_METRIC
251CENTRE = _core_.CENTRE
252CENTER = _core_.CENTER
253HORIZONTAL = _core_.HORIZONTAL
254VERTICAL = _core_.VERTICAL
255BOTH = _core_.BOTH
256LEFT = _core_.LEFT
257RIGHT = _core_.RIGHT
258UP = _core_.UP
259DOWN = _core_.DOWN
260TOP = _core_.TOP
261BOTTOM = _core_.BOTTOM
262NORTH = _core_.NORTH
263SOUTH = _core_.SOUTH
264WEST = _core_.WEST
265EAST = _core_.EAST
266ALL = _core_.ALL
267ALIGN_NOT = _core_.ALIGN_NOT
268ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
269ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
270ALIGN_LEFT = _core_.ALIGN_LEFT
271ALIGN_TOP = _core_.ALIGN_TOP
272ALIGN_RIGHT = _core_.ALIGN_RIGHT
273ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
274ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
275ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
276ALIGN_CENTER = _core_.ALIGN_CENTER
277ALIGN_CENTRE = _core_.ALIGN_CENTRE
278ALIGN_MASK = _core_.ALIGN_MASK
279STRETCH_NOT = _core_.STRETCH_NOT
280SHRINK = _core_.SHRINK
281GROW = _core_.GROW
282EXPAND = _core_.EXPAND
283SHAPED = _core_.SHAPED
284FIXED_MINSIZE = _core_.FIXED_MINSIZE
285TILE = _core_.TILE
286ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
287BORDER_DEFAULT = _core_.BORDER_DEFAULT
288BORDER_NONE = _core_.BORDER_NONE
289BORDER_STATIC = _core_.BORDER_STATIC
290BORDER_SIMPLE = _core_.BORDER_SIMPLE
291BORDER_RAISED = _core_.BORDER_RAISED
292BORDER_SUNKEN = _core_.BORDER_SUNKEN
293BORDER_DOUBLE = _core_.BORDER_DOUBLE
294BORDER_MASK = _core_.BORDER_MASK
295DEFAULT = _core_.DEFAULT
296DECORATIVE = _core_.DECORATIVE
297ROMAN = _core_.ROMAN
298SCRIPT = _core_.SCRIPT
299SWISS = _core_.SWISS
300MODERN = _core_.MODERN
301TELETYPE = _core_.TELETYPE
302VARIABLE = _core_.VARIABLE
303FIXED = _core_.FIXED
304NORMAL = _core_.NORMAL
305LIGHT = _core_.LIGHT
306BOLD = _core_.BOLD
307ITALIC = _core_.ITALIC
308SLANT = _core_.SLANT
309SOLID = _core_.SOLID
310DOT = _core_.DOT
311LONG_DASH = _core_.LONG_DASH
312SHORT_DASH = _core_.SHORT_DASH
313DOT_DASH = _core_.DOT_DASH
314USER_DASH = _core_.USER_DASH
315TRANSPARENT = _core_.TRANSPARENT
316STIPPLE = _core_.STIPPLE
317BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
318CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
319FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
320CROSS_HATCH = _core_.CROSS_HATCH
321HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
322VERTICAL_HATCH = _core_.VERTICAL_HATCH
323JOIN_BEVEL = _core_.JOIN_BEVEL
324JOIN_MITER = _core_.JOIN_MITER
325JOIN_ROUND = _core_.JOIN_ROUND
326CAP_ROUND = _core_.CAP_ROUND
327CAP_PROJECTING = _core_.CAP_PROJECTING
328CAP_BUTT = _core_.CAP_BUTT
329CLEAR = _core_.CLEAR
330XOR = _core_.XOR
331INVERT = _core_.INVERT
332OR_REVERSE = _core_.OR_REVERSE
333AND_REVERSE = _core_.AND_REVERSE
334COPY = _core_.COPY
335AND = _core_.AND
336AND_INVERT = _core_.AND_INVERT
337NO_OP = _core_.NO_OP
338NOR = _core_.NOR
339EQUIV = _core_.EQUIV
340SRC_INVERT = _core_.SRC_INVERT
341OR_INVERT = _core_.OR_INVERT
342NAND = _core_.NAND
343OR = _core_.OR
344SET = _core_.SET
345WXK_BACK = _core_.WXK_BACK
346WXK_TAB = _core_.WXK_TAB
347WXK_RETURN = _core_.WXK_RETURN
348WXK_ESCAPE = _core_.WXK_ESCAPE
349WXK_SPACE = _core_.WXK_SPACE
350WXK_DELETE = _core_.WXK_DELETE
351WXK_START = _core_.WXK_START
352WXK_LBUTTON = _core_.WXK_LBUTTON
353WXK_RBUTTON = _core_.WXK_RBUTTON
354WXK_CANCEL = _core_.WXK_CANCEL
355WXK_MBUTTON = _core_.WXK_MBUTTON
356WXK_CLEAR = _core_.WXK_CLEAR
357WXK_SHIFT = _core_.WXK_SHIFT
358WXK_ALT = _core_.WXK_ALT
359WXK_CONTROL = _core_.WXK_CONTROL
360WXK_MENU = _core_.WXK_MENU
361WXK_PAUSE = _core_.WXK_PAUSE
362WXK_CAPITAL = _core_.WXK_CAPITAL
363WXK_PRIOR = _core_.WXK_PRIOR
364WXK_NEXT = _core_.WXK_NEXT
365WXK_END = _core_.WXK_END
366WXK_HOME = _core_.WXK_HOME
367WXK_LEFT = _core_.WXK_LEFT
368WXK_UP = _core_.WXK_UP
369WXK_RIGHT = _core_.WXK_RIGHT
370WXK_DOWN = _core_.WXK_DOWN
371WXK_SELECT = _core_.WXK_SELECT
372WXK_PRINT = _core_.WXK_PRINT
373WXK_EXECUTE = _core_.WXK_EXECUTE
374WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
375WXK_INSERT = _core_.WXK_INSERT
376WXK_HELP = _core_.WXK_HELP
377WXK_NUMPAD0 = _core_.WXK_NUMPAD0
378WXK_NUMPAD1 = _core_.WXK_NUMPAD1
379WXK_NUMPAD2 = _core_.WXK_NUMPAD2
380WXK_NUMPAD3 = _core_.WXK_NUMPAD3
381WXK_NUMPAD4 = _core_.WXK_NUMPAD4
382WXK_NUMPAD5 = _core_.WXK_NUMPAD5
383WXK_NUMPAD6 = _core_.WXK_NUMPAD6
384WXK_NUMPAD7 = _core_.WXK_NUMPAD7
385WXK_NUMPAD8 = _core_.WXK_NUMPAD8
386WXK_NUMPAD9 = _core_.WXK_NUMPAD9
387WXK_MULTIPLY = _core_.WXK_MULTIPLY
388WXK_ADD = _core_.WXK_ADD
389WXK_SEPARATOR = _core_.WXK_SEPARATOR
390WXK_SUBTRACT = _core_.WXK_SUBTRACT
391WXK_DECIMAL = _core_.WXK_DECIMAL
392WXK_DIVIDE = _core_.WXK_DIVIDE
393WXK_F1 = _core_.WXK_F1
394WXK_F2 = _core_.WXK_F2
395WXK_F3 = _core_.WXK_F3
396WXK_F4 = _core_.WXK_F4
397WXK_F5 = _core_.WXK_F5
398WXK_F6 = _core_.WXK_F6
399WXK_F7 = _core_.WXK_F7
400WXK_F8 = _core_.WXK_F8
401WXK_F9 = _core_.WXK_F9
402WXK_F10 = _core_.WXK_F10
403WXK_F11 = _core_.WXK_F11
404WXK_F12 = _core_.WXK_F12
405WXK_F13 = _core_.WXK_F13
406WXK_F14 = _core_.WXK_F14
407WXK_F15 = _core_.WXK_F15
408WXK_F16 = _core_.WXK_F16
409WXK_F17 = _core_.WXK_F17
410WXK_F18 = _core_.WXK_F18
411WXK_F19 = _core_.WXK_F19
412WXK_F20 = _core_.WXK_F20
413WXK_F21 = _core_.WXK_F21
414WXK_F22 = _core_.WXK_F22
415WXK_F23 = _core_.WXK_F23
416WXK_F24 = _core_.WXK_F24
417WXK_NUMLOCK = _core_.WXK_NUMLOCK
418WXK_SCROLL = _core_.WXK_SCROLL
419WXK_PAGEUP = _core_.WXK_PAGEUP
420WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
421WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
422WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
423WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
424WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
425WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
426WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
427WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
428WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
429WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
430WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
431WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
432WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
433WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
434WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
435WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
436WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
437WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
438WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
439WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
440WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
441WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
442WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
443WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
444WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
445WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
446WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
447WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
448WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
449WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
450WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
451PAPER_NONE = _core_.PAPER_NONE
452PAPER_LETTER = _core_.PAPER_LETTER
453PAPER_LEGAL = _core_.PAPER_LEGAL
454PAPER_A4 = _core_.PAPER_A4
455PAPER_CSHEET = _core_.PAPER_CSHEET
456PAPER_DSHEET = _core_.PAPER_DSHEET
457PAPER_ESHEET = _core_.PAPER_ESHEET
458PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
459PAPER_TABLOID = _core_.PAPER_TABLOID
460PAPER_LEDGER = _core_.PAPER_LEDGER
461PAPER_STATEMENT = _core_.PAPER_STATEMENT
462PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
463PAPER_A3 = _core_.PAPER_A3
464PAPER_A4SMALL = _core_.PAPER_A4SMALL
465PAPER_A5 = _core_.PAPER_A5
466PAPER_B4 = _core_.PAPER_B4
467PAPER_B5 = _core_.PAPER_B5
468PAPER_FOLIO = _core_.PAPER_FOLIO
469PAPER_QUARTO = _core_.PAPER_QUARTO
470PAPER_10X14 = _core_.PAPER_10X14
471PAPER_11X17 = _core_.PAPER_11X17
472PAPER_NOTE = _core_.PAPER_NOTE
473PAPER_ENV_9 = _core_.PAPER_ENV_9
474PAPER_ENV_10 = _core_.PAPER_ENV_10
475PAPER_ENV_11 = _core_.PAPER_ENV_11
476PAPER_ENV_12 = _core_.PAPER_ENV_12
477PAPER_ENV_14 = _core_.PAPER_ENV_14
478PAPER_ENV_DL = _core_.PAPER_ENV_DL
479PAPER_ENV_C5 = _core_.PAPER_ENV_C5
480PAPER_ENV_C3 = _core_.PAPER_ENV_C3
481PAPER_ENV_C4 = _core_.PAPER_ENV_C4
482PAPER_ENV_C6 = _core_.PAPER_ENV_C6
483PAPER_ENV_C65 = _core_.PAPER_ENV_C65
484PAPER_ENV_B4 = _core_.PAPER_ENV_B4
485PAPER_ENV_B5 = _core_.PAPER_ENV_B5
486PAPER_ENV_B6 = _core_.PAPER_ENV_B6
487PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
488PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
489PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
490PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
491PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
492PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
493PAPER_ISO_B4 = _core_.PAPER_ISO_B4
494PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
495PAPER_9X11 = _core_.PAPER_9X11
496PAPER_10X11 = _core_.PAPER_10X11
497PAPER_15X11 = _core_.PAPER_15X11
498PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
499PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
500PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
501PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
502PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
503PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
504PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
505PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
506PAPER_A_PLUS = _core_.PAPER_A_PLUS
507PAPER_B_PLUS = _core_.PAPER_B_PLUS
508PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
509PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
510PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
511PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
512PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
513PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
514PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
515PAPER_A2 = _core_.PAPER_A2
516PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
517PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
518DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
519DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
520DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
521ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
522ITEM_NORMAL = _core_.ITEM_NORMAL
523ITEM_CHECK = _core_.ITEM_CHECK
524ITEM_RADIO = _core_.ITEM_RADIO
525ITEM_MAX = _core_.ITEM_MAX
526HT_NOWHERE = _core_.HT_NOWHERE
527HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
528HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
529HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
530HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
531HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
532HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
533HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
534HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
535HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
536HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
537HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
538HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
539HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
540HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
541HT_MAX = _core_.HT_MAX
542MOD_NONE = _core_.MOD_NONE
543MOD_ALT = _core_.MOD_ALT
544MOD_CONTROL = _core_.MOD_CONTROL
545MOD_SHIFT = _core_.MOD_SHIFT
546MOD_WIN = _core_.MOD_WIN
547UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
548UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
549UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
d14a1e28
RD
550#---------------------------------------------------------------------------
551
552class Object(object):
0df68c9f
RD
553 """
554 The base class for most wx objects, although in wxPython not
555 much functionality is needed nor exposed.
556 """
d14a1e28
RD
557 def __init__(self): raise RuntimeError, "No constructor defined"
558 def __repr__(self):
559 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 560 def GetClassName(*args, **kwargs):
0df68c9f 561 """
a95a7133 562 GetClassName(self) -> String
e811c8ce 563
a95a7133 564 Returns the class name of the C++ class using wxRTTI.
0df68c9f 565 """
54f9ee45 566 return _core_.Object_GetClassName(*args, **kwargs)
e811c8ce
RD
567
568 def Destroy(*args, **kwargs):
0df68c9f 569 """
a95a7133 570 Destroy(self)
e811c8ce 571
0df68c9f
RD
572 Deletes the C++ object this Python object is a proxy for.
573 """
54f9ee45 574 return _core_.Object_Destroy(*args, **kwargs)
e811c8ce 575
d14a1e28
RD
576
577class ObjectPtr(Object):
578 def __init__(self, this):
579 self.this = this
580 if not hasattr(self,"thisown"): self.thisown = 0
581 self.__class__ = Object
54f9ee45
RD
582_core_.Object_swigregister(ObjectPtr)
583_wxPySetDictionary = _core_._wxPySetDictionary
d14a1e28 584
54f9ee45 585_wxPyFixStockObjects = _core_._wxPyFixStockObjects
3a04f143 586
54f9ee45 587cvar = _core_.cvar
196addbf 588EmptyString = cvar.EmptyString
d14a1e28
RD
589
590#---------------------------------------------------------------------------
591
54f9ee45
RD
592BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
593BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
594BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
595BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
596BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
597BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
598BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
599BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
600BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
601BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
602BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
603BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
604BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
605BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
606BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
607BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
608BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
609BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
610BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
611BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
612CURSOR_NONE = _core_.CURSOR_NONE
613CURSOR_ARROW = _core_.CURSOR_ARROW
614CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
615CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
616CURSOR_CHAR = _core_.CURSOR_CHAR
617CURSOR_CROSS = _core_.CURSOR_CROSS
618CURSOR_HAND = _core_.CURSOR_HAND
619CURSOR_IBEAM = _core_.CURSOR_IBEAM
620CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
621CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
622CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
623CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
624CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
625CURSOR_PENCIL = _core_.CURSOR_PENCIL
626CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
627CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
628CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
629CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
630CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
631CURSOR_SIZENS = _core_.CURSOR_SIZENS
632CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
633CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
634CURSOR_SIZING = _core_.CURSOR_SIZING
635CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
636CURSOR_WAIT = _core_.CURSOR_WAIT
637CURSOR_WATCH = _core_.CURSOR_WATCH
638CURSOR_BLANK = _core_.CURSOR_BLANK
639CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
640CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
641CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
642CURSOR_MAX = _core_.CURSOR_MAX
d14a1e28
RD
643#---------------------------------------------------------------------------
644
645class Size(object):
0df68c9f 646 """
41e2b43e
RD
647 wx.Size is a useful data structure used to represent the size of
648 something. It simply contians integer width and height proprtites.
649 In most places in wxPython where a wx.Size is expected a
650 (width,height) tuple can be used instead.
0df68c9f 651 """
e811c8ce
RD
652 def __repr__(self):
653 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
654 width = property(_core_.Size_width_get, _core_.Size_width_set)
655 height = property(_core_.Size_height_get, _core_.Size_height_set)
242b7b46 656 x = width; y = height
d14a1e28 657 def __init__(self, *args, **kwargs):
0df68c9f 658 """
a95a7133 659 __init__(self, int w=0, int h=0) -> Size
e811c8ce 660
0df68c9f
RD
661 Creates a size object.
662 """
54f9ee45 663 newobj = _core_.new_Size(*args, **kwargs)
d14a1e28
RD
664 self.this = newobj.this
665 self.thisown = 1
666 del newobj.thisown
54f9ee45 667 def __del__(self, destroy=_core_.delete_Size):
a95a7133 668 """__del__(self)"""
d14a1e28
RD
669 try:
670 if self.thisown: destroy(self)
671 except: pass
e811c8ce
RD
672
673 def __eq__(*args, **kwargs):
0df68c9f 674 """
a95a7133 675 __eq__(self, Size sz) -> bool
e811c8ce 676
0df68c9f
RD
677 Test for equality of wx.Size objects.
678 """
54f9ee45 679 return _core_.Size___eq__(*args, **kwargs)
e811c8ce
RD
680
681 def __ne__(*args, **kwargs):
0df68c9f 682 """
a95a7133 683 __ne__(self, Size sz) -> bool
e811c8ce 684
0df68c9f
RD
685 Test for inequality.
686 """
54f9ee45 687 return _core_.Size___ne__(*args, **kwargs)
e811c8ce
RD
688
689 def __add__(*args, **kwargs):
0df68c9f 690 """
a95a7133 691 __add__(self, Size sz) -> Size
e811c8ce 692
0df68c9f
RD
693 Add sz's proprties to this and return the result.
694 """
54f9ee45 695 return _core_.Size___add__(*args, **kwargs)
e811c8ce
RD
696
697 def __sub__(*args, **kwargs):
0df68c9f 698 """
a95a7133 699 __sub__(self, Size sz) -> Size
e811c8ce 700
0df68c9f
RD
701 Subtract sz's properties from this and return the result.
702 """
54f9ee45 703 return _core_.Size___sub__(*args, **kwargs)
e811c8ce
RD
704
705 def IncTo(*args, **kwargs):
0df68c9f 706 """
a95a7133 707 IncTo(self, Size sz)
e811c8ce 708
0df68c9f
RD
709 Increments this object so that both of its dimensions are not less
710 than the corresponding dimensions of the size.
711 """
54f9ee45 712 return _core_.Size_IncTo(*args, **kwargs)
e811c8ce
RD
713
714 def DecTo(*args, **kwargs):
0df68c9f 715 """
a95a7133 716 DecTo(self, Size sz)
e811c8ce 717
0df68c9f
RD
718 Decrements this object so that both of its dimensions are not greater
719 than the corresponding dimensions of the size.
720 """
54f9ee45 721 return _core_.Size_DecTo(*args, **kwargs)
e811c8ce
RD
722
723 def Set(*args, **kwargs):
0df68c9f 724 """
a95a7133 725 Set(self, int w, int h)
e811c8ce 726
0df68c9f
RD
727 Set both width and height.
728 """
54f9ee45 729 return _core_.Size_Set(*args, **kwargs)
e811c8ce
RD
730
731 def SetWidth(*args, **kwargs):
a95a7133 732 """SetWidth(self, int w)"""
54f9ee45 733 return _core_.Size_SetWidth(*args, **kwargs)
e811c8ce
RD
734
735 def SetHeight(*args, **kwargs):
a95a7133 736 """SetHeight(self, int h)"""
54f9ee45 737 return _core_.Size_SetHeight(*args, **kwargs)
e811c8ce
RD
738
739 def GetWidth(*args, **kwargs):
a95a7133 740 """GetWidth(self) -> int"""
54f9ee45 741 return _core_.Size_GetWidth(*args, **kwargs)
e811c8ce
RD
742
743 def GetHeight(*args, **kwargs):
a95a7133 744 """GetHeight(self) -> int"""
54f9ee45 745 return _core_.Size_GetHeight(*args, **kwargs)
e811c8ce 746
74a57fcd
RD
747 def IsFullySpecified(*args, **kwargs):
748 """
a95a7133 749 IsFullySpecified(self) -> bool
74a57fcd
RD
750
751 Returns True if both components of the size are non-default values.
752 """
54f9ee45 753 return _core_.Size_IsFullySpecified(*args, **kwargs)
74a57fcd
RD
754
755 def SetDefaults(*args, **kwargs):
756 """
a95a7133 757 SetDefaults(self, Size size)
74a57fcd 758
41e2b43e
RD
759 Combine this size with the other one replacing the default components
760 of this object (i.e. equal to -1) with those of the other.
74a57fcd 761 """
54f9ee45 762 return _core_.Size_SetDefaults(*args, **kwargs)
74a57fcd 763
e811c8ce 764 def Get(*args, **kwargs):
0df68c9f
RD
765 """
766 Get() -> (width,height)
e811c8ce 767
0df68c9f
RD
768 Returns the width and height properties as a tuple.
769 """
54f9ee45 770 return _core_.Size_Get(*args, **kwargs)
e811c8ce 771
41e2b43e 772 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
773 def __str__(self): return str(self.Get())
774 def __repr__(self): return 'wx.Size'+str(self.Get())
775 def __len__(self): return len(self.Get())
776 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
777 def __setitem__(self, index, val):
778 if index == 0: self.width = val
779 elif index == 1: self.height = val
780 else: raise IndexError
e811c8ce 781 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
782 __safe_for_unpickling__ = True
783 def __reduce__(self): return (wx.Size, self.Get())
d14a1e28
RD
784
785
786class SizePtr(Size):
787 def __init__(self, this):
788 self.this = this
789 if not hasattr(self,"thisown"): self.thisown = 0
790 self.__class__ = Size
54f9ee45 791_core_.Size_swigregister(SizePtr)
d14a1e28
RD
792
793#---------------------------------------------------------------------------
794
795class RealPoint(object):
0df68c9f 796 """
41e2b43e
RD
797 A data structure for representing a point or position with floating
798 point x and y properties. In wxPython most places that expect a
799 wx.RealPoint can also accept a (x,y) tuple.
0df68c9f 800 """
e811c8ce
RD
801 def __repr__(self):
802 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
803 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
804 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
d14a1e28 805 def __init__(self, *args, **kwargs):
0df68c9f 806 """
a95a7133 807 __init__(self, double x=0.0, double y=0.0) -> RealPoint
e811c8ce 808
0df68c9f
RD
809 Create a wx.RealPoint object
810 """
54f9ee45 811 newobj = _core_.new_RealPoint(*args, **kwargs)
d14a1e28
RD
812 self.this = newobj.this
813 self.thisown = 1
814 del newobj.thisown
54f9ee45 815 def __del__(self, destroy=_core_.delete_RealPoint):
a95a7133 816 """__del__(self)"""
d14a1e28
RD
817 try:
818 if self.thisown: destroy(self)
819 except: pass
e811c8ce
RD
820
821 def __eq__(*args, **kwargs):
0df68c9f 822 """
a95a7133 823 __eq__(self, RealPoint pt) -> bool
e811c8ce 824
0df68c9f
RD
825 Test for equality of wx.RealPoint objects.
826 """
54f9ee45 827 return _core_.RealPoint___eq__(*args, **kwargs)
e811c8ce
RD
828
829 def __ne__(*args, **kwargs):
0df68c9f 830 """
a95a7133 831 __ne__(self, RealPoint pt) -> bool
e811c8ce 832
0df68c9f
RD
833 Test for inequality of wx.RealPoint objects.
834 """
54f9ee45 835 return _core_.RealPoint___ne__(*args, **kwargs)
e811c8ce
RD
836
837 def __add__(*args, **kwargs):
0df68c9f 838 """
a95a7133 839 __add__(self, RealPoint pt) -> RealPoint
e811c8ce 840
0df68c9f
RD
841 Add pt's proprties to this and return the result.
842 """
54f9ee45 843 return _core_.RealPoint___add__(*args, **kwargs)
e811c8ce
RD
844
845 def __sub__(*args, **kwargs):
0df68c9f 846 """
a95a7133 847 __sub__(self, RealPoint pt) -> RealPoint
e811c8ce 848
0df68c9f
RD
849 Subtract pt's proprties from this and return the result
850 """
54f9ee45 851 return _core_.RealPoint___sub__(*args, **kwargs)
e811c8ce
RD
852
853 def Set(*args, **kwargs):
0df68c9f 854 """
a95a7133 855 Set(self, double x, double y)
e811c8ce 856
0df68c9f
RD
857 Set both the x and y properties
858 """
54f9ee45 859 return _core_.RealPoint_Set(*args, **kwargs)
e811c8ce
RD
860
861 def Get(*args, **kwargs):
0df68c9f
RD
862 """
863 Get() -> (x,y)
e811c8ce 864
0df68c9f
RD
865 Return the x and y properties as a tuple.
866 """
54f9ee45 867 return _core_.RealPoint_Get(*args, **kwargs)
e811c8ce 868
41e2b43e 869 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
870 def __str__(self): return str(self.Get())
871 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
872 def __len__(self): return len(self.Get())
873 def __getitem__(self, index): return self.Get()[index]
d14a1e28 874 def __setitem__(self, index, val):
e811c8ce
RD
875 if index == 0: self.x = val
876 elif index == 1: self.y = val
d14a1e28 877 else: raise IndexError
e811c8ce 878 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
879 __safe_for_unpickling__ = True
880 def __reduce__(self): return (wx.RealPoint, self.Get())
d14a1e28
RD
881
882
883class RealPointPtr(RealPoint):
884 def __init__(self, this):
885 self.this = this
886 if not hasattr(self,"thisown"): self.thisown = 0
887 self.__class__ = RealPoint
54f9ee45 888_core_.RealPoint_swigregister(RealPointPtr)
d14a1e28
RD
889
890#---------------------------------------------------------------------------
891
892class Point(object):
0df68c9f 893 """
41e2b43e
RD
894 A data structure for representing a point or position with integer x
895 and y properties. Most places in wxPython that expect a wx.Point can
896 also accept a (x,y) tuple.
0df68c9f 897 """
e811c8ce
RD
898 def __repr__(self):
899 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
900 x = property(_core_.Point_x_get, _core_.Point_x_set)
901 y = property(_core_.Point_y_get, _core_.Point_y_set)
d14a1e28 902 def __init__(self, *args, **kwargs):
0df68c9f 903 """
a95a7133 904 __init__(self, int x=0, int y=0) -> Point
e811c8ce 905
0df68c9f
RD
906 Create a wx.Point object
907 """
54f9ee45 908 newobj = _core_.new_Point(*args, **kwargs)
d14a1e28
RD
909 self.this = newobj.this
910 self.thisown = 1
911 del newobj.thisown
54f9ee45 912 def __del__(self, destroy=_core_.delete_Point):
a95a7133 913 """__del__(self)"""
d14a1e28
RD
914 try:
915 if self.thisown: destroy(self)
916 except: pass
e811c8ce
RD
917
918 def __eq__(*args, **kwargs):
0df68c9f 919 """
a95a7133 920 __eq__(self, Point pt) -> bool
e811c8ce 921
0df68c9f
RD
922 Test for equality of wx.Point objects.
923 """
54f9ee45 924 return _core_.Point___eq__(*args, **kwargs)
e811c8ce
RD
925
926 def __ne__(*args, **kwargs):
0df68c9f 927 """
a95a7133 928 __ne__(self, Point pt) -> bool
e811c8ce 929
0df68c9f
RD
930 Test for inequality of wx.Point objects.
931 """
54f9ee45 932 return _core_.Point___ne__(*args, **kwargs)
e811c8ce
RD
933
934 def __add__(*args, **kwargs):
0df68c9f 935 """
a95a7133 936 __add__(self, Point pt) -> Point
e811c8ce 937
0df68c9f
RD
938 Add pt's proprties to this and return the result.
939 """
54f9ee45 940 return _core_.Point___add__(*args, **kwargs)
e811c8ce
RD
941
942 def __sub__(*args, **kwargs):
0df68c9f 943 """
a95a7133 944 __sub__(self, Point pt) -> Point
e811c8ce 945
0df68c9f
RD
946 Subtract pt's proprties from this and return the result
947 """
54f9ee45 948 return _core_.Point___sub__(*args, **kwargs)
e811c8ce
RD
949
950 def __iadd__(*args, **kwargs):
0df68c9f 951 """
a95a7133 952 __iadd__(self, Point pt) -> Point
e811c8ce 953
0df68c9f
RD
954 Add pt to this object.
955 """
54f9ee45 956 return _core_.Point___iadd__(*args, **kwargs)
e811c8ce
RD
957
958 def __isub__(*args, **kwargs):
0df68c9f 959 """
a95a7133 960 __isub__(self, Point pt) -> Point
e811c8ce 961
0df68c9f
RD
962 Subtract pt from this object.
963 """
54f9ee45 964 return _core_.Point___isub__(*args, **kwargs)
e811c8ce
RD
965
966 def Set(*args, **kwargs):
0df68c9f 967 """
a95a7133 968 Set(self, long x, long y)
e811c8ce 969
0df68c9f
RD
970 Set both the x and y properties
971 """
54f9ee45 972 return _core_.Point_Set(*args, **kwargs)
e811c8ce
RD
973
974 def Get(*args, **kwargs):
0df68c9f
RD
975 """
976 Get() -> (x,y)
e811c8ce 977
0df68c9f
RD
978 Return the x and y properties as a tuple.
979 """
54f9ee45 980 return _core_.Point_Get(*args, **kwargs)
e811c8ce 981
41e2b43e 982 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
983 def __str__(self): return str(self.Get())
984 def __repr__(self): return 'wx.Point'+str(self.Get())
985 def __len__(self): return len(self.Get())
986 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
987 def __setitem__(self, index, val):
988 if index == 0: self.x = val
989 elif index == 1: self.y = val
990 else: raise IndexError
e811c8ce 991 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
992 __safe_for_unpickling__ = True
993 def __reduce__(self): return (wx.Point, self.Get())
d14a1e28
RD
994
995
996class PointPtr(Point):
997 def __init__(self, this):
998 self.this = this
999 if not hasattr(self,"thisown"): self.thisown = 0
1000 self.__class__ = Point
54f9ee45 1001_core_.Point_swigregister(PointPtr)
d14a1e28
RD
1002
1003#---------------------------------------------------------------------------
1004
1005class Rect(object):
0df68c9f 1006 """
41e2b43e
RD
1007 A class for representing and manipulating rectangles. It has x, y,
1008 width and height properties. In wxPython most palces that expect a
1009 wx.Rect can also accept a (x,y,width,height) tuple.
0df68c9f 1010 """
e811c8ce
RD
1011 def __repr__(self):
1012 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1013 def __init__(self, *args, **kwargs):
0df68c9f 1014 """
a95a7133 1015 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
e811c8ce 1016
0df68c9f
RD
1017 Create a new Rect object.
1018 """
54f9ee45 1019 newobj = _core_.new_Rect(*args, **kwargs)
d14a1e28
RD
1020 self.this = newobj.this
1021 self.thisown = 1
1022 del newobj.thisown
54f9ee45 1023 def __del__(self, destroy=_core_.delete_Rect):
a95a7133 1024 """__del__(self)"""
d14a1e28
RD
1025 try:
1026 if self.thisown: destroy(self)
1027 except: pass
e811c8ce
RD
1028
1029 def GetX(*args, **kwargs):
a95a7133 1030 """GetX(self) -> int"""
54f9ee45 1031 return _core_.Rect_GetX(*args, **kwargs)
e811c8ce
RD
1032
1033 def SetX(*args, **kwargs):
a95a7133 1034 """SetX(self, int x)"""
54f9ee45 1035 return _core_.Rect_SetX(*args, **kwargs)
e811c8ce
RD
1036
1037 def GetY(*args, **kwargs):
a95a7133 1038 """GetY(self) -> int"""
54f9ee45 1039 return _core_.Rect_GetY(*args, **kwargs)
e811c8ce
RD
1040
1041 def SetY(*args, **kwargs):
a95a7133 1042 """SetY(self, int y)"""
54f9ee45 1043 return _core_.Rect_SetY(*args, **kwargs)
e811c8ce
RD
1044
1045 def GetWidth(*args, **kwargs):
a95a7133 1046 """GetWidth(self) -> int"""
54f9ee45 1047 return _core_.Rect_GetWidth(*args, **kwargs)
e811c8ce
RD
1048
1049 def SetWidth(*args, **kwargs):
a95a7133 1050 """SetWidth(self, int w)"""
54f9ee45 1051 return _core_.Rect_SetWidth(*args, **kwargs)
e811c8ce
RD
1052
1053 def GetHeight(*args, **kwargs):
a95a7133 1054 """GetHeight(self) -> int"""
54f9ee45 1055 return _core_.Rect_GetHeight(*args, **kwargs)
e811c8ce
RD
1056
1057 def SetHeight(*args, **kwargs):
a95a7133 1058 """SetHeight(self, int h)"""
54f9ee45 1059 return _core_.Rect_SetHeight(*args, **kwargs)
e811c8ce
RD
1060
1061 def GetPosition(*args, **kwargs):
a95a7133 1062 """GetPosition(self) -> Point"""
54f9ee45 1063 return _core_.Rect_GetPosition(*args, **kwargs)
e811c8ce
RD
1064
1065 def SetPosition(*args, **kwargs):
a95a7133 1066 """SetPosition(self, Point p)"""
54f9ee45 1067 return _core_.Rect_SetPosition(*args, **kwargs)
e811c8ce
RD
1068
1069 def GetSize(*args, **kwargs):
a95a7133 1070 """GetSize(self) -> Size"""
54f9ee45 1071 return _core_.Rect_GetSize(*args, **kwargs)
e811c8ce
RD
1072
1073 def SetSize(*args, **kwargs):
a95a7133 1074 """SetSize(self, Size s)"""
54f9ee45 1075 return _core_.Rect_SetSize(*args, **kwargs)
e811c8ce 1076
c9c7117a 1077 def GetTopLeft(*args, **kwargs):
a95a7133 1078 """GetTopLeft(self) -> Point"""
54f9ee45 1079 return _core_.Rect_GetTopLeft(*args, **kwargs)
c9c7117a
RD
1080
1081 def SetTopLeft(*args, **kwargs):
a95a7133 1082 """SetTopLeft(self, Point p)"""
54f9ee45 1083 return _core_.Rect_SetTopLeft(*args, **kwargs)
c9c7117a
RD
1084
1085 def GetBottomRight(*args, **kwargs):
a95a7133 1086 """GetBottomRight(self) -> Point"""
54f9ee45 1087 return _core_.Rect_GetBottomRight(*args, **kwargs)
c9c7117a
RD
1088
1089 def SetBottomRight(*args, **kwargs):
a95a7133 1090 """SetBottomRight(self, Point p)"""
54f9ee45 1091 return _core_.Rect_SetBottomRight(*args, **kwargs)
c9c7117a 1092
e811c8ce 1093 def GetLeft(*args, **kwargs):
a95a7133 1094 """GetLeft(self) -> int"""
54f9ee45 1095 return _core_.Rect_GetLeft(*args, **kwargs)
e811c8ce
RD
1096
1097 def GetTop(*args, **kwargs):
a95a7133 1098 """GetTop(self) -> int"""
54f9ee45 1099 return _core_.Rect_GetTop(*args, **kwargs)
e811c8ce
RD
1100
1101 def GetBottom(*args, **kwargs):
a95a7133 1102 """GetBottom(self) -> int"""
54f9ee45 1103 return _core_.Rect_GetBottom(*args, **kwargs)
e811c8ce
RD
1104
1105 def GetRight(*args, **kwargs):
a95a7133 1106 """GetRight(self) -> int"""
54f9ee45 1107 return _core_.Rect_GetRight(*args, **kwargs)
e811c8ce
RD
1108
1109 def SetLeft(*args, **kwargs):
a95a7133 1110 """SetLeft(self, int left)"""
54f9ee45 1111 return _core_.Rect_SetLeft(*args, **kwargs)
e811c8ce
RD
1112
1113 def SetRight(*args, **kwargs):
a95a7133 1114 """SetRight(self, int right)"""
54f9ee45 1115 return _core_.Rect_SetRight(*args, **kwargs)
e811c8ce
RD
1116
1117 def SetTop(*args, **kwargs):
a95a7133 1118 """SetTop(self, int top)"""
54f9ee45 1119 return _core_.Rect_SetTop(*args, **kwargs)
e811c8ce
RD
1120
1121 def SetBottom(*args, **kwargs):
a95a7133 1122 """SetBottom(self, int bottom)"""
54f9ee45 1123 return _core_.Rect_SetBottom(*args, **kwargs)
e811c8ce
RD
1124
1125 position = property(GetPosition, SetPosition)
1126 size = property(GetSize, SetSize)
1127 left = property(GetLeft, SetLeft)
1128 right = property(GetRight, SetRight)
1129 top = property(GetTop, SetTop)
1130 bottom = property(GetBottom, SetBottom)
1131
1132 def Inflate(*args, **kwargs):
0df68c9f 1133 """
a95a7133 1134 Inflate(self, int dx, int dy) -> Rect
e811c8ce 1135
41e2b43e
RD
1136 Increase the rectangle size by dx in x direction and dy in y
1137 direction. Both or one of) parameters may be negative to decrease the
1138 rectangle size.
0df68c9f 1139 """
54f9ee45 1140 return _core_.Rect_Inflate(*args, **kwargs)
e811c8ce
RD
1141
1142 def Deflate(*args, **kwargs):
0df68c9f 1143 """
a95a7133 1144 Deflate(self, int dx, int dy) -> Rect
e811c8ce 1145
41e2b43e
RD
1146 Decrease the rectangle size by dx in x direction and dy in y
1147 direction. Both or one of) parameters may be negative to increase the
1148 rectngle size. This method is the opposite of Inflate.
0df68c9f 1149 """
54f9ee45 1150 return _core_.Rect_Deflate(*args, **kwargs)
e811c8ce
RD
1151
1152 def OffsetXY(*args, **kwargs):
0df68c9f 1153 """
a95a7133 1154 OffsetXY(self, int dx, int dy)
e811c8ce 1155
41e2b43e
RD
1156 Moves the rectangle by the specified offset. If dx is positive, the
1157 rectangle is moved to the right, if dy is positive, it is moved to the
1158 bottom, otherwise it is moved to the left or top respectively.
0df68c9f 1159 """
54f9ee45 1160 return _core_.Rect_OffsetXY(*args, **kwargs)
e811c8ce
RD
1161
1162 def Offset(*args, **kwargs):
0df68c9f 1163 """
a95a7133 1164 Offset(self, Point pt)
e811c8ce 1165
0df68c9f
RD
1166 Same as OffsetXY but uses dx,dy from Point
1167 """
54f9ee45 1168 return _core_.Rect_Offset(*args, **kwargs)
e811c8ce
RD
1169
1170 def Intersect(*args, **kwargs):
0df68c9f 1171 """
a95a7133 1172 Intersect(self, Rect rect) -> Rect
e811c8ce 1173
0df68c9f
RD
1174 Return the intersectsion of this rectangle and rect.
1175 """
54f9ee45 1176 return _core_.Rect_Intersect(*args, **kwargs)
e811c8ce
RD
1177
1178 def __add__(*args, **kwargs):
0df68c9f 1179 """
a95a7133 1180 __add__(self, Rect rect) -> Rect
e811c8ce 1181
0df68c9f
RD
1182 Add the properties of rect to this rectangle and return the result.
1183 """
54f9ee45 1184 return _core_.Rect___add__(*args, **kwargs)
e811c8ce
RD
1185
1186 def __iadd__(*args, **kwargs):
0df68c9f 1187 """
a95a7133 1188 __iadd__(self, Rect rect) -> Rect
e811c8ce 1189
0df68c9f
RD
1190 Add the properties of rect to this rectangle, updating this rectangle.
1191 """
54f9ee45 1192 return _core_.Rect___iadd__(*args, **kwargs)
e811c8ce
RD
1193
1194 def __eq__(*args, **kwargs):
0df68c9f 1195 """
a95a7133 1196 __eq__(self, Rect rect) -> bool
e811c8ce 1197
0df68c9f
RD
1198 Test for equality.
1199 """
54f9ee45 1200 return _core_.Rect___eq__(*args, **kwargs)
e811c8ce
RD
1201
1202 def __ne__(*args, **kwargs):
0df68c9f 1203 """
a95a7133 1204 __ne__(self, Rect rect) -> bool
e811c8ce 1205
0df68c9f
RD
1206 Test for inequality.
1207 """
54f9ee45 1208 return _core_.Rect___ne__(*args, **kwargs)
e811c8ce
RD
1209
1210 def InsideXY(*args, **kwargs):
0df68c9f 1211 """
a95a7133 1212 InsideXY(self, int x, int y) -> bool
e811c8ce 1213
0df68c9f
RD
1214 Return True if the point is (not strcitly) inside the rect.
1215 """
54f9ee45 1216 return _core_.Rect_InsideXY(*args, **kwargs)
e811c8ce
RD
1217
1218 def Inside(*args, **kwargs):
0df68c9f 1219 """
a95a7133 1220 Inside(self, Point pt) -> bool
e811c8ce 1221
0df68c9f
RD
1222 Return True if the point is (not strcitly) inside the rect.
1223 """
54f9ee45 1224 return _core_.Rect_Inside(*args, **kwargs)
e811c8ce
RD
1225
1226 def Intersects(*args, **kwargs):
0df68c9f 1227 """
a95a7133 1228 Intersects(self, Rect rect) -> bool
e811c8ce 1229
0df68c9f
RD
1230 Returns True if the rectangles have a non empty intersection.
1231 """
54f9ee45 1232 return _core_.Rect_Intersects(*args, **kwargs)
e811c8ce 1233
54f9ee45
RD
1234 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1235 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1236 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1237 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
e811c8ce 1238 def Set(*args, **kwargs):
0df68c9f 1239 """
a95a7133 1240 Set(self, int x=0, int y=0, int width=0, int height=0)
e811c8ce 1241
0df68c9f
RD
1242 Set all rectangle properties.
1243 """
54f9ee45 1244 return _core_.Rect_Set(*args, **kwargs)
e811c8ce
RD
1245
1246 def Get(*args, **kwargs):
0df68c9f
RD
1247 """
1248 Get() -> (x,y,width,height)
e811c8ce 1249
0df68c9f
RD
1250 Return the rectangle properties as a tuple.
1251 """
54f9ee45 1252 return _core_.Rect_Get(*args, **kwargs)
e811c8ce 1253
41e2b43e 1254 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1255 def __str__(self): return str(self.Get())
1256 def __repr__(self): return 'wx.Rect'+str(self.Get())
1257 def __len__(self): return len(self.Get())
1258 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
1259 def __setitem__(self, index, val):
1260 if index == 0: self.x = val
1261 elif index == 1: self.y = val
1262 elif index == 2: self.width = val
1263 elif index == 3: self.height = val
1264 else: raise IndexError
e811c8ce 1265 def __nonzero__(self): return self.Get() != (0,0,0,0)
74e96f3d
RD
1266 __safe_for_unpickling__ = True
1267 def __reduce__(self): return (wx.Rect, self.Get())
d14a1e28
RD
1268
1269
1270class RectPtr(Rect):
1271 def __init__(self, this):
1272 self.this = this
1273 if not hasattr(self,"thisown"): self.thisown = 0
1274 self.__class__ = Rect
54f9ee45 1275_core_.Rect_swigregister(RectPtr)
d14a1e28
RD
1276
1277def RectPP(*args, **kwargs):
0df68c9f
RD
1278 """
1279 RectPP(Point topLeft, Point bottomRight) -> Rect
e811c8ce 1280
0df68c9f
RD
1281 Create a new Rect object from Points representing two corners.
1282 """
54f9ee45 1283 val = _core_.new_RectPP(*args, **kwargs)
d14a1e28
RD
1284 val.thisown = 1
1285 return val
1286
1287def RectPS(*args, **kwargs):
0df68c9f
RD
1288 """
1289 RectPS(Point pos, Size size) -> Rect
e811c8ce 1290
0df68c9f
RD
1291 Create a new Rect from a position and size.
1292 """
54f9ee45 1293 val = _core_.new_RectPS(*args, **kwargs)
d14a1e28
RD
1294 val.thisown = 1
1295 return val
1296
1297
e811c8ce 1298def IntersectRect(*args, **kwargs):
0df68c9f
RD
1299 """
1300 IntersectRect(Rect r1, Rect r2) -> Rect
e811c8ce 1301
0df68c9f
RD
1302 Calculate and return the intersection of r1 and r2.
1303 """
54f9ee45 1304 return _core_.IntersectRect(*args, **kwargs)
d14a1e28
RD
1305#---------------------------------------------------------------------------
1306
1307class Point2D(object):
41e2b43e
RD
1308 """
1309 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1310 with floating point values.
1311 """
e811c8ce
RD
1312 def __repr__(self):
1313 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1314 def __init__(self, *args, **kwargs):
0df68c9f 1315 """
a95a7133 1316 __init__(self, double x=0.0, double y=0.0) -> Point2D
e811c8ce 1317
0df68c9f
RD
1318 Create a w.Point2D object.
1319 """
54f9ee45 1320 newobj = _core_.new_Point2D(*args, **kwargs)
d14a1e28
RD
1321 self.this = newobj.this
1322 self.thisown = 1
1323 del newobj.thisown
e811c8ce 1324 def GetFloor(*args, **kwargs):
fd2dc343
RD
1325 """
1326 GetFloor() -> (x,y)
1327
1328 Convert to integer
1329 """
54f9ee45 1330 return _core_.Point2D_GetFloor(*args, **kwargs)
e811c8ce
RD
1331
1332 def GetRounded(*args, **kwargs):
fd2dc343
RD
1333 """
1334 GetRounded() -> (x,y)
1335
1336 Convert to integer
1337 """
54f9ee45 1338 return _core_.Point2D_GetRounded(*args, **kwargs)
e811c8ce
RD
1339
1340 def GetVectorLength(*args, **kwargs):
a95a7133 1341 """GetVectorLength(self) -> double"""
54f9ee45 1342 return _core_.Point2D_GetVectorLength(*args, **kwargs)
e811c8ce
RD
1343
1344 def GetVectorAngle(*args, **kwargs):
a95a7133 1345 """GetVectorAngle(self) -> double"""
54f9ee45 1346 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
e811c8ce
RD
1347
1348 def SetVectorLength(*args, **kwargs):
a95a7133 1349 """SetVectorLength(self, double length)"""
54f9ee45 1350 return _core_.Point2D_SetVectorLength(*args, **kwargs)
e811c8ce
RD
1351
1352 def SetVectorAngle(*args, **kwargs):
a95a7133 1353 """SetVectorAngle(self, double degrees)"""
54f9ee45 1354 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
e811c8ce 1355
d14a1e28
RD
1356 def SetPolarCoordinates(self, angle, length):
1357 self.SetVectorLength(length)
1358 self.SetVectorAngle(angle)
1359 def Normalize(self):
1360 self.SetVectorLength(1.0)
1361
e811c8ce 1362 def GetDistance(*args, **kwargs):
a95a7133 1363 """GetDistance(self, Point2D pt) -> double"""
54f9ee45 1364 return _core_.Point2D_GetDistance(*args, **kwargs)
e811c8ce
RD
1365
1366 def GetDistanceSquare(*args, **kwargs):
a95a7133 1367 """GetDistanceSquare(self, Point2D pt) -> double"""
54f9ee45 1368 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
e811c8ce
RD
1369
1370 def GetDotProduct(*args, **kwargs):
a95a7133 1371 """GetDotProduct(self, Point2D vec) -> double"""
54f9ee45 1372 return _core_.Point2D_GetDotProduct(*args, **kwargs)
e811c8ce
RD
1373
1374 def GetCrossProduct(*args, **kwargs):
a95a7133 1375 """GetCrossProduct(self, Point2D vec) -> double"""
54f9ee45 1376 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
e811c8ce
RD
1377
1378 def __neg__(*args, **kwargs):
0df68c9f 1379 """
a95a7133 1380 __neg__(self) -> Point2D
e811c8ce 1381
0df68c9f
RD
1382 the reflection of this point
1383 """
54f9ee45 1384 return _core_.Point2D___neg__(*args, **kwargs)
e811c8ce
RD
1385
1386 def __iadd__(*args, **kwargs):
a95a7133 1387 """__iadd__(self, Point2D pt) -> Point2D"""
54f9ee45 1388 return _core_.Point2D___iadd__(*args, **kwargs)
e811c8ce
RD
1389
1390 def __isub__(*args, **kwargs):
a95a7133 1391 """__isub__(self, Point2D pt) -> Point2D"""
54f9ee45 1392 return _core_.Point2D___isub__(*args, **kwargs)
e811c8ce
RD
1393
1394 def __imul__(*args, **kwargs):
a95a7133 1395 """__imul__(self, Point2D pt) -> Point2D"""
54f9ee45 1396 return _core_.Point2D___imul__(*args, **kwargs)
e811c8ce
RD
1397
1398 def __idiv__(*args, **kwargs):
a95a7133 1399 """__idiv__(self, Point2D pt) -> Point2D"""
54f9ee45 1400 return _core_.Point2D___idiv__(*args, **kwargs)
e811c8ce
RD
1401
1402 def __eq__(*args, **kwargs):
0df68c9f 1403 """
a95a7133 1404 __eq__(self, Point2D pt) -> bool
e811c8ce 1405
0df68c9f
RD
1406 Test for equality
1407 """
54f9ee45 1408 return _core_.Point2D___eq__(*args, **kwargs)
e811c8ce
RD
1409
1410 def __ne__(*args, **kwargs):
0df68c9f 1411 """
a95a7133 1412 __ne__(self, Point2D pt) -> bool
e811c8ce 1413
0df68c9f
RD
1414 Test for inequality
1415 """
54f9ee45 1416 return _core_.Point2D___ne__(*args, **kwargs)
e811c8ce 1417
54f9ee45
RD
1418 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1419 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
e811c8ce 1420 def Set(*args, **kwargs):
a95a7133 1421 """Set(self, double x=0, double y=0)"""
54f9ee45 1422 return _core_.Point2D_Set(*args, **kwargs)
e811c8ce
RD
1423
1424 def Get(*args, **kwargs):
0df68c9f
RD
1425 """
1426 Get() -> (x,y)
e811c8ce 1427
0df68c9f
RD
1428 Return x and y properties as a tuple.
1429 """
54f9ee45 1430 return _core_.Point2D_Get(*args, **kwargs)
e811c8ce 1431
41e2b43e 1432 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
1433 def __str__(self): return str(self.Get())
1434 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1435 def __len__(self): return len(self.Get())
1436 def __getitem__(self, index): return self.Get()[index]
d14a1e28 1437 def __setitem__(self, index, val):
e811c8ce
RD
1438 if index == 0: self.x = val
1439 elif index == 1: self.y = val
d14a1e28 1440 else: raise IndexError
e811c8ce 1441 def __nonzero__(self): return self.Get() != (0.0, 0.0)
74e96f3d
RD
1442 __safe_for_unpickling__ = True
1443 def __reduce__(self): return (wx.Point2D, self.Get())
d14a1e28
RD
1444
1445
1446class Point2DPtr(Point2D):
1447 def __init__(self, this):
1448 self.this = this
1449 if not hasattr(self,"thisown"): self.thisown = 0
1450 self.__class__ = Point2D
54f9ee45 1451_core_.Point2D_swigregister(Point2DPtr)
d14a1e28
RD
1452
1453def Point2DCopy(*args, **kwargs):
0df68c9f
RD
1454 """
1455 Point2DCopy(Point2D pt) -> Point2D
e811c8ce 1456
0df68c9f
RD
1457 Create a w.Point2D object.
1458 """
54f9ee45 1459 val = _core_.new_Point2DCopy(*args, **kwargs)
d14a1e28
RD
1460 val.thisown = 1
1461 return val
1462
1463def Point2DFromPoint(*args, **kwargs):
0df68c9f
RD
1464 """
1465 Point2DFromPoint(Point pt) -> Point2D
e811c8ce 1466
0df68c9f
RD
1467 Create a w.Point2D object.
1468 """
54f9ee45 1469 val = _core_.new_Point2DFromPoint(*args, **kwargs)
d14a1e28
RD
1470 val.thisown = 1
1471 return val
1472
1473#---------------------------------------------------------------------------
1474
54f9ee45
RD
1475FromStart = _core_.FromStart
1476FromCurrent = _core_.FromCurrent
1477FromEnd = _core_.FromEnd
d14a1e28 1478class InputStream(object):
e811c8ce
RD
1479 def __repr__(self):
1480 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1481 def __init__(self, *args, **kwargs):
a95a7133 1482 """__init__(self, PyObject p) -> InputStream"""
54f9ee45 1483 newobj = _core_.new_InputStream(*args, **kwargs)
d14a1e28
RD
1484 self.this = newobj.this
1485 self.thisown = 1
1486 del newobj.thisown
e811c8ce 1487 def close(*args, **kwargs):
a95a7133 1488 """close(self)"""
54f9ee45 1489 return _core_.InputStream_close(*args, **kwargs)
e811c8ce
RD
1490
1491 def flush(*args, **kwargs):
a95a7133 1492 """flush(self)"""
54f9ee45 1493 return _core_.InputStream_flush(*args, **kwargs)
e811c8ce
RD
1494
1495 def eof(*args, **kwargs):
a95a7133 1496 """eof(self) -> bool"""
54f9ee45 1497 return _core_.InputStream_eof(*args, **kwargs)
e811c8ce
RD
1498
1499 def read(*args, **kwargs):
a95a7133 1500 """read(self, int size=-1) -> PyObject"""
54f9ee45 1501 return _core_.InputStream_read(*args, **kwargs)
e811c8ce
RD
1502
1503 def readline(*args, **kwargs):
a95a7133 1504 """readline(self, int size=-1) -> PyObject"""
54f9ee45 1505 return _core_.InputStream_readline(*args, **kwargs)
e811c8ce
RD
1506
1507 def readlines(*args, **kwargs):
a95a7133 1508 """readlines(self, int sizehint=-1) -> PyObject"""
54f9ee45 1509 return _core_.InputStream_readlines(*args, **kwargs)
e811c8ce
RD
1510
1511 def seek(*args, **kwargs):
a95a7133 1512 """seek(self, int offset, int whence=0)"""
54f9ee45 1513 return _core_.InputStream_seek(*args, **kwargs)
e811c8ce
RD
1514
1515 def tell(*args, **kwargs):
a95a7133 1516 """tell(self) -> int"""
54f9ee45 1517 return _core_.InputStream_tell(*args, **kwargs)
e811c8ce
RD
1518
1519 def Peek(*args, **kwargs):
a95a7133 1520 """Peek(self) -> char"""
54f9ee45 1521 return _core_.InputStream_Peek(*args, **kwargs)
e811c8ce
RD
1522
1523 def GetC(*args, **kwargs):
a95a7133 1524 """GetC(self) -> char"""
54f9ee45 1525 return _core_.InputStream_GetC(*args, **kwargs)
e811c8ce
RD
1526
1527 def LastRead(*args, **kwargs):
a95a7133 1528 """LastRead(self) -> size_t"""
54f9ee45 1529 return _core_.InputStream_LastRead(*args, **kwargs)
e811c8ce
RD
1530
1531 def CanRead(*args, **kwargs):
a95a7133 1532 """CanRead(self) -> bool"""
54f9ee45 1533 return _core_.InputStream_CanRead(*args, **kwargs)
e811c8ce
RD
1534
1535 def Eof(*args, **kwargs):
a95a7133 1536 """Eof(self) -> bool"""
54f9ee45 1537 return _core_.InputStream_Eof(*args, **kwargs)
e811c8ce
RD
1538
1539 def Ungetch(*args, **kwargs):
a95a7133 1540 """Ungetch(self, char c) -> bool"""
54f9ee45 1541 return _core_.InputStream_Ungetch(*args, **kwargs)
e811c8ce
RD
1542
1543 def SeekI(*args, **kwargs):
a95a7133 1544 """SeekI(self, long pos, int mode=FromStart) -> long"""
54f9ee45 1545 return _core_.InputStream_SeekI(*args, **kwargs)
e811c8ce
RD
1546
1547 def TellI(*args, **kwargs):
a95a7133 1548 """TellI(self) -> long"""
54f9ee45 1549 return _core_.InputStream_TellI(*args, **kwargs)
e811c8ce 1550
d14a1e28
RD
1551
1552class InputStreamPtr(InputStream):
1553 def __init__(self, this):
1554 self.this = this
1555 if not hasattr(self,"thisown"): self.thisown = 0
1556 self.__class__ = InputStream
54f9ee45 1557_core_.InputStream_swigregister(InputStreamPtr)
d14a1e28
RD
1558DefaultPosition = cvar.DefaultPosition
1559DefaultSize = cvar.DefaultSize
1560
1561class OutputStream(object):
d14a1e28
RD
1562 def __init__(self): raise RuntimeError, "No constructor defined"
1563 def __repr__(self):
1564 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1565 def write(*args, **kwargs):
a95a7133 1566 """write(self, PyObject obj)"""
54f9ee45 1567 return _core_.OutputStream_write(*args, **kwargs)
e811c8ce 1568
d14a1e28
RD
1569
1570class OutputStreamPtr(OutputStream):
1571 def __init__(self, this):
1572 self.this = this
1573 if not hasattr(self,"thisown"): self.thisown = 0
1574 self.__class__ = OutputStream
54f9ee45 1575_core_.OutputStream_swigregister(OutputStreamPtr)
d14a1e28
RD
1576
1577#---------------------------------------------------------------------------
1578
1579class FSFile(Object):
e811c8ce
RD
1580 def __repr__(self):
1581 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1582 def __init__(self, *args, **kwargs):
0df68c9f 1583 """
a95a7133 1584 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
196addbf 1585 DateTime modif) -> FSFile
0df68c9f 1586 """
54f9ee45 1587 newobj = _core_.new_FSFile(*args, **kwargs)
d14a1e28
RD
1588 self.this = newobj.this
1589 self.thisown = 1
1590 del newobj.thisown
54f9ee45 1591 def __del__(self, destroy=_core_.delete_FSFile):
a95a7133 1592 """__del__(self)"""
d14a1e28
RD
1593 try:
1594 if self.thisown: destroy(self)
1595 except: pass
e811c8ce
RD
1596
1597 def GetStream(*args, **kwargs):
a95a7133 1598 """GetStream(self) -> InputStream"""
54f9ee45 1599 return _core_.FSFile_GetStream(*args, **kwargs)
e811c8ce
RD
1600
1601 def GetMimeType(*args, **kwargs):
a95a7133 1602 """GetMimeType(self) -> String"""
54f9ee45 1603 return _core_.FSFile_GetMimeType(*args, **kwargs)
e811c8ce
RD
1604
1605 def GetLocation(*args, **kwargs):
a95a7133 1606 """GetLocation(self) -> String"""
54f9ee45 1607 return _core_.FSFile_GetLocation(*args, **kwargs)
e811c8ce
RD
1608
1609 def GetAnchor(*args, **kwargs):
a95a7133 1610 """GetAnchor(self) -> String"""
54f9ee45 1611 return _core_.FSFile_GetAnchor(*args, **kwargs)
e811c8ce
RD
1612
1613 def GetModificationTime(*args, **kwargs):
a95a7133 1614 """GetModificationTime(self) -> DateTime"""
54f9ee45 1615 return _core_.FSFile_GetModificationTime(*args, **kwargs)
e811c8ce 1616
d14a1e28
RD
1617
1618class FSFilePtr(FSFile):
1619 def __init__(self, this):
1620 self.this = this
1621 if not hasattr(self,"thisown"): self.thisown = 0
1622 self.__class__ = FSFile
54f9ee45 1623_core_.FSFile_swigregister(FSFilePtr)
d14a1e28
RD
1624
1625class CPPFileSystemHandler(object):
1626 def __init__(self): raise RuntimeError, "No constructor defined"
1627 def __repr__(self):
1628 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1629
1630class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1631 def __init__(self, this):
1632 self.this = this
1633 if not hasattr(self,"thisown"): self.thisown = 0
1634 self.__class__ = CPPFileSystemHandler
54f9ee45 1635_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
d14a1e28
RD
1636
1637class FileSystemHandler(CPPFileSystemHandler):
e811c8ce
RD
1638 def __repr__(self):
1639 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1640 def __init__(self, *args, **kwargs):
a95a7133 1641 """__init__(self) -> FileSystemHandler"""
54f9ee45 1642 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
d14a1e28
RD
1643 self.this = newobj.this
1644 self.thisown = 1
1645 del newobj.thisown
1646 self._setCallbackInfo(self, FileSystemHandler)
e811c8ce
RD
1647
1648 def _setCallbackInfo(*args, **kwargs):
a95a7133 1649 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 1650 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
1651
1652 def CanOpen(*args, **kwargs):
a95a7133 1653 """CanOpen(self, String location) -> bool"""
54f9ee45 1654 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1655
1656 def OpenFile(*args, **kwargs):
a95a7133 1657 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1658 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1659
1660 def FindFirst(*args, **kwargs):
a95a7133 1661 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1662 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1663
1664 def FindNext(*args, **kwargs):
a95a7133 1665 """FindNext(self) -> String"""
54f9ee45 1666 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
e811c8ce
RD
1667
1668 def GetProtocol(*args, **kwargs):
a95a7133 1669 """GetProtocol(self, String location) -> String"""
54f9ee45 1670 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
e811c8ce
RD
1671
1672 def GetLeftLocation(*args, **kwargs):
a95a7133 1673 """GetLeftLocation(self, String location) -> String"""
54f9ee45 1674 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
e811c8ce
RD
1675
1676 def GetAnchor(*args, **kwargs):
a95a7133 1677 """GetAnchor(self, String location) -> String"""
54f9ee45 1678 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
e811c8ce
RD
1679
1680 def GetRightLocation(*args, **kwargs):
a95a7133 1681 """GetRightLocation(self, String location) -> String"""
54f9ee45 1682 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
e811c8ce
RD
1683
1684 def GetMimeTypeFromExt(*args, **kwargs):
a95a7133 1685 """GetMimeTypeFromExt(self, String location) -> String"""
54f9ee45 1686 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
e811c8ce 1687
d14a1e28
RD
1688
1689class FileSystemHandlerPtr(FileSystemHandler):
1690 def __init__(self, this):
1691 self.this = this
1692 if not hasattr(self,"thisown"): self.thisown = 0
1693 self.__class__ = FileSystemHandler
54f9ee45 1694_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
d14a1e28
RD
1695
1696class FileSystem(Object):
e811c8ce
RD
1697 def __repr__(self):
1698 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1699 def __init__(self, *args, **kwargs):
a95a7133 1700 """__init__(self) -> FileSystem"""
54f9ee45 1701 newobj = _core_.new_FileSystem(*args, **kwargs)
d14a1e28
RD
1702 self.this = newobj.this
1703 self.thisown = 1
1704 del newobj.thisown
54f9ee45 1705 def __del__(self, destroy=_core_.delete_FileSystem):
a95a7133 1706 """__del__(self)"""
d14a1e28
RD
1707 try:
1708 if self.thisown: destroy(self)
1709 except: pass
e811c8ce
RD
1710
1711 def ChangePathTo(*args, **kwargs):
a95a7133 1712 """ChangePathTo(self, String location, bool is_dir=False)"""
54f9ee45 1713 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
e811c8ce
RD
1714
1715 def GetPath(*args, **kwargs):
a95a7133 1716 """GetPath(self) -> String"""
54f9ee45 1717 return _core_.FileSystem_GetPath(*args, **kwargs)
e811c8ce
RD
1718
1719 def OpenFile(*args, **kwargs):
a95a7133 1720 """OpenFile(self, String location) -> FSFile"""
54f9ee45 1721 return _core_.FileSystem_OpenFile(*args, **kwargs)
e811c8ce
RD
1722
1723 def FindFirst(*args, **kwargs):
a95a7133 1724 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1725 return _core_.FileSystem_FindFirst(*args, **kwargs)
e811c8ce
RD
1726
1727 def FindNext(*args, **kwargs):
a95a7133 1728 """FindNext(self) -> String"""
54f9ee45 1729 return _core_.FileSystem_FindNext(*args, **kwargs)
e811c8ce
RD
1730
1731 def AddHandler(*args, **kwargs):
66c033b4 1732 """AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1733 return _core_.FileSystem_AddHandler(*args, **kwargs)
e811c8ce
RD
1734
1735 AddHandler = staticmethod(AddHandler)
1736 def CleanUpHandlers(*args, **kwargs):
66c033b4 1737 """CleanUpHandlers()"""
54f9ee45 1738 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
e811c8ce
RD
1739
1740 CleanUpHandlers = staticmethod(CleanUpHandlers)
1741 def FileNameToURL(*args, **kwargs):
66c033b4 1742 """FileNameToURL(String filename) -> String"""
54f9ee45 1743 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
e811c8ce
RD
1744
1745 FileNameToURL = staticmethod(FileNameToURL)
d14a1e28
RD
1746
1747class FileSystemPtr(FileSystem):
1748 def __init__(self, this):
1749 self.this = this
1750 if not hasattr(self,"thisown"): self.thisown = 0
1751 self.__class__ = FileSystem
54f9ee45 1752_core_.FileSystem_swigregister(FileSystemPtr)
d14a1e28 1753
e811c8ce
RD
1754def FileSystem_AddHandler(*args, **kwargs):
1755 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
54f9ee45 1756 return _core_.FileSystem_AddHandler(*args, **kwargs)
d14a1e28 1757
e811c8ce
RD
1758def FileSystem_CleanUpHandlers(*args, **kwargs):
1759 """FileSystem_CleanUpHandlers()"""
54f9ee45 1760 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
d14a1e28 1761
e811c8ce 1762def FileSystem_FileNameToURL(*args, **kwargs):
196addbf 1763 """FileSystem_FileNameToURL(String filename) -> String"""
54f9ee45 1764 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
d14a1e28
RD
1765
1766
e811c8ce 1767def FileSystem_URLToFileName(*args, **kwargs):
196addbf 1768 """FileSystem_URLToFileName(String url) -> String"""
54f9ee45 1769 return _core_.FileSystem_URLToFileName(*args, **kwargs)
d14a1e28 1770class InternetFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1771 def __repr__(self):
1772 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1773 def __init__(self, *args, **kwargs):
a95a7133 1774 """__init__(self) -> InternetFSHandler"""
54f9ee45 1775 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
d14a1e28
RD
1776 self.this = newobj.this
1777 self.thisown = 1
1778 del newobj.thisown
e811c8ce 1779 def CanOpen(*args, **kwargs):
a95a7133 1780 """CanOpen(self, String location) -> bool"""
54f9ee45 1781 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1782
1783 def OpenFile(*args, **kwargs):
a95a7133 1784 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1785 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
e811c8ce 1786
d14a1e28
RD
1787
1788class InternetFSHandlerPtr(InternetFSHandler):
1789 def __init__(self, this):
1790 self.this = this
1791 if not hasattr(self,"thisown"): self.thisown = 0
1792 self.__class__ = InternetFSHandler
54f9ee45 1793_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
d14a1e28
RD
1794
1795class ZipFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1796 def __repr__(self):
1797 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1798 def __init__(self, *args, **kwargs):
a95a7133 1799 """__init__(self) -> ZipFSHandler"""
54f9ee45 1800 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
d14a1e28
RD
1801 self.this = newobj.this
1802 self.thisown = 1
1803 del newobj.thisown
e811c8ce 1804 def CanOpen(*args, **kwargs):
a95a7133 1805 """CanOpen(self, String location) -> bool"""
54f9ee45 1806 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1807
1808 def OpenFile(*args, **kwargs):
a95a7133 1809 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1810 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1811
1812 def FindFirst(*args, **kwargs):
a95a7133 1813 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1814 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1815
1816 def FindNext(*args, **kwargs):
a95a7133 1817 """FindNext(self) -> String"""
54f9ee45 1818 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
e811c8ce 1819
d14a1e28
RD
1820
1821class ZipFSHandlerPtr(ZipFSHandler):
1822 def __init__(self, this):
1823 self.this = this
1824 if not hasattr(self,"thisown"): self.thisown = 0
1825 self.__class__ = ZipFSHandler
54f9ee45 1826_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
d14a1e28
RD
1827
1828
e811c8ce 1829def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
196addbf 1830 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
54f9ee45 1831 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
d14a1e28 1832
e811c8ce 1833def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
196addbf 1834 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
54f9ee45 1835 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
d14a1e28 1836
e811c8ce 1837def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
196addbf 1838 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
54f9ee45 1839 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
d14a1e28
RD
1840def MemoryFSHandler_AddFile(filename, a, b=''):
1841 if isinstance(a, wx.Image):
1842 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1843 elif isinstance(a, wx.Bitmap):
1844 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1845 elif type(a) == str:
1846 __wxMemoryFSHandler_AddFile_Data(filename, a)
1847 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1848
1849class MemoryFSHandler(CPPFileSystemHandler):
e811c8ce
RD
1850 def __repr__(self):
1851 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1852 def __init__(self, *args, **kwargs):
a95a7133 1853 """__init__(self) -> MemoryFSHandler"""
54f9ee45 1854 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
d14a1e28
RD
1855 self.this = newobj.this
1856 self.thisown = 1
1857 del newobj.thisown
e811c8ce 1858 def RemoveFile(*args, **kwargs):
66c033b4 1859 """RemoveFile(String filename)"""
54f9ee45 1860 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
e811c8ce
RD
1861
1862 RemoveFile = staticmethod(RemoveFile)
d14a1e28 1863 AddFile = staticmethod(MemoryFSHandler_AddFile)
e811c8ce 1864 def CanOpen(*args, **kwargs):
a95a7133 1865 """CanOpen(self, String location) -> bool"""
54f9ee45 1866 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
e811c8ce
RD
1867
1868 def OpenFile(*args, **kwargs):
a95a7133 1869 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
54f9ee45 1870 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
e811c8ce
RD
1871
1872 def FindFirst(*args, **kwargs):
a95a7133 1873 """FindFirst(self, String spec, int flags=0) -> String"""
54f9ee45 1874 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
e811c8ce
RD
1875
1876 def FindNext(*args, **kwargs):
a95a7133 1877 """FindNext(self) -> String"""
54f9ee45 1878 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
e811c8ce 1879
d14a1e28
RD
1880
1881class MemoryFSHandlerPtr(MemoryFSHandler):
1882 def __init__(self, this):
1883 self.this = this
1884 if not hasattr(self,"thisown"): self.thisown = 0
1885 self.__class__ = MemoryFSHandler
54f9ee45 1886_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
d14a1e28 1887
e811c8ce 1888def MemoryFSHandler_RemoveFile(*args, **kwargs):
196addbf 1889 """MemoryFSHandler_RemoveFile(String filename)"""
54f9ee45 1890 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
d14a1e28
RD
1891
1892#---------------------------------------------------------------------------
1893
1894class ImageHandler(Object):
d14a1e28
RD
1895 def __init__(self): raise RuntimeError, "No constructor defined"
1896 def __repr__(self):
1897 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 1898 def GetName(*args, **kwargs):
a95a7133 1899 """GetName(self) -> String"""
54f9ee45 1900 return _core_.ImageHandler_GetName(*args, **kwargs)
e811c8ce
RD
1901
1902 def GetExtension(*args, **kwargs):
a95a7133 1903 """GetExtension(self) -> String"""
54f9ee45 1904 return _core_.ImageHandler_GetExtension(*args, **kwargs)
e811c8ce
RD
1905
1906 def GetType(*args, **kwargs):
a95a7133 1907 """GetType(self) -> long"""
54f9ee45 1908 return _core_.ImageHandler_GetType(*args, **kwargs)
e811c8ce
RD
1909
1910 def GetMimeType(*args, **kwargs):
a95a7133 1911 """GetMimeType(self) -> String"""
54f9ee45 1912 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
e811c8ce
RD
1913
1914 def CanRead(*args, **kwargs):
a95a7133 1915 """CanRead(self, String name) -> bool"""
54f9ee45 1916 return _core_.ImageHandler_CanRead(*args, **kwargs)
e811c8ce
RD
1917
1918 def SetName(*args, **kwargs):
a95a7133 1919 """SetName(self, String name)"""
54f9ee45 1920 return _core_.ImageHandler_SetName(*args, **kwargs)
e811c8ce
RD
1921
1922 def SetExtension(*args, **kwargs):
a95a7133 1923 """SetExtension(self, String extension)"""
54f9ee45 1924 return _core_.ImageHandler_SetExtension(*args, **kwargs)
e811c8ce
RD
1925
1926 def SetType(*args, **kwargs):
a95a7133 1927 """SetType(self, long type)"""
54f9ee45 1928 return _core_.ImageHandler_SetType(*args, **kwargs)
e811c8ce
RD
1929
1930 def SetMimeType(*args, **kwargs):
a95a7133 1931 """SetMimeType(self, String mimetype)"""
54f9ee45 1932 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
e811c8ce 1933
d14a1e28
RD
1934
1935class ImageHandlerPtr(ImageHandler):
1936 def __init__(self, this):
1937 self.this = this
1938 if not hasattr(self,"thisown"): self.thisown = 0
1939 self.__class__ = ImageHandler
54f9ee45 1940_core_.ImageHandler_swigregister(ImageHandlerPtr)
d14a1e28
RD
1941
1942class ImageHistogram(object):
e811c8ce
RD
1943 def __repr__(self):
1944 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1945 def __init__(self, *args, **kwargs):
a95a7133 1946 """__init__(self) -> ImageHistogram"""
54f9ee45 1947 newobj = _core_.new_ImageHistogram(*args, **kwargs)
d14a1e28
RD
1948 self.this = newobj.this
1949 self.thisown = 1
1950 del newobj.thisown
e811c8ce 1951 def MakeKey(*args, **kwargs):
0df68c9f 1952 """
66c033b4 1953 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1954
0df68c9f
RD
1955 Get the key in the histogram for the given RGB values
1956 """
54f9ee45 1957 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
e811c8ce
RD
1958
1959 MakeKey = staticmethod(MakeKey)
1960 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
1961 """
1962 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
1963
1964 Find first colour that is not used in the image and has higher RGB
1965 values than startR, startG, startB. Returns a tuple consisting of a
1966 success flag and rgb values.
1967 """
54f9ee45 1968 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
e811c8ce 1969
d14a1e28
RD
1970
1971class ImageHistogramPtr(ImageHistogram):
1972 def __init__(self, this):
1973 self.this = this
1974 if not hasattr(self,"thisown"): self.thisown = 0
1975 self.__class__ = ImageHistogram
54f9ee45 1976_core_.ImageHistogram_swigregister(ImageHistogramPtr)
d14a1e28 1977
e811c8ce 1978def ImageHistogram_MakeKey(*args, **kwargs):
0df68c9f
RD
1979 """
1980 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
e811c8ce 1981
0df68c9f
RD
1982 Get the key in the histogram for the given RGB values
1983 """
54f9ee45 1984 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
d14a1e28
RD
1985
1986class Image(Object):
e811c8ce
RD
1987 def __repr__(self):
1988 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1989 def __init__(self, *args, **kwargs):
a95a7133 1990 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 1991 newobj = _core_.new_Image(*args, **kwargs)
d14a1e28
RD
1992 self.this = newobj.this
1993 self.thisown = 1
1994 del newobj.thisown
54f9ee45 1995 def __del__(self, destroy=_core_.delete_Image):
a95a7133 1996 """__del__(self)"""
d14a1e28
RD
1997 try:
1998 if self.thisown: destroy(self)
1999 except: pass
e811c8ce
RD
2000
2001 def Create(*args, **kwargs):
a95a7133 2002 """Create(self, int width, int height)"""
54f9ee45 2003 return _core_.Image_Create(*args, **kwargs)
e811c8ce
RD
2004
2005 def Destroy(*args, **kwargs):
0df68c9f 2006 """
a95a7133 2007 Destroy(self)
e811c8ce 2008
0df68c9f
RD
2009 Deletes the C++ object this Python object is a proxy for.
2010 """
54f9ee45 2011 return _core_.Image_Destroy(*args, **kwargs)
e811c8ce
RD
2012
2013 def Scale(*args, **kwargs):
a95a7133 2014 """Scale(self, int width, int height) -> Image"""
54f9ee45 2015 return _core_.Image_Scale(*args, **kwargs)
e811c8ce
RD
2016
2017 def ShrinkBy(*args, **kwargs):
a95a7133 2018 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
54f9ee45 2019 return _core_.Image_ShrinkBy(*args, **kwargs)
e811c8ce
RD
2020
2021 def Rescale(*args, **kwargs):
a95a7133 2022 """Rescale(self, int width, int height) -> Image"""
54f9ee45 2023 return _core_.Image_Rescale(*args, **kwargs)
e811c8ce
RD
2024
2025 def SetRGB(*args, **kwargs):
a95a7133 2026 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2027 return _core_.Image_SetRGB(*args, **kwargs)
e811c8ce
RD
2028
2029 def GetRed(*args, **kwargs):
a95a7133 2030 """GetRed(self, int x, int y) -> unsigned char"""
54f9ee45 2031 return _core_.Image_GetRed(*args, **kwargs)
e811c8ce
RD
2032
2033 def GetGreen(*args, **kwargs):
a95a7133 2034 """GetGreen(self, int x, int y) -> unsigned char"""
54f9ee45 2035 return _core_.Image_GetGreen(*args, **kwargs)
e811c8ce
RD
2036
2037 def GetBlue(*args, **kwargs):
a95a7133 2038 """GetBlue(self, int x, int y) -> unsigned char"""
54f9ee45 2039 return _core_.Image_GetBlue(*args, **kwargs)
e811c8ce
RD
2040
2041 def SetAlpha(*args, **kwargs):
a95a7133 2042 """SetAlpha(self, int x, int y, unsigned char alpha)"""
54f9ee45 2043 return _core_.Image_SetAlpha(*args, **kwargs)
e811c8ce
RD
2044
2045 def GetAlpha(*args, **kwargs):
a95a7133 2046 """GetAlpha(self, int x, int y) -> unsigned char"""
54f9ee45 2047 return _core_.Image_GetAlpha(*args, **kwargs)
e811c8ce
RD
2048
2049 def HasAlpha(*args, **kwargs):
a95a7133 2050 """HasAlpha(self) -> bool"""
54f9ee45 2051 return _core_.Image_HasAlpha(*args, **kwargs)
e811c8ce
RD
2052
2053 def FindFirstUnusedColour(*args, **kwargs):
fd2dc343
RD
2054 """
2055 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2056
2057 Find first colour that is not used in the image and has higher RGB
2058 values than startR, startG, startB. Returns a tuple consisting of a
2059 success flag and rgb values.
2060 """
54f9ee45 2061 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
e811c8ce
RD
2062
2063 def SetMaskFromImage(*args, **kwargs):
a95a7133 2064 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
54f9ee45 2065 return _core_.Image_SetMaskFromImage(*args, **kwargs)
e811c8ce
RD
2066
2067 def CanRead(*args, **kwargs):
66c033b4 2068 """CanRead(String name) -> bool"""
54f9ee45 2069 return _core_.Image_CanRead(*args, **kwargs)
e811c8ce
RD
2070
2071 CanRead = staticmethod(CanRead)
2072 def GetImageCount(*args, **kwargs):
66c033b4 2073 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2074 return _core_.Image_GetImageCount(*args, **kwargs)
e811c8ce
RD
2075
2076 GetImageCount = staticmethod(GetImageCount)
2077 def LoadFile(*args, **kwargs):
a95a7133 2078 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2079 return _core_.Image_LoadFile(*args, **kwargs)
e811c8ce
RD
2080
2081 def LoadMimeFile(*args, **kwargs):
a95a7133 2082 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
54f9ee45 2083 return _core_.Image_LoadMimeFile(*args, **kwargs)
e811c8ce
RD
2084
2085 def SaveFile(*args, **kwargs):
a95a7133 2086 """SaveFile(self, String name, int type) -> bool"""
54f9ee45 2087 return _core_.Image_SaveFile(*args, **kwargs)
e811c8ce
RD
2088
2089 def SaveMimeFile(*args, **kwargs):
a95a7133 2090 """SaveMimeFile(self, String name, String mimetype) -> bool"""
54f9ee45 2091 return _core_.Image_SaveMimeFile(*args, **kwargs)
e811c8ce
RD
2092
2093 def CanReadStream(*args, **kwargs):
66c033b4 2094 """CanReadStream(InputStream stream) -> bool"""
54f9ee45 2095 return _core_.Image_CanReadStream(*args, **kwargs)
e811c8ce
RD
2096
2097 CanReadStream = staticmethod(CanReadStream)
2098 def LoadStream(*args, **kwargs):
a95a7133 2099 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
54f9ee45 2100 return _core_.Image_LoadStream(*args, **kwargs)
e811c8ce
RD
2101
2102 def LoadMimeStream(*args, **kwargs):
a95a7133 2103 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
54f9ee45 2104 return _core_.Image_LoadMimeStream(*args, **kwargs)
e811c8ce
RD
2105
2106 def Ok(*args, **kwargs):
a95a7133 2107 """Ok(self) -> bool"""
54f9ee45 2108 return _core_.Image_Ok(*args, **kwargs)
e811c8ce
RD
2109
2110 def GetWidth(*args, **kwargs):
a95a7133 2111 """GetWidth(self) -> int"""
54f9ee45 2112 return _core_.Image_GetWidth(*args, **kwargs)
e811c8ce
RD
2113
2114 def GetHeight(*args, **kwargs):
a95a7133 2115 """GetHeight(self) -> int"""
54f9ee45 2116 return _core_.Image_GetHeight(*args, **kwargs)
e811c8ce 2117
b2df227b 2118 def GetSize(*args, **kwargs):
a95a7133 2119 """GetSize(self) -> Size"""
54f9ee45 2120 return _core_.Image_GetSize(*args, **kwargs)
b2df227b 2121
e811c8ce 2122 def GetSubImage(*args, **kwargs):
a95a7133 2123 """GetSubImage(self, Rect rect) -> Image"""
54f9ee45 2124 return _core_.Image_GetSubImage(*args, **kwargs)
e811c8ce
RD
2125
2126 def Copy(*args, **kwargs):
a95a7133 2127 """Copy(self) -> Image"""
54f9ee45 2128 return _core_.Image_Copy(*args, **kwargs)
e811c8ce
RD
2129
2130 def Paste(*args, **kwargs):
a95a7133 2131 """Paste(self, Image image, int x, int y)"""
54f9ee45 2132 return _core_.Image_Paste(*args, **kwargs)
e811c8ce
RD
2133
2134 def GetData(*args, **kwargs):
a95a7133 2135 """GetData(self) -> PyObject"""
54f9ee45 2136 return _core_.Image_GetData(*args, **kwargs)
e811c8ce
RD
2137
2138 def SetData(*args, **kwargs):
a95a7133 2139 """SetData(self, PyObject data)"""
54f9ee45 2140 return _core_.Image_SetData(*args, **kwargs)
e811c8ce
RD
2141
2142 def GetDataBuffer(*args, **kwargs):
a95a7133 2143 """GetDataBuffer(self) -> PyObject"""
54f9ee45 2144 return _core_.Image_GetDataBuffer(*args, **kwargs)
e811c8ce
RD
2145
2146 def SetDataBuffer(*args, **kwargs):
a95a7133 2147 """SetDataBuffer(self, PyObject data)"""
54f9ee45 2148 return _core_.Image_SetDataBuffer(*args, **kwargs)
e811c8ce
RD
2149
2150 def GetAlphaData(*args, **kwargs):
a95a7133 2151 """GetAlphaData(self) -> PyObject"""
54f9ee45 2152 return _core_.Image_GetAlphaData(*args, **kwargs)
e811c8ce
RD
2153
2154 def SetAlphaData(*args, **kwargs):
a95a7133 2155 """SetAlphaData(self, PyObject data)"""
54f9ee45 2156 return _core_.Image_SetAlphaData(*args, **kwargs)
e811c8ce
RD
2157
2158 def GetAlphaBuffer(*args, **kwargs):
a95a7133 2159 """GetAlphaBuffer(self) -> PyObject"""
54f9ee45 2160 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2161
2162 def SetAlphaBuffer(*args, **kwargs):
a95a7133 2163 """SetAlphaBuffer(self, PyObject data)"""
54f9ee45 2164 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
e811c8ce
RD
2165
2166 def SetMaskColour(*args, **kwargs):
a95a7133 2167 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
54f9ee45 2168 return _core_.Image_SetMaskColour(*args, **kwargs)
e811c8ce
RD
2169
2170 def GetMaskRed(*args, **kwargs):
a95a7133 2171 """GetMaskRed(self) -> unsigned char"""
54f9ee45 2172 return _core_.Image_GetMaskRed(*args, **kwargs)
e811c8ce
RD
2173
2174 def GetMaskGreen(*args, **kwargs):
a95a7133 2175 """GetMaskGreen(self) -> unsigned char"""
54f9ee45 2176 return _core_.Image_GetMaskGreen(*args, **kwargs)
e811c8ce
RD
2177
2178 def GetMaskBlue(*args, **kwargs):
a95a7133 2179 """GetMaskBlue(self) -> unsigned char"""
54f9ee45 2180 return _core_.Image_GetMaskBlue(*args, **kwargs)
e811c8ce
RD
2181
2182 def SetMask(*args, **kwargs):
a95a7133 2183 """SetMask(self, bool mask=True)"""
54f9ee45 2184 return _core_.Image_SetMask(*args, **kwargs)
e811c8ce
RD
2185
2186 def HasMask(*args, **kwargs):
a95a7133 2187 """HasMask(self) -> bool"""
54f9ee45 2188 return _core_.Image_HasMask(*args, **kwargs)
e811c8ce
RD
2189
2190 def Rotate(*args, **kwargs):
0df68c9f 2191 """
a95a7133 2192 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
0df68c9f
RD
2193 Point offset_after_rotation=None) -> Image
2194 """
54f9ee45 2195 return _core_.Image_Rotate(*args, **kwargs)
e811c8ce
RD
2196
2197 def Rotate90(*args, **kwargs):
a95a7133 2198 """Rotate90(self, bool clockwise=True) -> Image"""
54f9ee45 2199 return _core_.Image_Rotate90(*args, **kwargs)
e811c8ce
RD
2200
2201 def Mirror(*args, **kwargs):
a95a7133 2202 """Mirror(self, bool horizontally=True) -> Image"""
54f9ee45 2203 return _core_.Image_Mirror(*args, **kwargs)
e811c8ce
RD
2204
2205 def Replace(*args, **kwargs):
0df68c9f 2206 """
a95a7133 2207 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
0df68c9f
RD
2208 unsigned char r2, unsigned char g2, unsigned char b2)
2209 """
54f9ee45 2210 return _core_.Image_Replace(*args, **kwargs)
e811c8ce
RD
2211
2212 def ConvertToMono(*args, **kwargs):
a95a7133 2213 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
54f9ee45 2214 return _core_.Image_ConvertToMono(*args, **kwargs)
e811c8ce
RD
2215
2216 def SetOption(*args, **kwargs):
a95a7133 2217 """SetOption(self, String name, String value)"""
54f9ee45 2218 return _core_.Image_SetOption(*args, **kwargs)
e811c8ce
RD
2219
2220 def SetOptionInt(*args, **kwargs):
a95a7133 2221 """SetOptionInt(self, String name, int value)"""
54f9ee45 2222 return _core_.Image_SetOptionInt(*args, **kwargs)
e811c8ce
RD
2223
2224 def GetOption(*args, **kwargs):
a95a7133 2225 """GetOption(self, String name) -> String"""
54f9ee45 2226 return _core_.Image_GetOption(*args, **kwargs)
e811c8ce
RD
2227
2228 def GetOptionInt(*args, **kwargs):
a95a7133 2229 """GetOptionInt(self, String name) -> int"""
54f9ee45 2230 return _core_.Image_GetOptionInt(*args, **kwargs)
e811c8ce
RD
2231
2232 def HasOption(*args, **kwargs):
a95a7133 2233 """HasOption(self, String name) -> bool"""
54f9ee45 2234 return _core_.Image_HasOption(*args, **kwargs)
e811c8ce
RD
2235
2236 def CountColours(*args, **kwargs):
a95a7133 2237 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
54f9ee45 2238 return _core_.Image_CountColours(*args, **kwargs)
e811c8ce
RD
2239
2240 def ComputeHistogram(*args, **kwargs):
a95a7133 2241 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
54f9ee45 2242 return _core_.Image_ComputeHistogram(*args, **kwargs)
e811c8ce
RD
2243
2244 def AddHandler(*args, **kwargs):
66c033b4 2245 """AddHandler(ImageHandler handler)"""
54f9ee45 2246 return _core_.Image_AddHandler(*args, **kwargs)
e811c8ce
RD
2247
2248 AddHandler = staticmethod(AddHandler)
2249 def InsertHandler(*args, **kwargs):
66c033b4 2250 """InsertHandler(ImageHandler handler)"""
54f9ee45 2251 return _core_.Image_InsertHandler(*args, **kwargs)
e811c8ce
RD
2252
2253 InsertHandler = staticmethod(InsertHandler)
2254 def RemoveHandler(*args, **kwargs):
66c033b4 2255 """RemoveHandler(String name) -> bool"""
54f9ee45 2256 return _core_.Image_RemoveHandler(*args, **kwargs)
e811c8ce
RD
2257
2258 RemoveHandler = staticmethod(RemoveHandler)
2259 def GetImageExtWildcard(*args, **kwargs):
66c033b4 2260 """GetImageExtWildcard() -> String"""
54f9ee45 2261 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
e811c8ce
RD
2262
2263 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2264 def ConvertToBitmap(*args, **kwargs):
a95a7133 2265 """ConvertToBitmap(self) -> Bitmap"""
54f9ee45 2266 return _core_.Image_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
2267
2268 def ConvertToMonoBitmap(*args, **kwargs):
a95a7133 2269 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
54f9ee45 2270 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
e811c8ce
RD
2271
2272 def __nonzero__(self): return self.Ok()
d14a1e28
RD
2273
2274class ImagePtr(Image):
2275 def __init__(self, this):
2276 self.this = this
2277 if not hasattr(self,"thisown"): self.thisown = 0
2278 self.__class__ = Image
54f9ee45 2279_core_.Image_swigregister(ImagePtr)
d14a1e28
RD
2280
2281def ImageFromMime(*args, **kwargs):
196addbf 2282 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
54f9ee45 2283 val = _core_.new_ImageFromMime(*args, **kwargs)
d14a1e28
RD
2284 val.thisown = 1
2285 return val
2286
2287def ImageFromStream(*args, **kwargs):
196addbf 2288 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
54f9ee45 2289 val = _core_.new_ImageFromStream(*args, **kwargs)
d14a1e28
RD
2290 val.thisown = 1
2291 return val
2292
2293def ImageFromStreamMime(*args, **kwargs):
196addbf 2294 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
54f9ee45 2295 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
d14a1e28
RD
2296 val.thisown = 1
2297 return val
2298
66c033b4
RD
2299def EmptyImage(*args, **kwargs):
2300 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2301 val = _core_.new_EmptyImage(*args, **kwargs)
d14a1e28
RD
2302 val.thisown = 1
2303 return val
2304
2305def ImageFromBitmap(*args, **kwargs):
196addbf 2306 """ImageFromBitmap(Bitmap bitmap) -> Image"""
54f9ee45 2307 val = _core_.new_ImageFromBitmap(*args, **kwargs)
d14a1e28
RD
2308 val.thisown = 1
2309 return val
2310
2311def ImageFromData(*args, **kwargs):
e811c8ce 2312 """ImageFromData(int width, int height, unsigned char data) -> Image"""
54f9ee45 2313 val = _core_.new_ImageFromData(*args, **kwargs)
d14a1e28
RD
2314 val.thisown = 1
2315 return val
2316
e811c8ce 2317def Image_CanRead(*args, **kwargs):
196addbf 2318 """Image_CanRead(String name) -> bool"""
54f9ee45 2319 return _core_.Image_CanRead(*args, **kwargs)
d14a1e28 2320
e811c8ce 2321def Image_GetImageCount(*args, **kwargs):
196addbf 2322 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
54f9ee45 2323 return _core_.Image_GetImageCount(*args, **kwargs)
d14a1e28 2324
e811c8ce 2325def Image_CanReadStream(*args, **kwargs):
196addbf 2326 """Image_CanReadStream(InputStream stream) -> bool"""
54f9ee45 2327 return _core_.Image_CanReadStream(*args, **kwargs)
d14a1e28 2328
e811c8ce
RD
2329def Image_AddHandler(*args, **kwargs):
2330 """Image_AddHandler(ImageHandler handler)"""
54f9ee45 2331 return _core_.Image_AddHandler(*args, **kwargs)
d14a1e28 2332
e811c8ce
RD
2333def Image_InsertHandler(*args, **kwargs):
2334 """Image_InsertHandler(ImageHandler handler)"""
54f9ee45 2335 return _core_.Image_InsertHandler(*args, **kwargs)
d14a1e28 2336
e811c8ce 2337def Image_RemoveHandler(*args, **kwargs):
196addbf 2338 """Image_RemoveHandler(String name) -> bool"""
54f9ee45 2339 return _core_.Image_RemoveHandler(*args, **kwargs)
d14a1e28 2340
e811c8ce 2341def Image_GetImageExtWildcard(*args, **kwargs):
196addbf 2342 """Image_GetImageExtWildcard() -> String"""
54f9ee45 2343 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
d14a1e28 2344
5e4ca4a8
RD
2345def InitAllImageHandlers():
2346 """
2347 The former functionality of InitAllImageHanders is now done internal to
2348 the _core_ extension module and so this function has become a simple NOP.
2349 """
2350 pass
d14a1e28 2351
54f9ee45
RD
2352IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2353IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2354BMP_24BPP = _core_.BMP_24BPP
2355BMP_8BPP = _core_.BMP_8BPP
2356BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2357BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2358BMP_8BPP_RED = _core_.BMP_8BPP_RED
2359BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2360BMP_4BPP = _core_.BMP_4BPP
2361BMP_1BPP = _core_.BMP_1BPP
2362BMP_1BPP_BW = _core_.BMP_1BPP_BW
d14a1e28 2363class BMPHandler(ImageHandler):
e811c8ce
RD
2364 def __repr__(self):
2365 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2366 def __init__(self, *args, **kwargs):
a95a7133 2367 """__init__(self) -> BMPHandler"""
54f9ee45 2368 newobj = _core_.new_BMPHandler(*args, **kwargs)
d14a1e28
RD
2369 self.this = newobj.this
2370 self.thisown = 1
2371 del newobj.thisown
d14a1e28
RD
2372
2373class BMPHandlerPtr(BMPHandler):
2374 def __init__(self, this):
2375 self.this = this
2376 if not hasattr(self,"thisown"): self.thisown = 0
2377 self.__class__ = BMPHandler
54f9ee45 2378_core_.BMPHandler_swigregister(BMPHandlerPtr)
d14a1e28
RD
2379NullImage = cvar.NullImage
2380IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2381IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2382IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2383IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2384IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2385
2386class ICOHandler(BMPHandler):
e811c8ce
RD
2387 def __repr__(self):
2388 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2389 def __init__(self, *args, **kwargs):
a95a7133 2390 """__init__(self) -> ICOHandler"""
54f9ee45 2391 newobj = _core_.new_ICOHandler(*args, **kwargs)
d14a1e28
RD
2392 self.this = newobj.this
2393 self.thisown = 1
2394 del newobj.thisown
d14a1e28
RD
2395
2396class ICOHandlerPtr(ICOHandler):
2397 def __init__(self, this):
2398 self.this = this
2399 if not hasattr(self,"thisown"): self.thisown = 0
2400 self.__class__ = ICOHandler
54f9ee45 2401_core_.ICOHandler_swigregister(ICOHandlerPtr)
d14a1e28
RD
2402
2403class CURHandler(ICOHandler):
e811c8ce
RD
2404 def __repr__(self):
2405 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2406 def __init__(self, *args, **kwargs):
a95a7133 2407 """__init__(self) -> CURHandler"""
54f9ee45 2408 newobj = _core_.new_CURHandler(*args, **kwargs)
d14a1e28
RD
2409 self.this = newobj.this
2410 self.thisown = 1
2411 del newobj.thisown
d14a1e28
RD
2412
2413class CURHandlerPtr(CURHandler):
2414 def __init__(self, this):
2415 self.this = this
2416 if not hasattr(self,"thisown"): self.thisown = 0
2417 self.__class__ = CURHandler
54f9ee45 2418_core_.CURHandler_swigregister(CURHandlerPtr)
d14a1e28
RD
2419
2420class ANIHandler(CURHandler):
e811c8ce
RD
2421 def __repr__(self):
2422 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2423 def __init__(self, *args, **kwargs):
a95a7133 2424 """__init__(self) -> ANIHandler"""
54f9ee45 2425 newobj = _core_.new_ANIHandler(*args, **kwargs)
d14a1e28
RD
2426 self.this = newobj.this
2427 self.thisown = 1
2428 del newobj.thisown
d14a1e28
RD
2429
2430class ANIHandlerPtr(ANIHandler):
2431 def __init__(self, this):
2432 self.this = this
2433 if not hasattr(self,"thisown"): self.thisown = 0
2434 self.__class__ = ANIHandler
54f9ee45 2435_core_.ANIHandler_swigregister(ANIHandlerPtr)
d14a1e28
RD
2436
2437class PNGHandler(ImageHandler):
e811c8ce
RD
2438 def __repr__(self):
2439 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2440 def __init__(self, *args, **kwargs):
a95a7133 2441 """__init__(self) -> PNGHandler"""
54f9ee45 2442 newobj = _core_.new_PNGHandler(*args, **kwargs)
d14a1e28
RD
2443 self.this = newobj.this
2444 self.thisown = 1
2445 del newobj.thisown
d14a1e28
RD
2446
2447class PNGHandlerPtr(PNGHandler):
2448 def __init__(self, this):
2449 self.this = this
2450 if not hasattr(self,"thisown"): self.thisown = 0
2451 self.__class__ = PNGHandler
54f9ee45 2452_core_.PNGHandler_swigregister(PNGHandlerPtr)
d14a1e28
RD
2453
2454class GIFHandler(ImageHandler):
e811c8ce
RD
2455 def __repr__(self):
2456 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2457 def __init__(self, *args, **kwargs):
a95a7133 2458 """__init__(self) -> GIFHandler"""
54f9ee45 2459 newobj = _core_.new_GIFHandler(*args, **kwargs)
d14a1e28
RD
2460 self.this = newobj.this
2461 self.thisown = 1
2462 del newobj.thisown
d14a1e28
RD
2463
2464class GIFHandlerPtr(GIFHandler):
2465 def __init__(self, this):
2466 self.this = this
2467 if not hasattr(self,"thisown"): self.thisown = 0
2468 self.__class__ = GIFHandler
54f9ee45 2469_core_.GIFHandler_swigregister(GIFHandlerPtr)
d14a1e28
RD
2470
2471class PCXHandler(ImageHandler):
e811c8ce
RD
2472 def __repr__(self):
2473 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2474 def __init__(self, *args, **kwargs):
a95a7133 2475 """__init__(self) -> PCXHandler"""
54f9ee45 2476 newobj = _core_.new_PCXHandler(*args, **kwargs)
d14a1e28
RD
2477 self.this = newobj.this
2478 self.thisown = 1
2479 del newobj.thisown
d14a1e28
RD
2480
2481class PCXHandlerPtr(PCXHandler):
2482 def __init__(self, this):
2483 self.this = this
2484 if not hasattr(self,"thisown"): self.thisown = 0
2485 self.__class__ = PCXHandler
54f9ee45 2486_core_.PCXHandler_swigregister(PCXHandlerPtr)
d14a1e28
RD
2487
2488class JPEGHandler(ImageHandler):
e811c8ce
RD
2489 def __repr__(self):
2490 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2491 def __init__(self, *args, **kwargs):
a95a7133 2492 """__init__(self) -> JPEGHandler"""
54f9ee45 2493 newobj = _core_.new_JPEGHandler(*args, **kwargs)
d14a1e28
RD
2494 self.this = newobj.this
2495 self.thisown = 1
2496 del newobj.thisown
d14a1e28
RD
2497
2498class JPEGHandlerPtr(JPEGHandler):
2499 def __init__(self, this):
2500 self.this = this
2501 if not hasattr(self,"thisown"): self.thisown = 0
2502 self.__class__ = JPEGHandler
54f9ee45 2503_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
d14a1e28
RD
2504
2505class PNMHandler(ImageHandler):
e811c8ce
RD
2506 def __repr__(self):
2507 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2508 def __init__(self, *args, **kwargs):
a95a7133 2509 """__init__(self) -> PNMHandler"""
54f9ee45 2510 newobj = _core_.new_PNMHandler(*args, **kwargs)
d14a1e28
RD
2511 self.this = newobj.this
2512 self.thisown = 1
2513 del newobj.thisown
d14a1e28
RD
2514
2515class PNMHandlerPtr(PNMHandler):
2516 def __init__(self, this):
2517 self.this = this
2518 if not hasattr(self,"thisown"): self.thisown = 0
2519 self.__class__ = PNMHandler
54f9ee45 2520_core_.PNMHandler_swigregister(PNMHandlerPtr)
d14a1e28
RD
2521
2522class XPMHandler(ImageHandler):
e811c8ce
RD
2523 def __repr__(self):
2524 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2525 def __init__(self, *args, **kwargs):
a95a7133 2526 """__init__(self) -> XPMHandler"""
54f9ee45 2527 newobj = _core_.new_XPMHandler(*args, **kwargs)
d14a1e28
RD
2528 self.this = newobj.this
2529 self.thisown = 1
2530 del newobj.thisown
d14a1e28
RD
2531
2532class XPMHandlerPtr(XPMHandler):
2533 def __init__(self, this):
2534 self.this = this
2535 if not hasattr(self,"thisown"): self.thisown = 0
2536 self.__class__ = XPMHandler
54f9ee45 2537_core_.XPMHandler_swigregister(XPMHandlerPtr)
d14a1e28
RD
2538
2539class TIFFHandler(ImageHandler):
e811c8ce
RD
2540 def __repr__(self):
2541 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2542 def __init__(self, *args, **kwargs):
a95a7133 2543 """__init__(self) -> TIFFHandler"""
54f9ee45 2544 newobj = _core_.new_TIFFHandler(*args, **kwargs)
d14a1e28
RD
2545 self.this = newobj.this
2546 self.thisown = 1
2547 del newobj.thisown
d14a1e28
RD
2548
2549class TIFFHandlerPtr(TIFFHandler):
2550 def __init__(self, this):
2551 self.this = this
2552 if not hasattr(self,"thisown"): self.thisown = 0
2553 self.__class__ = TIFFHandler
54f9ee45 2554_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
d14a1e28
RD
2555
2556#---------------------------------------------------------------------------
2557
2558class EvtHandler(Object):
e811c8ce
RD
2559 def __repr__(self):
2560 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2561 def __init__(self, *args, **kwargs):
a95a7133 2562 """__init__(self) -> EvtHandler"""
54f9ee45 2563 newobj = _core_.new_EvtHandler(*args, **kwargs)
d14a1e28
RD
2564 self.this = newobj.this
2565 self.thisown = 1
2566 del newobj.thisown
e811c8ce 2567 def GetNextHandler(*args, **kwargs):
a95a7133 2568 """GetNextHandler(self) -> EvtHandler"""
54f9ee45 2569 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
e811c8ce
RD
2570
2571 def GetPreviousHandler(*args, **kwargs):
a95a7133 2572 """GetPreviousHandler(self) -> EvtHandler"""
54f9ee45 2573 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2574
2575 def SetNextHandler(*args, **kwargs):
a95a7133 2576 """SetNextHandler(self, EvtHandler handler)"""
54f9ee45 2577 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
e811c8ce
RD
2578
2579 def SetPreviousHandler(*args, **kwargs):
a95a7133 2580 """SetPreviousHandler(self, EvtHandler handler)"""
54f9ee45 2581 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
e811c8ce
RD
2582
2583 def GetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2584 """GetEvtHandlerEnabled(self) -> bool"""
54f9ee45 2585 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2586
2587 def SetEvtHandlerEnabled(*args, **kwargs):
a95a7133 2588 """SetEvtHandlerEnabled(self, bool enabled)"""
54f9ee45 2589 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
e811c8ce
RD
2590
2591 def ProcessEvent(*args, **kwargs):
a95a7133 2592 """ProcessEvent(self, Event event) -> bool"""
54f9ee45 2593 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
e811c8ce
RD
2594
2595 def AddPendingEvent(*args, **kwargs):
a95a7133 2596 """AddPendingEvent(self, Event event)"""
54f9ee45 2597 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
e811c8ce
RD
2598
2599 def ProcessPendingEvents(*args, **kwargs):
a95a7133 2600 """ProcessPendingEvents(self)"""
54f9ee45 2601 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
2602
2603 def Connect(*args, **kwargs):
a95a7133 2604 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
54f9ee45 2605 return _core_.EvtHandler_Connect(*args, **kwargs)
e811c8ce
RD
2606
2607 def Disconnect(*args, **kwargs):
a95a7133 2608 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
54f9ee45 2609 return _core_.EvtHandler_Disconnect(*args, **kwargs)
e811c8ce
RD
2610
2611 def _setOORInfo(*args, **kwargs):
a95a7133 2612 """_setOORInfo(self, PyObject _self)"""
54f9ee45 2613 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
e811c8ce 2614
d14a1e28
RD
2615 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2616 """
2617 Bind an event to an event handler.
2618
db3e571a
RD
2619 :param event: One of the EVT_* objects that specifies the
2620 type of event to bind,
d14a1e28 2621
db3e571a
RD
2622 :param handler: A callable object to be invoked when the
2623 event is delivered to self. Pass None to
2624 disconnect an event handler.
d14a1e28 2625
db3e571a
RD
2626 :param source: Sometimes the event originates from a
2627 different window than self, but you still
2628 want to catch it in self. (For example, a
2629 button event delivered to a frame.) By
2630 passing the source of the event, the event
2631 handling system is able to differentiate
2632 between the same event type from different
2633 controls.
d14a1e28 2634
db3e571a
RD
2635 :param id: Used to spcify the event source by ID instead
2636 of instance.
2637
2638 :param id2: Used when it is desirable to bind a handler
2639 to a range of IDs, such as with EVT_MENU_RANGE.
d14a1e28
RD
2640 """
2641 if source is not None:
2642 id = source.GetId()
2643 event.Bind(self, id, id2, handler)
2644
66c033b4
RD
2645 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2646 """
2647 Disconencts the event handler binding for event from self.
2648 Returns True if successful.
2649 """
2650 if source is not None:
2651 id = source.GetId()
2652 return event.Unbind(self, id, id2)
d14a1e28 2653
d14a1e28
RD
2654
2655class EvtHandlerPtr(EvtHandler):
2656 def __init__(self, this):
2657 self.this = this
2658 if not hasattr(self,"thisown"): self.thisown = 0
2659 self.__class__ = EvtHandler
54f9ee45 2660_core_.EvtHandler_swigregister(EvtHandlerPtr)
d14a1e28
RD
2661
2662#---------------------------------------------------------------------------
2663
2664class PyEventBinder(object):
2665 """
2666 Instances of this class are used to bind specific events to event
2667 handlers.
2668 """
2669 def __init__(self, evtType, expectedIDs=0):
2670 if expectedIDs not in [0, 1, 2]:
2671 raise ValueError, "Invalid number of expectedIDs"
2672 self.expectedIDs = expectedIDs
2673
2674 if type(evtType) == list or type(evtType) == tuple:
2675 self.evtType = evtType
2676 else:
2677 self.evtType = [evtType]
2678
2679
2680 def Bind(self, target, id1, id2, function):
2681 """Bind this set of event types to target."""
2682 for et in self.evtType:
2683 target.Connect(id1, id2, et, function)
2684
66c033b4
RD
2685
2686 def Unbind(self, target, id1, id2):
2687 """Remove an event binding."""
2688 success = 0
2689 for et in self.evtType:
2690 success += target.Disconnect(id1, id2, et)
2691 return success != 0
2692
d14a1e28
RD
2693
2694 def __call__(self, *args):
2695 """
2696 For backwards compatibility with the old EVT_* functions.
2697 Should be called with either (window, func), (window, ID,
2698 func) or (window, ID1, ID2, func) parameters depending on the
2699 type of the event.
2700 """
2701 assert len(args) == 2 + self.expectedIDs
2702 id1 = wx.ID_ANY
2703 id2 = wx.ID_ANY
2704 target = args[0]
2705 if self.expectedIDs == 0:
2706 func = args[1]
2707 elif self.expectedIDs == 1:
2708 id1 = args[1]
2709 func = args[2]
2710 elif self.expectedIDs == 2:
2711 id1 = args[1]
2712 id2 = args[2]
2713 func = args[3]
2714 else:
2715 raise ValueError, "Unexpected number of IDs"
2716
2717 self.Bind(target, id1, id2, func)
2718
2719
2720# These two are square pegs that don't fit the PyEventBinder hole...
2721def EVT_COMMAND(win, id, cmd, func):
2722 win.Connect(id, -1, cmd, func)
2723def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2724 win.Connect(id1, id2, cmd, func)
2725
2726
2727#---------------------------------------------------------------------------
2728
2729#---------------------------------------------------------------------------
2730
54f9ee45
RD
2731EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2732EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
d14a1e28 2733
e811c8ce
RD
2734def NewEventType(*args, **kwargs):
2735 """NewEventType() -> wxEventType"""
54f9ee45
RD
2736 return _core_.NewEventType(*args, **kwargs)
2737wxEVT_NULL = _core_.wxEVT_NULL
2738wxEVT_FIRST = _core_.wxEVT_FIRST
2739wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2740wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2741wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2742wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2743wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2744wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2745wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2746wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2747wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2748wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2749wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2750wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2751wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2752wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2753wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2754wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2755wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2756wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2757wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2758wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2759wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2760wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2761wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2762wxEVT_MOTION = _core_.wxEVT_MOTION
2763wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2764wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2765wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2766wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2767wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2768wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2769wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2770wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2771wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2772wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2773wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2774wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2775wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2776wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2777wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2778wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2779wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2780wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2781wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2782wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2783wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2784wxEVT_CHAR = _core_.wxEVT_CHAR
2785wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2786wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2787wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2788wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2789wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2790wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2791wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2792wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2793wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2794wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2795wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2796wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2797wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2798wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2799wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2800wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2801wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2802wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2803wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2804wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2805wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2806wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2807wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2808wxEVT_SIZE = _core_.wxEVT_SIZE
2809wxEVT_MOVE = _core_.wxEVT_MOVE
2810wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2811wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2812wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2813wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2814wxEVT_POWER = _core_.wxEVT_POWER
2815wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2816wxEVT_CREATE = _core_.wxEVT_CREATE
2817wxEVT_DESTROY = _core_.wxEVT_DESTROY
2818wxEVT_SHOW = _core_.wxEVT_SHOW
2819wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2820wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2821wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2822wxEVT_PAINT = _core_.wxEVT_PAINT
2823wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2824wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2825wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2826wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2827wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2828wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2829wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2830wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2831wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2832wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2833wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2834wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2835wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2836wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2837wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2838wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2839wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2840wxEVT_IDLE = _core_.wxEVT_IDLE
2841wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2842wxEVT_SIZING = _core_.wxEVT_SIZING
2843wxEVT_MOVING = _core_.wxEVT_MOVING
2844wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2845wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2846wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2847wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2848wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2849wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2850wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
d14a1e28
RD
2851#
2852# Create some event binders
2853EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2854EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2855EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2856EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2857EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2858EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2859EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2860EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2861EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2862EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2863EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2864EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2865EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2866EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2867EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2868EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2869EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2870EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2871EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2872EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2873EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2874EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2875EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2876EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2877EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2878EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2879EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
2880EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
2881EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
2882EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
2883EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
2884EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
2885EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
2886EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
2887EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
2888EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
2889EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
2890EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
2891EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
2892EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
2893
2894EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
2895EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
2896EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
2897EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
2898EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
2899EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
2900EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
2901EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
2902EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
2903EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
2904EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
2905EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
2906EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
2907
2908EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
2909 wxEVT_LEFT_UP,
2910 wxEVT_MIDDLE_DOWN,
2911 wxEVT_MIDDLE_UP,
2912 wxEVT_RIGHT_DOWN,
2913 wxEVT_RIGHT_UP,
2914 wxEVT_MOTION,
2915 wxEVT_LEFT_DCLICK,
2916 wxEVT_MIDDLE_DCLICK,
2917 wxEVT_RIGHT_DCLICK,
2918 wxEVT_ENTER_WINDOW,
2919 wxEVT_LEAVE_WINDOW,
2920 wxEVT_MOUSEWHEEL
2921 ])
2922
2923
2924# Scrolling from wxWindow (sent to wxScrolledWindow)
2925EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
2926 wxEVT_SCROLLWIN_BOTTOM,
2927 wxEVT_SCROLLWIN_LINEUP,
2928 wxEVT_SCROLLWIN_LINEDOWN,
2929 wxEVT_SCROLLWIN_PAGEUP,
2930 wxEVT_SCROLLWIN_PAGEDOWN,
2931 wxEVT_SCROLLWIN_THUMBTRACK,
2932 wxEVT_SCROLLWIN_THUMBRELEASE,
2933 ])
2934
2935EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
2936EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
2937EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
2938EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
2939EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
2940EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
2941EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
2942EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
2943
2944# Scrolling from wxSlider and wxScrollBar
2945EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2946 wxEVT_SCROLL_BOTTOM,
2947 wxEVT_SCROLL_LINEUP,
2948 wxEVT_SCROLL_LINEDOWN,
2949 wxEVT_SCROLL_PAGEUP,
2950 wxEVT_SCROLL_PAGEDOWN,
2951 wxEVT_SCROLL_THUMBTRACK,
2952 wxEVT_SCROLL_THUMBRELEASE,
2953 wxEVT_SCROLL_ENDSCROLL,
2954 ])
2955
2956EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
2957EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
2958EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
2959EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
2960EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
2961EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
2962EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
2963EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
2964EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
2965
2966# Scrolling from wxSlider and wxScrollBar, with an id
2967EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
2968 wxEVT_SCROLL_BOTTOM,
2969 wxEVT_SCROLL_LINEUP,
2970 wxEVT_SCROLL_LINEDOWN,
2971 wxEVT_SCROLL_PAGEUP,
2972 wxEVT_SCROLL_PAGEDOWN,
2973 wxEVT_SCROLL_THUMBTRACK,
2974 wxEVT_SCROLL_THUMBRELEASE,
2975 wxEVT_SCROLL_ENDSCROLL,
2976 ], 1)
2977
2978EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
2979EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
2980EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
2981EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
2982EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
2983EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
2984EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
2985EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
2986EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
2987
d14a1e28
RD
2988EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
2989EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
2990EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
2991EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
2992EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
2993EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
2994EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
2995EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
2996EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
2997EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
2998
2999EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3000EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3001EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3002EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3003EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3004EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3005EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3006EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3007EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3008
3009
3010EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3011EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3012EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3013EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3014EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3015EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3016EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3017
3018EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3019
3020EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3021EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3022
3023EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3024
3025
3026
3027#---------------------------------------------------------------------------
3028
3029class Event(Object):
e811c8ce
RD
3030 def __init__(self): raise RuntimeError, "No constructor defined"
3031 def __repr__(self):
3032 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 3033 def __del__(self, destroy=_core_.delete_Event):
a95a7133 3034 """__del__(self)"""
d14a1e28
RD
3035 try:
3036 if self.thisown: destroy(self)
3037 except: pass
e811c8ce
RD
3038
3039 def SetEventType(*args, **kwargs):
a95a7133 3040 """SetEventType(self, wxEventType typ)"""
54f9ee45 3041 return _core_.Event_SetEventType(*args, **kwargs)
e811c8ce
RD
3042
3043 def GetEventType(*args, **kwargs):
a95a7133 3044 """GetEventType(self) -> wxEventType"""
54f9ee45 3045 return _core_.Event_GetEventType(*args, **kwargs)
e811c8ce
RD
3046
3047 def GetEventObject(*args, **kwargs):
a95a7133 3048 """GetEventObject(self) -> Object"""
54f9ee45 3049 return _core_.Event_GetEventObject(*args, **kwargs)
e811c8ce
RD
3050
3051 def SetEventObject(*args, **kwargs):
a95a7133 3052 """SetEventObject(self, Object obj)"""
54f9ee45 3053 return _core_.Event_SetEventObject(*args, **kwargs)
e811c8ce
RD
3054
3055 def GetTimestamp(*args, **kwargs):
a95a7133 3056 """GetTimestamp(self) -> long"""
54f9ee45 3057 return _core_.Event_GetTimestamp(*args, **kwargs)
e811c8ce
RD
3058
3059 def SetTimestamp(*args, **kwargs):
a95a7133 3060 """SetTimestamp(self, long ts=0)"""
54f9ee45 3061 return _core_.Event_SetTimestamp(*args, **kwargs)
e811c8ce
RD
3062
3063 def GetId(*args, **kwargs):
a95a7133 3064 """GetId(self) -> int"""
54f9ee45 3065 return _core_.Event_GetId(*args, **kwargs)
e811c8ce
RD
3066
3067 def SetId(*args, **kwargs):
a95a7133 3068 """SetId(self, int Id)"""
54f9ee45 3069 return _core_.Event_SetId(*args, **kwargs)
e811c8ce
RD
3070
3071 def IsCommandEvent(*args, **kwargs):
a95a7133 3072 """IsCommandEvent(self) -> bool"""
54f9ee45 3073 return _core_.Event_IsCommandEvent(*args, **kwargs)
e811c8ce
RD
3074
3075 def Skip(*args, **kwargs):
a95a7133 3076 """Skip(self, bool skip=True)"""
54f9ee45 3077 return _core_.Event_Skip(*args, **kwargs)
e811c8ce
RD
3078
3079 def GetSkipped(*args, **kwargs):
a95a7133 3080 """GetSkipped(self) -> bool"""
54f9ee45 3081 return _core_.Event_GetSkipped(*args, **kwargs)
e811c8ce
RD
3082
3083 def ShouldPropagate(*args, **kwargs):
a95a7133 3084 """ShouldPropagate(self) -> bool"""
54f9ee45 3085 return _core_.Event_ShouldPropagate(*args, **kwargs)
e811c8ce
RD
3086
3087 def StopPropagation(*args, **kwargs):
a95a7133 3088 """StopPropagation(self) -> int"""
54f9ee45 3089 return _core_.Event_StopPropagation(*args, **kwargs)
e811c8ce
RD
3090
3091 def ResumePropagation(*args, **kwargs):
a95a7133 3092 """ResumePropagation(self, int propagationLevel)"""
54f9ee45 3093 return _core_.Event_ResumePropagation(*args, **kwargs)
e811c8ce
RD
3094
3095 def Clone(*args, **kwargs):
a95a7133 3096 """Clone(self) -> Event"""
54f9ee45 3097 return _core_.Event_Clone(*args, **kwargs)
e811c8ce 3098
d14a1e28
RD
3099
3100class EventPtr(Event):
3101 def __init__(self, this):
3102 self.this = this
3103 if not hasattr(self,"thisown"): self.thisown = 0
3104 self.__class__ = Event
54f9ee45 3105_core_.Event_swigregister(EventPtr)
d14a1e28
RD
3106
3107#---------------------------------------------------------------------------
3108
3109class PropagationDisabler(object):
e811c8ce
RD
3110 def __repr__(self):
3111 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3112 def __init__(self, *args, **kwargs):
a95a7133 3113 """__init__(self, Event event) -> PropagationDisabler"""
54f9ee45 3114 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
d14a1e28
RD
3115 self.this = newobj.this
3116 self.thisown = 1
3117 del newobj.thisown
54f9ee45 3118 def __del__(self, destroy=_core_.delete_PropagationDisabler):
a95a7133 3119 """__del__(self)"""
d14a1e28
RD
3120 try:
3121 if self.thisown: destroy(self)
3122 except: pass
e811c8ce 3123
d14a1e28
RD
3124
3125class PropagationDisablerPtr(PropagationDisabler):
3126 def __init__(self, this):
3127 self.this = this
3128 if not hasattr(self,"thisown"): self.thisown = 0
3129 self.__class__ = PropagationDisabler
54f9ee45 3130_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
d14a1e28
RD
3131
3132class PropagateOnce(object):
e811c8ce
RD
3133 def __repr__(self):
3134 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3135 def __init__(self, *args, **kwargs):
a95a7133 3136 """__init__(self, Event event) -> PropagateOnce"""
54f9ee45 3137 newobj = _core_.new_PropagateOnce(*args, **kwargs)
d14a1e28
RD
3138 self.this = newobj.this
3139 self.thisown = 1
3140 del newobj.thisown
54f9ee45 3141 def __del__(self, destroy=_core_.delete_PropagateOnce):
a95a7133 3142 """__del__(self)"""
d14a1e28
RD
3143 try:
3144 if self.thisown: destroy(self)
3145 except: pass
e811c8ce 3146
d14a1e28
RD
3147
3148class PropagateOncePtr(PropagateOnce):
3149 def __init__(self, this):
3150 self.this = this
3151 if not hasattr(self,"thisown"): self.thisown = 0
3152 self.__class__ = PropagateOnce
54f9ee45 3153_core_.PropagateOnce_swigregister(PropagateOncePtr)
d14a1e28
RD
3154
3155#---------------------------------------------------------------------------
3156
3157class CommandEvent(Event):
e811c8ce
RD
3158 def __repr__(self):
3159 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3160 def __init__(self, *args, **kwargs):
a95a7133 3161 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
54f9ee45 3162 newobj = _core_.new_CommandEvent(*args, **kwargs)
d14a1e28
RD
3163 self.this = newobj.this
3164 self.thisown = 1
3165 del newobj.thisown
e811c8ce 3166 def GetSelection(*args, **kwargs):
a95a7133 3167 """GetSelection(self) -> int"""
54f9ee45 3168 return _core_.CommandEvent_GetSelection(*args, **kwargs)
e811c8ce
RD
3169
3170 def SetString(*args, **kwargs):
a95a7133 3171 """SetString(self, String s)"""
54f9ee45 3172 return _core_.CommandEvent_SetString(*args, **kwargs)
e811c8ce
RD
3173
3174 def GetString(*args, **kwargs):
a95a7133 3175 """GetString(self) -> String"""
54f9ee45 3176 return _core_.CommandEvent_GetString(*args, **kwargs)
e811c8ce
RD
3177
3178 def IsChecked(*args, **kwargs):
a95a7133 3179 """IsChecked(self) -> bool"""
54f9ee45 3180 return _core_.CommandEvent_IsChecked(*args, **kwargs)
e811c8ce 3181
242b7b46 3182 Checked = IsChecked
e811c8ce 3183 def IsSelection(*args, **kwargs):
a95a7133 3184 """IsSelection(self) -> bool"""
54f9ee45 3185 return _core_.CommandEvent_IsSelection(*args, **kwargs)
e811c8ce
RD
3186
3187 def SetExtraLong(*args, **kwargs):
a95a7133 3188 """SetExtraLong(self, long extraLong)"""
54f9ee45 3189 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
e811c8ce
RD
3190
3191 def GetExtraLong(*args, **kwargs):
a95a7133 3192 """GetExtraLong(self) -> long"""
54f9ee45 3193 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
e811c8ce
RD
3194
3195 def SetInt(*args, **kwargs):
a95a7133 3196 """SetInt(self, int i)"""
54f9ee45 3197 return _core_.CommandEvent_SetInt(*args, **kwargs)
e811c8ce
RD
3198
3199 def GetInt(*args, **kwargs):
a95a7133 3200 """GetInt(self) -> long"""
54f9ee45 3201 return _core_.CommandEvent_GetInt(*args, **kwargs)
e811c8ce
RD
3202
3203 def Clone(*args, **kwargs):
a95a7133 3204 """Clone(self) -> Event"""
54f9ee45 3205 return _core_.CommandEvent_Clone(*args, **kwargs)
e811c8ce 3206
d14a1e28
RD
3207
3208class CommandEventPtr(CommandEvent):
3209 def __init__(self, this):
3210 self.this = this
3211 if not hasattr(self,"thisown"): self.thisown = 0
3212 self.__class__ = CommandEvent
54f9ee45 3213_core_.CommandEvent_swigregister(CommandEventPtr)
d14a1e28
RD
3214
3215#---------------------------------------------------------------------------
3216
3217class NotifyEvent(CommandEvent):
e811c8ce
RD
3218 def __repr__(self):
3219 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3220 def __init__(self, *args, **kwargs):
a95a7133 3221 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
54f9ee45 3222 newobj = _core_.new_NotifyEvent(*args, **kwargs)
d14a1e28
RD
3223 self.this = newobj.this
3224 self.thisown = 1
3225 del newobj.thisown
e811c8ce 3226 def Veto(*args, **kwargs):
a95a7133 3227 """Veto(self)"""
54f9ee45 3228 return _core_.NotifyEvent_Veto(*args, **kwargs)
e811c8ce
RD
3229
3230 def Allow(*args, **kwargs):
a95a7133 3231 """Allow(self)"""
54f9ee45 3232 return _core_.NotifyEvent_Allow(*args, **kwargs)
e811c8ce
RD
3233
3234 def IsAllowed(*args, **kwargs):
a95a7133 3235 """IsAllowed(self) -> bool"""
54f9ee45 3236 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
e811c8ce 3237
d14a1e28
RD
3238
3239class NotifyEventPtr(NotifyEvent):
3240 def __init__(self, this):
3241 self.this = this
3242 if not hasattr(self,"thisown"): self.thisown = 0
3243 self.__class__ = NotifyEvent
54f9ee45 3244_core_.NotifyEvent_swigregister(NotifyEventPtr)
d14a1e28
RD
3245
3246#---------------------------------------------------------------------------
3247
3248class ScrollEvent(CommandEvent):
e811c8ce
RD
3249 def __repr__(self):
3250 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3251 def __init__(self, *args, **kwargs):
0df68c9f 3252 """
a95a7133 3253 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
0df68c9f
RD
3254 int orient=0) -> ScrollEvent
3255 """
54f9ee45 3256 newobj = _core_.new_ScrollEvent(*args, **kwargs)
d14a1e28
RD
3257 self.this = newobj.this
3258 self.thisown = 1
3259 del newobj.thisown
e811c8ce 3260 def GetOrientation(*args, **kwargs):
a95a7133 3261 """GetOrientation(self) -> int"""
54f9ee45 3262 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3263
3264 def GetPosition(*args, **kwargs):
a95a7133 3265 """GetPosition(self) -> int"""
54f9ee45 3266 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3267
3268 def SetOrientation(*args, **kwargs):
a95a7133 3269 """SetOrientation(self, int orient)"""
54f9ee45 3270 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3271
3272 def SetPosition(*args, **kwargs):
a95a7133 3273 """SetPosition(self, int pos)"""
54f9ee45 3274 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
e811c8ce 3275
d14a1e28
RD
3276
3277class ScrollEventPtr(ScrollEvent):
3278 def __init__(self, this):
3279 self.this = this
3280 if not hasattr(self,"thisown"): self.thisown = 0
3281 self.__class__ = ScrollEvent
54f9ee45 3282_core_.ScrollEvent_swigregister(ScrollEventPtr)
d14a1e28
RD
3283
3284#---------------------------------------------------------------------------
3285
3286class ScrollWinEvent(Event):
e811c8ce
RD
3287 def __repr__(self):
3288 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3289 def __init__(self, *args, **kwargs):
a95a7133 3290 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
54f9ee45 3291 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
d14a1e28
RD
3292 self.this = newobj.this
3293 self.thisown = 1
3294 del newobj.thisown
e811c8ce 3295 def GetOrientation(*args, **kwargs):
a95a7133 3296 """GetOrientation(self) -> int"""
54f9ee45 3297 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
e811c8ce
RD
3298
3299 def GetPosition(*args, **kwargs):
a95a7133 3300 """GetPosition(self) -> int"""
54f9ee45 3301 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3302
3303 def SetOrientation(*args, **kwargs):
a95a7133 3304 """SetOrientation(self, int orient)"""
54f9ee45 3305 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
e811c8ce
RD
3306
3307 def SetPosition(*args, **kwargs):
a95a7133 3308 """SetPosition(self, int pos)"""
54f9ee45 3309 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
e811c8ce 3310
d14a1e28
RD
3311
3312class ScrollWinEventPtr(ScrollWinEvent):
3313 def __init__(self, this):
3314 self.this = this
3315 if not hasattr(self,"thisown"): self.thisown = 0
3316 self.__class__ = ScrollWinEvent
54f9ee45 3317_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
d14a1e28
RD
3318
3319#---------------------------------------------------------------------------
3320
54f9ee45
RD
3321MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3322MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3323MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3324MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3325MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
d14a1e28 3326class MouseEvent(Event):
e811c8ce
RD
3327 def __repr__(self):
3328 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3329 def __init__(self, *args, **kwargs):
a95a7133 3330 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
54f9ee45 3331 newobj = _core_.new_MouseEvent(*args, **kwargs)
d14a1e28
RD
3332 self.this = newobj.this
3333 self.thisown = 1
3334 del newobj.thisown
e811c8ce 3335 def IsButton(*args, **kwargs):
a95a7133 3336 """IsButton(self) -> bool"""
54f9ee45 3337 return _core_.MouseEvent_IsButton(*args, **kwargs)
e811c8ce
RD
3338
3339 def ButtonDown(*args, **kwargs):
a95a7133 3340 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3341 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
e811c8ce
RD
3342
3343 def ButtonDClick(*args, **kwargs):
a95a7133 3344 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3345 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
e811c8ce
RD
3346
3347 def ButtonUp(*args, **kwargs):
a95a7133 3348 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
54f9ee45 3349 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
e811c8ce
RD
3350
3351 def Button(*args, **kwargs):
a95a7133 3352 """Button(self, int but) -> bool"""
54f9ee45 3353 return _core_.MouseEvent_Button(*args, **kwargs)
e811c8ce
RD
3354
3355 def ButtonIsDown(*args, **kwargs):
a95a7133 3356 """ButtonIsDown(self, int but) -> bool"""
54f9ee45 3357 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
e811c8ce
RD
3358
3359 def GetButton(*args, **kwargs):
a95a7133 3360 """GetButton(self) -> int"""
54f9ee45 3361 return _core_.MouseEvent_GetButton(*args, **kwargs)
e811c8ce
RD
3362
3363 def ControlDown(*args, **kwargs):
a95a7133 3364 """ControlDown(self) -> bool"""
54f9ee45 3365 return _core_.MouseEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3366
3367 def MetaDown(*args, **kwargs):
a95a7133 3368 """MetaDown(self) -> bool"""
54f9ee45 3369 return _core_.MouseEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3370
3371 def AltDown(*args, **kwargs):
a95a7133 3372 """AltDown(self) -> bool"""
54f9ee45 3373 return _core_.MouseEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3374
3375 def ShiftDown(*args, **kwargs):
a95a7133 3376 """ShiftDown(self) -> bool"""
54f9ee45 3377 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
e811c8ce 3378
412d302d
RD
3379 def CmdDown(*args, **kwargs):
3380 """
3381 CmdDown(self) -> bool
3382
3383 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3384 platforms but the special "Apple" (a.k.a as "Command") key on
3385 Macs: it makes often sense to use it instead of, say, `ControlDown`
3386 because Cmd key is used for the same thing under Mac as Ctrl
3387 elsewhere. The Ctrl still exists, it's just not used for this
3388 purpose. So for non-Mac platforms this is the same as `ControlDown`
3389 and Macs this is the same as `MetaDown`.
3390 """
3391 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3392
e811c8ce 3393 def LeftDown(*args, **kwargs):
a95a7133 3394 """LeftDown(self) -> bool"""
54f9ee45 3395 return _core_.MouseEvent_LeftDown(*args, **kwargs)
e811c8ce
RD
3396
3397 def MiddleDown(*args, **kwargs):
a95a7133 3398 """MiddleDown(self) -> bool"""
54f9ee45 3399 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
e811c8ce
RD
3400
3401 def RightDown(*args, **kwargs):
a95a7133 3402 """RightDown(self) -> bool"""
54f9ee45 3403 return _core_.MouseEvent_RightDown(*args, **kwargs)
e811c8ce
RD
3404
3405 def LeftUp(*args, **kwargs):
a95a7133 3406 """LeftUp(self) -> bool"""
54f9ee45 3407 return _core_.MouseEvent_LeftUp(*args, **kwargs)
e811c8ce
RD
3408
3409 def MiddleUp(*args, **kwargs):
a95a7133 3410 """MiddleUp(self) -> bool"""
54f9ee45 3411 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
e811c8ce
RD
3412
3413 def RightUp(*args, **kwargs):
a95a7133 3414 """RightUp(self) -> bool"""
54f9ee45 3415 return _core_.MouseEvent_RightUp(*args, **kwargs)
e811c8ce
RD
3416
3417 def LeftDClick(*args, **kwargs):
a95a7133 3418 """LeftDClick(self) -> bool"""
54f9ee45 3419 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
e811c8ce
RD
3420
3421 def MiddleDClick(*args, **kwargs):
a95a7133 3422 """MiddleDClick(self) -> bool"""
54f9ee45 3423 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
e811c8ce
RD
3424
3425 def RightDClick(*args, **kwargs):
a95a7133 3426 """RightDClick(self) -> bool"""
54f9ee45 3427 return _core_.MouseEvent_RightDClick(*args, **kwargs)
e811c8ce
RD
3428
3429 def LeftIsDown(*args, **kwargs):
a95a7133 3430 """LeftIsDown(self) -> bool"""
54f9ee45 3431 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
e811c8ce
RD
3432
3433 def MiddleIsDown(*args, **kwargs):
a95a7133 3434 """MiddleIsDown(self) -> bool"""
54f9ee45 3435 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
e811c8ce
RD
3436
3437 def RightIsDown(*args, **kwargs):
a95a7133 3438 """RightIsDown(self) -> bool"""
54f9ee45 3439 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
e811c8ce
RD
3440
3441 def Dragging(*args, **kwargs):
a95a7133 3442 """Dragging(self) -> bool"""
54f9ee45 3443 return _core_.MouseEvent_Dragging(*args, **kwargs)
e811c8ce
RD
3444
3445 def Moving(*args, **kwargs):
a95a7133 3446 """Moving(self) -> bool"""
54f9ee45 3447 return _core_.MouseEvent_Moving(*args, **kwargs)
e811c8ce
RD
3448
3449 def Entering(*args, **kwargs):
a95a7133 3450 """Entering(self) -> bool"""
54f9ee45 3451 return _core_.MouseEvent_Entering(*args, **kwargs)
e811c8ce
RD
3452
3453 def Leaving(*args, **kwargs):
a95a7133 3454 """Leaving(self) -> bool"""
54f9ee45 3455 return _core_.MouseEvent_Leaving(*args, **kwargs)
e811c8ce
RD
3456
3457 def GetPosition(*args, **kwargs):
0df68c9f 3458 """
a95a7133 3459 GetPosition(self) -> Point
e811c8ce 3460
41e2b43e
RD
3461 Returns the position of the mouse in window coordinates when the event
3462 happened.
0df68c9f 3463 """
54f9ee45 3464 return _core_.MouseEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3465
3466 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3467 """
3468 GetPositionTuple() -> (x,y)
e811c8ce 3469
41e2b43e
RD
3470 Returns the position of the mouse in window coordinates when the event
3471 happened.
0df68c9f 3472 """
54f9ee45 3473 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3474
3475 def GetLogicalPosition(*args, **kwargs):
a95a7133 3476 """GetLogicalPosition(self, DC dc) -> Point"""
54f9ee45 3477 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
e811c8ce
RD
3478
3479 def GetX(*args, **kwargs):
a95a7133 3480 """GetX(self) -> int"""
54f9ee45 3481 return _core_.MouseEvent_GetX(*args, **kwargs)
e811c8ce
RD
3482
3483 def GetY(*args, **kwargs):
a95a7133 3484 """GetY(self) -> int"""
54f9ee45 3485 return _core_.MouseEvent_GetY(*args, **kwargs)
e811c8ce
RD
3486
3487 def GetWheelRotation(*args, **kwargs):
a95a7133 3488 """GetWheelRotation(self) -> int"""
54f9ee45 3489 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
e811c8ce
RD
3490
3491 def GetWheelDelta(*args, **kwargs):
a95a7133 3492 """GetWheelDelta(self) -> int"""
54f9ee45 3493 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
e811c8ce
RD
3494
3495 def GetLinesPerAction(*args, **kwargs):
a95a7133 3496 """GetLinesPerAction(self) -> int"""
54f9ee45 3497 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
e811c8ce
RD
3498
3499 def IsPageScroll(*args, **kwargs):
a95a7133 3500 """IsPageScroll(self) -> bool"""
54f9ee45
RD
3501 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3502
3503 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3504 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3505 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3506 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3507 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3508 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3509 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3510 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3511 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3512 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3513 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3514 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
d14a1e28
RD
3515
3516class MouseEventPtr(MouseEvent):
3517 def __init__(self, this):
3518 self.this = this
3519 if not hasattr(self,"thisown"): self.thisown = 0
3520 self.__class__ = MouseEvent
54f9ee45 3521_core_.MouseEvent_swigregister(MouseEventPtr)
d14a1e28
RD
3522
3523#---------------------------------------------------------------------------
3524
3525class SetCursorEvent(Event):
e811c8ce
RD
3526 def __repr__(self):
3527 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3528 def __init__(self, *args, **kwargs):
a95a7133 3529 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
54f9ee45 3530 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
d14a1e28
RD
3531 self.this = newobj.this
3532 self.thisown = 1
3533 del newobj.thisown
e811c8ce 3534 def GetX(*args, **kwargs):
a95a7133 3535 """GetX(self) -> int"""
54f9ee45 3536 return _core_.SetCursorEvent_GetX(*args, **kwargs)
e811c8ce
RD
3537
3538 def GetY(*args, **kwargs):
a95a7133 3539 """GetY(self) -> int"""
54f9ee45 3540 return _core_.SetCursorEvent_GetY(*args, **kwargs)
e811c8ce
RD
3541
3542 def SetCursor(*args, **kwargs):
a95a7133 3543 """SetCursor(self, Cursor cursor)"""
54f9ee45 3544 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
e811c8ce
RD
3545
3546 def GetCursor(*args, **kwargs):
a95a7133 3547 """GetCursor(self) -> Cursor"""
54f9ee45 3548 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
e811c8ce
RD
3549
3550 def HasCursor(*args, **kwargs):
a95a7133 3551 """HasCursor(self) -> bool"""
54f9ee45 3552 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
e811c8ce 3553
d14a1e28
RD
3554
3555class SetCursorEventPtr(SetCursorEvent):
3556 def __init__(self, this):
3557 self.this = this
3558 if not hasattr(self,"thisown"): self.thisown = 0
3559 self.__class__ = SetCursorEvent
54f9ee45 3560_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
d14a1e28
RD
3561
3562#---------------------------------------------------------------------------
3563
3564class KeyEvent(Event):
e811c8ce
RD
3565 def __repr__(self):
3566 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3567 def __init__(self, *args, **kwargs):
a95a7133 3568 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
54f9ee45 3569 newobj = _core_.new_KeyEvent(*args, **kwargs)
d14a1e28
RD
3570 self.this = newobj.this
3571 self.thisown = 1
3572 del newobj.thisown
e811c8ce 3573 def ControlDown(*args, **kwargs):
a95a7133 3574 """ControlDown(self) -> bool"""
54f9ee45 3575 return _core_.KeyEvent_ControlDown(*args, **kwargs)
e811c8ce
RD
3576
3577 def MetaDown(*args, **kwargs):
a95a7133 3578 """MetaDown(self) -> bool"""
54f9ee45 3579 return _core_.KeyEvent_MetaDown(*args, **kwargs)
e811c8ce
RD
3580
3581 def AltDown(*args, **kwargs):
a95a7133 3582 """AltDown(self) -> bool"""
54f9ee45 3583 return _core_.KeyEvent_AltDown(*args, **kwargs)
e811c8ce
RD
3584
3585 def ShiftDown(*args, **kwargs):
a95a7133 3586 """ShiftDown(self) -> bool"""
54f9ee45 3587 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
e811c8ce 3588
412d302d
RD
3589 def CmdDown(*args, **kwargs):
3590 """
3591 CmdDown(self) -> bool
3592
3593 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3594 platforms but the special "Apple" (a.k.a as "Command") key on
3595 Macs: it makes often sense to use it instead of, say, `ControlDown`
3596 because Cmd key is used for the same thing under Mac as Ctrl
3597 elsewhere. The Ctrl still exists, it's just not used for this
3598 purpose. So for non-Mac platforms this is the same as `ControlDown`
3599 and Macs this is the same as `MetaDown`.
3600 """
3601 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3602
e811c8ce 3603 def HasModifiers(*args, **kwargs):
a95a7133 3604 """HasModifiers(self) -> bool"""
54f9ee45 3605 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
e811c8ce
RD
3606
3607 def GetKeyCode(*args, **kwargs):
a95a7133 3608 """GetKeyCode(self) -> int"""
54f9ee45 3609 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
e811c8ce 3610
d14a1e28 3611 KeyCode = GetKeyCode
19272049
RD
3612 def GetUnicodeKey(*args, **kwargs):
3613 """GetUnicodeKey(self) -> int"""
3614 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
e811c8ce 3615
19272049 3616 GetUniChar = GetUnicodeKey
e811c8ce 3617 def GetRawKeyCode(*args, **kwargs):
a95a7133 3618 """GetRawKeyCode(self) -> unsigned int"""
54f9ee45 3619 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
e811c8ce
RD
3620
3621 def GetRawKeyFlags(*args, **kwargs):
a95a7133 3622 """GetRawKeyFlags(self) -> unsigned int"""
54f9ee45 3623 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
e811c8ce
RD
3624
3625 def GetPosition(*args, **kwargs):
0df68c9f 3626 """
a95a7133 3627 GetPosition(self) -> Point
e811c8ce 3628
0df68c9f
RD
3629 Find the position of the event.
3630 """
54f9ee45 3631 return _core_.KeyEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3632
3633 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
3634 """
3635 GetPositionTuple() -> (x,y)
e811c8ce 3636
0df68c9f
RD
3637 Find the position of the event.
3638 """
54f9ee45 3639 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
3640
3641 def GetX(*args, **kwargs):
a95a7133 3642 """GetX(self) -> int"""
54f9ee45 3643 return _core_.KeyEvent_GetX(*args, **kwargs)
e811c8ce
RD
3644
3645 def GetY(*args, **kwargs):
a95a7133 3646 """GetY(self) -> int"""
54f9ee45
RD
3647 return _core_.KeyEvent_GetY(*args, **kwargs)
3648
3649 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3650 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3651 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3652 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3653 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3654 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3655 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3656 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3657 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3658 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
d14a1e28
RD
3659
3660class KeyEventPtr(KeyEvent):
3661 def __init__(self, this):
3662 self.this = this
3663 if not hasattr(self,"thisown"): self.thisown = 0
3664 self.__class__ = KeyEvent
54f9ee45 3665_core_.KeyEvent_swigregister(KeyEventPtr)
d14a1e28
RD
3666
3667#---------------------------------------------------------------------------
3668
3669class SizeEvent(Event):
e811c8ce
RD
3670 def __repr__(self):
3671 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3672 def __init__(self, *args, **kwargs):
a95a7133 3673 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
54f9ee45 3674 newobj = _core_.new_SizeEvent(*args, **kwargs)
d14a1e28
RD
3675 self.this = newobj.this
3676 self.thisown = 1
3677 del newobj.thisown
e811c8ce 3678 def GetSize(*args, **kwargs):
a95a7133 3679 """GetSize(self) -> Size"""
54f9ee45 3680 return _core_.SizeEvent_GetSize(*args, **kwargs)
e811c8ce
RD
3681
3682 def GetRect(*args, **kwargs):
a95a7133 3683 """GetRect(self) -> Rect"""
54f9ee45 3684 return _core_.SizeEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3685
3686 def SetRect(*args, **kwargs):
a95a7133 3687 """SetRect(self, Rect rect)"""
54f9ee45 3688 return _core_.SizeEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3689
3690 def SetSize(*args, **kwargs):
a95a7133 3691 """SetSize(self, Size size)"""
54f9ee45 3692 return _core_.SizeEvent_SetSize(*args, **kwargs)
e811c8ce 3693
54f9ee45
RD
3694 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3695 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
d14a1e28
RD
3696
3697class SizeEventPtr(SizeEvent):
3698 def __init__(self, this):
3699 self.this = this
3700 if not hasattr(self,"thisown"): self.thisown = 0
3701 self.__class__ = SizeEvent
54f9ee45 3702_core_.SizeEvent_swigregister(SizeEventPtr)
d14a1e28
RD
3703
3704#---------------------------------------------------------------------------
3705
3706class MoveEvent(Event):
e811c8ce
RD
3707 def __repr__(self):
3708 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3709 def __init__(self, *args, **kwargs):
a95a7133 3710 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
54f9ee45 3711 newobj = _core_.new_MoveEvent(*args, **kwargs)
d14a1e28
RD
3712 self.this = newobj.this
3713 self.thisown = 1
3714 del newobj.thisown
e811c8ce 3715 def GetPosition(*args, **kwargs):
a95a7133 3716 """GetPosition(self) -> Point"""
54f9ee45 3717 return _core_.MoveEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
3718
3719 def GetRect(*args, **kwargs):
a95a7133 3720 """GetRect(self) -> Rect"""
54f9ee45 3721 return _core_.MoveEvent_GetRect(*args, **kwargs)
e811c8ce
RD
3722
3723 def SetRect(*args, **kwargs):
a95a7133 3724 """SetRect(self, Rect rect)"""
54f9ee45 3725 return _core_.MoveEvent_SetRect(*args, **kwargs)
e811c8ce
RD
3726
3727 def SetPosition(*args, **kwargs):
a95a7133 3728 """SetPosition(self, Point pos)"""
54f9ee45 3729 return _core_.MoveEvent_SetPosition(*args, **kwargs)
e811c8ce 3730
54f9ee45
RD
3731 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3732 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
d14a1e28
RD
3733
3734class MoveEventPtr(MoveEvent):
3735 def __init__(self, this):
3736 self.this = this
3737 if not hasattr(self,"thisown"): self.thisown = 0
3738 self.__class__ = MoveEvent
54f9ee45 3739_core_.MoveEvent_swigregister(MoveEventPtr)
d14a1e28
RD
3740
3741#---------------------------------------------------------------------------
3742
3743class PaintEvent(Event):
e811c8ce
RD
3744 def __repr__(self):
3745 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3746 def __init__(self, *args, **kwargs):
a95a7133 3747 """__init__(self, int Id=0) -> PaintEvent"""
54f9ee45 3748 newobj = _core_.new_PaintEvent(*args, **kwargs)
d14a1e28
RD
3749 self.this = newobj.this
3750 self.thisown = 1
3751 del newobj.thisown
d14a1e28
RD
3752
3753class PaintEventPtr(PaintEvent):
3754 def __init__(self, this):
3755 self.this = this
3756 if not hasattr(self,"thisown"): self.thisown = 0
3757 self.__class__ = PaintEvent
54f9ee45 3758_core_.PaintEvent_swigregister(PaintEventPtr)
d14a1e28
RD
3759
3760class NcPaintEvent(Event):
e811c8ce
RD
3761 def __repr__(self):
3762 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3763 def __init__(self, *args, **kwargs):
a95a7133 3764 """__init__(self, int winid=0) -> NcPaintEvent"""
54f9ee45 3765 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
d14a1e28
RD
3766 self.this = newobj.this
3767 self.thisown = 1
3768 del newobj.thisown
d14a1e28
RD
3769
3770class NcPaintEventPtr(NcPaintEvent):
3771 def __init__(self, this):
3772 self.this = this
3773 if not hasattr(self,"thisown"): self.thisown = 0
3774 self.__class__ = NcPaintEvent
54f9ee45 3775_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
d14a1e28
RD
3776
3777#---------------------------------------------------------------------------
3778
3779class EraseEvent(Event):
e811c8ce
RD
3780 def __repr__(self):
3781 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3782 def __init__(self, *args, **kwargs):
a95a7133 3783 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
54f9ee45 3784 newobj = _core_.new_EraseEvent(*args, **kwargs)
d14a1e28
RD
3785 self.this = newobj.this
3786 self.thisown = 1
3787 del newobj.thisown
e811c8ce 3788 def GetDC(*args, **kwargs):
a95a7133 3789 """GetDC(self) -> DC"""
54f9ee45 3790 return _core_.EraseEvent_GetDC(*args, **kwargs)
e811c8ce 3791
d14a1e28
RD
3792
3793class EraseEventPtr(EraseEvent):
3794 def __init__(self, this):
3795 self.this = this
3796 if not hasattr(self,"thisown"): self.thisown = 0
3797 self.__class__ = EraseEvent
54f9ee45 3798_core_.EraseEvent_swigregister(EraseEventPtr)
d14a1e28
RD
3799
3800#---------------------------------------------------------------------------
3801
3802class FocusEvent(Event):
e811c8ce
RD
3803 def __repr__(self):
3804 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3805 def __init__(self, *args, **kwargs):
a95a7133 3806 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
54f9ee45 3807 newobj = _core_.new_FocusEvent(*args, **kwargs)
d14a1e28
RD
3808 self.this = newobj.this
3809 self.thisown = 1
3810 del newobj.thisown
e811c8ce 3811 def GetWindow(*args, **kwargs):
a95a7133 3812 """GetWindow(self) -> Window"""
54f9ee45 3813 return _core_.FocusEvent_GetWindow(*args, **kwargs)
e811c8ce
RD
3814
3815 def SetWindow(*args, **kwargs):
a95a7133 3816 """SetWindow(self, Window win)"""
54f9ee45 3817 return _core_.FocusEvent_SetWindow(*args, **kwargs)
e811c8ce 3818
d14a1e28
RD
3819
3820class FocusEventPtr(FocusEvent):
3821 def __init__(self, this):
3822 self.this = this
3823 if not hasattr(self,"thisown"): self.thisown = 0
3824 self.__class__ = FocusEvent
54f9ee45 3825_core_.FocusEvent_swigregister(FocusEventPtr)
d14a1e28
RD
3826
3827#---------------------------------------------------------------------------
3828
3829class ChildFocusEvent(CommandEvent):
e811c8ce
RD
3830 def __repr__(self):
3831 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3832 def __init__(self, *args, **kwargs):
a95a7133 3833 """__init__(self, Window win=None) -> ChildFocusEvent"""
54f9ee45 3834 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
d14a1e28
RD
3835 self.this = newobj.this
3836 self.thisown = 1
3837 del newobj.thisown
e811c8ce 3838 def GetWindow(*args, **kwargs):
a95a7133 3839 """GetWindow(self) -> Window"""
54f9ee45 3840 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
e811c8ce 3841
d14a1e28
RD
3842
3843class ChildFocusEventPtr(ChildFocusEvent):
3844 def __init__(self, this):
3845 self.this = this
3846 if not hasattr(self,"thisown"): self.thisown = 0
3847 self.__class__ = ChildFocusEvent
54f9ee45 3848_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
d14a1e28
RD
3849
3850#---------------------------------------------------------------------------
3851
3852class ActivateEvent(Event):
e811c8ce
RD
3853 def __repr__(self):
3854 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3855 def __init__(self, *args, **kwargs):
a95a7133 3856 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
54f9ee45 3857 newobj = _core_.new_ActivateEvent(*args, **kwargs)
d14a1e28
RD
3858 self.this = newobj.this
3859 self.thisown = 1
3860 del newobj.thisown
e811c8ce 3861 def GetActive(*args, **kwargs):
a95a7133 3862 """GetActive(self) -> bool"""
54f9ee45 3863 return _core_.ActivateEvent_GetActive(*args, **kwargs)
e811c8ce 3864
d14a1e28
RD
3865
3866class ActivateEventPtr(ActivateEvent):
3867 def __init__(self, this):
3868 self.this = this
3869 if not hasattr(self,"thisown"): self.thisown = 0
3870 self.__class__ = ActivateEvent
54f9ee45 3871_core_.ActivateEvent_swigregister(ActivateEventPtr)
d14a1e28
RD
3872
3873#---------------------------------------------------------------------------
3874
3875class InitDialogEvent(Event):
e811c8ce
RD
3876 def __repr__(self):
3877 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3878 def __init__(self, *args, **kwargs):
a95a7133 3879 """__init__(self, int Id=0) -> InitDialogEvent"""
54f9ee45 3880 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
d14a1e28
RD
3881 self.this = newobj.this
3882 self.thisown = 1
3883 del newobj.thisown
d14a1e28
RD
3884
3885class InitDialogEventPtr(InitDialogEvent):
3886 def __init__(self, this):
3887 self.this = this
3888 if not hasattr(self,"thisown"): self.thisown = 0
3889 self.__class__ = InitDialogEvent
54f9ee45 3890_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
d14a1e28
RD
3891
3892#---------------------------------------------------------------------------
3893
3894class MenuEvent(Event):
e811c8ce
RD
3895 def __repr__(self):
3896 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3897 def __init__(self, *args, **kwargs):
a95a7133 3898 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
54f9ee45 3899 newobj = _core_.new_MenuEvent(*args, **kwargs)
d14a1e28
RD
3900 self.this = newobj.this
3901 self.thisown = 1
3902 del newobj.thisown
e811c8ce 3903 def GetMenuId(*args, **kwargs):
a95a7133 3904 """GetMenuId(self) -> int"""
54f9ee45 3905 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
e811c8ce
RD
3906
3907 def IsPopup(*args, **kwargs):
a95a7133 3908 """IsPopup(self) -> bool"""
54f9ee45 3909 return _core_.MenuEvent_IsPopup(*args, **kwargs)
e811c8ce
RD
3910
3911 def GetMenu(*args, **kwargs):
a95a7133 3912 """GetMenu(self) -> Menu"""
54f9ee45 3913 return _core_.MenuEvent_GetMenu(*args, **kwargs)
e811c8ce 3914
d14a1e28
RD
3915
3916class MenuEventPtr(MenuEvent):
3917 def __init__(self, this):
3918 self.this = this
3919 if not hasattr(self,"thisown"): self.thisown = 0
3920 self.__class__ = MenuEvent
54f9ee45 3921_core_.MenuEvent_swigregister(MenuEventPtr)
d14a1e28
RD
3922
3923#---------------------------------------------------------------------------
3924
3925class CloseEvent(Event):
e811c8ce
RD
3926 def __repr__(self):
3927 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3928 def __init__(self, *args, **kwargs):
a95a7133 3929 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
54f9ee45 3930 newobj = _core_.new_CloseEvent(*args, **kwargs)
d14a1e28
RD
3931 self.this = newobj.this
3932 self.thisown = 1
3933 del newobj.thisown
e811c8ce 3934 def SetLoggingOff(*args, **kwargs):
a95a7133 3935 """SetLoggingOff(self, bool logOff)"""
54f9ee45 3936 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
e811c8ce
RD
3937
3938 def GetLoggingOff(*args, **kwargs):
a95a7133 3939 """GetLoggingOff(self) -> bool"""
54f9ee45 3940 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
e811c8ce
RD
3941
3942 def Veto(*args, **kwargs):
a95a7133 3943 """Veto(self, bool veto=True)"""
54f9ee45 3944 return _core_.CloseEvent_Veto(*args, **kwargs)
e811c8ce
RD
3945
3946 def SetCanVeto(*args, **kwargs):
a95a7133 3947 """SetCanVeto(self, bool canVeto)"""
54f9ee45 3948 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
e811c8ce
RD
3949
3950 def CanVeto(*args, **kwargs):
a95a7133 3951 """CanVeto(self) -> bool"""
54f9ee45 3952 return _core_.CloseEvent_CanVeto(*args, **kwargs)
e811c8ce
RD
3953
3954 def GetVeto(*args, **kwargs):
a95a7133 3955 """GetVeto(self) -> bool"""
54f9ee45 3956 return _core_.CloseEvent_GetVeto(*args, **kwargs)
e811c8ce 3957
d14a1e28
RD
3958
3959class CloseEventPtr(CloseEvent):
3960 def __init__(self, this):
3961 self.this = this
3962 if not hasattr(self,"thisown"): self.thisown = 0
3963 self.__class__ = CloseEvent
54f9ee45 3964_core_.CloseEvent_swigregister(CloseEventPtr)
d14a1e28
RD
3965
3966#---------------------------------------------------------------------------
3967
3968class ShowEvent(Event):
e811c8ce
RD
3969 def __repr__(self):
3970 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3971 def __init__(self, *args, **kwargs):
a95a7133 3972 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
54f9ee45 3973 newobj = _core_.new_ShowEvent(*args, **kwargs)
d14a1e28
RD
3974 self.this = newobj.this
3975 self.thisown = 1
3976 del newobj.thisown
e811c8ce 3977 def SetShow(*args, **kwargs):
a95a7133 3978 """SetShow(self, bool show)"""
54f9ee45 3979 return _core_.ShowEvent_SetShow(*args, **kwargs)
e811c8ce
RD
3980
3981 def GetShow(*args, **kwargs):
a95a7133 3982 """GetShow(self) -> bool"""
54f9ee45 3983 return _core_.ShowEvent_GetShow(*args, **kwargs)
e811c8ce 3984
d14a1e28
RD
3985
3986class ShowEventPtr(ShowEvent):
3987 def __init__(self, this):
3988 self.this = this
3989 if not hasattr(self,"thisown"): self.thisown = 0
3990 self.__class__ = ShowEvent
54f9ee45 3991_core_.ShowEvent_swigregister(ShowEventPtr)
d14a1e28
RD
3992
3993#---------------------------------------------------------------------------
3994
3995class IconizeEvent(Event):
e811c8ce
RD
3996 def __repr__(self):
3997 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 3998 def __init__(self, *args, **kwargs):
a95a7133 3999 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
54f9ee45 4000 newobj = _core_.new_IconizeEvent(*args, **kwargs)
d14a1e28
RD
4001 self.this = newobj.this
4002 self.thisown = 1
4003 del newobj.thisown
e811c8ce 4004 def Iconized(*args, **kwargs):
a95a7133 4005 """Iconized(self) -> bool"""
54f9ee45 4006 return _core_.IconizeEvent_Iconized(*args, **kwargs)
e811c8ce 4007
d14a1e28
RD
4008
4009class IconizeEventPtr(IconizeEvent):
4010 def __init__(self, this):
4011 self.this = this
4012 if not hasattr(self,"thisown"): self.thisown = 0
4013 self.__class__ = IconizeEvent
54f9ee45 4014_core_.IconizeEvent_swigregister(IconizeEventPtr)
d14a1e28
RD
4015
4016#---------------------------------------------------------------------------
4017
4018class MaximizeEvent(Event):
e811c8ce
RD
4019 def __repr__(self):
4020 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4021 def __init__(self, *args, **kwargs):
a95a7133 4022 """__init__(self, int id=0) -> MaximizeEvent"""
54f9ee45 4023 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
d14a1e28
RD
4024 self.this = newobj.this
4025 self.thisown = 1
4026 del newobj.thisown
d14a1e28
RD
4027
4028class MaximizeEventPtr(MaximizeEvent):
4029 def __init__(self, this):
4030 self.this = this
4031 if not hasattr(self,"thisown"): self.thisown = 0
4032 self.__class__ = MaximizeEvent
54f9ee45 4033_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
d14a1e28
RD
4034
4035#---------------------------------------------------------------------------
4036
4037class DropFilesEvent(Event):
d14a1e28
RD
4038 def __init__(self): raise RuntimeError, "No constructor defined"
4039 def __repr__(self):
4040 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4041 def GetPosition(*args, **kwargs):
a95a7133 4042 """GetPosition(self) -> Point"""
54f9ee45 4043 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4044
4045 def GetNumberOfFiles(*args, **kwargs):
a95a7133 4046 """GetNumberOfFiles(self) -> int"""
54f9ee45 4047 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
e811c8ce
RD
4048
4049 def GetFiles(*args, **kwargs):
a95a7133 4050 """GetFiles(self) -> PyObject"""
54f9ee45 4051 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
e811c8ce 4052
d14a1e28
RD
4053
4054class DropFilesEventPtr(DropFilesEvent):
4055 def __init__(self, this):
4056 self.this = this
4057 if not hasattr(self,"thisown"): self.thisown = 0
4058 self.__class__ = DropFilesEvent
54f9ee45 4059_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
d14a1e28
RD
4060
4061#---------------------------------------------------------------------------
4062
54f9ee45
RD
4063UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4064UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
d14a1e28 4065class UpdateUIEvent(CommandEvent):
e811c8ce
RD
4066 def __repr__(self):
4067 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4068 def __init__(self, *args, **kwargs):
a95a7133 4069 """__init__(self, int commandId=0) -> UpdateUIEvent"""
54f9ee45 4070 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
d14a1e28
RD
4071 self.this = newobj.this
4072 self.thisown = 1
4073 del newobj.thisown
e811c8ce 4074 def GetChecked(*args, **kwargs):
a95a7133 4075 """GetChecked(self) -> bool"""
54f9ee45 4076 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
e811c8ce
RD
4077
4078 def GetEnabled(*args, **kwargs):
a95a7133 4079 """GetEnabled(self) -> bool"""
54f9ee45 4080 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
e811c8ce
RD
4081
4082 def GetText(*args, **kwargs):
a95a7133 4083 """GetText(self) -> String"""
54f9ee45 4084 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
e811c8ce
RD
4085
4086 def GetSetText(*args, **kwargs):
a95a7133 4087 """GetSetText(self) -> bool"""
54f9ee45 4088 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
e811c8ce
RD
4089
4090 def GetSetChecked(*args, **kwargs):
a95a7133 4091 """GetSetChecked(self) -> bool"""
54f9ee45 4092 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
e811c8ce
RD
4093
4094 def GetSetEnabled(*args, **kwargs):
a95a7133 4095 """GetSetEnabled(self) -> bool"""
54f9ee45 4096 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
e811c8ce
RD
4097
4098 def Check(*args, **kwargs):
a95a7133 4099 """Check(self, bool check)"""
54f9ee45 4100 return _core_.UpdateUIEvent_Check(*args, **kwargs)
e811c8ce
RD
4101
4102 def Enable(*args, **kwargs):
a95a7133 4103 """Enable(self, bool enable)"""
54f9ee45 4104 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
e811c8ce
RD
4105
4106 def SetText(*args, **kwargs):
a95a7133 4107 """SetText(self, String text)"""
54f9ee45 4108 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
e811c8ce
RD
4109
4110 def SetUpdateInterval(*args, **kwargs):
66c033b4 4111 """SetUpdateInterval(long updateInterval)"""
54f9ee45 4112 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4113
4114 SetUpdateInterval = staticmethod(SetUpdateInterval)
4115 def GetUpdateInterval(*args, **kwargs):
66c033b4 4116 """GetUpdateInterval() -> long"""
54f9ee45 4117 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
e811c8ce
RD
4118
4119 GetUpdateInterval = staticmethod(GetUpdateInterval)
4120 def CanUpdate(*args, **kwargs):
66c033b4 4121 """CanUpdate(Window win) -> bool"""
54f9ee45 4122 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
e811c8ce
RD
4123
4124 CanUpdate = staticmethod(CanUpdate)
4125 def ResetUpdateTime(*args, **kwargs):
66c033b4 4126 """ResetUpdateTime()"""
54f9ee45 4127 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
e811c8ce
RD
4128
4129 ResetUpdateTime = staticmethod(ResetUpdateTime)
4130 def SetMode(*args, **kwargs):
66c033b4 4131 """SetMode(int mode)"""
54f9ee45 4132 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4133
4134 SetMode = staticmethod(SetMode)
4135 def GetMode(*args, **kwargs):
66c033b4 4136 """GetMode() -> int"""
54f9ee45 4137 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4138
4139 GetMode = staticmethod(GetMode)
d14a1e28
RD
4140
4141class UpdateUIEventPtr(UpdateUIEvent):
4142 def __init__(self, this):
4143 self.this = this
4144 if not hasattr(self,"thisown"): self.thisown = 0
4145 self.__class__ = UpdateUIEvent
54f9ee45 4146_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
d14a1e28 4147
e811c8ce
RD
4148def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4149 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
54f9ee45 4150 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
d14a1e28 4151
e811c8ce
RD
4152def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4153 """UpdateUIEvent_GetUpdateInterval() -> long"""
54f9ee45 4154 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
d14a1e28 4155
e811c8ce
RD
4156def UpdateUIEvent_CanUpdate(*args, **kwargs):
4157 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
54f9ee45 4158 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
d14a1e28 4159
e811c8ce
RD
4160def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4161 """UpdateUIEvent_ResetUpdateTime()"""
54f9ee45 4162 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
d14a1e28 4163
e811c8ce 4164def UpdateUIEvent_SetMode(*args, **kwargs):
196addbf 4165 """UpdateUIEvent_SetMode(int mode)"""
54f9ee45 4166 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
d14a1e28 4167
e811c8ce 4168def UpdateUIEvent_GetMode(*args, **kwargs):
196addbf 4169 """UpdateUIEvent_GetMode() -> int"""
54f9ee45 4170 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
d14a1e28
RD
4171
4172#---------------------------------------------------------------------------
4173
4174class SysColourChangedEvent(Event):
e811c8ce
RD
4175 def __repr__(self):
4176 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4177 def __init__(self, *args, **kwargs):
a95a7133 4178 """__init__(self) -> SysColourChangedEvent"""
54f9ee45 4179 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
d14a1e28
RD
4180 self.this = newobj.this
4181 self.thisown = 1
4182 del newobj.thisown
d14a1e28
RD
4183
4184class SysColourChangedEventPtr(SysColourChangedEvent):
4185 def __init__(self, this):
4186 self.this = this
4187 if not hasattr(self,"thisown"): self.thisown = 0
4188 self.__class__ = SysColourChangedEvent
54f9ee45 4189_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
d14a1e28
RD
4190
4191#---------------------------------------------------------------------------
4192
4193class MouseCaptureChangedEvent(Event):
e811c8ce
RD
4194 def __repr__(self):
4195 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4196 def __init__(self, *args, **kwargs):
a95a7133 4197 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
54f9ee45 4198 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
d14a1e28
RD
4199 self.this = newobj.this
4200 self.thisown = 1
4201 del newobj.thisown
e811c8ce 4202 def GetCapturedWindow(*args, **kwargs):
a95a7133 4203 """GetCapturedWindow(self) -> Window"""
54f9ee45 4204 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
e811c8ce 4205
d14a1e28
RD
4206
4207class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4208 def __init__(self, this):
4209 self.this = this
4210 if not hasattr(self,"thisown"): self.thisown = 0
4211 self.__class__ = MouseCaptureChangedEvent
54f9ee45 4212_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
d14a1e28
RD
4213
4214#---------------------------------------------------------------------------
4215
4216class DisplayChangedEvent(Event):
e811c8ce
RD
4217 def __repr__(self):
4218 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4219 def __init__(self, *args, **kwargs):
a95a7133 4220 """__init__(self) -> DisplayChangedEvent"""
54f9ee45 4221 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
d14a1e28
RD
4222 self.this = newobj.this
4223 self.thisown = 1
4224 del newobj.thisown
d14a1e28
RD
4225
4226class DisplayChangedEventPtr(DisplayChangedEvent):
4227 def __init__(self, this):
4228 self.this = this
4229 if not hasattr(self,"thisown"): self.thisown = 0
4230 self.__class__ = DisplayChangedEvent
54f9ee45 4231_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
d14a1e28
RD
4232
4233#---------------------------------------------------------------------------
4234
4235class PaletteChangedEvent(Event):
e811c8ce
RD
4236 def __repr__(self):
4237 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4238 def __init__(self, *args, **kwargs):
a95a7133 4239 """__init__(self, int id=0) -> PaletteChangedEvent"""
54f9ee45 4240 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
d14a1e28
RD
4241 self.this = newobj.this
4242 self.thisown = 1
4243 del newobj.thisown
e811c8ce 4244 def SetChangedWindow(*args, **kwargs):
a95a7133 4245 """SetChangedWindow(self, Window win)"""
54f9ee45 4246 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
e811c8ce
RD
4247
4248 def GetChangedWindow(*args, **kwargs):
a95a7133 4249 """GetChangedWindow(self) -> Window"""
54f9ee45 4250 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
e811c8ce 4251
d14a1e28
RD
4252
4253class PaletteChangedEventPtr(PaletteChangedEvent):
4254 def __init__(self, this):
4255 self.this = this
4256 if not hasattr(self,"thisown"): self.thisown = 0
4257 self.__class__ = PaletteChangedEvent
54f9ee45 4258_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
d14a1e28
RD
4259
4260#---------------------------------------------------------------------------
4261
4262class QueryNewPaletteEvent(Event):
e811c8ce
RD
4263 def __repr__(self):
4264 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4265 def __init__(self, *args, **kwargs):
a95a7133 4266 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
54f9ee45 4267 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
d14a1e28
RD
4268 self.this = newobj.this
4269 self.thisown = 1
4270 del newobj.thisown
e811c8ce 4271 def SetPaletteRealized(*args, **kwargs):
a95a7133 4272 """SetPaletteRealized(self, bool realized)"""
54f9ee45 4273 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
e811c8ce
RD
4274
4275 def GetPaletteRealized(*args, **kwargs):
a95a7133 4276 """GetPaletteRealized(self) -> bool"""
54f9ee45 4277 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
e811c8ce 4278
d14a1e28
RD
4279
4280class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4281 def __init__(self, this):
4282 self.this = this
4283 if not hasattr(self,"thisown"): self.thisown = 0
4284 self.__class__ = QueryNewPaletteEvent
54f9ee45 4285_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
d14a1e28
RD
4286
4287#---------------------------------------------------------------------------
4288
4289class NavigationKeyEvent(Event):
e811c8ce
RD
4290 def __repr__(self):
4291 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4292 def __init__(self, *args, **kwargs):
a95a7133 4293 """__init__(self) -> NavigationKeyEvent"""
54f9ee45 4294 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
d14a1e28
RD
4295 self.this = newobj.this
4296 self.thisown = 1
4297 del newobj.thisown
e811c8ce 4298 def GetDirection(*args, **kwargs):
a95a7133 4299 """GetDirection(self) -> bool"""
54f9ee45 4300 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
e811c8ce
RD
4301
4302 def SetDirection(*args, **kwargs):
908b74cd 4303 """SetDirection(self, bool forward)"""
54f9ee45 4304 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
e811c8ce
RD
4305
4306 def IsWindowChange(*args, **kwargs):
a95a7133 4307 """IsWindowChange(self) -> bool"""
54f9ee45 4308 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
e811c8ce
RD
4309
4310 def SetWindowChange(*args, **kwargs):
908b74cd 4311 """SetWindowChange(self, bool ischange)"""
54f9ee45 4312 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
e811c8ce 4313
908b74cd
RD
4314 def SetFlags(*args, **kwargs):
4315 """SetFlags(self, long flags)"""
4316 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4317
e811c8ce 4318 def GetCurrentFocus(*args, **kwargs):
a95a7133 4319 """GetCurrentFocus(self) -> Window"""
54f9ee45 4320 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
e811c8ce
RD
4321
4322 def SetCurrentFocus(*args, **kwargs):
a95a7133 4323 """SetCurrentFocus(self, Window win)"""
54f9ee45 4324 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
e811c8ce 4325
908b74cd
RD
4326 IsForward = _core_.NavigationKeyEvent_IsForward
4327 WinChange = _core_.NavigationKeyEvent_WinChange
d14a1e28
RD
4328
4329class NavigationKeyEventPtr(NavigationKeyEvent):
4330 def __init__(self, this):
4331 self.this = this
4332 if not hasattr(self,"thisown"): self.thisown = 0
4333 self.__class__ = NavigationKeyEvent
54f9ee45 4334_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
d14a1e28
RD
4335
4336#---------------------------------------------------------------------------
4337
4338class WindowCreateEvent(CommandEvent):
e811c8ce
RD
4339 def __repr__(self):
4340 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4341 def __init__(self, *args, **kwargs):
a95a7133 4342 """__init__(self, Window win=None) -> WindowCreateEvent"""
54f9ee45 4343 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
d14a1e28
RD
4344 self.this = newobj.this
4345 self.thisown = 1
4346 del newobj.thisown
e811c8ce 4347 def GetWindow(*args, **kwargs):
a95a7133 4348 """GetWindow(self) -> Window"""
54f9ee45 4349 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
e811c8ce 4350
d14a1e28
RD
4351
4352class WindowCreateEventPtr(WindowCreateEvent):
4353 def __init__(self, this):
4354 self.this = this
4355 if not hasattr(self,"thisown"): self.thisown = 0
4356 self.__class__ = WindowCreateEvent
54f9ee45 4357_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
d14a1e28
RD
4358
4359class WindowDestroyEvent(CommandEvent):
e811c8ce
RD
4360 def __repr__(self):
4361 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4362 def __init__(self, *args, **kwargs):
a95a7133 4363 """__init__(self, Window win=None) -> WindowDestroyEvent"""
54f9ee45 4364 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
d14a1e28
RD
4365 self.this = newobj.this
4366 self.thisown = 1
4367 del newobj.thisown
e811c8ce 4368 def GetWindow(*args, **kwargs):
a95a7133 4369 """GetWindow(self) -> Window"""
54f9ee45 4370 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
e811c8ce 4371
d14a1e28
RD
4372
4373class WindowDestroyEventPtr(WindowDestroyEvent):
4374 def __init__(self, this):
4375 self.this = this
4376 if not hasattr(self,"thisown"): self.thisown = 0
4377 self.__class__ = WindowDestroyEvent
54f9ee45 4378_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
d14a1e28
RD
4379
4380#---------------------------------------------------------------------------
4381
4382class ContextMenuEvent(CommandEvent):
e811c8ce
RD
4383 def __repr__(self):
4384 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4385 def __init__(self, *args, **kwargs):
a95a7133 4386 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
54f9ee45 4387 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
d14a1e28
RD
4388 self.this = newobj.this
4389 self.thisown = 1
4390 del newobj.thisown
e811c8ce 4391 def GetPosition(*args, **kwargs):
a95a7133 4392 """GetPosition(self) -> Point"""
54f9ee45 4393 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
e811c8ce
RD
4394
4395 def SetPosition(*args, **kwargs):
a95a7133 4396 """SetPosition(self, Point pos)"""
54f9ee45 4397 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
e811c8ce 4398
d14a1e28
RD
4399
4400class ContextMenuEventPtr(ContextMenuEvent):
4401 def __init__(self, this):
4402 self.this = this
4403 if not hasattr(self,"thisown"): self.thisown = 0
4404 self.__class__ = ContextMenuEvent
54f9ee45 4405_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
d14a1e28
RD
4406
4407#---------------------------------------------------------------------------
4408
54f9ee45
RD
4409IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4410IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
d14a1e28 4411class IdleEvent(Event):
e811c8ce
RD
4412 def __repr__(self):
4413 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4414 def __init__(self, *args, **kwargs):
a95a7133 4415 """__init__(self) -> IdleEvent"""
54f9ee45 4416 newobj = _core_.new_IdleEvent(*args, **kwargs)
d14a1e28
RD
4417 self.this = newobj.this
4418 self.thisown = 1
4419 del newobj.thisown
e811c8ce 4420 def RequestMore(*args, **kwargs):
a95a7133 4421 """RequestMore(self, bool needMore=True)"""
54f9ee45 4422 return _core_.IdleEvent_RequestMore(*args, **kwargs)
e811c8ce
RD
4423
4424 def MoreRequested(*args, **kwargs):
a95a7133 4425 """MoreRequested(self) -> bool"""
54f9ee45 4426 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
e811c8ce
RD
4427
4428 def SetMode(*args, **kwargs):
66c033b4 4429 """SetMode(int mode)"""
54f9ee45 4430 return _core_.IdleEvent_SetMode(*args, **kwargs)
e811c8ce
RD
4431
4432 SetMode = staticmethod(SetMode)
4433 def GetMode(*args, **kwargs):
66c033b4 4434 """GetMode() -> int"""
54f9ee45 4435 return _core_.IdleEvent_GetMode(*args, **kwargs)
e811c8ce
RD
4436
4437 GetMode = staticmethod(GetMode)
4438 def CanSend(*args, **kwargs):
66c033b4 4439 """CanSend(Window win) -> bool"""
54f9ee45 4440 return _core_.IdleEvent_CanSend(*args, **kwargs)
e811c8ce
RD
4441
4442 CanSend = staticmethod(CanSend)
d14a1e28
RD
4443
4444class IdleEventPtr(IdleEvent):
4445 def __init__(self, this):
4446 self.this = this
4447 if not hasattr(self,"thisown"): self.thisown = 0
4448 self.__class__ = IdleEvent
54f9ee45 4449_core_.IdleEvent_swigregister(IdleEventPtr)
d14a1e28 4450
e811c8ce 4451def IdleEvent_SetMode(*args, **kwargs):
196addbf 4452 """IdleEvent_SetMode(int mode)"""
54f9ee45 4453 return _core_.IdleEvent_SetMode(*args, **kwargs)
d14a1e28 4454
e811c8ce 4455def IdleEvent_GetMode(*args, **kwargs):
196addbf 4456 """IdleEvent_GetMode() -> int"""
54f9ee45 4457 return _core_.IdleEvent_GetMode(*args, **kwargs)
d14a1e28 4458
e811c8ce
RD
4459def IdleEvent_CanSend(*args, **kwargs):
4460 """IdleEvent_CanSend(Window win) -> bool"""
54f9ee45 4461 return _core_.IdleEvent_CanSend(*args, **kwargs)
d14a1e28
RD
4462
4463#---------------------------------------------------------------------------
4464
4465class PyEvent(Event):
e811c8ce
RD
4466 def __repr__(self):
4467 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4468 def __init__(self, *args, **kwargs):
a95a7133 4469 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
54f9ee45 4470 newobj = _core_.new_PyEvent(*args, **kwargs)
d14a1e28
RD
4471 self.this = newobj.this
4472 self.thisown = 1
4473 del newobj.thisown
4474 self.SetSelf(self)
e811c8ce 4475
54f9ee45 4476 def __del__(self, destroy=_core_.delete_PyEvent):
a95a7133 4477 """__del__(self)"""
d14a1e28
RD
4478 try:
4479 if self.thisown: destroy(self)
4480 except: pass
e811c8ce
RD
4481
4482 def SetSelf(*args, **kwargs):
a95a7133 4483 """SetSelf(self, PyObject self)"""
54f9ee45 4484 return _core_.PyEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4485
4486 def GetSelf(*args, **kwargs):
a95a7133 4487 """GetSelf(self) -> PyObject"""
54f9ee45 4488 return _core_.PyEvent_GetSelf(*args, **kwargs)
e811c8ce 4489
d14a1e28
RD
4490
4491class PyEventPtr(PyEvent):
4492 def __init__(self, this):
4493 self.this = this
4494 if not hasattr(self,"thisown"): self.thisown = 0
4495 self.__class__ = PyEvent
54f9ee45 4496_core_.PyEvent_swigregister(PyEventPtr)
d14a1e28
RD
4497
4498class PyCommandEvent(CommandEvent):
e811c8ce
RD
4499 def __repr__(self):
4500 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4501 def __init__(self, *args, **kwargs):
a95a7133 4502 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
54f9ee45 4503 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
d14a1e28
RD
4504 self.this = newobj.this
4505 self.thisown = 1
4506 del newobj.thisown
4507 self.SetSelf(self)
e811c8ce 4508
54f9ee45 4509 def __del__(self, destroy=_core_.delete_PyCommandEvent):
a95a7133 4510 """__del__(self)"""
d14a1e28
RD
4511 try:
4512 if self.thisown: destroy(self)
4513 except: pass
e811c8ce
RD
4514
4515 def SetSelf(*args, **kwargs):
a95a7133 4516 """SetSelf(self, PyObject self)"""
54f9ee45 4517 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
e811c8ce
RD
4518
4519 def GetSelf(*args, **kwargs):
a95a7133 4520 """GetSelf(self) -> PyObject"""
54f9ee45 4521 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
e811c8ce 4522
d14a1e28
RD
4523
4524class PyCommandEventPtr(PyCommandEvent):
4525 def __init__(self, this):
4526 self.this = this
4527 if not hasattr(self,"thisown"): self.thisown = 0
4528 self.__class__ = PyCommandEvent
54f9ee45 4529_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
d14a1e28
RD
4530
4531#---------------------------------------------------------------------------
4532
54f9ee45
RD
4533PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4534PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4535PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4536PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4537PRINT_WINDOWS = _core_.PRINT_WINDOWS
4538PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
d14a1e28 4539class PyApp(EvtHandler):
66c033b4
RD
4540 """
4541 The ``wx.PyApp`` class is an *implementation detail*, please use the
4542 `wx.App` class (or some other derived class) instead.
4543 """
e811c8ce
RD
4544 def __repr__(self):
4545 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4546 def __init__(self, *args, **kwargs):
98e665d3 4547 """
a95a7133 4548 __init__(self) -> PyApp
98e665d3
RD
4549
4550 Create a new application object, starting the bootstrap process.
4551 """
54f9ee45 4552 newobj = _core_.new_PyApp(*args, **kwargs)
d14a1e28
RD
4553 self.this = newobj.this
4554 self.thisown = 1
4555 del newobj.thisown
4556 self._setCallbackInfo(self, PyApp)
4557 self._setOORInfo(self)
e811c8ce 4558
54f9ee45 4559 def __del__(self, destroy=_core_.delete_PyApp):
a95a7133 4560 """__del__(self)"""
d14a1e28
RD
4561 try:
4562 if self.thisown: destroy(self)
4563 except: pass
e811c8ce
RD
4564
4565 def _setCallbackInfo(*args, **kwargs):
a95a7133 4566 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 4567 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
4568
4569 def GetAppName(*args, **kwargs):
0df68c9f 4570 """
a95a7133 4571 GetAppName(self) -> String
6c3b4aae 4572
0df68c9f
RD
4573 Get the application name.
4574 """
54f9ee45 4575 return _core_.PyApp_GetAppName(*args, **kwargs)
e811c8ce
RD
4576
4577 def SetAppName(*args, **kwargs):
0df68c9f 4578 """
a95a7133 4579 SetAppName(self, String name)
6c3b4aae 4580
66c033b4
RD
4581 Set the application name. This value may be used automatically by
4582 `wx.Config` and such.
0df68c9f 4583 """
54f9ee45 4584 return _core_.PyApp_SetAppName(*args, **kwargs)
e811c8ce
RD
4585
4586 def GetClassName(*args, **kwargs):
0df68c9f 4587 """
a95a7133 4588 GetClassName(self) -> String
e811c8ce 4589
0df68c9f
RD
4590 Get the application's class name.
4591 """
54f9ee45 4592 return _core_.PyApp_GetClassName(*args, **kwargs)
e811c8ce
RD
4593
4594 def SetClassName(*args, **kwargs):
0df68c9f 4595 """
a95a7133 4596 SetClassName(self, String name)
6c3b4aae 4597
66c033b4
RD
4598 Set the application's class name. This value may be used for
4599 X-resources if applicable for the platform
0df68c9f 4600 """
54f9ee45 4601 return _core_.PyApp_SetClassName(*args, **kwargs)
e811c8ce
RD
4602
4603 def GetVendorName(*args, **kwargs):
0df68c9f 4604 """
a95a7133 4605 GetVendorName(self) -> String
6c3b4aae 4606
0df68c9f
RD
4607 Get the application's vendor name.
4608 """
54f9ee45 4609 return _core_.PyApp_GetVendorName(*args, **kwargs)
e811c8ce
RD
4610
4611 def SetVendorName(*args, **kwargs):
0df68c9f 4612 """
a95a7133 4613 SetVendorName(self, String name)
6c3b4aae 4614
66c033b4
RD
4615 Set the application's vendor name. This value may be used
4616 automatically by `wx.Config` and such.
0df68c9f 4617 """
54f9ee45 4618 return _core_.PyApp_SetVendorName(*args, **kwargs)
e811c8ce
RD
4619
4620 def GetTraits(*args, **kwargs):
0df68c9f 4621 """
a95a7133 4622 GetTraits(self) -> wxAppTraits
6c3b4aae 4623
66c033b4
RD
4624 Return (and create if necessary) the app traits object to which we
4625 delegate for everything which either should be configurable by the
4626 user (then he can change the default behaviour simply by overriding
4627 CreateTraits() and returning his own traits object) or which is
4628 GUI/console dependent as then wx.AppTraits allows us to abstract the
4629 differences behind the common facade.
4630
4631 :todo: Add support for overriding CreateAppTraits in wxPython.
0df68c9f 4632 """
54f9ee45 4633 return _core_.PyApp_GetTraits(*args, **kwargs)
e811c8ce
RD
4634
4635 def ProcessPendingEvents(*args, **kwargs):
0df68c9f 4636 """
a95a7133 4637 ProcessPendingEvents(self)
6c3b4aae 4638
66c033b4
RD
4639 Process all events in the Pending Events list -- it is necessary to
4640 call this function to process posted events. This normally happens
4641 during each event loop iteration.
0df68c9f 4642 """
54f9ee45 4643 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
e811c8ce
RD
4644
4645 def Yield(*args, **kwargs):
0df68c9f 4646 """
a95a7133 4647 Yield(self, bool onlyIfNeeded=False) -> bool
6c3b4aae 4648
66c033b4
RD
4649 Process all currently pending events right now, instead of waiting
4650 until return to the event loop. It is an error to call ``Yield``
4651 recursively unless the value of ``onlyIfNeeded`` is True.
6c3b4aae 4652
66c033b4 4653 :warning: This function is dangerous as it can lead to unexpected
41e2b43e
RD
4654 reentrancies (i.e. when called from an event handler it may
4655 result in calling the same event handler again), use with
4656 extreme care or, better, don't use at all!
0df68c9f 4657
66c033b4 4658 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
41e2b43e 4659
0df68c9f 4660 """
54f9ee45 4661 return _core_.PyApp_Yield(*args, **kwargs)
e811c8ce
RD
4662
4663 def WakeUpIdle(*args, **kwargs):
0df68c9f 4664 """
a95a7133 4665 WakeUpIdle(self)
6c3b4aae 4666
66c033b4
RD
4667 Make sure that idle events are sent again.
4668 :see: `wx.WakeUpIdle`
0df68c9f 4669 """
54f9ee45 4670 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
e811c8ce
RD
4671
4672 def MainLoop(*args, **kwargs):
0df68c9f 4673 """
a95a7133 4674 MainLoop(self) -> int
6c3b4aae 4675
66c033b4
RD
4676 Execute the main GUI loop, the function doesn't normally return until
4677 all top level windows have been closed and destroyed.
0df68c9f 4678 """
54f9ee45 4679 return _core_.PyApp_MainLoop(*args, **kwargs)
e811c8ce
RD
4680
4681 def Exit(*args, **kwargs):
0df68c9f 4682 """
a95a7133 4683 Exit(self)
6c3b4aae 4684
0df68c9f 4685 Exit the main loop thus terminating the application.
66c033b4 4686 :see: `wx.Exit`
0df68c9f 4687 """
54f9ee45 4688 return _core_.PyApp_Exit(*args, **kwargs)
e811c8ce
RD
4689
4690 def ExitMainLoop(*args, **kwargs):
0df68c9f 4691 """
a95a7133 4692 ExitMainLoop(self)
6c3b4aae 4693
66c033b4
RD
4694 Exit the main GUI loop during the next iteration of the main
4695 loop, (i.e. it does not stop the program immediately!)
0df68c9f 4696 """
54f9ee45 4697 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
e811c8ce
RD
4698
4699 def Pending(*args, **kwargs):
0df68c9f 4700 """
a95a7133 4701 Pending(self) -> bool
6c3b4aae 4702
0df68c9f
RD
4703 Returns True if there are unprocessed events in the event queue.
4704 """
54f9ee45 4705 return _core_.PyApp_Pending(*args, **kwargs)
e811c8ce
RD
4706
4707 def Dispatch(*args, **kwargs):
0df68c9f 4708 """
a95a7133 4709 Dispatch(self) -> bool
6c3b4aae 4710
0df68c9f
RD
4711 Process the first event in the event queue (blocks until an event
4712 appears if there are none currently)
4713 """
54f9ee45 4714 return _core_.PyApp_Dispatch(*args, **kwargs)
e811c8ce
RD
4715
4716 def ProcessIdle(*args, **kwargs):
0df68c9f 4717 """
a95a7133 4718 ProcessIdle(self) -> bool
6c3b4aae 4719
66c033b4
RD
4720 Called from the MainLoop when the application becomes idle (there are
4721 no pending events) and sends a `wx.IdleEvent` to all interested
4722 parties. Returns True if more idle events are needed, False if not.
0df68c9f 4723 """
54f9ee45 4724 return _core_.PyApp_ProcessIdle(*args, **kwargs)
e811c8ce
RD
4725
4726 def SendIdleEvents(*args, **kwargs):
0df68c9f 4727 """
a95a7133 4728 SendIdleEvents(self, Window win, IdleEvent event) -> bool
e811c8ce 4729
66c033b4
RD
4730 Send idle event to window and all subwindows. Returns True if more
4731 idle time is requested.
0df68c9f 4732 """
54f9ee45 4733 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
e811c8ce
RD
4734
4735 def IsActive(*args, **kwargs):
0df68c9f 4736 """
a95a7133 4737 IsActive(self) -> bool
6c3b4aae 4738
0df68c9f
RD
4739 Return True if our app has focus.
4740 """
54f9ee45 4741 return _core_.PyApp_IsActive(*args, **kwargs)
e811c8ce
RD
4742
4743 def SetTopWindow(*args, **kwargs):
0df68c9f 4744 """
a95a7133 4745 SetTopWindow(self, Window win)
6c3b4aae 4746
66c033b4 4747 Set the *main* top level window
0df68c9f 4748 """
54f9ee45 4749 return _core_.PyApp_SetTopWindow(*args, **kwargs)
e811c8ce
RD
4750
4751 def GetTopWindow(*args, **kwargs):
0df68c9f 4752 """
a95a7133 4753 GetTopWindow(self) -> Window
6c3b4aae 4754
66c033b4
RD
4755 Return the *main* top level window (if it hadn't been set previously
4756 with SetTopWindow(), will return just some top level window and, if
4757 there not any, will return None)
0df68c9f 4758 """
54f9ee45 4759 return _core_.PyApp_GetTopWindow(*args, **kwargs)
e811c8ce
RD
4760
4761 def SetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4762 """
a95a7133 4763 SetExitOnFrameDelete(self, bool flag)
0df68c9f 4764
66c033b4
RD
4765 Control the exit behaviour: by default, the program will exit the main
4766 loop (and so, usually, terminate) when the last top-level program
4767 window is deleted. Beware that if you disable this behaviour (with
4768 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4769 explicitly from somewhere.
0df68c9f 4770 """
54f9ee45 4771 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4772
4773 def GetExitOnFrameDelete(*args, **kwargs):
0df68c9f 4774 """
a95a7133 4775 GetExitOnFrameDelete(self) -> bool
6c3b4aae 4776
0df68c9f
RD
4777 Get the current exit behaviour setting.
4778 """
54f9ee45 4779 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
e811c8ce
RD
4780
4781 def SetUseBestVisual(*args, **kwargs):
0df68c9f 4782 """
a95a7133 4783 SetUseBestVisual(self, bool flag)
6c3b4aae 4784
66c033b4
RD
4785 Set whether the app should try to use the best available visual on
4786 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
0df68c9f 4787 """
54f9ee45 4788 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4789
4790 def GetUseBestVisual(*args, **kwargs):
0df68c9f 4791 """
a95a7133 4792 GetUseBestVisual(self) -> bool
6c3b4aae 4793
0df68c9f
RD
4794 Get current UseBestVisual setting.
4795 """
54f9ee45 4796 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
e811c8ce
RD
4797
4798 def SetPrintMode(*args, **kwargs):
a95a7133 4799 """SetPrintMode(self, int mode)"""
54f9ee45 4800 return _core_.PyApp_SetPrintMode(*args, **kwargs)
e811c8ce
RD
4801
4802 def GetPrintMode(*args, **kwargs):
a95a7133 4803 """GetPrintMode(self) -> int"""
54f9ee45 4804 return _core_.PyApp_GetPrintMode(*args, **kwargs)
e811c8ce 4805
e811c8ce 4806 def SetAssertMode(*args, **kwargs):
0df68c9f 4807 """
a95a7133 4808 SetAssertMode(self, int mode)
6c3b4aae 4809
41e2b43e 4810 Set the OnAssert behaviour for debug and hybrid builds.
0df68c9f 4811 """
54f9ee45 4812 return _core_.PyApp_SetAssertMode(*args, **kwargs)
e811c8ce 4813
6c3b4aae 4814 def GetAssertMode(*args, **kwargs):
0df68c9f 4815 """
a95a7133 4816 GetAssertMode(self) -> int
6c3b4aae 4817
0df68c9f
RD
4818 Get the current OnAssert behaviour setting.
4819 """
54f9ee45 4820 return _core_.PyApp_GetAssertMode(*args, **kwargs)
6c3b4aae 4821
e811c8ce 4822 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4823 """GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4824 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4825
4826 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4827 def GetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4828 """GetMacAboutMenuItemId() -> long"""
54f9ee45 4829 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4830
4831 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4832 def GetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4833 """GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4834 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4835
4836 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4837 def GetMacExitMenuItemId(*args, **kwargs):
66c033b4 4838 """GetMacExitMenuItemId() -> long"""
54f9ee45 4839 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4840
4841 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4842 def GetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4843 """GetMacHelpMenuTitleName() -> String"""
54f9ee45 4844 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4845
4846 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4847 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
66c033b4 4848 """SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4849 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
e811c8ce
RD
4850
4851 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4852 def SetMacAboutMenuItemId(*args, **kwargs):
66c033b4 4853 """SetMacAboutMenuItemId(long val)"""
54f9ee45 4854 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
e811c8ce
RD
4855
4856 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4857 def SetMacPreferencesMenuItemId(*args, **kwargs):
66c033b4 4858 """SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4859 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
e811c8ce
RD
4860
4861 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4862 def SetMacExitMenuItemId(*args, **kwargs):
66c033b4 4863 """SetMacExitMenuItemId(long val)"""
54f9ee45 4864 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
e811c8ce
RD
4865
4866 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4867 def SetMacHelpMenuTitleName(*args, **kwargs):
66c033b4 4868 """SetMacHelpMenuTitleName(String val)"""
54f9ee45 4869 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
e811c8ce
RD
4870
4871 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4872 def _BootstrapApp(*args, **kwargs):
0df68c9f 4873 """
a95a7133 4874 _BootstrapApp(self)
6c3b4aae 4875
0df68c9f
RD
4876 For internal use only
4877 """
54f9ee45 4878 return _core_.PyApp__BootstrapApp(*args, **kwargs)
e811c8ce
RD
4879
4880 def GetComCtl32Version(*args, **kwargs):
0df68c9f 4881 """
66c033b4 4882 GetComCtl32Version() -> int
6c3b4aae 4883
66c033b4
RD
4884 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4885 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4886 """
54f9ee45 4887 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
e811c8ce
RD
4888
4889 GetComCtl32Version = staticmethod(GetComCtl32Version)
d14a1e28
RD
4890
4891class PyAppPtr(PyApp):
4892 def __init__(self, this):
4893 self.this = this
4894 if not hasattr(self,"thisown"): self.thisown = 0
4895 self.__class__ = PyApp
54f9ee45 4896_core_.PyApp_swigregister(PyAppPtr)
d14a1e28 4897
e811c8ce
RD
4898def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4899 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
54f9ee45 4900 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4901
e811c8ce
RD
4902def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4903 """PyApp_GetMacAboutMenuItemId() -> long"""
54f9ee45 4904 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4905
e811c8ce
RD
4906def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4907 """PyApp_GetMacPreferencesMenuItemId() -> long"""
54f9ee45 4908 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4909
e811c8ce
RD
4910def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4911 """PyApp_GetMacExitMenuItemId() -> long"""
54f9ee45 4912 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4913
e811c8ce 4914def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4915 """PyApp_GetMacHelpMenuTitleName() -> String"""
54f9ee45 4916 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4917
e811c8ce
RD
4918def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4919 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
54f9ee45 4920 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
d14a1e28 4921
e811c8ce
RD
4922def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
4923 """PyApp_SetMacAboutMenuItemId(long val)"""
54f9ee45 4924 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
d14a1e28 4925
e811c8ce
RD
4926def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
4927 """PyApp_SetMacPreferencesMenuItemId(long val)"""
54f9ee45 4928 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
d14a1e28 4929
e811c8ce
RD
4930def PyApp_SetMacExitMenuItemId(*args, **kwargs):
4931 """PyApp_SetMacExitMenuItemId(long val)"""
54f9ee45 4932 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
d14a1e28 4933
e811c8ce 4934def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
196addbf 4935 """PyApp_SetMacHelpMenuTitleName(String val)"""
54f9ee45 4936 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
d14a1e28 4937
e811c8ce 4938def PyApp_GetComCtl32Version(*args, **kwargs):
0df68c9f
RD
4939 """
4940 PyApp_GetComCtl32Version() -> int
6c3b4aae 4941
66c033b4
RD
4942 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4943 it wasn't found at all. Raises an exception on non-Windows platforms.
0df68c9f 4944 """
54f9ee45 4945 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
d14a1e28
RD
4946
4947#---------------------------------------------------------------------------
4948
4949
e811c8ce 4950def Exit(*args, **kwargs):
0df68c9f
RD
4951 """
4952 Exit()
6c3b4aae 4953
0df68c9f
RD
4954 Force an exit of the application. Convenience for wx.GetApp().Exit()
4955 """
54f9ee45 4956 return _core_.Exit(*args, **kwargs)
d14a1e28 4957
e811c8ce 4958def Yield(*args, **kwargs):
0df68c9f
RD
4959 """
4960 Yield() -> bool
6c3b4aae 4961
0df68c9f
RD
4962 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
4963 """
54f9ee45 4964 return _core_.Yield(*args, **kwargs)
d14a1e28 4965
e811c8ce 4966def YieldIfNeeded(*args, **kwargs):
0df68c9f
RD
4967 """
4968 YieldIfNeeded() -> bool
6c3b4aae 4969
0df68c9f
RD
4970 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
4971 """
54f9ee45 4972 return _core_.YieldIfNeeded(*args, **kwargs)
d14a1e28 4973
e811c8ce 4974def SafeYield(*args, **kwargs):
0df68c9f
RD
4975 """
4976 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
6c3b4aae 4977
66c033b4
RD
4978 This function is similar to `wx.Yield`, except that it disables the
4979 user input to all program windows before calling `wx.Yield` and
4980 re-enables it again afterwards. If ``win`` is not None, this window
4981 will remain enabled, allowing the implementation of some limited user
4982 interaction.
6c3b4aae 4983
66c033b4 4984 :Returns: the result of the call to `wx.Yield`.
0df68c9f 4985 """
54f9ee45 4986 return _core_.SafeYield(*args, **kwargs)
d14a1e28 4987
e811c8ce 4988def WakeUpIdle(*args, **kwargs):
0df68c9f
RD
4989 """
4990 WakeUpIdle()
6c3b4aae 4991
66c033b4
RD
4992 Cause the message queue to become empty again, so idle events will be
4993 sent.
0df68c9f 4994 """
54f9ee45 4995 return _core_.WakeUpIdle(*args, **kwargs)
d14a1e28 4996
e811c8ce 4997def PostEvent(*args, **kwargs):
0df68c9f
RD
4998 """
4999 PostEvent(EvtHandler dest, Event event)
6c3b4aae 5000
66c033b4
RD
5001 Send an event to a window or other wx.EvtHandler to be processed
5002 later.
0df68c9f 5003 """
54f9ee45 5004 return _core_.PostEvent(*args, **kwargs)
d14a1e28 5005
e811c8ce 5006def App_CleanUp(*args, **kwargs):
0df68c9f
RD
5007 """
5008 App_CleanUp()
6c3b4aae 5009
41e2b43e 5010 For internal use only, it is used to cleanup after wxWidgets when
66c033b4 5011 Python shuts down.
0df68c9f 5012 """
54f9ee45 5013 return _core_.App_CleanUp(*args, **kwargs)
d14a1e28 5014
e811c8ce 5015def GetApp(*args, **kwargs):
0df68c9f
RD
5016 """
5017 GetApp() -> PyApp
6c3b4aae 5018
196addbf 5019 Return a reference to the current wx.App object.
0df68c9f 5020 """
54f9ee45 5021 return _core_.GetApp(*args, **kwargs)
d14a1e28
RD
5022#----------------------------------------------------------------------
5023
5024class PyOnDemandOutputWindow:
6c3b4aae
RD
5025 """
5026 A class that can be used for redirecting Python's stdout and
5027 stderr streams. It will do nothing until something is wrriten to
5028 the stream at which point it will create a Frame with a text area
5029 and write the text there.
5030 """
d14a1e28
RD
5031 def __init__(self, title = "wxPython: stdout/stderr"):
5032 self.frame = None
5033 self.title = title
412d302d
RD
5034 self.pos = wx.DefaultPosition
5035 self.size = (450, 300)
d14a1e28
RD
5036 self.parent = None
5037
5038 def SetParent(self, parent):
6c3b4aae 5039 """Set the window to be used as the popup Frame's parent."""
d14a1e28
RD
5040 self.parent = parent
5041
6c3b4aae
RD
5042
5043 def CreateOutputWindow(self, st):
412d302d
RD
5044 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5045 style=wx.DEFAULT_FRAME_STYLE)
196addbf 5046 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5047 style=wx.TE_MULTILINE|wx.TE_READONLY)
d1e20054 5048 self.text.AppendText(st)
6c3b4aae
RD
5049 self.frame.Show(True)
5050 EVT_CLOSE(self.frame, self.OnCloseWindow)
5051
d14a1e28 5052
7409c0c6
RD
5053 def OnCloseWindow(self, event):
5054 if self.frame is not None:
5055 self.frame.Destroy()
5056 self.frame = None
5057 self.text = None
5058
5059
d14a1e28 5060 # These methods provide the file-like output behaviour.
6c3b4aae
RD
5061 def write(self, text):
5062 """
5063 Create the output window if needed and write the string to it.
5064 If not called in the context of the gui thread then uses
5065 CallAfter to do the work there.
5066 """
5067 if self.frame is None:
5068 if not wx.Thread_IsMain():
5069 wx.CallAfter(self.CreateOutputWindow, text)
5070 else:
5071 self.CreateOutputWindow(text)
5072 else:
5073 if not wx.Thread_IsMain():
5074 wx.CallAfter(self.text.AppendText, text)
5075 else:
5076 self.text.AppendText(text)
5077
d14a1e28
RD
5078
5079 def close(self):
6c3b4aae
RD
5080 if self.frame is not None:
5081 wx.CallAfter(self.frame.Close)
5082
d14a1e28 5083
19272049
RD
5084 def flush(self):
5085 pass
5086
5087
d14a1e28
RD
5088
5089#----------------------------------------------------------------------
d14a1e28
RD
5090
5091_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5092
5093class App(wx.PyApp):
6c3b4aae 5094 """
66c033b4
RD
5095 The ``wx.App`` class represents the application and is used to:
5096
5097 * bootstrap the wxPython system and initialize the underlying
5098 gui toolkit
5099 * set and get application-wide properties
5100 * implement the windowing system main message or event loop,
5101 and to dispatch events to window instances
5102 * etc.
5103
5104 Every application must have a ``wx.App`` instance, and all
5105 creation of UI objects should be delayed until after the
03e37cd5
RD
5106 ``wx.App`` object has been created in order to ensure that the gui
5107 platform and wxWidgets have been fully initialized.
66c033b4
RD
5108
5109 Normally you would derive from this class and implement an
5110 ``OnInit`` method that creates a frame and then calls
5111 ``self.SetTopWindow(frame)``.
5112
03e37cd5 5113 :see: `wx.PySimpleApp` for a simpler app class that can be used
1c0f361b 5114 directly.
6c3b4aae 5115 """
66c033b4 5116
d14a1e28
RD
5117 outputWindowClass = PyOnDemandOutputWindow
5118
03e37cd5
RD
5119 def __init__(self, redirect=_defRedirect, filename=None,
5120 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5121 """
5122 Construct a ``wx.App`` object.
5123
03e37cd5
RD
5124 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5125 redirected? Defaults to True on Windows and Mac, False
5126 otherwise. If `filename` is None then output will be
5127 redirected to a window that pops up as needed. (You can
5128 control what kind of window is created for the output by
5129 resetting the class variable ``outputWindowClass`` to a
5130 class of your choosing.)
66c033b4 5131
03e37cd5
RD
5132 :param filename: The name of a file to redirect output to, if
5133 redirect is True.
66c033b4
RD
5134
5135 :param useBestVisual: Should the app try to use the best
03e37cd5
RD
5136 available visual provided by the system (only relevant on
5137 systems that have more than one visual.) This parameter
5138 must be used instead of calling `SetUseBestVisual` later
5139 on because it must be set before the underlying GUI
5140 toolkit is initialized.
5141
5142 :param clearSigInt: Should SIGINT be cleared? This allows the
5143 app to terminate upon a Ctrl-C in the console like other
5144 GUI apps will.
66c033b4
RD
5145
5146 :note: You should override OnInit to do applicaition
5147 initialization to ensure that the system, toolkit and
5148 wxWidgets are fully initialized.
5149 """
d14a1e28
RD
5150 wx.PyApp.__init__(self)
5151
5152 if wx.Platform == "__WXMAC__":
5153 try:
5154 import MacOS
5155 if not MacOS.WMAvailable():
5156 print """\
5157This program needs access to the screen. Please run with 'pythonw',
5158not 'python', and only when you are logged in on the main display of
5159your Mac."""
5160 _sys.exit(1)
36cadbf7
RD
5161 except SystemExit:
5162 raise
d14a1e28
RD
5163 except:
5164 pass
5165
5166 # This has to be done before OnInit
5167 self.SetUseBestVisual(useBestVisual)
5168
5169 # Set the default handler for SIGINT. This fixes a problem
5170 # where if Ctrl-C is pressed in the console that started this
5171 # app then it will not appear to do anything, (not even send
5172 # KeyboardInterrupt???) but will later segfault on exit. By
5173 # setting the default handler then the app will exit, as
5174 # expected (depending on platform.)
03e37cd5
RD
5175 if clearSigInt:
5176 try:
5177 import signal
5178 signal.signal(signal.SIGINT, signal.SIG_DFL)
5179 except:
5180 pass
d14a1e28
RD
5181
5182 # Save and redirect the stdio to a window?
5183 self.stdioWin = None
5184 self.saveStdio = (_sys.stdout, _sys.stderr)
5185 if redirect:
5186 self.RedirectStdio(filename)
5187
5188 # This finishes the initialization of wxWindows and then calls
5189 # the OnInit that should be present in the derived class
5190 self._BootstrapApp()
5191
5192
5193 def __del__(self):
5194 try:
5195 self.RestoreStdio() # Just in case the MainLoop was overridden
5196 except:
5197 pass
5198
5199
5200 def SetTopWindow(self, frame):
1e0c8722 5201 """Set the \"main\" top level window"""
d14a1e28
RD
5202 if self.stdioWin:
5203 self.stdioWin.SetParent(frame)
5204 wx.PyApp.SetTopWindow(self, frame)
5205
5206
5207 def MainLoop(self):
1e0c8722 5208 """Execute the main GUI event loop"""
d14a1e28
RD
5209 wx.PyApp.MainLoop(self)
5210 self.RestoreStdio()
5211
5212
7409c0c6 5213 def RedirectStdio(self, filename=None):
1e0c8722 5214 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
d14a1e28
RD
5215 if filename:
5216 _sys.stdout = _sys.stderr = open(filename, 'a')
5217 else:
5218 self.stdioWin = self.outputWindowClass()
5219 _sys.stdout = _sys.stderr = self.stdioWin
5220
5221
5222 def RestoreStdio(self):
5223 _sys.stdout, _sys.stderr = self.saveStdio
5224
5225
412d302d
RD
5226 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5227 """
5228 Set the title, position and/or size of the output window if
5229 the stdio has been redirected.
5230 """
5231 if self.stdioWin:
5232 if title is not None:
5233 self.stdioWin.title = title
5234 if pos is not None:
5235 self.stdioWin.pos = pos
5236 if size is not None:
5237 self.stdioWin.size = size
5238
5239
5240
d14a1e28 5241
66c033b4 5242# change from wx.PyApp_XX to wx.App_XX
54f9ee45
RD
5243App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5244App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5245App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5246App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5247App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5248App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5249App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5250App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5251App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5252App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5253App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
d14a1e28
RD
5254
5255#----------------------------------------------------------------------------
5256
5257class PySimpleApp(wx.App):
6c3b4aae
RD
5258 """
5259 A simple application class. You can just create one of these and
5260 then then make your top level windows later, and not have to worry
66c033b4
RD
5261 about OnInit. For example::
5262
5263 app = wx.PySimpleApp()
5264 frame = wx.Frame(None, title='Hello World')
5265 frame.Show()
5266 app.MainLoop()
5267
5268 :see: `wx.App`
5269 """
6c3b4aae 5270
03e37cd5
RD
5271 def __init__(self, redirect=False, filename=None,
5272 useBestVisual=False, clearSigInt=True):
66c033b4
RD
5273 """
5274 :see: `wx.App.__init__`
5275 """
03e37cd5 5276 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
6c3b4aae 5277
d14a1e28 5278 def OnInit(self):
d14a1e28
RD
5279 return True
5280
5281
66c033b4 5282
6c3b4aae 5283# Is anybody using this one?
d14a1e28
RD
5284class PyWidgetTester(wx.App):
5285 def __init__(self, size = (250, 100)):
5286 self.size = size
5287 wx.App.__init__(self, 0)
5288
5289 def OnInit(self):
196addbf 5290 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
d14a1e28
RD
5291 self.SetTopWindow(self.frame)
5292 return True
5293
66c033b4
RD
5294 def SetWidget(self, widgetClass, *args, **kwargs):
5295 w = widgetClass(self.frame, *args, **kwargs)
d14a1e28
RD
5296 self.frame.Show(True)
5297
5298#----------------------------------------------------------------------------
5299# DO NOT hold any other references to this object. This is how we
66c033b4 5300# know when to cleanup system resources that wxWidgets is holding. When
d14a1e28 5301# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
66c033b4 5302# goes to zero and it calls the wx.App_CleanUp function.
d14a1e28
RD
5303
5304class __wxPyCleanup:
5305 def __init__(self):
54f9ee45 5306 self.cleanup = _core_.App_CleanUp
d14a1e28
RD
5307 def __del__(self):
5308 self.cleanup()
5309
5310_sys.__wxPythonCleanup = __wxPyCleanup()
5311
5312## # another possible solution, but it gets called too early...
66c033b4
RD
5313## import atexit
5314## atexit.register(_core_.wxApp_CleanUp)
d14a1e28
RD
5315
5316
5317#----------------------------------------------------------------------------
5318
5319#---------------------------------------------------------------------------
5320
1e0c8722 5321class AcceleratorEntry(object):
66c033b4
RD
5322 """
5323 A class used to define items in an `wx.AcceleratorTable`. wxPython
5324 programs can choose to use wx.AcceleratorEntry objects, but using a
5325 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
41e2b43e 5326 as well. See `__init__` for of the tuple values.
66c033b4
RD
5327
5328 :see: `wx.AcceleratorTable`
5329 """
1e0c8722
RD
5330 def __repr__(self):
5331 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5332 def __init__(self, *args, **kwargs):
66c033b4
RD
5333 """
5334 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5335
5336 Construct a wx.AcceleratorEntry.
66c033b4 5337 """
54f9ee45 5338 newobj = _core_.new_AcceleratorEntry(*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_AcceleratorEntry):
a95a7133 5343 """__del__(self)"""
1e0c8722
RD
5344 try:
5345 if self.thisown: destroy(self)
5346 except: pass
5347
5348 def Set(*args, **kwargs):
66c033b4
RD
5349 """
5350 Set(self, int flags, int keyCode, int cmd)
1e0c8722 5351
66c033b4
RD
5352 (Re)set the attributes of a wx.AcceleratorEntry.
5353 :see `__init__`
5354 """
5355 return _core_.AcceleratorEntry_Set(*args, **kwargs)
1e0c8722
RD
5356
5357 def GetFlags(*args, **kwargs):
66c033b4
RD
5358 """
5359 GetFlags(self) -> int
5360
5361 Get the AcceleratorEntry's flags.
5362 """
54f9ee45 5363 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
1e0c8722
RD
5364
5365 def GetKeyCode(*args, **kwargs):
66c033b4
RD
5366 """
5367 GetKeyCode(self) -> int
5368
5369 Get the AcceleratorEntry's keycode.
5370 """
54f9ee45 5371 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
1e0c8722
RD
5372
5373 def GetCommand(*args, **kwargs):
66c033b4
RD
5374 """
5375 GetCommand(self) -> int
5376
5377 Get the AcceleratorEntry's command ID.
5378 """
54f9ee45 5379 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
1e0c8722
RD
5380
5381
5382class AcceleratorEntryPtr(AcceleratorEntry):
5383 def __init__(self, this):
5384 self.this = this
5385 if not hasattr(self,"thisown"): self.thisown = 0
5386 self.__class__ = AcceleratorEntry
54f9ee45 5387_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
1e0c8722
RD
5388
5389class AcceleratorTable(Object):
66c033b4
RD
5390 """
5391 An accelerator table allows the application to specify a table of
5392 keyboard shortcuts for menus or other commands. On Windows, menu or
5393 button commands are supported; on GTK, only menu commands are
5394 supported.
66c033b4 5395 """
1e0c8722
RD
5396 def __repr__(self):
5397 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5398 def __init__(self, *args, **kwargs):
0df68c9f
RD
5399 """
5400 __init__(entries) -> AcceleratorTable
1e0c8722 5401
66c033b4
RD
5402 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5403 items or or of 3-tuples (flags, keyCode, cmdID)
5404
5405 :see: `wx.AcceleratorEntry`
0df68c9f 5406 """
54f9ee45 5407 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
1e0c8722
RD
5408 self.this = newobj.this
5409 self.thisown = 1
5410 del newobj.thisown
54f9ee45 5411 def __del__(self, destroy=_core_.delete_AcceleratorTable):
a95a7133 5412 """__del__(self)"""
1e0c8722
RD
5413 try:
5414 if self.thisown: destroy(self)
5415 except: pass
5416
5417 def Ok(*args, **kwargs):
a95a7133 5418 """Ok(self) -> bool"""
54f9ee45 5419 return _core_.AcceleratorTable_Ok(*args, **kwargs)
1e0c8722
RD
5420
5421
5422class AcceleratorTablePtr(AcceleratorTable):
5423 def __init__(self, this):
5424 self.this = this
5425 if not hasattr(self,"thisown"): self.thisown = 0
5426 self.__class__ = AcceleratorTable
54f9ee45 5427_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
1e0c8722
RD
5428
5429
5430def GetAccelFromString(*args, **kwargs):
196addbf 5431 """GetAccelFromString(String label) -> AcceleratorEntry"""
54f9ee45 5432 return _core_.GetAccelFromString(*args, **kwargs)
1e0c8722
RD
5433#---------------------------------------------------------------------------
5434
74a57fcd
RD
5435class VisualAttributes(object):
5436 """struct containing all the visual attributes of a control"""
5437 def __repr__(self):
5438 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5439 def __init__(self, *args, **kwargs):
5440 """
a95a7133 5441 __init__(self) -> VisualAttributes
74a57fcd
RD
5442
5443 struct containing all the visual attributes of a control
5444 """
54f9ee45 5445 newobj = _core_.new_VisualAttributes(*args, **kwargs)
74a57fcd
RD
5446 self.this = newobj.this
5447 self.thisown = 1
5448 del newobj.thisown
54f9ee45 5449 def __del__(self, destroy=_core_.delete_VisualAttributes):
a95a7133 5450 """__del__(self)"""
74a57fcd
RD
5451 try:
5452 if self.thisown: destroy(self)
5453 except: pass
5454
54f9ee45
RD
5455 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5456 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5457 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
74a57fcd
RD
5458
5459class VisualAttributesPtr(VisualAttributes):
5460 def __init__(self, this):
5461 self.this = this
5462 if not hasattr(self,"thisown"): self.thisown = 0
5463 self.__class__ = VisualAttributes
54f9ee45 5464_core_.VisualAttributes_swigregister(VisualAttributesPtr)
74a57fcd
RD
5465NullAcceleratorTable = cvar.NullAcceleratorTable
5466PanelNameStr = cvar.PanelNameStr
5467
54f9ee45
RD
5468WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5469WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5470WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5471WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5472WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
d14a1e28 5473class Window(EvtHandler):
15afbcd0
RD
5474 """
5475 wx.Window is the base class for all windows and represents any visible
5476 object on the screen. All controls, top level windows and so on are
5477 wx.Windows. Sizers and device contexts are not however, as they don't
5478 appear on screen themselves.
5479
5480 """
e811c8ce
RD
5481 def __repr__(self):
5482 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 5483 def __init__(self, *args, **kwargs):
0df68c9f 5484 """
a95a7133 5485 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5486 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
15afbcd0
RD
5487
5488 Construct and show a generic Window.
0df68c9f 5489 """
54f9ee45 5490 newobj = _core_.new_Window(*args, **kwargs)
d14a1e28
RD
5491 self.this = newobj.this
5492 self.thisown = 1
5493 del newobj.thisown
5494 self._setOORInfo(self)
d14a1e28 5495
e811c8ce 5496 def Create(*args, **kwargs):
0df68c9f 5497 """
a95a7133 5498 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
74a57fcd 5499 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
15afbcd0
RD
5500
5501 Create the GUI part of the Window for 2-phase creation mode.
0df68c9f 5502 """
54f9ee45 5503 return _core_.Window_Create(*args, **kwargs)
d14a1e28 5504
e811c8ce 5505 def Close(*args, **kwargs):
15afbcd0 5506 """
a95a7133 5507 Close(self, bool force=False) -> bool
15afbcd0
RD
5508
5509 This function simply generates a EVT_CLOSE event whose handler usually
5510 tries to close the window. It doesn't close the window itself,
5511 however. If force is False (the default) then the window's close
5512 handler will be allowed to veto the destruction of the window.
15afbcd0 5513 """
54f9ee45 5514 return _core_.Window_Close(*args, **kwargs)
d14a1e28 5515
e811c8ce 5516 def Destroy(*args, **kwargs):
0df68c9f 5517 """
a95a7133 5518 Destroy(self) -> bool
d14a1e28 5519
15afbcd0
RD
5520 Destroys the window safely. Frames and dialogs are not destroyed
5521 immediately when this function is called -- they are added to a list
5522 of windows to be deleted on idle time, when all the window's events
5523 have been processed. This prevents problems with events being sent to
5524 non-existent windows.
5525
5526 Returns True if the window has either been successfully deleted, or it
5527 has been added to the list of windows pending real deletion.
0df68c9f 5528 """
54f9ee45 5529 return _core_.Window_Destroy(*args, **kwargs)
d14a1e28 5530
e811c8ce 5531 def DestroyChildren(*args, **kwargs):
15afbcd0 5532 """
a95a7133 5533 DestroyChildren(self) -> bool
15afbcd0 5534
41e2b43e
RD
5535 Destroys all children of a window. Called automatically by the
5536 destructor.
15afbcd0 5537 """
54f9ee45 5538 return _core_.Window_DestroyChildren(*args, **kwargs)
d14a1e28 5539
e811c8ce 5540 def IsBeingDeleted(*args, **kwargs):
15afbcd0 5541 """
a95a7133 5542 IsBeingDeleted(self) -> bool
15afbcd0
RD
5543
5544 Is the window in the process of being deleted?
5545 """
54f9ee45 5546 return _core_.Window_IsBeingDeleted(*args, **kwargs)
d14a1e28 5547
e811c8ce 5548 def SetTitle(*args, **kwargs):
15afbcd0 5549 """
a95a7133 5550 SetTitle(self, String title)
15afbcd0
RD
5551
5552 Sets the window's title. Applicable only to frames and dialogs.
5553 """
54f9ee45 5554 return _core_.Window_SetTitle(*args, **kwargs)
d14a1e28 5555
e811c8ce 5556 def GetTitle(*args, **kwargs):
15afbcd0 5557 """
a95a7133 5558 GetTitle(self) -> String
15afbcd0
RD
5559
5560 Gets the window's title. Applicable only to frames and dialogs.
5561 """
54f9ee45 5562 return _core_.Window_GetTitle(*args, **kwargs)
d14a1e28 5563
e811c8ce 5564 def SetLabel(*args, **kwargs):
15afbcd0 5565 """
a95a7133 5566 SetLabel(self, String label)
15afbcd0
RD
5567
5568 Set the text which the window shows in its label if applicable.
5569 """
54f9ee45 5570 return _core_.Window_SetLabel(*args, **kwargs)
d14a1e28 5571
e811c8ce 5572 def GetLabel(*args, **kwargs):
15afbcd0 5573 """
a95a7133 5574 GetLabel(self) -> String
15afbcd0 5575
41e2b43e
RD
5576 Generic way of getting a label from any window, for identification
5577 purposes. The interpretation of this function differs from class to
5578 class. For frames and dialogs, the value returned is the title. For
5579 buttons or static text controls, it is the button text. This function
5580 can be useful for meta-programs such as testing tools or special-needs
5581 access programs)which need to identify windows by name.
15afbcd0 5582 """
54f9ee45 5583 return _core_.Window_GetLabel(*args, **kwargs)
d14a1e28 5584
e811c8ce 5585 def SetName(*args, **kwargs):
15afbcd0 5586 """
a95a7133 5587 SetName(self, String name)
15afbcd0 5588
41e2b43e
RD
5589 Sets the window's name. The window name is used for ressource setting
5590 in X, it is not the same as the window title/label
15afbcd0 5591 """
54f9ee45 5592 return _core_.Window_SetName(*args, **kwargs)
d14a1e28 5593
e811c8ce 5594 def GetName(*args, **kwargs):
15afbcd0 5595 """
a95a7133 5596 GetName(self) -> String
15afbcd0 5597
41e2b43e
RD
5598 Returns the windows name. This name is not guaranteed to be unique;
5599 it is up to the programmer to supply an appropriate name in the window
5600 constructor or via wx.Window.SetName.
15afbcd0 5601 """
54f9ee45 5602 return _core_.Window_GetName(*args, **kwargs)
d14a1e28 5603
4276dc52
RD
5604 def SetWindowVariant(*args, **kwargs):
5605 """
a95a7133 5606 SetWindowVariant(self, int variant)
4276dc52 5607
41e2b43e
RD
5608 Sets the variant of the window/font size to use for this window, if
5609 the platform supports variants, for example, wxMac.
4276dc52 5610 """
54f9ee45 5611 return _core_.Window_SetWindowVariant(*args, **kwargs)
4276dc52
RD
5612
5613 def GetWindowVariant(*args, **kwargs):
a95a7133 5614 """GetWindowVariant(self) -> int"""
54f9ee45 5615 return _core_.Window_GetWindowVariant(*args, **kwargs)
4276dc52 5616
e811c8ce 5617 def SetId(*args, **kwargs):
15afbcd0 5618 """
a95a7133 5619 SetId(self, int winid)
15afbcd0
RD
5620
5621 Sets the identifier of the window. Each window has an integer
5622 identifier. If the application has not provided one, an identifier
5623 will be generated. Normally, the identifier should be provided on
5624 creation and should not be modified subsequently.
5625 """
54f9ee45 5626 return _core_.Window_SetId(*args, **kwargs)
d14a1e28 5627
e811c8ce 5628 def GetId(*args, **kwargs):
15afbcd0 5629 """
a95a7133 5630 GetId(self) -> int
15afbcd0
RD
5631
5632 Returns the identifier of the window. Each window has an integer
5633 identifier. If the application has not provided one (or the default Id
5634 -1 is used) then an unique identifier with a negative value will be
5635 generated.
5636 """
54f9ee45 5637 return _core_.Window_GetId(*args, **kwargs)
d14a1e28 5638
e811c8ce 5639 def NewControlId(*args, **kwargs):
15afbcd0 5640 """
66c033b4 5641 NewControlId() -> int
15afbcd0
RD
5642
5643 Generate a control id for the controls which were not given one.
5644 """
54f9ee45 5645 return _core_.Window_NewControlId(*args, **kwargs)
d14a1e28 5646
e811c8ce
RD
5647 NewControlId = staticmethod(NewControlId)
5648 def NextControlId(*args, **kwargs):
15afbcd0 5649 """
66c033b4 5650 NextControlId(int winid) -> int
15afbcd0
RD
5651
5652 Get the id of the control following the one with the given
41e2b43e 5653 autogenerated) id
15afbcd0 5654 """
54f9ee45 5655 return _core_.Window_NextControlId(*args, **kwargs)
d14a1e28 5656
e811c8ce
RD
5657 NextControlId = staticmethod(NextControlId)
5658 def PrevControlId(*args, **kwargs):
15afbcd0 5659 """
66c033b4 5660 PrevControlId(int winid) -> int
15afbcd0
RD
5661
5662 Get the id of the control preceding the one with the given
41e2b43e 5663 autogenerated) id
15afbcd0 5664 """
54f9ee45 5665 return _core_.Window_PrevControlId(*args, **kwargs)
d14a1e28 5666
e811c8ce
RD
5667 PrevControlId = staticmethod(PrevControlId)
5668 def SetSize(*args, **kwargs):
15afbcd0 5669 """
a95a7133 5670 SetSize(self, Size size)
15afbcd0
RD
5671
5672 Sets the size of the window in pixels.
5673 """
54f9ee45 5674 return _core_.Window_SetSize(*args, **kwargs)
d14a1e28 5675
e811c8ce 5676 def SetDimensions(*args, **kwargs):
15afbcd0 5677 """
a95a7133 5678 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5679
5680 Sets the position and size of the window in pixels. The sizeFlags
5681 parameter indicates the interpretation of the other params if they are
5682 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5683 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5684 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5685 dimensions of -1 and less to be interpreted as real dimensions, not
5686 default values.
5687 """
54f9ee45 5688 return _core_.Window_SetDimensions(*args, **kwargs)
d14a1e28 5689
e811c8ce 5690 def SetRect(*args, **kwargs):
15afbcd0 5691 """
a95a7133 5692 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
15afbcd0
RD
5693
5694 Sets the position and size of the window in pixels using a wx.Rect.
5695 """
54f9ee45 5696 return _core_.Window_SetRect(*args, **kwargs)
d14a1e28 5697
e811c8ce 5698 def SetSizeWH(*args, **kwargs):
15afbcd0 5699 """
a95a7133 5700 SetSizeWH(self, int width, int height)
15afbcd0
RD
5701
5702 Sets the size of the window in pixels.
5703 """
54f9ee45 5704 return _core_.Window_SetSizeWH(*args, **kwargs)
d14a1e28 5705
e811c8ce 5706 def Move(*args, **kwargs):
15afbcd0 5707 """
a95a7133 5708 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5709
5710 Moves the window to the given position.
5711 """
54f9ee45 5712 return _core_.Window_Move(*args, **kwargs)
d14a1e28 5713
e811c8ce
RD
5714 SetPosition = Move
5715 def MoveXY(*args, **kwargs):
15afbcd0 5716 """
a95a7133 5717 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
15afbcd0
RD
5718
5719 Moves the window to the given position.
5720 """
54f9ee45 5721 return _core_.Window_MoveXY(*args, **kwargs)
e811c8ce 5722
f8167d6e
RD
5723 def SetBestFittingSize(*args, **kwargs):
5724 """
5725 SetBestFittingSize(self, Size size=DefaultSize)
5726
5727 A 'Smart' SetSize that will fill in default size components with the
5728 window's *best size* values. Also set's the minsize for use with sizers.
5729 """
5730 return _core_.Window_SetBestFittingSize(*args, **kwargs)
5731
e811c8ce 5732 def Raise(*args, **kwargs):
15afbcd0 5733 """
a95a7133 5734 Raise(self)
15afbcd0
RD
5735
5736 Raises the window to the top of the window hierarchy if it is a
5737 managed window (dialog or frame).
5738 """
54f9ee45 5739 return _core_.Window_Raise(*args, **kwargs)
e811c8ce
RD
5740
5741 def Lower(*args, **kwargs):
15afbcd0 5742 """
a95a7133 5743 Lower(self)
15afbcd0
RD
5744
5745 Lowers the window to the bottom of the window hierarchy if it is a
5746 managed window (dialog or frame).
5747 """
54f9ee45 5748 return _core_.Window_Lower(*args, **kwargs)
e811c8ce
RD
5749
5750 def SetClientSize(*args, **kwargs):
15afbcd0 5751 """
a95a7133 5752 SetClientSize(self, Size size)
15afbcd0
RD
5753
5754 This sets the size of the window client area in pixels. Using this
5755 function to size a window tends to be more device-independent than
5756 wx.Window.SetSize, since the application need not worry about what
5757 dimensions the border or title bar have when trying to fit the window
5758 around panel items, for example.
5759 """
54f9ee45 5760 return _core_.Window_SetClientSize(*args, **kwargs)
e811c8ce
RD
5761
5762 def SetClientSizeWH(*args, **kwargs):
15afbcd0 5763 """
a95a7133 5764 SetClientSizeWH(self, int width, int height)
15afbcd0
RD
5765
5766 This sets the size of the window client area in pixels. Using this
5767 function to size a window tends to be more device-independent than
5768 wx.Window.SetSize, since the application need not worry about what
5769 dimensions the border or title bar have when trying to fit the window
5770 around panel items, for example.
5771 """
54f9ee45 5772 return _core_.Window_SetClientSizeWH(*args, **kwargs)
e811c8ce
RD
5773
5774 def SetClientRect(*args, **kwargs):
15afbcd0 5775 """
a95a7133 5776 SetClientRect(self, Rect rect)
15afbcd0
RD
5777
5778 This sets the size of the window client area in pixels. Using this
5779 function to size a window tends to be more device-independent than
5780 wx.Window.SetSize, since the application need not worry about what
5781 dimensions the border or title bar have when trying to fit the window
5782 around panel items, for example.
5783 """
54f9ee45 5784 return _core_.Window_SetClientRect(*args, **kwargs)
e811c8ce
RD
5785
5786 def GetPosition(*args, **kwargs):
0df68c9f 5787 """
a95a7133 5788 GetPosition(self) -> Point
e811c8ce 5789
0df68c9f
RD
5790 Get the window's position.
5791 """
54f9ee45 5792 return _core_.Window_GetPosition(*args, **kwargs)
e811c8ce
RD
5793
5794 def GetPositionTuple(*args, **kwargs):
0df68c9f
RD
5795 """
5796 GetPositionTuple() -> (x,y)
e811c8ce 5797
0df68c9f
RD
5798 Get the window's position.
5799 """
54f9ee45 5800 return _core_.Window_GetPositionTuple(*args, **kwargs)
e811c8ce
RD
5801
5802 def GetSize(*args, **kwargs):
0df68c9f 5803 """
a95a7133 5804 GetSize(self) -> Size
e811c8ce 5805
0df68c9f
RD
5806 Get the window size.
5807 """
54f9ee45 5808 return _core_.Window_GetSize(*args, **kwargs)
e811c8ce
RD
5809
5810 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
5811 """
5812 GetSizeTuple() -> (width, height)
e811c8ce 5813
0df68c9f
RD
5814 Get the window size.
5815 """
54f9ee45 5816 return _core_.Window_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
5817
5818 def GetRect(*args, **kwargs):
15afbcd0 5819 """
a95a7133 5820 GetRect(self) -> Rect
15afbcd0
RD
5821
5822 Returns the size and position of the window as a wx.Rect object.
5823 """
54f9ee45 5824 return _core_.Window_GetRect(*args, **kwargs)
e811c8ce
RD
5825
5826 def GetClientSize(*args, **kwargs):
0df68c9f 5827 """
a95a7133 5828 GetClientSize(self) -> Size
e811c8ce 5829
15afbcd0
RD
5830 This gets the size of the window's 'client area' in pixels. The client
5831 area is the area which may be drawn on by the programmer, excluding
5832 title bar, border, scrollbars, etc.
0df68c9f 5833 """
54f9ee45 5834 return _core_.Window_GetClientSize(*args, **kwargs)
e811c8ce
RD
5835
5836 def GetClientSizeTuple(*args, **kwargs):
0df68c9f
RD
5837 """
5838 GetClientSizeTuple() -> (width, height)
e811c8ce 5839
15afbcd0
RD
5840 This gets the size of the window's 'client area' in pixels. The client
5841 area is the area which may be drawn on by the programmer, excluding
5842 title bar, border, scrollbars, etc.
0df68c9f 5843 """
54f9ee45 5844 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
e811c8ce
RD
5845
5846 def GetClientAreaOrigin(*args, **kwargs):
15afbcd0 5847 """
a95a7133 5848 GetClientAreaOrigin(self) -> Point
15afbcd0
RD
5849
5850 Get the origin of the client area of the window relative to the
5851 window's top left corner (the client area may be shifted because of
5852 the borders, scrollbars, other decorations...)
5853 """
54f9ee45 5854 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
e811c8ce
RD
5855
5856 def GetClientRect(*args, **kwargs):
15afbcd0 5857 """
a95a7133 5858 GetClientRect(self) -> Rect
15afbcd0 5859
61863841 5860 Get the client area position and size as a `wx.Rect` object.
15afbcd0 5861 """
54f9ee45 5862 return _core_.Window_GetClientRect(*args, **kwargs)
e811c8ce
RD
5863
5864 def GetBestSize(*args, **kwargs):
0df68c9f 5865 """
a95a7133 5866 GetBestSize(self) -> Size
e811c8ce 5867
248ed943 5868 This function returns the best acceptable minimal size for the
41e2b43e
RD
5869 window, if applicable. For example, for a static text control, it will
5870 be the minimal size such that the control label is not truncated. For
5871 windows containing subwindows (suzh aswx.Panel), the size returned by
5872 this function will be the same as the size the window would have had
5873 after calling Fit.
0df68c9f 5874 """
54f9ee45 5875 return _core_.Window_GetBestSize(*args, **kwargs)
e811c8ce
RD
5876
5877 def GetBestSizeTuple(*args, **kwargs):
0df68c9f
RD
5878 """
5879 GetBestSizeTuple() -> (width, height)
e811c8ce 5880
248ed943 5881 This function returns the best acceptable minimal size for the
41e2b43e
RD
5882 window, if applicable. For example, for a static text control, it will
5883 be the minimal size such that the control label is not truncated. For
5884 windows containing subwindows (suzh aswx.Panel), the size returned by
5885 this function will be the same as the size the window would have had
5886 after calling Fit.
0df68c9f 5887 """
54f9ee45 5888 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
e811c8ce 5889
dfbb5885
RD
5890 def InvalidateBestSize(*args, **kwargs):
5891 """
5892 InvalidateBestSize(self)
5893
5894 Reset the cached best size value so it will be recalculated the next
5895 time it is needed.
5896 """
5897 return _core_.Window_InvalidateBestSize(*args, **kwargs)
5898
5899 def GetBestFittingSize(*args, **kwargs):
5900 """
5901 GetBestFittingSize(self) -> Size
5902
5903 This function will merge the window's best size into the window's
5904 minimum size, giving priority to the min size components, and returns
5905 the results.
5906
5907 """
5908 return _core_.Window_GetBestFittingSize(*args, **kwargs)
5909
e811c8ce 5910 def GetAdjustedBestSize(*args, **kwargs):
15afbcd0 5911 """
a95a7133 5912 GetAdjustedBestSize(self) -> Size
15afbcd0
RD
5913
5914 This method is similar to GetBestSize, except in one
5915 thing. GetBestSize should return the minimum untruncated size of the
5916 window, while this method will return the largest of BestSize and any
5917 user specified minimum size. ie. it is the minimum size the window
5918 should currently be drawn at, not the minimal size it can possibly
5919 tolerate.
5920 """
54f9ee45 5921 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
e811c8ce
RD
5922
5923 def Center(*args, **kwargs):
15afbcd0 5924 """
a95a7133 5925 Center(self, int direction=BOTH)
15afbcd0
RD
5926
5927 Centers the window. The parameter specifies the direction for
5928 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
5929 also include wx.CENTER_ON_SCREEN flag if you want to center the window
5930 on the entire screen and not on its parent window. If it is a
5931 top-level window and has no parent then it will always be centered
5932 relative to the screen.
5933 """
54f9ee45 5934 return _core_.Window_Center(*args, **kwargs)
e811c8ce
RD
5935
5936 Centre = Center
5937 def CenterOnScreen(*args, **kwargs):
15afbcd0 5938 """
a95a7133 5939 CenterOnScreen(self, int dir=BOTH)
15afbcd0
RD
5940
5941 Center on screen (only works for top level windows)
5942 """
54f9ee45 5943 return _core_.Window_CenterOnScreen(*args, **kwargs)
e811c8ce
RD
5944
5945 CentreOnScreen = CenterOnScreen
5946 def CenterOnParent(*args, **kwargs):
15afbcd0 5947 """
a95a7133 5948 CenterOnParent(self, int dir=BOTH)
15afbcd0
RD
5949
5950 Center with respect to the the parent window
5951 """
54f9ee45 5952 return _core_.Window_CenterOnParent(*args, **kwargs)
e811c8ce
RD
5953
5954 CentreOnParent = CenterOnParent
5955 def Fit(*args, **kwargs):
15afbcd0 5956 """
a95a7133 5957 Fit(self)
15afbcd0
RD
5958
5959 Sizes the window so that it fits around its subwindows. This function
5960 won't do anything if there are no subwindows and will only really work
5961 correctly if sizers are used for the subwindows layout. Also, if the
5962 window has exactly one subwindow it is better (faster and the result
5963 is more precise as Fit adds some margin to account for fuzziness of
5964 its calculations) to call window.SetClientSize(child.GetSize())
5965 instead of calling Fit.
5966 """
54f9ee45 5967 return _core_.Window_Fit(*args, **kwargs)
e811c8ce
RD
5968
5969 def FitInside(*args, **kwargs):
15afbcd0 5970 """
a95a7133 5971 FitInside(self)
15afbcd0
RD
5972
5973 Similar to Fit, but sizes the interior (virtual) size of a
5974 window. Mainly useful with scrolled windows to reset scrollbars after
5975 sizing changes that do not trigger a size event, and/or scrolled
5976 windows without an interior sizer. This function similarly won't do
5977 anything if there are no subwindows.
5978 """
54f9ee45 5979 return _core_.Window_FitInside(*args, **kwargs)
e811c8ce 5980
74a57fcd 5981 def SetSizeHints(*args):
0df68c9f 5982 """
908b74cd 5983 SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
a95a7133 5984 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
0df68c9f 5985 int incH=-1)
15afbcd0
RD
5986
5987 Allows specification of minimum and maximum window sizes, and window
5988 size increments. If a pair of values is not set (or set to -1), the
5989 default values will be used. If this function is called, the user
908b74cd
RD
5990 will not be able to size the window outside the given bounds (if it is
5991 a top-level window.) Sizers will also inspect the minimum window size
5992 and will use that value if set when calculating layout.
5993
5994 The resizing increments are only significant under Motif or Xt.
0df68c9f 5995 """
54f9ee45 5996 return _core_.Window_SetSizeHints(*args)
e811c8ce 5997
74a57fcd 5998 def SetVirtualSizeHints(*args):
15afbcd0 5999 """
a95a7133 6000 SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
908b74cd 6001 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
15afbcd0
RD
6002
6003 Allows specification of minimum and maximum virtual window sizes. If a
6004 pair of values is not set (or set to -1), the default values will be
6005 used. If this function is called, the user will not be able to size
6006 the virtual area of the window outside the given bounds.
6007 """
54f9ee45 6008 return _core_.Window_SetVirtualSizeHints(*args)
e811c8ce 6009
908b74cd
RD
6010 def GetMaxSize(*args, **kwargs):
6011 """GetMaxSize(self) -> Size"""
6012 return _core_.Window_GetMaxSize(*args, **kwargs)
6013
6014 def GetMinSize(*args, **kwargs):
6015 """GetMinSize(self) -> Size"""
6016 return _core_.Window_GetMinSize(*args, **kwargs)
6017
6018 def SetMinSize(*args, **kwargs):
6019 """
6020 SetMinSize(self, Size minSize)
6021
6022 A more convenient method than `SetSizeHints` for setting just the
6023 min size.
6024 """
6025 return _core_.Window_SetMinSize(*args, **kwargs)
6026
6027 def SetMaxSize(*args, **kwargs):
6028 """
6029 SetMaxSize(self, Size maxSize)
6030
6031 A more convenient method than `SetSizeHints` for setting just the
6032 max size.
6033 """
6034 return _core_.Window_SetMaxSize(*args, **kwargs)
6035
e811c8ce 6036 def GetMinWidth(*args, **kwargs):
a95a7133 6037 """GetMinWidth(self) -> int"""
54f9ee45 6038 return _core_.Window_GetMinWidth(*args, **kwargs)
e811c8ce
RD
6039
6040 def GetMinHeight(*args, **kwargs):
a95a7133 6041 """GetMinHeight(self) -> int"""
54f9ee45 6042 return _core_.Window_GetMinHeight(*args, **kwargs)
e811c8ce
RD
6043
6044 def GetMaxWidth(*args, **kwargs):
a95a7133 6045 """GetMaxWidth(self) -> int"""
54f9ee45 6046 return _core_.Window_GetMaxWidth(*args, **kwargs)
e811c8ce
RD
6047
6048 def GetMaxHeight(*args, **kwargs):
a95a7133 6049 """GetMaxHeight(self) -> int"""
54f9ee45 6050 return _core_.Window_GetMaxHeight(*args, **kwargs)
e811c8ce 6051
e811c8ce 6052 def SetVirtualSize(*args, **kwargs):
0df68c9f 6053 """
a95a7133 6054 SetVirtualSize(self, Size size)
e811c8ce 6055
15afbcd0
RD
6056 Set the the virtual size of a window in pixels. For most windows this
6057 is just the client area of the window, but for some like scrolled
6058 windows it is more or less independent of the screen window size.
0df68c9f 6059 """
54f9ee45 6060 return _core_.Window_SetVirtualSize(*args, **kwargs)
e811c8ce
RD
6061
6062 def SetVirtualSizeWH(*args, **kwargs):
0df68c9f 6063 """
a95a7133 6064 SetVirtualSizeWH(self, int w, int h)
e811c8ce 6065
15afbcd0
RD
6066 Set the the virtual size of a window in pixels. For most windows this
6067 is just the client area of the window, but for some like scrolled
6068 windows it is more or less independent of the screen window size.
0df68c9f 6069 """
54f9ee45 6070 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
e811c8ce
RD
6071
6072 def GetVirtualSize(*args, **kwargs):
0df68c9f 6073 """
a95a7133 6074 GetVirtualSize(self) -> Size
e811c8ce 6075
15afbcd0
RD
6076 Get the the virtual size of the window in pixels. For most windows
6077 this is just the client area of the window, but for some like scrolled
6078 windows it is more or less independent of the screen window size.
0df68c9f 6079 """
54f9ee45 6080 return _core_.Window_GetVirtualSize(*args, **kwargs)
e811c8ce
RD
6081
6082 def GetVirtualSizeTuple(*args, **kwargs):
0df68c9f
RD
6083 """
6084 GetVirtualSizeTuple() -> (width, height)
e811c8ce 6085
15afbcd0
RD
6086 Get the the virtual size of the window in pixels. For most windows
6087 this is just the client area of the window, but for some like scrolled
6088 windows it is more or less independent of the screen window size.
0df68c9f 6089 """
54f9ee45 6090 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
e811c8ce
RD
6091
6092 def GetBestVirtualSize(*args, **kwargs):
15afbcd0 6093 """
a95a7133 6094 GetBestVirtualSize(self) -> Size
15afbcd0
RD
6095
6096 Return the largest of ClientSize and BestSize (as determined by a
6097 sizer, interior children, or other means)
6098 """
54f9ee45 6099 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
e811c8ce
RD
6100
6101 def Show(*args, **kwargs):
15afbcd0 6102 """
a95a7133 6103 Show(self, bool show=True) -> bool
15afbcd0
RD
6104
6105 Shows or hides the window. You may need to call Raise for a top level
6106 window if you want to bring it to top, although this is not needed if
6107 Show is called immediately after the frame creation. Returns True if
6108 the window has been shown or hidden or False if nothing was done
6109 because it already was in the requested state.
6110 """
54f9ee45 6111 return _core_.Window_Show(*args, **kwargs)
e811c8ce
RD
6112
6113 def Hide(*args, **kwargs):
15afbcd0 6114 """
a95a7133 6115 Hide(self) -> bool
15afbcd0
RD
6116
6117 Equivalent to calling Show(False).
6118 """
54f9ee45 6119 return _core_.Window_Hide(*args, **kwargs)
e811c8ce
RD
6120
6121 def Enable(*args, **kwargs):
15afbcd0 6122 """
a95a7133 6123 Enable(self, bool enable=True) -> bool
15afbcd0
RD
6124
6125 Enable or disable the window for user input. Note that when a parent
6126 window is disabled, all of its children are disabled as well and they
6127 are reenabled again when the parent is. Returns true if the window
6128 has been enabled or disabled, false if nothing was done, i.e. if the
6129 window had already been in the specified state.
6130 """
54f9ee45 6131 return _core_.Window_Enable(*args, **kwargs)
e811c8ce
RD
6132
6133 def Disable(*args, **kwargs):
15afbcd0 6134 """
a95a7133 6135 Disable(self) -> bool
15afbcd0
RD
6136
6137 Disables the window, same as Enable(false).
6138 """
54f9ee45 6139 return _core_.Window_Disable(*args, **kwargs)
e811c8ce
RD
6140
6141 def IsShown(*args, **kwargs):
15afbcd0 6142 """
a95a7133 6143 IsShown(self) -> bool
15afbcd0
RD
6144
6145 Returns true if the window is shown, false if it has been hidden.
6146 """
54f9ee45 6147 return _core_.Window_IsShown(*args, **kwargs)
e811c8ce
RD
6148
6149 def IsEnabled(*args, **kwargs):
15afbcd0 6150 """
a95a7133 6151 IsEnabled(self) -> bool
15afbcd0
RD
6152
6153 Returns true if the window is enabled for input, false otherwise.
6154 """
54f9ee45 6155 return _core_.Window_IsEnabled(*args, **kwargs)
e811c8ce
RD
6156
6157 def SetWindowStyleFlag(*args, **kwargs):
15afbcd0 6158 """
a95a7133 6159 SetWindowStyleFlag(self, long style)
15afbcd0 6160
41e2b43e
RD
6161 Sets the style of the window. Please note that some styles cannot be
6162 changed after the window creation and that Refresh() might need to be
6163 called after changing the others for the change to take place
6164 immediately.
15afbcd0 6165 """
54f9ee45 6166 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
e811c8ce
RD
6167
6168 def GetWindowStyleFlag(*args, **kwargs):
15afbcd0 6169 """
a95a7133 6170 GetWindowStyleFlag(self) -> long
e811c8ce 6171
15afbcd0
RD
6172 Gets the window style that was passed to the constructor or Create
6173 method.
6174 """
54f9ee45 6175 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
e811c8ce 6176
15afbcd0 6177 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
e811c8ce 6178 def HasFlag(*args, **kwargs):
15afbcd0 6179 """
a95a7133 6180 HasFlag(self, int flag) -> bool
15afbcd0
RD
6181
6182 Test if the given style is set for this window.
6183 """
54f9ee45 6184 return _core_.Window_HasFlag(*args, **kwargs)
e811c8ce
RD
6185
6186 def IsRetained(*args, **kwargs):
15afbcd0 6187 """
a95a7133 6188 IsRetained(self) -> bool
15afbcd0
RD
6189
6190 Returns true if the window is retained, false otherwise. Retained
6191 windows are only available on X platforms.
6192 """
54f9ee45 6193 return _core_.Window_IsRetained(*args, **kwargs)
e811c8ce
RD
6194
6195 def SetExtraStyle(*args, **kwargs):
15afbcd0 6196 """
a95a7133 6197 SetExtraStyle(self, long exStyle)
15afbcd0
RD
6198
6199 Sets the extra style bits for the window. Extra styles are the less
6200 often used style bits which can't be set with the constructor or with
6201 SetWindowStyleFlag()
6202 """
54f9ee45 6203 return _core_.Window_SetExtraStyle(*args, **kwargs)
e811c8ce
RD
6204
6205 def GetExtraStyle(*args, **kwargs):
15afbcd0 6206 """
a95a7133 6207 GetExtraStyle(self) -> long
15afbcd0
RD
6208
6209 Returns the extra style bits for the window.
6210 """
54f9ee45 6211 return _core_.Window_GetExtraStyle(*args, **kwargs)
e811c8ce
RD
6212
6213 def MakeModal(*args, **kwargs):
15afbcd0 6214 """
a95a7133 6215 MakeModal(self, bool modal=True)
15afbcd0
RD
6216
6217 Disables all other windows in the application so that the user can
6218 only interact with this window. Passing False will reverse this
6219 effect.
6220 """
54f9ee45 6221 return _core_.Window_MakeModal(*args, **kwargs)
e811c8ce
RD
6222
6223 def SetThemeEnabled(*args, **kwargs):
15afbcd0 6224 """
a95a7133 6225 SetThemeEnabled(self, bool enableTheme)
15afbcd0
RD
6226
6227 This function tells a window if it should use the system's "theme"
6228 code to draw the windows' background instead if its own background
6229 drawing code. This will only have an effect on platforms that support
6230 the notion of themes in user defined windows. One such platform is
6231 GTK+ where windows can have (very colourful) backgrounds defined by a
6232 user's selected theme.
6233
6234 Dialogs, notebook pages and the status bar have this flag set to true
6235 by default so that the default look and feel is simulated best.
6236 """
54f9ee45 6237 return _core_.Window_SetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6238
6239 def GetThemeEnabled(*args, **kwargs):
15afbcd0 6240 """
a95a7133 6241 GetThemeEnabled(self) -> bool
e811c8ce 6242
15afbcd0
RD
6243 Return the themeEnabled flag.
6244 """
54f9ee45 6245 return _core_.Window_GetThemeEnabled(*args, **kwargs)
e811c8ce
RD
6246
6247 def SetFocus(*args, **kwargs):
15afbcd0 6248 """
a95a7133 6249 SetFocus(self)
15afbcd0
RD
6250
6251 Set's the focus to this window, allowing it to receive keyboard input.
6252 """
54f9ee45 6253 return _core_.Window_SetFocus(*args, **kwargs)
e811c8ce
RD
6254
6255 def SetFocusFromKbd(*args, **kwargs):
15afbcd0 6256 """
a95a7133 6257 SetFocusFromKbd(self)
15afbcd0
RD
6258
6259 Set focus to this window as the result of a keyboard action. Normally
6260 only called internally.
6261 """
54f9ee45 6262 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
e811c8ce
RD
6263
6264 def FindFocus(*args, **kwargs):
15afbcd0 6265 """
66c033b4 6266 FindFocus() -> Window
15afbcd0
RD
6267
6268 Returns the window or control that currently has the keyboard focus,
6269 or None.
6270 """
54f9ee45 6271 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
6272
6273 FindFocus = staticmethod(FindFocus)
6274 def AcceptsFocus(*args, **kwargs):
15afbcd0 6275 """
a95a7133 6276 AcceptsFocus(self) -> bool
15afbcd0
RD
6277
6278 Can this window have focus?
6279 """
54f9ee45 6280 return _core_.Window_AcceptsFocus(*args, **kwargs)
e811c8ce
RD
6281
6282 def AcceptsFocusFromKeyboard(*args, **kwargs):
15afbcd0 6283 """
a95a7133 6284 AcceptsFocusFromKeyboard(self) -> bool
15afbcd0
RD
6285
6286 Can this window be given focus by keyboard navigation? if not, the
6287 only way to give it focus (provided it accepts it at all) is to click
6288 it.
6289 """
54f9ee45 6290 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
e811c8ce
RD
6291
6292 def GetDefaultItem(*args, **kwargs):
15afbcd0 6293 """
a95a7133 6294 GetDefaultItem(self) -> Window
15afbcd0
RD
6295
6296 Get the default child of this parent, i.e. the one which is activated
6297 by pressing <Enter> such as the OK button on a wx.Dialog.
6298 """
54f9ee45 6299 return _core_.Window_GetDefaultItem(*args, **kwargs)
e811c8ce
RD
6300
6301 def SetDefaultItem(*args, **kwargs):
15afbcd0 6302 """
a95a7133 6303 SetDefaultItem(self, Window child) -> Window
15afbcd0
RD
6304
6305 Set this child as default, return the old default.
6306 """
54f9ee45 6307 return _core_.Window_SetDefaultItem(*args, **kwargs)
e811c8ce
RD
6308
6309 def SetTmpDefaultItem(*args, **kwargs):
15afbcd0 6310 """
a95a7133 6311 SetTmpDefaultItem(self, Window win)
15afbcd0
RD
6312
6313 Set this child as temporary default
6314 """
54f9ee45 6315 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
e811c8ce 6316
908b74cd
RD
6317 def Navigate(*args, **kwargs):
6318 """
6319 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6320
fd2dc343
RD
6321 Does keyboard navigation from this window to another, by sending a
6322 `wx.NavigationKeyEvent`.
908b74cd
RD
6323 """
6324 return _core_.Window_Navigate(*args, **kwargs)
6325
e811c8ce 6326 def GetChildren(*args, **kwargs):
15afbcd0 6327 """
a95a7133 6328 GetChildren(self) -> PyObject
15afbcd0
RD
6329
6330 Returns a list of the window's children. NOTE: Currently this is a
6331 copy of the child window list maintained by the window, so the return
6332 value of this function is only valid as long as the window's children
6333 do not change.
6334 """
54f9ee45 6335 return _core_.Window_GetChildren(*args, **kwargs)
e811c8ce
RD
6336
6337 def GetParent(*args, **kwargs):
15afbcd0 6338 """
a95a7133 6339 GetParent(self) -> Window
15afbcd0
RD
6340
6341 Returns the parent window of this window, or None if there isn't one.
6342 """
54f9ee45 6343 return _core_.Window_GetParent(*args, **kwargs)
e811c8ce
RD
6344
6345 def GetGrandParent(*args, **kwargs):
15afbcd0 6346 """
a95a7133 6347 GetGrandParent(self) -> Window
15afbcd0 6348
41e2b43e
RD
6349 Returns the parent of the parent of this window, or None if there
6350 isn't one.
15afbcd0 6351 """
54f9ee45 6352 return _core_.Window_GetGrandParent(*args, **kwargs)
e811c8ce
RD
6353
6354 def IsTopLevel(*args, **kwargs):
15afbcd0 6355 """
a95a7133 6356 IsTopLevel(self) -> bool
15afbcd0
RD
6357
6358 Returns true if the given window is a top-level one. Currently all
6359 frames and dialogs are always considered to be top-level windows (even
6360 if they have a parent window).
6361 """
54f9ee45 6362 return _core_.Window_IsTopLevel(*args, **kwargs)
e811c8ce
RD
6363
6364 def Reparent(*args, **kwargs):
15afbcd0 6365 """
a95a7133 6366 Reparent(self, Window newParent) -> bool
15afbcd0
RD
6367
6368 Reparents the window, i.e the window will be removed from its current
6369 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6370 re-inserted into another. Available on Windows and GTK. Returns True
6371 if the parent was changed, False otherwise (error or newParent ==
6372 oldParent)
6373 """
54f9ee45 6374 return _core_.Window_Reparent(*args, **kwargs)
e811c8ce
RD
6375
6376 def AddChild(*args, **kwargs):
15afbcd0 6377 """
a95a7133 6378 AddChild(self, Window child)
15afbcd0
RD
6379
6380 Adds a child window. This is called automatically by window creation
6381 functions so should not be required by the application programmer.
6382 """
54f9ee45 6383 return _core_.Window_AddChild(*args, **kwargs)
e811c8ce
RD
6384
6385 def RemoveChild(*args, **kwargs):
15afbcd0 6386 """
a95a7133 6387 RemoveChild(self, Window child)
15afbcd0
RD
6388
6389 Removes a child window. This is called automatically by window
6390 deletion functions so should not be required by the application
6391 programmer.
6392 """
54f9ee45 6393 return _core_.Window_RemoveChild(*args, **kwargs)
e811c8ce
RD
6394
6395 def FindWindowById(*args, **kwargs):
15afbcd0 6396 """
a95a7133 6397 FindWindowById(self, long winid) -> Window
15afbcd0
RD
6398
6399 Find a chld of this window by window ID
6400 """
54f9ee45 6401 return _core_.Window_FindWindowById(*args, **kwargs)
e811c8ce
RD
6402
6403 def FindWindowByName(*args, **kwargs):
15afbcd0 6404 """
a95a7133 6405 FindWindowByName(self, String name) -> Window
15afbcd0
RD
6406
6407 Find a child of this window by name
6408 """
54f9ee45 6409 return _core_.Window_FindWindowByName(*args, **kwargs)
e811c8ce
RD
6410
6411 def GetEventHandler(*args, **kwargs):
15afbcd0 6412 """
a95a7133 6413 GetEventHandler(self) -> EvtHandler
15afbcd0
RD
6414
6415 Returns the event handler for this window. By default, the window is
6416 its own event handler.
6417 """
54f9ee45 6418 return _core_.Window_GetEventHandler(*args, **kwargs)
e811c8ce
RD
6419
6420 def SetEventHandler(*args, **kwargs):
15afbcd0 6421 """
a95a7133 6422 SetEventHandler(self, EvtHandler handler)
15afbcd0
RD
6423
6424 Sets the event handler for this window. An event handler is an object
6425 that is capable of processing the events sent to a window. By default,
6426 the window is its own event handler, but an application may wish to
6427 substitute another, for example to allow central implementation of
6428 event-handling for a variety of different window classes.
6429
41e2b43e 6430 It is usually better to use `wx.Window.PushEventHandler` since this sets
15afbcd0
RD
6431 up a chain of event handlers, where an event not handled by one event
6432 handler is handed to the next one in the chain.
6433 """
54f9ee45 6434 return _core_.Window_SetEventHandler(*args, **kwargs)
e811c8ce
RD
6435
6436 def PushEventHandler(*args, **kwargs):
15afbcd0 6437 """
a95a7133 6438 PushEventHandler(self, EvtHandler handler)
15afbcd0
RD
6439
6440 Pushes this event handler onto the event handler stack for the window.
6441 An event handler is an object that is capable of processing the events
6442 sent to a window. By default, the window is its own event handler, but
6443 an application may wish to substitute another, for example to allow
6444 central implementation of event-handling for a variety of different
6445 window classes.
6446
6447 wx.Window.PushEventHandler allows an application to set up a chain of
6448 event handlers, where an event not handled by one event handler is
41e2b43e 6449 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
15afbcd0
RD
6450 remove the event handler.
6451 """
54f9ee45 6452 return _core_.Window_PushEventHandler(*args, **kwargs)
e811c8ce
RD
6453
6454 def PopEventHandler(*args, **kwargs):
15afbcd0 6455 """
a95a7133 6456 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
15afbcd0
RD
6457
6458 Removes and returns the top-most event handler on the event handler
6459 stack. If deleteHandler is True then the wx.EvtHandler object will be
6460 destroyed after it is popped.
6461 """
54f9ee45 6462 return _core_.Window_PopEventHandler(*args, **kwargs)
e811c8ce
RD
6463
6464 def RemoveEventHandler(*args, **kwargs):
15afbcd0 6465 """
a95a7133 6466 RemoveEventHandler(self, EvtHandler handler) -> bool
15afbcd0 6467
41e2b43e
RD
6468 Find the given handler in the event handler chain and remove (but not
6469 delete) it from the event handler chain, return True if it was found
6470 and False otherwise (this also results in an assert failure so this
6471 function should only be called when the handler is supposed to be
6472 there.)
15afbcd0 6473 """
54f9ee45 6474 return _core_.Window_RemoveEventHandler(*args, **kwargs)
e811c8ce
RD
6475
6476 def SetValidator(*args, **kwargs):
15afbcd0 6477 """
a95a7133 6478 SetValidator(self, Validator validator)
15afbcd0
RD
6479
6480 Deletes the current validator (if any) and sets the window validator,
6481 having called wx.Validator.Clone to create a new validator of this
6482 type.
6483 """
54f9ee45 6484 return _core_.Window_SetValidator(*args, **kwargs)
e811c8ce
RD
6485
6486 def GetValidator(*args, **kwargs):
15afbcd0 6487 """
a95a7133 6488 GetValidator(self) -> Validator
15afbcd0
RD
6489
6490 Returns a pointer to the current validator for the window, or None if
6491 there is none.
6492 """
54f9ee45 6493 return _core_.Window_GetValidator(*args, **kwargs)
e811c8ce 6494
74a57fcd
RD
6495 def Validate(*args, **kwargs):
6496 """
a95a7133 6497 Validate(self) -> bool
74a57fcd
RD
6498
6499 Validates the current values of the child controls using their
41e2b43e
RD
6500 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6501 style flag set, the method will also call Validate() of all child
6502 windows. Returns false if any of the validations failed.
74a57fcd 6503 """
54f9ee45 6504 return _core_.Window_Validate(*args, **kwargs)
74a57fcd
RD
6505
6506 def TransferDataToWindow(*args, **kwargs):
6507 """
a95a7133 6508 TransferDataToWindow(self) -> bool
74a57fcd 6509
41e2b43e
RD
6510 Transfers values to child controls from data areas specified by their
6511 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6512 style flag set, the method will also call TransferDataToWindow() of
6513 all child windows.
74a57fcd 6514 """
54f9ee45 6515 return _core_.Window_TransferDataToWindow(*args, **kwargs)
74a57fcd
RD
6516
6517 def TransferDataFromWindow(*args, **kwargs):
6518 """
a95a7133 6519 TransferDataFromWindow(self) -> bool
74a57fcd 6520
41e2b43e
RD
6521 Transfers values from child controls to data areas specified by their
6522 validators. Returns false if a transfer failed. If the window has
6523 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6524 also call TransferDataFromWindow() of all child windows.
74a57fcd 6525 """
54f9ee45 6526 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
74a57fcd
RD
6527
6528 def InitDialog(*args, **kwargs):
6529 """
a95a7133 6530 InitDialog(self)
74a57fcd 6531
41e2b43e
RD
6532 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6533 to the dialog via validators.
74a57fcd 6534 """
54f9ee45 6535 return _core_.Window_InitDialog(*args, **kwargs)
74a57fcd 6536
e811c8ce 6537 def SetAcceleratorTable(*args, **kwargs):
15afbcd0 6538 """
a95a7133 6539 SetAcceleratorTable(self, AcceleratorTable accel)
15afbcd0
RD
6540
6541 Sets the accelerator table for this window.
6542 """
54f9ee45 6543 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6544
6545 def GetAcceleratorTable(*args, **kwargs):
15afbcd0 6546 """
a95a7133 6547 GetAcceleratorTable(self) -> AcceleratorTable
15afbcd0
RD
6548
6549 Gets the accelerator table for this window.
6550 """
54f9ee45 6551 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
e811c8ce
RD
6552
6553 def RegisterHotKey(*args, **kwargs):
15afbcd0 6554 """
a95a7133 6555 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
15afbcd0
RD
6556
6557 Registers a system wide hotkey. Every time the user presses the hotkey
6558 registered here, this window will receive a hotkey event. It will
6559 receive the event even if the application is in the background and
6560 does not have the input focus because the user is working with some
6561 other application. To bind an event handler function to this hotkey
6562 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6563 hotkey was registered successfully.
6564 """
54f9ee45 6565 return _core_.Window_RegisterHotKey(*args, **kwargs)
e811c8ce
RD
6566
6567 def UnregisterHotKey(*args, **kwargs):
15afbcd0 6568 """
a95a7133 6569 UnregisterHotKey(self, int hotkeyId) -> bool
15afbcd0
RD
6570
6571 Unregisters a system wide hotkey.
6572 """
54f9ee45 6573 return _core_.Window_UnregisterHotKey(*args, **kwargs)
e811c8ce
RD
6574
6575 def ConvertDialogPointToPixels(*args, **kwargs):
15afbcd0 6576 """
a95a7133 6577 ConvertDialogPointToPixels(self, Point pt) -> Point
15afbcd0
RD
6578
6579 Converts a point or size from dialog units to pixels. Dialog units
6580 are used for maintaining a dialog's proportions even if the font
6581 changes. For the x dimension, the dialog units are multiplied by the
6582 average character width and then divided by 4. For the y dimension,
6583 the dialog units are multiplied by the average character height and
6584 then divided by 8.
6585 """
54f9ee45 6586 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
e811c8ce
RD
6587
6588 def ConvertDialogSizeToPixels(*args, **kwargs):
15afbcd0 6589 """
a95a7133 6590 ConvertDialogSizeToPixels(self, Size sz) -> Size
15afbcd0
RD
6591
6592 Converts a point or size from dialog units to pixels. Dialog units
6593 are used for maintaining a dialog's proportions even if the font
6594 changes. For the x dimension, the dialog units are multiplied by the
6595 average character width and then divided by 4. For the y dimension,
6596 the dialog units are multiplied by the average character height and
6597 then divided by 8.
6598 """
54f9ee45 6599 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
e811c8ce
RD
6600
6601 def DLG_PNT(*args, **kwargs):
15afbcd0 6602 """
a95a7133 6603 DLG_PNT(self, Point pt) -> Point
15afbcd0
RD
6604
6605 Converts a point or size from dialog units to pixels. Dialog units
6606 are used for maintaining a dialog's proportions even if the font
6607 changes. For the x dimension, the dialog units are multiplied by the
6608 average character width and then divided by 4. For the y dimension,
6609 the dialog units are multiplied by the average character height and
6610 then divided by 8.
6611 """
54f9ee45 6612 return _core_.Window_DLG_PNT(*args, **kwargs)
e811c8ce
RD
6613
6614 def DLG_SZE(*args, **kwargs):
15afbcd0 6615 """
a95a7133 6616 DLG_SZE(self, Size sz) -> Size
15afbcd0
RD
6617
6618 Converts a point or size from dialog units to pixels. Dialog units
6619 are used for maintaining a dialog's proportions even if the font
6620 changes. For the x dimension, the dialog units are multiplied by the
6621 average character width and then divided by 4. For the y dimension,
6622 the dialog units are multiplied by the average character height and
6623 then divided by 8.
6624 """
54f9ee45 6625 return _core_.Window_DLG_SZE(*args, **kwargs)
e811c8ce
RD
6626
6627 def ConvertPixelPointToDialog(*args, **kwargs):
a95a7133 6628 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
54f9ee45 6629 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
e811c8ce
RD
6630
6631 def ConvertPixelSizeToDialog(*args, **kwargs):
a95a7133 6632 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
54f9ee45 6633 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
e811c8ce
RD
6634
6635 def WarpPointer(*args, **kwargs):
15afbcd0 6636 """
a95a7133 6637 WarpPointer(self, int x, int y)
15afbcd0
RD
6638
6639 Moves the pointer to the given position on the window.
6640
6641 NOTE: This function is not supported under Mac because Apple Human
6642 Interface Guidelines forbid moving the mouse cursor programmatically.
6643 """
54f9ee45 6644 return _core_.Window_WarpPointer(*args, **kwargs)
e811c8ce
RD
6645
6646 def CaptureMouse(*args, **kwargs):
15afbcd0 6647 """
a95a7133 6648 CaptureMouse(self)
15afbcd0
RD
6649
6650 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6651 release the capture.
6652
6653 Note that wxWindows maintains the stack of windows having captured the
6654 mouse and when the mouse is released the capture returns to the window
6655 which had had captured it previously and it is only really released if
6656 there were no previous window. In particular, this means that you must
6657 release the mouse as many times as you capture it.
6658 """
54f9ee45 6659 return _core_.Window_CaptureMouse(*args, **kwargs)
e811c8ce
RD
6660
6661 def ReleaseMouse(*args, **kwargs):
15afbcd0 6662 """
a95a7133 6663 ReleaseMouse(self)
15afbcd0
RD
6664
6665 Releases mouse input captured with wx.Window.CaptureMouse.
6666 """
54f9ee45 6667 return _core_.Window_ReleaseMouse(*args, **kwargs)
e811c8ce
RD
6668
6669 def GetCapture(*args, **kwargs):
15afbcd0 6670 """
66c033b4 6671 GetCapture() -> Window
15afbcd0
RD
6672
6673 Returns the window which currently captures the mouse or None
6674 """
54f9ee45 6675 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce
RD
6676
6677 GetCapture = staticmethod(GetCapture)
6678 def HasCapture(*args, **kwargs):
15afbcd0 6679 """
a95a7133 6680 HasCapture(self) -> bool
15afbcd0
RD
6681
6682 Returns true if this window has the current mouse capture.
6683 """
54f9ee45 6684 return _core_.Window_HasCapture(*args, **kwargs)
e811c8ce
RD
6685
6686 def Refresh(*args, **kwargs):
15afbcd0 6687 """
a95a7133 6688 Refresh(self, bool eraseBackground=True, Rect rect=None)
15afbcd0
RD
6689
6690 Mark the specified rectangle (or the whole window) as "dirty" so it
6691 will be repainted. Causes an EVT_PAINT event to be generated and sent
6692 to the window.
6693 """
54f9ee45 6694 return _core_.Window_Refresh(*args, **kwargs)
e811c8ce
RD
6695
6696 def RefreshRect(*args, **kwargs):
15afbcd0 6697 """
a95a7133 6698 RefreshRect(self, Rect rect)
15afbcd0
RD
6699
6700 Redraws the contents of the given rectangle: the area inside it will
6701 be repainted. This is the same as Refresh but has a nicer syntax.
6702 """
54f9ee45 6703 return _core_.Window_RefreshRect(*args, **kwargs)
e811c8ce
RD
6704
6705 def Update(*args, **kwargs):
15afbcd0 6706 """
a95a7133 6707 Update(self)
15afbcd0
RD
6708
6709 Calling this method immediately repaints the invalidated area of the
6710 window instead of waiting for the EVT_PAINT event to happen, (normally
6711 this would usually only happen when the flow of control returns to the
6712 event loop.) Notice that this function doesn't refresh the window and
6713 does nothing if the window has been already repainted. Use Refresh
6714 first if you want to immediately redraw the window (or some portion of
6715 it) unconditionally.
6716 """
54f9ee45 6717 return _core_.Window_Update(*args, **kwargs)
e811c8ce
RD
6718
6719 def ClearBackground(*args, **kwargs):
15afbcd0 6720 """
a95a7133 6721 ClearBackground(self)
15afbcd0
RD
6722
6723 Clears the window by filling it with the current background
6724 colour. Does not cause an erase background event to be generated.
6725 """
54f9ee45 6726 return _core_.Window_ClearBackground(*args, **kwargs)
e811c8ce
RD
6727
6728 def Freeze(*args, **kwargs):
15afbcd0 6729 """
a95a7133 6730 Freeze(self)
15afbcd0 6731
41e2b43e
RD
6732 Freezes the window or, in other words, prevents any updates from
6733 taking place on screen, the window is not redrawn at all. Thaw must be
6734 called to reenable window redrawing. Calls to Freeze/Thaw may be
6735 nested, with the actual Thaw being delayed until all the nesting has
6736 been undone.
15afbcd0
RD
6737
6738 This method is useful for visual appearance optimization (for example,
6739 it is a good idea to use it before inserting large amount of text into
6740 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6741 for all controls so it is mostly just a hint to wxWindows and not a
6742 mandatory directive.
6743 """
54f9ee45 6744 return _core_.Window_Freeze(*args, **kwargs)
e811c8ce
RD
6745
6746 def Thaw(*args, **kwargs):
15afbcd0 6747 """
a95a7133 6748 Thaw(self)
15afbcd0 6749
4276dc52 6750 Reenables window updating after a previous call to Freeze. Calls to
41e2b43e
RD
6751 Freeze/Thaw may be nested, so Thaw must be called the same number of
6752 times that Freeze was before the window will be updated.
15afbcd0 6753 """
54f9ee45 6754 return _core_.Window_Thaw(*args, **kwargs)
e811c8ce
RD
6755
6756 def PrepareDC(*args, **kwargs):
15afbcd0 6757 """
a95a7133 6758 PrepareDC(self, DC dc)
15afbcd0
RD
6759
6760 Call this function to prepare the device context for drawing a
6761 scrolled image. It sets the device origin according to the current
6762 scroll position.
6763 """
54f9ee45 6764 return _core_.Window_PrepareDC(*args, **kwargs)
e811c8ce
RD
6765
6766 def GetUpdateRegion(*args, **kwargs):
15afbcd0 6767 """
a95a7133 6768 GetUpdateRegion(self) -> Region
15afbcd0
RD
6769
6770 Returns the region specifying which parts of the window have been
6771 damaged. Should only be called within an EVT_PAINT handler.
6772 """
54f9ee45 6773 return _core_.Window_GetUpdateRegion(*args, **kwargs)
e811c8ce
RD
6774
6775 def GetUpdateClientRect(*args, **kwargs):
15afbcd0 6776 """
a95a7133 6777 GetUpdateClientRect(self) -> Rect
15afbcd0
RD
6778
6779 Get the update rectangle region bounding box in client coords.
6780 """
54f9ee45 6781 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
e811c8ce
RD
6782
6783 def IsExposed(*args, **kwargs):
15afbcd0 6784 """
a95a7133 6785 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
15afbcd0
RD
6786
6787 Returns true if the given point or rectangle area has been exposed
6788 since the last repaint. Call this in an paint event handler to
6789 optimize redrawing by only redrawing those areas, which have been
6790 exposed.
6791 """
54f9ee45 6792 return _core_.Window_IsExposed(*args, **kwargs)
e811c8ce
RD
6793
6794 def IsExposedPoint(*args, **kwargs):
15afbcd0 6795 """
a95a7133 6796 IsExposedPoint(self, Point pt) -> bool
15afbcd0
RD
6797
6798 Returns true if the given point or rectangle area has been exposed
6799 since the last repaint. Call this in an paint event handler to
6800 optimize redrawing by only redrawing those areas, which have been
6801 exposed.
6802 """
54f9ee45 6803 return _core_.Window_IsExposedPoint(*args, **kwargs)
e811c8ce 6804
4276dc52 6805 def IsExposedRect(*args, **kwargs):
15afbcd0 6806 """
a95a7133 6807 IsExposedRect(self, Rect rect) -> bool
15afbcd0
RD
6808
6809 Returns true if the given point or rectangle area has been exposed
6810 since the last repaint. Call this in an paint event handler to
6811 optimize redrawing by only redrawing those areas, which have been
6812 exposed.
6813 """
54f9ee45 6814 return _core_.Window_IsExposedRect(*args, **kwargs)
e811c8ce 6815
74a57fcd
RD
6816 def GetDefaultAttributes(*args, **kwargs):
6817 """
a95a7133 6818 GetDefaultAttributes(self) -> VisualAttributes
74a57fcd 6819
41e2b43e
RD
6820 Get the default attributes for an instance of this class. This is
6821 useful if you want to use the same font or colour in your own control
6822 as in a standard control -- which is a much better idea than hard
6823 coding specific colours or fonts which might look completely out of
db3e571a 6824 place on the user's system, especially if it uses themes.
74a57fcd 6825 """
54f9ee45 6826 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6827
6828 def GetClassDefaultAttributes(*args, **kwargs):
6829 """
66c033b4 6830 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
74a57fcd 6831
41e2b43e
RD
6832 Get the default attributes for this class. This is useful if you want
6833 to use the same font or colour in your own control as in a standard
6834 control -- which is a much better idea than hard coding specific
db3e571a
RD
6835 colours or fonts which might look completely out of place on the
6836 user's system, especially if it uses themes.
74a57fcd
RD
6837
6838 The variant parameter is only relevant under Mac currently and is
41e2b43e 6839 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
6840 the returned font. See `wx.Window.SetWindowVariant` for more about
6841 this.
74a57fcd 6842 """
54f9ee45 6843 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
6844
6845 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
e811c8ce 6846 def SetBackgroundColour(*args, **kwargs):
15afbcd0 6847 """
a95a7133 6848 SetBackgroundColour(self, Colour colour) -> bool
15afbcd0
RD
6849
6850 Sets the background colour of the window. Returns True if the colour
6851 was changed. The background colour is usually painted by the default
6852 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
6853 automatically under GTK. Using `wx.NullColour` will reset the window
6854 to the default background colour.
15afbcd0 6855
db3e571a 6856 Note that setting the background colour may not cause an immediate
f8167d6e 6857 refresh, so you may wish to call `ClearBackground` or `Refresh` after
15afbcd0
RD
6858 calling this function.
6859
f8167d6e
RD
6860 Using this function will disable attempts to use themes for this
6861 window, if the system supports them. Use with care since usually the
6862 themes represent the appearance chosen by the user to be used for all
6863 applications on the system.
15afbcd0 6864 """
54f9ee45 6865 return _core_.Window_SetBackgroundColour(*args, **kwargs)
e811c8ce 6866
412d302d
RD
6867 def SetOwnBackgroundColour(*args, **kwargs):
6868 """SetOwnBackgroundColour(self, Colour colour)"""
6869 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
b2df227b 6870
e811c8ce 6871 def SetForegroundColour(*args, **kwargs):
15afbcd0 6872 """
a95a7133 6873 SetForegroundColour(self, Colour colour) -> bool
15afbcd0
RD
6874
6875 Sets the foreground colour of the window. Returns True is the colour
6876 was changed. The interpretation of foreground colour is dependent on
6877 the window class; it may be the text colour or other colour, or it may
6878 not be used at all.
6879 """
54f9ee45 6880 return _core_.Window_SetForegroundColour(*args, **kwargs)
e811c8ce 6881
fa47d7a7
VS
6882 def SetOwnForegroundColour(*args, **kwargs):
6883 """SetOwnForegroundColour(self, Colour colour)"""
6884 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
b2df227b 6885
e811c8ce 6886 def GetBackgroundColour(*args, **kwargs):
15afbcd0 6887 """
a95a7133 6888 GetBackgroundColour(self) -> Colour
15afbcd0
RD
6889
6890 Returns the background colour of the window.
6891 """
54f9ee45 6892 return _core_.Window_GetBackgroundColour(*args, **kwargs)
e811c8ce
RD
6893
6894 def GetForegroundColour(*args, **kwargs):
15afbcd0 6895 """
a95a7133 6896 GetForegroundColour(self) -> Colour
15afbcd0
RD
6897
6898 Returns the foreground colour of the window. The interpretation of
6899 foreground colour is dependent on the window class; it may be the text
6900 colour or other colour, or it may not be used at all.
6901 """
54f9ee45 6902 return _core_.Window_GetForegroundColour(*args, **kwargs)
e811c8ce
RD
6903
6904 def SetCursor(*args, **kwargs):
15afbcd0 6905 """
a95a7133 6906 SetCursor(self, Cursor cursor) -> bool
15afbcd0
RD
6907
6908 Sets the window's cursor. Notice that the window cursor also sets it
6909 for the children of the window implicitly.
6910
6911 The cursor may be wx.NullCursor in which case the window cursor will
6912 be reset back to default.
6913 """
54f9ee45 6914 return _core_.Window_SetCursor(*args, **kwargs)
e811c8ce
RD
6915
6916 def GetCursor(*args, **kwargs):
15afbcd0 6917 """
a95a7133 6918 GetCursor(self) -> Cursor
15afbcd0
RD
6919
6920 Return the cursor associated with this window.
6921 """
54f9ee45 6922 return _core_.Window_GetCursor(*args, **kwargs)
e811c8ce
RD
6923
6924 def SetFont(*args, **kwargs):
15afbcd0 6925 """
a95a7133 6926 SetFont(self, Font font) -> bool
15afbcd0
RD
6927
6928 Sets the font for this window.
6929 """
54f9ee45 6930 return _core_.Window_SetFont(*args, **kwargs)
e811c8ce 6931
fa47d7a7
VS
6932 def SetOwnFont(*args, **kwargs):
6933 """SetOwnFont(self, Font font)"""
6934 return _core_.Window_SetOwnFont(*args, **kwargs)
b2df227b 6935
e811c8ce 6936 def GetFont(*args, **kwargs):
15afbcd0 6937 """
a95a7133 6938 GetFont(self) -> Font
15afbcd0 6939
4276dc52 6940 Returns the default font used for this window.
15afbcd0 6941 """
54f9ee45 6942 return _core_.Window_GetFont(*args, **kwargs)
e811c8ce
RD
6943
6944 def SetCaret(*args, **kwargs):
15afbcd0 6945 """
a95a7133 6946 SetCaret(self, Caret caret)
15afbcd0
RD
6947
6948 Sets the caret associated with the window.
6949 """
54f9ee45 6950 return _core_.Window_SetCaret(*args, **kwargs)
e811c8ce
RD
6951
6952 def GetCaret(*args, **kwargs):
15afbcd0 6953 """
a95a7133 6954 GetCaret(self) -> Caret
15afbcd0
RD
6955
6956 Returns the caret associated with the window.
6957 """
54f9ee45 6958 return _core_.Window_GetCaret(*args, **kwargs)
e811c8ce
RD
6959
6960 def GetCharHeight(*args, **kwargs):
15afbcd0 6961 """
a95a7133 6962 GetCharHeight(self) -> int
15afbcd0
RD
6963
6964 Get the (average) character size for the current font.
6965 """
54f9ee45 6966 return _core_.Window_GetCharHeight(*args, **kwargs)
e811c8ce
RD
6967
6968 def GetCharWidth(*args, **kwargs):
15afbcd0 6969 """
a95a7133 6970 GetCharWidth(self) -> int
15afbcd0
RD
6971
6972 Get the (average) character size for the current font.
6973 """
54f9ee45 6974 return _core_.Window_GetCharWidth(*args, **kwargs)
e811c8ce
RD
6975
6976 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
6977 """
6978 GetTextExtent(String string) -> (width, height)
6979
6980 Get the width and height of the text using the current font.
6981 """
54f9ee45 6982 return _core_.Window_GetTextExtent(*args, **kwargs)
e811c8ce
RD
6983
6984 def GetFullTextExtent(*args, **kwargs):
0df68c9f 6985 """
196addbf 6986 GetFullTextExtent(String string, Font font=None) ->
0df68c9f 6987 (width, height, descent, externalLeading)
e811c8ce 6988
15afbcd0
RD
6989 Get the width, height, decent and leading of the text using the
6990 current or specified font.
0df68c9f 6991 """
54f9ee45 6992 return _core_.Window_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
6993
6994 def ClientToScreenXY(*args, **kwargs):
15afbcd0
RD
6995 """
6996 ClientToScreenXY(int x, int y) -> (x,y)
6997
6998 Converts to screen coordinates from coordinates relative to this window.
6999 """
54f9ee45 7000 return _core_.Window_ClientToScreenXY(*args, **kwargs)
e811c8ce
RD
7001
7002 def ScreenToClientXY(*args, **kwargs):
15afbcd0
RD
7003 """
7004 ScreenToClientXY(int x, int y) -> (x,y)
7005
7006 Converts from screen to client window coordinates.
7007 """
54f9ee45 7008 return _core_.Window_ScreenToClientXY(*args, **kwargs)
e811c8ce
RD
7009
7010 def ClientToScreen(*args, **kwargs):
15afbcd0 7011 """
a95a7133 7012 ClientToScreen(self, Point pt) -> Point
15afbcd0
RD
7013
7014 Converts to screen coordinates from coordinates relative to this window.
7015 """
54f9ee45 7016 return _core_.Window_ClientToScreen(*args, **kwargs)
e811c8ce
RD
7017
7018 def ScreenToClient(*args, **kwargs):
15afbcd0 7019 """
a95a7133 7020 ScreenToClient(self, Point pt) -> Point
15afbcd0
RD
7021
7022 Converts from screen to client window coordinates.
7023 """
54f9ee45 7024 return _core_.Window_ScreenToClient(*args, **kwargs)
e811c8ce
RD
7025
7026 def HitTestXY(*args, **kwargs):
15afbcd0 7027 """
a95a7133 7028 HitTestXY(self, int x, int y) -> int
15afbcd0
RD
7029
7030 Test where the given (in client coords) point lies
7031 """
54f9ee45 7032 return _core_.Window_HitTestXY(*args, **kwargs)
e811c8ce
RD
7033
7034 def HitTest(*args, **kwargs):
15afbcd0 7035 """
a95a7133 7036 HitTest(self, Point pt) -> int
15afbcd0
RD
7037
7038 Test where the given (in client coords) point lies
7039 """
54f9ee45 7040 return _core_.Window_HitTest(*args, **kwargs)
e811c8ce 7041
15afbcd0
RD
7042 def GetBorder(*args):
7043 """
a95a7133
RD
7044 GetBorder(self, long flags) -> int
7045 GetBorder(self) -> int
e811c8ce 7046
15afbcd0
RD
7047 Get border for the flags of this window
7048 """
54f9ee45 7049 return _core_.Window_GetBorder(*args)
e811c8ce
RD
7050
7051 def UpdateWindowUI(*args, **kwargs):
15afbcd0 7052 """
a95a7133 7053 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
15afbcd0
RD
7054
7055 This function sends EVT_UPDATE_UI events to the window. The particular
7056 implementation depends on the window; for example a wx.ToolBar will
7057 send an update UI event for each toolbar button, and a wx.Frame will
7058 send an update UI event for each menubar menu item. You can call this
7059 function from your application to ensure that your UI is up-to-date at
7060 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7061 concerned). This may be necessary if you have called
7062 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7063 limit the overhead that wxWindows incurs by sending update UI events
7064 in idle time.
15afbcd0 7065 """
54f9ee45 7066 return _core_.Window_UpdateWindowUI(*args, **kwargs)
e811c8ce
RD
7067
7068 def PopupMenuXY(*args, **kwargs):
15afbcd0 7069 """
b0503257 7070 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
15afbcd0 7071
b0503257
RD
7072 Pops up the given menu at the specified coordinates, relative to this window,
7073 and returns control when the user has dismissed the menu. If a menu item is
7074 selected, the corresponding menu event is generated and will be processed as
7075 usual. If the default position is given then the current position of the
7076 mouse cursor will be used.
15afbcd0 7077 """
54f9ee45 7078 return _core_.Window_PopupMenuXY(*args, **kwargs)
e811c8ce 7079
15afbcd0
RD
7080 def PopupMenu(*args, **kwargs):
7081 """
b0503257 7082 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
15afbcd0 7083
b0503257
RD
7084 Pops up the given menu at the specified coordinates, relative to this window,
7085 and returns control when the user has dismissed the menu. If a menu item is
7086 selected, the corresponding menu event is generated and will be processed as
7087 usual. If the default position is given then the current position of the
7088 mouse cursor will be used.
15afbcd0 7089 """
54f9ee45 7090 return _core_.Window_PopupMenu(*args, **kwargs)
15afbcd0
RD
7091
7092 def GetHandle(*args, **kwargs):
7093 """
a95a7133 7094 GetHandle(self) -> long
15afbcd0
RD
7095
7096 Returns the platform-specific handle (as a long integer) of the
7097 physical window. Currently on wxMac it returns the handle of the
7098 toplevel parent of the window.
7099 """
54f9ee45 7100 return _core_.Window_GetHandle(*args, **kwargs)
15afbcd0
RD
7101
7102 def HasScrollbar(*args, **kwargs):
7103 """
a95a7133 7104 HasScrollbar(self, int orient) -> bool
15afbcd0
RD
7105
7106 Does the window have the scrollbar for this orientation?
7107 """
54f9ee45 7108 return _core_.Window_HasScrollbar(*args, **kwargs)
15afbcd0
RD
7109
7110 def SetScrollbar(*args, **kwargs):
7111 """
41e2b43e 7112 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
15afbcd0
RD
7113 bool refresh=True)
7114
7115 Sets the scrollbar properties of a built-in scrollbar.
15afbcd0 7116 """
54f9ee45 7117 return _core_.Window_SetScrollbar(*args, **kwargs)
e811c8ce
RD
7118
7119 def SetScrollPos(*args, **kwargs):
15afbcd0 7120 """
a95a7133 7121 SetScrollPos(self, int orientation, int pos, bool refresh=True)
15afbcd0
RD
7122
7123 Sets the position of one of the built-in scrollbars.
7124 """
54f9ee45 7125 return _core_.Window_SetScrollPos(*args, **kwargs)
e811c8ce
RD
7126
7127 def GetScrollPos(*args, **kwargs):
15afbcd0 7128 """
a95a7133 7129 GetScrollPos(self, int orientation) -> int
15afbcd0
RD
7130
7131 Returns the built-in scrollbar position.
7132 """
54f9ee45 7133 return _core_.Window_GetScrollPos(*args, **kwargs)
e811c8ce
RD
7134
7135 def GetScrollThumb(*args, **kwargs):
15afbcd0 7136 """
a95a7133 7137 GetScrollThumb(self, int orientation) -> int
15afbcd0
RD
7138
7139 Returns the built-in scrollbar thumb size.
7140 """
54f9ee45 7141 return _core_.Window_GetScrollThumb(*args, **kwargs)
e811c8ce
RD
7142
7143 def GetScrollRange(*args, **kwargs):
15afbcd0 7144 """
a95a7133 7145 GetScrollRange(self, int orientation) -> int
15afbcd0
RD
7146
7147 Returns the built-in scrollbar range.
7148 """
54f9ee45 7149 return _core_.Window_GetScrollRange(*args, **kwargs)
e811c8ce
RD
7150
7151 def ScrollWindow(*args, **kwargs):
15afbcd0 7152 """
a95a7133 7153 ScrollWindow(self, int dx, int dy, Rect rect=None)
15afbcd0
RD
7154
7155 Physically scrolls the pixels in the window and move child windows
7156 accordingly. Use this function to optimise your scrolling
7157 implementations, to minimise the area that must be redrawn. Note that
7158 it is rarely required to call this function from a user program.
15afbcd0 7159 """
54f9ee45 7160 return _core_.Window_ScrollWindow(*args, **kwargs)
e811c8ce
RD
7161
7162 def ScrollLines(*args, **kwargs):
15afbcd0 7163 """
a95a7133 7164 ScrollLines(self, int lines) -> bool
15afbcd0
RD
7165
7166 If the platform and window class supports it, scrolls the window by
7167 the given number of lines down, if lines is positive, or up if lines
7168 is negative. Returns True if the window was scrolled, False if it was
7169 already on top/bottom and nothing was done.
7170 """
54f9ee45 7171 return _core_.Window_ScrollLines(*args, **kwargs)
e811c8ce
RD
7172
7173 def ScrollPages(*args, **kwargs):
15afbcd0 7174 """
a95a7133 7175 ScrollPages(self, int pages) -> bool
15afbcd0 7176
41e2b43e 7177 If the platform and window class supports it, scrolls the window by
15afbcd0
RD
7178 the given number of pages down, if pages is positive, or up if pages
7179 is negative. Returns True if the window was scrolled, False if it was
7180 already on top/bottom and nothing was done.
7181 """
54f9ee45 7182 return _core_.Window_ScrollPages(*args, **kwargs)
e811c8ce
RD
7183
7184 def LineUp(*args, **kwargs):
15afbcd0 7185 """
a95a7133 7186 LineUp(self) -> bool
15afbcd0
RD
7187
7188 This is just a wrapper for ScrollLines(-1).
7189 """
54f9ee45 7190 return _core_.Window_LineUp(*args, **kwargs)
e811c8ce
RD
7191
7192 def LineDown(*args, **kwargs):
15afbcd0 7193 """
a95a7133 7194 LineDown(self) -> bool
15afbcd0
RD
7195
7196 This is just a wrapper for ScrollLines(1).
7197 """
54f9ee45 7198 return _core_.Window_LineDown(*args, **kwargs)
e811c8ce
RD
7199
7200 def PageUp(*args, **kwargs):
15afbcd0 7201 """
a95a7133 7202 PageUp(self) -> bool
15afbcd0
RD
7203
7204 This is just a wrapper for ScrollPages(-1).
7205 """
54f9ee45 7206 return _core_.Window_PageUp(*args, **kwargs)
e811c8ce
RD
7207
7208 def PageDown(*args, **kwargs):
15afbcd0 7209 """
a95a7133 7210 PageDown(self) -> bool
15afbcd0
RD
7211
7212 This is just a wrapper for ScrollPages(1).
7213 """
54f9ee45 7214 return _core_.Window_PageDown(*args, **kwargs)
e811c8ce
RD
7215
7216 def SetHelpText(*args, **kwargs):
15afbcd0 7217 """
a95a7133 7218 SetHelpText(self, String text)
15afbcd0
RD
7219
7220 Sets the help text to be used as context-sensitive help for this
7221 window. Note that the text is actually stored by the current
7222 wxHelpProvider implementation, and not in the window object itself.
7223 """
54f9ee45 7224 return _core_.Window_SetHelpText(*args, **kwargs)
e811c8ce
RD
7225
7226 def SetHelpTextForId(*args, **kwargs):
15afbcd0 7227 """
a95a7133 7228 SetHelpTextForId(self, String text)
15afbcd0
RD
7229
7230 Associate this help text with all windows with the same id as this
7231 one.
7232 """
54f9ee45 7233 return _core_.Window_SetHelpTextForId(*args, **kwargs)
e811c8ce
RD
7234
7235 def GetHelpText(*args, **kwargs):
15afbcd0 7236 """
a95a7133 7237 GetHelpText(self) -> String
15afbcd0
RD
7238
7239 Gets the help text to be used as context-sensitive help for this
7240 window. Note that the text is actually stored by the current
7241 wxHelpProvider implementation, and not in the window object itself.
7242 """
54f9ee45 7243 return _core_.Window_GetHelpText(*args, **kwargs)
e811c8ce
RD
7244
7245 def SetToolTipString(*args, **kwargs):
15afbcd0 7246 """
a95a7133 7247 SetToolTipString(self, String tip)
15afbcd0
RD
7248
7249 Attach a tooltip to the window.
7250 """
54f9ee45 7251 return _core_.Window_SetToolTipString(*args, **kwargs)
e811c8ce
RD
7252
7253 def SetToolTip(*args, **kwargs):
15afbcd0 7254 """
a95a7133 7255 SetToolTip(self, ToolTip tip)
15afbcd0
RD
7256
7257 Attach a tooltip to the window.
7258 """
54f9ee45 7259 return _core_.Window_SetToolTip(*args, **kwargs)
e811c8ce
RD
7260
7261 def GetToolTip(*args, **kwargs):
15afbcd0 7262 """
a95a7133 7263 GetToolTip(self) -> ToolTip
15afbcd0
RD
7264
7265 get the associated tooltip or None if none
7266 """
54f9ee45 7267 return _core_.Window_GetToolTip(*args, **kwargs)
e811c8ce
RD
7268
7269 def SetDropTarget(*args, **kwargs):
15afbcd0 7270 """
a95a7133 7271 SetDropTarget(self, DropTarget dropTarget)
15afbcd0
RD
7272
7273 Associates a drop target with this window. If the window already has
7274 a drop target, it is deleted.
7275 """
54f9ee45 7276 return _core_.Window_SetDropTarget(*args, **kwargs)
e811c8ce
RD
7277
7278 def GetDropTarget(*args, **kwargs):
15afbcd0 7279 """
a95a7133 7280 GetDropTarget(self) -> DropTarget
15afbcd0
RD
7281
7282 Returns the associated drop target, which may be None.
7283 """
54f9ee45 7284 return _core_.Window_GetDropTarget(*args, **kwargs)
e811c8ce
RD
7285
7286 def SetConstraints(*args, **kwargs):
15afbcd0 7287 """
a95a7133 7288 SetConstraints(self, LayoutConstraints constraints)
15afbcd0
RD
7289
7290 Sets the window to have the given layout constraints. If an existing
7291 layout constraints object is already owned by the window, it will be
7292 deleted. Pass None to disassociate and delete the window's current
7293 constraints.
7294
7295 You must call SetAutoLayout to tell a window to use the constraints
7296 automatically in its default EVT_SIZE handler; otherwise, you must
7297 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7298 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7299 effect.
7300 """
54f9ee45 7301 return _core_.Window_SetConstraints(*args, **kwargs)
e811c8ce
RD
7302
7303 def GetConstraints(*args, **kwargs):
15afbcd0 7304 """
a95a7133 7305 GetConstraints(self) -> LayoutConstraints
15afbcd0
RD
7306
7307 Returns a pointer to the window's layout constraints, or None if there
7308 are none.
7309 """
54f9ee45 7310 return _core_.Window_GetConstraints(*args, **kwargs)
e811c8ce
RD
7311
7312 def SetAutoLayout(*args, **kwargs):
15afbcd0 7313 """
a95a7133 7314 SetAutoLayout(self, bool autoLayout)
15afbcd0
RD
7315
7316 Determines whether the Layout function will be called automatically
7317 when the window is resized. It is called implicitly by SetSizer but
7318 if you use SetConstraints you should call it manually or otherwise the
7319 window layout won't be correctly updated when its size changes.
7320 """
54f9ee45 7321 return _core_.Window_SetAutoLayout(*args, **kwargs)
e811c8ce
RD
7322
7323 def GetAutoLayout(*args, **kwargs):
15afbcd0 7324 """
a95a7133 7325 GetAutoLayout(self) -> bool
15afbcd0
RD
7326
7327 Returns the current autoLayout setting
7328 """
54f9ee45 7329 return _core_.Window_GetAutoLayout(*args, **kwargs)
e811c8ce
RD
7330
7331 def Layout(*args, **kwargs):
15afbcd0 7332 """
a95a7133 7333 Layout(self) -> bool
15afbcd0
RD
7334
7335 Invokes the constraint-based layout algorithm or the sizer-based
7336 algorithm for this window. See SetAutoLayout: when auto layout is on,
7337 this function gets called automatically by the default EVT_SIZE
7338 handler when the window is resized.
7339 """
54f9ee45 7340 return _core_.Window_Layout(*args, **kwargs)
e811c8ce
RD
7341
7342 def SetSizer(*args, **kwargs):
15afbcd0 7343 """
a95a7133 7344 SetSizer(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7345
7346 Sets the window to have the given layout sizer. The window will then
7347 own the object, and will take care of its deletion. If an existing
7348 layout sizer object is already owned by the window, it will be deleted
7349 if the deleteOld parameter is true. Note that this function will also
7350 call SetAutoLayout implicitly with a True parameter if the sizer is
7351 non-NoneL and False otherwise.
7352 """
54f9ee45 7353 return _core_.Window_SetSizer(*args, **kwargs)
e811c8ce
RD
7354
7355 def SetSizerAndFit(*args, **kwargs):
15afbcd0 7356 """
a95a7133 7357 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
15afbcd0
RD
7358
7359 The same as SetSizer, except it also sets the size hints for the
7360 window based on the sizer's minimum size.
7361 """
54f9ee45 7362 return _core_.Window_SetSizerAndFit(*args, **kwargs)
e811c8ce
RD
7363
7364 def GetSizer(*args, **kwargs):
15afbcd0 7365 """
a95a7133 7366 GetSizer(self) -> Sizer
15afbcd0
RD
7367
7368 Return the sizer associated with the window by a previous call to
7369 SetSizer or None if there isn't one.
7370 """
54f9ee45 7371 return _core_.Window_GetSizer(*args, **kwargs)
e811c8ce
RD
7372
7373 def SetContainingSizer(*args, **kwargs):
15afbcd0 7374 """
a95a7133 7375 SetContainingSizer(self, Sizer sizer)
15afbcd0
RD
7376
7377 This normally does not need to be called by application code. It is
7378 called internally when a window is added to a sizer, and is used so
7379 the window can remove itself from the sizer when it is destroyed.
7380 """
54f9ee45 7381 return _core_.Window_SetContainingSizer(*args, **kwargs)
e811c8ce
RD
7382
7383 def GetContainingSizer(*args, **kwargs):
15afbcd0 7384 """
a95a7133 7385 GetContainingSizer(self) -> Sizer
15afbcd0
RD
7386
7387 Return the sizer that this window is a member of, if any, otherwise None.
7388 """
54f9ee45 7389 return _core_.Window_GetContainingSizer(*args, **kwargs)
e811c8ce 7390
a95a7133
RD
7391 def InheritAttributes(*args, **kwargs):
7392 """
7393 InheritAttributes(self)
7394
41e2b43e
RD
7395 This function is (or should be, in case of custom controls) called
7396 during window creation to intelligently set up the window visual
7397 attributes, that is the font and the foreground and background
7398 colours.
7399
7400 By 'intelligently' the following is meant: by default, all windows use
7401 their own default attributes. However if some of the parent's
7402 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7403 SetOwnFont) and if the corresponding attribute hadn't been
41e2b43e
RD
7404 explicitly set for this window itself, then this window takes the same
7405 value as used by the parent. In addition, if the window overrides
7406 ShouldInheritColours to return false, the colours will not be changed
7407 no matter what and only the font might.
7408
7409 This rather complicated logic is necessary in order to accomodate the
7410 different usage scenarius. The most common one is when all default
7411 attributes are used and in this case, nothing should be inherited as
7412 in modern GUIs different controls use different fonts (and colours)
7413 than their siblings so they can't inherit the same value from the
7414 parent. However it was also deemed desirable to allow to simply change
7415 the attributes of all children at once by just changing the font or
7416 colour of their common parent, hence in this case we do inherit the
7417 parents attributes.
7418
a95a7133 7419 """
54f9ee45 7420 return _core_.Window_InheritAttributes(*args, **kwargs)
a95a7133
RD
7421
7422 def ShouldInheritColours(*args, **kwargs):
7423 """
7424 ShouldInheritColours(self) -> bool
7425
7426 Return true from here to allow the colours of this window to be
41e2b43e
RD
7427 changed by InheritAttributes, returning false forbids inheriting them
7428 from the parent window.
a95a7133 7429
41e2b43e
RD
7430 The base class version returns false, but this method is overridden in
7431 wxControl where it returns true.
a95a7133 7432 """
54f9ee45 7433 return _core_.Window_ShouldInheritColours(*args, **kwargs)
a95a7133 7434
e811c8ce 7435 def PostCreate(self, pre):
15afbcd0
RD
7436 """
7437 Phase 3 of the 2-phase create <wink!>
7438 Call this method after precreating the window with the 2-phase create method.
7439 """
e811c8ce
RD
7440 self.this = pre.this
7441 self.thisown = pre.thisown
7442 pre.thisown = 0
7443 if hasattr(self, '_setOORInfo'):
7444 self._setOORInfo(self)
7445 if hasattr(self, '_setCallbackInfo'):
7446 self._setCallbackInfo(self, self.__class__)
7447
7448
7449class WindowPtr(Window):
7450 def __init__(self, this):
7451 self.this = this
7452 if not hasattr(self,"thisown"): self.thisown = 0
7453 self.__class__ = Window
54f9ee45 7454_core_.Window_swigregister(WindowPtr)
e811c8ce
RD
7455
7456def PreWindow(*args, **kwargs):
15afbcd0
RD
7457 """
7458 PreWindow() -> Window
7459
7460 Precreate a Window for 2-phase creation.
7461 """
54f9ee45 7462 val = _core_.new_PreWindow(*args, **kwargs)
e811c8ce
RD
7463 val.thisown = 1
7464 return val
7465
7466def Window_NewControlId(*args, **kwargs):
15afbcd0
RD
7467 """
7468 Window_NewControlId() -> int
7469
7470 Generate a control id for the controls which were not given one.
7471 """
54f9ee45 7472 return _core_.Window_NewControlId(*args, **kwargs)
e811c8ce
RD
7473
7474def Window_NextControlId(*args, **kwargs):
15afbcd0
RD
7475 """
7476 Window_NextControlId(int winid) -> int
7477
7478 Get the id of the control following the one with the given
41e2b43e 7479 autogenerated) id
15afbcd0 7480 """
54f9ee45 7481 return _core_.Window_NextControlId(*args, **kwargs)
e811c8ce
RD
7482
7483def Window_PrevControlId(*args, **kwargs):
15afbcd0
RD
7484 """
7485 Window_PrevControlId(int winid) -> int
7486
7487 Get the id of the control preceding the one with the given
41e2b43e 7488 autogenerated) id
15afbcd0 7489 """
54f9ee45 7490 return _core_.Window_PrevControlId(*args, **kwargs)
e811c8ce
RD
7491
7492def Window_FindFocus(*args, **kwargs):
15afbcd0
RD
7493 """
7494 Window_FindFocus() -> Window
7495
7496 Returns the window or control that currently has the keyboard focus,
7497 or None.
7498 """
54f9ee45 7499 return _core_.Window_FindFocus(*args, **kwargs)
e811c8ce
RD
7500
7501def Window_GetCapture(*args, **kwargs):
15afbcd0
RD
7502 """
7503 Window_GetCapture() -> Window
7504
7505 Returns the window which currently captures the mouse or None
7506 """
54f9ee45 7507 return _core_.Window_GetCapture(*args, **kwargs)
e811c8ce 7508
74a57fcd
RD
7509def Window_GetClassDefaultAttributes(*args, **kwargs):
7510 """
7511 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7512
41e2b43e
RD
7513 Get the default attributes for this class. This is useful if you want
7514 to use the same font or colour in your own control as in a standard
7515 control -- which is a much better idea than hard coding specific
db3e571a
RD
7516 colours or fonts which might look completely out of place on the
7517 user's system, especially if it uses themes.
74a57fcd
RD
7518
7519 The variant parameter is only relevant under Mac currently and is
41e2b43e 7520 ignore under other platforms. Under Mac, it will change the size of
db3e571a
RD
7521 the returned font. See `wx.Window.SetWindowVariant` for more about
7522 this.
74a57fcd 7523 """
54f9ee45 7524 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 7525
e811c8ce 7526def DLG_PNT(win, point_or_x, y=None):
15afbcd0
RD
7527 """
7528 Convenience function for converting a Point or (x,y) in
7529 dialog units to pixel units.
7530 """
e811c8ce
RD
7531 if y is None:
7532 return win.ConvertDialogPointToPixels(point_or_x)
7533 else:
fd3f2efe 7534 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
e811c8ce
RD
7535
7536def DLG_SZE(win, size_width, height=None):
15afbcd0
RD
7537 """
7538 Convenience function for converting a Size or (w,h) in
7539 dialog units to pixel units.
7540 """
e811c8ce
RD
7541 if height is None:
7542 return win.ConvertDialogSizeToPixels(size_width)
7543 else:
fd3f2efe 7544 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
e811c8ce
RD
7545
7546
7547def FindWindowById(*args, **kwargs):
15afbcd0
RD
7548 """
7549 FindWindowById(long id, Window parent=None) -> Window
7550
7551 Find the first window in the application with the given id. If parent
7552 is None, the search will start from all top-level frames and dialog
7553 boxes; if non-None, the search will be limited to the given window
7554 hierarchy. The search is recursive in both cases.
7555 """
54f9ee45 7556 return _core_.FindWindowById(*args, **kwargs)
e811c8ce
RD
7557
7558def FindWindowByName(*args, **kwargs):
15afbcd0
RD
7559 """
7560 FindWindowByName(String name, Window parent=None) -> Window
7561
7562 Find a window by its name (as given in a window constructor or Create
7563 function call). If parent is None, the search will start from all
7564 top-level frames and dialog boxes; if non-None, the search will be
7565 limited to the given window hierarchy. The search is recursive in both
7566 cases.
7567
7568 If no window with such name is found, wx.FindWindowByLabel is called.
7569 """
54f9ee45 7570 return _core_.FindWindowByName(*args, **kwargs)
e811c8ce
RD
7571
7572def FindWindowByLabel(*args, **kwargs):
15afbcd0
RD
7573 """
7574 FindWindowByLabel(String label, Window parent=None) -> Window
7575
7576 Find a window by its label. Depending on the type of window, the label
7577 may be a window title or panel item label. If parent is None, the
7578 search will start from all top-level frames and dialog boxes; if
7579 non-None, the search will be limited to the given window
7580 hierarchy. The search is recursive in both cases.
7581 """
54f9ee45 7582 return _core_.FindWindowByLabel(*args, **kwargs)
e811c8ce
RD
7583
7584def Window_FromHWND(*args, **kwargs):
4276dc52 7585 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
54f9ee45 7586 return _core_.Window_FromHWND(*args, **kwargs)
e811c8ce
RD
7587#---------------------------------------------------------------------------
7588
7589class Validator(EvtHandler):
e811c8ce
RD
7590 def __repr__(self):
7591 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7592 def __init__(self, *args, **kwargs):
a95a7133 7593 """__init__(self) -> Validator"""
54f9ee45 7594 newobj = _core_.new_Validator(*args, **kwargs)
d14a1e28
RD
7595 self.this = newobj.this
7596 self.thisown = 1
7597 del newobj.thisown
7598 self._setOORInfo(self)
e811c8ce
RD
7599
7600 def Clone(*args, **kwargs):
a95a7133 7601 """Clone(self) -> Validator"""
54f9ee45 7602 return _core_.Validator_Clone(*args, **kwargs)
e811c8ce
RD
7603
7604 def Validate(*args, **kwargs):
a95a7133 7605 """Validate(self, Window parent) -> bool"""
54f9ee45 7606 return _core_.Validator_Validate(*args, **kwargs)
e811c8ce
RD
7607
7608 def TransferToWindow(*args, **kwargs):
a95a7133 7609 """TransferToWindow(self) -> bool"""
54f9ee45 7610 return _core_.Validator_TransferToWindow(*args, **kwargs)
e811c8ce
RD
7611
7612 def TransferFromWindow(*args, **kwargs):
a95a7133 7613 """TransferFromWindow(self) -> bool"""
54f9ee45 7614 return _core_.Validator_TransferFromWindow(*args, **kwargs)
e811c8ce
RD
7615
7616 def GetWindow(*args, **kwargs):
a95a7133 7617 """GetWindow(self) -> Window"""
54f9ee45 7618 return _core_.Validator_GetWindow(*args, **kwargs)
e811c8ce
RD
7619
7620 def SetWindow(*args, **kwargs):
a95a7133 7621 """SetWindow(self, Window window)"""
54f9ee45 7622 return _core_.Validator_SetWindow(*args, **kwargs)
e811c8ce
RD
7623
7624 def IsSilent(*args, **kwargs):
66c033b4 7625 """IsSilent() -> bool"""
54f9ee45 7626 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7627
7628 IsSilent = staticmethod(IsSilent)
7629 def SetBellOnError(*args, **kwargs):
66c033b4 7630 """SetBellOnError(int doIt=True)"""
54f9ee45 7631 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7632
7633 SetBellOnError = staticmethod(SetBellOnError)
7634
7635class ValidatorPtr(Validator):
7636 def __init__(self, this):
7637 self.this = this
7638 if not hasattr(self,"thisown"): self.thisown = 0
7639 self.__class__ = Validator
54f9ee45 7640_core_.Validator_swigregister(ValidatorPtr)
e811c8ce
RD
7641
7642def Validator_IsSilent(*args, **kwargs):
7643 """Validator_IsSilent() -> bool"""
54f9ee45 7644 return _core_.Validator_IsSilent(*args, **kwargs)
e811c8ce
RD
7645
7646def Validator_SetBellOnError(*args, **kwargs):
7647 """Validator_SetBellOnError(int doIt=True)"""
54f9ee45 7648 return _core_.Validator_SetBellOnError(*args, **kwargs)
e811c8ce
RD
7649
7650class PyValidator(Validator):
e811c8ce
RD
7651 def __repr__(self):
7652 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7653 def __init__(self, *args, **kwargs):
a95a7133 7654 """__init__(self) -> PyValidator"""
54f9ee45 7655 newobj = _core_.new_PyValidator(*args, **kwargs)
e811c8ce
RD
7656 self.this = newobj.this
7657 self.thisown = 1
7658 del newobj.thisown
7659
7660 self._setCallbackInfo(self, PyValidator, 1)
7661 self._setOORInfo(self)
7662
7663 def _setCallbackInfo(*args, **kwargs):
a95a7133 7664 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
54f9ee45 7665 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
7666
7667
7668class PyValidatorPtr(PyValidator):
7669 def __init__(self, this):
7670 self.this = this
7671 if not hasattr(self,"thisown"): self.thisown = 0
7672 self.__class__ = PyValidator
54f9ee45 7673_core_.PyValidator_swigregister(PyValidatorPtr)
e811c8ce
RD
7674
7675#---------------------------------------------------------------------------
7676
7677class Menu(EvtHandler):
d14a1e28
RD
7678 def __repr__(self):
7679 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 7680 def __init__(self, *args, **kwargs):
a95a7133 7681 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
54f9ee45 7682 newobj = _core_.new_Menu(*args, **kwargs)
e811c8ce
RD
7683 self.this = newobj.this
7684 self.thisown = 1
7685 del newobj.thisown
7686 self._setOORInfo(self)
7687
7688 def Append(*args, **kwargs):
a95a7133 7689 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7690 return _core_.Menu_Append(*args, **kwargs)
e811c8ce
RD
7691
7692 def AppendSeparator(*args, **kwargs):
a95a7133 7693 """AppendSeparator(self) -> MenuItem"""
54f9ee45 7694 return _core_.Menu_AppendSeparator(*args, **kwargs)
e811c8ce
RD
7695
7696 def AppendCheckItem(*args, **kwargs):
a95a7133 7697 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7698 return _core_.Menu_AppendCheckItem(*args, **kwargs)
e811c8ce
RD
7699
7700 def AppendRadioItem(*args, **kwargs):
a95a7133 7701 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7702 return _core_.Menu_AppendRadioItem(*args, **kwargs)
e811c8ce
RD
7703
7704 def AppendMenu(*args, **kwargs):
a95a7133 7705 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7706 return _core_.Menu_AppendMenu(*args, **kwargs)
e811c8ce
RD
7707
7708 def AppendItem(*args, **kwargs):
a95a7133 7709 """AppendItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7710 return _core_.Menu_AppendItem(*args, **kwargs)
e811c8ce
RD
7711
7712 def Break(*args, **kwargs):
a95a7133 7713 """Break(self)"""
54f9ee45 7714 return _core_.Menu_Break(*args, **kwargs)
e811c8ce
RD
7715
7716 def InsertItem(*args, **kwargs):
a95a7133 7717 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
54f9ee45 7718 return _core_.Menu_InsertItem(*args, **kwargs)
e811c8ce
RD
7719
7720 def Insert(*args, **kwargs):
0df68c9f 7721 """
a95a7133 7722 Insert(self, size_t pos, int id, String text, String help=EmptyString,
a41e16b6 7723 int kind=ITEM_NORMAL) -> MenuItem
0df68c9f 7724 """
54f9ee45 7725 return _core_.Menu_Insert(*args, **kwargs)
e811c8ce
RD
7726
7727 def InsertSeparator(*args, **kwargs):
a95a7133 7728 """InsertSeparator(self, size_t pos) -> MenuItem"""
54f9ee45 7729 return _core_.Menu_InsertSeparator(*args, **kwargs)
e811c8ce
RD
7730
7731 def InsertCheckItem(*args, **kwargs):
a95a7133 7732 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7733 return _core_.Menu_InsertCheckItem(*args, **kwargs)
e811c8ce
RD
7734
7735 def InsertRadioItem(*args, **kwargs):
a95a7133 7736 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7737 return _core_.Menu_InsertRadioItem(*args, **kwargs)
e811c8ce
RD
7738
7739 def InsertMenu(*args, **kwargs):
a95a7133 7740 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7741 return _core_.Menu_InsertMenu(*args, **kwargs)
e811c8ce
RD
7742
7743 def PrependItem(*args, **kwargs):
a95a7133 7744 """PrependItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7745 return _core_.Menu_PrependItem(*args, **kwargs)
e811c8ce
RD
7746
7747 def Prepend(*args, **kwargs):
a95a7133 7748 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
54f9ee45 7749 return _core_.Menu_Prepend(*args, **kwargs)
e811c8ce
RD
7750
7751 def PrependSeparator(*args, **kwargs):
a95a7133 7752 """PrependSeparator(self) -> MenuItem"""
54f9ee45 7753 return _core_.Menu_PrependSeparator(*args, **kwargs)
e811c8ce
RD
7754
7755 def PrependCheckItem(*args, **kwargs):
a95a7133 7756 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7757 return _core_.Menu_PrependCheckItem(*args, **kwargs)
e811c8ce
RD
7758
7759 def PrependRadioItem(*args, **kwargs):
a95a7133 7760 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
54f9ee45 7761 return _core_.Menu_PrependRadioItem(*args, **kwargs)
e811c8ce
RD
7762
7763 def PrependMenu(*args, **kwargs):
a95a7133 7764 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
54f9ee45 7765 return _core_.Menu_PrependMenu(*args, **kwargs)
e811c8ce
RD
7766
7767 def Remove(*args, **kwargs):
a95a7133 7768 """Remove(self, int id) -> MenuItem"""
54f9ee45 7769 return _core_.Menu_Remove(*args, **kwargs)
e811c8ce
RD
7770
7771 def RemoveItem(*args, **kwargs):
a95a7133 7772 """RemoveItem(self, MenuItem item) -> MenuItem"""
54f9ee45 7773 return _core_.Menu_RemoveItem(*args, **kwargs)
e811c8ce
RD
7774
7775 def Delete(*args, **kwargs):
a95a7133 7776 """Delete(self, int id) -> bool"""
54f9ee45 7777 return _core_.Menu_Delete(*args, **kwargs)
e811c8ce
RD
7778
7779 def DeleteItem(*args, **kwargs):
a95a7133 7780 """DeleteItem(self, MenuItem item) -> bool"""
54f9ee45 7781 return _core_.Menu_DeleteItem(*args, **kwargs)
e811c8ce
RD
7782
7783 def Destroy(*args, **kwargs):
0df68c9f 7784 """
a95a7133 7785 Destroy(self)
e811c8ce 7786
0df68c9f
RD
7787 Deletes the C++ object this Python object is a proxy for.
7788 """
54f9ee45 7789 return _core_.Menu_Destroy(*args, **kwargs)
e811c8ce
RD
7790
7791 def DestroyId(*args, **kwargs):
0df68c9f 7792 """
a95a7133 7793 DestroyId(self, int id) -> bool
e811c8ce 7794
0df68c9f
RD
7795 Deletes the C++ object this Python object is a proxy for.
7796 """
54f9ee45 7797 return _core_.Menu_DestroyId(*args, **kwargs)
e811c8ce
RD
7798
7799 def DestroyItem(*args, **kwargs):
0df68c9f 7800 """
a95a7133 7801 DestroyItem(self, MenuItem item) -> bool
e811c8ce 7802
0df68c9f
RD
7803 Deletes the C++ object this Python object is a proxy for.
7804 """
54f9ee45 7805 return _core_.Menu_DestroyItem(*args, **kwargs)
e811c8ce
RD
7806
7807 def GetMenuItemCount(*args, **kwargs):
a95a7133 7808 """GetMenuItemCount(self) -> size_t"""
54f9ee45 7809 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
e811c8ce
RD
7810
7811 def GetMenuItems(*args, **kwargs):
a95a7133 7812 """GetMenuItems(self) -> PyObject"""
54f9ee45 7813 return _core_.Menu_GetMenuItems(*args, **kwargs)
e811c8ce
RD
7814
7815 def FindItem(*args, **kwargs):
a95a7133 7816 """FindItem(self, String item) -> int"""
54f9ee45 7817 return _core_.Menu_FindItem(*args, **kwargs)
e811c8ce
RD
7818
7819 def FindItemById(*args, **kwargs):
a95a7133 7820 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7821 return _core_.Menu_FindItemById(*args, **kwargs)
e811c8ce
RD
7822
7823 def FindItemByPosition(*args, **kwargs):
a95a7133 7824 """FindItemByPosition(self, size_t position) -> MenuItem"""
54f9ee45 7825 return _core_.Menu_FindItemByPosition(*args, **kwargs)
e811c8ce
RD
7826
7827 def Enable(*args, **kwargs):
a95a7133 7828 """Enable(self, int id, bool enable)"""
54f9ee45 7829 return _core_.Menu_Enable(*args, **kwargs)
e811c8ce
RD
7830
7831 def IsEnabled(*args, **kwargs):
a95a7133 7832 """IsEnabled(self, int id) -> bool"""
54f9ee45 7833 return _core_.Menu_IsEnabled(*args, **kwargs)
e811c8ce
RD
7834
7835 def Check(*args, **kwargs):
a95a7133 7836 """Check(self, int id, bool check)"""
54f9ee45 7837 return _core_.Menu_Check(*args, **kwargs)
e811c8ce
RD
7838
7839 def IsChecked(*args, **kwargs):
a95a7133 7840 """IsChecked(self, int id) -> bool"""
54f9ee45 7841 return _core_.Menu_IsChecked(*args, **kwargs)
e811c8ce
RD
7842
7843 def SetLabel(*args, **kwargs):
a95a7133 7844 """SetLabel(self, int id, String label)"""
54f9ee45 7845 return _core_.Menu_SetLabel(*args, **kwargs)
e811c8ce
RD
7846
7847 def GetLabel(*args, **kwargs):
a95a7133 7848 """GetLabel(self, int id) -> String"""
54f9ee45 7849 return _core_.Menu_GetLabel(*args, **kwargs)
e811c8ce
RD
7850
7851 def SetHelpString(*args, **kwargs):
a95a7133 7852 """SetHelpString(self, int id, String helpString)"""
54f9ee45 7853 return _core_.Menu_SetHelpString(*args, **kwargs)
e811c8ce
RD
7854
7855 def GetHelpString(*args, **kwargs):
a95a7133 7856 """GetHelpString(self, int id) -> String"""
54f9ee45 7857 return _core_.Menu_GetHelpString(*args, **kwargs)
e811c8ce
RD
7858
7859 def SetTitle(*args, **kwargs):
a95a7133 7860 """SetTitle(self, String title)"""
54f9ee45 7861 return _core_.Menu_SetTitle(*args, **kwargs)
e811c8ce
RD
7862
7863 def GetTitle(*args, **kwargs):
a95a7133 7864 """GetTitle(self) -> String"""
54f9ee45 7865 return _core_.Menu_GetTitle(*args, **kwargs)
e811c8ce
RD
7866
7867 def SetEventHandler(*args, **kwargs):
a95a7133 7868 """SetEventHandler(self, EvtHandler handler)"""
54f9ee45 7869 return _core_.Menu_SetEventHandler(*args, **kwargs)
e811c8ce
RD
7870
7871 def GetEventHandler(*args, **kwargs):
a95a7133 7872 """GetEventHandler(self) -> EvtHandler"""
54f9ee45 7873 return _core_.Menu_GetEventHandler(*args, **kwargs)
e811c8ce
RD
7874
7875 def SetInvokingWindow(*args, **kwargs):
a95a7133 7876 """SetInvokingWindow(self, Window win)"""
54f9ee45 7877 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7878
7879 def GetInvokingWindow(*args, **kwargs):
a95a7133 7880 """GetInvokingWindow(self) -> Window"""
54f9ee45 7881 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
e811c8ce
RD
7882
7883 def GetStyle(*args, **kwargs):
a95a7133 7884 """GetStyle(self) -> long"""
54f9ee45 7885 return _core_.Menu_GetStyle(*args, **kwargs)
e811c8ce
RD
7886
7887 def UpdateUI(*args, **kwargs):
a95a7133 7888 """UpdateUI(self, EvtHandler source=None)"""
54f9ee45 7889 return _core_.Menu_UpdateUI(*args, **kwargs)
e811c8ce
RD
7890
7891 def GetMenuBar(*args, **kwargs):
a95a7133 7892 """GetMenuBar(self) -> MenuBar"""
54f9ee45 7893 return _core_.Menu_GetMenuBar(*args, **kwargs)
e811c8ce
RD
7894
7895 def Attach(*args, **kwargs):
a95a7133 7896 """Attach(self, wxMenuBarBase menubar)"""
54f9ee45 7897 return _core_.Menu_Attach(*args, **kwargs)
e811c8ce
RD
7898
7899 def Detach(*args, **kwargs):
a95a7133 7900 """Detach(self)"""
54f9ee45 7901 return _core_.Menu_Detach(*args, **kwargs)
e811c8ce
RD
7902
7903 def IsAttached(*args, **kwargs):
a95a7133 7904 """IsAttached(self) -> bool"""
54f9ee45 7905 return _core_.Menu_IsAttached(*args, **kwargs)
e811c8ce
RD
7906
7907 def SetParent(*args, **kwargs):
a95a7133 7908 """SetParent(self, Menu parent)"""
54f9ee45 7909 return _core_.Menu_SetParent(*args, **kwargs)
e811c8ce
RD
7910
7911 def GetParent(*args, **kwargs):
a95a7133 7912 """GetParent(self) -> Menu"""
54f9ee45 7913 return _core_.Menu_GetParent(*args, **kwargs)
e811c8ce 7914
d14a1e28
RD
7915
7916class MenuPtr(Menu):
7917 def __init__(self, this):
7918 self.this = this
7919 if not hasattr(self,"thisown"): self.thisown = 0
7920 self.__class__ = Menu
54f9ee45 7921_core_.Menu_swigregister(MenuPtr)
d14a1e28
RD
7922DefaultValidator = cvar.DefaultValidator
7923
7924#---------------------------------------------------------------------------
7925
7926class MenuBar(Window):
e811c8ce
RD
7927 def __repr__(self):
7928 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 7929 def __init__(self, *args, **kwargs):
a95a7133 7930 """__init__(self, long style=0) -> MenuBar"""
54f9ee45 7931 newobj = _core_.new_MenuBar(*args, **kwargs)
d14a1e28
RD
7932 self.this = newobj.this
7933 self.thisown = 1
7934 del newobj.thisown
7935 self._setOORInfo(self)
e811c8ce
RD
7936
7937 def Append(*args, **kwargs):
a95a7133 7938 """Append(self, Menu menu, String title) -> bool"""
54f9ee45 7939 return _core_.MenuBar_Append(*args, **kwargs)
e811c8ce
RD
7940
7941 def Insert(*args, **kwargs):
a95a7133 7942 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
54f9ee45 7943 return _core_.MenuBar_Insert(*args, **kwargs)
e811c8ce
RD
7944
7945 def GetMenuCount(*args, **kwargs):
a95a7133 7946 """GetMenuCount(self) -> size_t"""
54f9ee45 7947 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
e811c8ce
RD
7948
7949 def GetMenu(*args, **kwargs):
a95a7133 7950 """GetMenu(self, size_t pos) -> Menu"""
54f9ee45 7951 return _core_.MenuBar_GetMenu(*args, **kwargs)
e811c8ce
RD
7952
7953 def Replace(*args, **kwargs):
a95a7133 7954 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
54f9ee45 7955 return _core_.MenuBar_Replace(*args, **kwargs)
e811c8ce
RD
7956
7957 def Remove(*args, **kwargs):
a95a7133 7958 """Remove(self, size_t pos) -> Menu"""
54f9ee45 7959 return _core_.MenuBar_Remove(*args, **kwargs)
e811c8ce
RD
7960
7961 def EnableTop(*args, **kwargs):
a95a7133 7962 """EnableTop(self, size_t pos, bool enable)"""
54f9ee45 7963 return _core_.MenuBar_EnableTop(*args, **kwargs)
e811c8ce
RD
7964
7965 def IsEnabledTop(*args, **kwargs):
a95a7133 7966 """IsEnabledTop(self, size_t pos) -> bool"""
54f9ee45 7967 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
e811c8ce
RD
7968
7969 def SetLabelTop(*args, **kwargs):
a95a7133 7970 """SetLabelTop(self, size_t pos, String label)"""
54f9ee45 7971 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
e811c8ce
RD
7972
7973 def GetLabelTop(*args, **kwargs):
a95a7133 7974 """GetLabelTop(self, size_t pos) -> String"""
54f9ee45 7975 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
e811c8ce
RD
7976
7977 def FindMenuItem(*args, **kwargs):
a95a7133 7978 """FindMenuItem(self, String menu, String item) -> int"""
54f9ee45 7979 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
e811c8ce
RD
7980
7981 def FindItemById(*args, **kwargs):
a95a7133 7982 """FindItemById(self, int id) -> MenuItem"""
54f9ee45 7983 return _core_.MenuBar_FindItemById(*args, **kwargs)
e811c8ce
RD
7984
7985 def FindMenu(*args, **kwargs):
a95a7133 7986 """FindMenu(self, String title) -> int"""
54f9ee45 7987 return _core_.MenuBar_FindMenu(*args, **kwargs)
e811c8ce
RD
7988
7989 def Enable(*args, **kwargs):
a95a7133 7990 """Enable(self, int id, bool enable)"""
54f9ee45 7991 return _core_.MenuBar_Enable(*args, **kwargs)
e811c8ce
RD
7992
7993 def Check(*args, **kwargs):
a95a7133 7994 """Check(self, int id, bool check)"""
54f9ee45 7995 return _core_.MenuBar_Check(*args, **kwargs)
e811c8ce
RD
7996
7997 def IsChecked(*args, **kwargs):
a95a7133 7998 """IsChecked(self, int id) -> bool"""
54f9ee45 7999 return _core_.MenuBar_IsChecked(*args, **kwargs)
e811c8ce
RD
8000
8001 def IsEnabled(*args, **kwargs):
a95a7133 8002 """IsEnabled(self, int id) -> bool"""
54f9ee45 8003 return _core_.MenuBar_IsEnabled(*args, **kwargs)
e811c8ce
RD
8004
8005 def SetLabel(*args, **kwargs):
a95a7133 8006 """SetLabel(self, int id, String label)"""
54f9ee45 8007 return _core_.MenuBar_SetLabel(*args, **kwargs)
e811c8ce
RD
8008
8009 def GetLabel(*args, **kwargs):
a95a7133 8010 """GetLabel(self, int id) -> String"""
54f9ee45 8011 return _core_.MenuBar_GetLabel(*args, **kwargs)
e811c8ce
RD
8012
8013 def SetHelpString(*args, **kwargs):
a95a7133 8014 """SetHelpString(self, int id, String helpString)"""
54f9ee45 8015 return _core_.MenuBar_SetHelpString(*args, **kwargs)
e811c8ce
RD
8016
8017 def GetHelpString(*args, **kwargs):
a95a7133 8018 """GetHelpString(self, int id) -> String"""
54f9ee45 8019 return _core_.MenuBar_GetHelpString(*args, **kwargs)
e811c8ce
RD
8020
8021 def GetFrame(*args, **kwargs):
a95a7133 8022 """GetFrame(self) -> wxFrame"""
54f9ee45 8023 return _core_.MenuBar_GetFrame(*args, **kwargs)
e811c8ce
RD
8024
8025 def IsAttached(*args, **kwargs):
a95a7133 8026 """IsAttached(self) -> bool"""
54f9ee45 8027 return _core_.MenuBar_IsAttached(*args, **kwargs)
e811c8ce
RD
8028
8029 def Attach(*args, **kwargs):
a95a7133 8030 """Attach(self, wxFrame frame)"""
54f9ee45 8031 return _core_.MenuBar_Attach(*args, **kwargs)
e811c8ce
RD
8032
8033 def Detach(*args, **kwargs):
a95a7133 8034 """Detach(self)"""
54f9ee45 8035 return _core_.MenuBar_Detach(*args, **kwargs)
e811c8ce 8036
d14a1e28
RD
8037
8038class MenuBarPtr(MenuBar):
8039 def __init__(self, this):
8040 self.this = this
8041 if not hasattr(self,"thisown"): self.thisown = 0
8042 self.__class__ = MenuBar
54f9ee45 8043_core_.MenuBar_swigregister(MenuBarPtr)
d14a1e28
RD
8044
8045#---------------------------------------------------------------------------
8046
8047class MenuItem(Object):
e811c8ce
RD
8048 def __repr__(self):
8049 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8050 def __init__(self, *args, **kwargs):
0df68c9f 8051 """
a95a7133 8052 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
196addbf
RD
8053 String help=EmptyString, int kind=ITEM_NORMAL,
8054 Menu subMenu=None) -> MenuItem
0df68c9f 8055 """
54f9ee45 8056 newobj = _core_.new_MenuItem(*args, **kwargs)
d14a1e28
RD
8057 self.this = newobj.this
8058 self.thisown = 1
8059 del newobj.thisown
e811c8ce 8060 def GetMenu(*args, **kwargs):
a95a7133 8061 """GetMenu(self) -> Menu"""
54f9ee45 8062 return _core_.MenuItem_GetMenu(*args, **kwargs)
e811c8ce
RD
8063
8064 def SetMenu(*args, **kwargs):
a95a7133 8065 """SetMenu(self, Menu menu)"""
54f9ee45 8066 return _core_.MenuItem_SetMenu(*args, **kwargs)
e811c8ce
RD
8067
8068 def SetId(*args, **kwargs):
a95a7133 8069 """SetId(self, int id)"""
54f9ee45 8070 return _core_.MenuItem_SetId(*args, **kwargs)
e811c8ce
RD
8071
8072 def GetId(*args, **kwargs):
a95a7133 8073 """GetId(self) -> int"""
54f9ee45 8074 return _core_.MenuItem_GetId(*args, **kwargs)
e811c8ce
RD
8075
8076 def IsSeparator(*args, **kwargs):
a95a7133 8077 """IsSeparator(self) -> bool"""
54f9ee45 8078 return _core_.MenuItem_IsSeparator(*args, **kwargs)
e811c8ce
RD
8079
8080 def SetText(*args, **kwargs):
a95a7133 8081 """SetText(self, String str)"""
54f9ee45 8082 return _core_.MenuItem_SetText(*args, **kwargs)
e811c8ce
RD
8083
8084 def GetLabel(*args, **kwargs):
a95a7133 8085 """GetLabel(self) -> String"""
54f9ee45 8086 return _core_.MenuItem_GetLabel(*args, **kwargs)
e811c8ce
RD
8087
8088 def GetText(*args, **kwargs):
a95a7133 8089 """GetText(self) -> String"""
54f9ee45 8090 return _core_.MenuItem_GetText(*args, **kwargs)
e811c8ce
RD
8091
8092 def GetLabelFromText(*args, **kwargs):
66c033b4 8093 """GetLabelFromText(String text) -> String"""
54f9ee45 8094 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
e811c8ce
RD
8095
8096 GetLabelFromText = staticmethod(GetLabelFromText)
8097 def GetKind(*args, **kwargs):
a95a7133 8098 """GetKind(self) -> int"""
54f9ee45 8099 return _core_.MenuItem_GetKind(*args, **kwargs)
e811c8ce 8100
a95a7133
RD
8101 def SetKind(*args, **kwargs):
8102 """SetKind(self, int kind)"""
54f9ee45 8103 return _core_.MenuItem_SetKind(*args, **kwargs)
a95a7133 8104
e811c8ce 8105 def SetCheckable(*args, **kwargs):
a95a7133 8106 """SetCheckable(self, bool checkable)"""
54f9ee45 8107 return _core_.MenuItem_SetCheckable(*args, **kwargs)
e811c8ce
RD
8108
8109 def IsCheckable(*args, **kwargs):
a95a7133 8110 """IsCheckable(self) -> bool"""
54f9ee45 8111 return _core_.MenuItem_IsCheckable(*args, **kwargs)
e811c8ce
RD
8112
8113 def IsSubMenu(*args, **kwargs):
a95a7133 8114 """IsSubMenu(self) -> bool"""
54f9ee45 8115 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
e811c8ce
RD
8116
8117 def SetSubMenu(*args, **kwargs):
a95a7133 8118 """SetSubMenu(self, Menu menu)"""
54f9ee45 8119 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
e811c8ce
RD
8120
8121 def GetSubMenu(*args, **kwargs):
a95a7133 8122 """GetSubMenu(self) -> Menu"""
54f9ee45 8123 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
e811c8ce
RD
8124
8125 def Enable(*args, **kwargs):
a95a7133 8126 """Enable(self, bool enable=True)"""
54f9ee45 8127 return _core_.MenuItem_Enable(*args, **kwargs)
e811c8ce
RD
8128
8129 def IsEnabled(*args, **kwargs):
a95a7133 8130 """IsEnabled(self) -> bool"""
54f9ee45 8131 return _core_.MenuItem_IsEnabled(*args, **kwargs)
e811c8ce
RD
8132
8133 def Check(*args, **kwargs):
a95a7133 8134 """Check(self, bool check=True)"""
54f9ee45 8135 return _core_.MenuItem_Check(*args, **kwargs)
e811c8ce
RD
8136
8137 def IsChecked(*args, **kwargs):
a95a7133 8138 """IsChecked(self) -> bool"""
54f9ee45 8139 return _core_.MenuItem_IsChecked(*args, **kwargs)
e811c8ce
RD
8140
8141 def Toggle(*args, **kwargs):
a95a7133 8142 """Toggle(self)"""
54f9ee45 8143 return _core_.MenuItem_Toggle(*args, **kwargs)
e811c8ce
RD
8144
8145 def SetHelp(*args, **kwargs):
a95a7133 8146 """SetHelp(self, String str)"""
54f9ee45 8147 return _core_.MenuItem_SetHelp(*args, **kwargs)
e811c8ce
RD
8148
8149 def GetHelp(*args, **kwargs):
a95a7133 8150 """GetHelp(self) -> String"""
54f9ee45 8151 return _core_.MenuItem_GetHelp(*args, **kwargs)
e811c8ce
RD
8152
8153 def GetAccel(*args, **kwargs):
a95a7133 8154 """GetAccel(self) -> AcceleratorEntry"""
54f9ee45 8155 return _core_.MenuItem_GetAccel(*args, **kwargs)
e811c8ce
RD
8156
8157 def SetAccel(*args, **kwargs):
a95a7133 8158 """SetAccel(self, AcceleratorEntry accel)"""
54f9ee45 8159 return _core_.MenuItem_SetAccel(*args, **kwargs)
e811c8ce
RD
8160
8161 def GetDefaultMarginWidth(*args, **kwargs):
66c033b4 8162 """GetDefaultMarginWidth() -> int"""
54f9ee45 8163 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
e811c8ce
RD
8164
8165 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8166 def SetBitmap(*args, **kwargs):
a95a7133 8167 """SetBitmap(self, Bitmap bitmap)"""
54f9ee45 8168 return _core_.MenuItem_SetBitmap(*args, **kwargs)
e811c8ce
RD
8169
8170 def GetBitmap(*args, **kwargs):
a95a7133 8171 """GetBitmap(self) -> Bitmap"""
54f9ee45 8172 return _core_.MenuItem_GetBitmap(*args, **kwargs)
e811c8ce 8173
d14a1e28
RD
8174
8175class MenuItemPtr(MenuItem):
8176 def __init__(self, this):
8177 self.this = this
8178 if not hasattr(self,"thisown"): self.thisown = 0
8179 self.__class__ = MenuItem
54f9ee45 8180_core_.MenuItem_swigregister(MenuItemPtr)
d14a1e28 8181
e811c8ce 8182def MenuItem_GetLabelFromText(*args, **kwargs):
196addbf 8183 """MenuItem_GetLabelFromText(String text) -> String"""
54f9ee45 8184 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
d14a1e28 8185
e811c8ce
RD
8186def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8187 """MenuItem_GetDefaultMarginWidth() -> int"""
54f9ee45 8188 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
d14a1e28
RD
8189
8190#---------------------------------------------------------------------------
8191
8192class Control(Window):
15afbcd0
RD
8193 """
8194 This is the base class for a control or 'widget'.
8195
41e2b43e
RD
8196 A control is generally a small window which processes user input
8197 and/or displays one or more item of data.
15afbcd0 8198 """
e811c8ce
RD
8199 def __repr__(self):
8200 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8201 def __init__(self, *args, **kwargs):
0df68c9f 8202 """
248ed943
RD
8203 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8204 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8205 String name=ControlNameStr) -> Control
15afbcd0 8206
41e2b43e
RD
8207 Create a Control. Normally you should only call this from a subclass'
8208 __init__ as a plain old wx.Control is not very useful.
0df68c9f 8209 """
54f9ee45 8210 newobj = _core_.new_Control(*args, **kwargs)
d14a1e28
RD
8211 self.this = newobj.this
8212 self.thisown = 1
8213 del newobj.thisown
8214 self._setOORInfo(self)
e811c8ce
RD
8215
8216 def Create(*args, **kwargs):
0df68c9f 8217 """
248ed943
RD
8218 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8219 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
b2dc1044 8220 String name=ControlNameStr) -> bool
15afbcd0
RD
8221
8222 Do the 2nd phase and create the GUI control.
0df68c9f 8223 """
54f9ee45 8224 return _core_.Control_Create(*args, **kwargs)
e811c8ce
RD
8225
8226 def Command(*args, **kwargs):
15afbcd0 8227 """
a95a7133 8228 Command(self, CommandEvent event)
15afbcd0 8229
41e2b43e
RD
8230 Simulates the effect of the user issuing a command to the item.
8231
8232 :see: `wx.CommandEvent`
8233
15afbcd0 8234 """
54f9ee45 8235 return _core_.Control_Command(*args, **kwargs)
e811c8ce
RD
8236
8237 def GetLabel(*args, **kwargs):
15afbcd0 8238 """
a95a7133 8239 GetLabel(self) -> String
15afbcd0
RD
8240
8241 Return a control's text.
8242 """
54f9ee45 8243 return _core_.Control_GetLabel(*args, **kwargs)
e811c8ce
RD
8244
8245 def SetLabel(*args, **kwargs):
15afbcd0 8246 """
a95a7133 8247 SetLabel(self, String label)
15afbcd0
RD
8248
8249 Sets the item's text.
8250 """
54f9ee45 8251 return _core_.Control_SetLabel(*args, **kwargs)
e811c8ce 8252
74a57fcd 8253 def GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8254 """
8255 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8256
8257 Get the default attributes for this class. This is useful if you want
8258 to use the same font or colour in your own control as in a standard
8259 control -- which is a much better idea than hard coding specific
8260 colours or fonts which might look completely out of place on the
8261 user's system, especially if it uses themes.
8262
8263 The variant parameter is only relevant under Mac currently and is
8264 ignore under other platforms. Under Mac, it will change the size of
8265 the returned font. See `wx.Window.SetWindowVariant` for more about
8266 this.
8267 """
54f9ee45 8268 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd
RD
8269
8270 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
d14a1e28
RD
8271
8272class ControlPtr(Control):
8273 def __init__(self, this):
8274 self.this = this
8275 if not hasattr(self,"thisown"): self.thisown = 0
8276 self.__class__ = Control
54f9ee45 8277_core_.Control_swigregister(ControlPtr)
b2dc1044 8278ControlNameStr = cvar.ControlNameStr
d14a1e28
RD
8279
8280def PreControl(*args, **kwargs):
15afbcd0
RD
8281 """
8282 PreControl() -> Control
8283
8284 Precreate a Control control for 2-phase creation
8285 """
54f9ee45 8286 val = _core_.new_PreControl(*args, **kwargs)
d14a1e28
RD
8287 val.thisown = 1
8288 return val
8289
74a57fcd 8290def Control_GetClassDefaultAttributes(*args, **kwargs):
110da5b0
RD
8291 """
8292 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8293
8294 Get the default attributes for this class. This is useful if you want
8295 to use the same font or colour in your own control as in a standard
8296 control -- which is a much better idea than hard coding specific
8297 colours or fonts which might look completely out of place on the
8298 user's system, especially if it uses themes.
8299
8300 The variant parameter is only relevant under Mac currently and is
8301 ignore under other platforms. Under Mac, it will change the size of
8302 the returned font. See `wx.Window.SetWindowVariant` for more about
8303 this.
8304 """
54f9ee45 8305 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
74a57fcd 8306
d14a1e28
RD
8307#---------------------------------------------------------------------------
8308
8309class ItemContainer(object):
15afbcd0
RD
8310 """
8311 wx.ItemContainer defines an interface which is implemented by all
41e2b43e
RD
8312 controls which have string subitems, each of which may be selected,
8313 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8314 `wx.ComboBox` which implements an extended interface deriving from
8315 this one.
15afbcd0 8316
41e2b43e
RD
8317 It defines the methods for accessing the control's items and although
8318 each of the derived classes implements them differently, they still
8319 all conform to the same interface.
15afbcd0 8320
41e2b43e
RD
8321 The items in a wx.ItemContainer have (non empty) string labels and,
8322 optionally, client data associated with them.
15afbcd0
RD
8323
8324 """
d14a1e28
RD
8325 def __init__(self): raise RuntimeError, "No constructor defined"
8326 def __repr__(self):
8327 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 8328 def Append(*args, **kwargs):
15afbcd0 8329 """
a95a7133 8330 Append(self, String item, PyObject clientData=None) -> int
15afbcd0 8331
41e2b43e
RD
8332 Adds the item to the control, associating the given data with the item
8333 if not None. The return value is the index of the newly added item
8334 which may be different from the last one if the control is sorted (e.g.
8335 has wx.LB_SORT or wx.CB_SORT style).
15afbcd0 8336 """
54f9ee45 8337 return _core_.ItemContainer_Append(*args, **kwargs)
e811c8ce
RD
8338
8339 def AppendItems(*args, **kwargs):
15afbcd0 8340 """
a95a7133 8341 AppendItems(self, wxArrayString strings)
15afbcd0 8342
41e2b43e
RD
8343 Apend several items at once to the control. Notice that calling this
8344 method may be much faster than appending the items one by one if you
8345 need to add a lot of items.
15afbcd0 8346 """
54f9ee45 8347 return _core_.ItemContainer_AppendItems(*args, **kwargs)
e811c8ce
RD
8348
8349 def Insert(*args, **kwargs):
15afbcd0 8350 """
a95a7133 8351 Insert(self, String item, int pos, PyObject clientData=None) -> int
15afbcd0 8352
41e2b43e 8353 Insert an item into the control before the item at the ``pos`` index,
15afbcd0
RD
8354 optionally associating some data object with the item.
8355 """
54f9ee45 8356 return _core_.ItemContainer_Insert(*args, **kwargs)
e811c8ce
RD
8357
8358 def Clear(*args, **kwargs):
15afbcd0 8359 """
a95a7133 8360 Clear(self)
15afbcd0
RD
8361
8362 Removes all items from the control.
8363 """
54f9ee45 8364 return _core_.ItemContainer_Clear(*args, **kwargs)
e811c8ce
RD
8365
8366 def Delete(*args, **kwargs):
15afbcd0 8367 """
a95a7133 8368 Delete(self, int n)
15afbcd0 8369
41e2b43e
RD
8370 Deletes the item at the zero-based index 'n' from the control. Note
8371 that it is an error (signalled by a `wx.PyAssertionError` exception if
8372 enabled) to remove an item with the index negative or greater or equal
8373 than the number of items in the control.
15afbcd0 8374 """
54f9ee45 8375 return _core_.ItemContainer_Delete(*args, **kwargs)
e811c8ce
RD
8376
8377 def GetCount(*args, **kwargs):
15afbcd0 8378 """
a95a7133 8379 GetCount(self) -> int
15afbcd0
RD
8380
8381 Returns the number of items in the control.
8382 """
54f9ee45 8383 return _core_.ItemContainer_GetCount(*args, **kwargs)
e811c8ce
RD
8384
8385 def IsEmpty(*args, **kwargs):
15afbcd0 8386 """
a95a7133 8387 IsEmpty(self) -> bool
15afbcd0
RD
8388
8389 Returns True if the control is empty or False if it has some items.
8390 """
54f9ee45 8391 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
e811c8ce
RD
8392
8393 def GetString(*args, **kwargs):
15afbcd0 8394 """
a95a7133 8395 GetString(self, int n) -> String
15afbcd0
RD
8396
8397 Returns the label of the item with the given index.
8398 """
54f9ee45 8399 return _core_.ItemContainer_GetString(*args, **kwargs)
e811c8ce
RD
8400
8401 def GetStrings(*args, **kwargs):
a95a7133 8402 """GetStrings(self) -> wxArrayString"""
54f9ee45 8403 return _core_.ItemContainer_GetStrings(*args, **kwargs)
e811c8ce
RD
8404
8405 def SetString(*args, **kwargs):
15afbcd0 8406 """
a95a7133 8407 SetString(self, int n, String s)
15afbcd0
RD
8408
8409 Sets the label for the given item.
8410 """
54f9ee45 8411 return _core_.ItemContainer_SetString(*args, **kwargs)
e811c8ce
RD
8412
8413 def FindString(*args, **kwargs):
15afbcd0 8414 """
a95a7133 8415 FindString(self, String s) -> int
15afbcd0
RD
8416
8417 Finds an item whose label matches the given string. Returns the
41e2b43e
RD
8418 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8419 found.
15afbcd0 8420 """
54f9ee45 8421 return _core_.ItemContainer_FindString(*args, **kwargs)
e811c8ce
RD
8422
8423 def Select(*args, **kwargs):
15afbcd0 8424 """
a95a7133 8425 Select(self, int n)
15afbcd0
RD
8426
8427 Sets the item at index 'n' to be the selected item.
8428 """
54f9ee45 8429 return _core_.ItemContainer_Select(*args, **kwargs)
e811c8ce 8430
15afbcd0 8431 SetSelection = Select
e811c8ce 8432 def GetSelection(*args, **kwargs):
15afbcd0 8433 """
a95a7133 8434 GetSelection(self) -> int
15afbcd0 8435
41e2b43e
RD
8436 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8437 is selected.
15afbcd0 8438 """
54f9ee45 8439 return _core_.ItemContainer_GetSelection(*args, **kwargs)
e811c8ce
RD
8440
8441 def GetStringSelection(*args, **kwargs):
15afbcd0 8442 """
a95a7133 8443 GetStringSelection(self) -> String
15afbcd0 8444
41e2b43e
RD
8445 Returns the label of the selected item or an empty string if no item
8446 is selected.
15afbcd0 8447 """
54f9ee45 8448 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
e811c8ce
RD
8449
8450 def GetClientData(*args, **kwargs):
15afbcd0 8451 """
a95a7133 8452 GetClientData(self, int n) -> PyObject
15afbcd0
RD
8453
8454 Returns the client data associated with the given item, (if any.)
8455 """
54f9ee45 8456 return _core_.ItemContainer_GetClientData(*args, **kwargs)
e811c8ce
RD
8457
8458 def SetClientData(*args, **kwargs):
15afbcd0 8459 """
a95a7133 8460 SetClientData(self, int n, PyObject clientData)
15afbcd0
RD
8461
8462 Associate the given client data with the item at position n.
8463 """
54f9ee45 8464 return _core_.ItemContainer_SetClientData(*args, **kwargs)
e811c8ce 8465
d14a1e28
RD
8466
8467class ItemContainerPtr(ItemContainer):
8468 def __init__(self, this):
8469 self.this = this
8470 if not hasattr(self,"thisown"): self.thisown = 0
8471 self.__class__ = ItemContainer
54f9ee45 8472_core_.ItemContainer_swigregister(ItemContainerPtr)
d14a1e28
RD
8473
8474#---------------------------------------------------------------------------
8475
8476class ControlWithItems(Control,ItemContainer):
15afbcd0 8477 """
41e2b43e
RD
8478 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8479 wx.Control class, and is used for the base class of various controls
8480 that have items.
15afbcd0 8481 """
d14a1e28
RD
8482 def __init__(self): raise RuntimeError, "No constructor defined"
8483 def __repr__(self):
8484 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8485
8486class ControlWithItemsPtr(ControlWithItems):
8487 def __init__(self, this):
8488 self.this = this
8489 if not hasattr(self,"thisown"): self.thisown = 0
8490 self.__class__ = ControlWithItems
54f9ee45 8491_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
d14a1e28
RD
8492
8493#---------------------------------------------------------------------------
8494
8495class SizerItem(Object):
248ed943
RD
8496 """
8497 The wx.SizerItem class is used to track the position, size and other
8498 attributes of each item managed by a `wx.Sizer`. In normal usage user
8499 code should never need to deal directly with a wx.SizerItem, but
8500 custom classes derived from `wx.PySizer` will probably need to use the
8501 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8502
8503 :see: `wx.Sizer`, `wx.GBSizerItem`
8504 """
e811c8ce
RD
8505 def __repr__(self):
8506 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 8507 def __init__(self, *args, **kwargs):
248ed943
RD
8508 """
8509 __init__(self) -> SizerItem
8510
8511 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8512 size will need to be set before this item can be used in a Sizer.
8513
8514 You will probably never need to create a wx.SizerItem directly as they
8515 are created automatically when the sizer's Add, Insert or Prepend
8516 methods are called.
8517
8518 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8519 """
54f9ee45 8520 newobj = _core_.new_SizerItem(*args, **kwargs)
d14a1e28
RD
8521 self.this = newobj.this
8522 self.thisown = 1
8523 del newobj.thisown
e811c8ce 8524 def DeleteWindows(*args, **kwargs):
248ed943
RD
8525 """
8526 DeleteWindows(self)
8527
8528 Destroy the window or the windows in a subsizer, depending on the type
8529 of item.
8530 """
54f9ee45 8531 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
e811c8ce
RD
8532
8533 def DetachSizer(*args, **kwargs):
248ed943
RD
8534 """
8535 DetachSizer(self)
8536
8537 Enable deleting the SizerItem without destroying the contained sizer.
8538 """
54f9ee45 8539 return _core_.SizerItem_DetachSizer(*args, **kwargs)
e811c8ce
RD
8540
8541 def GetSize(*args, **kwargs):
248ed943
RD
8542 """
8543 GetSize(self) -> Size
8544
8545 Get the current size of the item, as set in the last Layout.
8546 """
54f9ee45 8547 return _core_.SizerItem_GetSize(*args, **kwargs)
e811c8ce
RD
8548
8549 def CalcMin(*args, **kwargs):
248ed943
RD
8550 """
8551 CalcMin(self) -> Size
8552
8553 Calculates the minimum desired size for the item, including any space
8554 needed by borders.
8555 """
54f9ee45 8556 return _core_.SizerItem_CalcMin(*args, **kwargs)
e811c8ce
RD
8557
8558 def SetDimension(*args, **kwargs):
248ed943
RD
8559 """
8560 SetDimension(self, Point pos, Size size)
8561
8562 Set the position and size of the space allocated for this item by the
8563 sizer, and adjust the position and size of the item (window or
8564 subsizer) to be within that space taking alignment and borders into
8565 account.
8566 """
54f9ee45 8567 return _core_.SizerItem_SetDimension(*args, **kwargs)
e811c8ce
RD
8568
8569 def GetMinSize(*args, **kwargs):
248ed943
RD
8570 """
8571 GetMinSize(self) -> Size
8572
8573 Get the minimum size needed for the item.
8574 """
54f9ee45 8575 return _core_.SizerItem_GetMinSize(*args, **kwargs)
e811c8ce 8576
dfbb5885
RD
8577 def GetMinSizeWithBorder(*args, **kwargs):
8578 """
8579 GetMinSizeWithBorder(self) -> Size
8580
8581 Get the minimum size needed for the item with space for the borders
8582 added, if needed.
8583 """
8584 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
8585
e811c8ce 8586 def SetInitSize(*args, **kwargs):
a95a7133 8587 """SetInitSize(self, int x, int y)"""
54f9ee45 8588 return _core_.SizerItem_SetInitSize(*args, **kwargs)
e811c8ce
RD
8589
8590 def SetRatioWH(*args, **kwargs):
248ed943
RD
8591 """
8592 SetRatioWH(self, int width, int height)
8593
8594 Set the ratio item attribute.
8595 """
54f9ee45 8596 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
e811c8ce
RD
8597
8598 def SetRatioSize(*args, **kwargs):
248ed943
RD
8599 """
8600 SetRatioSize(self, Size size)
8601
8602 Set the ratio item attribute.
8603 """
54f9ee45 8604 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
e811c8ce
RD
8605
8606 def SetRatio(*args, **kwargs):
248ed943
RD
8607 """
8608 SetRatio(self, float ratio)
8609
8610 Set the ratio item attribute.
8611 """
54f9ee45 8612 return _core_.SizerItem_SetRatio(*args, **kwargs)
e811c8ce
RD
8613
8614 def GetRatio(*args, **kwargs):
248ed943
RD
8615 """
8616 GetRatio(self) -> float
8617
8618 Set the ratio item attribute.
8619 """
54f9ee45 8620 return _core_.SizerItem_GetRatio(*args, **kwargs)
e811c8ce
RD
8621
8622 def IsWindow(*args, **kwargs):
248ed943
RD
8623 """
8624 IsWindow(self) -> bool
8625
8626 Is this sizer item a window?
8627 """
54f9ee45 8628 return _core_.SizerItem_IsWindow(*args, **kwargs)
e811c8ce
RD
8629
8630 def IsSizer(*args, **kwargs):
248ed943
RD
8631 """
8632 IsSizer(self) -> bool
8633
8634 Is this sizer item a subsizer?
8635 """
54f9ee45 8636 return _core_.SizerItem_IsSizer(*args, **kwargs)
e811c8ce
RD
8637
8638 def IsSpacer(*args, **kwargs):
248ed943
RD
8639 """
8640 IsSpacer(self) -> bool
8641
8642 Is this sizer item a spacer?
8643 """
54f9ee45 8644 return _core_.SizerItem_IsSpacer(*args, **kwargs)
e811c8ce
RD
8645
8646 def SetProportion(*args, **kwargs):
248ed943
RD
8647 """
8648 SetProportion(self, int proportion)
8649
8650 Set the proportion value for this item.
8651 """
54f9ee45 8652 return _core_.SizerItem_SetProportion(*args, **kwargs)
e811c8ce
RD
8653
8654 def GetProportion(*args, **kwargs):
248ed943
RD
8655 """
8656 GetProportion(self) -> int
8657
8658 Get the proportion value for this item.
8659 """
54f9ee45 8660 return _core_.SizerItem_GetProportion(*args, **kwargs)
e811c8ce 8661
248ed943
RD
8662 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8663 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
e811c8ce 8664 def SetFlag(*args, **kwargs):
248ed943
RD
8665 """
8666 SetFlag(self, int flag)
8667
8668 Set the flag value for this item.
8669 """
54f9ee45 8670 return _core_.SizerItem_SetFlag(*args, **kwargs)
e811c8ce
RD
8671
8672 def GetFlag(*args, **kwargs):
248ed943
RD
8673 """
8674 GetFlag(self) -> int
8675
8676 Get the flag value for this item.
8677 """
54f9ee45 8678 return _core_.SizerItem_GetFlag(*args, **kwargs)
e811c8ce
RD
8679
8680 def SetBorder(*args, **kwargs):
248ed943
RD
8681 """
8682 SetBorder(self, int border)
8683
8684 Set the border value for this item.
8685 """
54f9ee45 8686 return _core_.SizerItem_SetBorder(*args, **kwargs)
e811c8ce
RD
8687
8688 def GetBorder(*args, **kwargs):
248ed943
RD
8689 """
8690 GetBorder(self) -> int
8691
8692 Get the border value for this item.
8693 """
54f9ee45 8694 return _core_.SizerItem_GetBorder(*args, **kwargs)
e811c8ce
RD
8695
8696 def GetWindow(*args, **kwargs):
248ed943
RD
8697 """
8698 GetWindow(self) -> Window
8699
8700 Get the window (if any) that is managed by this sizer item.
8701 """
54f9ee45 8702 return _core_.SizerItem_GetWindow(*args, **kwargs)
e811c8ce
RD
8703
8704 def SetWindow(*args, **kwargs):
248ed943
RD
8705 """
8706 SetWindow(self, Window window)
8707
8708 Set the window to be managed by this sizer item.
8709 """
54f9ee45 8710 return _core_.SizerItem_SetWindow(*args, **kwargs)
e811c8ce
RD
8711
8712 def GetSizer(*args, **kwargs):
248ed943
RD
8713 """
8714 GetSizer(self) -> Sizer
8715
8716 Get the subsizer (if any) that is managed by this sizer item.
8717 """
54f9ee45 8718 return _core_.SizerItem_GetSizer(*args, **kwargs)
e811c8ce
RD
8719
8720 def SetSizer(*args, **kwargs):
248ed943
RD
8721 """
8722 SetSizer(self, Sizer sizer)
8723
8724 Set the subsizer to be managed by this sizer item.
8725 """
54f9ee45 8726 return _core_.SizerItem_SetSizer(*args, **kwargs)
e811c8ce
RD
8727
8728 def GetSpacer(*args, **kwargs):
248ed943
RD
8729 """
8730 GetSpacer(self) -> Size
8731
8732 Get the size of the spacer managed by this sizer item.
8733 """
54f9ee45 8734 return _core_.SizerItem_GetSpacer(*args, **kwargs)
e811c8ce
RD
8735
8736 def SetSpacer(*args, **kwargs):
248ed943
RD
8737 """
8738 SetSpacer(self, Size size)
8739
8740 Set the size of the spacer to be managed by this sizer item.
8741 """
54f9ee45 8742 return _core_.SizerItem_SetSpacer(*args, **kwargs)
e811c8ce
RD
8743
8744 def Show(*args, **kwargs):
248ed943
RD
8745 """
8746 Show(self, bool show)
8747
8748 Set the show item attribute, which sizers use to determine if the item
8749 is to be made part of the layout or not. If the item is tracking a
8750 window then it is shown or hidden as needed.
8751 """
54f9ee45 8752 return _core_.SizerItem_Show(*args, **kwargs)
e811c8ce
RD
8753
8754 def IsShown(*args, **kwargs):
248ed943
RD
8755 """
8756 IsShown(self) -> bool
8757
8758 Is the item to be shown in the layout?
8759 """
54f9ee45 8760 return _core_.SizerItem_IsShown(*args, **kwargs)
e811c8ce
RD
8761
8762 def GetPosition(*args, **kwargs):
248ed943
RD
8763 """
8764 GetPosition(self) -> Point
8765
8766 Returns the current position of the item, as set in the last Layout.
8767 """
54f9ee45 8768 return _core_.SizerItem_GetPosition(*args, **kwargs)
e811c8ce
RD
8769
8770 def GetUserData(*args, **kwargs):
248ed943
RD
8771 """
8772 GetUserData(self) -> PyObject
8773
8774 Returns the userData associated with this sizer item, or None if there
8775 isn't any.
8776 """
54f9ee45 8777 return _core_.SizerItem_GetUserData(*args, **kwargs)
e811c8ce 8778
d14a1e28
RD
8779
8780class SizerItemPtr(SizerItem):
8781 def __init__(self, this):
8782 self.this = this
8783 if not hasattr(self,"thisown"): self.thisown = 0
8784 self.__class__ = SizerItem
54f9ee45 8785_core_.SizerItem_swigregister(SizerItemPtr)
d14a1e28 8786
248ed943 8787def SizerItemWindow(*args, **kwargs):
0df68c9f 8788 """
248ed943
RD
8789 SizerItemWindow(Window window, int proportion, int flag, int border,
8790 PyObject userData=None) -> SizerItem
8791
8792 Constructs a `wx.SizerItem` for tracking a window.
0df68c9f 8793 """
248ed943 8794 val = _core_.new_SizerItemWindow(*args, **kwargs)
d14a1e28
RD
8795 val.thisown = 1
8796 return val
8797
248ed943 8798def SizerItemSpacer(*args, **kwargs):
0df68c9f 8799 """
248ed943
RD
8800 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
8801 PyObject userData=None) -> SizerItem
8802
8803 Constructs a `wx.SizerItem` for tracking a spacer.
0df68c9f 8804 """
248ed943 8805 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d14a1e28
RD
8806 val.thisown = 1
8807 return val
8808
8809def SizerItemSizer(*args, **kwargs):
0df68c9f
RD
8810 """
8811 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
8812 PyObject userData=None) -> SizerItem
8813
8814 Constructs a `wx.SizerItem` for tracking a subsizer
0df68c9f 8815 """
54f9ee45 8816 val = _core_.new_SizerItemSizer(*args, **kwargs)
d14a1e28
RD
8817 val.thisown = 1
8818 return val
8819
8820class Sizer(Object):
248ed943
RD
8821 """
8822 wx.Sizer is the abstract base class used for laying out subwindows in
8823 a window. You cannot use wx.Sizer directly; instead, you will have to
8824 use one of the sizer classes derived from it such as `wx.BoxSizer`,
8825 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
8826 and `wx.GridBagSizer`.
8827
8828 The concept implemented by sizers in wxWidgets is closely related to
8829 layout tools in other GUI toolkits, such as Java's AWT, the GTK
8830 toolkit or the Qt toolkit. It is based upon the idea of the individual
8831 subwindows reporting their minimal required size and their ability to
8832 get stretched if the size of the parent window has changed. This will
8833 most often mean that the programmer does not set the original size of
8834 a dialog in the beginning, rather the dialog will assigned a sizer and
8835 this sizer will be queried about the recommended size. The sizer in
8836 turn will query its children, which can be normal windows or contorls,
8837 empty space or other sizers, so that a hierarchy of sizers can be
8838 constructed. Note that wxSizer does not derive from wxWindow and thus
8839 do not interfere with tab ordering and requires very little resources
8840 compared to a real window on screen.
8841
8842 What makes sizers so well fitted for use in wxWidgets is the fact that
8843 every control reports its own minimal size and the algorithm can
8844 handle differences in font sizes or different window (dialog item)
8845 sizes on different platforms without problems. If for example the
8846 standard font as well as the overall design of Mac widgets requires
8847 more space than on Windows, then the initial size of a dialog using a
8848 sizer will automatically be bigger on Mac than on Windows.
8849 """
e811c8ce
RD
8850 def __init__(self): raise RuntimeError, "No constructor defined"
8851 def __repr__(self):
8852 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8853 def _setOORInfo(*args, **kwargs):
a95a7133 8854 """_setOORInfo(self, PyObject _self)"""
54f9ee45 8855 return _core_.Sizer__setOORInfo(*args, **kwargs)
e811c8ce
RD
8856
8857 def Add(*args, **kwargs):
0df68c9f 8858 """
248ed943 8859 Add(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8860 PyObject userData=None)
248ed943
RD
8861
8862 Appends a child item to the sizer.
0df68c9f 8863 """
54f9ee45 8864 return _core_.Sizer_Add(*args, **kwargs)
e811c8ce
RD
8865
8866 def Insert(*args, **kwargs):
0df68c9f 8867 """
248ed943
RD
8868 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
8869 PyObject userData=None)
8870
8871 Inserts a new item into the list of items managed by this sizer before
8872 the item at index *before*. See `Add` for a description of the parameters.
0df68c9f 8873 """
54f9ee45 8874 return _core_.Sizer_Insert(*args, **kwargs)
e811c8ce
RD
8875
8876 def Prepend(*args, **kwargs):
0df68c9f 8877 """
248ed943 8878 Prepend(self, item, int proportion=0, int flag=0, int border=0,
0df68c9f 8879 PyObject userData=None)
248ed943
RD
8880
8881 Adds a new item to the begining of the list of sizer items managed by
8882 this sizer. See `Add` for a description of the parameters.
0df68c9f 8883 """
54f9ee45 8884 return _core_.Sizer_Prepend(*args, **kwargs)
e811c8ce
RD
8885
8886 def Remove(*args, **kwargs):
248ed943
RD
8887 """
8888 Remove(self, item) -> bool
8889
8890 Removes an item from the sizer and destroys it. This method does not
8891 cause any layout or resizing to take place, call `Layout` to update
8892 the layout on screen after removing a child from the sizer. The
8893 *item* parameter can be either a window, a sizer, or the zero-based
8894 index of an item to remove. Returns True if the child item was found
8895 and removed.
8896 """
54f9ee45 8897 return _core_.Sizer_Remove(*args, **kwargs)
e811c8ce 8898
1c0f361b 8899 def Detach(*args, **kwargs):
248ed943
RD
8900 """
8901 Detach(self, item) -> bool
8902
8903 Detaches an item from the sizer without destroying it. This method
8904 does not cause any layout or resizing to take place, call `Layout` to
8905 do so. The *item* parameter can be either a window, a sizer, or the
8906 zero-based index of the item to be detached. Returns True if the child item
8907 was found and detached.
8908 """
1c0f361b
RD
8909 return _core_.Sizer_Detach(*args, **kwargs)
8910
e811c8ce 8911 def _SetItemMinSize(*args, **kwargs):
a95a7133 8912 """_SetItemMinSize(self, PyObject item, Size size)"""
54f9ee45 8913 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
e811c8ce 8914
248ed943
RD
8915 def SetItemMinSize(self, item, *args):
8916 """
8917 SetItemMinSize(self, item, Size size)
8918
8919 Sets the minimum size that will be allocated for an item in the sizer.
8920 The *item* parameter can be either a window, a sizer, or the
8921 zero-based index of the item. If a window or sizer is given then it
8922 will be searched for recursivly in subsizers if neccessary.
8923 """
8924 if len(args) == 2:
8925 # for backward compatibility accept separate width,height args too
8926 return self._SetItemMinSize(item, args)
8927 else:
8928 return self._SetItemMinSize(item, args[0])
8929
e811c8ce 8930 def AddItem(*args, **kwargs):
248ed943
RD
8931 """
8932 AddItem(self, SizerItem item)
8933
8934 Adds a `wx.SizerItem` to the sizer.
8935 """
54f9ee45 8936 return _core_.Sizer_AddItem(*args, **kwargs)
e811c8ce
RD
8937
8938 def InsertItem(*args, **kwargs):
248ed943
RD
8939 """
8940 InsertItem(self, int index, SizerItem item)
8941
8942 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
8943 """
54f9ee45 8944 return _core_.Sizer_InsertItem(*args, **kwargs)
e811c8ce
RD
8945
8946 def PrependItem(*args, **kwargs):
248ed943
RD
8947 """
8948 PrependItem(self, SizerItem item)
8949
8950 Prepends a `wx.SizerItem` to the sizer.
8951 """
54f9ee45 8952 return _core_.Sizer_PrependItem(*args, **kwargs)
e811c8ce 8953
248ed943 8954 def AddMany(self, items):
66c033b4
RD
8955 """
8956 AddMany is a convenience method for adding several items
8957 to a sizer at one time. Simply pass it a list of tuples,
8958 where each tuple consists of the parameters that you
8959 would normally pass to the `Add` method.
8960 """
248ed943
RD
8961 for item in items:
8962 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
8963 item = (item, )
8964 self.Add(*item)
d14a1e28 8965
74e96f3d 8966 # for backwards compatibility only, please do not use in new code
66c033b4
RD
8967 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
8968 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
8969 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
8970 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
8971 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
8972 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
8973 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
8974 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
8975 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
8976 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
8977 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
8978 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d14a1e28
RD
8979
8980
e811c8ce 8981 def SetDimension(*args, **kwargs):
248ed943
RD
8982 """
8983 SetDimension(self, int x, int y, int width, int height)
8984
8985 Call this to force the sizer to take the given dimension and thus
8986 force the items owned by the sizer to resize themselves according to
8987 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
8988 methods.
8989 """
54f9ee45 8990 return _core_.Sizer_SetDimension(*args, **kwargs)
e811c8ce
RD
8991
8992 def SetMinSize(*args, **kwargs):
248ed943
RD
8993 """
8994 SetMinSize(self, Size size)
8995
8996 Call this to give the sizer a minimal size. Normally, the sizer will
8997 calculate its minimal size based purely on how much space its children
8998 need. After calling this method `GetMinSize` will return either the
8999 minimal size as requested by its children or the minimal size set
9000 here, depending on which is bigger.
9001 """
54f9ee45 9002 return _core_.Sizer_SetMinSize(*args, **kwargs)
e811c8ce
RD
9003
9004 def GetSize(*args, **kwargs):
248ed943
RD
9005 """
9006 GetSize(self) -> Size
9007
9008 Returns the current size of the space managed by the sizer.
9009 """
54f9ee45 9010 return _core_.Sizer_GetSize(*args, **kwargs)
e811c8ce
RD
9011
9012 def GetPosition(*args, **kwargs):
248ed943
RD
9013 """
9014 GetPosition(self) -> Point
9015
9016 Returns the current position of the sizer's managed space.
9017 """
54f9ee45 9018 return _core_.Sizer_GetPosition(*args, **kwargs)
e811c8ce
RD
9019
9020 def GetMinSize(*args, **kwargs):
248ed943
RD
9021 """
9022 GetMinSize(self) -> Size
9023
9024 Returns the minimal size of the sizer. This is either the combined
9025 minimal size of all the children and their borders or the minimal size
9026 set by SetMinSize, depending on which is bigger.
9027 """
54f9ee45 9028 return _core_.Sizer_GetMinSize(*args, **kwargs)
e811c8ce 9029
d14a1e28 9030 def GetSizeTuple(self):
1c0f361b 9031 return self.GetSize().Get()
d14a1e28 9032 def GetPositionTuple(self):
1c0f361b 9033 return self.GetPosition().Get()
d14a1e28 9034 def GetMinSizeTuple(self):
1c0f361b 9035 return self.GetMinSize().Get()
d14a1e28 9036
e811c8ce 9037 def RecalcSizes(*args, **kwargs):
248ed943
RD
9038 """
9039 RecalcSizes(self)
9040
9041 Using the sizes calculated by `CalcMin` reposition and resize all the
9042 items managed by this sizer. You should not need to call this directly as
9043 it is called by `Layout`.
9044 """
54f9ee45 9045 return _core_.Sizer_RecalcSizes(*args, **kwargs)
e811c8ce
RD
9046
9047 def CalcMin(*args, **kwargs):
248ed943
RD
9048 """
9049 CalcMin(self) -> Size
9050
9051 This method is where the sizer will do the actual calculation of its
9052 children's minimal sizes. You should not need to call this directly as
9053 it is called by `Layout`.
9054 """
54f9ee45 9055 return _core_.Sizer_CalcMin(*args, **kwargs)
e811c8ce
RD
9056
9057 def Layout(*args, **kwargs):
248ed943
RD
9058 """
9059 Layout(self)
9060
9061 This method will force the recalculation and layout of the items
9062 controlled by the sizer using the current space allocated to the
9063 sizer. Normally this is called automatically from the owning window's
9064 EVT_SIZE handler, but it is also useful to call it from user code when
9065 one of the items in a sizer change size, or items are added or
9066 removed.
9067 """
54f9ee45 9068 return _core_.Sizer_Layout(*args, **kwargs)
e811c8ce
RD
9069
9070 def Fit(*args, **kwargs):
248ed943
RD
9071 """
9072 Fit(self, Window window) -> Size
9073
9074 Tell the sizer to resize the *window* to match the sizer's minimal
9075 size. This is commonly done in the constructor of the window itself in
9076 order to set its initial size to match the needs of the children as
9077 determined by the sizer. Returns the new size.
9078
9079 For a top level window this is the total window size, not the client size.
9080 """
54f9ee45 9081 return _core_.Sizer_Fit(*args, **kwargs)
e811c8ce
RD
9082
9083 def FitInside(*args, **kwargs):
248ed943
RD
9084 """
9085 FitInside(self, Window window)
9086
9087 Tell the sizer to resize the *virtual size* of the *window* to match the
9088 sizer's minimal size. This will not alter the on screen size of the
9089 window, but may cause the addition/removal/alteration of scrollbars
9090 required to view the virtual area in windows which manage it.
9091
9092 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9093
9094 """
54f9ee45 9095 return _core_.Sizer_FitInside(*args, **kwargs)
e811c8ce
RD
9096
9097 def SetSizeHints(*args, **kwargs):
248ed943
RD
9098 """
9099 SetSizeHints(self, Window window)
9100
9101 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9102 match the sizer's minimal size. This is commonly done in the
9103 constructor of the window itself if the window is resizable (as are
9104 many dialogs under Unix and frames on probably all platforms) in order
9105 to prevent the window from being sized smaller than the minimal size
9106 required by the sizer.
9107 """
54f9ee45 9108 return _core_.Sizer_SetSizeHints(*args, **kwargs)
e811c8ce
RD
9109
9110 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9111 """
9112 SetVirtualSizeHints(self, Window window)
9113
9114 Tell the sizer to set the minimal size of the window virtual area to
9115 match the sizer's minimal size. For windows with managed scrollbars
9116 this will set them appropriately.
9117
9118 :see: `wx.ScrolledWindow.SetScrollbars`
9119
9120 """
54f9ee45 9121 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
e811c8ce
RD
9122
9123 def Clear(*args, **kwargs):
248ed943
RD
9124 """
9125 Clear(self, bool deleteWindows=False)
9126
9127 Clear all items from the sizer, optionally destroying the window items
9128 as well.
9129 """
54f9ee45 9130 return _core_.Sizer_Clear(*args, **kwargs)
e811c8ce
RD
9131
9132 def DeleteWindows(*args, **kwargs):
248ed943
RD
9133 """
9134 DeleteWindows(self)
9135
9136 Destroy all windows managed by the sizer.
9137 """
54f9ee45 9138 return _core_.Sizer_DeleteWindows(*args, **kwargs)
e811c8ce
RD
9139
9140 def GetChildren(*args, **kwargs):
248ed943
RD
9141 """
9142 GetChildren(sefl) -> list
9143
9144 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9145 """
54f9ee45 9146 return _core_.Sizer_GetChildren(*args, **kwargs)
e811c8ce
RD
9147
9148 def Show(*args, **kwargs):
248ed943
RD
9149 """
9150 Show(self, item, bool show=True)
e811c8ce 9151
248ed943
RD
9152 Shows or hides an item managed by the sizer. To make a sizer item
9153 disappear or reappear, use Show followed by `Layout`. The *item*
9154 parameter can be either a window, a sizer, or the zero-based index of
9155 the item.
9156 """
9157 return _core_.Sizer_Show(*args, **kwargs)
e811c8ce
RD
9158
9159 def IsShown(*args, **kwargs):
248ed943
RD
9160 """
9161 IsShown(self, item)
9162
9163 Determines if the item is currently shown. sizer. To make a sizer
9164 item disappear or reappear, use Show followed by `Layout`. The *item*
9165 parameter can be either a window, a sizer, or the zero-based index of
9166 the item.
9167 """
54f9ee45 9168 return _core_.Sizer_IsShown(*args, **kwargs)
e811c8ce 9169
248ed943
RD
9170 def Hide(self, item):
9171 """
9172 A convenience method for Show(item, False).
9173 """
9174 self.Show(item, False)
9175
e811c8ce 9176 def ShowItems(*args, **kwargs):
248ed943
RD
9177 """
9178 ShowItems(self, bool show)
9179
9180 Recursively call `wx.Window.Show` on all sizer items.
9181 """
54f9ee45 9182 return _core_.Sizer_ShowItems(*args, **kwargs)
e811c8ce 9183
d14a1e28
RD
9184
9185class SizerPtr(Sizer):
9186 def __init__(self, this):
9187 self.this = this
9188 if not hasattr(self,"thisown"): self.thisown = 0
9189 self.__class__ = Sizer
54f9ee45 9190_core_.Sizer_swigregister(SizerPtr)
d14a1e28
RD
9191
9192class PySizer(Sizer):
248ed943
RD
9193 """
9194 wx.PySizer is a special version of `wx.Sizer` that has been
9195 instrumented to allow the C++ virtual methods to be overloaded in
9196 Python derived classes. You would derive from this class if you are
9197 wanting to implement a custom sizer in Python code. Simply implement
9198 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9199 For example::
9200
9201 class MySizer(wx.PySizer):
9202 def __init__(self):
9203 wx.PySizer.__init__(self)
9204
9205 def CalcMin(self):
9206 for item in self.GetChildren():
9207 # calculate the total minimum width and height needed
9208 # by all items in the sizer according to this sizer's
9209 # layout algorithm.
9210 ...
9211 return wx.Size(width, height)
9212
9213 def RecalcSizes(self):
9214 # find the space allotted to this sizer
9215 pos = self.GetPosition()
9216 size = self.GetSize()
9217 for item in self.GetChildren():
9218 # Recalculate (if necessary) the position and size of
9219 # each item and then call item.SetDimension to do the
9220 # actual positioning and sizing of the items within the
9221 # space alloted to this sizer.
9222 ...
9223 item.SetDimension(itemPos, itemSize)
9224
9225
9226 When `Layout` is called it first calls `CalcMin` followed by
9227 `RecalcSizes` so you can optimize a bit by saving the results of
9228 `CalcMin` and resuing them in `RecalcSizes`.
9229
9230 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9231
9232
9233 """
e811c8ce
RD
9234 def __repr__(self):
9235 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9236 def __init__(self, *args, **kwargs):
248ed943
RD
9237 """
9238 __init__(self) -> PySizer
9239
9240 Creates a wx.PySizer. Must be called from the __init__ in the derived
9241 class.
9242 """
54f9ee45 9243 newobj = _core_.new_PySizer(*args, **kwargs)
d14a1e28
RD
9244 self.this = newobj.this
9245 self.thisown = 1
9246 del newobj.thisown
9247 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
e811c8ce
RD
9248
9249 def _setCallbackInfo(*args, **kwargs):
a95a7133 9250 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
54f9ee45 9251 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
e811c8ce 9252
d14a1e28
RD
9253
9254class PySizerPtr(PySizer):
9255 def __init__(self, this):
9256 self.this = this
9257 if not hasattr(self,"thisown"): self.thisown = 0
9258 self.__class__ = PySizer
54f9ee45 9259_core_.PySizer_swigregister(PySizerPtr)
d14a1e28
RD
9260
9261#---------------------------------------------------------------------------
9262
9263class BoxSizer(Sizer):
248ed943
RD
9264 """
9265 The basic idea behind a box sizer is that windows will most often be
9266 laid out in rather simple basic geometry, typically in a row or a
9267 column or nested hierarchies of either. A wx.BoxSizer will lay out
9268 its items in a simple row or column, depending on the orientation
9269 parameter passed to the constructor.
9270 """
e811c8ce
RD
9271 def __repr__(self):
9272 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9273 def __init__(self, *args, **kwargs):
248ed943
RD
9274 """
9275 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9276
9277 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9278 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9279 sizer.
9280 """
54f9ee45 9281 newobj = _core_.new_BoxSizer(*args, **kwargs)
d14a1e28
RD
9282 self.this = newobj.this
9283 self.thisown = 1
9284 del newobj.thisown
9285 self._setOORInfo(self)
e811c8ce
RD
9286
9287 def GetOrientation(*args, **kwargs):
248ed943
RD
9288 """
9289 GetOrientation(self) -> int
9290
9291 Returns the current orientation of the sizer.
9292 """
54f9ee45 9293 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
e811c8ce
RD
9294
9295 def SetOrientation(*args, **kwargs):
248ed943
RD
9296 """
9297 SetOrientation(self, int orient)
e811c8ce 9298
248ed943
RD
9299 Resets the orientation of the sizer.
9300 """
9301 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
e811c8ce 9302
d14a1e28
RD
9303
9304class BoxSizerPtr(BoxSizer):
9305 def __init__(self, this):
9306 self.this = this
9307 if not hasattr(self,"thisown"): self.thisown = 0
9308 self.__class__ = BoxSizer
54f9ee45 9309_core_.BoxSizer_swigregister(BoxSizerPtr)
d14a1e28
RD
9310
9311#---------------------------------------------------------------------------
9312
9313class StaticBoxSizer(BoxSizer):
248ed943
RD
9314 """
9315 wx.StaticBoxSizer derives from and functions identically to the
9316 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9317 manages. Note that this static box must be created separately and
9318 passed to the sizer constructor.
9319 """
e811c8ce
RD
9320 def __repr__(self):
9321 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9322 def __init__(self, *args, **kwargs):
248ed943
RD
9323 """
9324 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9325
9326 Constructor. It takes an associated static box and the orientation
9327 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9328 ``wx.HORIZONTAL``.
9329 """
54f9ee45 9330 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
d14a1e28
RD
9331 self.this = newobj.this
9332 self.thisown = 1
9333 del newobj.thisown
9334 self._setOORInfo(self)
e811c8ce
RD
9335
9336 def GetStaticBox(*args, **kwargs):
248ed943
RD
9337 """
9338 GetStaticBox(self) -> StaticBox
e811c8ce 9339
248ed943
RD
9340 Returns the static box associated with this sizer.
9341 """
9342 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
e811c8ce 9343
d14a1e28
RD
9344
9345class StaticBoxSizerPtr(StaticBoxSizer):
9346 def __init__(self, this):
9347 self.this = this
9348 if not hasattr(self,"thisown"): self.thisown = 0
9349 self.__class__ = StaticBoxSizer
54f9ee45 9350_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
d14a1e28
RD
9351
9352#---------------------------------------------------------------------------
9353
9354class GridSizer(Sizer):
248ed943
RD
9355 """
9356 A grid sizer is a sizer which lays out its children in a
9357 two-dimensional table with all cells having the same size. In other
9358 words, the width of each cell within the grid is the width of the
9359 widest item added to the sizer and the height of each grid cell is the
9360 height of the tallest item. An optional vertical and/or horizontal
9361 gap between items can also be specified (in pixels.)
9362
9363 Items are placed in the cells of the grid in the order they are added,
9364 in row-major order. In other words, the first row is filled first,
9365 then the second, and so on until all items have been added. (If
9366 neccessary, additional rows will be added as items are added.) If you
9367 need to have greater control over the cells that items are placed in
9368 then use the `wx.GridBagSizer`.
9369
9370 """
e811c8ce
RD
9371 def __repr__(self):
9372 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9373 def __init__(self, *args, **kwargs):
248ed943
RD
9374 """
9375 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9376
9377 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9378 of columns and rows in the sizer - if either of the parameters is
9379 zero, it will be calculated to from the total number of children in
9380 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9381 define extra space between all children.
9382 """
54f9ee45 9383 newobj = _core_.new_GridSizer(*args, **kwargs)
d14a1e28
RD
9384 self.this = newobj.this
9385 self.thisown = 1
9386 del newobj.thisown
9387 self._setOORInfo(self)
e811c8ce 9388
e811c8ce 9389 def SetCols(*args, **kwargs):
248ed943
RD
9390 """
9391 SetCols(self, int cols)
9392
9393 Sets the number of columns in the sizer.
9394 """
54f9ee45 9395 return _core_.GridSizer_SetCols(*args, **kwargs)
e811c8ce
RD
9396
9397 def SetRows(*args, **kwargs):
248ed943
RD
9398 """
9399 SetRows(self, int rows)
9400
9401 Sets the number of rows in the sizer.
9402 """
54f9ee45 9403 return _core_.GridSizer_SetRows(*args, **kwargs)
e811c8ce
RD
9404
9405 def SetVGap(*args, **kwargs):
248ed943
RD
9406 """
9407 SetVGap(self, int gap)
9408
9409 Sets the vertical gap (in pixels) between the cells in the sizer.
9410 """
54f9ee45 9411 return _core_.GridSizer_SetVGap(*args, **kwargs)
e811c8ce
RD
9412
9413 def SetHGap(*args, **kwargs):
248ed943
RD
9414 """
9415 SetHGap(self, int gap)
9416
9417 Sets the horizontal gap (in pixels) between cells in the sizer
9418 """
54f9ee45 9419 return _core_.GridSizer_SetHGap(*args, **kwargs)
e811c8ce
RD
9420
9421 def GetCols(*args, **kwargs):
248ed943
RD
9422 """
9423 GetCols(self) -> int
9424
9425 Returns the number of columns in the sizer.
9426 """
54f9ee45 9427 return _core_.GridSizer_GetCols(*args, **kwargs)
e811c8ce
RD
9428
9429 def GetRows(*args, **kwargs):
248ed943
RD
9430 """
9431 GetRows(self) -> int
9432
9433 Returns the number of rows in the sizer.
9434 """
54f9ee45 9435 return _core_.GridSizer_GetRows(*args, **kwargs)
e811c8ce
RD
9436
9437 def GetVGap(*args, **kwargs):
248ed943
RD
9438 """
9439 GetVGap(self) -> int
9440
9441 Returns the vertical gap (in pixels) between the cells in the sizer.
9442 """
54f9ee45 9443 return _core_.GridSizer_GetVGap(*args, **kwargs)
e811c8ce
RD
9444
9445 def GetHGap(*args, **kwargs):
248ed943
RD
9446 """
9447 GetHGap(self) -> int
9448
9449 Returns the horizontal gap (in pixels) between cells in the sizer.
9450 """
54f9ee45 9451 return _core_.GridSizer_GetHGap(*args, **kwargs)
e811c8ce 9452
d14a1e28
RD
9453
9454class GridSizerPtr(GridSizer):
9455 def __init__(self, this):
9456 self.this = this
9457 if not hasattr(self,"thisown"): self.thisown = 0
9458 self.__class__ = GridSizer
54f9ee45 9459_core_.GridSizer_swigregister(GridSizerPtr)
d14a1e28
RD
9460
9461#---------------------------------------------------------------------------
9462
54f9ee45
RD
9463FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9464FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9465FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
d14a1e28 9466class FlexGridSizer(GridSizer):
248ed943
RD
9467 """
9468 A flex grid sizer is a sizer which lays out its children in a
9469 two-dimensional table with all table cells in one row having the same
9470 height and all cells in one column having the same width, but all
9471 rows or all columns are not necessarily the same height or width as in
9472 the `wx.GridSizer`.
9473
9474 wx.FlexGridSizer can also size items equally in one direction but
9475 unequally ("flexibly") in the other. If the sizer is only flexible
9476 in one direction (this can be changed using `SetFlexibleDirection`), it
9477 needs to be decided how the sizer should grow in the other ("non
9478 flexible") direction in order to fill the available space. The
9479 `SetNonFlexibleGrowMode` method serves this purpose.
9480
9481
9482 """
e811c8ce
RD
9483 def __repr__(self):
9484 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9485 def __init__(self, *args, **kwargs):
248ed943
RD
9486 """
9487 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9488
9489 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9490 number of columns and rows in the sizer - if either of the parameters
9491 is zero, it will be calculated to from the total number of children in
9492 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9493 define extra space between all children.
9494 """
54f9ee45 9495 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
d14a1e28
RD
9496 self.this = newobj.this
9497 self.thisown = 1
9498 del newobj.thisown
9499 self._setOORInfo(self)
e811c8ce 9500
248ed943
RD
9501 def AddGrowableRow(*args, **kwargs):
9502 """
9503 AddGrowableRow(self, size_t idx, int proportion=0)
e811c8ce 9504
248ed943
RD
9505 Specifies that row *idx* (starting from zero) should be grown if there
9506 is extra space available to the sizer.
e811c8ce 9507
248ed943
RD
9508 The *proportion* parameter has the same meaning as the stretch factor
9509 for the box sizers except that if all proportions are 0, then all
9510 columns are resized equally (instead of not being resized at all).
9511 """
54f9ee45 9512 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
e811c8ce
RD
9513
9514 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
9515 """
9516 RemoveGrowableRow(self, size_t idx)
9517
9518 Specifies that row *idx* is no longer growable.
9519 """
54f9ee45 9520 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
e811c8ce
RD
9521
9522 def AddGrowableCol(*args, **kwargs):
248ed943
RD
9523 """
9524 AddGrowableCol(self, size_t idx, int proportion=0)
9525
9526 Specifies that column *idx* (starting from zero) should be grown if
9527 there is extra space available to the sizer.
9528
9529 The *proportion* parameter has the same meaning as the stretch factor
9530 for the box sizers except that if all proportions are 0, then all
9531 columns are resized equally (instead of not being resized at all).
9532 """
54f9ee45 9533 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
e811c8ce
RD
9534
9535 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
9536 """
9537 RemoveGrowableCol(self, size_t idx)
9538
9539 Specifies that column *idx* is no longer growable.
9540 """
54f9ee45 9541 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
e811c8ce
RD
9542
9543 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
9544 """
9545 SetFlexibleDirection(self, int direction)
9546
9547 Specifies whether the sizer should flexibly resize its columns, rows,
9548 or both. Argument *direction* can be one of the following values. Any
9549 other value is ignored.
9550
9551 ============== =======================================
9552 wx.VERTICAL Rows are flexibly sized.
9553 wx.HORIZONTAL Columns are flexibly sized.
9554 wx.BOTH Both rows and columns are flexibly sized
9555 (this is the default value).
9556 ============== =======================================
9557
9558 Note that this method does not trigger relayout.
9559
9560 """
54f9ee45 9561 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9562
9563 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
9564 """
9565 GetFlexibleDirection(self) -> int
9566
9567 Returns a value that specifies whether the sizer
9568 flexibly resizes its columns, rows, or both (default).
9569
9570 :see: `SetFlexibleDirection`
9571 """
54f9ee45 9572 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
e811c8ce
RD
9573
9574 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9575 """
9576 SetNonFlexibleGrowMode(self, int mode)
9577
9578 Specifies how the sizer should grow in the non-flexible direction if
9579 there is one (so `SetFlexibleDirection` must have been called
9580 previously). Argument *mode* can be one of the following values:
9581
9582 ========================== =================================================
9583 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9584 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9585 `AddGrowableCol` and `AddGrowableRow`. In this
9586 case equal sizing applies to minimum sizes of
9587 columns or rows (this is the default value).
9588 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9589 the non flexible direction, whether they are
9590 growable or not in the flexbile direction.
9591 ========================== =================================================
9592
9593 Note that this method does not trigger relayout.
9594
9595
9596 """
54f9ee45 9597 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9598
9599 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9600 """
9601 GetNonFlexibleGrowMode(self) -> int
9602
9603 Returns the value that specifies how the sizer grows in the
9604 non-flexible direction if there is one.
9605
9606 :see: `SetNonFlexibleGrowMode`
9607 """
54f9ee45 9608 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
e811c8ce
RD
9609
9610 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
9611 """
9612 GetRowHeights(self) -> list
9613
9614 Returns a list of integers representing the heights of each of the
9615 rows in the sizer.
9616 """
54f9ee45 9617 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
e811c8ce
RD
9618
9619 def GetColWidths(*args, **kwargs):
fd2dc343
RD
9620 """
9621 GetColWidths(self) -> list
9622
9623 Returns a list of integers representing the widths of each of the
9624 columns in the sizer.
9625 """
54f9ee45 9626 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
e811c8ce 9627
d14a1e28
RD
9628
9629class FlexGridSizerPtr(FlexGridSizer):
9630 def __init__(self, this):
9631 self.this = this
9632 if not hasattr(self,"thisown"): self.thisown = 0
9633 self.__class__ = FlexGridSizer
54f9ee45 9634_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
d14a1e28
RD
9635
9636#---------------------------------------------------------------------------
9637
9638class GBPosition(object):
248ed943
RD
9639 """
9640 This class represents the position of an item in a virtual grid of
9641 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9642 typemaps that will automatically convert from a 2-element sequence of
9643 integers to a wx.GBPosition, so you can use the more pythonic
9644 representation of the position nearly transparently in Python code.
9645 """
e811c8ce
RD
9646 def __repr__(self):
9647 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9648 def __init__(self, *args, **kwargs):
248ed943
RD
9649 """
9650 __init__(self, int row=0, int col=0) -> GBPosition
9651
9652 This class represents the position of an item in a virtual grid of
9653 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9654 typemaps that will automatically convert from a 2-element sequence of
9655 integers to a wx.GBPosition, so you can use the more pythonic
9656 representation of the position nearly transparently in Python code.
9657 """
54f9ee45 9658 newobj = _core_.new_GBPosition(*args, **kwargs)
d14a1e28
RD
9659 self.this = newobj.this
9660 self.thisown = 1
9661 del newobj.thisown
e811c8ce 9662 def GetRow(*args, **kwargs):
a95a7133 9663 """GetRow(self) -> int"""
54f9ee45 9664 return _core_.GBPosition_GetRow(*args, **kwargs)
e811c8ce
RD
9665
9666 def GetCol(*args, **kwargs):
a95a7133 9667 """GetCol(self) -> int"""
54f9ee45 9668 return _core_.GBPosition_GetCol(*args, **kwargs)
e811c8ce
RD
9669
9670 def SetRow(*args, **kwargs):
a95a7133 9671 """SetRow(self, int row)"""
54f9ee45 9672 return _core_.GBPosition_SetRow(*args, **kwargs)
e811c8ce
RD
9673
9674 def SetCol(*args, **kwargs):
a95a7133 9675 """SetCol(self, int col)"""
54f9ee45 9676 return _core_.GBPosition_SetCol(*args, **kwargs)
e811c8ce
RD
9677
9678 def __eq__(*args, **kwargs):
a95a7133 9679 """__eq__(self, GBPosition other) -> bool"""
54f9ee45 9680 return _core_.GBPosition___eq__(*args, **kwargs)
e811c8ce
RD
9681
9682 def __ne__(*args, **kwargs):
a95a7133 9683 """__ne__(self, GBPosition other) -> bool"""
54f9ee45 9684 return _core_.GBPosition___ne__(*args, **kwargs)
e811c8ce
RD
9685
9686 def Set(*args, **kwargs):
a95a7133 9687 """Set(self, int row=0, int col=0)"""
54f9ee45 9688 return _core_.GBPosition_Set(*args, **kwargs)
e811c8ce
RD
9689
9690 def Get(*args, **kwargs):
a95a7133 9691 """Get(self) -> PyObject"""
54f9ee45 9692 return _core_.GBPosition_Get(*args, **kwargs)
e811c8ce 9693
41e2b43e 9694 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9695 def __str__(self): return str(self.Get())
9696 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9697 def __len__(self): return len(self.Get())
9698 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9699 def __setitem__(self, index, val):
9700 if index == 0: self.SetRow(val)
9701 elif index == 1: self.SetCol(val)
9702 else: raise IndexError
e811c8ce 9703 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9704 __safe_for_unpickling__ = True
9705 def __reduce__(self): return (wx.GBPosition, self.Get())
d14a1e28
RD
9706
9707 row = property(GetRow, SetRow)
9708 col = property(GetCol, SetCol)
9709
9710
9711class GBPositionPtr(GBPosition):
9712 def __init__(self, this):
9713 self.this = this
9714 if not hasattr(self,"thisown"): self.thisown = 0
9715 self.__class__ = GBPosition
54f9ee45 9716_core_.GBPosition_swigregister(GBPositionPtr)
d14a1e28
RD
9717
9718class GBSpan(object):
248ed943
RD
9719 """
9720 This class is used to hold the row and column spanning attributes of
9721 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9722 automatically convert from a 2-element sequence of integers to a
9723 wx.GBSpan, so you can use the more pythonic representation of the span
9724 nearly transparently in Python code.
9725
9726 """
e811c8ce
RD
9727 def __repr__(self):
9728 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9729 def __init__(self, *args, **kwargs):
248ed943
RD
9730 """
9731 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9732
9733 Construct a new wxGBSpan, optionally setting the rowspan and
9734 colspan. The default is (1,1). (Meaning that the item occupies one
9735 cell in each direction.
9736 """
54f9ee45 9737 newobj = _core_.new_GBSpan(*args, **kwargs)
d14a1e28
RD
9738 self.this = newobj.this
9739 self.thisown = 1
9740 del newobj.thisown
e811c8ce 9741 def GetRowspan(*args, **kwargs):
a95a7133 9742 """GetRowspan(self) -> int"""
54f9ee45 9743 return _core_.GBSpan_GetRowspan(*args, **kwargs)
e811c8ce
RD
9744
9745 def GetColspan(*args, **kwargs):
a95a7133 9746 """GetColspan(self) -> int"""
54f9ee45 9747 return _core_.GBSpan_GetColspan(*args, **kwargs)
e811c8ce
RD
9748
9749 def SetRowspan(*args, **kwargs):
a95a7133 9750 """SetRowspan(self, int rowspan)"""
54f9ee45 9751 return _core_.GBSpan_SetRowspan(*args, **kwargs)
e811c8ce
RD
9752
9753 def SetColspan(*args, **kwargs):
a95a7133 9754 """SetColspan(self, int colspan)"""
54f9ee45 9755 return _core_.GBSpan_SetColspan(*args, **kwargs)
e811c8ce
RD
9756
9757 def __eq__(*args, **kwargs):
a95a7133 9758 """__eq__(self, GBSpan other) -> bool"""
54f9ee45 9759 return _core_.GBSpan___eq__(*args, **kwargs)
e811c8ce
RD
9760
9761 def __ne__(*args, **kwargs):
a95a7133 9762 """__ne__(self, GBSpan other) -> bool"""
54f9ee45 9763 return _core_.GBSpan___ne__(*args, **kwargs)
e811c8ce
RD
9764
9765 def Set(*args, **kwargs):
a95a7133 9766 """Set(self, int rowspan=1, int colspan=1)"""
54f9ee45 9767 return _core_.GBSpan_Set(*args, **kwargs)
e811c8ce
RD
9768
9769 def Get(*args, **kwargs):
a95a7133 9770 """Get(self) -> PyObject"""
54f9ee45 9771 return _core_.GBSpan_Get(*args, **kwargs)
e811c8ce 9772
41e2b43e 9773 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
e811c8ce
RD
9774 def __str__(self): return str(self.Get())
9775 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
9776 def __len__(self): return len(self.Get())
9777 def __getitem__(self, index): return self.Get()[index]
d14a1e28
RD
9778 def __setitem__(self, index, val):
9779 if index == 0: self.SetRowspan(val)
9780 elif index == 1: self.SetColspan(val)
9781 else: raise IndexError
e811c8ce 9782 def __nonzero__(self): return self.Get() != (0,0)
74e96f3d
RD
9783 __safe_for_unpickling__ = True
9784 def __reduce__(self): return (wx.GBSpan, self.Get())
d14a1e28
RD
9785
9786 rowspan = property(GetRowspan, SetRowspan)
9787 colspan = property(GetColspan, SetColspan)
9788
9789
9790class GBSpanPtr(GBSpan):
9791 def __init__(self, this):
9792 self.this = this
9793 if not hasattr(self,"thisown"): self.thisown = 0
9794 self.__class__ = GBSpan
54f9ee45 9795_core_.GBSpan_swigregister(GBSpanPtr)
d14a1e28
RD
9796
9797class GBSizerItem(SizerItem):
248ed943
RD
9798 """
9799 The wx.GBSizerItem class is used to track the additional data about
9800 items in a `wx.GridBagSizer` such as the item's position in the grid
9801 and how many rows or columns it spans.
9802
9803 """
e811c8ce
RD
9804 def __repr__(self):
9805 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9806 def __init__(self, *args, **kwargs):
248ed943
RD
9807 """
9808 __init__(self) -> GBSizerItem
9809
9810 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
9811 size will need to be set, as well as a position and span before this
9812 item can be used in a Sizer.
9813
9814 You will probably never need to create a wx.GBSizerItem directly as they
9815 are created automatically when the sizer's Add method is called.
9816 """
54f9ee45 9817 newobj = _core_.new_GBSizerItem(*args, **kwargs)
d14a1e28
RD
9818 self.this = newobj.this
9819 self.thisown = 1
9820 del newobj.thisown
e811c8ce 9821 def GetPos(*args, **kwargs):
248ed943
RD
9822 """
9823 GetPos(self) -> GBPosition
9824
9825 Get the grid position of the item
9826 """
54f9ee45 9827 return _core_.GBSizerItem_GetPos(*args, **kwargs)
e811c8ce
RD
9828
9829 def GetPosTuple(self): return self.GetPos().Get()
9830 def GetSpan(*args, **kwargs):
248ed943
RD
9831 """
9832 GetSpan(self) -> GBSpan
9833
9834 Get the row and column spanning of the item
9835 """
54f9ee45 9836 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
e811c8ce
RD
9837
9838 def GetSpanTuple(self): return self.GetSpan().Get()
9839 def SetPos(*args, **kwargs):
248ed943
RD
9840 """
9841 SetPos(self, GBPosition pos) -> bool
9842
9843 If the item is already a member of a sizer then first ensure that
9844 there is no other item that would intersect with this one at the new
9845 position, then set the new position. Returns True if the change is
9846 successful and after the next Layout() the item will be moved.
9847 """
54f9ee45 9848 return _core_.GBSizerItem_SetPos(*args, **kwargs)
e811c8ce
RD
9849
9850 def SetSpan(*args, **kwargs):
248ed943
RD
9851 """
9852 SetSpan(self, GBSpan span) -> bool
9853
9854 If the item is already a member of a sizer then first ensure that
9855 there is no other item that would intersect with this one with its new
9856 spanning size, then set the new spanning. Returns True if the change
9857 is successful and after the next Layout() the item will be resized.
9858
9859 """
54f9ee45 9860 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
e811c8ce 9861
248ed943 9862 def Intersects(*args, **kwargs):
0df68c9f 9863 """
a95a7133 9864 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
9865
9866 Returns True if this item and the other item instersect.
0df68c9f 9867 """
248ed943
RD
9868 return _core_.GBSizerItem_Intersects(*args, **kwargs)
9869
9870 def IntersectsPos(*args, **kwargs):
9871 """
9872 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
9873
9874 Returns True if the given pos/span would intersect with this item.
9875 """
9876 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
e811c8ce
RD
9877
9878 def GetEndPos(*args, **kwargs):
248ed943
RD
9879 """
9880 GetEndPos(self) -> GBPosition
9881
9882 Get the row and column of the endpoint of this item.
9883 """
54f9ee45 9884 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
e811c8ce
RD
9885
9886 def GetGBSizer(*args, **kwargs):
248ed943
RD
9887 """
9888 GetGBSizer(self) -> GridBagSizer
9889
9890 Get the sizer this item is a member of.
9891 """
54f9ee45 9892 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
e811c8ce
RD
9893
9894 def SetGBSizer(*args, **kwargs):
248ed943
RD
9895 """
9896 SetGBSizer(self, GridBagSizer sizer)
9897
9898 Set the sizer this item is a member of.
9899 """
54f9ee45 9900 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
e811c8ce 9901
d14a1e28
RD
9902
9903class GBSizerItemPtr(GBSizerItem):
9904 def __init__(self, this):
9905 self.this = this
9906 if not hasattr(self,"thisown"): self.thisown = 0
9907 self.__class__ = GBSizerItem
54f9ee45 9908_core_.GBSizerItem_swigregister(GBSizerItemPtr)
d14a1e28
RD
9909DefaultSpan = cvar.DefaultSpan
9910
9911def GBSizerItemWindow(*args, **kwargs):
0df68c9f
RD
9912 """
9913 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9914 int border, PyObject userData=None) -> GBSizerItem
9915
9916 Construct a `wx.GBSizerItem` for a window.
0df68c9f 9917 """
54f9ee45 9918 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
d14a1e28
RD
9919 val.thisown = 1
9920 return val
9921
9922def GBSizerItemSizer(*args, **kwargs):
0df68c9f
RD
9923 """
9924 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
9925 int border, PyObject userData=None) -> GBSizerItem
9926
9927 Construct a `wx.GBSizerItem` for a sizer
0df68c9f 9928 """
54f9ee45 9929 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
d14a1e28
RD
9930 val.thisown = 1
9931 return val
9932
9933def GBSizerItemSpacer(*args, **kwargs):
0df68c9f
RD
9934 """
9935 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
9936 int flag, int border, PyObject userData=None) -> GBSizerItem
9937
9938 Construct a `wx.GBSizerItem` for a spacer.
0df68c9f 9939 """
54f9ee45 9940 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
d14a1e28
RD
9941 val.thisown = 1
9942 return val
9943
9944class GridBagSizer(FlexGridSizer):
248ed943
RD
9945 """
9946 A `wx.Sizer` that can lay out items in a virtual grid like a
9947 `wx.FlexGridSizer` but in this case explicit positioning of the items
9948 is allowed using `wx.GBPosition`, and items can optionally span more
9949 than one row and/or column using `wx.GBSpan`. The total size of the
9950 virtual grid is determined by the largest row and column that items are
9951 positioned at, adjusted for spanning.
9952
9953 """
e811c8ce
RD
9954 def __repr__(self):
9955 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 9956 def __init__(self, *args, **kwargs):
248ed943
RD
9957 """
9958 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
9959
9960 Constructor, with optional parameters to specify the gap between the
9961 rows and columns.
9962 """
54f9ee45 9963 newobj = _core_.new_GridBagSizer(*args, **kwargs)
d14a1e28
RD
9964 self.this = newobj.this
9965 self.thisown = 1
9966 del newobj.thisown
e811c8ce 9967 def Add(*args, **kwargs):
0df68c9f 9968 """
248ed943
RD
9969 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
9970 int border=0, userData=None)
9971
9972 Adds an item to the sizer at the grid cell *pos*, optionally spanning
9973 more than one row or column as specified with *span*. The remaining
9974 args behave similarly to `wx.Sizer.Add`.
9975
9976 Returns True if the item was successfully placed at the given cell
9977 position, False if something was already there.
9978
0df68c9f 9979 """
54f9ee45 9980 return _core_.GridBagSizer_Add(*args, **kwargs)
e811c8ce
RD
9981
9982 def AddItem(*args, **kwargs):
248ed943
RD
9983 """
9984 Add(self, GBSizerItem item) -> bool
9985
9986 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
9987 the item was successfully placed at its given cell position, False if
9988 something was already there.
9989 """
54f9ee45 9990 return _core_.GridBagSizer_AddItem(*args, **kwargs)
e811c8ce
RD
9991
9992 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
9993 """
9994 GetEmptyCellSize(self) -> Size
9995
9996 Get the size used for cells in the grid with no item.
9997 """
54f9ee45 9998 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
9999
10000 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10001 """
10002 SetEmptyCellSize(self, Size sz)
10003
10004 Set the size used for cells in the grid with no item.
10005 """
54f9ee45 10006 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
e811c8ce
RD
10007
10008 def GetItemPosition(*args):
0df68c9f 10009 """
248ed943
RD
10010 GetItemPosition(self, item) -> GBPosition
10011
10012 Get the grid position of the specified *item* where *item* is either a
10013 window or subsizer that is a member of this sizer, or a zero-based
10014 index of an item.
0df68c9f 10015 """
54f9ee45 10016 return _core_.GridBagSizer_GetItemPosition(*args)
e811c8ce
RD
10017
10018 def SetItemPosition(*args):
0df68c9f 10019 """
248ed943
RD
10020 SetItemPosition(self, item, GBPosition pos) -> bool
10021
10022 Set the grid position of the specified *item* where *item* is either a
10023 window or subsizer that is a member of this sizer, or a zero-based
10024 index of an item. Returns True on success. If the move is not
10025 allowed (because an item is already there) then False is returned.
10026
0df68c9f 10027 """
54f9ee45 10028 return _core_.GridBagSizer_SetItemPosition(*args)
e811c8ce
RD
10029
10030 def GetItemSpan(*args):
0df68c9f 10031 """
248ed943
RD
10032 GetItemSpan(self, item) -> GBSpan
10033
10034 Get the row/col spanning of the specified *item* where *item* is
10035 either a window or subsizer that is a member of this sizer, or a
10036 zero-based index of an item.
0df68c9f 10037 """
54f9ee45 10038 return _core_.GridBagSizer_GetItemSpan(*args)
e811c8ce
RD
10039
10040 def SetItemSpan(*args):
0df68c9f 10041 """
248ed943
RD
10042 SetItemSpan(self, item, GBSpan span) -> bool
10043
10044 Set the row/col spanning of the specified *item* where *item* is
10045 either a window or subsizer that is a member of this sizer, or a
10046 zero-based index of an item. Returns True on success. If the move is
10047 not allowed (because an item is already there) then False is returned.
0df68c9f 10048 """
54f9ee45 10049 return _core_.GridBagSizer_SetItemSpan(*args)
e811c8ce
RD
10050
10051 def FindItem(*args):
0df68c9f 10052 """
248ed943
RD
10053 FindItem(self, item) -> GBSizerItem
10054
10055 Find the sizer item for the given window or subsizer, returns None if
10056 not found. (non-recursive)
0df68c9f 10057 """
54f9ee45 10058 return _core_.GridBagSizer_FindItem(*args)
e811c8ce
RD
10059
10060 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10061 """
10062 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10063
10064 Return the sizer item for the given grid cell, or None if there is no
10065 item at that position. (non-recursive)
10066 """
54f9ee45 10067 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
e811c8ce
RD
10068
10069 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10070 """
10071 FindItemAtPoint(self, Point pt) -> GBSizerItem
10072
10073 Return the sizer item located at the point given in *pt*, or None if
10074 there is no item at that point. The (x,y) coordinates in pt correspond
10075 to the client coordinates of the window using the sizer for
10076 layout. (non-recursive)
10077 """
54f9ee45 10078 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
e811c8ce 10079
248ed943
RD
10080 def CheckForIntersection(*args, **kwargs):
10081 """
10082 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
e811c8ce 10083
248ed943
RD
10084 Look at all items and see if any intersect (or would overlap) the
10085 given *item*. Returns True if so, False if there would be no overlap.
10086 If an *excludeItem* is given then it will not be checked for
10087 intersection, for example it may be the item we are checking the
10088 position of.
e811c8ce 10089
248ed943
RD
10090 """
10091 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
e811c8ce 10092
248ed943 10093 def CheckForIntersectionPos(*args, **kwargs):
0df68c9f 10094 """
248ed943
RD
10095 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10096
10097 Look at all items and see if any intersect (or would overlap) the
10098 given position and span. Returns True if so, False if there would be
10099 no overlap. If an *excludeItem* is given then it will not be checked
10100 for intersection, for example it may be the item we are checking the
10101 position of.
0df68c9f 10102 """
248ed943 10103 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
e811c8ce 10104
d14a1e28
RD
10105
10106class GridBagSizerPtr(GridBagSizer):
10107 def __init__(self, this):
10108 self.this = this
10109 if not hasattr(self,"thisown"): self.thisown = 0
10110 self.__class__ = GridBagSizer
54f9ee45 10111_core_.GridBagSizer_swigregister(GridBagSizerPtr)
d14a1e28
RD
10112
10113#---------------------------------------------------------------------------
10114
54f9ee45
RD
10115Left = _core_.Left
10116Top = _core_.Top
10117Right = _core_.Right
10118Bottom = _core_.Bottom
10119Width = _core_.Width
10120Height = _core_.Height
10121Centre = _core_.Centre
10122Center = _core_.Center
10123CentreX = _core_.CentreX
10124CentreY = _core_.CentreY
10125Unconstrained = _core_.Unconstrained
10126AsIs = _core_.AsIs
10127PercentOf = _core_.PercentOf
10128Above = _core_.Above
10129Below = _core_.Below
10130LeftOf = _core_.LeftOf
10131RightOf = _core_.RightOf
10132SameAs = _core_.SameAs
10133Absolute = _core_.Absolute
d14a1e28 10134class IndividualLayoutConstraint(Object):
15afbcd0 10135 """
41e2b43e
RD
10136 Objects of this class are stored in the `wx.LayoutConstraints` class as
10137 one of eight possible constraints that a window can be involved in.
10138 You will never need to create an instance of
10139 wx.IndividualLayoutConstraint, rather you should create a
10140 `wx.LayoutConstraints` instance and use the individual contstraints
15afbcd0 10141 that it contains.
15afbcd0 10142 """
d14a1e28
RD
10143 def __init__(self): raise RuntimeError, "No constructor defined"
10144 def __repr__(self):
10145 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 10146 def Set(*args, **kwargs):
41e2b43e
RD
10147 """
10148 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10149
10150 Sets the properties of the constraint. Normally called by one of the
10151 convenience functions such as Above, RightOf, SameAs.
10152 """
54f9ee45 10153 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
e811c8ce
RD
10154
10155 def LeftOf(*args, **kwargs):
15afbcd0 10156 """
a95a7133 10157 LeftOf(self, Window sibling, int marg=0)
15afbcd0 10158
41e2b43e
RD
10159 Constrains this edge to be to the left of the given window, with an
10160 optional margin. Implicitly, this is relative to the left edge of the
10161 other window.
15afbcd0 10162 """
54f9ee45 10163 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
e811c8ce
RD
10164
10165 def RightOf(*args, **kwargs):
15afbcd0 10166 """
a95a7133 10167 RightOf(self, Window sibling, int marg=0)
15afbcd0 10168
41e2b43e
RD
10169 Constrains this edge to be to the right of the given window, with an
10170 optional margin. Implicitly, this is relative to the right edge of the
10171 other window.
15afbcd0 10172 """
54f9ee45 10173 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
e811c8ce
RD
10174
10175 def Above(*args, **kwargs):
15afbcd0 10176 """
a95a7133 10177 Above(self, Window sibling, int marg=0)
15afbcd0 10178
41e2b43e
RD
10179 Constrains this edge to be above the given window, with an optional
10180 margin. Implicitly, this is relative to the top edge of the other
10181 window.
15afbcd0 10182 """
54f9ee45 10183 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
e811c8ce
RD
10184
10185 def Below(*args, **kwargs):
15afbcd0 10186 """
a95a7133 10187 Below(self, Window sibling, int marg=0)
15afbcd0 10188
41e2b43e
RD
10189 Constrains this edge to be below the given window, with an optional
10190 margin. Implicitly, this is relative to the bottom edge of the other
10191 window.
15afbcd0 10192 """
54f9ee45 10193 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
e811c8ce
RD
10194
10195 def SameAs(*args, **kwargs):
15afbcd0 10196 """
a95a7133 10197 SameAs(self, Window otherW, int edge, int marg=0)
15afbcd0 10198
41e2b43e
RD
10199 Constrains this edge or dimension to be to the same as the edge of the
10200 given window, with an optional margin.
15afbcd0 10201 """
54f9ee45 10202 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
e811c8ce
RD
10203
10204 def PercentOf(*args, **kwargs):
15afbcd0 10205 """
a95a7133 10206 PercentOf(self, Window otherW, int wh, int per)
15afbcd0 10207
41e2b43e
RD
10208 Constrains this edge or dimension to be to a percentage of the given
10209 window, with an optional margin.
15afbcd0 10210 """
54f9ee45 10211 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
e811c8ce
RD
10212
10213 def Absolute(*args, **kwargs):
15afbcd0 10214 """
a95a7133 10215 Absolute(self, int val)
15afbcd0 10216
41e2b43e 10217 Constrains this edge or dimension to be the given absolute value.
15afbcd0 10218 """
54f9ee45 10219 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
e811c8ce
RD
10220
10221 def Unconstrained(*args, **kwargs):
15afbcd0 10222 """
a95a7133 10223 Unconstrained(self)
15afbcd0 10224
41e2b43e
RD
10225 Sets this edge or dimension to be unconstrained, that is, dependent on
10226 other edges and dimensions from which this value can be deduced.
15afbcd0 10227 """
54f9ee45 10228 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
e811c8ce
RD
10229
10230 def AsIs(*args, **kwargs):
15afbcd0 10231 """
a95a7133 10232 AsIs(self)
15afbcd0 10233
41e2b43e
RD
10234 Sets this edge or constraint to be whatever the window's value is at
10235 the moment. If either of the width and height constraints are *as is*,
10236 the window will not be resized, but moved instead. This is important
10237 when considering panel items which are intended to have a default
10238 size, such as a button, which may take its size from the size of the
10239 button label.
15afbcd0 10240 """
54f9ee45 10241 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
e811c8ce
RD
10242
10243 def GetOtherWindow(*args, **kwargs):
a95a7133 10244 """GetOtherWindow(self) -> Window"""
54f9ee45 10245 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
e811c8ce
RD
10246
10247 def GetMyEdge(*args, **kwargs):
a95a7133 10248 """GetMyEdge(self) -> int"""
54f9ee45 10249 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
e811c8ce
RD
10250
10251 def SetEdge(*args, **kwargs):
a95a7133 10252 """SetEdge(self, int which)"""
54f9ee45 10253 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
e811c8ce
RD
10254
10255 def SetValue(*args, **kwargs):
a95a7133 10256 """SetValue(self, int v)"""
54f9ee45 10257 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
e811c8ce
RD
10258
10259 def GetMargin(*args, **kwargs):
a95a7133 10260 """GetMargin(self) -> int"""
54f9ee45 10261 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
e811c8ce
RD
10262
10263 def SetMargin(*args, **kwargs):
a95a7133 10264 """SetMargin(self, int m)"""
54f9ee45 10265 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
e811c8ce
RD
10266
10267 def GetValue(*args, **kwargs):
a95a7133 10268 """GetValue(self) -> int"""
54f9ee45 10269 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
e811c8ce
RD
10270
10271 def GetPercent(*args, **kwargs):
a95a7133 10272 """GetPercent(self) -> int"""
54f9ee45 10273 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
e811c8ce
RD
10274
10275 def GetOtherEdge(*args, **kwargs):
a95a7133 10276 """GetOtherEdge(self) -> int"""
54f9ee45 10277 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
e811c8ce
RD
10278
10279 def GetDone(*args, **kwargs):
a95a7133 10280 """GetDone(self) -> bool"""
54f9ee45 10281 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
e811c8ce
RD
10282
10283 def SetDone(*args, **kwargs):
a95a7133 10284 """SetDone(self, bool d)"""
54f9ee45 10285 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
e811c8ce
RD
10286
10287 def GetRelationship(*args, **kwargs):
a95a7133 10288 """GetRelationship(self) -> int"""
54f9ee45 10289 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
e811c8ce
RD
10290
10291 def SetRelationship(*args, **kwargs):
a95a7133 10292 """SetRelationship(self, int r)"""
54f9ee45 10293 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
e811c8ce
RD
10294
10295 def ResetIfWin(*args, **kwargs):
15afbcd0 10296 """
a95a7133 10297 ResetIfWin(self, Window otherW) -> bool
15afbcd0
RD
10298
10299 Reset constraint if it mentions otherWin
10300 """
54f9ee45 10301 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
e811c8ce
RD
10302
10303 def SatisfyConstraint(*args, **kwargs):
15afbcd0 10304 """
a95a7133 10305 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
15afbcd0
RD
10306
10307 Try to satisfy constraint
10308 """
54f9ee45 10309 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
e811c8ce
RD
10310
10311 def GetEdge(*args, **kwargs):
15afbcd0 10312 """
a95a7133 10313 GetEdge(self, int which, Window thisWin, Window other) -> int
15afbcd0
RD
10314
10315 Get the value of this edge or dimension, or if this
10316 is not determinable, -1.
10317 """
54f9ee45 10318 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
e811c8ce 10319
d14a1e28
RD
10320
10321class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10322 def __init__(self, this):
10323 self.this = this
10324 if not hasattr(self,"thisown"): self.thisown = 0
10325 self.__class__ = IndividualLayoutConstraint
54f9ee45 10326_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
d14a1e28
RD
10327
10328class LayoutConstraints(Object):
15afbcd0 10329 """
41e2b43e
RD
10330 **Note:** constraints are now deprecated and you should use sizers
10331 instead.
15afbcd0 10332
41e2b43e
RD
10333 Objects of this class can be associated with a window to define its
10334 layout constraints, with respect to siblings or its parent.
15afbcd0
RD
10335
10336 The class consists of the following eight constraints of class
10337 wx.IndividualLayoutConstraint, some or all of which should be accessed
10338 directly to set the appropriate constraints.
10339
10340 * left: represents the left hand edge of the window
10341 * right: represents the right hand edge of the window
10342 * top: represents the top edge of the window
10343 * bottom: represents the bottom edge of the window
10344 * width: represents the width of the window
10345 * height: represents the height of the window
10346 * centreX: represents the horizontal centre point of the window
10347 * centreY: represents the vertical centre point of the window
10348
41e2b43e
RD
10349 Most constraints are initially set to have the relationship
10350 wxUnconstrained, which means that their values should be calculated by
10351 looking at known constraints. The exceptions are width and height,
10352 which are set to wxAsIs to ensure that if the user does not specify a
10353 constraint, the existing width and height will be used, to be
10354 compatible with panel items which often have take a default size. If
10355 the constraint is ``wx.AsIs``, the dimension will not be changed.
10356
10357 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
15afbcd0
RD
10358
10359 """
e811c8ce
RD
10360 def __repr__(self):
10361 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
10362 left = property(_core_.LayoutConstraints_left_get)
10363 top = property(_core_.LayoutConstraints_top_get)
10364 right = property(_core_.LayoutConstraints_right_get)
10365 bottom = property(_core_.LayoutConstraints_bottom_get)
10366 width = property(_core_.LayoutConstraints_width_get)
10367 height = property(_core_.LayoutConstraints_height_get)
10368 centreX = property(_core_.LayoutConstraints_centreX_get)
10369 centreY = property(_core_.LayoutConstraints_centreY_get)
d14a1e28 10370 def __init__(self, *args, **kwargs):
a95a7133 10371 """__init__(self) -> LayoutConstraints"""
54f9ee45 10372 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
d14a1e28
RD
10373 self.this = newobj.this
10374 self.thisown = 1
10375 del newobj.thisown
e811c8ce 10376 def SatisfyConstraints(*args, **kwargs):
6c3b4aae 10377 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
54f9ee45 10378 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
e811c8ce
RD
10379
10380 def AreSatisfied(*args, **kwargs):
a95a7133 10381 """AreSatisfied(self) -> bool"""
54f9ee45 10382 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
e811c8ce 10383
d14a1e28
RD
10384
10385class LayoutConstraintsPtr(LayoutConstraints):
10386 def __init__(self, this):
10387 self.this = this
10388 if not hasattr(self,"thisown"): self.thisown = 0
10389 self.__class__ = LayoutConstraints
54f9ee45 10390_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
d14a1e28
RD
10391
10392#----------------------------------------------------------------------------
10393
322913ce 10394# Use Python's bool constants if available, make some if not
d14a1e28
RD
10395try:
10396 True
10397except NameError:
322913ce
RD
10398 __builtins__.True = 1==1
10399 __builtins__.False = 1==0
4f89f6a3
RD
10400 def bool(value): return not not value
10401 __builtins__.bool = bool
d14a1e28 10402
d14a1e28
RD
10403
10404
10405# workarounds for bad wxRTTI names
10406__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10407__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10408__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10409
10410
10411#----------------------------------------------------------------------------
10412# Load version numbers from __version__... Ensure that major and minor
10413# versions are the same for both wxPython and wxWindows.
10414
10415from __version__ import *
10416__version__ = VERSION_STRING
10417
54f9ee45
RD
10418assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
10419assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
10420if RELEASE_VERSION != _core_.RELEASE_VERSION:
d14a1e28
RD
10421 import warnings
10422 warnings.warn("wxPython/wxWindows release number mismatch")
10423
10424#----------------------------------------------------------------------------
10425
10426class PyDeadObjectError(AttributeError):
10427 pass
10428
d14a1e28
RD
10429class _wxPyDeadObject(object):
10430 """
10431 Instances of wx objects that are OOR capable will have their __class__
10432 changed to this class when the C++ object is deleted. This should help
10433 prevent crashes due to referencing a bogus C++ pointer.
10434 """
10435 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10436 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10437
3a04f143 10438 def __repr__(self):
d14a1e28
RD
10439 if not hasattr(self, "_name"):
10440 self._name = "[unknown]"
10441 return self.reprStr % self._name
10442
3a04f143 10443 def __getattr__(self, *args):
d14a1e28
RD
10444 if not hasattr(self, "_name"):
10445 self._name = "[unknown]"
3a04f143
RD
10446 raise PyDeadObjectError(self.attrStr % self._name)
10447
10448 def __nonzero__(self):
10449 return 0
10450
10451
10452
10453class PyUnbornObjectError(AttributeError):
10454 pass
10455
10456class _wxPyUnbornObject(object):
10457 """
54f9ee45 10458 Some stock objects are created when the wx._core module is
3a04f143
RD
10459 imported, but their C++ instance is not created until the wx.App
10460 object is created and initialized. These object instances will
10461 temporarily have their __class__ changed to this class so an
10462 exception will be raised if they are used before the C++ instance
10463 is ready.
10464 """
10465
10466 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10467 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10468
10469 def __repr__(self):
10470 #if not hasattr(self, "_name"):
10471 # self._name = "[unknown]"
10472 return self.reprStr #% self._name
10473
10474 def __getattr__(self, *args):
10475 #if not hasattr(self, "_name"):
10476 # self._name = "[unknown]"
10477 raise PyUnbornObjectError(self.attrStr) # % self._name )
d14a1e28
RD
10478
10479 def __nonzero__(self):
10480 return 0
10481
10482
10483#----------------------------------------------------------------------------
10484_wxPyCallAfterId = None
10485
10486def CallAfter(callable, *args, **kw):
10487 """
10488 Call the specified function after the current and pending event
10489 handlers have been completed. This is also good for making GUI
61863841
RD
10490 method calls from non-GUI threads. Any extra positional or
10491 keyword args are passed on to the callable when it is called.
10492
10493 :see: `wx.FutureCall`
d14a1e28
RD
10494 """
10495 app = wx.GetApp()
dfbb5885 10496 assert app is not None, 'No wx.App created yet'
d14a1e28
RD
10497
10498 global _wxPyCallAfterId
10499 if _wxPyCallAfterId is None:
10500 _wxPyCallAfterId = wx.NewEventType()
10501 app.Connect(-1, -1, _wxPyCallAfterId,
10502 lambda event: event.callable(*event.args, **event.kw) )
10503 evt = wx.PyEvent()
10504 evt.SetEventType(_wxPyCallAfterId)
10505 evt.callable = callable
10506 evt.args = args
10507 evt.kw = kw
10508 wx.PostEvent(app, evt)
10509
10510
10511#----------------------------------------------------------------------------
10512
10513
10514class FutureCall:
10515 """
4276dc52 10516 A convenience class for wx.Timer, that calls the given callable
d14a1e28
RD
10517 object once after the given amount of milliseconds, passing any
10518 positional or keyword args. The return value of the callable is
61863841 10519 availbale after it has been run with the `GetResult` method.
d14a1e28
RD
10520
10521 If you don't need to get the return value or restart the timer
10522 then there is no need to hold a reference to this object. It will
10523 hold a reference to itself while the timer is running (the timer
10524 has a reference to self.Notify) but the cycle will be broken when
10525 the timer completes, automatically cleaning up the wx.FutureCall
10526 object.
61863841
RD
10527
10528 :see: `wx.CallAfter`
d14a1e28
RD
10529 """
10530 def __init__(self, millis, callable, *args, **kwargs):
10531 self.millis = millis
10532 self.callable = callable
10533 self.SetArgs(*args, **kwargs)
10534 self.runCount = 0
4276dc52 10535 self.running = False
d14a1e28
RD
10536 self.hasRun = False
10537 self.result = None
10538 self.timer = None
10539 self.Start()
10540
10541 def __del__(self):
10542 self.Stop()
10543
10544
10545 def Start(self, millis=None, *args, **kwargs):
10546 """
10547 (Re)start the timer
10548 """
10549 self.hasRun = False
10550 if millis is not None:
10551 self.millis = millis
10552 if args or kwargs:
10553 self.SetArgs(*args, **kwargs)
10554 self.Stop()
10555 self.timer = wx.PyTimer(self.Notify)
10556 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
4276dc52 10557 self.running = True
d14a1e28
RD
10558 Restart = Start
10559
10560
10561 def Stop(self):
10562 """
10563 Stop and destroy the timer.
10564 """
10565 if self.timer is not None:
10566 self.timer.Stop()
10567 self.timer = None
10568
10569
10570 def GetInterval(self):
10571 if self.timer is not None:
10572 return self.timer.GetInterval()
10573 else:
10574 return 0
10575
10576
10577 def IsRunning(self):
10578 return self.timer is not None and self.timer.IsRunning()
10579
10580
10581 def SetArgs(self, *args, **kwargs):
10582 """
10583 (Re)set the args passed to the callable object. This is
10584 useful in conjunction with Restart if you want to schedule a
10585 new call to the same callable object but with different
10586 parameters.
10587 """
10588 self.args = args
10589 self.kwargs = kwargs
10590
10591
10592 def HasRun(self):
10593 return self.hasRun
10594
10595 def GetResult(self):
10596 return self.result
10597
10598 def Notify(self):
10599 """
10600 The timer has expired so call the callable.
10601 """
10602 if self.callable and getattr(self.callable, 'im_self', True):
10603 self.runCount += 1
4276dc52 10604 self.running = False
d14a1e28
RD
10605 self.result = self.callable(*self.args, **self.kwargs)
10606 self.hasRun = True
4276dc52
RD
10607 if not self.running:
10608 # if it wasn't restarted, then cleanup
10609 wx.CallAfter(self.Stop)
d14a1e28
RD
10610
10611
a95a7133
RD
10612
10613#----------------------------------------------------------------------------
10614# Control which items in this module should be documented by epydoc.
10615# We allow only classes and functions, which will help reduce the size
10616# of the docs by filtering out the zillions of constants, EVT objects,
10617# and etc that don't make much sense by themselves, but are instead
10618# documented (or will be) as part of the classes/functions/methods
10619# where they should be used.
10620
66c033b4
RD
10621class __DocFilter:
10622 """
10623 A filter for epydoc that only allows non-Ptr classes and
10624 fucntions, in order to reduce the clutter in the API docs.
10625 """
10626 def __init__(self, globals):
10627 self._globals = globals
10628
10629 def __call__(self, name):
10630 import types
10631 obj = self._globals.get(name, None)
10632 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10633 return False
10634 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10635 return False
10636 return True
a95a7133 10637
d14a1e28
RD
10638#----------------------------------------------------------------------------
10639#----------------------------------------------------------------------------
10640
10641# Import other modules in this package that should show up in the
10642# "core" wx namespace
54f9ee45
RD
10643from _gdi import *
10644from _windows import *
10645from _controls import *
10646from _misc import *
d14a1e28 10647
3a04f143
RD
10648
10649# Fixup the stock objects since they can't be used yet. (They will be
10650# restored in wx.PyApp.OnInit.)
54f9ee45 10651_core_._wxPyFixStockObjects()
3a04f143 10652
d14a1e28
RD
10653#----------------------------------------------------------------------------
10654#----------------------------------------------------------------------------
10655
10656