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