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