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