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