]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/mac/_core.py
inform the IM context about focus changes
[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
3379 def LeftDown(*args, **kwargs):
3380 """LeftDown(self) -> bool"""
3381 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3382
3383 def MiddleDown(*args, **kwargs):
3384 """MiddleDown(self) -> bool"""
3385 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3386
3387 def RightDown(*args, **kwargs):
3388 """RightDown(self) -> bool"""
3389 return _core_.MouseEvent_RightDown(*args, **kwargs)
3390
3391 def LeftUp(*args, **kwargs):
3392 """LeftUp(self) -> bool"""
3393 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3394
3395 def MiddleUp(*args, **kwargs):
3396 """MiddleUp(self) -> bool"""
3397 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3398
3399 def RightUp(*args, **kwargs):
3400 """RightUp(self) -> bool"""
3401 return _core_.MouseEvent_RightUp(*args, **kwargs)
3402
3403 def LeftDClick(*args, **kwargs):
3404 """LeftDClick(self) -> bool"""
3405 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3406
3407 def MiddleDClick(*args, **kwargs):
3408 """MiddleDClick(self) -> bool"""
3409 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3410
3411 def RightDClick(*args, **kwargs):
3412 """RightDClick(self) -> bool"""
3413 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3414
3415 def LeftIsDown(*args, **kwargs):
3416 """LeftIsDown(self) -> bool"""
3417 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3418
3419 def MiddleIsDown(*args, **kwargs):
3420 """MiddleIsDown(self) -> bool"""
3421 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3422
3423 def RightIsDown(*args, **kwargs):
3424 """RightIsDown(self) -> bool"""
3425 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3426
3427 def Dragging(*args, **kwargs):
3428 """Dragging(self) -> bool"""
3429 return _core_.MouseEvent_Dragging(*args, **kwargs)
3430
3431 def Moving(*args, **kwargs):
3432 """Moving(self) -> bool"""
3433 return _core_.MouseEvent_Moving(*args, **kwargs)
3434
3435 def Entering(*args, **kwargs):
3436 """Entering(self) -> bool"""
3437 return _core_.MouseEvent_Entering(*args, **kwargs)
3438
3439 def Leaving(*args, **kwargs):
3440 """Leaving(self) -> bool"""
3441 return _core_.MouseEvent_Leaving(*args, **kwargs)
3442
3443 def GetPosition(*args, **kwargs):
3444 """
3445 GetPosition(self) -> Point
3446
15817c7e
RD
3447 Returns the position of the mouse in window coordinates when the event
3448 happened.
d55e5bfc
RD
3449 """
3450 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3451
3452 def GetPositionTuple(*args, **kwargs):
3453 """
3454 GetPositionTuple() -> (x,y)
3455
15817c7e
RD
3456 Returns the position of the mouse in window coordinates when the event
3457 happened.
d55e5bfc
RD
3458 """
3459 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3460
3461 def GetLogicalPosition(*args, **kwargs):
3462 """GetLogicalPosition(self, DC dc) -> Point"""
3463 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3464
3465 def GetX(*args, **kwargs):
3466 """GetX(self) -> int"""
3467 return _core_.MouseEvent_GetX(*args, **kwargs)
3468
3469 def GetY(*args, **kwargs):
3470 """GetY(self) -> int"""
3471 return _core_.MouseEvent_GetY(*args, **kwargs)
3472
3473 def GetWheelRotation(*args, **kwargs):
3474 """GetWheelRotation(self) -> int"""
3475 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3476
3477 def GetWheelDelta(*args, **kwargs):
3478 """GetWheelDelta(self) -> int"""
3479 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3480
3481 def GetLinesPerAction(*args, **kwargs):
3482 """GetLinesPerAction(self) -> int"""
3483 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3484
3485 def IsPageScroll(*args, **kwargs):
3486 """IsPageScroll(self) -> bool"""
3487 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3488
3489 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3490 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3491 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3492 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3493 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3494 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3495 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3496 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3497 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3498 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3499 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3500 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3501
3502class MouseEventPtr(MouseEvent):
3503 def __init__(self, this):
3504 self.this = this
3505 if not hasattr(self,"thisown"): self.thisown = 0
3506 self.__class__ = MouseEvent
3507_core_.MouseEvent_swigregister(MouseEventPtr)
3508
3509#---------------------------------------------------------------------------
3510
3511class SetCursorEvent(Event):
3512 def __repr__(self):
3513 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3514 def __init__(self, *args, **kwargs):
3515 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3516 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3517 self.this = newobj.this
3518 self.thisown = 1
3519 del newobj.thisown
3520 def GetX(*args, **kwargs):
3521 """GetX(self) -> int"""
3522 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3523
3524 def GetY(*args, **kwargs):
3525 """GetY(self) -> int"""
3526 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3527
3528 def SetCursor(*args, **kwargs):
3529 """SetCursor(self, Cursor cursor)"""
3530 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3531
3532 def GetCursor(*args, **kwargs):
3533 """GetCursor(self) -> Cursor"""
3534 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3535
3536 def HasCursor(*args, **kwargs):
3537 """HasCursor(self) -> bool"""
3538 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3539
3540
3541class SetCursorEventPtr(SetCursorEvent):
3542 def __init__(self, this):
3543 self.this = this
3544 if not hasattr(self,"thisown"): self.thisown = 0
3545 self.__class__ = SetCursorEvent
3546_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3547
3548#---------------------------------------------------------------------------
3549
3550class KeyEvent(Event):
3551 def __repr__(self):
3552 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3553 def __init__(self, *args, **kwargs):
3554 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3555 newobj = _core_.new_KeyEvent(*args, **kwargs)
3556 self.this = newobj.this
3557 self.thisown = 1
3558 del newobj.thisown
3559 def ControlDown(*args, **kwargs):
3560 """ControlDown(self) -> bool"""
3561 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3562
3563 def MetaDown(*args, **kwargs):
3564 """MetaDown(self) -> bool"""
3565 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3566
3567 def AltDown(*args, **kwargs):
3568 """AltDown(self) -> bool"""
3569 return _core_.KeyEvent_AltDown(*args, **kwargs)
3570
3571 def ShiftDown(*args, **kwargs):
3572 """ShiftDown(self) -> bool"""
3573 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3574
3575 def HasModifiers(*args, **kwargs):
3576 """HasModifiers(self) -> bool"""
3577 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3578
3579 def GetKeyCode(*args, **kwargs):
3580 """GetKeyCode(self) -> int"""
3581 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3582
3583 KeyCode = GetKeyCode
3584 def GetUniChar(*args, **kwargs):
3585 """GetUniChar(self) -> int"""
3586 return _core_.KeyEvent_GetUniChar(*args, **kwargs)
3587
3588 def GetRawKeyCode(*args, **kwargs):
3589 """GetRawKeyCode(self) -> unsigned int"""
3590 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3591
3592 def GetRawKeyFlags(*args, **kwargs):
3593 """GetRawKeyFlags(self) -> unsigned int"""
3594 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3595
3596 def GetPosition(*args, **kwargs):
3597 """
3598 GetPosition(self) -> Point
3599
3600 Find the position of the event.
3601 """
3602 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3603
3604 def GetPositionTuple(*args, **kwargs):
3605 """
3606 GetPositionTuple() -> (x,y)
3607
3608 Find the position of the event.
3609 """
3610 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3611
3612 def GetX(*args, **kwargs):
3613 """GetX(self) -> int"""
3614 return _core_.KeyEvent_GetX(*args, **kwargs)
3615
3616 def GetY(*args, **kwargs):
3617 """GetY(self) -> int"""
3618 return _core_.KeyEvent_GetY(*args, **kwargs)
3619
3620 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3621 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3622 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3623 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3624 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3625 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3626 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3627 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3628 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3629 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3630
3631class KeyEventPtr(KeyEvent):
3632 def __init__(self, this):
3633 self.this = this
3634 if not hasattr(self,"thisown"): self.thisown = 0
3635 self.__class__ = KeyEvent
3636_core_.KeyEvent_swigregister(KeyEventPtr)
3637
3638#---------------------------------------------------------------------------
3639
3640class SizeEvent(Event):
3641 def __repr__(self):
3642 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3643 def __init__(self, *args, **kwargs):
3644 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3645 newobj = _core_.new_SizeEvent(*args, **kwargs)
3646 self.this = newobj.this
3647 self.thisown = 1
3648 del newobj.thisown
3649 def GetSize(*args, **kwargs):
3650 """GetSize(self) -> Size"""
3651 return _core_.SizeEvent_GetSize(*args, **kwargs)
3652
3653 def GetRect(*args, **kwargs):
3654 """GetRect(self) -> Rect"""
3655 return _core_.SizeEvent_GetRect(*args, **kwargs)
3656
3657 def SetRect(*args, **kwargs):
3658 """SetRect(self, Rect rect)"""
3659 return _core_.SizeEvent_SetRect(*args, **kwargs)
3660
3661 def SetSize(*args, **kwargs):
3662 """SetSize(self, Size size)"""
3663 return _core_.SizeEvent_SetSize(*args, **kwargs)
3664
3665 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3666 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
3667
3668class SizeEventPtr(SizeEvent):
3669 def __init__(self, this):
3670 self.this = this
3671 if not hasattr(self,"thisown"): self.thisown = 0
3672 self.__class__ = SizeEvent
3673_core_.SizeEvent_swigregister(SizeEventPtr)
3674
3675#---------------------------------------------------------------------------
3676
3677class MoveEvent(Event):
3678 def __repr__(self):
3679 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3680 def __init__(self, *args, **kwargs):
3681 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
3682 newobj = _core_.new_MoveEvent(*args, **kwargs)
3683 self.this = newobj.this
3684 self.thisown = 1
3685 del newobj.thisown
3686 def GetPosition(*args, **kwargs):
3687 """GetPosition(self) -> Point"""
3688 return _core_.MoveEvent_GetPosition(*args, **kwargs)
3689
3690 def GetRect(*args, **kwargs):
3691 """GetRect(self) -> Rect"""
3692 return _core_.MoveEvent_GetRect(*args, **kwargs)
3693
3694 def SetRect(*args, **kwargs):
3695 """SetRect(self, Rect rect)"""
3696 return _core_.MoveEvent_SetRect(*args, **kwargs)
3697
3698 def SetPosition(*args, **kwargs):
3699 """SetPosition(self, Point pos)"""
3700 return _core_.MoveEvent_SetPosition(*args, **kwargs)
3701
3702 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3703 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
3704
3705class MoveEventPtr(MoveEvent):
3706 def __init__(self, this):
3707 self.this = this
3708 if not hasattr(self,"thisown"): self.thisown = 0
3709 self.__class__ = MoveEvent
3710_core_.MoveEvent_swigregister(MoveEventPtr)
3711
3712#---------------------------------------------------------------------------
3713
3714class PaintEvent(Event):
3715 def __repr__(self):
3716 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3717 def __init__(self, *args, **kwargs):
3718 """__init__(self, int Id=0) -> PaintEvent"""
3719 newobj = _core_.new_PaintEvent(*args, **kwargs)
3720 self.this = newobj.this
3721 self.thisown = 1
3722 del newobj.thisown
3723
3724class PaintEventPtr(PaintEvent):
3725 def __init__(self, this):
3726 self.this = this
3727 if not hasattr(self,"thisown"): self.thisown = 0
3728 self.__class__ = PaintEvent
3729_core_.PaintEvent_swigregister(PaintEventPtr)
3730
3731class NcPaintEvent(Event):
3732 def __repr__(self):
3733 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3734 def __init__(self, *args, **kwargs):
3735 """__init__(self, int winid=0) -> NcPaintEvent"""
3736 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
3737 self.this = newobj.this
3738 self.thisown = 1
3739 del newobj.thisown
3740
3741class NcPaintEventPtr(NcPaintEvent):
3742 def __init__(self, this):
3743 self.this = this
3744 if not hasattr(self,"thisown"): self.thisown = 0
3745 self.__class__ = NcPaintEvent
3746_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
3747
3748#---------------------------------------------------------------------------
3749
3750class EraseEvent(Event):
3751 def __repr__(self):
3752 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3753 def __init__(self, *args, **kwargs):
3754 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
3755 newobj = _core_.new_EraseEvent(*args, **kwargs)
3756 self.this = newobj.this
3757 self.thisown = 1
3758 del newobj.thisown
3759 def GetDC(*args, **kwargs):
3760 """GetDC(self) -> DC"""
3761 return _core_.EraseEvent_GetDC(*args, **kwargs)
3762
3763
3764class EraseEventPtr(EraseEvent):
3765 def __init__(self, this):
3766 self.this = this
3767 if not hasattr(self,"thisown"): self.thisown = 0
3768 self.__class__ = EraseEvent
3769_core_.EraseEvent_swigregister(EraseEventPtr)
3770
3771#---------------------------------------------------------------------------
3772
3773class FocusEvent(Event):
3774 def __repr__(self):
3775 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3776 def __init__(self, *args, **kwargs):
3777 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
3778 newobj = _core_.new_FocusEvent(*args, **kwargs)
3779 self.this = newobj.this
3780 self.thisown = 1
3781 del newobj.thisown
3782 def GetWindow(*args, **kwargs):
3783 """GetWindow(self) -> Window"""
3784 return _core_.FocusEvent_GetWindow(*args, **kwargs)
3785
3786 def SetWindow(*args, **kwargs):
3787 """SetWindow(self, Window win)"""
3788 return _core_.FocusEvent_SetWindow(*args, **kwargs)
3789
3790
3791class FocusEventPtr(FocusEvent):
3792 def __init__(self, this):
3793 self.this = this
3794 if not hasattr(self,"thisown"): self.thisown = 0
3795 self.__class__ = FocusEvent
3796_core_.FocusEvent_swigregister(FocusEventPtr)
3797
3798#---------------------------------------------------------------------------
3799
3800class ChildFocusEvent(CommandEvent):
3801 def __repr__(self):
3802 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3803 def __init__(self, *args, **kwargs):
3804 """__init__(self, Window win=None) -> ChildFocusEvent"""
3805 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
3806 self.this = newobj.this
3807 self.thisown = 1
3808 del newobj.thisown
3809 def GetWindow(*args, **kwargs):
3810 """GetWindow(self) -> Window"""
3811 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
3812
3813
3814class ChildFocusEventPtr(ChildFocusEvent):
3815 def __init__(self, this):
3816 self.this = this
3817 if not hasattr(self,"thisown"): self.thisown = 0
3818 self.__class__ = ChildFocusEvent
3819_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
3820
3821#---------------------------------------------------------------------------
3822
3823class ActivateEvent(Event):
3824 def __repr__(self):
3825 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3826 def __init__(self, *args, **kwargs):
3827 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
3828 newobj = _core_.new_ActivateEvent(*args, **kwargs)
3829 self.this = newobj.this
3830 self.thisown = 1
3831 del newobj.thisown
3832 def GetActive(*args, **kwargs):
3833 """GetActive(self) -> bool"""
3834 return _core_.ActivateEvent_GetActive(*args, **kwargs)
3835
3836
3837class ActivateEventPtr(ActivateEvent):
3838 def __init__(self, this):
3839 self.this = this
3840 if not hasattr(self,"thisown"): self.thisown = 0
3841 self.__class__ = ActivateEvent
3842_core_.ActivateEvent_swigregister(ActivateEventPtr)
3843
3844#---------------------------------------------------------------------------
3845
3846class InitDialogEvent(Event):
3847 def __repr__(self):
3848 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3849 def __init__(self, *args, **kwargs):
3850 """__init__(self, int Id=0) -> InitDialogEvent"""
3851 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
3852 self.this = newobj.this
3853 self.thisown = 1
3854 del newobj.thisown
3855
3856class InitDialogEventPtr(InitDialogEvent):
3857 def __init__(self, this):
3858 self.this = this
3859 if not hasattr(self,"thisown"): self.thisown = 0
3860 self.__class__ = InitDialogEvent
3861_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
3862
3863#---------------------------------------------------------------------------
3864
3865class MenuEvent(Event):
3866 def __repr__(self):
3867 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3868 def __init__(self, *args, **kwargs):
3869 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
3870 newobj = _core_.new_MenuEvent(*args, **kwargs)
3871 self.this = newobj.this
3872 self.thisown = 1
3873 del newobj.thisown
3874 def GetMenuId(*args, **kwargs):
3875 """GetMenuId(self) -> int"""
3876 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
3877
3878 def IsPopup(*args, **kwargs):
3879 """IsPopup(self) -> bool"""
3880 return _core_.MenuEvent_IsPopup(*args, **kwargs)
3881
3882 def GetMenu(*args, **kwargs):
3883 """GetMenu(self) -> Menu"""
3884 return _core_.MenuEvent_GetMenu(*args, **kwargs)
3885
3886
3887class MenuEventPtr(MenuEvent):
3888 def __init__(self, this):
3889 self.this = this
3890 if not hasattr(self,"thisown"): self.thisown = 0
3891 self.__class__ = MenuEvent
3892_core_.MenuEvent_swigregister(MenuEventPtr)
3893
3894#---------------------------------------------------------------------------
3895
3896class CloseEvent(Event):
3897 def __repr__(self):
3898 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3899 def __init__(self, *args, **kwargs):
3900 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
3901 newobj = _core_.new_CloseEvent(*args, **kwargs)
3902 self.this = newobj.this
3903 self.thisown = 1
3904 del newobj.thisown
3905 def SetLoggingOff(*args, **kwargs):
3906 """SetLoggingOff(self, bool logOff)"""
3907 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
3908
3909 def GetLoggingOff(*args, **kwargs):
3910 """GetLoggingOff(self) -> bool"""
3911 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
3912
3913 def Veto(*args, **kwargs):
3914 """Veto(self, bool veto=True)"""
3915 return _core_.CloseEvent_Veto(*args, **kwargs)
3916
3917 def SetCanVeto(*args, **kwargs):
3918 """SetCanVeto(self, bool canVeto)"""
3919 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
3920
3921 def CanVeto(*args, **kwargs):
3922 """CanVeto(self) -> bool"""
3923 return _core_.CloseEvent_CanVeto(*args, **kwargs)
3924
3925 def GetVeto(*args, **kwargs):
3926 """GetVeto(self) -> bool"""
3927 return _core_.CloseEvent_GetVeto(*args, **kwargs)
3928
3929
3930class CloseEventPtr(CloseEvent):
3931 def __init__(self, this):
3932 self.this = this
3933 if not hasattr(self,"thisown"): self.thisown = 0
3934 self.__class__ = CloseEvent
3935_core_.CloseEvent_swigregister(CloseEventPtr)
3936
3937#---------------------------------------------------------------------------
3938
3939class ShowEvent(Event):
3940 def __repr__(self):
3941 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3942 def __init__(self, *args, **kwargs):
3943 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
3944 newobj = _core_.new_ShowEvent(*args, **kwargs)
3945 self.this = newobj.this
3946 self.thisown = 1
3947 del newobj.thisown
3948 def SetShow(*args, **kwargs):
3949 """SetShow(self, bool show)"""
3950 return _core_.ShowEvent_SetShow(*args, **kwargs)
3951
3952 def GetShow(*args, **kwargs):
3953 """GetShow(self) -> bool"""
3954 return _core_.ShowEvent_GetShow(*args, **kwargs)
3955
3956
3957class ShowEventPtr(ShowEvent):
3958 def __init__(self, this):
3959 self.this = this
3960 if not hasattr(self,"thisown"): self.thisown = 0
3961 self.__class__ = ShowEvent
3962_core_.ShowEvent_swigregister(ShowEventPtr)
3963
3964#---------------------------------------------------------------------------
3965
3966class IconizeEvent(Event):
3967 def __repr__(self):
3968 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3969 def __init__(self, *args, **kwargs):
3970 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
3971 newobj = _core_.new_IconizeEvent(*args, **kwargs)
3972 self.this = newobj.this
3973 self.thisown = 1
3974 del newobj.thisown
3975 def Iconized(*args, **kwargs):
3976 """Iconized(self) -> bool"""
3977 return _core_.IconizeEvent_Iconized(*args, **kwargs)
3978
3979
3980class IconizeEventPtr(IconizeEvent):
3981 def __init__(self, this):
3982 self.this = this
3983 if not hasattr(self,"thisown"): self.thisown = 0
3984 self.__class__ = IconizeEvent
3985_core_.IconizeEvent_swigregister(IconizeEventPtr)
3986
3987#---------------------------------------------------------------------------
3988
3989class MaximizeEvent(Event):
3990 def __repr__(self):
3991 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3992 def __init__(self, *args, **kwargs):
3993 """__init__(self, int id=0) -> MaximizeEvent"""
3994 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
3995 self.this = newobj.this
3996 self.thisown = 1
3997 del newobj.thisown
3998
3999class MaximizeEventPtr(MaximizeEvent):
4000 def __init__(self, this):
4001 self.this = this
4002 if not hasattr(self,"thisown"): self.thisown = 0
4003 self.__class__ = MaximizeEvent
4004_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4005
4006#---------------------------------------------------------------------------
4007
4008class DropFilesEvent(Event):
4009 def __init__(self): raise RuntimeError, "No constructor defined"
4010 def __repr__(self):
4011 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4012 def GetPosition(*args, **kwargs):
4013 """GetPosition(self) -> Point"""
4014 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4015
4016 def GetNumberOfFiles(*args, **kwargs):
4017 """GetNumberOfFiles(self) -> int"""
4018 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4019
4020 def GetFiles(*args, **kwargs):
4021 """GetFiles(self) -> PyObject"""
4022 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4023
4024
4025class DropFilesEventPtr(DropFilesEvent):
4026 def __init__(self, this):
4027 self.this = this
4028 if not hasattr(self,"thisown"): self.thisown = 0
4029 self.__class__ = DropFilesEvent
4030_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4031
4032#---------------------------------------------------------------------------
4033
4034UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4035UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4036class UpdateUIEvent(CommandEvent):
4037 def __repr__(self):
4038 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4039 def __init__(self, *args, **kwargs):
4040 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4041 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4042 self.this = newobj.this
4043 self.thisown = 1
4044 del newobj.thisown
4045 def GetChecked(*args, **kwargs):
4046 """GetChecked(self) -> bool"""
4047 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4048
4049 def GetEnabled(*args, **kwargs):
4050 """GetEnabled(self) -> bool"""
4051 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4052
4053 def GetText(*args, **kwargs):
4054 """GetText(self) -> String"""
4055 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4056
4057 def GetSetText(*args, **kwargs):
4058 """GetSetText(self) -> bool"""
4059 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4060
4061 def GetSetChecked(*args, **kwargs):
4062 """GetSetChecked(self) -> bool"""
4063 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4064
4065 def GetSetEnabled(*args, **kwargs):
4066 """GetSetEnabled(self) -> bool"""
4067 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4068
4069 def Check(*args, **kwargs):
4070 """Check(self, bool check)"""
4071 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4072
4073 def Enable(*args, **kwargs):
4074 """Enable(self, bool enable)"""
4075 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4076
4077 def SetText(*args, **kwargs):
4078 """SetText(self, String text)"""
4079 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4080
4081 def SetUpdateInterval(*args, **kwargs):
d6c14a4c 4082 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD
4083 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4084
4085 SetUpdateInterval = staticmethod(SetUpdateInterval)
4086 def GetUpdateInterval(*args, **kwargs):
d6c14a4c 4087 """GetUpdateInterval() -> long"""
d55e5bfc
RD
4088 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4089
4090 GetUpdateInterval = staticmethod(GetUpdateInterval)
4091 def CanUpdate(*args, **kwargs):
d6c14a4c 4092 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD
4093 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4094
4095 CanUpdate = staticmethod(CanUpdate)
4096 def ResetUpdateTime(*args, **kwargs):
d6c14a4c 4097 """ResetUpdateTime()"""
d55e5bfc
RD
4098 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4099
4100 ResetUpdateTime = staticmethod(ResetUpdateTime)
4101 def SetMode(*args, **kwargs):
d6c14a4c 4102 """SetMode(int mode)"""
d55e5bfc
RD
4103 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4104
4105 SetMode = staticmethod(SetMode)
4106 def GetMode(*args, **kwargs):
d6c14a4c 4107 """GetMode() -> int"""
d55e5bfc
RD
4108 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4109
4110 GetMode = staticmethod(GetMode)
4111
4112class UpdateUIEventPtr(UpdateUIEvent):
4113 def __init__(self, this):
4114 self.this = this
4115 if not hasattr(self,"thisown"): self.thisown = 0
4116 self.__class__ = UpdateUIEvent
4117_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4118
4119def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4120 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4121 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4122
4123def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4124 """UpdateUIEvent_GetUpdateInterval() -> long"""
4125 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4126
4127def UpdateUIEvent_CanUpdate(*args, **kwargs):
4128 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4129 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4130
4131def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4132 """UpdateUIEvent_ResetUpdateTime()"""
4133 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4134
4135def UpdateUIEvent_SetMode(*args, **kwargs):
4136 """UpdateUIEvent_SetMode(int mode)"""
4137 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4138
4139def UpdateUIEvent_GetMode(*args, **kwargs):
4140 """UpdateUIEvent_GetMode() -> int"""
4141 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4142
4143#---------------------------------------------------------------------------
4144
4145class SysColourChangedEvent(Event):
4146 def __repr__(self):
4147 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4148 def __init__(self, *args, **kwargs):
4149 """__init__(self) -> SysColourChangedEvent"""
4150 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4151 self.this = newobj.this
4152 self.thisown = 1
4153 del newobj.thisown
4154
4155class SysColourChangedEventPtr(SysColourChangedEvent):
4156 def __init__(self, this):
4157 self.this = this
4158 if not hasattr(self,"thisown"): self.thisown = 0
4159 self.__class__ = SysColourChangedEvent
4160_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4161
4162#---------------------------------------------------------------------------
4163
4164class MouseCaptureChangedEvent(Event):
4165 def __repr__(self):
4166 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4167 def __init__(self, *args, **kwargs):
4168 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4169 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4170 self.this = newobj.this
4171 self.thisown = 1
4172 del newobj.thisown
4173 def GetCapturedWindow(*args, **kwargs):
4174 """GetCapturedWindow(self) -> Window"""
4175 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4176
4177
4178class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4179 def __init__(self, this):
4180 self.this = this
4181 if not hasattr(self,"thisown"): self.thisown = 0
4182 self.__class__ = MouseCaptureChangedEvent
4183_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4184
4185#---------------------------------------------------------------------------
4186
4187class DisplayChangedEvent(Event):
4188 def __repr__(self):
4189 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4190 def __init__(self, *args, **kwargs):
4191 """__init__(self) -> DisplayChangedEvent"""
4192 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4193 self.this = newobj.this
4194 self.thisown = 1
4195 del newobj.thisown
4196
4197class DisplayChangedEventPtr(DisplayChangedEvent):
4198 def __init__(self, this):
4199 self.this = this
4200 if not hasattr(self,"thisown"): self.thisown = 0
4201 self.__class__ = DisplayChangedEvent
4202_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4203
4204#---------------------------------------------------------------------------
4205
4206class PaletteChangedEvent(Event):
4207 def __repr__(self):
4208 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4209 def __init__(self, *args, **kwargs):
4210 """__init__(self, int id=0) -> PaletteChangedEvent"""
4211 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4212 self.this = newobj.this
4213 self.thisown = 1
4214 del newobj.thisown
4215 def SetChangedWindow(*args, **kwargs):
4216 """SetChangedWindow(self, Window win)"""
4217 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4218
4219 def GetChangedWindow(*args, **kwargs):
4220 """GetChangedWindow(self) -> Window"""
4221 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4222
4223
4224class PaletteChangedEventPtr(PaletteChangedEvent):
4225 def __init__(self, this):
4226 self.this = this
4227 if not hasattr(self,"thisown"): self.thisown = 0
4228 self.__class__ = PaletteChangedEvent
4229_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4230
4231#---------------------------------------------------------------------------
4232
4233class QueryNewPaletteEvent(Event):
4234 def __repr__(self):
4235 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4236 def __init__(self, *args, **kwargs):
4237 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4238 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4239 self.this = newobj.this
4240 self.thisown = 1
4241 del newobj.thisown
4242 def SetPaletteRealized(*args, **kwargs):
4243 """SetPaletteRealized(self, bool realized)"""
4244 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4245
4246 def GetPaletteRealized(*args, **kwargs):
4247 """GetPaletteRealized(self) -> bool"""
4248 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4249
4250
4251class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4252 def __init__(self, this):
4253 self.this = this
4254 if not hasattr(self,"thisown"): self.thisown = 0
4255 self.__class__ = QueryNewPaletteEvent
4256_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4257
4258#---------------------------------------------------------------------------
4259
4260class NavigationKeyEvent(Event):
4261 def __repr__(self):
4262 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4263 def __init__(self, *args, **kwargs):
4264 """__init__(self) -> NavigationKeyEvent"""
4265 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4266 self.this = newobj.this
4267 self.thisown = 1
4268 del newobj.thisown
4269 def GetDirection(*args, **kwargs):
4270 """GetDirection(self) -> bool"""
4271 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4272
4273 def SetDirection(*args, **kwargs):
908b74cd 4274 """SetDirection(self, bool forward)"""
d55e5bfc
RD
4275 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4276
4277 def IsWindowChange(*args, **kwargs):
4278 """IsWindowChange(self) -> bool"""
4279 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4280
4281 def SetWindowChange(*args, **kwargs):
908b74cd 4282 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD
4283 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4284
908b74cd
RD
4285 def SetFlags(*args, **kwargs):
4286 """SetFlags(self, long flags)"""
4287 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4288
d55e5bfc
RD
4289 def GetCurrentFocus(*args, **kwargs):
4290 """GetCurrentFocus(self) -> Window"""
4291 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4292
4293 def SetCurrentFocus(*args, **kwargs):
4294 """SetCurrentFocus(self, Window win)"""
4295 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4296
908b74cd
RD
4297 IsForward = _core_.NavigationKeyEvent_IsForward
4298 WinChange = _core_.NavigationKeyEvent_WinChange
d55e5bfc
RD
4299
4300class NavigationKeyEventPtr(NavigationKeyEvent):
4301 def __init__(self, this):
4302 self.this = this
4303 if not hasattr(self,"thisown"): self.thisown = 0
4304 self.__class__ = NavigationKeyEvent
4305_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4306
4307#---------------------------------------------------------------------------
4308
4309class WindowCreateEvent(CommandEvent):
4310 def __repr__(self):
4311 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4312 def __init__(self, *args, **kwargs):
4313 """__init__(self, Window win=None) -> WindowCreateEvent"""
4314 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4315 self.this = newobj.this
4316 self.thisown = 1
4317 del newobj.thisown
4318 def GetWindow(*args, **kwargs):
4319 """GetWindow(self) -> Window"""
4320 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4321
4322
4323class WindowCreateEventPtr(WindowCreateEvent):
4324 def __init__(self, this):
4325 self.this = this
4326 if not hasattr(self,"thisown"): self.thisown = 0
4327 self.__class__ = WindowCreateEvent
4328_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4329
4330class WindowDestroyEvent(CommandEvent):
4331 def __repr__(self):
4332 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4333 def __init__(self, *args, **kwargs):
4334 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4335 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4336 self.this = newobj.this
4337 self.thisown = 1
4338 del newobj.thisown
4339 def GetWindow(*args, **kwargs):
4340 """GetWindow(self) -> Window"""
4341 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4342
4343
4344class WindowDestroyEventPtr(WindowDestroyEvent):
4345 def __init__(self, this):
4346 self.this = this
4347 if not hasattr(self,"thisown"): self.thisown = 0
4348 self.__class__ = WindowDestroyEvent
4349_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4350
4351#---------------------------------------------------------------------------
4352
4353class ContextMenuEvent(CommandEvent):
4354 def __repr__(self):
4355 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4356 def __init__(self, *args, **kwargs):
4357 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4358 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4359 self.this = newobj.this
4360 self.thisown = 1
4361 del newobj.thisown
4362 def GetPosition(*args, **kwargs):
4363 """GetPosition(self) -> Point"""
4364 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4365
4366 def SetPosition(*args, **kwargs):
4367 """SetPosition(self, Point pos)"""
4368 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4369
4370
4371class ContextMenuEventPtr(ContextMenuEvent):
4372 def __init__(self, this):
4373 self.this = this
4374 if not hasattr(self,"thisown"): self.thisown = 0
4375 self.__class__ = ContextMenuEvent
4376_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4377
4378#---------------------------------------------------------------------------
4379
4380IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4381IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4382class IdleEvent(Event):
4383 def __repr__(self):
4384 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4385 def __init__(self, *args, **kwargs):
4386 """__init__(self) -> IdleEvent"""
4387 newobj = _core_.new_IdleEvent(*args, **kwargs)
4388 self.this = newobj.this
4389 self.thisown = 1
4390 del newobj.thisown
4391 def RequestMore(*args, **kwargs):
4392 """RequestMore(self, bool needMore=True)"""
4393 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4394
4395 def MoreRequested(*args, **kwargs):
4396 """MoreRequested(self) -> bool"""
4397 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4398
4399 def SetMode(*args, **kwargs):
d6c14a4c 4400 """SetMode(int mode)"""
d55e5bfc
RD
4401 return _core_.IdleEvent_SetMode(*args, **kwargs)
4402
4403 SetMode = staticmethod(SetMode)
4404 def GetMode(*args, **kwargs):
d6c14a4c 4405 """GetMode() -> int"""
d55e5bfc
RD
4406 return _core_.IdleEvent_GetMode(*args, **kwargs)
4407
4408 GetMode = staticmethod(GetMode)
4409 def CanSend(*args, **kwargs):
d6c14a4c 4410 """CanSend(Window win) -> bool"""
d55e5bfc
RD
4411 return _core_.IdleEvent_CanSend(*args, **kwargs)
4412
4413 CanSend = staticmethod(CanSend)
4414
4415class IdleEventPtr(IdleEvent):
4416 def __init__(self, this):
4417 self.this = this
4418 if not hasattr(self,"thisown"): self.thisown = 0
4419 self.__class__ = IdleEvent
4420_core_.IdleEvent_swigregister(IdleEventPtr)
4421
4422def IdleEvent_SetMode(*args, **kwargs):
4423 """IdleEvent_SetMode(int mode)"""
4424 return _core_.IdleEvent_SetMode(*args, **kwargs)
4425
4426def IdleEvent_GetMode(*args, **kwargs):
4427 """IdleEvent_GetMode() -> int"""
4428 return _core_.IdleEvent_GetMode(*args, **kwargs)
4429
4430def IdleEvent_CanSend(*args, **kwargs):
4431 """IdleEvent_CanSend(Window win) -> bool"""
4432 return _core_.IdleEvent_CanSend(*args, **kwargs)
4433
4434#---------------------------------------------------------------------------
4435
4436class PyEvent(Event):
4437 def __repr__(self):
4438 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4439 def __init__(self, *args, **kwargs):
4440 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4441 newobj = _core_.new_PyEvent(*args, **kwargs)
4442 self.this = newobj.this
4443 self.thisown = 1
4444 del newobj.thisown
4445 self.SetSelf(self)
4446
4447 def __del__(self, destroy=_core_.delete_PyEvent):
4448 """__del__(self)"""
4449 try:
4450 if self.thisown: destroy(self)
4451 except: pass
4452
4453 def SetSelf(*args, **kwargs):
4454 """SetSelf(self, PyObject self)"""
4455 return _core_.PyEvent_SetSelf(*args, **kwargs)
4456
4457 def GetSelf(*args, **kwargs):
4458 """GetSelf(self) -> PyObject"""
4459 return _core_.PyEvent_GetSelf(*args, **kwargs)
4460
4461
4462class PyEventPtr(PyEvent):
4463 def __init__(self, this):
4464 self.this = this
4465 if not hasattr(self,"thisown"): self.thisown = 0
4466 self.__class__ = PyEvent
4467_core_.PyEvent_swigregister(PyEventPtr)
4468
4469class PyCommandEvent(CommandEvent):
4470 def __repr__(self):
4471 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4472 def __init__(self, *args, **kwargs):
4473 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4474 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4475 self.this = newobj.this
4476 self.thisown = 1
4477 del newobj.thisown
4478 self.SetSelf(self)
4479
4480 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4481 """__del__(self)"""
4482 try:
4483 if self.thisown: destroy(self)
4484 except: pass
4485
4486 def SetSelf(*args, **kwargs):
4487 """SetSelf(self, PyObject self)"""
4488 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4489
4490 def GetSelf(*args, **kwargs):
4491 """GetSelf(self) -> PyObject"""
4492 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4493
4494
4495class PyCommandEventPtr(PyCommandEvent):
4496 def __init__(self, this):
4497 self.this = this
4498 if not hasattr(self,"thisown"): self.thisown = 0
4499 self.__class__ = PyCommandEvent
4500_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4501
4502#---------------------------------------------------------------------------
4503
4504PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4505PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4506PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4507PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4508PRINT_WINDOWS = _core_.PRINT_WINDOWS
4509PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4510class PyApp(EvtHandler):
d6c14a4c
RD
4511 """
4512 The ``wx.PyApp`` class is an *implementation detail*, please use the
4513 `wx.App` class (or some other derived class) instead.
4514 """
d55e5bfc
RD
4515 def __repr__(self):
4516 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4517 def __init__(self, *args, **kwargs):
4518 """
4519 __init__(self) -> PyApp
4520
4521 Create a new application object, starting the bootstrap process.
4522 """
4523 newobj = _core_.new_PyApp(*args, **kwargs)
4524 self.this = newobj.this
4525 self.thisown = 1
4526 del newobj.thisown
4527 self._setCallbackInfo(self, PyApp)
4528 self._setOORInfo(self)
4529
4530 def __del__(self, destroy=_core_.delete_PyApp):
4531 """__del__(self)"""
4532 try:
4533 if self.thisown: destroy(self)
4534 except: pass
4535
4536 def _setCallbackInfo(*args, **kwargs):
4537 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4538 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4539
4540 def GetAppName(*args, **kwargs):
4541 """
4542 GetAppName(self) -> String
4543
4544 Get the application name.
4545 """
4546 return _core_.PyApp_GetAppName(*args, **kwargs)
4547
4548 def SetAppName(*args, **kwargs):
4549 """
4550 SetAppName(self, String name)
4551
d6c14a4c
RD
4552 Set the application name. This value may be used automatically by
4553 `wx.Config` and such.
d55e5bfc
RD
4554 """
4555 return _core_.PyApp_SetAppName(*args, **kwargs)
4556
4557 def GetClassName(*args, **kwargs):
4558 """
4559 GetClassName(self) -> String
4560
4561 Get the application's class name.
4562 """
4563 return _core_.PyApp_GetClassName(*args, **kwargs)
4564
4565 def SetClassName(*args, **kwargs):
4566 """
4567 SetClassName(self, String name)
4568
d6c14a4c
RD
4569 Set the application's class name. This value may be used for
4570 X-resources if applicable for the platform
d55e5bfc
RD
4571 """
4572 return _core_.PyApp_SetClassName(*args, **kwargs)
4573
4574 def GetVendorName(*args, **kwargs):
4575 """
4576 GetVendorName(self) -> String
4577
4578 Get the application's vendor name.
4579 """
4580 return _core_.PyApp_GetVendorName(*args, **kwargs)
4581
4582 def SetVendorName(*args, **kwargs):
4583 """
4584 SetVendorName(self, String name)
4585
d6c14a4c
RD
4586 Set the application's vendor name. This value may be used
4587 automatically by `wx.Config` and such.
d55e5bfc
RD
4588 """
4589 return _core_.PyApp_SetVendorName(*args, **kwargs)
4590
4591 def GetTraits(*args, **kwargs):
4592 """
4593 GetTraits(self) -> wxAppTraits
4594
d6c14a4c
RD
4595 Return (and create if necessary) the app traits object to which we
4596 delegate for everything which either should be configurable by the
4597 user (then he can change the default behaviour simply by overriding
4598 CreateTraits() and returning his own traits object) or which is
4599 GUI/console dependent as then wx.AppTraits allows us to abstract the
4600 differences behind the common facade.
4601
4602 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
4603 """
4604 return _core_.PyApp_GetTraits(*args, **kwargs)
4605
4606 def ProcessPendingEvents(*args, **kwargs):
4607 """
4608 ProcessPendingEvents(self)
4609
d6c14a4c
RD
4610 Process all events in the Pending Events list -- it is necessary to
4611 call this function to process posted events. This normally happens
4612 during each event loop iteration.
d55e5bfc
RD
4613 """
4614 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
4615
4616 def Yield(*args, **kwargs):
4617 """
4618 Yield(self, bool onlyIfNeeded=False) -> bool
4619
d6c14a4c
RD
4620 Process all currently pending events right now, instead of waiting
4621 until return to the event loop. It is an error to call ``Yield``
4622 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 4623
d6c14a4c 4624 :warning: This function is dangerous as it can lead to unexpected
15817c7e
RD
4625 reentrancies (i.e. when called from an event handler it may
4626 result in calling the same event handler again), use with
4627 extreme care or, better, don't use at all!
d55e5bfc 4628
d6c14a4c 4629 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
15817c7e 4630
d55e5bfc
RD
4631 """
4632 return _core_.PyApp_Yield(*args, **kwargs)
4633
4634 def WakeUpIdle(*args, **kwargs):
4635 """
4636 WakeUpIdle(self)
4637
d6c14a4c
RD
4638 Make sure that idle events are sent again.
4639 :see: `wx.WakeUpIdle`
d55e5bfc
RD
4640 """
4641 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
4642
4643 def MainLoop(*args, **kwargs):
4644 """
4645 MainLoop(self) -> int
4646
d6c14a4c
RD
4647 Execute the main GUI loop, the function doesn't normally return until
4648 all top level windows have been closed and destroyed.
d55e5bfc
RD
4649 """
4650 return _core_.PyApp_MainLoop(*args, **kwargs)
4651
4652 def Exit(*args, **kwargs):
4653 """
4654 Exit(self)
4655
4656 Exit the main loop thus terminating the application.
d6c14a4c 4657 :see: `wx.Exit`
d55e5bfc
RD
4658 """
4659 return _core_.PyApp_Exit(*args, **kwargs)
4660
4661 def ExitMainLoop(*args, **kwargs):
4662 """
4663 ExitMainLoop(self)
4664
d6c14a4c
RD
4665 Exit the main GUI loop during the next iteration of the main
4666 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
4667 """
4668 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
4669
4670 def Pending(*args, **kwargs):
4671 """
4672 Pending(self) -> bool
4673
4674 Returns True if there are unprocessed events in the event queue.
4675 """
4676 return _core_.PyApp_Pending(*args, **kwargs)
4677
4678 def Dispatch(*args, **kwargs):
4679 """
4680 Dispatch(self) -> bool
4681
4682 Process the first event in the event queue (blocks until an event
4683 appears if there are none currently)
4684 """
4685 return _core_.PyApp_Dispatch(*args, **kwargs)
4686
4687 def ProcessIdle(*args, **kwargs):
4688 """
4689 ProcessIdle(self) -> bool
4690
d6c14a4c
RD
4691 Called from the MainLoop when the application becomes idle (there are
4692 no pending events) and sends a `wx.IdleEvent` to all interested
4693 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
4694 """
4695 return _core_.PyApp_ProcessIdle(*args, **kwargs)
4696
4697 def SendIdleEvents(*args, **kwargs):
4698 """
4699 SendIdleEvents(self, Window win, IdleEvent event) -> bool
4700
d6c14a4c
RD
4701 Send idle event to window and all subwindows. Returns True if more
4702 idle time is requested.
d55e5bfc
RD
4703 """
4704 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
4705
4706 def IsActive(*args, **kwargs):
4707 """
4708 IsActive(self) -> bool
4709
4710 Return True if our app has focus.
4711 """
4712 return _core_.PyApp_IsActive(*args, **kwargs)
4713
4714 def SetTopWindow(*args, **kwargs):
4715 """
4716 SetTopWindow(self, Window win)
4717
d6c14a4c 4718 Set the *main* top level window
d55e5bfc
RD
4719 """
4720 return _core_.PyApp_SetTopWindow(*args, **kwargs)
4721
4722 def GetTopWindow(*args, **kwargs):
4723 """
4724 GetTopWindow(self) -> Window
4725
d6c14a4c
RD
4726 Return the *main* top level window (if it hadn't been set previously
4727 with SetTopWindow(), will return just some top level window and, if
4728 there not any, will return None)
d55e5bfc
RD
4729 """
4730 return _core_.PyApp_GetTopWindow(*args, **kwargs)
4731
4732 def SetExitOnFrameDelete(*args, **kwargs):
4733 """
4734 SetExitOnFrameDelete(self, bool flag)
4735
d6c14a4c
RD
4736 Control the exit behaviour: by default, the program will exit the main
4737 loop (and so, usually, terminate) when the last top-level program
4738 window is deleted. Beware that if you disable this behaviour (with
4739 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4740 explicitly from somewhere.
d55e5bfc
RD
4741 """
4742 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
4743
4744 def GetExitOnFrameDelete(*args, **kwargs):
4745 """
4746 GetExitOnFrameDelete(self) -> bool
4747
4748 Get the current exit behaviour setting.
4749 """
4750 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
4751
4752 def SetUseBestVisual(*args, **kwargs):
4753 """
4754 SetUseBestVisual(self, bool flag)
4755
d6c14a4c
RD
4756 Set whether the app should try to use the best available visual on
4757 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
4758 """
4759 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
4760
4761 def GetUseBestVisual(*args, **kwargs):
4762 """
4763 GetUseBestVisual(self) -> bool
4764
4765 Get current UseBestVisual setting.
4766 """
4767 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
4768
4769 def SetPrintMode(*args, **kwargs):
4770 """SetPrintMode(self, int mode)"""
4771 return _core_.PyApp_SetPrintMode(*args, **kwargs)
4772
4773 def GetPrintMode(*args, **kwargs):
4774 """GetPrintMode(self) -> int"""
4775 return _core_.PyApp_GetPrintMode(*args, **kwargs)
4776
4777 def SetAssertMode(*args, **kwargs):
4778 """
4779 SetAssertMode(self, int mode)
4780
15817c7e 4781 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
4782 """
4783 return _core_.PyApp_SetAssertMode(*args, **kwargs)
4784
4785 def GetAssertMode(*args, **kwargs):
4786 """
4787 GetAssertMode(self) -> int
4788
4789 Get the current OnAssert behaviour setting.
4790 """
4791 return _core_.PyApp_GetAssertMode(*args, **kwargs)
4792
4793 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 4794 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
4795 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4796
4797 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4798 def GetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 4799 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
4800 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4801
4802 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4803 def GetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 4804 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
4805 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4806
4807 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4808 def GetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 4809 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
4810 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4811
4812 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4813 def GetMacHelpMenuTitleName(*args, **kwargs):
d6c14a4c 4814 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
4815 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4816
4817 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4818 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
d6c14a4c 4819 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
4820 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4821
4822 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4823 def SetMacAboutMenuItemId(*args, **kwargs):
d6c14a4c 4824 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
4825 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4826
4827 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4828 def SetMacPreferencesMenuItemId(*args, **kwargs):
d6c14a4c 4829 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
4830 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4831
4832 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4833 def SetMacExitMenuItemId(*args, **kwargs):
d6c14a4c 4834 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
4835 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4836
4837 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4838 def SetMacHelpMenuTitleName(*args, **kwargs):
d6c14a4c 4839 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
4840 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
4841
4842 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4843 def _BootstrapApp(*args, **kwargs):
4844 """
4845 _BootstrapApp(self)
4846
4847 For internal use only
4848 """
4849 return _core_.PyApp__BootstrapApp(*args, **kwargs)
4850
4851 def GetComCtl32Version(*args, **kwargs):
4852 """
d6c14a4c 4853 GetComCtl32Version() -> int
d55e5bfc 4854
d6c14a4c
RD
4855 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4856 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
4857 """
4858 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
4859
4860 GetComCtl32Version = staticmethod(GetComCtl32Version)
4861
4862class PyAppPtr(PyApp):
4863 def __init__(self, this):
4864 self.this = this
4865 if not hasattr(self,"thisown"): self.thisown = 0
4866 self.__class__ = PyApp
4867_core_.PyApp_swigregister(PyAppPtr)
4868
4869def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4870 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
4871 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4872
4873def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4874 """PyApp_GetMacAboutMenuItemId() -> long"""
4875 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4876
4877def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4878 """PyApp_GetMacPreferencesMenuItemId() -> long"""
4879 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4880
4881def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4882 """PyApp_GetMacExitMenuItemId() -> long"""
4883 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4884
4885def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
4886 """PyApp_GetMacHelpMenuTitleName() -> String"""
4887 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4888
4889def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4890 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
4891 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4892
4893def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
4894 """PyApp_SetMacAboutMenuItemId(long val)"""
4895 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4896
4897def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
4898 """PyApp_SetMacPreferencesMenuItemId(long val)"""
4899 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4900
4901def PyApp_SetMacExitMenuItemId(*args, **kwargs):
4902 """PyApp_SetMacExitMenuItemId(long val)"""
4903 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4904
4905def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
4906 """PyApp_SetMacHelpMenuTitleName(String val)"""
4907 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
4908
4909def PyApp_GetComCtl32Version(*args, **kwargs):
4910 """
4911 PyApp_GetComCtl32Version() -> int
4912
d6c14a4c
RD
4913 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4914 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
4915 """
4916 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
4917
4918#---------------------------------------------------------------------------
4919
4920
4921def Exit(*args, **kwargs):
4922 """
4923 Exit()
4924
4925 Force an exit of the application. Convenience for wx.GetApp().Exit()
4926 """
4927 return _core_.Exit(*args, **kwargs)
4928
4929def Yield(*args, **kwargs):
4930 """
4931 Yield() -> bool
4932
4933 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
4934 """
4935 return _core_.Yield(*args, **kwargs)
4936
4937def YieldIfNeeded(*args, **kwargs):
4938 """
4939 YieldIfNeeded() -> bool
4940
4941 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
4942 """
4943 return _core_.YieldIfNeeded(*args, **kwargs)
4944
4945def SafeYield(*args, **kwargs):
4946 """
4947 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
4948
d6c14a4c
RD
4949 This function is similar to `wx.Yield`, except that it disables the
4950 user input to all program windows before calling `wx.Yield` and
4951 re-enables it again afterwards. If ``win`` is not None, this window
4952 will remain enabled, allowing the implementation of some limited user
4953 interaction.
d55e5bfc 4954
d6c14a4c 4955 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
4956 """
4957 return _core_.SafeYield(*args, **kwargs)
4958
4959def WakeUpIdle(*args, **kwargs):
4960 """
4961 WakeUpIdle()
4962
d6c14a4c
RD
4963 Cause the message queue to become empty again, so idle events will be
4964 sent.
d55e5bfc
RD
4965 """
4966 return _core_.WakeUpIdle(*args, **kwargs)
4967
4968def PostEvent(*args, **kwargs):
4969 """
4970 PostEvent(EvtHandler dest, Event event)
4971
d6c14a4c
RD
4972 Send an event to a window or other wx.EvtHandler to be processed
4973 later.
d55e5bfc
RD
4974 """
4975 return _core_.PostEvent(*args, **kwargs)
4976
4977def App_CleanUp(*args, **kwargs):
4978 """
4979 App_CleanUp()
4980
15817c7e 4981 For internal use only, it is used to cleanup after wxWidgets when
d6c14a4c 4982 Python shuts down.
d55e5bfc
RD
4983 """
4984 return _core_.App_CleanUp(*args, **kwargs)
4985
4986def GetApp(*args, **kwargs):
4987 """
4988 GetApp() -> PyApp
4989
4990 Return a reference to the current wx.App object.
4991 """
4992 return _core_.GetApp(*args, **kwargs)
4993#----------------------------------------------------------------------
4994
4995class PyOnDemandOutputWindow:
4996 """
4997 A class that can be used for redirecting Python's stdout and
4998 stderr streams. It will do nothing until something is wrriten to
4999 the stream at which point it will create a Frame with a text area
5000 and write the text there.
5001 """
5002 def __init__(self, title = "wxPython: stdout/stderr"):
5003 self.frame = None
5004 self.title = title
5005 self.parent = None
5006
5007 def SetParent(self, parent):
5008 """Set the window to be used as the popup Frame's parent."""
5009 self.parent = parent
5010
5011
5012 def CreateOutputWindow(self, st):
5013 self.frame = wx.Frame(self.parent, -1, self.title,
5014 style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE)
5015 self.text = wx.TextCtrl(self.frame, -1, "",
5016 style = wx.TE_MULTILINE | wx.TE_READONLY)
5017 self.text.AppendText(st)
5018 self.frame.SetSize((450, 300))
5019 self.frame.Show(True)
5020 EVT_CLOSE(self.frame, self.OnCloseWindow)
5021
5022
5023 def OnCloseWindow(self, event):
5024 if self.frame is not None:
5025 self.frame.Destroy()
5026 self.frame = None
5027 self.text = None
5028
5029
5030 # These methods provide the file-like output behaviour.
5031 def write(self, text):
5032 """
5033 Create the output window if needed and write the string to it.
5034 If not called in the context of the gui thread then uses
5035 CallAfter to do the work there.
5036 """
5037 if self.frame is None:
5038 if not wx.Thread_IsMain():
5039 wx.CallAfter(self.CreateOutputWindow, text)
5040 else:
5041 self.CreateOutputWindow(text)
5042 else:
5043 if not wx.Thread_IsMain():
5044 wx.CallAfter(self.text.AppendText, text)
5045 else:
5046 self.text.AppendText(text)
5047
5048
5049 def close(self):
5050 if self.frame is not None:
5051 wx.CallAfter(self.frame.Close)
5052
5053
5054
5055#----------------------------------------------------------------------
5056
5057_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5058
5059class App(wx.PyApp):
5060 """
d6c14a4c
RD
5061 The ``wx.App`` class represents the application and is used to:
5062
5063 * bootstrap the wxPython system and initialize the underlying
5064 gui toolkit
5065 * set and get application-wide properties
5066 * implement the windowing system main message or event loop,
5067 and to dispatch events to window instances
5068 * etc.
5069
5070 Every application must have a ``wx.App`` instance, and all
5071 creation of UI objects should be delayed until after the
5072 ``wx.App`` object has been created in order to ensure that the gui
5073 platform and wxWidgets have been fully initialized.
5074
5075 Normally you would derive from this class and implement an
5076 ``OnInit`` method that creates a frame and then calls
5077 ``self.SetTopWindow(frame)``.
5078
5079 :see: `wx.PySimpleApp` for a simpler app class that can be used
15817c7e 5080 directly.
d55e5bfc 5081 """
d6c14a4c 5082
d55e5bfc
RD
5083 outputWindowClass = PyOnDemandOutputWindow
5084
d6c14a4c
RD
5085 def __init__(self, redirect=_defRedirect, filename=None,
5086 useBestVisual=False, clearSigInt=True):
5087 """
5088 Construct a ``wx.App`` object.
5089
5090 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5091 redirected? Defaults to True on Windows and Mac, False
5092 otherwise. If `filename` is None then output will be
5093 redirected to a window that pops up as needed. (You can
5094 control what kind of window is created for the output by
5095 resetting the class variable ``outputWindowClass`` to a
5096 class of your choosing.)
5097
5098 :param filename: The name of a file to redirect output to, if
5099 redirect is True.
5100
5101 :param useBestVisual: Should the app try to use the best
5102 available visual provided by the system (only relevant on
5103 systems that have more than one visual.) This parameter
5104 must be used instead of calling `SetUseBestVisual` later
5105 on because it must be set before the underlying GUI
5106 toolkit is initialized.
5107
5108 :param clearSigInt: Should SIGINT be cleared? This allows the
5109 app to terminate upon a Ctrl-C in the console like other
5110 GUI apps will.
5111
5112 :note: You should override OnInit to do applicaition
5113 initialization to ensure that the system, toolkit and
5114 wxWidgets are fully initialized.
5115 """
d55e5bfc
RD
5116 wx.PyApp.__init__(self)
5117
5118 if wx.Platform == "__WXMAC__":
5119 try:
5120 import MacOS
5121 if not MacOS.WMAvailable():
5122 print """\
5123This program needs access to the screen. Please run with 'pythonw',
5124not 'python', and only when you are logged in on the main display of
5125your Mac."""
5126 _sys.exit(1)
0346c964
RD
5127 except SystemExit:
5128 raise
d55e5bfc
RD
5129 except:
5130 pass
5131
5132 # This has to be done before OnInit
5133 self.SetUseBestVisual(useBestVisual)
5134
5135 # Set the default handler for SIGINT. This fixes a problem
5136 # where if Ctrl-C is pressed in the console that started this
5137 # app then it will not appear to do anything, (not even send
5138 # KeyboardInterrupt???) but will later segfault on exit. By
5139 # setting the default handler then the app will exit, as
5140 # expected (depending on platform.)
d6c14a4c
RD
5141 if clearSigInt:
5142 try:
5143 import signal
5144 signal.signal(signal.SIGINT, signal.SIG_DFL)
5145 except:
5146 pass
d55e5bfc
RD
5147
5148 # Save and redirect the stdio to a window?
5149 self.stdioWin = None
5150 self.saveStdio = (_sys.stdout, _sys.stderr)
5151 if redirect:
5152 self.RedirectStdio(filename)
5153
5154 # This finishes the initialization of wxWindows and then calls
5155 # the OnInit that should be present in the derived class
5156 self._BootstrapApp()
5157
5158
5159 def __del__(self):
5160 try:
5161 self.RestoreStdio() # Just in case the MainLoop was overridden
5162 except:
5163 pass
5164
5165
5166 def SetTopWindow(self, frame):
5167 """Set the \"main\" top level window"""
5168 if self.stdioWin:
5169 self.stdioWin.SetParent(frame)
5170 wx.PyApp.SetTopWindow(self, frame)
5171
5172
5173 def MainLoop(self):
5174 """Execute the main GUI event loop"""
5175 wx.PyApp.MainLoop(self)
5176 self.RestoreStdio()
5177
5178
5179 def RedirectStdio(self, filename=None):
5180 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5181 if filename:
5182 _sys.stdout = _sys.stderr = open(filename, 'a')
5183 else:
5184 self.stdioWin = self.outputWindowClass()
5185 _sys.stdout = _sys.stderr = self.stdioWin
5186
5187
5188 def RestoreStdio(self):
5189 _sys.stdout, _sys.stderr = self.saveStdio
5190
5191
5192
d6c14a4c 5193# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
5194App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5195App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5196App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5197App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5198App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5199App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5200App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5201App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5202App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5203App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5204App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5205
5206#----------------------------------------------------------------------------
5207
5208class PySimpleApp(wx.App):
5209 """
5210 A simple application class. You can just create one of these and
5211 then then make your top level windows later, and not have to worry
d6c14a4c 5212 about OnInit. For example::
d55e5bfc 5213
d6c14a4c
RD
5214 app = wx.PySimpleApp()
5215 frame = wx.Frame(None, title='Hello World')
5216 frame.Show()
5217 app.MainLoop()
5218
5219 :see: `wx.App`
5220 """
5221
5222 def __init__(self, redirect=False, filename=None,
5223 useBestVisual=False, clearSigInt=True):
5224 """
5225 :see: `wx.App.__init__`
5226 """
5227 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
5228
5229 def OnInit(self):
d55e5bfc
RD
5230 return True
5231
5232
d6c14a4c 5233
d55e5bfc
RD
5234# Is anybody using this one?
5235class PyWidgetTester(wx.App):
5236 def __init__(self, size = (250, 100)):
5237 self.size = size
5238 wx.App.__init__(self, 0)
5239
5240 def OnInit(self):
5241 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5242 self.SetTopWindow(self.frame)
5243 return True
5244
d6c14a4c
RD
5245 def SetWidget(self, widgetClass, *args, **kwargs):
5246 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
5247 self.frame.Show(True)
5248
5249#----------------------------------------------------------------------------
5250# DO NOT hold any other references to this object. This is how we
d6c14a4c 5251# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5252# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
d6c14a4c 5253# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
5254
5255class __wxPyCleanup:
5256 def __init__(self):
5257 self.cleanup = _core_.App_CleanUp
5258 def __del__(self):
5259 self.cleanup()
5260
5261_sys.__wxPythonCleanup = __wxPyCleanup()
5262
5263## # another possible solution, but it gets called too early...
d6c14a4c
RD
5264## import atexit
5265## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
5266
5267
5268#----------------------------------------------------------------------------
5269
5270#---------------------------------------------------------------------------
5271
5272class AcceleratorEntry(object):
d6c14a4c
RD
5273 """
5274 A class used to define items in an `wx.AcceleratorTable`. wxPython
5275 programs can choose to use wx.AcceleratorEntry objects, but using a
5276 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
15817c7e 5277 as well. See `__init__` for of the tuple values.
d6c14a4c
RD
5278
5279 :see: `wx.AcceleratorTable`
5280 """
d55e5bfc
RD
5281 def __repr__(self):
5282 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5283 def __init__(self, *args, **kwargs):
d6c14a4c
RD
5284 """
5285 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5286
5287 Construct a wx.AcceleratorEntry.
d6c14a4c 5288 """
d55e5bfc
RD
5289 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5290 self.this = newobj.this
5291 self.thisown = 1
5292 del newobj.thisown
5293 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5294 """__del__(self)"""
5295 try:
5296 if self.thisown: destroy(self)
5297 except: pass
5298
5299 def Set(*args, **kwargs):
d6c14a4c
RD
5300 """
5301 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5302
d6c14a4c
RD
5303 (Re)set the attributes of a wx.AcceleratorEntry.
5304 :see `__init__`
5305 """
5306 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
5307
5308 def GetFlags(*args, **kwargs):
d6c14a4c
RD
5309 """
5310 GetFlags(self) -> int
5311
5312 Get the AcceleratorEntry's flags.
5313 """
d55e5bfc
RD
5314 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5315
5316 def GetKeyCode(*args, **kwargs):
d6c14a4c
RD
5317 """
5318 GetKeyCode(self) -> int
5319
5320 Get the AcceleratorEntry's keycode.
5321 """
d55e5bfc
RD
5322 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5323
5324 def GetCommand(*args, **kwargs):
d6c14a4c
RD
5325 """
5326 GetCommand(self) -> int
5327
5328 Get the AcceleratorEntry's command ID.
5329 """
d55e5bfc
RD
5330 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5331
5332
5333class AcceleratorEntryPtr(AcceleratorEntry):
5334 def __init__(self, this):
5335 self.this = this
5336 if not hasattr(self,"thisown"): self.thisown = 0
5337 self.__class__ = AcceleratorEntry
5338_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5339
5340class AcceleratorTable(Object):
d6c14a4c
RD
5341 """
5342 An accelerator table allows the application to specify a table of
5343 keyboard shortcuts for menus or other commands. On Windows, menu or
5344 button commands are supported; on GTK, only menu commands are
5345 supported.
d6c14a4c 5346 """
d55e5bfc
RD
5347 def __repr__(self):
5348 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5349 def __init__(self, *args, **kwargs):
5350 """
5351 __init__(entries) -> AcceleratorTable
5352
d6c14a4c
RD
5353 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5354 items or or of 3-tuples (flags, keyCode, cmdID)
5355
5356 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
5357 """
5358 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5359 self.this = newobj.this
5360 self.thisown = 1
5361 del newobj.thisown
5362 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5363 """__del__(self)"""
5364 try:
5365 if self.thisown: destroy(self)
5366 except: pass
5367
5368 def Ok(*args, **kwargs):
5369 """Ok(self) -> bool"""
5370 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5371
5372
5373class AcceleratorTablePtr(AcceleratorTable):
5374 def __init__(self, this):
5375 self.this = this
5376 if not hasattr(self,"thisown"): self.thisown = 0
5377 self.__class__ = AcceleratorTable
5378_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5379
5380
5381def GetAccelFromString(*args, **kwargs):
5382 """GetAccelFromString(String label) -> AcceleratorEntry"""
5383 return _core_.GetAccelFromString(*args, **kwargs)
5384#---------------------------------------------------------------------------
5385
5386class VisualAttributes(object):
5387 """struct containing all the visual attributes of a control"""
5388 def __repr__(self):
5389 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5390 def __init__(self, *args, **kwargs):
5391 """
5392 __init__(self) -> VisualAttributes
5393
5394 struct containing all the visual attributes of a control
5395 """
5396 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5397 self.this = newobj.this
5398 self.thisown = 1
5399 del newobj.thisown
5400 def __del__(self, destroy=_core_.delete_VisualAttributes):
5401 """__del__(self)"""
5402 try:
5403 if self.thisown: destroy(self)
5404 except: pass
5405
5406 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5407 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5408 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5409
5410class VisualAttributesPtr(VisualAttributes):
5411 def __init__(self, this):
5412 self.this = this
5413 if not hasattr(self,"thisown"): self.thisown = 0
5414 self.__class__ = VisualAttributes
5415_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5416NullAcceleratorTable = cvar.NullAcceleratorTable
5417PanelNameStr = cvar.PanelNameStr
5418
5419WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5420WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5421WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5422WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5423WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5424class Window(EvtHandler):
5425 """
5426 wx.Window is the base class for all windows and represents any visible
5427 object on the screen. All controls, top level windows and so on are
5428 wx.Windows. Sizers and device contexts are not however, as they don't
5429 appear on screen themselves.
5430
5431 """
5432 def __repr__(self):
5433 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5434 def __init__(self, *args, **kwargs):
5435 """
5436 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5437 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5438
5439 Construct and show a generic Window.
5440 """
5441 newobj = _core_.new_Window(*args, **kwargs)
5442 self.this = newobj.this
5443 self.thisown = 1
5444 del newobj.thisown
5445 self._setOORInfo(self)
5446
5447 def Create(*args, **kwargs):
5448 """
5449 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5450 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
5451
5452 Create the GUI part of the Window for 2-phase creation mode.
5453 """
5454 return _core_.Window_Create(*args, **kwargs)
5455
5456 def Close(*args, **kwargs):
5457 """
5458 Close(self, bool force=False) -> bool
5459
5460 This function simply generates a EVT_CLOSE event whose handler usually
5461 tries to close the window. It doesn't close the window itself,
5462 however. If force is False (the default) then the window's close
5463 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
5464 """
5465 return _core_.Window_Close(*args, **kwargs)
5466
5467 def Destroy(*args, **kwargs):
5468 """
5469 Destroy(self) -> bool
5470
5471 Destroys the window safely. Frames and dialogs are not destroyed
5472 immediately when this function is called -- they are added to a list
5473 of windows to be deleted on idle time, when all the window's events
5474 have been processed. This prevents problems with events being sent to
5475 non-existent windows.
5476
5477 Returns True if the window has either been successfully deleted, or it
5478 has been added to the list of windows pending real deletion.
5479 """
5480 return _core_.Window_Destroy(*args, **kwargs)
5481
5482 def DestroyChildren(*args, **kwargs):
5483 """
5484 DestroyChildren(self) -> bool
5485
15817c7e
RD
5486 Destroys all children of a window. Called automatically by the
5487 destructor.
d55e5bfc
RD
5488 """
5489 return _core_.Window_DestroyChildren(*args, **kwargs)
5490
5491 def IsBeingDeleted(*args, **kwargs):
5492 """
5493 IsBeingDeleted(self) -> bool
5494
5495 Is the window in the process of being deleted?
5496 """
5497 return _core_.Window_IsBeingDeleted(*args, **kwargs)
5498
5499 def SetTitle(*args, **kwargs):
5500 """
5501 SetTitle(self, String title)
5502
5503 Sets the window's title. Applicable only to frames and dialogs.
5504 """
5505 return _core_.Window_SetTitle(*args, **kwargs)
5506
5507 def GetTitle(*args, **kwargs):
5508 """
5509 GetTitle(self) -> String
5510
5511 Gets the window's title. Applicable only to frames and dialogs.
5512 """
5513 return _core_.Window_GetTitle(*args, **kwargs)
5514
5515 def SetLabel(*args, **kwargs):
5516 """
5517 SetLabel(self, String label)
5518
5519 Set the text which the window shows in its label if applicable.
5520 """
5521 return _core_.Window_SetLabel(*args, **kwargs)
5522
5523 def GetLabel(*args, **kwargs):
5524 """
5525 GetLabel(self) -> String
5526
15817c7e
RD
5527 Generic way of getting a label from any window, for identification
5528 purposes. The interpretation of this function differs from class to
5529 class. For frames and dialogs, the value returned is the title. For
5530 buttons or static text controls, it is the button text. This function
5531 can be useful for meta-programs such as testing tools or special-needs
5532 access programs)which need to identify windows by name.
d55e5bfc
RD
5533 """
5534 return _core_.Window_GetLabel(*args, **kwargs)
5535
5536 def SetName(*args, **kwargs):
5537 """
5538 SetName(self, String name)
5539
15817c7e
RD
5540 Sets the window's name. The window name is used for ressource setting
5541 in X, it is not the same as the window title/label
d55e5bfc
RD
5542 """
5543 return _core_.Window_SetName(*args, **kwargs)
5544
5545 def GetName(*args, **kwargs):
5546 """
5547 GetName(self) -> String
5548
15817c7e
RD
5549 Returns the windows name. This name is not guaranteed to be unique;
5550 it is up to the programmer to supply an appropriate name in the window
5551 constructor or via wx.Window.SetName.
d55e5bfc
RD
5552 """
5553 return _core_.Window_GetName(*args, **kwargs)
5554
5555 def SetWindowVariant(*args, **kwargs):
5556 """
5557 SetWindowVariant(self, int variant)
5558
15817c7e
RD
5559 Sets the variant of the window/font size to use for this window, if
5560 the platform supports variants, for example, wxMac.
d55e5bfc
RD
5561 """
5562 return _core_.Window_SetWindowVariant(*args, **kwargs)
5563
5564 def GetWindowVariant(*args, **kwargs):
5565 """GetWindowVariant(self) -> int"""
5566 return _core_.Window_GetWindowVariant(*args, **kwargs)
5567
5568 def SetId(*args, **kwargs):
5569 """
5570 SetId(self, int winid)
5571
5572 Sets the identifier of the window. Each window has an integer
5573 identifier. If the application has not provided one, an identifier
5574 will be generated. Normally, the identifier should be provided on
5575 creation and should not be modified subsequently.
5576 """
5577 return _core_.Window_SetId(*args, **kwargs)
5578
5579 def GetId(*args, **kwargs):
5580 """
5581 GetId(self) -> int
5582
5583 Returns the identifier of the window. Each window has an integer
5584 identifier. If the application has not provided one (or the default Id
5585 -1 is used) then an unique identifier with a negative value will be
5586 generated.
5587 """
5588 return _core_.Window_GetId(*args, **kwargs)
5589
5590 def NewControlId(*args, **kwargs):
5591 """
d6c14a4c 5592 NewControlId() -> int
d55e5bfc
RD
5593
5594 Generate a control id for the controls which were not given one.
5595 """
5596 return _core_.Window_NewControlId(*args, **kwargs)
5597
5598 NewControlId = staticmethod(NewControlId)
5599 def NextControlId(*args, **kwargs):
5600 """
d6c14a4c 5601 NextControlId(int winid) -> int
d55e5bfc
RD
5602
5603 Get the id of the control following the one with the given
15817c7e 5604 autogenerated) id
d55e5bfc
RD
5605 """
5606 return _core_.Window_NextControlId(*args, **kwargs)
5607
5608 NextControlId = staticmethod(NextControlId)
5609 def PrevControlId(*args, **kwargs):
5610 """
d6c14a4c 5611 PrevControlId(int winid) -> int
d55e5bfc
RD
5612
5613 Get the id of the control preceding the one with the given
15817c7e 5614 autogenerated) id
d55e5bfc
RD
5615 """
5616 return _core_.Window_PrevControlId(*args, **kwargs)
5617
5618 PrevControlId = staticmethod(PrevControlId)
5619 def SetSize(*args, **kwargs):
5620 """
5621 SetSize(self, Size size)
5622
5623 Sets the size of the window in pixels.
5624 """
5625 return _core_.Window_SetSize(*args, **kwargs)
5626
5627 def SetDimensions(*args, **kwargs):
5628 """
5629 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
5630
5631 Sets the position and size of the window in pixels. The sizeFlags
5632 parameter indicates the interpretation of the other params if they are
5633 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5634 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5635 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5636 dimensions of -1 and less to be interpreted as real dimensions, not
5637 default values.
5638 """
5639 return _core_.Window_SetDimensions(*args, **kwargs)
5640
5641 def SetRect(*args, **kwargs):
5642 """
5643 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
5644
5645 Sets the position and size of the window in pixels using a wx.Rect.
5646 """
5647 return _core_.Window_SetRect(*args, **kwargs)
5648
5649 def SetSizeWH(*args, **kwargs):
5650 """
5651 SetSizeWH(self, int width, int height)
5652
5653 Sets the size of the window in pixels.
5654 """
5655 return _core_.Window_SetSizeWH(*args, **kwargs)
5656
5657 def Move(*args, **kwargs):
5658 """
5659 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
5660
5661 Moves the window to the given position.
5662 """
5663 return _core_.Window_Move(*args, **kwargs)
5664
5665 SetPosition = Move
5666 def MoveXY(*args, **kwargs):
5667 """
5668 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
5669
5670 Moves the window to the given position.
5671 """
5672 return _core_.Window_MoveXY(*args, **kwargs)
5673
f8167d6e
RD
5674 def SetBestFittingSize(*args, **kwargs):
5675 """
5676 SetBestFittingSize(self, Size size=DefaultSize)
5677
5678 A 'Smart' SetSize that will fill in default size components with the
5679 window's *best size* values. Also set's the minsize for use with sizers.
5680 """
5681 return _core_.Window_SetBestFittingSize(*args, **kwargs)
5682
d55e5bfc
RD
5683 def Raise(*args, **kwargs):
5684 """
5685 Raise(self)
5686
5687 Raises the window to the top of the window hierarchy if it is a
5688 managed window (dialog or frame).
5689 """
5690 return _core_.Window_Raise(*args, **kwargs)
5691
5692 def Lower(*args, **kwargs):
5693 """
5694 Lower(self)
5695
5696 Lowers the window to the bottom of the window hierarchy if it is a
5697 managed window (dialog or frame).
5698 """
5699 return _core_.Window_Lower(*args, **kwargs)
5700
5701 def SetClientSize(*args, **kwargs):
5702 """
5703 SetClientSize(self, Size size)
5704
5705 This sets the size of the window client area in pixels. Using this
5706 function to size a window tends to be more device-independent than
5707 wx.Window.SetSize, since the application need not worry about what
5708 dimensions the border or title bar have when trying to fit the window
5709 around panel items, for example.
5710 """
5711 return _core_.Window_SetClientSize(*args, **kwargs)
5712
5713 def SetClientSizeWH(*args, **kwargs):
5714 """
5715 SetClientSizeWH(self, int width, int height)
5716
5717 This sets the size of the window client area in pixels. Using this
5718 function to size a window tends to be more device-independent than
5719 wx.Window.SetSize, since the application need not worry about what
5720 dimensions the border or title bar have when trying to fit the window
5721 around panel items, for example.
5722 """
5723 return _core_.Window_SetClientSizeWH(*args, **kwargs)
5724
5725 def SetClientRect(*args, **kwargs):
5726 """
5727 SetClientRect(self, Rect rect)
5728
5729 This sets the size of the window client area in pixels. Using this
5730 function to size a window tends to be more device-independent than
5731 wx.Window.SetSize, since the application need not worry about what
5732 dimensions the border or title bar have when trying to fit the window
5733 around panel items, for example.
5734 """
5735 return _core_.Window_SetClientRect(*args, **kwargs)
5736
5737 def GetPosition(*args, **kwargs):
5738 """
5739 GetPosition(self) -> Point
5740
5741 Get the window's position.
5742 """
5743 return _core_.Window_GetPosition(*args, **kwargs)
5744
5745 def GetPositionTuple(*args, **kwargs):
5746 """
5747 GetPositionTuple() -> (x,y)
5748
5749 Get the window's position.
5750 """
5751 return _core_.Window_GetPositionTuple(*args, **kwargs)
5752
5753 def GetSize(*args, **kwargs):
5754 """
5755 GetSize(self) -> Size
5756
5757 Get the window size.
5758 """
5759 return _core_.Window_GetSize(*args, **kwargs)
5760
5761 def GetSizeTuple(*args, **kwargs):
5762 """
5763 GetSizeTuple() -> (width, height)
5764
5765 Get the window size.
5766 """
5767 return _core_.Window_GetSizeTuple(*args, **kwargs)
5768
5769 def GetRect(*args, **kwargs):
5770 """
5771 GetRect(self) -> Rect
5772
5773 Returns the size and position of the window as a wx.Rect object.
5774 """
5775 return _core_.Window_GetRect(*args, **kwargs)
5776
5777 def GetClientSize(*args, **kwargs):
5778 """
5779 GetClientSize(self) -> Size
5780
5781 This gets the size of the window's 'client area' in pixels. The client
5782 area is the area which may be drawn on by the programmer, excluding
5783 title bar, border, scrollbars, etc.
5784 """
5785 return _core_.Window_GetClientSize(*args, **kwargs)
5786
5787 def GetClientSizeTuple(*args, **kwargs):
5788 """
5789 GetClientSizeTuple() -> (width, height)
5790
5791 This gets the size of the window's 'client area' in pixels. The client
5792 area is the area which may be drawn on by the programmer, excluding
5793 title bar, border, scrollbars, etc.
5794 """
5795 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
5796
5797 def GetClientAreaOrigin(*args, **kwargs):
5798 """
5799 GetClientAreaOrigin(self) -> Point
5800
5801 Get the origin of the client area of the window relative to the
5802 window's top left corner (the client area may be shifted because of
5803 the borders, scrollbars, other decorations...)
5804 """
5805 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
5806
5807 def GetClientRect(*args, **kwargs):
5808 """
5809 GetClientRect(self) -> Rect
5810
0439c23b 5811 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
5812 """
5813 return _core_.Window_GetClientRect(*args, **kwargs)
5814
5815 def GetBestSize(*args, **kwargs):
5816 """
5817 GetBestSize(self) -> Size
5818
bfddbb17 5819 This function returns the best acceptable minimal size for the
15817c7e
RD
5820 window, if applicable. For example, for a static text control, it will
5821 be the minimal size such that the control label is not truncated. For
5822 windows containing subwindows (suzh aswx.Panel), the size returned by
5823 this function will be the same as the size the window would have had
5824 after calling Fit.
d55e5bfc
RD
5825 """
5826 return _core_.Window_GetBestSize(*args, **kwargs)
5827
5828 def GetBestSizeTuple(*args, **kwargs):
5829 """
5830 GetBestSizeTuple() -> (width, height)
5831
bfddbb17 5832 This function returns the best acceptable minimal size for the
15817c7e
RD
5833 window, if applicable. For example, for a static text control, it will
5834 be the minimal size such that the control label is not truncated. For
5835 windows containing subwindows (suzh aswx.Panel), the size returned by
5836 this function will be the same as the size the window would have had
5837 after calling Fit.
d55e5bfc
RD
5838 """
5839 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
5840
5841 def GetAdjustedBestSize(*args, **kwargs):
5842 """
5843 GetAdjustedBestSize(self) -> Size
5844
5845 This method is similar to GetBestSize, except in one
5846 thing. GetBestSize should return the minimum untruncated size of the
5847 window, while this method will return the largest of BestSize and any
5848 user specified minimum size. ie. it is the minimum size the window
5849 should currently be drawn at, not the minimal size it can possibly
5850 tolerate.
5851 """
5852 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
5853
5854 def Center(*args, **kwargs):
5855 """
5856 Center(self, int direction=BOTH)
5857
5858 Centers the window. The parameter specifies the direction for
5859 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
5860 also include wx.CENTER_ON_SCREEN flag if you want to center the window
5861 on the entire screen and not on its parent window. If it is a
5862 top-level window and has no parent then it will always be centered
5863 relative to the screen.
5864 """
5865 return _core_.Window_Center(*args, **kwargs)
5866
5867 Centre = Center
5868 def CenterOnScreen(*args, **kwargs):
5869 """
5870 CenterOnScreen(self, int dir=BOTH)
5871
5872 Center on screen (only works for top level windows)
5873 """
5874 return _core_.Window_CenterOnScreen(*args, **kwargs)
5875
5876 CentreOnScreen = CenterOnScreen
5877 def CenterOnParent(*args, **kwargs):
5878 """
5879 CenterOnParent(self, int dir=BOTH)
5880
5881 Center with respect to the the parent window
5882 """
5883 return _core_.Window_CenterOnParent(*args, **kwargs)
5884
5885 CentreOnParent = CenterOnParent
5886 def Fit(*args, **kwargs):
5887 """
5888 Fit(self)
5889
5890 Sizes the window so that it fits around its subwindows. This function
5891 won't do anything if there are no subwindows and will only really work
5892 correctly if sizers are used for the subwindows layout. Also, if the
5893 window has exactly one subwindow it is better (faster and the result
5894 is more precise as Fit adds some margin to account for fuzziness of
5895 its calculations) to call window.SetClientSize(child.GetSize())
5896 instead of calling Fit.
5897 """
5898 return _core_.Window_Fit(*args, **kwargs)
5899
5900 def FitInside(*args, **kwargs):
5901 """
5902 FitInside(self)
5903
5904 Similar to Fit, but sizes the interior (virtual) size of a
5905 window. Mainly useful with scrolled windows to reset scrollbars after
5906 sizing changes that do not trigger a size event, and/or scrolled
5907 windows without an interior sizer. This function similarly won't do
5908 anything if there are no subwindows.
5909 """
5910 return _core_.Window_FitInside(*args, **kwargs)
5911
5912 def SetSizeHints(*args):
5913 """
908b74cd 5914 SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
d55e5bfc
RD
5915 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
5916 int incH=-1)
d55e5bfc
RD
5917
5918 Allows specification of minimum and maximum window sizes, and window
5919 size increments. If a pair of values is not set (or set to -1), the
5920 default values will be used. If this function is called, the user
908b74cd
RD
5921 will not be able to size the window outside the given bounds (if it is
5922 a top-level window.) Sizers will also inspect the minimum window size
5923 and will use that value if set when calculating layout.
5924
5925 The resizing increments are only significant under Motif or Xt.
d55e5bfc
RD
5926 """
5927 return _core_.Window_SetSizeHints(*args)
5928
5929 def SetVirtualSizeHints(*args):
5930 """
d55e5bfc 5931 SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
908b74cd 5932 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
5933
5934 Allows specification of minimum and maximum virtual window sizes. If a
5935 pair of values is not set (or set to -1), the default values will be
5936 used. If this function is called, the user will not be able to size
5937 the virtual area of the window outside the given bounds.
5938 """
5939 return _core_.Window_SetVirtualSizeHints(*args)
5940
908b74cd
RD
5941 def GetMaxSize(*args, **kwargs):
5942 """GetMaxSize(self) -> Size"""
5943 return _core_.Window_GetMaxSize(*args, **kwargs)
5944
5945 def GetMinSize(*args, **kwargs):
5946 """GetMinSize(self) -> Size"""
5947 return _core_.Window_GetMinSize(*args, **kwargs)
5948
5949 def SetMinSize(*args, **kwargs):
5950 """
5951 SetMinSize(self, Size minSize)
5952
5953 A more convenient method than `SetSizeHints` for setting just the
5954 min size.
5955 """
5956 return _core_.Window_SetMinSize(*args, **kwargs)
5957
5958 def SetMaxSize(*args, **kwargs):
5959 """
5960 SetMaxSize(self, Size maxSize)
5961
5962 A more convenient method than `SetSizeHints` for setting just the
5963 max size.
5964 """
5965 return _core_.Window_SetMaxSize(*args, **kwargs)
5966
d55e5bfc
RD
5967 def GetMinWidth(*args, **kwargs):
5968 """GetMinWidth(self) -> int"""
5969 return _core_.Window_GetMinWidth(*args, **kwargs)
5970
5971 def GetMinHeight(*args, **kwargs):
5972 """GetMinHeight(self) -> int"""
5973 return _core_.Window_GetMinHeight(*args, **kwargs)
5974
5975 def GetMaxWidth(*args, **kwargs):
5976 """GetMaxWidth(self) -> int"""
5977 return _core_.Window_GetMaxWidth(*args, **kwargs)
5978
5979 def GetMaxHeight(*args, **kwargs):
5980 """GetMaxHeight(self) -> int"""
5981 return _core_.Window_GetMaxHeight(*args, **kwargs)
5982
d55e5bfc
RD
5983 def SetVirtualSize(*args, **kwargs):
5984 """
5985 SetVirtualSize(self, Size size)
5986
5987 Set the the virtual size of a window in pixels. For most windows this
5988 is just the client area of the window, but for some like scrolled
5989 windows it is more or less independent of the screen window size.
5990 """
5991 return _core_.Window_SetVirtualSize(*args, **kwargs)
5992
5993 def SetVirtualSizeWH(*args, **kwargs):
5994 """
5995 SetVirtualSizeWH(self, int w, int h)
5996
5997 Set the the virtual size of a window in pixels. For most windows this
5998 is just the client area of the window, but for some like scrolled
5999 windows it is more or less independent of the screen window size.
6000 """
6001 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6002
6003 def GetVirtualSize(*args, **kwargs):
6004 """
6005 GetVirtualSize(self) -> Size
6006
6007 Get the the virtual size of the window in pixels. For most windows
6008 this is just the client area of the window, but for some like scrolled
6009 windows it is more or less independent of the screen window size.
6010 """
6011 return _core_.Window_GetVirtualSize(*args, **kwargs)
6012
6013 def GetVirtualSizeTuple(*args, **kwargs):
6014 """
6015 GetVirtualSizeTuple() -> (width, height)
6016
6017 Get the the virtual size of the window in pixels. For most windows
6018 this is just the client area of the window, but for some like scrolled
6019 windows it is more or less independent of the screen window size.
6020 """
6021 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6022
6023 def GetBestVirtualSize(*args, **kwargs):
6024 """
6025 GetBestVirtualSize(self) -> Size
6026
6027 Return the largest of ClientSize and BestSize (as determined by a
6028 sizer, interior children, or other means)
6029 """
6030 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6031
6032 def Show(*args, **kwargs):
6033 """
6034 Show(self, bool show=True) -> bool
6035
6036 Shows or hides the window. You may need to call Raise for a top level
6037 window if you want to bring it to top, although this is not needed if
6038 Show is called immediately after the frame creation. Returns True if
6039 the window has been shown or hidden or False if nothing was done
6040 because it already was in the requested state.
6041 """
6042 return _core_.Window_Show(*args, **kwargs)
6043
6044 def Hide(*args, **kwargs):
6045 """
6046 Hide(self) -> bool
6047
6048 Equivalent to calling Show(False).
6049 """
6050 return _core_.Window_Hide(*args, **kwargs)
6051
6052 def Enable(*args, **kwargs):
6053 """
6054 Enable(self, bool enable=True) -> bool
6055
6056 Enable or disable the window for user input. Note that when a parent
6057 window is disabled, all of its children are disabled as well and they
6058 are reenabled again when the parent is. Returns true if the window
6059 has been enabled or disabled, false if nothing was done, i.e. if the
6060 window had already been in the specified state.
6061 """
6062 return _core_.Window_Enable(*args, **kwargs)
6063
6064 def Disable(*args, **kwargs):
6065 """
6066 Disable(self) -> bool
6067
6068 Disables the window, same as Enable(false).
6069 """
6070 return _core_.Window_Disable(*args, **kwargs)
6071
6072 def IsShown(*args, **kwargs):
6073 """
6074 IsShown(self) -> bool
6075
6076 Returns true if the window is shown, false if it has been hidden.
6077 """
6078 return _core_.Window_IsShown(*args, **kwargs)
6079
6080 def IsEnabled(*args, **kwargs):
6081 """
6082 IsEnabled(self) -> bool
6083
6084 Returns true if the window is enabled for input, false otherwise.
6085 """
6086 return _core_.Window_IsEnabled(*args, **kwargs)
6087
6088 def SetWindowStyleFlag(*args, **kwargs):
6089 """
6090 SetWindowStyleFlag(self, long style)
6091
15817c7e
RD
6092 Sets the style of the window. Please note that some styles cannot be
6093 changed after the window creation and that Refresh() might need to be
6094 called after changing the others for the change to take place
6095 immediately.
d55e5bfc
RD
6096 """
6097 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6098
6099 def GetWindowStyleFlag(*args, **kwargs):
6100 """
6101 GetWindowStyleFlag(self) -> long
6102
6103 Gets the window style that was passed to the constructor or Create
6104 method.
6105 """
6106 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6107
6108 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6109 def HasFlag(*args, **kwargs):
6110 """
6111 HasFlag(self, int flag) -> bool
6112
6113 Test if the given style is set for this window.
6114 """
6115 return _core_.Window_HasFlag(*args, **kwargs)
6116
6117 def IsRetained(*args, **kwargs):
6118 """
6119 IsRetained(self) -> bool
6120
6121 Returns true if the window is retained, false otherwise. Retained
6122 windows are only available on X platforms.
6123 """
6124 return _core_.Window_IsRetained(*args, **kwargs)
6125
6126 def SetExtraStyle(*args, **kwargs):
6127 """
6128 SetExtraStyle(self, long exStyle)
6129
6130 Sets the extra style bits for the window. Extra styles are the less
6131 often used style bits which can't be set with the constructor or with
6132 SetWindowStyleFlag()
6133 """
6134 return _core_.Window_SetExtraStyle(*args, **kwargs)
6135
6136 def GetExtraStyle(*args, **kwargs):
6137 """
6138 GetExtraStyle(self) -> long
6139
6140 Returns the extra style bits for the window.
6141 """
6142 return _core_.Window_GetExtraStyle(*args, **kwargs)
6143
6144 def MakeModal(*args, **kwargs):
6145 """
6146 MakeModal(self, bool modal=True)
6147
6148 Disables all other windows in the application so that the user can
6149 only interact with this window. Passing False will reverse this
6150 effect.
6151 """
6152 return _core_.Window_MakeModal(*args, **kwargs)
6153
6154 def SetThemeEnabled(*args, **kwargs):
6155 """
6156 SetThemeEnabled(self, bool enableTheme)
6157
6158 This function tells a window if it should use the system's "theme"
6159 code to draw the windows' background instead if its own background
6160 drawing code. This will only have an effect on platforms that support
6161 the notion of themes in user defined windows. One such platform is
6162 GTK+ where windows can have (very colourful) backgrounds defined by a
6163 user's selected theme.
6164
6165 Dialogs, notebook pages and the status bar have this flag set to true
6166 by default so that the default look and feel is simulated best.
6167 """
6168 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6169
6170 def GetThemeEnabled(*args, **kwargs):
6171 """
6172 GetThemeEnabled(self) -> bool
6173
6174 Return the themeEnabled flag.
6175 """
6176 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6177
6178 def SetFocus(*args, **kwargs):
6179 """
6180 SetFocus(self)
6181
6182 Set's the focus to this window, allowing it to receive keyboard input.
6183 """
6184 return _core_.Window_SetFocus(*args, **kwargs)
6185
6186 def SetFocusFromKbd(*args, **kwargs):
6187 """
6188 SetFocusFromKbd(self)
6189
6190 Set focus to this window as the result of a keyboard action. Normally
6191 only called internally.
6192 """
6193 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6194
6195 def FindFocus(*args, **kwargs):
6196 """
d6c14a4c 6197 FindFocus() -> Window
d55e5bfc
RD
6198
6199 Returns the window or control that currently has the keyboard focus,
6200 or None.
6201 """
6202 return _core_.Window_FindFocus(*args, **kwargs)
6203
6204 FindFocus = staticmethod(FindFocus)
6205 def AcceptsFocus(*args, **kwargs):
6206 """
6207 AcceptsFocus(self) -> bool
6208
6209 Can this window have focus?
6210 """
6211 return _core_.Window_AcceptsFocus(*args, **kwargs)
6212
6213 def AcceptsFocusFromKeyboard(*args, **kwargs):
6214 """
6215 AcceptsFocusFromKeyboard(self) -> bool
6216
6217 Can this window be given focus by keyboard navigation? if not, the
6218 only way to give it focus (provided it accepts it at all) is to click
6219 it.
6220 """
6221 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6222
6223 def GetDefaultItem(*args, **kwargs):
6224 """
6225 GetDefaultItem(self) -> Window
6226
6227 Get the default child of this parent, i.e. the one which is activated
6228 by pressing <Enter> such as the OK button on a wx.Dialog.
6229 """
6230 return _core_.Window_GetDefaultItem(*args, **kwargs)
6231
6232 def SetDefaultItem(*args, **kwargs):
6233 """
6234 SetDefaultItem(self, Window child) -> Window
6235
6236 Set this child as default, return the old default.
6237 """
6238 return _core_.Window_SetDefaultItem(*args, **kwargs)
6239
6240 def SetTmpDefaultItem(*args, **kwargs):
6241 """
6242 SetTmpDefaultItem(self, Window win)
6243
6244 Set this child as temporary default
6245 """
6246 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6247
908b74cd
RD
6248 def Navigate(*args, **kwargs):
6249 """
6250 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6251
fd2dc343
RD
6252 Does keyboard navigation from this window to another, by sending a
6253 `wx.NavigationKeyEvent`.
908b74cd
RD
6254 """
6255 return _core_.Window_Navigate(*args, **kwargs)
6256
d55e5bfc
RD
6257 def GetChildren(*args, **kwargs):
6258 """
6259 GetChildren(self) -> PyObject
6260
6261 Returns a list of the window's children. NOTE: Currently this is a
6262 copy of the child window list maintained by the window, so the return
6263 value of this function is only valid as long as the window's children
6264 do not change.
6265 """
6266 return _core_.Window_GetChildren(*args, **kwargs)
6267
6268 def GetParent(*args, **kwargs):
6269 """
6270 GetParent(self) -> Window
6271
6272 Returns the parent window of this window, or None if there isn't one.
6273 """
6274 return _core_.Window_GetParent(*args, **kwargs)
6275
6276 def GetGrandParent(*args, **kwargs):
6277 """
6278 GetGrandParent(self) -> Window
6279
15817c7e
RD
6280 Returns the parent of the parent of this window, or None if there
6281 isn't one.
d55e5bfc
RD
6282 """
6283 return _core_.Window_GetGrandParent(*args, **kwargs)
6284
6285 def IsTopLevel(*args, **kwargs):
6286 """
6287 IsTopLevel(self) -> bool
6288
6289 Returns true if the given window is a top-level one. Currently all
6290 frames and dialogs are always considered to be top-level windows (even
6291 if they have a parent window).
6292 """
6293 return _core_.Window_IsTopLevel(*args, **kwargs)
6294
6295 def Reparent(*args, **kwargs):
6296 """
6297 Reparent(self, Window newParent) -> bool
6298
6299 Reparents the window, i.e the window will be removed from its current
6300 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6301 re-inserted into another. Available on Windows and GTK. Returns True
6302 if the parent was changed, False otherwise (error or newParent ==
6303 oldParent)
6304 """
6305 return _core_.Window_Reparent(*args, **kwargs)
6306
6307 def AddChild(*args, **kwargs):
6308 """
6309 AddChild(self, Window child)
6310
6311 Adds a child window. This is called automatically by window creation
6312 functions so should not be required by the application programmer.
6313 """
6314 return _core_.Window_AddChild(*args, **kwargs)
6315
6316 def RemoveChild(*args, **kwargs):
6317 """
6318 RemoveChild(self, Window child)
6319
6320 Removes a child window. This is called automatically by window
6321 deletion functions so should not be required by the application
6322 programmer.
6323 """
6324 return _core_.Window_RemoveChild(*args, **kwargs)
6325
6326 def FindWindowById(*args, **kwargs):
6327 """
6328 FindWindowById(self, long winid) -> Window
6329
6330 Find a chld of this window by window ID
6331 """
6332 return _core_.Window_FindWindowById(*args, **kwargs)
6333
6334 def FindWindowByName(*args, **kwargs):
6335 """
6336 FindWindowByName(self, String name) -> Window
6337
6338 Find a child of this window by name
6339 """
6340 return _core_.Window_FindWindowByName(*args, **kwargs)
6341
6342 def GetEventHandler(*args, **kwargs):
6343 """
6344 GetEventHandler(self) -> EvtHandler
6345
6346 Returns the event handler for this window. By default, the window is
6347 its own event handler.
6348 """
6349 return _core_.Window_GetEventHandler(*args, **kwargs)
6350
6351 def SetEventHandler(*args, **kwargs):
6352 """
6353 SetEventHandler(self, EvtHandler handler)
6354
6355 Sets the event handler for this window. An event handler is an object
6356 that is capable of processing the events sent to a window. By default,
6357 the window is its own event handler, but an application may wish to
6358 substitute another, for example to allow central implementation of
6359 event-handling for a variety of different window classes.
6360
15817c7e 6361 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
6362 up a chain of event handlers, where an event not handled by one event
6363 handler is handed to the next one in the chain.
6364 """
6365 return _core_.Window_SetEventHandler(*args, **kwargs)
6366
6367 def PushEventHandler(*args, **kwargs):
6368 """
6369 PushEventHandler(self, EvtHandler handler)
6370
6371 Pushes this event handler onto the event handler stack for the window.
6372 An event handler is an object that is capable of processing the events
6373 sent to a window. By default, the window is its own event handler, but
6374 an application may wish to substitute another, for example to allow
6375 central implementation of event-handling for a variety of different
6376 window classes.
6377
6378 wx.Window.PushEventHandler allows an application to set up a chain of
6379 event handlers, where an event not handled by one event handler is
15817c7e 6380 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
6381 remove the event handler.
6382 """
6383 return _core_.Window_PushEventHandler(*args, **kwargs)
6384
6385 def PopEventHandler(*args, **kwargs):
6386 """
6387 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
6388
6389 Removes and returns the top-most event handler on the event handler
6390 stack. If deleteHandler is True then the wx.EvtHandler object will be
6391 destroyed after it is popped.
6392 """
6393 return _core_.Window_PopEventHandler(*args, **kwargs)
6394
6395 def RemoveEventHandler(*args, **kwargs):
6396 """
6397 RemoveEventHandler(self, EvtHandler handler) -> bool
6398
15817c7e
RD
6399 Find the given handler in the event handler chain and remove (but not
6400 delete) it from the event handler chain, return True if it was found
6401 and False otherwise (this also results in an assert failure so this
6402 function should only be called when the handler is supposed to be
6403 there.)
d55e5bfc
RD
6404 """
6405 return _core_.Window_RemoveEventHandler(*args, **kwargs)
6406
6407 def SetValidator(*args, **kwargs):
6408 """
6409 SetValidator(self, Validator validator)
6410
6411 Deletes the current validator (if any) and sets the window validator,
6412 having called wx.Validator.Clone to create a new validator of this
6413 type.
6414 """
6415 return _core_.Window_SetValidator(*args, **kwargs)
6416
6417 def GetValidator(*args, **kwargs):
6418 """
6419 GetValidator(self) -> Validator
6420
6421 Returns a pointer to the current validator for the window, or None if
6422 there is none.
6423 """
6424 return _core_.Window_GetValidator(*args, **kwargs)
6425
6426 def Validate(*args, **kwargs):
6427 """
6428 Validate(self) -> bool
6429
6430 Validates the current values of the child controls using their
15817c7e
RD
6431 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6432 style flag set, the method will also call Validate() of all child
6433 windows. Returns false if any of the validations failed.
d55e5bfc
RD
6434 """
6435 return _core_.Window_Validate(*args, **kwargs)
6436
6437 def TransferDataToWindow(*args, **kwargs):
6438 """
6439 TransferDataToWindow(self) -> bool
6440
15817c7e
RD
6441 Transfers values to child controls from data areas specified by their
6442 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6443 style flag set, the method will also call TransferDataToWindow() of
6444 all child windows.
d55e5bfc
RD
6445 """
6446 return _core_.Window_TransferDataToWindow(*args, **kwargs)
6447
6448 def TransferDataFromWindow(*args, **kwargs):
6449 """
6450 TransferDataFromWindow(self) -> bool
6451
15817c7e
RD
6452 Transfers values from child controls to data areas specified by their
6453 validators. Returns false if a transfer failed. If the window has
6454 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6455 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
6456 """
6457 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
6458
6459 def InitDialog(*args, **kwargs):
6460 """
6461 InitDialog(self)
6462
15817c7e
RD
6463 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6464 to the dialog via validators.
d55e5bfc
RD
6465 """
6466 return _core_.Window_InitDialog(*args, **kwargs)
6467
6468 def SetAcceleratorTable(*args, **kwargs):
6469 """
6470 SetAcceleratorTable(self, AcceleratorTable accel)
6471
6472 Sets the accelerator table for this window.
6473 """
6474 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
6475
6476 def GetAcceleratorTable(*args, **kwargs):
6477 """
6478 GetAcceleratorTable(self) -> AcceleratorTable
6479
6480 Gets the accelerator table for this window.
6481 """
6482 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
6483
6484 def RegisterHotKey(*args, **kwargs):
6485 """
6486 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
6487
6488 Registers a system wide hotkey. Every time the user presses the hotkey
6489 registered here, this window will receive a hotkey event. It will
6490 receive the event even if the application is in the background and
6491 does not have the input focus because the user is working with some
6492 other application. To bind an event handler function to this hotkey
6493 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6494 hotkey was registered successfully.
6495 """
6496 return _core_.Window_RegisterHotKey(*args, **kwargs)
6497
6498 def UnregisterHotKey(*args, **kwargs):
6499 """
6500 UnregisterHotKey(self, int hotkeyId) -> bool
6501
6502 Unregisters a system wide hotkey.
6503 """
6504 return _core_.Window_UnregisterHotKey(*args, **kwargs)
6505
6506 def ConvertDialogPointToPixels(*args, **kwargs):
6507 """
6508 ConvertDialogPointToPixels(self, Point pt) -> Point
6509
6510 Converts a point or size from dialog units to pixels. Dialog units
6511 are used for maintaining a dialog's proportions even if the font
6512 changes. For the x dimension, the dialog units are multiplied by the
6513 average character width and then divided by 4. For the y dimension,
6514 the dialog units are multiplied by the average character height and
6515 then divided by 8.
6516 """
6517 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
6518
6519 def ConvertDialogSizeToPixels(*args, **kwargs):
6520 """
6521 ConvertDialogSizeToPixels(self, Size sz) -> Size
6522
6523 Converts a point or size from dialog units to pixels. Dialog units
6524 are used for maintaining a dialog's proportions even if the font
6525 changes. For the x dimension, the dialog units are multiplied by the
6526 average character width and then divided by 4. For the y dimension,
6527 the dialog units are multiplied by the average character height and
6528 then divided by 8.
6529 """
6530 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
6531
6532 def DLG_PNT(*args, **kwargs):
6533 """
6534 DLG_PNT(self, Point pt) -> Point
6535
6536 Converts a point or size from dialog units to pixels. Dialog units
6537 are used for maintaining a dialog's proportions even if the font
6538 changes. For the x dimension, the dialog units are multiplied by the
6539 average character width and then divided by 4. For the y dimension,
6540 the dialog units are multiplied by the average character height and
6541 then divided by 8.
6542 """
6543 return _core_.Window_DLG_PNT(*args, **kwargs)
6544
6545 def DLG_SZE(*args, **kwargs):
6546 """
6547 DLG_SZE(self, Size sz) -> Size
6548
6549 Converts a point or size from dialog units to pixels. Dialog units
6550 are used for maintaining a dialog's proportions even if the font
6551 changes. For the x dimension, the dialog units are multiplied by the
6552 average character width and then divided by 4. For the y dimension,
6553 the dialog units are multiplied by the average character height and
6554 then divided by 8.
6555 """
6556 return _core_.Window_DLG_SZE(*args, **kwargs)
6557
6558 def ConvertPixelPointToDialog(*args, **kwargs):
6559 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
6560 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
6561
6562 def ConvertPixelSizeToDialog(*args, **kwargs):
6563 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
6564 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
6565
6566 def WarpPointer(*args, **kwargs):
6567 """
6568 WarpPointer(self, int x, int y)
6569
6570 Moves the pointer to the given position on the window.
6571
6572 NOTE: This function is not supported under Mac because Apple Human
6573 Interface Guidelines forbid moving the mouse cursor programmatically.
6574 """
6575 return _core_.Window_WarpPointer(*args, **kwargs)
6576
6577 def CaptureMouse(*args, **kwargs):
6578 """
6579 CaptureMouse(self)
6580
6581 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6582 release the capture.
6583
6584 Note that wxWindows maintains the stack of windows having captured the
6585 mouse and when the mouse is released the capture returns to the window
6586 which had had captured it previously and it is only really released if
6587 there were no previous window. In particular, this means that you must
6588 release the mouse as many times as you capture it.
6589 """
6590 return _core_.Window_CaptureMouse(*args, **kwargs)
6591
6592 def ReleaseMouse(*args, **kwargs):
6593 """
6594 ReleaseMouse(self)
6595
6596 Releases mouse input captured with wx.Window.CaptureMouse.
6597 """
6598 return _core_.Window_ReleaseMouse(*args, **kwargs)
6599
6600 def GetCapture(*args, **kwargs):
6601 """
d6c14a4c 6602 GetCapture() -> Window
d55e5bfc
RD
6603
6604 Returns the window which currently captures the mouse or None
6605 """
6606 return _core_.Window_GetCapture(*args, **kwargs)
6607
6608 GetCapture = staticmethod(GetCapture)
6609 def HasCapture(*args, **kwargs):
6610 """
6611 HasCapture(self) -> bool
6612
6613 Returns true if this window has the current mouse capture.
6614 """
6615 return _core_.Window_HasCapture(*args, **kwargs)
6616
6617 def Refresh(*args, **kwargs):
6618 """
6619 Refresh(self, bool eraseBackground=True, Rect rect=None)
6620
6621 Mark the specified rectangle (or the whole window) as "dirty" so it
6622 will be repainted. Causes an EVT_PAINT event to be generated and sent
6623 to the window.
6624 """
6625 return _core_.Window_Refresh(*args, **kwargs)
6626
6627 def RefreshRect(*args, **kwargs):
6628 """
6629 RefreshRect(self, Rect rect)
6630
6631 Redraws the contents of the given rectangle: the area inside it will
6632 be repainted. This is the same as Refresh but has a nicer syntax.
6633 """
6634 return _core_.Window_RefreshRect(*args, **kwargs)
6635
6636 def Update(*args, **kwargs):
6637 """
6638 Update(self)
6639
6640 Calling this method immediately repaints the invalidated area of the
6641 window instead of waiting for the EVT_PAINT event to happen, (normally
6642 this would usually only happen when the flow of control returns to the
6643 event loop.) Notice that this function doesn't refresh the window and
6644 does nothing if the window has been already repainted. Use Refresh
6645 first if you want to immediately redraw the window (or some portion of
6646 it) unconditionally.
6647 """
6648 return _core_.Window_Update(*args, **kwargs)
6649
6650 def ClearBackground(*args, **kwargs):
6651 """
6652 ClearBackground(self)
6653
6654 Clears the window by filling it with the current background
6655 colour. Does not cause an erase background event to be generated.
6656 """
6657 return _core_.Window_ClearBackground(*args, **kwargs)
6658
6659 def Freeze(*args, **kwargs):
6660 """
6661 Freeze(self)
6662
15817c7e
RD
6663 Freezes the window or, in other words, prevents any updates from
6664 taking place on screen, the window is not redrawn at all. Thaw must be
6665 called to reenable window redrawing. Calls to Freeze/Thaw may be
6666 nested, with the actual Thaw being delayed until all the nesting has
6667 been undone.
d55e5bfc
RD
6668
6669 This method is useful for visual appearance optimization (for example,
6670 it is a good idea to use it before inserting large amount of text into
6671 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6672 for all controls so it is mostly just a hint to wxWindows and not a
6673 mandatory directive.
6674 """
6675 return _core_.Window_Freeze(*args, **kwargs)
6676
6677 def Thaw(*args, **kwargs):
6678 """
6679 Thaw(self)
6680
6681 Reenables window updating after a previous call to Freeze. Calls to
15817c7e
RD
6682 Freeze/Thaw may be nested, so Thaw must be called the same number of
6683 times that Freeze was before the window will be updated.
d55e5bfc
RD
6684 """
6685 return _core_.Window_Thaw(*args, **kwargs)
6686
6687 def PrepareDC(*args, **kwargs):
6688 """
6689 PrepareDC(self, DC dc)
6690
6691 Call this function to prepare the device context for drawing a
6692 scrolled image. It sets the device origin according to the current
6693 scroll position.
6694 """
6695 return _core_.Window_PrepareDC(*args, **kwargs)
6696
6697 def GetUpdateRegion(*args, **kwargs):
6698 """
6699 GetUpdateRegion(self) -> Region
6700
6701 Returns the region specifying which parts of the window have been
6702 damaged. Should only be called within an EVT_PAINT handler.
6703 """
6704 return _core_.Window_GetUpdateRegion(*args, **kwargs)
6705
6706 def GetUpdateClientRect(*args, **kwargs):
6707 """
6708 GetUpdateClientRect(self) -> Rect
6709
6710 Get the update rectangle region bounding box in client coords.
6711 """
6712 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
6713
6714 def IsExposed(*args, **kwargs):
6715 """
6716 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
6717
6718 Returns true if the given point or rectangle area has been exposed
6719 since the last repaint. Call this in an paint event handler to
6720 optimize redrawing by only redrawing those areas, which have been
6721 exposed.
6722 """
6723 return _core_.Window_IsExposed(*args, **kwargs)
6724
6725 def IsExposedPoint(*args, **kwargs):
6726 """
6727 IsExposedPoint(self, Point pt) -> bool
6728
6729 Returns true if the given point or rectangle area has been exposed
6730 since the last repaint. Call this in an paint event handler to
6731 optimize redrawing by only redrawing those areas, which have been
6732 exposed.
6733 """
6734 return _core_.Window_IsExposedPoint(*args, **kwargs)
6735
6736 def IsExposedRect(*args, **kwargs):
6737 """
6738 IsExposedRect(self, Rect rect) -> bool
6739
6740 Returns true if the given point or rectangle area has been exposed
6741 since the last repaint. Call this in an paint event handler to
6742 optimize redrawing by only redrawing those areas, which have been
6743 exposed.
6744 """
6745 return _core_.Window_IsExposedRect(*args, **kwargs)
6746
6747 def GetDefaultAttributes(*args, **kwargs):
6748 """
6749 GetDefaultAttributes(self) -> VisualAttributes
6750
15817c7e
RD
6751 Get the default attributes for an instance of this class. This is
6752 useful if you want to use the same font or colour in your own control
6753 as in a standard control -- which is a much better idea than hard
6754 coding specific colours or fonts which might look completely out of
a5ee0656 6755 place on the user's system, especially if it uses themes.
d55e5bfc
RD
6756 """
6757 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
6758
6759 def GetClassDefaultAttributes(*args, **kwargs):
6760 """
d6c14a4c 6761 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 6762
15817c7e
RD
6763 Get the default attributes for this class. This is useful if you want
6764 to use the same font or colour in your own control as in a standard
6765 control -- which is a much better idea than hard coding specific
a5ee0656
RD
6766 colours or fonts which might look completely out of place on the
6767 user's system, especially if it uses themes.
d55e5bfc
RD
6768
6769 The variant parameter is only relevant under Mac currently and is
15817c7e 6770 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
6771 the returned font. See `wx.Window.SetWindowVariant` for more about
6772 this.
d55e5bfc
RD
6773 """
6774 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
6775
6776 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
6777 def SetBackgroundColour(*args, **kwargs):
6778 """
6779 SetBackgroundColour(self, Colour colour) -> bool
6780
6781 Sets the background colour of the window. Returns True if the colour
6782 was changed. The background colour is usually painted by the default
6783 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
6784 automatically under GTK. Using `wx.NullColour` will reset the window
6785 to the default background colour.
d55e5bfc 6786
a5ee0656 6787 Note that setting the background colour may not cause an immediate
f8167d6e 6788 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
6789 calling this function.
6790
f8167d6e
RD
6791 Using this function will disable attempts to use themes for this
6792 window, if the system supports them. Use with care since usually the
6793 themes represent the appearance chosen by the user to be used for all
6794 applications on the system.
d55e5bfc
RD
6795 """
6796 return _core_.Window_SetBackgroundColour(*args, **kwargs)
6797
6798 def SetDefaultBackgroundColour(*args, **kwargs):
6799 """SetDefaultBackgroundColour(self, Colour colour)"""
6800 return _core_.Window_SetDefaultBackgroundColour(*args, **kwargs)
6801
6802 def SetForegroundColour(*args, **kwargs):
6803 """
6804 SetForegroundColour(self, Colour colour) -> bool
6805
6806 Sets the foreground colour of the window. Returns True is the colour
6807 was changed. The interpretation of foreground colour is dependent on
6808 the window class; it may be the text colour or other colour, or it may
6809 not be used at all.
6810 """
6811 return _core_.Window_SetForegroundColour(*args, **kwargs)
6812
6813 def SetDefaultForegroundColour(*args, **kwargs):
6814 """SetDefaultForegroundColour(self, Colour colour)"""
6815 return _core_.Window_SetDefaultForegroundColour(*args, **kwargs)
6816
6817 def GetBackgroundColour(*args, **kwargs):
6818 """
6819 GetBackgroundColour(self) -> Colour
6820
6821 Returns the background colour of the window.
6822 """
6823 return _core_.Window_GetBackgroundColour(*args, **kwargs)
6824
6825 def GetForegroundColour(*args, **kwargs):
6826 """
6827 GetForegroundColour(self) -> Colour
6828
6829 Returns the foreground colour of the window. The interpretation of
6830 foreground colour is dependent on the window class; it may be the text
6831 colour or other colour, or it may not be used at all.
6832 """
6833 return _core_.Window_GetForegroundColour(*args, **kwargs)
6834
6835 def SetCursor(*args, **kwargs):
6836 """
6837 SetCursor(self, Cursor cursor) -> bool
6838
6839 Sets the window's cursor. Notice that the window cursor also sets it
6840 for the children of the window implicitly.
6841
6842 The cursor may be wx.NullCursor in which case the window cursor will
6843 be reset back to default.
6844 """
6845 return _core_.Window_SetCursor(*args, **kwargs)
6846
6847 def GetCursor(*args, **kwargs):
6848 """
6849 GetCursor(self) -> Cursor
6850
6851 Return the cursor associated with this window.
6852 """
6853 return _core_.Window_GetCursor(*args, **kwargs)
6854
6855 def SetFont(*args, **kwargs):
6856 """
6857 SetFont(self, Font font) -> bool
6858
6859 Sets the font for this window.
6860 """
6861 return _core_.Window_SetFont(*args, **kwargs)
6862
6863 def SetDefaultFont(*args, **kwargs):
6864 """SetDefaultFont(self, Font font)"""
6865 return _core_.Window_SetDefaultFont(*args, **kwargs)
6866
6867 def GetFont(*args, **kwargs):
6868 """
6869 GetFont(self) -> Font
6870
6871 Returns the default font used for this window.
6872 """
6873 return _core_.Window_GetFont(*args, **kwargs)
6874
6875 def SetCaret(*args, **kwargs):
6876 """
6877 SetCaret(self, Caret caret)
6878
6879 Sets the caret associated with the window.
6880 """
6881 return _core_.Window_SetCaret(*args, **kwargs)
6882
6883 def GetCaret(*args, **kwargs):
6884 """
6885 GetCaret(self) -> Caret
6886
6887 Returns the caret associated with the window.
6888 """
6889 return _core_.Window_GetCaret(*args, **kwargs)
6890
6891 def GetCharHeight(*args, **kwargs):
6892 """
6893 GetCharHeight(self) -> int
6894
6895 Get the (average) character size for the current font.
6896 """
6897 return _core_.Window_GetCharHeight(*args, **kwargs)
6898
6899 def GetCharWidth(*args, **kwargs):
6900 """
6901 GetCharWidth(self) -> int
6902
6903 Get the (average) character size for the current font.
6904 """
6905 return _core_.Window_GetCharWidth(*args, **kwargs)
6906
6907 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
6908 """
6909 GetTextExtent(String string) -> (width, height)
6910
6911 Get the width and height of the text using the current font.
6912 """
d55e5bfc
RD
6913 return _core_.Window_GetTextExtent(*args, **kwargs)
6914
6915 def GetFullTextExtent(*args, **kwargs):
6916 """
6917 GetFullTextExtent(String string, Font font=None) ->
6918 (width, height, descent, externalLeading)
6919
6920 Get the width, height, decent and leading of the text using the
6921 current or specified font.
6922 """
6923 return _core_.Window_GetFullTextExtent(*args, **kwargs)
6924
6925 def ClientToScreenXY(*args, **kwargs):
6926 """
6927 ClientToScreenXY(int x, int y) -> (x,y)
6928
6929 Converts to screen coordinates from coordinates relative to this window.
6930 """
6931 return _core_.Window_ClientToScreenXY(*args, **kwargs)
6932
6933 def ScreenToClientXY(*args, **kwargs):
6934 """
6935 ScreenToClientXY(int x, int y) -> (x,y)
6936
6937 Converts from screen to client window coordinates.
6938 """
6939 return _core_.Window_ScreenToClientXY(*args, **kwargs)
6940
6941 def ClientToScreen(*args, **kwargs):
6942 """
6943 ClientToScreen(self, Point pt) -> Point
6944
6945 Converts to screen coordinates from coordinates relative to this window.
6946 """
6947 return _core_.Window_ClientToScreen(*args, **kwargs)
6948
6949 def ScreenToClient(*args, **kwargs):
6950 """
6951 ScreenToClient(self, Point pt) -> Point
6952
6953 Converts from screen to client window coordinates.
6954 """
6955 return _core_.Window_ScreenToClient(*args, **kwargs)
6956
6957 def HitTestXY(*args, **kwargs):
6958 """
6959 HitTestXY(self, int x, int y) -> int
6960
6961 Test where the given (in client coords) point lies
6962 """
6963 return _core_.Window_HitTestXY(*args, **kwargs)
6964
6965 def HitTest(*args, **kwargs):
6966 """
6967 HitTest(self, Point pt) -> int
6968
6969 Test where the given (in client coords) point lies
6970 """
6971 return _core_.Window_HitTest(*args, **kwargs)
6972
6973 def GetBorder(*args):
6974 """
6975 GetBorder(self, long flags) -> int
6976 GetBorder(self) -> int
6977
6978 Get border for the flags of this window
6979 """
6980 return _core_.Window_GetBorder(*args)
6981
6982 def UpdateWindowUI(*args, **kwargs):
6983 """
6984 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
6985
6986 This function sends EVT_UPDATE_UI events to the window. The particular
6987 implementation depends on the window; for example a wx.ToolBar will
6988 send an update UI event for each toolbar button, and a wx.Frame will
6989 send an update UI event for each menubar menu item. You can call this
6990 function from your application to ensure that your UI is up-to-date at
6991 a particular point in time (as far as your EVT_UPDATE_UI handlers are
6992 concerned). This may be necessary if you have called
6993 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
6994 limit the overhead that wxWindows incurs by sending update UI events
6995 in idle time.
d55e5bfc
RD
6996 """
6997 return _core_.Window_UpdateWindowUI(*args, **kwargs)
6998
6999 def PopupMenuXY(*args, **kwargs):
7000 """
b0503257 7001 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7002
b0503257
RD
7003 Pops up the given menu at the specified coordinates, relative to this window,
7004 and returns control when the user has dismissed the menu. If a menu item is
7005 selected, the corresponding menu event is generated and will be processed as
7006 usual. If the default position is given then the current position of the
7007 mouse cursor will be used.
d55e5bfc
RD
7008 """
7009 return _core_.Window_PopupMenuXY(*args, **kwargs)
7010
7011 def PopupMenu(*args, **kwargs):
7012 """
b0503257 7013 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7014
b0503257
RD
7015 Pops up the given menu at the specified coordinates, relative to this window,
7016 and returns control when the user has dismissed the menu. If a menu item is
7017 selected, the corresponding menu event is generated and will be processed as
7018 usual. If the default position is given then the current position of the
7019 mouse cursor will be used.
d55e5bfc
RD
7020 """
7021 return _core_.Window_PopupMenu(*args, **kwargs)
7022
7023 def GetHandle(*args, **kwargs):
7024 """
7025 GetHandle(self) -> long
7026
7027 Returns the platform-specific handle (as a long integer) of the
7028 physical window. Currently on wxMac it returns the handle of the
7029 toplevel parent of the window.
7030 """
7031 return _core_.Window_GetHandle(*args, **kwargs)
7032
7033 def HasScrollbar(*args, **kwargs):
7034 """
7035 HasScrollbar(self, int orient) -> bool
7036
7037 Does the window have the scrollbar for this orientation?
7038 """
7039 return _core_.Window_HasScrollbar(*args, **kwargs)
7040
7041 def SetScrollbar(*args, **kwargs):
7042 """
15817c7e 7043 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
7044 bool refresh=True)
7045
7046 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
7047 """
7048 return _core_.Window_SetScrollbar(*args, **kwargs)
7049
7050 def SetScrollPos(*args, **kwargs):
7051 """
7052 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7053
7054 Sets the position of one of the built-in scrollbars.
7055 """
7056 return _core_.Window_SetScrollPos(*args, **kwargs)
7057
7058 def GetScrollPos(*args, **kwargs):
7059 """
7060 GetScrollPos(self, int orientation) -> int
7061
7062 Returns the built-in scrollbar position.
7063 """
7064 return _core_.Window_GetScrollPos(*args, **kwargs)
7065
7066 def GetScrollThumb(*args, **kwargs):
7067 """
7068 GetScrollThumb(self, int orientation) -> int
7069
7070 Returns the built-in scrollbar thumb size.
7071 """
7072 return _core_.Window_GetScrollThumb(*args, **kwargs)
7073
7074 def GetScrollRange(*args, **kwargs):
7075 """
7076 GetScrollRange(self, int orientation) -> int
7077
7078 Returns the built-in scrollbar range.
7079 """
7080 return _core_.Window_GetScrollRange(*args, **kwargs)
7081
7082 def ScrollWindow(*args, **kwargs):
7083 """
7084 ScrollWindow(self, int dx, int dy, Rect rect=None)
7085
7086 Physically scrolls the pixels in the window and move child windows
7087 accordingly. Use this function to optimise your scrolling
7088 implementations, to minimise the area that must be redrawn. Note that
7089 it is rarely required to call this function from a user program.
d55e5bfc
RD
7090 """
7091 return _core_.Window_ScrollWindow(*args, **kwargs)
7092
7093 def ScrollLines(*args, **kwargs):
7094 """
7095 ScrollLines(self, int lines) -> bool
7096
7097 If the platform and window class supports it, scrolls the window by
7098 the given number of lines down, if lines is positive, or up if lines
7099 is negative. Returns True if the window was scrolled, False if it was
7100 already on top/bottom and nothing was done.
7101 """
7102 return _core_.Window_ScrollLines(*args, **kwargs)
7103
7104 def ScrollPages(*args, **kwargs):
7105 """
7106 ScrollPages(self, int pages) -> bool
7107
15817c7e 7108 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
7109 the given number of pages down, if pages is positive, or up if pages
7110 is negative. Returns True if the window was scrolled, False if it was
7111 already on top/bottom and nothing was done.
7112 """
7113 return _core_.Window_ScrollPages(*args, **kwargs)
7114
7115 def LineUp(*args, **kwargs):
7116 """
7117 LineUp(self) -> bool
7118
7119 This is just a wrapper for ScrollLines(-1).
7120 """
7121 return _core_.Window_LineUp(*args, **kwargs)
7122
7123 def LineDown(*args, **kwargs):
7124 """
7125 LineDown(self) -> bool
7126
7127 This is just a wrapper for ScrollLines(1).
7128 """
7129 return _core_.Window_LineDown(*args, **kwargs)
7130
7131 def PageUp(*args, **kwargs):
7132 """
7133 PageUp(self) -> bool
7134
7135 This is just a wrapper for ScrollPages(-1).
7136 """
7137 return _core_.Window_PageUp(*args, **kwargs)
7138
7139 def PageDown(*args, **kwargs):
7140 """
7141 PageDown(self) -> bool
7142
7143 This is just a wrapper for ScrollPages(1).
7144 """
7145 return _core_.Window_PageDown(*args, **kwargs)
7146
7147 def SetHelpText(*args, **kwargs):
7148 """
7149 SetHelpText(self, String text)
7150
7151 Sets the help text to be used as context-sensitive help for this
7152 window. Note that the text is actually stored by the current
7153 wxHelpProvider implementation, and not in the window object itself.
7154 """
7155 return _core_.Window_SetHelpText(*args, **kwargs)
7156
7157 def SetHelpTextForId(*args, **kwargs):
7158 """
7159 SetHelpTextForId(self, String text)
7160
7161 Associate this help text with all windows with the same id as this
7162 one.
7163 """
7164 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7165
7166 def GetHelpText(*args, **kwargs):
7167 """
7168 GetHelpText(self) -> String
7169
7170 Gets the help text to be used as context-sensitive help for this
7171 window. Note that the text is actually stored by the current
7172 wxHelpProvider implementation, and not in the window object itself.
7173 """
7174 return _core_.Window_GetHelpText(*args, **kwargs)
7175
7176 def SetToolTipString(*args, **kwargs):
7177 """
7178 SetToolTipString(self, String tip)
7179
7180 Attach a tooltip to the window.
7181 """
7182 return _core_.Window_SetToolTipString(*args, **kwargs)
7183
7184 def SetToolTip(*args, **kwargs):
7185 """
7186 SetToolTip(self, ToolTip tip)
7187
7188 Attach a tooltip to the window.
7189 """
7190 return _core_.Window_SetToolTip(*args, **kwargs)
7191
7192 def GetToolTip(*args, **kwargs):
7193 """
7194 GetToolTip(self) -> ToolTip
7195
7196 get the associated tooltip or None if none
7197 """
7198 return _core_.Window_GetToolTip(*args, **kwargs)
7199
7200 def SetDropTarget(*args, **kwargs):
7201 """
7202 SetDropTarget(self, DropTarget dropTarget)
7203
7204 Associates a drop target with this window. If the window already has
7205 a drop target, it is deleted.
7206 """
7207 return _core_.Window_SetDropTarget(*args, **kwargs)
7208
7209 def GetDropTarget(*args, **kwargs):
7210 """
7211 GetDropTarget(self) -> DropTarget
7212
7213 Returns the associated drop target, which may be None.
7214 """
7215 return _core_.Window_GetDropTarget(*args, **kwargs)
7216
7217 def SetConstraints(*args, **kwargs):
7218 """
7219 SetConstraints(self, LayoutConstraints constraints)
7220
7221 Sets the window to have the given layout constraints. If an existing
7222 layout constraints object is already owned by the window, it will be
7223 deleted. Pass None to disassociate and delete the window's current
7224 constraints.
7225
7226 You must call SetAutoLayout to tell a window to use the constraints
7227 automatically in its default EVT_SIZE handler; otherwise, you must
7228 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7229 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7230 effect.
7231 """
7232 return _core_.Window_SetConstraints(*args, **kwargs)
7233
7234 def GetConstraints(*args, **kwargs):
7235 """
7236 GetConstraints(self) -> LayoutConstraints
7237
7238 Returns a pointer to the window's layout constraints, or None if there
7239 are none.
7240 """
7241 return _core_.Window_GetConstraints(*args, **kwargs)
7242
7243 def SetAutoLayout(*args, **kwargs):
7244 """
7245 SetAutoLayout(self, bool autoLayout)
7246
7247 Determines whether the Layout function will be called automatically
7248 when the window is resized. It is called implicitly by SetSizer but
7249 if you use SetConstraints you should call it manually or otherwise the
7250 window layout won't be correctly updated when its size changes.
7251 """
7252 return _core_.Window_SetAutoLayout(*args, **kwargs)
7253
7254 def GetAutoLayout(*args, **kwargs):
7255 """
7256 GetAutoLayout(self) -> bool
7257
7258 Returns the current autoLayout setting
7259 """
7260 return _core_.Window_GetAutoLayout(*args, **kwargs)
7261
7262 def Layout(*args, **kwargs):
7263 """
7264 Layout(self) -> bool
7265
7266 Invokes the constraint-based layout algorithm or the sizer-based
7267 algorithm for this window. See SetAutoLayout: when auto layout is on,
7268 this function gets called automatically by the default EVT_SIZE
7269 handler when the window is resized.
7270 """
7271 return _core_.Window_Layout(*args, **kwargs)
7272
7273 def SetSizer(*args, **kwargs):
7274 """
7275 SetSizer(self, Sizer sizer, bool deleteOld=True)
7276
7277 Sets the window to have the given layout sizer. The window will then
7278 own the object, and will take care of its deletion. If an existing
7279 layout sizer object is already owned by the window, it will be deleted
7280 if the deleteOld parameter is true. Note that this function will also
7281 call SetAutoLayout implicitly with a True parameter if the sizer is
7282 non-NoneL and False otherwise.
7283 """
7284 return _core_.Window_SetSizer(*args, **kwargs)
7285
7286 def SetSizerAndFit(*args, **kwargs):
7287 """
7288 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7289
7290 The same as SetSizer, except it also sets the size hints for the
7291 window based on the sizer's minimum size.
7292 """
7293 return _core_.Window_SetSizerAndFit(*args, **kwargs)
7294
7295 def GetSizer(*args, **kwargs):
7296 """
7297 GetSizer(self) -> Sizer
7298
7299 Return the sizer associated with the window by a previous call to
7300 SetSizer or None if there isn't one.
7301 """
7302 return _core_.Window_GetSizer(*args, **kwargs)
7303
7304 def SetContainingSizer(*args, **kwargs):
7305 """
7306 SetContainingSizer(self, Sizer sizer)
7307
7308 This normally does not need to be called by application code. It is
7309 called internally when a window is added to a sizer, and is used so
7310 the window can remove itself from the sizer when it is destroyed.
7311 """
7312 return _core_.Window_SetContainingSizer(*args, **kwargs)
7313
7314 def GetContainingSizer(*args, **kwargs):
7315 """
7316 GetContainingSizer(self) -> Sizer
7317
7318 Return the sizer that this window is a member of, if any, otherwise None.
7319 """
7320 return _core_.Window_GetContainingSizer(*args, **kwargs)
7321
7322 def InheritAttributes(*args, **kwargs):
7323 """
7324 InheritAttributes(self)
7325
15817c7e
RD
7326 This function is (or should be, in case of custom controls) called
7327 during window creation to intelligently set up the window visual
7328 attributes, that is the font and the foreground and background
7329 colours.
7330
7331 By 'intelligently' the following is meant: by default, all windows use
7332 their own default attributes. However if some of the parent's
7333 attributes are explicitly changed (that is, using SetFont and not
7334 SetDefaultFont) and if the corresponding attribute hadn't been
7335 explicitly set for this window itself, then this window takes the same
7336 value as used by the parent. In addition, if the window overrides
7337 ShouldInheritColours to return false, the colours will not be changed
7338 no matter what and only the font might.
7339
7340 This rather complicated logic is necessary in order to accomodate the
7341 different usage scenarius. The most common one is when all default
7342 attributes are used and in this case, nothing should be inherited as
7343 in modern GUIs different controls use different fonts (and colours)
7344 than their siblings so they can't inherit the same value from the
7345 parent. However it was also deemed desirable to allow to simply change
7346 the attributes of all children at once by just changing the font or
7347 colour of their common parent, hence in this case we do inherit the
7348 parents attributes.
7349
d55e5bfc
RD
7350 """
7351 return _core_.Window_InheritAttributes(*args, **kwargs)
7352
7353 def ShouldInheritColours(*args, **kwargs):
7354 """
7355 ShouldInheritColours(self) -> bool
7356
7357 Return true from here to allow the colours of this window to be
15817c7e
RD
7358 changed by InheritAttributes, returning false forbids inheriting them
7359 from the parent window.
d55e5bfc 7360
15817c7e
RD
7361 The base class version returns false, but this method is overridden in
7362 wxControl where it returns true.
d55e5bfc
RD
7363 """
7364 return _core_.Window_ShouldInheritColours(*args, **kwargs)
7365
7366 def PostCreate(self, pre):
7367 """
7368 Phase 3 of the 2-phase create <wink!>
7369 Call this method after precreating the window with the 2-phase create method.
7370 """
7371 self.this = pre.this
7372 self.thisown = pre.thisown
7373 pre.thisown = 0
7374 if hasattr(self, '_setOORInfo'):
7375 self._setOORInfo(self)
7376 if hasattr(self, '_setCallbackInfo'):
7377 self._setCallbackInfo(self, self.__class__)
7378
7379
7380class WindowPtr(Window):
7381 def __init__(self, this):
7382 self.this = this
7383 if not hasattr(self,"thisown"): self.thisown = 0
7384 self.__class__ = Window
7385_core_.Window_swigregister(WindowPtr)
7386
7387def PreWindow(*args, **kwargs):
7388 """
7389 PreWindow() -> Window
7390
7391 Precreate a Window for 2-phase creation.
7392 """
7393 val = _core_.new_PreWindow(*args, **kwargs)
7394 val.thisown = 1
7395 return val
7396
7397def Window_NewControlId(*args, **kwargs):
7398 """
7399 Window_NewControlId() -> int
7400
7401 Generate a control id for the controls which were not given one.
7402 """
7403 return _core_.Window_NewControlId(*args, **kwargs)
7404
7405def Window_NextControlId(*args, **kwargs):
7406 """
7407 Window_NextControlId(int winid) -> int
7408
7409 Get the id of the control following the one with the given
15817c7e 7410 autogenerated) id
d55e5bfc
RD
7411 """
7412 return _core_.Window_NextControlId(*args, **kwargs)
7413
7414def Window_PrevControlId(*args, **kwargs):
7415 """
7416 Window_PrevControlId(int winid) -> int
7417
7418 Get the id of the control preceding the one with the given
15817c7e 7419 autogenerated) id
d55e5bfc
RD
7420 """
7421 return _core_.Window_PrevControlId(*args, **kwargs)
7422
7423def Window_FindFocus(*args, **kwargs):
7424 """
7425 Window_FindFocus() -> Window
7426
7427 Returns the window or control that currently has the keyboard focus,
7428 or None.
7429 """
7430 return _core_.Window_FindFocus(*args, **kwargs)
7431
7432def Window_GetCapture(*args, **kwargs):
7433 """
7434 Window_GetCapture() -> Window
7435
7436 Returns the window which currently captures the mouse or None
7437 """
7438 return _core_.Window_GetCapture(*args, **kwargs)
7439
7440def Window_GetClassDefaultAttributes(*args, **kwargs):
7441 """
7442 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7443
15817c7e
RD
7444 Get the default attributes for this class. This is useful if you want
7445 to use the same font or colour in your own control as in a standard
7446 control -- which is a much better idea than hard coding specific
a5ee0656
RD
7447 colours or fonts which might look completely out of place on the
7448 user's system, especially if it uses themes.
d55e5bfc
RD
7449
7450 The variant parameter is only relevant under Mac currently and is
15817c7e 7451 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
7452 the returned font. See `wx.Window.SetWindowVariant` for more about
7453 this.
d55e5bfc
RD
7454 """
7455 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7456
7457def DLG_PNT(win, point_or_x, y=None):
7458 """
7459 Convenience function for converting a Point or (x,y) in
7460 dialog units to pixel units.
7461 """
7462 if y is None:
7463 return win.ConvertDialogPointToPixels(point_or_x)
7464 else:
7465 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
7466
7467def DLG_SZE(win, size_width, height=None):
7468 """
7469 Convenience function for converting a Size or (w,h) in
7470 dialog units to pixel units.
7471 """
7472 if height is None:
7473 return win.ConvertDialogSizeToPixels(size_width)
7474 else:
7475 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
7476
7477
7478def FindWindowById(*args, **kwargs):
7479 """
7480 FindWindowById(long id, Window parent=None) -> Window
7481
7482 Find the first window in the application with the given id. If parent
7483 is None, the search will start from all top-level frames and dialog
7484 boxes; if non-None, the search will be limited to the given window
7485 hierarchy. The search is recursive in both cases.
7486 """
7487 return _core_.FindWindowById(*args, **kwargs)
7488
7489def FindWindowByName(*args, **kwargs):
7490 """
7491 FindWindowByName(String name, Window parent=None) -> Window
7492
7493 Find a window by its name (as given in a window constructor or Create
7494 function call). If parent is None, the search will start from all
7495 top-level frames and dialog boxes; if non-None, the search will be
7496 limited to the given window hierarchy. The search is recursive in both
7497 cases.
7498
7499 If no window with such name is found, wx.FindWindowByLabel is called.
7500 """
7501 return _core_.FindWindowByName(*args, **kwargs)
7502
7503def FindWindowByLabel(*args, **kwargs):
7504 """
7505 FindWindowByLabel(String label, Window parent=None) -> Window
7506
7507 Find a window by its label. Depending on the type of window, the label
7508 may be a window title or panel item label. If parent is None, the
7509 search will start from all top-level frames and dialog boxes; if
7510 non-None, the search will be limited to the given window
7511 hierarchy. The search is recursive in both cases.
7512 """
7513 return _core_.FindWindowByLabel(*args, **kwargs)
7514
7515def Window_FromHWND(*args, **kwargs):
7516 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
7517 return _core_.Window_FromHWND(*args, **kwargs)
7518#---------------------------------------------------------------------------
7519
7520class Validator(EvtHandler):
7521 def __repr__(self):
7522 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7523 def __init__(self, *args, **kwargs):
7524 """__init__(self) -> Validator"""
7525 newobj = _core_.new_Validator(*args, **kwargs)
7526 self.this = newobj.this
7527 self.thisown = 1
7528 del newobj.thisown
7529 self._setOORInfo(self)
7530
7531 def Clone(*args, **kwargs):
7532 """Clone(self) -> Validator"""
7533 return _core_.Validator_Clone(*args, **kwargs)
7534
7535 def Validate(*args, **kwargs):
7536 """Validate(self, Window parent) -> bool"""
7537 return _core_.Validator_Validate(*args, **kwargs)
7538
7539 def TransferToWindow(*args, **kwargs):
7540 """TransferToWindow(self) -> bool"""
7541 return _core_.Validator_TransferToWindow(*args, **kwargs)
7542
7543 def TransferFromWindow(*args, **kwargs):
7544 """TransferFromWindow(self) -> bool"""
7545 return _core_.Validator_TransferFromWindow(*args, **kwargs)
7546
7547 def GetWindow(*args, **kwargs):
7548 """GetWindow(self) -> Window"""
7549 return _core_.Validator_GetWindow(*args, **kwargs)
7550
7551 def SetWindow(*args, **kwargs):
7552 """SetWindow(self, Window window)"""
7553 return _core_.Validator_SetWindow(*args, **kwargs)
7554
7555 def IsSilent(*args, **kwargs):
d6c14a4c 7556 """IsSilent() -> bool"""
d55e5bfc
RD
7557 return _core_.Validator_IsSilent(*args, **kwargs)
7558
7559 IsSilent = staticmethod(IsSilent)
7560 def SetBellOnError(*args, **kwargs):
d6c14a4c 7561 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
7562 return _core_.Validator_SetBellOnError(*args, **kwargs)
7563
7564 SetBellOnError = staticmethod(SetBellOnError)
7565
7566class ValidatorPtr(Validator):
7567 def __init__(self, this):
7568 self.this = this
7569 if not hasattr(self,"thisown"): self.thisown = 0
7570 self.__class__ = Validator
7571_core_.Validator_swigregister(ValidatorPtr)
7572
7573def Validator_IsSilent(*args, **kwargs):
7574 """Validator_IsSilent() -> bool"""
7575 return _core_.Validator_IsSilent(*args, **kwargs)
7576
7577def Validator_SetBellOnError(*args, **kwargs):
7578 """Validator_SetBellOnError(int doIt=True)"""
7579 return _core_.Validator_SetBellOnError(*args, **kwargs)
7580
7581class PyValidator(Validator):
7582 def __repr__(self):
7583 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7584 def __init__(self, *args, **kwargs):
7585 """__init__(self) -> PyValidator"""
7586 newobj = _core_.new_PyValidator(*args, **kwargs)
7587 self.this = newobj.this
7588 self.thisown = 1
7589 del newobj.thisown
7590
7591 self._setCallbackInfo(self, PyValidator, 1)
7592 self._setOORInfo(self)
7593
7594 def _setCallbackInfo(*args, **kwargs):
7595 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
7596 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
7597
7598
7599class PyValidatorPtr(PyValidator):
7600 def __init__(self, this):
7601 self.this = this
7602 if not hasattr(self,"thisown"): self.thisown = 0
7603 self.__class__ = PyValidator
7604_core_.PyValidator_swigregister(PyValidatorPtr)
7605
7606#---------------------------------------------------------------------------
7607
7608class Menu(EvtHandler):
7609 def __repr__(self):
7610 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7611 def __init__(self, *args, **kwargs):
7612 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
7613 newobj = _core_.new_Menu(*args, **kwargs)
7614 self.this = newobj.this
7615 self.thisown = 1
7616 del newobj.thisown
7617 self._setOORInfo(self)
7618
7619 def Append(*args, **kwargs):
7620 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7621 return _core_.Menu_Append(*args, **kwargs)
7622
7623 def AppendSeparator(*args, **kwargs):
7624 """AppendSeparator(self) -> MenuItem"""
7625 return _core_.Menu_AppendSeparator(*args, **kwargs)
7626
7627 def AppendCheckItem(*args, **kwargs):
7628 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7629 return _core_.Menu_AppendCheckItem(*args, **kwargs)
7630
7631 def AppendRadioItem(*args, **kwargs):
7632 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7633 return _core_.Menu_AppendRadioItem(*args, **kwargs)
7634
7635 def AppendMenu(*args, **kwargs):
7636 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7637 return _core_.Menu_AppendMenu(*args, **kwargs)
7638
7639 def AppendItem(*args, **kwargs):
7640 """AppendItem(self, MenuItem item) -> MenuItem"""
7641 return _core_.Menu_AppendItem(*args, **kwargs)
7642
7643 def Break(*args, **kwargs):
7644 """Break(self)"""
7645 return _core_.Menu_Break(*args, **kwargs)
7646
7647 def InsertItem(*args, **kwargs):
7648 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
7649 return _core_.Menu_InsertItem(*args, **kwargs)
7650
7651 def Insert(*args, **kwargs):
7652 """
7653 Insert(self, size_t pos, int id, String text, String help=EmptyString,
7654 int kind=ITEM_NORMAL) -> MenuItem
7655 """
7656 return _core_.Menu_Insert(*args, **kwargs)
7657
7658 def InsertSeparator(*args, **kwargs):
7659 """InsertSeparator(self, size_t pos) -> MenuItem"""
7660 return _core_.Menu_InsertSeparator(*args, **kwargs)
7661
7662 def InsertCheckItem(*args, **kwargs):
7663 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7664 return _core_.Menu_InsertCheckItem(*args, **kwargs)
7665
7666 def InsertRadioItem(*args, **kwargs):
7667 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7668 return _core_.Menu_InsertRadioItem(*args, **kwargs)
7669
7670 def InsertMenu(*args, **kwargs):
7671 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7672 return _core_.Menu_InsertMenu(*args, **kwargs)
7673
7674 def PrependItem(*args, **kwargs):
7675 """PrependItem(self, MenuItem item) -> MenuItem"""
7676 return _core_.Menu_PrependItem(*args, **kwargs)
7677
7678 def Prepend(*args, **kwargs):
7679 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7680 return _core_.Menu_Prepend(*args, **kwargs)
7681
7682 def PrependSeparator(*args, **kwargs):
7683 """PrependSeparator(self) -> MenuItem"""
7684 return _core_.Menu_PrependSeparator(*args, **kwargs)
7685
7686 def PrependCheckItem(*args, **kwargs):
7687 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7688 return _core_.Menu_PrependCheckItem(*args, **kwargs)
7689
7690 def PrependRadioItem(*args, **kwargs):
7691 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7692 return _core_.Menu_PrependRadioItem(*args, **kwargs)
7693
7694 def PrependMenu(*args, **kwargs):
7695 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7696 return _core_.Menu_PrependMenu(*args, **kwargs)
7697
7698 def Remove(*args, **kwargs):
7699 """Remove(self, int id) -> MenuItem"""
7700 return _core_.Menu_Remove(*args, **kwargs)
7701
7702 def RemoveItem(*args, **kwargs):
7703 """RemoveItem(self, MenuItem item) -> MenuItem"""
7704 return _core_.Menu_RemoveItem(*args, **kwargs)
7705
7706 def Delete(*args, **kwargs):
7707 """Delete(self, int id) -> bool"""
7708 return _core_.Menu_Delete(*args, **kwargs)
7709
7710 def DeleteItem(*args, **kwargs):
7711 """DeleteItem(self, MenuItem item) -> bool"""
7712 return _core_.Menu_DeleteItem(*args, **kwargs)
7713
7714 def Destroy(*args, **kwargs):
7715 """
7716 Destroy(self)
7717
7718 Deletes the C++ object this Python object is a proxy for.
7719 """
7720 return _core_.Menu_Destroy(*args, **kwargs)
7721
7722 def DestroyId(*args, **kwargs):
7723 """
7724 DestroyId(self, int id) -> bool
7725
7726 Deletes the C++ object this Python object is a proxy for.
7727 """
7728 return _core_.Menu_DestroyId(*args, **kwargs)
7729
7730 def DestroyItem(*args, **kwargs):
7731 """
7732 DestroyItem(self, MenuItem item) -> bool
7733
7734 Deletes the C++ object this Python object is a proxy for.
7735 """
7736 return _core_.Menu_DestroyItem(*args, **kwargs)
7737
7738 def GetMenuItemCount(*args, **kwargs):
7739 """GetMenuItemCount(self) -> size_t"""
7740 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
7741
7742 def GetMenuItems(*args, **kwargs):
7743 """GetMenuItems(self) -> PyObject"""
7744 return _core_.Menu_GetMenuItems(*args, **kwargs)
7745
7746 def FindItem(*args, **kwargs):
7747 """FindItem(self, String item) -> int"""
7748 return _core_.Menu_FindItem(*args, **kwargs)
7749
7750 def FindItemById(*args, **kwargs):
7751 """FindItemById(self, int id) -> MenuItem"""
7752 return _core_.Menu_FindItemById(*args, **kwargs)
7753
7754 def FindItemByPosition(*args, **kwargs):
7755 """FindItemByPosition(self, size_t position) -> MenuItem"""
7756 return _core_.Menu_FindItemByPosition(*args, **kwargs)
7757
7758 def Enable(*args, **kwargs):
7759 """Enable(self, int id, bool enable)"""
7760 return _core_.Menu_Enable(*args, **kwargs)
7761
7762 def IsEnabled(*args, **kwargs):
7763 """IsEnabled(self, int id) -> bool"""
7764 return _core_.Menu_IsEnabled(*args, **kwargs)
7765
7766 def Check(*args, **kwargs):
7767 """Check(self, int id, bool check)"""
7768 return _core_.Menu_Check(*args, **kwargs)
7769
7770 def IsChecked(*args, **kwargs):
7771 """IsChecked(self, int id) -> bool"""
7772 return _core_.Menu_IsChecked(*args, **kwargs)
7773
7774 def SetLabel(*args, **kwargs):
7775 """SetLabel(self, int id, String label)"""
7776 return _core_.Menu_SetLabel(*args, **kwargs)
7777
7778 def GetLabel(*args, **kwargs):
7779 """GetLabel(self, int id) -> String"""
7780 return _core_.Menu_GetLabel(*args, **kwargs)
7781
7782 def SetHelpString(*args, **kwargs):
7783 """SetHelpString(self, int id, String helpString)"""
7784 return _core_.Menu_SetHelpString(*args, **kwargs)
7785
7786 def GetHelpString(*args, **kwargs):
7787 """GetHelpString(self, int id) -> String"""
7788 return _core_.Menu_GetHelpString(*args, **kwargs)
7789
7790 def SetTitle(*args, **kwargs):
7791 """SetTitle(self, String title)"""
7792 return _core_.Menu_SetTitle(*args, **kwargs)
7793
7794 def GetTitle(*args, **kwargs):
7795 """GetTitle(self) -> String"""
7796 return _core_.Menu_GetTitle(*args, **kwargs)
7797
7798 def SetEventHandler(*args, **kwargs):
7799 """SetEventHandler(self, EvtHandler handler)"""
7800 return _core_.Menu_SetEventHandler(*args, **kwargs)
7801
7802 def GetEventHandler(*args, **kwargs):
7803 """GetEventHandler(self) -> EvtHandler"""
7804 return _core_.Menu_GetEventHandler(*args, **kwargs)
7805
7806 def SetInvokingWindow(*args, **kwargs):
7807 """SetInvokingWindow(self, Window win)"""
7808 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
7809
7810 def GetInvokingWindow(*args, **kwargs):
7811 """GetInvokingWindow(self) -> Window"""
7812 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
7813
7814 def GetStyle(*args, **kwargs):
7815 """GetStyle(self) -> long"""
7816 return _core_.Menu_GetStyle(*args, **kwargs)
7817
7818 def UpdateUI(*args, **kwargs):
7819 """UpdateUI(self, EvtHandler source=None)"""
7820 return _core_.Menu_UpdateUI(*args, **kwargs)
7821
7822 def GetMenuBar(*args, **kwargs):
7823 """GetMenuBar(self) -> MenuBar"""
7824 return _core_.Menu_GetMenuBar(*args, **kwargs)
7825
7826 def Attach(*args, **kwargs):
7827 """Attach(self, wxMenuBarBase menubar)"""
7828 return _core_.Menu_Attach(*args, **kwargs)
7829
7830 def Detach(*args, **kwargs):
7831 """Detach(self)"""
7832 return _core_.Menu_Detach(*args, **kwargs)
7833
7834 def IsAttached(*args, **kwargs):
7835 """IsAttached(self) -> bool"""
7836 return _core_.Menu_IsAttached(*args, **kwargs)
7837
7838 def SetParent(*args, **kwargs):
7839 """SetParent(self, Menu parent)"""
7840 return _core_.Menu_SetParent(*args, **kwargs)
7841
7842 def GetParent(*args, **kwargs):
7843 """GetParent(self) -> Menu"""
7844 return _core_.Menu_GetParent(*args, **kwargs)
7845
7846
7847class MenuPtr(Menu):
7848 def __init__(self, this):
7849 self.this = this
7850 if not hasattr(self,"thisown"): self.thisown = 0
7851 self.__class__ = Menu
7852_core_.Menu_swigregister(MenuPtr)
7853DefaultValidator = cvar.DefaultValidator
7854
7855#---------------------------------------------------------------------------
7856
7857class MenuBar(Window):
7858 def __repr__(self):
7859 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7860 def __init__(self, *args, **kwargs):
7861 """__init__(self, long style=0) -> MenuBar"""
7862 newobj = _core_.new_MenuBar(*args, **kwargs)
7863 self.this = newobj.this
7864 self.thisown = 1
7865 del newobj.thisown
7866 self._setOORInfo(self)
7867
7868 def Append(*args, **kwargs):
7869 """Append(self, Menu menu, String title) -> bool"""
7870 return _core_.MenuBar_Append(*args, **kwargs)
7871
7872 def Insert(*args, **kwargs):
7873 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
7874 return _core_.MenuBar_Insert(*args, **kwargs)
7875
7876 def GetMenuCount(*args, **kwargs):
7877 """GetMenuCount(self) -> size_t"""
7878 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
7879
7880 def GetMenu(*args, **kwargs):
7881 """GetMenu(self, size_t pos) -> Menu"""
7882 return _core_.MenuBar_GetMenu(*args, **kwargs)
7883
7884 def Replace(*args, **kwargs):
7885 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
7886 return _core_.MenuBar_Replace(*args, **kwargs)
7887
7888 def Remove(*args, **kwargs):
7889 """Remove(self, size_t pos) -> Menu"""
7890 return _core_.MenuBar_Remove(*args, **kwargs)
7891
7892 def EnableTop(*args, **kwargs):
7893 """EnableTop(self, size_t pos, bool enable)"""
7894 return _core_.MenuBar_EnableTop(*args, **kwargs)
7895
7896 def IsEnabledTop(*args, **kwargs):
7897 """IsEnabledTop(self, size_t pos) -> bool"""
7898 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
7899
7900 def SetLabelTop(*args, **kwargs):
7901 """SetLabelTop(self, size_t pos, String label)"""
7902 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
7903
7904 def GetLabelTop(*args, **kwargs):
7905 """GetLabelTop(self, size_t pos) -> String"""
7906 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
7907
7908 def FindMenuItem(*args, **kwargs):
7909 """FindMenuItem(self, String menu, String item) -> int"""
7910 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
7911
7912 def FindItemById(*args, **kwargs):
7913 """FindItemById(self, int id) -> MenuItem"""
7914 return _core_.MenuBar_FindItemById(*args, **kwargs)
7915
7916 def FindMenu(*args, **kwargs):
7917 """FindMenu(self, String title) -> int"""
7918 return _core_.MenuBar_FindMenu(*args, **kwargs)
7919
7920 def Enable(*args, **kwargs):
7921 """Enable(self, int id, bool enable)"""
7922 return _core_.MenuBar_Enable(*args, **kwargs)
7923
7924 def Check(*args, **kwargs):
7925 """Check(self, int id, bool check)"""
7926 return _core_.MenuBar_Check(*args, **kwargs)
7927
7928 def IsChecked(*args, **kwargs):
7929 """IsChecked(self, int id) -> bool"""
7930 return _core_.MenuBar_IsChecked(*args, **kwargs)
7931
7932 def IsEnabled(*args, **kwargs):
7933 """IsEnabled(self, int id) -> bool"""
7934 return _core_.MenuBar_IsEnabled(*args, **kwargs)
7935
7936 def SetLabel(*args, **kwargs):
7937 """SetLabel(self, int id, String label)"""
7938 return _core_.MenuBar_SetLabel(*args, **kwargs)
7939
7940 def GetLabel(*args, **kwargs):
7941 """GetLabel(self, int id) -> String"""
7942 return _core_.MenuBar_GetLabel(*args, **kwargs)
7943
7944 def SetHelpString(*args, **kwargs):
7945 """SetHelpString(self, int id, String helpString)"""
7946 return _core_.MenuBar_SetHelpString(*args, **kwargs)
7947
7948 def GetHelpString(*args, **kwargs):
7949 """GetHelpString(self, int id) -> String"""
7950 return _core_.MenuBar_GetHelpString(*args, **kwargs)
7951
7952 def GetFrame(*args, **kwargs):
7953 """GetFrame(self) -> wxFrame"""
7954 return _core_.MenuBar_GetFrame(*args, **kwargs)
7955
7956 def IsAttached(*args, **kwargs):
7957 """IsAttached(self) -> bool"""
7958 return _core_.MenuBar_IsAttached(*args, **kwargs)
7959
7960 def Attach(*args, **kwargs):
7961 """Attach(self, wxFrame frame)"""
7962 return _core_.MenuBar_Attach(*args, **kwargs)
7963
7964 def Detach(*args, **kwargs):
7965 """Detach(self)"""
7966 return _core_.MenuBar_Detach(*args, **kwargs)
7967
7968
7969class MenuBarPtr(MenuBar):
7970 def __init__(self, this):
7971 self.this = this
7972 if not hasattr(self,"thisown"): self.thisown = 0
7973 self.__class__ = MenuBar
7974_core_.MenuBar_swigregister(MenuBarPtr)
7975
7976#---------------------------------------------------------------------------
7977
7978class MenuItem(Object):
7979 def __repr__(self):
7980 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7981 def __init__(self, *args, **kwargs):
7982 """
7983 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
7984 String help=EmptyString, int kind=ITEM_NORMAL,
7985 Menu subMenu=None) -> MenuItem
7986 """
7987 newobj = _core_.new_MenuItem(*args, **kwargs)
7988 self.this = newobj.this
7989 self.thisown = 1
7990 del newobj.thisown
7991 def GetMenu(*args, **kwargs):
7992 """GetMenu(self) -> Menu"""
7993 return _core_.MenuItem_GetMenu(*args, **kwargs)
7994
7995 def SetMenu(*args, **kwargs):
7996 """SetMenu(self, Menu menu)"""
7997 return _core_.MenuItem_SetMenu(*args, **kwargs)
7998
7999 def SetId(*args, **kwargs):
8000 """SetId(self, int id)"""
8001 return _core_.MenuItem_SetId(*args, **kwargs)
8002
8003 def GetId(*args, **kwargs):
8004 """GetId(self) -> int"""
8005 return _core_.MenuItem_GetId(*args, **kwargs)
8006
8007 def IsSeparator(*args, **kwargs):
8008 """IsSeparator(self) -> bool"""
8009 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8010
8011 def SetText(*args, **kwargs):
8012 """SetText(self, String str)"""
8013 return _core_.MenuItem_SetText(*args, **kwargs)
8014
8015 def GetLabel(*args, **kwargs):
8016 """GetLabel(self) -> String"""
8017 return _core_.MenuItem_GetLabel(*args, **kwargs)
8018
8019 def GetText(*args, **kwargs):
8020 """GetText(self) -> String"""
8021 return _core_.MenuItem_GetText(*args, **kwargs)
8022
8023 def GetLabelFromText(*args, **kwargs):
d6c14a4c 8024 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
8025 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8026
8027 GetLabelFromText = staticmethod(GetLabelFromText)
8028 def GetKind(*args, **kwargs):
8029 """GetKind(self) -> int"""
8030 return _core_.MenuItem_GetKind(*args, **kwargs)
8031
8032 def SetKind(*args, **kwargs):
8033 """SetKind(self, int kind)"""
8034 return _core_.MenuItem_SetKind(*args, **kwargs)
8035
8036 def SetCheckable(*args, **kwargs):
8037 """SetCheckable(self, bool checkable)"""
8038 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8039
8040 def IsCheckable(*args, **kwargs):
8041 """IsCheckable(self) -> bool"""
8042 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8043
8044 def IsSubMenu(*args, **kwargs):
8045 """IsSubMenu(self) -> bool"""
8046 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8047
8048 def SetSubMenu(*args, **kwargs):
8049 """SetSubMenu(self, Menu menu)"""
8050 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8051
8052 def GetSubMenu(*args, **kwargs):
8053 """GetSubMenu(self) -> Menu"""
8054 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8055
8056 def Enable(*args, **kwargs):
8057 """Enable(self, bool enable=True)"""
8058 return _core_.MenuItem_Enable(*args, **kwargs)
8059
8060 def IsEnabled(*args, **kwargs):
8061 """IsEnabled(self) -> bool"""
8062 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8063
8064 def Check(*args, **kwargs):
8065 """Check(self, bool check=True)"""
8066 return _core_.MenuItem_Check(*args, **kwargs)
8067
8068 def IsChecked(*args, **kwargs):
8069 """IsChecked(self) -> bool"""
8070 return _core_.MenuItem_IsChecked(*args, **kwargs)
8071
8072 def Toggle(*args, **kwargs):
8073 """Toggle(self)"""
8074 return _core_.MenuItem_Toggle(*args, **kwargs)
8075
8076 def SetHelp(*args, **kwargs):
8077 """SetHelp(self, String str)"""
8078 return _core_.MenuItem_SetHelp(*args, **kwargs)
8079
8080 def GetHelp(*args, **kwargs):
8081 """GetHelp(self) -> String"""
8082 return _core_.MenuItem_GetHelp(*args, **kwargs)
8083
8084 def GetAccel(*args, **kwargs):
8085 """GetAccel(self) -> AcceleratorEntry"""
8086 return _core_.MenuItem_GetAccel(*args, **kwargs)
8087
8088 def SetAccel(*args, **kwargs):
8089 """SetAccel(self, AcceleratorEntry accel)"""
8090 return _core_.MenuItem_SetAccel(*args, **kwargs)
8091
8092 def GetDefaultMarginWidth(*args, **kwargs):
d6c14a4c 8093 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
8094 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8095
8096 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8097 def SetBitmap(*args, **kwargs):
8098 """SetBitmap(self, Bitmap bitmap)"""
8099 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8100
8101 def GetBitmap(*args, **kwargs):
8102 """GetBitmap(self) -> Bitmap"""
8103 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8104
8105
8106class MenuItemPtr(MenuItem):
8107 def __init__(self, this):
8108 self.this = this
8109 if not hasattr(self,"thisown"): self.thisown = 0
8110 self.__class__ = MenuItem
8111_core_.MenuItem_swigregister(MenuItemPtr)
8112
8113def MenuItem_GetLabelFromText(*args, **kwargs):
8114 """MenuItem_GetLabelFromText(String text) -> String"""
8115 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8116
8117def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8118 """MenuItem_GetDefaultMarginWidth() -> int"""
8119 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8120
8121#---------------------------------------------------------------------------
8122
8123class Control(Window):
8124 """
8125 This is the base class for a control or 'widget'.
8126
15817c7e
RD
8127 A control is generally a small window which processes user input
8128 and/or displays one or more item of data.
d55e5bfc
RD
8129 """
8130 def __repr__(self):
8131 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8132 def __init__(self, *args, **kwargs):
8133 """
bfddbb17
RD
8134 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8135 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8136 String name=ControlNameStr) -> Control
8137
15817c7e
RD
8138 Create a Control. Normally you should only call this from a subclass'
8139 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
8140 """
8141 newobj = _core_.new_Control(*args, **kwargs)
8142 self.this = newobj.this
8143 self.thisown = 1
8144 del newobj.thisown
8145 self._setOORInfo(self)
8146
8147 def Create(*args, **kwargs):
8148 """
bfddbb17
RD
8149 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8150 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8151 String name=ControlNameStr) -> bool
8152
8153 Do the 2nd phase and create the GUI control.
8154 """
8155 return _core_.Control_Create(*args, **kwargs)
8156
8157 def Command(*args, **kwargs):
8158 """
8159 Command(self, CommandEvent event)
8160
15817c7e
RD
8161 Simulates the effect of the user issuing a command to the item.
8162
8163 :see: `wx.CommandEvent`
8164
d55e5bfc
RD
8165 """
8166 return _core_.Control_Command(*args, **kwargs)
8167
8168 def GetLabel(*args, **kwargs):
8169 """
8170 GetLabel(self) -> String
8171
8172 Return a control's text.
8173 """
8174 return _core_.Control_GetLabel(*args, **kwargs)
8175
8176 def SetLabel(*args, **kwargs):
8177 """
8178 SetLabel(self, String label)
8179
8180 Sets the item's text.
8181 """
8182 return _core_.Control_SetLabel(*args, **kwargs)
8183
f8167d6e
RD
8184 def GetAdjustMinSizeFlag(*args, **kwargs):
8185 """
8186 GetAdjustMinSizeFlag(self) -> bool
8187
8188 Returns whether the minsize should be adjusted for this control when
8189 `SetLabel` or `SetFont` are called.
8190 """
8191 return _core_.Control_GetAdjustMinSizeFlag(*args, **kwargs)
8192
8193 def SetAdjustMinSizeFlag(*args, **kwargs):
8194 """
8195 SetAdjustMinSizeFlag(self, bool adjust)
8196
8197 By default controls will readjust their size and minsize when
8198 `SetLabel` or `SetFont` are called. This flag will allow you to
8199 control this behavior.
8200 """
8201 return _core_.Control_SetAdjustMinSizeFlag(*args, **kwargs)
8202
d55e5bfc
RD
8203 def GetClassDefaultAttributes(*args, **kwargs):
8204 """
d6c14a4c 8205 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 8206
15817c7e
RD
8207 Get the default attributes for this class. This is useful if you want
8208 to use the same font or colour in your own control as in a standard
8209 control -- which is a much better idea than hard coding specific
a5ee0656
RD
8210 colours or fonts which might look completely out of place on the
8211 user's system, especially if it uses themes.
d55e5bfc
RD
8212
8213 The variant parameter is only relevant under Mac currently and is
15817c7e 8214 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
8215 the returned font. See `wx.Window.SetWindowVariant` for more about
8216 this.
d55e5bfc
RD
8217 """
8218 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8219
8220 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8221
8222class ControlPtr(Control):
8223 def __init__(self, this):
8224 self.this = this
8225 if not hasattr(self,"thisown"): self.thisown = 0
8226 self.__class__ = Control
8227_core_.Control_swigregister(ControlPtr)
8228ControlNameStr = cvar.ControlNameStr
8229
8230def PreControl(*args, **kwargs):
8231 """
8232 PreControl() -> Control
8233
8234 Precreate a Control control for 2-phase creation
8235 """
8236 val = _core_.new_PreControl(*args, **kwargs)
8237 val.thisown = 1
8238 return val
8239
8240def Control_GetClassDefaultAttributes(*args, **kwargs):
8241 """
8242 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8243
15817c7e
RD
8244 Get the default attributes for this class. This is useful if you want
8245 to use the same font or colour in your own control as in a standard
8246 control -- which is a much better idea than hard coding specific
a5ee0656
RD
8247 colours or fonts which might look completely out of place on the
8248 user's system, especially if it uses themes.
d55e5bfc
RD
8249
8250 The variant parameter is only relevant under Mac currently and is
15817c7e 8251 ignore under other platforms. Under Mac, it will change the size of
a5ee0656
RD
8252 the returned font. See `wx.Window.SetWindowVariant` for more about
8253 this.
d55e5bfc
RD
8254 """
8255 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8256
8257#---------------------------------------------------------------------------
8258
8259class ItemContainer(object):
8260 """
8261 wx.ItemContainer defines an interface which is implemented by all
15817c7e
RD
8262 controls which have string subitems, each of which may be selected,
8263 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8264 `wx.ComboBox` which implements an extended interface deriving from
8265 this one.
d55e5bfc 8266
15817c7e
RD
8267 It defines the methods for accessing the control's items and although
8268 each of the derived classes implements them differently, they still
8269 all conform to the same interface.
d55e5bfc 8270
15817c7e
RD
8271 The items in a wx.ItemContainer have (non empty) string labels and,
8272 optionally, client data associated with them.
d55e5bfc
RD
8273
8274 """
8275 def __init__(self): raise RuntimeError, "No constructor defined"
8276 def __repr__(self):
8277 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8278 def Append(*args, **kwargs):
8279 """
8280 Append(self, String item, PyObject clientData=None) -> int
8281
15817c7e
RD
8282 Adds the item to the control, associating the given data with the item
8283 if not None. The return value is the index of the newly added item
8284 which may be different from the last one if the control is sorted (e.g.
8285 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
8286 """
8287 return _core_.ItemContainer_Append(*args, **kwargs)
8288
8289 def AppendItems(*args, **kwargs):
8290 """
8291 AppendItems(self, wxArrayString strings)
8292
15817c7e
RD
8293 Apend several items at once to the control. Notice that calling this
8294 method may be much faster than appending the items one by one if you
8295 need to add a lot of items.
d55e5bfc
RD
8296 """
8297 return _core_.ItemContainer_AppendItems(*args, **kwargs)
8298
8299 def Insert(*args, **kwargs):
8300 """
8301 Insert(self, String item, int pos, PyObject clientData=None) -> int
8302
15817c7e 8303 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
8304 optionally associating some data object with the item.
8305 """
8306 return _core_.ItemContainer_Insert(*args, **kwargs)
8307
8308 def Clear(*args, **kwargs):
8309 """
8310 Clear(self)
8311
8312 Removes all items from the control.
8313 """
8314 return _core_.ItemContainer_Clear(*args, **kwargs)
8315
8316 def Delete(*args, **kwargs):
8317 """
8318 Delete(self, int n)
8319
15817c7e
RD
8320 Deletes the item at the zero-based index 'n' from the control. Note
8321 that it is an error (signalled by a `wx.PyAssertionError` exception if
8322 enabled) to remove an item with the index negative or greater or equal
8323 than the number of items in the control.
d55e5bfc
RD
8324 """
8325 return _core_.ItemContainer_Delete(*args, **kwargs)
8326
8327 def GetCount(*args, **kwargs):
8328 """
8329 GetCount(self) -> int
8330
8331 Returns the number of items in the control.
8332 """
8333 return _core_.ItemContainer_GetCount(*args, **kwargs)
8334
8335 def IsEmpty(*args, **kwargs):
8336 """
8337 IsEmpty(self) -> bool
8338
8339 Returns True if the control is empty or False if it has some items.
8340 """
8341 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
8342
8343 def GetString(*args, **kwargs):
8344 """
8345 GetString(self, int n) -> String
8346
8347 Returns the label of the item with the given index.
8348 """
8349 return _core_.ItemContainer_GetString(*args, **kwargs)
8350
8351 def GetStrings(*args, **kwargs):
8352 """GetStrings(self) -> wxArrayString"""
8353 return _core_.ItemContainer_GetStrings(*args, **kwargs)
8354
8355 def SetString(*args, **kwargs):
8356 """
8357 SetString(self, int n, String s)
8358
8359 Sets the label for the given item.
8360 """
8361 return _core_.ItemContainer_SetString(*args, **kwargs)
8362
8363 def FindString(*args, **kwargs):
8364 """
8365 FindString(self, String s) -> int
8366
8367 Finds an item whose label matches the given string. Returns the
15817c7e
RD
8368 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8369 found.
d55e5bfc
RD
8370 """
8371 return _core_.ItemContainer_FindString(*args, **kwargs)
8372
8373 def Select(*args, **kwargs):
8374 """
8375 Select(self, int n)
8376
8377 Sets the item at index 'n' to be the selected item.
8378 """
8379 return _core_.ItemContainer_Select(*args, **kwargs)
8380
8381 SetSelection = Select
8382 def GetSelection(*args, **kwargs):
8383 """
8384 GetSelection(self) -> int
8385
15817c7e
RD
8386 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8387 is selected.
d55e5bfc
RD
8388 """
8389 return _core_.ItemContainer_GetSelection(*args, **kwargs)
8390
8391 def GetStringSelection(*args, **kwargs):
8392 """
8393 GetStringSelection(self) -> String
8394
15817c7e
RD
8395 Returns the label of the selected item or an empty string if no item
8396 is selected.
d55e5bfc
RD
8397 """
8398 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
8399
8400 def GetClientData(*args, **kwargs):
8401 """
8402 GetClientData(self, int n) -> PyObject
8403
8404 Returns the client data associated with the given item, (if any.)
8405 """
8406 return _core_.ItemContainer_GetClientData(*args, **kwargs)
8407
8408 def SetClientData(*args, **kwargs):
8409 """
8410 SetClientData(self, int n, PyObject clientData)
8411
8412 Associate the given client data with the item at position n.
8413 """
8414 return _core_.ItemContainer_SetClientData(*args, **kwargs)
8415
8416
8417class ItemContainerPtr(ItemContainer):
8418 def __init__(self, this):
8419 self.this = this
8420 if not hasattr(self,"thisown"): self.thisown = 0
8421 self.__class__ = ItemContainer
8422_core_.ItemContainer_swigregister(ItemContainerPtr)
8423
8424#---------------------------------------------------------------------------
8425
8426class ControlWithItems(Control,ItemContainer):
8427 """
15817c7e
RD
8428 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8429 wx.Control class, and is used for the base class of various controls
8430 that have items.
d55e5bfc
RD
8431 """
8432 def __init__(self): raise RuntimeError, "No constructor defined"
8433 def __repr__(self):
8434 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8435
8436class ControlWithItemsPtr(ControlWithItems):
8437 def __init__(self, this):
8438 self.this = this
8439 if not hasattr(self,"thisown"): self.thisown = 0
8440 self.__class__ = ControlWithItems
8441_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
8442
8443#---------------------------------------------------------------------------
8444
8445class SizerItem(Object):
bfddbb17
RD
8446 """
8447 The wx.SizerItem class is used to track the position, size and other
8448 attributes of each item managed by a `wx.Sizer`. In normal usage user
8449 code should never need to deal directly with a wx.SizerItem, but
8450 custom classes derived from `wx.PySizer` will probably need to use the
8451 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8452
8453 :see: `wx.Sizer`, `wx.GBSizerItem`
8454 """
d55e5bfc
RD
8455 def __repr__(self):
8456 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8457 def __init__(self, *args, **kwargs):
bfddbb17
RD
8458 """
8459 __init__(self) -> SizerItem
8460
8461 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8462 size will need to be set before this item can be used in a Sizer.
8463
8464 You will probably never need to create a wx.SizerItem directly as they
8465 are created automatically when the sizer's Add, Insert or Prepend
8466 methods are called.
8467
8468 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8469 """
d55e5bfc
RD
8470 newobj = _core_.new_SizerItem(*args, **kwargs)
8471 self.this = newobj.this
8472 self.thisown = 1
8473 del newobj.thisown
8474 def DeleteWindows(*args, **kwargs):
bfddbb17
RD
8475 """
8476 DeleteWindows(self)
8477
8478 Destroy the window or the windows in a subsizer, depending on the type
8479 of item.
8480 """
d55e5bfc
RD
8481 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
8482
8483 def DetachSizer(*args, **kwargs):
bfddbb17
RD
8484 """
8485 DetachSizer(self)
8486
8487 Enable deleting the SizerItem without destroying the contained sizer.
8488 """
d55e5bfc
RD
8489 return _core_.SizerItem_DetachSizer(*args, **kwargs)
8490
8491 def GetSize(*args, **kwargs):
bfddbb17
RD
8492 """
8493 GetSize(self) -> Size
8494
8495 Get the current size of the item, as set in the last Layout.
8496 """
d55e5bfc
RD
8497 return _core_.SizerItem_GetSize(*args, **kwargs)
8498
8499 def CalcMin(*args, **kwargs):
bfddbb17
RD
8500 """
8501 CalcMin(self) -> Size
8502
8503 Calculates the minimum desired size for the item, including any space
8504 needed by borders.
8505 """
d55e5bfc
RD
8506 return _core_.SizerItem_CalcMin(*args, **kwargs)
8507
8508 def SetDimension(*args, **kwargs):
bfddbb17
RD
8509 """
8510 SetDimension(self, Point pos, Size size)
8511
8512 Set the position and size of the space allocated for this item by the
8513 sizer, and adjust the position and size of the item (window or
8514 subsizer) to be within that space taking alignment and borders into
8515 account.
8516 """
d55e5bfc
RD
8517 return _core_.SizerItem_SetDimension(*args, **kwargs)
8518
8519 def GetMinSize(*args, **kwargs):
bfddbb17
RD
8520 """
8521 GetMinSize(self) -> Size
8522
8523 Get the minimum size needed for the item.
8524 """
d55e5bfc
RD
8525 return _core_.SizerItem_GetMinSize(*args, **kwargs)
8526
8527 def SetInitSize(*args, **kwargs):
8528 """SetInitSize(self, int x, int y)"""
8529 return _core_.SizerItem_SetInitSize(*args, **kwargs)
8530
8531 def SetRatioWH(*args, **kwargs):
bfddbb17
RD
8532 """
8533 SetRatioWH(self, int width, int height)
8534
8535 Set the ratio item attribute.
8536 """
d55e5bfc
RD
8537 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
8538
8539 def SetRatioSize(*args, **kwargs):
bfddbb17
RD
8540 """
8541 SetRatioSize(self, Size size)
8542
8543 Set the ratio item attribute.
8544 """
d55e5bfc
RD
8545 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
8546
8547 def SetRatio(*args, **kwargs):
bfddbb17
RD
8548 """
8549 SetRatio(self, float ratio)
8550
8551 Set the ratio item attribute.
8552 """
d55e5bfc
RD
8553 return _core_.SizerItem_SetRatio(*args, **kwargs)
8554
8555 def GetRatio(*args, **kwargs):
bfddbb17
RD
8556 """
8557 GetRatio(self) -> float
8558
8559 Set the ratio item attribute.
8560 """
d55e5bfc
RD
8561 return _core_.SizerItem_GetRatio(*args, **kwargs)
8562
8563 def IsWindow(*args, **kwargs):
bfddbb17
RD
8564 """
8565 IsWindow(self) -> bool
8566
8567 Is this sizer item a window?
8568 """
d55e5bfc
RD
8569 return _core_.SizerItem_IsWindow(*args, **kwargs)
8570
8571 def IsSizer(*args, **kwargs):
bfddbb17
RD
8572 """
8573 IsSizer(self) -> bool
8574
8575 Is this sizer item a subsizer?
8576 """
d55e5bfc
RD
8577 return _core_.SizerItem_IsSizer(*args, **kwargs)
8578
8579 def IsSpacer(*args, **kwargs):
bfddbb17
RD
8580 """
8581 IsSpacer(self) -> bool
8582
8583 Is this sizer item a spacer?
8584 """
d55e5bfc
RD
8585 return _core_.SizerItem_IsSpacer(*args, **kwargs)
8586
8587 def SetProportion(*args, **kwargs):
bfddbb17
RD
8588 """
8589 SetProportion(self, int proportion)
8590
8591 Set the proportion value for this item.
8592 """
d55e5bfc
RD
8593 return _core_.SizerItem_SetProportion(*args, **kwargs)
8594
8595 def GetProportion(*args, **kwargs):
bfddbb17
RD
8596 """
8597 GetProportion(self) -> int
8598
8599 Get the proportion value for this item.
8600 """
d55e5bfc
RD
8601 return _core_.SizerItem_GetProportion(*args, **kwargs)
8602
bfddbb17
RD
8603 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8604 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 8605 def SetFlag(*args, **kwargs):
bfddbb17
RD
8606 """
8607 SetFlag(self, int flag)
8608
8609 Set the flag value for this item.
8610 """
d55e5bfc
RD
8611 return _core_.SizerItem_SetFlag(*args, **kwargs)
8612
8613 def GetFlag(*args, **kwargs):
bfddbb17
RD
8614 """
8615 GetFlag(self) -> int
8616
8617 Get the flag value for this item.
8618 """
d55e5bfc
RD
8619 return _core_.SizerItem_GetFlag(*args, **kwargs)
8620
8621 def SetBorder(*args, **kwargs):
bfddbb17
RD
8622 """
8623 SetBorder(self, int border)
8624
8625 Set the border value for this item.
8626 """
d55e5bfc
RD
8627 return _core_.SizerItem_SetBorder(*args, **kwargs)
8628
8629 def GetBorder(*args, **kwargs):
bfddbb17
RD
8630 """
8631 GetBorder(self) -> int
8632
8633 Get the border value for this item.
8634 """
d55e5bfc
RD
8635 return _core_.SizerItem_GetBorder(*args, **kwargs)
8636
8637 def GetWindow(*args, **kwargs):
bfddbb17
RD
8638 """
8639 GetWindow(self) -> Window
8640
8641 Get the window (if any) that is managed by this sizer item.
8642 """
d55e5bfc
RD
8643 return _core_.SizerItem_GetWindow(*args, **kwargs)
8644
8645 def SetWindow(*args, **kwargs):
bfddbb17
RD
8646 """
8647 SetWindow(self, Window window)
8648
8649 Set the window to be managed by this sizer item.
8650 """
d55e5bfc
RD
8651 return _core_.SizerItem_SetWindow(*args, **kwargs)
8652
8653 def GetSizer(*args, **kwargs):
bfddbb17
RD
8654 """
8655 GetSizer(self) -> Sizer
8656
8657 Get the subsizer (if any) that is managed by this sizer item.
8658 """
d55e5bfc
RD
8659 return _core_.SizerItem_GetSizer(*args, **kwargs)
8660
8661 def SetSizer(*args, **kwargs):
bfddbb17
RD
8662 """
8663 SetSizer(self, Sizer sizer)
8664
8665 Set the subsizer to be managed by this sizer item.
8666 """
d55e5bfc
RD
8667 return _core_.SizerItem_SetSizer(*args, **kwargs)
8668
8669 def GetSpacer(*args, **kwargs):
bfddbb17
RD
8670 """
8671 GetSpacer(self) -> Size
8672
8673 Get the size of the spacer managed by this sizer item.
8674 """
d55e5bfc
RD
8675 return _core_.SizerItem_GetSpacer(*args, **kwargs)
8676
8677 def SetSpacer(*args, **kwargs):
bfddbb17
RD
8678 """
8679 SetSpacer(self, Size size)
8680
8681 Set the size of the spacer to be managed by this sizer item.
8682 """
d55e5bfc
RD
8683 return _core_.SizerItem_SetSpacer(*args, **kwargs)
8684
8685 def Show(*args, **kwargs):
bfddbb17
RD
8686 """
8687 Show(self, bool show)
8688
8689 Set the show item attribute, which sizers use to determine if the item
8690 is to be made part of the layout or not. If the item is tracking a
8691 window then it is shown or hidden as needed.
8692 """
d55e5bfc
RD
8693 return _core_.SizerItem_Show(*args, **kwargs)
8694
8695 def IsShown(*args, **kwargs):
bfddbb17
RD
8696 """
8697 IsShown(self) -> bool
8698
8699 Is the item to be shown in the layout?
8700 """
d55e5bfc
RD
8701 return _core_.SizerItem_IsShown(*args, **kwargs)
8702
8703 def GetPosition(*args, **kwargs):
bfddbb17
RD
8704 """
8705 GetPosition(self) -> Point
8706
8707 Returns the current position of the item, as set in the last Layout.
8708 """
d55e5bfc
RD
8709 return _core_.SizerItem_GetPosition(*args, **kwargs)
8710
8711 def GetUserData(*args, **kwargs):
bfddbb17
RD
8712 """
8713 GetUserData(self) -> PyObject
8714
8715 Returns the userData associated with this sizer item, or None if there
8716 isn't any.
8717 """
d55e5bfc
RD
8718 return _core_.SizerItem_GetUserData(*args, **kwargs)
8719
8720
8721class SizerItemPtr(SizerItem):
8722 def __init__(self, this):
8723 self.this = this
8724 if not hasattr(self,"thisown"): self.thisown = 0
8725 self.__class__ = SizerItem
8726_core_.SizerItem_swigregister(SizerItemPtr)
8727
bfddbb17 8728def SizerItemWindow(*args, **kwargs):
d55e5bfc 8729 """
bfddbb17
RD
8730 SizerItemWindow(Window window, int proportion, int flag, int border,
8731 PyObject userData=None) -> SizerItem
8732
8733 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 8734 """
bfddbb17 8735 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
8736 val.thisown = 1
8737 return val
8738
bfddbb17 8739def SizerItemSpacer(*args, **kwargs):
d55e5bfc 8740 """
bfddbb17
RD
8741 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
8742 PyObject userData=None) -> SizerItem
8743
8744 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 8745 """
bfddbb17 8746 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
8747 val.thisown = 1
8748 return val
8749
8750def SizerItemSizer(*args, **kwargs):
8751 """
8752 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
bfddbb17
RD
8753 PyObject userData=None) -> SizerItem
8754
8755 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
8756 """
8757 val = _core_.new_SizerItemSizer(*args, **kwargs)
8758 val.thisown = 1
8759 return val
8760
8761class Sizer(Object):
bfddbb17
RD
8762 """
8763 wx.Sizer is the abstract base class used for laying out subwindows in
8764 a window. You cannot use wx.Sizer directly; instead, you will have to
8765 use one of the sizer classes derived from it such as `wx.BoxSizer`,
8766 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
8767 and `wx.GridBagSizer`.
8768
8769 The concept implemented by sizers in wxWidgets is closely related to
8770 layout tools in other GUI toolkits, such as Java's AWT, the GTK
8771 toolkit or the Qt toolkit. It is based upon the idea of the individual
8772 subwindows reporting their minimal required size and their ability to
8773 get stretched if the size of the parent window has changed. This will
8774 most often mean that the programmer does not set the original size of
8775 a dialog in the beginning, rather the dialog will assigned a sizer and
8776 this sizer will be queried about the recommended size. The sizer in
8777 turn will query its children, which can be normal windows or contorls,
8778 empty space or other sizers, so that a hierarchy of sizers can be
8779 constructed. Note that wxSizer does not derive from wxWindow and thus
8780 do not interfere with tab ordering and requires very little resources
8781 compared to a real window on screen.
8782
8783 What makes sizers so well fitted for use in wxWidgets is the fact that
8784 every control reports its own minimal size and the algorithm can
8785 handle differences in font sizes or different window (dialog item)
8786 sizes on different platforms without problems. If for example the
8787 standard font as well as the overall design of Mac widgets requires
8788 more space than on Windows, then the initial size of a dialog using a
8789 sizer will automatically be bigger on Mac than on Windows.
8790 """
d55e5bfc
RD
8791 def __init__(self): raise RuntimeError, "No constructor defined"
8792 def __repr__(self):
8793 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8794 def _setOORInfo(*args, **kwargs):
8795 """_setOORInfo(self, PyObject _self)"""
8796 return _core_.Sizer__setOORInfo(*args, **kwargs)
8797
8798 def Add(*args, **kwargs):
8799 """
bfddbb17 8800 Add(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 8801 PyObject userData=None)
bfddbb17
RD
8802
8803 Appends a child item to the sizer.
d55e5bfc
RD
8804 """
8805 return _core_.Sizer_Add(*args, **kwargs)
8806
8807 def Insert(*args, **kwargs):
8808 """
bfddbb17
RD
8809 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
8810 PyObject userData=None)
8811
8812 Inserts a new item into the list of items managed by this sizer before
8813 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
8814 """
8815 return _core_.Sizer_Insert(*args, **kwargs)
8816
8817 def Prepend(*args, **kwargs):
8818 """
bfddbb17 8819 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 8820 PyObject userData=None)
bfddbb17
RD
8821
8822 Adds a new item to the begining of the list of sizer items managed by
8823 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
8824 """
8825 return _core_.Sizer_Prepend(*args, **kwargs)
8826
8827 def Remove(*args, **kwargs):
bfddbb17
RD
8828 """
8829 Remove(self, item) -> bool
8830
8831 Removes an item from the sizer and destroys it. This method does not
8832 cause any layout or resizing to take place, call `Layout` to update
8833 the layout on screen after removing a child from the sizer. The
8834 *item* parameter can be either a window, a sizer, or the zero-based
8835 index of an item to remove. Returns True if the child item was found
8836 and removed.
8837 """
d55e5bfc
RD
8838 return _core_.Sizer_Remove(*args, **kwargs)
8839
1a6bba1e 8840 def Detach(*args, **kwargs):
bfddbb17
RD
8841 """
8842 Detach(self, item) -> bool
8843
8844 Detaches an item from the sizer without destroying it. This method
8845 does not cause any layout or resizing to take place, call `Layout` to
8846 do so. The *item* parameter can be either a window, a sizer, or the
8847 zero-based index of the item to be detached. Returns True if the child item
8848 was found and detached.
8849 """
1a6bba1e
RD
8850 return _core_.Sizer_Detach(*args, **kwargs)
8851
d55e5bfc
RD
8852 def _SetItemMinSize(*args, **kwargs):
8853 """_SetItemMinSize(self, PyObject item, Size size)"""
8854 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
8855
bfddbb17
RD
8856 def SetItemMinSize(self, item, *args):
8857 """
8858 SetItemMinSize(self, item, Size size)
8859
8860 Sets the minimum size that will be allocated for an item in the sizer.
8861 The *item* parameter can be either a window, a sizer, or the
8862 zero-based index of the item. If a window or sizer is given then it
8863 will be searched for recursivly in subsizers if neccessary.
8864 """
8865 if len(args) == 2:
8866 # for backward compatibility accept separate width,height args too
8867 return self._SetItemMinSize(item, args)
8868 else:
8869 return self._SetItemMinSize(item, args[0])
8870
d55e5bfc 8871 def AddItem(*args, **kwargs):
bfddbb17
RD
8872 """
8873 AddItem(self, SizerItem item)
8874
8875 Adds a `wx.SizerItem` to the sizer.
8876 """
d55e5bfc
RD
8877 return _core_.Sizer_AddItem(*args, **kwargs)
8878
8879 def InsertItem(*args, **kwargs):
bfddbb17
RD
8880 """
8881 InsertItem(self, int index, SizerItem item)
8882
8883 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
8884 """
d55e5bfc
RD
8885 return _core_.Sizer_InsertItem(*args, **kwargs)
8886
8887 def PrependItem(*args, **kwargs):
bfddbb17
RD
8888 """
8889 PrependItem(self, SizerItem item)
8890
8891 Prepends a `wx.SizerItem` to the sizer.
8892 """
d55e5bfc
RD
8893 return _core_.Sizer_PrependItem(*args, **kwargs)
8894
bfddbb17 8895 def AddMany(self, items):
d6c14a4c
RD
8896 """
8897 AddMany is a convenience method for adding several items
8898 to a sizer at one time. Simply pass it a list of tuples,
8899 where each tuple consists of the parameters that you
8900 would normally pass to the `Add` method.
8901 """
bfddbb17
RD
8902 for item in items:
8903 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
8904 item = (item, )
8905 self.Add(*item)
d55e5bfc
RD
8906
8907 # for backwards compatibility only, please do not use in new code
d6c14a4c
RD
8908 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
8909 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
8910 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
8911 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
8912 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
8913 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
8914 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
8915 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
8916 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
8917 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
8918 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
8919 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d55e5bfc
RD
8920
8921
d55e5bfc 8922 def SetDimension(*args, **kwargs):
bfddbb17
RD
8923 """
8924 SetDimension(self, int x, int y, int width, int height)
8925
8926 Call this to force the sizer to take the given dimension and thus
8927 force the items owned by the sizer to resize themselves according to
8928 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
8929 methods.
8930 """
d55e5bfc
RD
8931 return _core_.Sizer_SetDimension(*args, **kwargs)
8932
8933 def SetMinSize(*args, **kwargs):
bfddbb17
RD
8934 """
8935 SetMinSize(self, Size size)
8936
8937 Call this to give the sizer a minimal size. Normally, the sizer will
8938 calculate its minimal size based purely on how much space its children
8939 need. After calling this method `GetMinSize` will return either the
8940 minimal size as requested by its children or the minimal size set
8941 here, depending on which is bigger.
8942 """
d55e5bfc
RD
8943 return _core_.Sizer_SetMinSize(*args, **kwargs)
8944
8945 def GetSize(*args, **kwargs):
bfddbb17
RD
8946 """
8947 GetSize(self) -> Size
8948
8949 Returns the current size of the space managed by the sizer.
8950 """
d55e5bfc
RD
8951 return _core_.Sizer_GetSize(*args, **kwargs)
8952
8953 def GetPosition(*args, **kwargs):
bfddbb17
RD
8954 """
8955 GetPosition(self) -> Point
8956
8957 Returns the current position of the sizer's managed space.
8958 """
d55e5bfc
RD
8959 return _core_.Sizer_GetPosition(*args, **kwargs)
8960
8961 def GetMinSize(*args, **kwargs):
bfddbb17
RD
8962 """
8963 GetMinSize(self) -> Size
8964
8965 Returns the minimal size of the sizer. This is either the combined
8966 minimal size of all the children and their borders or the minimal size
8967 set by SetMinSize, depending on which is bigger.
8968 """
d55e5bfc
RD
8969 return _core_.Sizer_GetMinSize(*args, **kwargs)
8970
8971 def GetSizeTuple(self):
1a6bba1e 8972 return self.GetSize().Get()
d55e5bfc 8973 def GetPositionTuple(self):
1a6bba1e 8974 return self.GetPosition().Get()
d55e5bfc 8975 def GetMinSizeTuple(self):
1a6bba1e 8976 return self.GetMinSize().Get()
d55e5bfc
RD
8977
8978 def RecalcSizes(*args, **kwargs):
bfddbb17
RD
8979 """
8980 RecalcSizes(self)
8981
8982 Using the sizes calculated by `CalcMin` reposition and resize all the
8983 items managed by this sizer. You should not need to call this directly as
8984 it is called by `Layout`.
8985 """
d55e5bfc
RD
8986 return _core_.Sizer_RecalcSizes(*args, **kwargs)
8987
8988 def CalcMin(*args, **kwargs):
bfddbb17
RD
8989 """
8990 CalcMin(self) -> Size
8991
8992 This method is where the sizer will do the actual calculation of its
8993 children's minimal sizes. You should not need to call this directly as
8994 it is called by `Layout`.
8995 """
d55e5bfc
RD
8996 return _core_.Sizer_CalcMin(*args, **kwargs)
8997
8998 def Layout(*args, **kwargs):
bfddbb17
RD
8999 """
9000 Layout(self)
9001
9002 This method will force the recalculation and layout of the items
9003 controlled by the sizer using the current space allocated to the
9004 sizer. Normally this is called automatically from the owning window's
9005 EVT_SIZE handler, but it is also useful to call it from user code when
9006 one of the items in a sizer change size, or items are added or
9007 removed.
9008 """
d55e5bfc
RD
9009 return _core_.Sizer_Layout(*args, **kwargs)
9010
9011 def Fit(*args, **kwargs):
bfddbb17
RD
9012 """
9013 Fit(self, Window window) -> Size
9014
9015 Tell the sizer to resize the *window* to match the sizer's minimal
9016 size. This is commonly done in the constructor of the window itself in
9017 order to set its initial size to match the needs of the children as
9018 determined by the sizer. Returns the new size.
9019
9020 For a top level window this is the total window size, not the client size.
9021 """
d55e5bfc
RD
9022 return _core_.Sizer_Fit(*args, **kwargs)
9023
9024 def FitInside(*args, **kwargs):
bfddbb17
RD
9025 """
9026 FitInside(self, Window window)
9027
9028 Tell the sizer to resize the *virtual size* of the *window* to match the
9029 sizer's minimal size. This will not alter the on screen size of the
9030 window, but may cause the addition/removal/alteration of scrollbars
9031 required to view the virtual area in windows which manage it.
9032
9033 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9034
9035 """
d55e5bfc
RD
9036 return _core_.Sizer_FitInside(*args, **kwargs)
9037
9038 def SetSizeHints(*args, **kwargs):
bfddbb17
RD
9039 """
9040 SetSizeHints(self, Window window)
9041
9042 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9043 match the sizer's minimal size. This is commonly done in the
9044 constructor of the window itself if the window is resizable (as are
9045 many dialogs under Unix and frames on probably all platforms) in order
9046 to prevent the window from being sized smaller than the minimal size
9047 required by the sizer.
9048 """
d55e5bfc
RD
9049 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9050
9051 def SetVirtualSizeHints(*args, **kwargs):
bfddbb17
RD
9052 """
9053 SetVirtualSizeHints(self, Window window)
9054
9055 Tell the sizer to set the minimal size of the window virtual area to
9056 match the sizer's minimal size. For windows with managed scrollbars
9057 this will set them appropriately.
9058
9059 :see: `wx.ScrolledWindow.SetScrollbars`
9060
9061 """
d55e5bfc
RD
9062 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9063
9064 def Clear(*args, **kwargs):
bfddbb17
RD
9065 """
9066 Clear(self, bool deleteWindows=False)
9067
9068 Clear all items from the sizer, optionally destroying the window items
9069 as well.
9070 """
d55e5bfc
RD
9071 return _core_.Sizer_Clear(*args, **kwargs)
9072
9073 def DeleteWindows(*args, **kwargs):
bfddbb17
RD
9074 """
9075 DeleteWindows(self)
9076
9077 Destroy all windows managed by the sizer.
9078 """
d55e5bfc
RD
9079 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9080
9081 def GetChildren(*args, **kwargs):
bfddbb17
RD
9082 """
9083 GetChildren(sefl) -> list
9084
9085 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9086 """
d55e5bfc
RD
9087 return _core_.Sizer_GetChildren(*args, **kwargs)
9088
9089 def Show(*args, **kwargs):
bfddbb17
RD
9090 """
9091 Show(self, item, bool show=True)
d55e5bfc 9092
bfddbb17
RD
9093 Shows or hides an item managed by the sizer. To make a sizer item
9094 disappear or reappear, use Show followed by `Layout`. The *item*
9095 parameter can be either a window, a sizer, or the zero-based index of
9096 the item.
9097 """
9098 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
9099
9100 def IsShown(*args, **kwargs):
bfddbb17
RD
9101 """
9102 IsShown(self, item)
9103
9104 Determines if the item is currently shown. sizer. To make a sizer
9105 item disappear or reappear, use Show followed by `Layout`. The *item*
9106 parameter can be either a window, a sizer, or the zero-based index of
9107 the item.
9108 """
d55e5bfc
RD
9109 return _core_.Sizer_IsShown(*args, **kwargs)
9110
bfddbb17
RD
9111 def Hide(self, item):
9112 """
9113 A convenience method for Show(item, False).
9114 """
9115 self.Show(item, False)
9116
d55e5bfc 9117 def ShowItems(*args, **kwargs):
bfddbb17
RD
9118 """
9119 ShowItems(self, bool show)
9120
9121 Recursively call `wx.Window.Show` on all sizer items.
9122 """
d55e5bfc
RD
9123 return _core_.Sizer_ShowItems(*args, **kwargs)
9124
9125
9126class SizerPtr(Sizer):
9127 def __init__(self, this):
9128 self.this = this
9129 if not hasattr(self,"thisown"): self.thisown = 0
9130 self.__class__ = Sizer
9131_core_.Sizer_swigregister(SizerPtr)
9132
9133class PySizer(Sizer):
bfddbb17
RD
9134 """
9135 wx.PySizer is a special version of `wx.Sizer` that has been
9136 instrumented to allow the C++ virtual methods to be overloaded in
9137 Python derived classes. You would derive from this class if you are
9138 wanting to implement a custom sizer in Python code. Simply implement
9139 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9140 For example::
9141
9142 class MySizer(wx.PySizer):
9143 def __init__(self):
9144 wx.PySizer.__init__(self)
9145
9146 def CalcMin(self):
9147 for item in self.GetChildren():
9148 # calculate the total minimum width and height needed
9149 # by all items in the sizer according to this sizer's
9150 # layout algorithm.
9151 ...
9152 return wx.Size(width, height)
9153
9154 def RecalcSizes(self):
9155 # find the space allotted to this sizer
9156 pos = self.GetPosition()
9157 size = self.GetSize()
9158 for item in self.GetChildren():
9159 # Recalculate (if necessary) the position and size of
9160 # each item and then call item.SetDimension to do the
9161 # actual positioning and sizing of the items within the
9162 # space alloted to this sizer.
9163 ...
9164 item.SetDimension(itemPos, itemSize)
9165
9166
9167 When `Layout` is called it first calls `CalcMin` followed by
9168 `RecalcSizes` so you can optimize a bit by saving the results of
9169 `CalcMin` and resuing them in `RecalcSizes`.
9170
9171 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9172
9173
9174 """
d55e5bfc
RD
9175 def __repr__(self):
9176 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9177 def __init__(self, *args, **kwargs):
bfddbb17
RD
9178 """
9179 __init__(self) -> PySizer
9180
9181 Creates a wx.PySizer. Must be called from the __init__ in the derived
9182 class.
9183 """
d55e5bfc
RD
9184 newobj = _core_.new_PySizer(*args, **kwargs)
9185 self.this = newobj.this
9186 self.thisown = 1
9187 del newobj.thisown
9188 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
9189
9190 def _setCallbackInfo(*args, **kwargs):
9191 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
9192 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
9193
9194
9195class PySizerPtr(PySizer):
9196 def __init__(self, this):
9197 self.this = this
9198 if not hasattr(self,"thisown"): self.thisown = 0
9199 self.__class__ = PySizer
9200_core_.PySizer_swigregister(PySizerPtr)
9201
9202#---------------------------------------------------------------------------
9203
9204class BoxSizer(Sizer):
bfddbb17
RD
9205 """
9206 The basic idea behind a box sizer is that windows will most often be
9207 laid out in rather simple basic geometry, typically in a row or a
9208 column or nested hierarchies of either. A wx.BoxSizer will lay out
9209 its items in a simple row or column, depending on the orientation
9210 parameter passed to the constructor.
9211 """
d55e5bfc
RD
9212 def __repr__(self):
9213 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9214 def __init__(self, *args, **kwargs):
bfddbb17
RD
9215 """
9216 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9217
9218 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9219 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9220 sizer.
9221 """
d55e5bfc
RD
9222 newobj = _core_.new_BoxSizer(*args, **kwargs)
9223 self.this = newobj.this
9224 self.thisown = 1
9225 del newobj.thisown
9226 self._setOORInfo(self)
9227
9228 def GetOrientation(*args, **kwargs):
bfddbb17
RD
9229 """
9230 GetOrientation(self) -> int
9231
9232 Returns the current orientation of the sizer.
9233 """
d55e5bfc
RD
9234 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
9235
9236 def SetOrientation(*args, **kwargs):
bfddbb17
RD
9237 """
9238 SetOrientation(self, int orient)
d55e5bfc 9239
bfddbb17
RD
9240 Resets the orientation of the sizer.
9241 """
9242 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
9243
9244
9245class BoxSizerPtr(BoxSizer):
9246 def __init__(self, this):
9247 self.this = this
9248 if not hasattr(self,"thisown"): self.thisown = 0
9249 self.__class__ = BoxSizer
9250_core_.BoxSizer_swigregister(BoxSizerPtr)
9251
9252#---------------------------------------------------------------------------
9253
9254class StaticBoxSizer(BoxSizer):
bfddbb17
RD
9255 """
9256 wx.StaticBoxSizer derives from and functions identically to the
9257 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9258 manages. Note that this static box must be created separately and
9259 passed to the sizer constructor.
9260 """
d55e5bfc
RD
9261 def __repr__(self):
9262 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9263 def __init__(self, *args, **kwargs):
bfddbb17
RD
9264 """
9265 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9266
9267 Constructor. It takes an associated static box and the orientation
9268 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9269 ``wx.HORIZONTAL``.
9270 """
d55e5bfc
RD
9271 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
9272 self.this = newobj.this
9273 self.thisown = 1
9274 del newobj.thisown
9275 self._setOORInfo(self)
9276
9277 def GetStaticBox(*args, **kwargs):
bfddbb17
RD
9278 """
9279 GetStaticBox(self) -> StaticBox
d55e5bfc 9280
bfddbb17
RD
9281 Returns the static box associated with this sizer.
9282 """
9283 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
9284
9285
9286class StaticBoxSizerPtr(StaticBoxSizer):
9287 def __init__(self, this):
9288 self.this = this
9289 if not hasattr(self,"thisown"): self.thisown = 0
9290 self.__class__ = StaticBoxSizer
9291_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
9292
9293#---------------------------------------------------------------------------
9294
9295class GridSizer(Sizer):
bfddbb17
RD
9296 """
9297 A grid sizer is a sizer which lays out its children in a
9298 two-dimensional table with all cells having the same size. In other
9299 words, the width of each cell within the grid is the width of the
9300 widest item added to the sizer and the height of each grid cell is the
9301 height of the tallest item. An optional vertical and/or horizontal
9302 gap between items can also be specified (in pixels.)
9303
9304 Items are placed in the cells of the grid in the order they are added,
9305 in row-major order. In other words, the first row is filled first,
9306 then the second, and so on until all items have been added. (If
9307 neccessary, additional rows will be added as items are added.) If you
9308 need to have greater control over the cells that items are placed in
9309 then use the `wx.GridBagSizer`.
9310
9311 """
d55e5bfc
RD
9312 def __repr__(self):
9313 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9314 def __init__(self, *args, **kwargs):
bfddbb17
RD
9315 """
9316 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9317
9318 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9319 of columns and rows in the sizer - if either of the parameters is
9320 zero, it will be calculated to from the total number of children in
9321 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9322 define extra space between all children.
9323 """
d55e5bfc
RD
9324 newobj = _core_.new_GridSizer(*args, **kwargs)
9325 self.this = newobj.this
9326 self.thisown = 1
9327 del newobj.thisown
9328 self._setOORInfo(self)
9329
d55e5bfc 9330 def SetCols(*args, **kwargs):
bfddbb17
RD
9331 """
9332 SetCols(self, int cols)
9333
9334 Sets the number of columns in the sizer.
9335 """
d55e5bfc
RD
9336 return _core_.GridSizer_SetCols(*args, **kwargs)
9337
9338 def SetRows(*args, **kwargs):
bfddbb17
RD
9339 """
9340 SetRows(self, int rows)
9341
9342 Sets the number of rows in the sizer.
9343 """
d55e5bfc
RD
9344 return _core_.GridSizer_SetRows(*args, **kwargs)
9345
9346 def SetVGap(*args, **kwargs):
bfddbb17
RD
9347 """
9348 SetVGap(self, int gap)
9349
9350 Sets the vertical gap (in pixels) between the cells in the sizer.
9351 """
d55e5bfc
RD
9352 return _core_.GridSizer_SetVGap(*args, **kwargs)
9353
9354 def SetHGap(*args, **kwargs):
bfddbb17
RD
9355 """
9356 SetHGap(self, int gap)
9357
9358 Sets the horizontal gap (in pixels) between cells in the sizer
9359 """
d55e5bfc
RD
9360 return _core_.GridSizer_SetHGap(*args, **kwargs)
9361
9362 def GetCols(*args, **kwargs):
bfddbb17
RD
9363 """
9364 GetCols(self) -> int
9365
9366 Returns the number of columns in the sizer.
9367 """
d55e5bfc
RD
9368 return _core_.GridSizer_GetCols(*args, **kwargs)
9369
9370 def GetRows(*args, **kwargs):
bfddbb17
RD
9371 """
9372 GetRows(self) -> int
9373
9374 Returns the number of rows in the sizer.
9375 """
d55e5bfc
RD
9376 return _core_.GridSizer_GetRows(*args, **kwargs)
9377
9378 def GetVGap(*args, **kwargs):
bfddbb17
RD
9379 """
9380 GetVGap(self) -> int
9381
9382 Returns the vertical gap (in pixels) between the cells in the sizer.
9383 """
d55e5bfc
RD
9384 return _core_.GridSizer_GetVGap(*args, **kwargs)
9385
9386 def GetHGap(*args, **kwargs):
bfddbb17
RD
9387 """
9388 GetHGap(self) -> int
9389
9390 Returns the horizontal gap (in pixels) between cells in the sizer.
9391 """
d55e5bfc
RD
9392 return _core_.GridSizer_GetHGap(*args, **kwargs)
9393
9394
9395class GridSizerPtr(GridSizer):
9396 def __init__(self, this):
9397 self.this = this
9398 if not hasattr(self,"thisown"): self.thisown = 0
9399 self.__class__ = GridSizer
9400_core_.GridSizer_swigregister(GridSizerPtr)
9401
9402#---------------------------------------------------------------------------
9403
9404FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9405FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9406FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
9407class FlexGridSizer(GridSizer):
bfddbb17
RD
9408 """
9409 A flex grid sizer is a sizer which lays out its children in a
9410 two-dimensional table with all table cells in one row having the same
9411 height and all cells in one column having the same width, but all
9412 rows or all columns are not necessarily the same height or width as in
9413 the `wx.GridSizer`.
9414
9415 wx.FlexGridSizer can also size items equally in one direction but
9416 unequally ("flexibly") in the other. If the sizer is only flexible
9417 in one direction (this can be changed using `SetFlexibleDirection`), it
9418 needs to be decided how the sizer should grow in the other ("non
9419 flexible") direction in order to fill the available space. The
9420 `SetNonFlexibleGrowMode` method serves this purpose.
9421
9422
9423 """
d55e5bfc
RD
9424 def __repr__(self):
9425 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9426 def __init__(self, *args, **kwargs):
bfddbb17
RD
9427 """
9428 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9429
9430 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9431 number of columns and rows in the sizer - if either of the parameters
9432 is zero, it will be calculated to from the total number of children in
9433 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9434 define extra space between all children.
9435 """
d55e5bfc
RD
9436 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
9437 self.this = newobj.this
9438 self.thisown = 1
9439 del newobj.thisown
9440 self._setOORInfo(self)
9441
bfddbb17
RD
9442 def AddGrowableRow(*args, **kwargs):
9443 """
9444 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 9445
bfddbb17
RD
9446 Specifies that row *idx* (starting from zero) should be grown if there
9447 is extra space available to the sizer.
d55e5bfc 9448
bfddbb17
RD
9449 The *proportion* parameter has the same meaning as the stretch factor
9450 for the box sizers except that if all proportions are 0, then all
9451 columns are resized equally (instead of not being resized at all).
9452 """
d55e5bfc
RD
9453 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
9454
9455 def RemoveGrowableRow(*args, **kwargs):
bfddbb17
RD
9456 """
9457 RemoveGrowableRow(self, size_t idx)
9458
9459 Specifies that row *idx* is no longer growable.
9460 """
d55e5bfc
RD
9461 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
9462
9463 def AddGrowableCol(*args, **kwargs):
bfddbb17
RD
9464 """
9465 AddGrowableCol(self, size_t idx, int proportion=0)
9466
9467 Specifies that column *idx* (starting from zero) should be grown if
9468 there is extra space available to the sizer.
9469
9470 The *proportion* parameter has the same meaning as the stretch factor
9471 for the box sizers except that if all proportions are 0, then all
9472 columns are resized equally (instead of not being resized at all).
9473 """
d55e5bfc
RD
9474 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
9475
9476 def RemoveGrowableCol(*args, **kwargs):
bfddbb17
RD
9477 """
9478 RemoveGrowableCol(self, size_t idx)
9479
9480 Specifies that column *idx* is no longer growable.
9481 """
d55e5bfc
RD
9482 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
9483
9484 def SetFlexibleDirection(*args, **kwargs):
bfddbb17
RD
9485 """
9486 SetFlexibleDirection(self, int direction)
9487
9488 Specifies whether the sizer should flexibly resize its columns, rows,
9489 or both. Argument *direction* can be one of the following values. Any
9490 other value is ignored.
9491
9492 ============== =======================================
9493 wx.VERTICAL Rows are flexibly sized.
9494 wx.HORIZONTAL Columns are flexibly sized.
9495 wx.BOTH Both rows and columns are flexibly sized
9496 (this is the default value).
9497 ============== =======================================
9498
9499 Note that this method does not trigger relayout.
9500
9501 """
d55e5bfc
RD
9502 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
9503
9504 def GetFlexibleDirection(*args, **kwargs):
bfddbb17
RD
9505 """
9506 GetFlexibleDirection(self) -> int
9507
9508 Returns a value that specifies whether the sizer
9509 flexibly resizes its columns, rows, or both (default).
9510
9511 :see: `SetFlexibleDirection`
9512 """
d55e5bfc
RD
9513 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
9514
9515 def SetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD
9516 """
9517 SetNonFlexibleGrowMode(self, int mode)
9518
9519 Specifies how the sizer should grow in the non-flexible direction if
9520 there is one (so `SetFlexibleDirection` must have been called
9521 previously). Argument *mode* can be one of the following values:
9522
9523 ========================== =================================================
9524 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9525 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9526 `AddGrowableCol` and `AddGrowableRow`. In this
9527 case equal sizing applies to minimum sizes of
9528 columns or rows (this is the default value).
9529 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9530 the non flexible direction, whether they are
9531 growable or not in the flexbile direction.
9532 ========================== =================================================
9533
9534 Note that this method does not trigger relayout.
9535
9536
9537 """
d55e5bfc
RD
9538 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
9539
9540 def GetNonFlexibleGrowMode(*args, **kwargs):
bfddbb17
RD
9541 """
9542 GetNonFlexibleGrowMode(self) -> int
9543
9544 Returns the value that specifies how the sizer grows in the
9545 non-flexible direction if there is one.
9546
9547 :see: `SetNonFlexibleGrowMode`
9548 """
d55e5bfc
RD
9549 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
9550
9551 def GetRowHeights(*args, **kwargs):
fd2dc343
RD
9552 """
9553 GetRowHeights(self) -> list
9554
9555 Returns a list of integers representing the heights of each of the
9556 rows in the sizer.
9557 """
d55e5bfc
RD
9558 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
9559
9560 def GetColWidths(*args, **kwargs):
fd2dc343
RD
9561 """
9562 GetColWidths(self) -> list
9563
9564 Returns a list of integers representing the widths of each of the
9565 columns in the sizer.
9566 """
d55e5bfc
RD
9567 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
9568
9569
9570class FlexGridSizerPtr(FlexGridSizer):
9571 def __init__(self, this):
9572 self.this = this
9573 if not hasattr(self,"thisown"): self.thisown = 0
9574 self.__class__ = FlexGridSizer
9575_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
9576
9577#---------------------------------------------------------------------------
9578
9579class GBPosition(object):
bfddbb17
RD
9580 """
9581 This class represents the position of an item in a virtual grid of
9582 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9583 typemaps that will automatically convert from a 2-element sequence of
9584 integers to a wx.GBPosition, so you can use the more pythonic
9585 representation of the position nearly transparently in Python code.
9586 """
d55e5bfc
RD
9587 def __repr__(self):
9588 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9589 def __init__(self, *args, **kwargs):
bfddbb17
RD
9590 """
9591 __init__(self, int row=0, int col=0) -> GBPosition
9592
9593 This class represents the position of an item in a virtual grid of
9594 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9595 typemaps that will automatically convert from a 2-element sequence of
9596 integers to a wx.GBPosition, so you can use the more pythonic
9597 representation of the position nearly transparently in Python code.
9598 """
d55e5bfc
RD
9599 newobj = _core_.new_GBPosition(*args, **kwargs)
9600 self.this = newobj.this
9601 self.thisown = 1
9602 del newobj.thisown
9603 def GetRow(*args, **kwargs):
9604 """GetRow(self) -> int"""
9605 return _core_.GBPosition_GetRow(*args, **kwargs)
9606
9607 def GetCol(*args, **kwargs):
9608 """GetCol(self) -> int"""
9609 return _core_.GBPosition_GetCol(*args, **kwargs)
9610
9611 def SetRow(*args, **kwargs):
9612 """SetRow(self, int row)"""
9613 return _core_.GBPosition_SetRow(*args, **kwargs)
9614
9615 def SetCol(*args, **kwargs):
9616 """SetCol(self, int col)"""
9617 return _core_.GBPosition_SetCol(*args, **kwargs)
9618
9619 def __eq__(*args, **kwargs):
9620 """__eq__(self, GBPosition other) -> bool"""
9621 return _core_.GBPosition___eq__(*args, **kwargs)
9622
9623 def __ne__(*args, **kwargs):
9624 """__ne__(self, GBPosition other) -> bool"""
9625 return _core_.GBPosition___ne__(*args, **kwargs)
9626
9627 def Set(*args, **kwargs):
9628 """Set(self, int row=0, int col=0)"""
9629 return _core_.GBPosition_Set(*args, **kwargs)
9630
9631 def Get(*args, **kwargs):
9632 """Get(self) -> PyObject"""
9633 return _core_.GBPosition_Get(*args, **kwargs)
9634
15817c7e 9635 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
9636 def __str__(self): return str(self.Get())
9637 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9638 def __len__(self): return len(self.Get())
9639 def __getitem__(self, index): return self.Get()[index]
9640 def __setitem__(self, index, val):
9641 if index == 0: self.SetRow(val)
9642 elif index == 1: self.SetCol(val)
9643 else: raise IndexError
9644 def __nonzero__(self): return self.Get() != (0,0)
9645 __safe_for_unpickling__ = True
9646 def __reduce__(self): return (wx.GBPosition, self.Get())
9647
9648 row = property(GetRow, SetRow)
9649 col = property(GetCol, SetCol)
9650
9651
9652class GBPositionPtr(GBPosition):
9653 def __init__(self, this):
9654 self.this = this
9655 if not hasattr(self,"thisown"): self.thisown = 0
9656 self.__class__ = GBPosition
9657_core_.GBPosition_swigregister(GBPositionPtr)
9658
9659class GBSpan(object):
bfddbb17
RD
9660 """
9661 This class is used to hold the row and column spanning attributes of
9662 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9663 automatically convert from a 2-element sequence of integers to a
9664 wx.GBSpan, so you can use the more pythonic representation of the span
9665 nearly transparently in Python code.
9666
9667 """
d55e5bfc
RD
9668 def __repr__(self):
9669 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9670 def __init__(self, *args, **kwargs):
bfddbb17
RD
9671 """
9672 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9673
9674 Construct a new wxGBSpan, optionally setting the rowspan and
9675 colspan. The default is (1,1). (Meaning that the item occupies one
9676 cell in each direction.
9677 """
d55e5bfc
RD
9678 newobj = _core_.new_GBSpan(*args, **kwargs)
9679 self.this = newobj.this
9680 self.thisown = 1
9681 del newobj.thisown
9682 def GetRowspan(*args, **kwargs):
9683 """GetRowspan(self) -> int"""
9684 return _core_.GBSpan_GetRowspan(*args, **kwargs)
9685
9686 def GetColspan(*args, **kwargs):
9687 """GetColspan(self) -> int"""
9688 return _core_.GBSpan_GetColspan(*args, **kwargs)
9689
9690 def SetRowspan(*args, **kwargs):
9691 """SetRowspan(self, int rowspan)"""
9692 return _core_.GBSpan_SetRowspan(*args, **kwargs)
9693
9694 def SetColspan(*args, **kwargs):
9695 """SetColspan(self, int colspan)"""
9696 return _core_.GBSpan_SetColspan(*args, **kwargs)
9697
9698 def __eq__(*args, **kwargs):
9699 """__eq__(self, GBSpan other) -> bool"""
9700 return _core_.GBSpan___eq__(*args, **kwargs)
9701
9702 def __ne__(*args, **kwargs):
9703 """__ne__(self, GBSpan other) -> bool"""
9704 return _core_.GBSpan___ne__(*args, **kwargs)
9705
9706 def Set(*args, **kwargs):
9707 """Set(self, int rowspan=1, int colspan=1)"""
9708 return _core_.GBSpan_Set(*args, **kwargs)
9709
9710 def Get(*args, **kwargs):
9711 """Get(self) -> PyObject"""
9712 return _core_.GBSpan_Get(*args, **kwargs)
9713
15817c7e 9714 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
9715 def __str__(self): return str(self.Get())
9716 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
9717 def __len__(self): return len(self.Get())
9718 def __getitem__(self, index): return self.Get()[index]
9719 def __setitem__(self, index, val):
9720 if index == 0: self.SetRowspan(val)
9721 elif index == 1: self.SetColspan(val)
9722 else: raise IndexError
9723 def __nonzero__(self): return self.Get() != (0,0)
9724 __safe_for_unpickling__ = True
9725 def __reduce__(self): return (wx.GBSpan, self.Get())
9726
9727 rowspan = property(GetRowspan, SetRowspan)
9728 colspan = property(GetColspan, SetColspan)
9729
9730
9731class GBSpanPtr(GBSpan):
9732 def __init__(self, this):
9733 self.this = this
9734 if not hasattr(self,"thisown"): self.thisown = 0
9735 self.__class__ = GBSpan
9736_core_.GBSpan_swigregister(GBSpanPtr)
9737
9738class GBSizerItem(SizerItem):
bfddbb17
RD
9739 """
9740 The wx.GBSizerItem class is used to track the additional data about
9741 items in a `wx.GridBagSizer` such as the item's position in the grid
9742 and how many rows or columns it spans.
9743
9744 """
d55e5bfc
RD
9745 def __repr__(self):
9746 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9747 def __init__(self, *args, **kwargs):
bfddbb17
RD
9748 """
9749 __init__(self) -> GBSizerItem
9750
9751 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
9752 size will need to be set, as well as a position and span before this
9753 item can be used in a Sizer.
9754
9755 You will probably never need to create a wx.GBSizerItem directly as they
9756 are created automatically when the sizer's Add method is called.
9757 """
d55e5bfc
RD
9758 newobj = _core_.new_GBSizerItem(*args, **kwargs)
9759 self.this = newobj.this
9760 self.thisown = 1
9761 del newobj.thisown
9762 def GetPos(*args, **kwargs):
bfddbb17
RD
9763 """
9764 GetPos(self) -> GBPosition
9765
9766 Get the grid position of the item
9767 """
d55e5bfc
RD
9768 return _core_.GBSizerItem_GetPos(*args, **kwargs)
9769
9770 def GetPosTuple(self): return self.GetPos().Get()
9771 def GetSpan(*args, **kwargs):
bfddbb17
RD
9772 """
9773 GetSpan(self) -> GBSpan
9774
9775 Get the row and column spanning of the item
9776 """
d55e5bfc
RD
9777 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
9778
9779 def GetSpanTuple(self): return self.GetSpan().Get()
9780 def SetPos(*args, **kwargs):
bfddbb17
RD
9781 """
9782 SetPos(self, GBPosition pos) -> bool
9783
9784 If the item is already a member of a sizer then first ensure that
9785 there is no other item that would intersect with this one at the new
9786 position, then set the new position. Returns True if the change is
9787 successful and after the next Layout() the item will be moved.
9788 """
d55e5bfc
RD
9789 return _core_.GBSizerItem_SetPos(*args, **kwargs)
9790
9791 def SetSpan(*args, **kwargs):
bfddbb17
RD
9792 """
9793 SetSpan(self, GBSpan span) -> bool
9794
9795 If the item is already a member of a sizer then first ensure that
9796 there is no other item that would intersect with this one with its new
9797 spanning size, then set the new spanning. Returns True if the change
9798 is successful and after the next Layout() the item will be resized.
9799
9800 """
d55e5bfc
RD
9801 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
9802
bfddbb17 9803 def Intersects(*args, **kwargs):
d55e5bfc
RD
9804 """
9805 Intersects(self, GBSizerItem other) -> bool
bfddbb17
RD
9806
9807 Returns True if this item and the other item instersect.
d55e5bfc 9808 """
bfddbb17
RD
9809 return _core_.GBSizerItem_Intersects(*args, **kwargs)
9810
9811 def IntersectsPos(*args, **kwargs):
9812 """
9813 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
9814
9815 Returns True if the given pos/span would intersect with this item.
9816 """
9817 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
9818
9819 def GetEndPos(*args, **kwargs):
bfddbb17
RD
9820 """
9821 GetEndPos(self) -> GBPosition
9822
9823 Get the row and column of the endpoint of this item.
9824 """
d55e5bfc
RD
9825 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
9826
9827 def GetGBSizer(*args, **kwargs):
bfddbb17
RD
9828 """
9829 GetGBSizer(self) -> GridBagSizer
9830
9831 Get the sizer this item is a member of.
9832 """
d55e5bfc
RD
9833 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
9834
9835 def SetGBSizer(*args, **kwargs):
bfddbb17
RD
9836 """
9837 SetGBSizer(self, GridBagSizer sizer)
9838
9839 Set the sizer this item is a member of.
9840 """
d55e5bfc
RD
9841 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
9842
9843
9844class GBSizerItemPtr(GBSizerItem):
9845 def __init__(self, this):
9846 self.this = this
9847 if not hasattr(self,"thisown"): self.thisown = 0
9848 self.__class__ = GBSizerItem
9849_core_.GBSizerItem_swigregister(GBSizerItemPtr)
9850DefaultSpan = cvar.DefaultSpan
9851
9852def GBSizerItemWindow(*args, **kwargs):
9853 """
9854 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
bfddbb17
RD
9855 int border, PyObject userData=None) -> GBSizerItem
9856
9857 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
9858 """
9859 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
9860 val.thisown = 1
9861 return val
9862
9863def GBSizerItemSizer(*args, **kwargs):
9864 """
9865 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
bfddbb17
RD
9866 int border, PyObject userData=None) -> GBSizerItem
9867
9868 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
9869 """
9870 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
9871 val.thisown = 1
9872 return val
9873
9874def GBSizerItemSpacer(*args, **kwargs):
9875 """
9876 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
bfddbb17
RD
9877 int flag, int border, PyObject userData=None) -> GBSizerItem
9878
9879 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
9880 """
9881 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
9882 val.thisown = 1
9883 return val
9884
9885class GridBagSizer(FlexGridSizer):
bfddbb17
RD
9886 """
9887 A `wx.Sizer` that can lay out items in a virtual grid like a
9888 `wx.FlexGridSizer` but in this case explicit positioning of the items
9889 is allowed using `wx.GBPosition`, and items can optionally span more
9890 than one row and/or column using `wx.GBSpan`. The total size of the
9891 virtual grid is determined by the largest row and column that items are
9892 positioned at, adjusted for spanning.
9893
9894 """
d55e5bfc
RD
9895 def __repr__(self):
9896 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9897 def __init__(self, *args, **kwargs):
bfddbb17
RD
9898 """
9899 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
9900
9901 Constructor, with optional parameters to specify the gap between the
9902 rows and columns.
9903 """
d55e5bfc
RD
9904 newobj = _core_.new_GridBagSizer(*args, **kwargs)
9905 self.this = newobj.this
9906 self.thisown = 1
9907 del newobj.thisown
9908 def Add(*args, **kwargs):
9909 """
bfddbb17
RD
9910 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
9911 int border=0, userData=None)
9912
9913 Adds an item to the sizer at the grid cell *pos*, optionally spanning
9914 more than one row or column as specified with *span*. The remaining
9915 args behave similarly to `wx.Sizer.Add`.
9916
9917 Returns True if the item was successfully placed at the given cell
9918 position, False if something was already there.
9919
d55e5bfc
RD
9920 """
9921 return _core_.GridBagSizer_Add(*args, **kwargs)
9922
9923 def AddItem(*args, **kwargs):
bfddbb17
RD
9924 """
9925 Add(self, GBSizerItem item) -> bool
9926
9927 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
9928 the item was successfully placed at its given cell position, False if
9929 something was already there.
9930 """
d55e5bfc
RD
9931 return _core_.GridBagSizer_AddItem(*args, **kwargs)
9932
9933 def GetEmptyCellSize(*args, **kwargs):
bfddbb17
RD
9934 """
9935 GetEmptyCellSize(self) -> Size
9936
9937 Get the size used for cells in the grid with no item.
9938 """
d55e5bfc
RD
9939 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
9940
9941 def SetEmptyCellSize(*args, **kwargs):
bfddbb17
RD
9942 """
9943 SetEmptyCellSize(self, Size sz)
9944
9945 Set the size used for cells in the grid with no item.
9946 """
d55e5bfc
RD
9947 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
9948
9949 def GetItemPosition(*args):
9950 """
bfddbb17
RD
9951 GetItemPosition(self, item) -> GBPosition
9952
9953 Get the grid position of the specified *item* where *item* is either a
9954 window or subsizer that is a member of this sizer, or a zero-based
9955 index of an item.
d55e5bfc
RD
9956 """
9957 return _core_.GridBagSizer_GetItemPosition(*args)
9958
9959 def SetItemPosition(*args):
9960 """
bfddbb17
RD
9961 SetItemPosition(self, item, GBPosition pos) -> bool
9962
9963 Set the grid position of the specified *item* where *item* is either a
9964 window or subsizer that is a member of this sizer, or a zero-based
9965 index of an item. Returns True on success. If the move is not
9966 allowed (because an item is already there) then False is returned.
9967
d55e5bfc
RD
9968 """
9969 return _core_.GridBagSizer_SetItemPosition(*args)
9970
9971 def GetItemSpan(*args):
9972 """
bfddbb17
RD
9973 GetItemSpan(self, item) -> GBSpan
9974
9975 Get the row/col spanning of the specified *item* where *item* is
9976 either a window or subsizer that is a member of this sizer, or a
9977 zero-based index of an item.
d55e5bfc
RD
9978 """
9979 return _core_.GridBagSizer_GetItemSpan(*args)
9980
9981 def SetItemSpan(*args):
9982 """
bfddbb17
RD
9983 SetItemSpan(self, item, GBSpan span) -> bool
9984
9985 Set the row/col spanning of the specified *item* where *item* is
9986 either a window or subsizer that is a member of this sizer, or a
9987 zero-based index of an item. Returns True on success. If the move is
9988 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
9989 """
9990 return _core_.GridBagSizer_SetItemSpan(*args)
9991
9992 def FindItem(*args):
9993 """
bfddbb17
RD
9994 FindItem(self, item) -> GBSizerItem
9995
9996 Find the sizer item for the given window or subsizer, returns None if
9997 not found. (non-recursive)
d55e5bfc
RD
9998 """
9999 return _core_.GridBagSizer_FindItem(*args)
10000
10001 def FindItemAtPosition(*args, **kwargs):
bfddbb17
RD
10002 """
10003 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10004
10005 Return the sizer item for the given grid cell, or None if there is no
10006 item at that position. (non-recursive)
10007 """
d55e5bfc
RD
10008 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10009
10010 def FindItemAtPoint(*args, **kwargs):
bfddbb17
RD
10011 """
10012 FindItemAtPoint(self, Point pt) -> GBSizerItem
10013
10014 Return the sizer item located at the point given in *pt*, or None if
10015 there is no item at that point. The (x,y) coordinates in pt correspond
10016 to the client coordinates of the window using the sizer for
10017 layout. (non-recursive)
10018 """
d55e5bfc
RD
10019 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10020
bfddbb17
RD
10021 def CheckForIntersection(*args, **kwargs):
10022 """
10023 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10024
bfddbb17
RD
10025 Look at all items and see if any intersect (or would overlap) the
10026 given *item*. Returns True if so, False if there would be no overlap.
10027 If an *excludeItem* is given then it will not be checked for
10028 intersection, for example it may be the item we are checking the
10029 position of.
d55e5bfc 10030
bfddbb17
RD
10031 """
10032 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10033
bfddbb17 10034 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10035 """
bfddbb17
RD
10036 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10037
10038 Look at all items and see if any intersect (or would overlap) the
10039 given position and span. Returns True if so, False if there would be
10040 no overlap. If an *excludeItem* is given then it will not be checked
10041 for intersection, for example it may be the item we are checking the
10042 position of.
d55e5bfc 10043 """
bfddbb17 10044 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
10045
10046
10047class GridBagSizerPtr(GridBagSizer):
10048 def __init__(self, this):
10049 self.this = this
10050 if not hasattr(self,"thisown"): self.thisown = 0
10051 self.__class__ = GridBagSizer
10052_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10053
10054#---------------------------------------------------------------------------
10055
10056Left = _core_.Left
10057Top = _core_.Top
10058Right = _core_.Right
10059Bottom = _core_.Bottom
10060Width = _core_.Width
10061Height = _core_.Height
10062Centre = _core_.Centre
10063Center = _core_.Center
10064CentreX = _core_.CentreX
10065CentreY = _core_.CentreY
10066Unconstrained = _core_.Unconstrained
10067AsIs = _core_.AsIs
10068PercentOf = _core_.PercentOf
10069Above = _core_.Above
10070Below = _core_.Below
10071LeftOf = _core_.LeftOf
10072RightOf = _core_.RightOf
10073SameAs = _core_.SameAs
10074Absolute = _core_.Absolute
10075class IndividualLayoutConstraint(Object):
10076 """
15817c7e
RD
10077 Objects of this class are stored in the `wx.LayoutConstraints` class as
10078 one of eight possible constraints that a window can be involved in.
10079 You will never need to create an instance of
10080 wx.IndividualLayoutConstraint, rather you should create a
10081 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10082 that it contains.
d55e5bfc
RD
10083 """
10084 def __init__(self): raise RuntimeError, "No constructor defined"
10085 def __repr__(self):
10086 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10087 def Set(*args, **kwargs):
15817c7e
RD
10088 """
10089 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10090
10091 Sets the properties of the constraint. Normally called by one of the
10092 convenience functions such as Above, RightOf, SameAs.
10093 """
d55e5bfc
RD
10094 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
10095
10096 def LeftOf(*args, **kwargs):
10097 """
10098 LeftOf(self, Window sibling, int marg=0)
10099
15817c7e
RD
10100 Constrains this edge to be to the left of the given window, with an
10101 optional margin. Implicitly, this is relative to the left edge of the
10102 other window.
d55e5bfc
RD
10103 """
10104 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
10105
10106 def RightOf(*args, **kwargs):
10107 """
10108 RightOf(self, Window sibling, int marg=0)
10109
15817c7e
RD
10110 Constrains this edge to be to the right of the given window, with an
10111 optional margin. Implicitly, this is relative to the right edge of the
10112 other window.
d55e5bfc
RD
10113 """
10114 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
10115
10116 def Above(*args, **kwargs):
10117 """
10118 Above(self, Window sibling, int marg=0)
10119
15817c7e
RD
10120 Constrains this edge to be above the given window, with an optional
10121 margin. Implicitly, this is relative to the top edge of the other
10122 window.
d55e5bfc
RD
10123 """
10124 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
10125
10126 def Below(*args, **kwargs):
10127 """
10128 Below(self, Window sibling, int marg=0)
10129
15817c7e
RD
10130 Constrains this edge to be below the given window, with an optional
10131 margin. Implicitly, this is relative to the bottom edge of the other
10132 window.
d55e5bfc
RD
10133 """
10134 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
10135
10136 def SameAs(*args, **kwargs):
10137 """
10138 SameAs(self, Window otherW, int edge, int marg=0)
10139
15817c7e
RD
10140 Constrains this edge or dimension to be to the same as the edge of the
10141 given window, with an optional margin.
d55e5bfc
RD
10142 """
10143 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
10144
10145 def PercentOf(*args, **kwargs):
10146 """
10147 PercentOf(self, Window otherW, int wh, int per)
10148
15817c7e
RD
10149 Constrains this edge or dimension to be to a percentage of the given
10150 window, with an optional margin.
d55e5bfc
RD
10151 """
10152 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
10153
10154 def Absolute(*args, **kwargs):
10155 """
10156 Absolute(self, int val)
10157
15817c7e 10158 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
10159 """
10160 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
10161
10162 def Unconstrained(*args, **kwargs):
10163 """
10164 Unconstrained(self)
10165
15817c7e
RD
10166 Sets this edge or dimension to be unconstrained, that is, dependent on
10167 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
10168 """
10169 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
10170
10171 def AsIs(*args, **kwargs):
10172 """
10173 AsIs(self)
10174
15817c7e
RD
10175 Sets this edge or constraint to be whatever the window's value is at
10176 the moment. If either of the width and height constraints are *as is*,
10177 the window will not be resized, but moved instead. This is important
10178 when considering panel items which are intended to have a default
10179 size, such as a button, which may take its size from the size of the
10180 button label.
d55e5bfc
RD
10181 """
10182 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
10183
10184 def GetOtherWindow(*args, **kwargs):
10185 """GetOtherWindow(self) -> Window"""
10186 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
10187
10188 def GetMyEdge(*args, **kwargs):
10189 """GetMyEdge(self) -> int"""
10190 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
10191
10192 def SetEdge(*args, **kwargs):
10193 """SetEdge(self, int which)"""
10194 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
10195
10196 def SetValue(*args, **kwargs):
10197 """SetValue(self, int v)"""
10198 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
10199
10200 def GetMargin(*args, **kwargs):
10201 """GetMargin(self) -> int"""
10202 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
10203
10204 def SetMargin(*args, **kwargs):
10205 """SetMargin(self, int m)"""
10206 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
10207
10208 def GetValue(*args, **kwargs):
10209 """GetValue(self) -> int"""
10210 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
10211
10212 def GetPercent(*args, **kwargs):
10213 """GetPercent(self) -> int"""
10214 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
10215
10216 def GetOtherEdge(*args, **kwargs):
10217 """GetOtherEdge(self) -> int"""
10218 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
10219
10220 def GetDone(*args, **kwargs):
10221 """GetDone(self) -> bool"""
10222 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
10223
10224 def SetDone(*args, **kwargs):
10225 """SetDone(self, bool d)"""
10226 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
10227
10228 def GetRelationship(*args, **kwargs):
10229 """GetRelationship(self) -> int"""
10230 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
10231
10232 def SetRelationship(*args, **kwargs):
10233 """SetRelationship(self, int r)"""
10234 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
10235
10236 def ResetIfWin(*args, **kwargs):
10237 """
10238 ResetIfWin(self, Window otherW) -> bool
10239
10240 Reset constraint if it mentions otherWin
10241 """
10242 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
10243
10244 def SatisfyConstraint(*args, **kwargs):
10245 """
10246 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
10247
10248 Try to satisfy constraint
10249 """
10250 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
10251
10252 def GetEdge(*args, **kwargs):
10253 """
10254 GetEdge(self, int which, Window thisWin, Window other) -> int
10255
10256 Get the value of this edge or dimension, or if this
10257 is not determinable, -1.
10258 """
10259 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
10260
10261
10262class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10263 def __init__(self, this):
10264 self.this = this
10265 if not hasattr(self,"thisown"): self.thisown = 0
10266 self.__class__ = IndividualLayoutConstraint
10267_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
10268
10269class LayoutConstraints(Object):
10270 """
15817c7e
RD
10271 **Note:** constraints are now deprecated and you should use sizers
10272 instead.
d55e5bfc 10273
15817c7e
RD
10274 Objects of this class can be associated with a window to define its
10275 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
10276
10277 The class consists of the following eight constraints of class
10278 wx.IndividualLayoutConstraint, some or all of which should be accessed
10279 directly to set the appropriate constraints.
10280
10281 * left: represents the left hand edge of the window
10282 * right: represents the right hand edge of the window
10283 * top: represents the top edge of the window
10284 * bottom: represents the bottom edge of the window
10285 * width: represents the width of the window
10286 * height: represents the height of the window
10287 * centreX: represents the horizontal centre point of the window
10288 * centreY: represents the vertical centre point of the window
10289
15817c7e
RD
10290 Most constraints are initially set to have the relationship
10291 wxUnconstrained, which means that their values should be calculated by
10292 looking at known constraints. The exceptions are width and height,
10293 which are set to wxAsIs to ensure that if the user does not specify a
10294 constraint, the existing width and height will be used, to be
10295 compatible with panel items which often have take a default size. If
10296 the constraint is ``wx.AsIs``, the dimension will not be changed.
10297
10298 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
10299
10300 """
10301 def __repr__(self):
10302 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10303 left = property(_core_.LayoutConstraints_left_get)
10304 top = property(_core_.LayoutConstraints_top_get)
10305 right = property(_core_.LayoutConstraints_right_get)
10306 bottom = property(_core_.LayoutConstraints_bottom_get)
10307 width = property(_core_.LayoutConstraints_width_get)
10308 height = property(_core_.LayoutConstraints_height_get)
10309 centreX = property(_core_.LayoutConstraints_centreX_get)
10310 centreY = property(_core_.LayoutConstraints_centreY_get)
10311 def __init__(self, *args, **kwargs):
10312 """__init__(self) -> LayoutConstraints"""
10313 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
10314 self.this = newobj.this
10315 self.thisown = 1
10316 del newobj.thisown
10317 def SatisfyConstraints(*args, **kwargs):
10318 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
10319 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
10320
10321 def AreSatisfied(*args, **kwargs):
10322 """AreSatisfied(self) -> bool"""
10323 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
10324
10325
10326class LayoutConstraintsPtr(LayoutConstraints):
10327 def __init__(self, this):
10328 self.this = this
10329 if not hasattr(self,"thisown"): self.thisown = 0
10330 self.__class__ = LayoutConstraints
10331_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
10332
10333#----------------------------------------------------------------------------
10334
10335# Use Python's bool constants if available, make some if not
10336try:
10337 True
10338except NameError:
10339 __builtins__.True = 1==1
10340 __builtins__.False = 1==0
10341 def bool(value): return not not value
10342 __builtins__.bool = bool
10343
10344
10345
10346# workarounds for bad wxRTTI names
10347__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10348__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10349__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10350
10351
10352#----------------------------------------------------------------------------
10353# Load version numbers from __version__... Ensure that major and minor
10354# versions are the same for both wxPython and wxWindows.
10355
10356from __version__ import *
10357__version__ = VERSION_STRING
10358
10359assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
10360assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
10361if RELEASE_VERSION != _core_.RELEASE_VERSION:
10362 import warnings
10363 warnings.warn("wxPython/wxWindows release number mismatch")
10364
10365#----------------------------------------------------------------------------
10366
10367class PyDeadObjectError(AttributeError):
10368 pass
10369
10370class _wxPyDeadObject(object):
10371 """
10372 Instances of wx objects that are OOR capable will have their __class__
10373 changed to this class when the C++ object is deleted. This should help
10374 prevent crashes due to referencing a bogus C++ pointer.
10375 """
10376 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10377 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10378
10379 def __repr__(self):
10380 if not hasattr(self, "_name"):
10381 self._name = "[unknown]"
10382 return self.reprStr % self._name
10383
10384 def __getattr__(self, *args):
10385 if not hasattr(self, "_name"):
10386 self._name = "[unknown]"
10387 raise PyDeadObjectError(self.attrStr % self._name)
10388
10389 def __nonzero__(self):
10390 return 0
10391
10392
10393
10394class PyUnbornObjectError(AttributeError):
10395 pass
10396
10397class _wxPyUnbornObject(object):
10398 """
10399 Some stock objects are created when the wx._core module is
10400 imported, but their C++ instance is not created until the wx.App
10401 object is created and initialized. These object instances will
10402 temporarily have their __class__ changed to this class so an
10403 exception will be raised if they are used before the C++ instance
10404 is ready.
10405 """
10406
10407 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10408 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10409
10410 def __repr__(self):
10411 #if not hasattr(self, "_name"):
10412 # self._name = "[unknown]"
10413 return self.reprStr #% self._name
10414
10415 def __getattr__(self, *args):
10416 #if not hasattr(self, "_name"):
10417 # self._name = "[unknown]"
10418 raise PyUnbornObjectError(self.attrStr) # % self._name )
10419
10420 def __nonzero__(self):
10421 return 0
10422
10423
10424#----------------------------------------------------------------------------
10425_wxPyCallAfterId = None
10426
10427def CallAfter(callable, *args, **kw):
10428 """
10429 Call the specified function after the current and pending event
10430 handlers have been completed. This is also good for making GUI
0439c23b
RD
10431 method calls from non-GUI threads. Any extra positional or
10432 keyword args are passed on to the callable when it is called.
10433
10434 :see: `wx.FutureCall`
d55e5bfc
RD
10435 """
10436 app = wx.GetApp()
10437 assert app, 'No wxApp created yet'
10438
10439 global _wxPyCallAfterId
10440 if _wxPyCallAfterId is None:
10441 _wxPyCallAfterId = wx.NewEventType()
10442 app.Connect(-1, -1, _wxPyCallAfterId,
10443 lambda event: event.callable(*event.args, **event.kw) )
10444 evt = wx.PyEvent()
10445 evt.SetEventType(_wxPyCallAfterId)
10446 evt.callable = callable
10447 evt.args = args
10448 evt.kw = kw
10449 wx.PostEvent(app, evt)
10450
10451
10452#----------------------------------------------------------------------------
10453
10454
10455class FutureCall:
10456 """
10457 A convenience class for wx.Timer, that calls the given callable
10458 object once after the given amount of milliseconds, passing any
10459 positional or keyword args. The return value of the callable is
0439c23b 10460 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
10461
10462 If you don't need to get the return value or restart the timer
10463 then there is no need to hold a reference to this object. It will
10464 hold a reference to itself while the timer is running (the timer
10465 has a reference to self.Notify) but the cycle will be broken when
10466 the timer completes, automatically cleaning up the wx.FutureCall
10467 object.
0439c23b
RD
10468
10469 :see: `wx.CallAfter`
d55e5bfc
RD
10470 """
10471 def __init__(self, millis, callable, *args, **kwargs):
10472 self.millis = millis
10473 self.callable = callable
10474 self.SetArgs(*args, **kwargs)
10475 self.runCount = 0
10476 self.running = False
10477 self.hasRun = False
10478 self.result = None
10479 self.timer = None
10480 self.Start()
10481
10482 def __del__(self):
10483 self.Stop()
10484
10485
10486 def Start(self, millis=None, *args, **kwargs):
10487 """
10488 (Re)start the timer
10489 """
10490 self.hasRun = False
10491 if millis is not None:
10492 self.millis = millis
10493 if args or kwargs:
10494 self.SetArgs(*args, **kwargs)
10495 self.Stop()
10496 self.timer = wx.PyTimer(self.Notify)
10497 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
10498 self.running = True
10499 Restart = Start
10500
10501
10502 def Stop(self):
10503 """
10504 Stop and destroy the timer.
10505 """
10506 if self.timer is not None:
10507 self.timer.Stop()
10508 self.timer = None
10509
10510
10511 def GetInterval(self):
10512 if self.timer is not None:
10513 return self.timer.GetInterval()
10514 else:
10515 return 0
10516
10517
10518 def IsRunning(self):
10519 return self.timer is not None and self.timer.IsRunning()
10520
10521
10522 def SetArgs(self, *args, **kwargs):
10523 """
10524 (Re)set the args passed to the callable object. This is
10525 useful in conjunction with Restart if you want to schedule a
10526 new call to the same callable object but with different
10527 parameters.
10528 """
10529 self.args = args
10530 self.kwargs = kwargs
10531
10532
10533 def HasRun(self):
10534 return self.hasRun
10535
10536 def GetResult(self):
10537 return self.result
10538
10539 def Notify(self):
10540 """
10541 The timer has expired so call the callable.
10542 """
10543 if self.callable and getattr(self.callable, 'im_self', True):
10544 self.runCount += 1
10545 self.running = False
10546 self.result = self.callable(*self.args, **self.kwargs)
10547 self.hasRun = True
10548 if not self.running:
10549 # if it wasn't restarted, then cleanup
10550 wx.CallAfter(self.Stop)
10551
10552
10553
10554#----------------------------------------------------------------------------
10555# Control which items in this module should be documented by epydoc.
10556# We allow only classes and functions, which will help reduce the size
10557# of the docs by filtering out the zillions of constants, EVT objects,
10558# and etc that don't make much sense by themselves, but are instead
10559# documented (or will be) as part of the classes/functions/methods
10560# where they should be used.
10561
d6c14a4c
RD
10562class __DocFilter:
10563 """
10564 A filter for epydoc that only allows non-Ptr classes and
10565 fucntions, in order to reduce the clutter in the API docs.
10566 """
10567 def __init__(self, globals):
10568 self._globals = globals
10569
10570 def __call__(self, name):
10571 import types
10572 obj = self._globals.get(name, None)
10573 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10574 return False
10575 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10576 return False
10577 return True
d55e5bfc
RD
10578
10579#----------------------------------------------------------------------------
10580#----------------------------------------------------------------------------
10581
10582# Import other modules in this package that should show up in the
10583# "core" wx namespace
10584from _gdi import *
10585from _windows import *
10586from _controls import *
10587from _misc import *
10588
10589
10590# Fixup the stock objects since they can't be used yet. (They will be
10591# restored in wx.PyApp.OnInit.)
10592_core_._wxPyFixStockObjects()
10593
10594#----------------------------------------------------------------------------
10595#----------------------------------------------------------------------------
10596
10597