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