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