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