]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_core.py
compilation fix for not MSW
[wxWidgets.git] / wxPython / src / msw / _core.py
CommitLineData
d55e5bfc
RD
1# This file was created automatically by SWIG.
2# Don't modify this file, modify the SWIG interface instead.
3
4import _core_
5
6#// Give a reference to the dictionary of this module to the C++ extension
7#// code.
8_core_._wxPySetDictionary(vars())
9
10#// A little trick to make 'wx' be a reference to this module so wx.Names can
11#// be used here.
12import sys as _sys
13wx = _sys.modules[__name__]
14
c24da6d6
RD
15
16#----------------------------------------------------------------------------
17
18def _deprecated(callable, msg=None):
19 """
20 Create a wrapper function that will raise a DeprecationWarning
21 before calling the callable.
22 """
23 if msg is None:
24 msg = "%s is deprecated" % callable
25 def deprecatedWrapper(*args, **kwargs):
26 import warnings
27 warnings.warn(msg, DeprecationWarning, stacklevel=2)
28 return callable(*args, **kwargs)
29 deprecatedWrapper.__doc__ = msg
30 return deprecatedWrapper
31
32
33#----------------------------------------------------------------------------
34
d55e5bfc
RD
35NOT_FOUND = _core_.NOT_FOUND
36VSCROLL = _core_.VSCROLL
37HSCROLL = _core_.HSCROLL
38CAPTION = _core_.CAPTION
39DOUBLE_BORDER = _core_.DOUBLE_BORDER
40SUNKEN_BORDER = _core_.SUNKEN_BORDER
41RAISED_BORDER = _core_.RAISED_BORDER
42BORDER = _core_.BORDER
43SIMPLE_BORDER = _core_.SIMPLE_BORDER
44STATIC_BORDER = _core_.STATIC_BORDER
45TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
46NO_BORDER = _core_.NO_BORDER
47TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
48WANTS_CHARS = _core_.WANTS_CHARS
49POPUP_WINDOW = _core_.POPUP_WINDOW
50CENTER_FRAME = _core_.CENTER_FRAME
51CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
52CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
53ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
54ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
55ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
56ED_STATIC_LINE = _core_.ED_STATIC_LINE
57EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
58CLIP_CHILDREN = _core_.CLIP_CHILDREN
59CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
60ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
61RETAINED = _core_.RETAINED
62BACKINGSTORE = _core_.BACKINGSTORE
63COLOURED = _core_.COLOURED
64FIXED_LENGTH = _core_.FIXED_LENGTH
65LB_NEEDED_SB = _core_.LB_NEEDED_SB
66LB_ALWAYS_SB = _core_.LB_ALWAYS_SB
67LB_SORT = _core_.LB_SORT
68LB_SINGLE = _core_.LB_SINGLE
69LB_MULTIPLE = _core_.LB_MULTIPLE
70LB_EXTENDED = _core_.LB_EXTENDED
71LB_OWNERDRAW = _core_.LB_OWNERDRAW
72LB_HSCROLL = _core_.LB_HSCROLL
73PROCESS_ENTER = _core_.PROCESS_ENTER
74PASSWORD = _core_.PASSWORD
75CB_SIMPLE = _core_.CB_SIMPLE
76CB_DROPDOWN = _core_.CB_DROPDOWN
77CB_SORT = _core_.CB_SORT
78CB_READONLY = _core_.CB_READONLY
79RA_HORIZONTAL = _core_.RA_HORIZONTAL
80RA_VERTICAL = _core_.RA_VERTICAL
81RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
82RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
83RB_GROUP = _core_.RB_GROUP
84RB_SINGLE = _core_.RB_SINGLE
85SL_HORIZONTAL = _core_.SL_HORIZONTAL
86SL_VERTICAL = _core_.SL_VERTICAL
87SL_AUTOTICKS = _core_.SL_AUTOTICKS
88SL_LABELS = _core_.SL_LABELS
89SL_LEFT = _core_.SL_LEFT
90SL_TOP = _core_.SL_TOP
91SL_RIGHT = _core_.SL_RIGHT
92SL_BOTTOM = _core_.SL_BOTTOM
93SL_BOTH = _core_.SL_BOTH
94SL_SELRANGE = _core_.SL_SELRANGE
95SB_HORIZONTAL = _core_.SB_HORIZONTAL
96SB_VERTICAL = _core_.SB_VERTICAL
97ST_SIZEGRIP = _core_.ST_SIZEGRIP
98ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
99FLOOD_SURFACE = _core_.FLOOD_SURFACE
100FLOOD_BORDER = _core_.FLOOD_BORDER
101ODDEVEN_RULE = _core_.ODDEVEN_RULE
102WINDING_RULE = _core_.WINDING_RULE
103TOOL_TOP = _core_.TOOL_TOP
104TOOL_BOTTOM = _core_.TOOL_BOTTOM
105TOOL_LEFT = _core_.TOOL_LEFT
106TOOL_RIGHT = _core_.TOOL_RIGHT
107OK = _core_.OK
108YES_NO = _core_.YES_NO
109CANCEL = _core_.CANCEL
110YES = _core_.YES
111NO = _core_.NO
112NO_DEFAULT = _core_.NO_DEFAULT
113YES_DEFAULT = _core_.YES_DEFAULT
114ICON_EXCLAMATION = _core_.ICON_EXCLAMATION
115ICON_HAND = _core_.ICON_HAND
116ICON_QUESTION = _core_.ICON_QUESTION
117ICON_INFORMATION = _core_.ICON_INFORMATION
118ICON_STOP = _core_.ICON_STOP
119ICON_ASTERISK = _core_.ICON_ASTERISK
120ICON_MASK = _core_.ICON_MASK
121ICON_WARNING = _core_.ICON_WARNING
122ICON_ERROR = _core_.ICON_ERROR
123FORWARD = _core_.FORWARD
124BACKWARD = _core_.BACKWARD
125RESET = _core_.RESET
126HELP = _core_.HELP
127MORE = _core_.MORE
128SETUP = _core_.SETUP
129SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH
130SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT
131SIZE_AUTO = _core_.SIZE_AUTO
132SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
133SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
134PORTRAIT = _core_.PORTRAIT
135LANDSCAPE = _core_.LANDSCAPE
136PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
137PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM
138PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW
139PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
140ID_ANY = _core_.ID_ANY
141ID_SEPARATOR = _core_.ID_SEPARATOR
142ID_LOWEST = _core_.ID_LOWEST
143ID_OPEN = _core_.ID_OPEN
144ID_CLOSE = _core_.ID_CLOSE
145ID_NEW = _core_.ID_NEW
146ID_SAVE = _core_.ID_SAVE
147ID_SAVEAS = _core_.ID_SAVEAS
148ID_REVERT = _core_.ID_REVERT
149ID_EXIT = _core_.ID_EXIT
150ID_UNDO = _core_.ID_UNDO
151ID_REDO = _core_.ID_REDO
152ID_HELP = _core_.ID_HELP
153ID_PRINT = _core_.ID_PRINT
154ID_PRINT_SETUP = _core_.ID_PRINT_SETUP
155ID_PREVIEW = _core_.ID_PREVIEW
156ID_ABOUT = _core_.ID_ABOUT
157ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS
158ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS
159ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES
160ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT
161ID_CLOSE_ALL = _core_.ID_CLOSE_ALL
162ID_PREFERENCES = _core_.ID_PREFERENCES
163ID_CUT = _core_.ID_CUT
164ID_COPY = _core_.ID_COPY
165ID_PASTE = _core_.ID_PASTE
166ID_CLEAR = _core_.ID_CLEAR
167ID_FIND = _core_.ID_FIND
168ID_DUPLICATE = _core_.ID_DUPLICATE
169ID_SELECTALL = _core_.ID_SELECTALL
170ID_DELETE = _core_.ID_DELETE
171ID_REPLACE = _core_.ID_REPLACE
172ID_REPLACE_ALL = _core_.ID_REPLACE_ALL
173ID_PROPERTIES = _core_.ID_PROPERTIES
174ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS
175ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS
176ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS
177ID_VIEW_LIST = _core_.ID_VIEW_LIST
178ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE
179ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME
180ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE
181ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE
182ID_FILE1 = _core_.ID_FILE1
183ID_FILE2 = _core_.ID_FILE2
184ID_FILE3 = _core_.ID_FILE3
185ID_FILE4 = _core_.ID_FILE4
186ID_FILE5 = _core_.ID_FILE5
187ID_FILE6 = _core_.ID_FILE6
188ID_FILE7 = _core_.ID_FILE7
189ID_FILE8 = _core_.ID_FILE8
190ID_FILE9 = _core_.ID_FILE9
191ID_OK = _core_.ID_OK
192ID_CANCEL = _core_.ID_CANCEL
193ID_APPLY = _core_.ID_APPLY
194ID_YES = _core_.ID_YES
195ID_NO = _core_.ID_NO
196ID_STATIC = _core_.ID_STATIC
197ID_FORWARD = _core_.ID_FORWARD
198ID_BACKWARD = _core_.ID_BACKWARD
199ID_DEFAULT = _core_.ID_DEFAULT
200ID_MORE = _core_.ID_MORE
201ID_SETUP = _core_.ID_SETUP
202ID_RESET = _core_.ID_RESET
203ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP
204ID_YESTOALL = _core_.ID_YESTOALL
205ID_NOTOALL = _core_.ID_NOTOALL
206ID_ABORT = _core_.ID_ABORT
207ID_RETRY = _core_.ID_RETRY
208ID_IGNORE = _core_.ID_IGNORE
0f63ec68
RD
209ID_ADD = _core_.ID_ADD
210ID_REMOVE = _core_.ID_REMOVE
211ID_UP = _core_.ID_UP
212ID_DOWN = _core_.ID_DOWN
213ID_HOME = _core_.ID_HOME
214ID_REFRESH = _core_.ID_REFRESH
215ID_STOP = _core_.ID_STOP
216ID_INDEX = _core_.ID_INDEX
217ID_BOLD = _core_.ID_BOLD
218ID_ITALIC = _core_.ID_ITALIC
219ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
220ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
221ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
222ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
223ID_UNDERLINE = _core_.ID_UNDERLINE
224ID_INDENT = _core_.ID_INDENT
225ID_UNINDENT = _core_.ID_UNINDENT
226ID_ZOOM_100 = _core_.ID_ZOOM_100
227ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
228ID_ZOOM_IN = _core_.ID_ZOOM_IN
229ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
230ID_UNDELETE = _core_.ID_UNDELETE
231ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
d55e5bfc
RD
232ID_HIGHEST = _core_.ID_HIGHEST
233OPEN = _core_.OPEN
234SAVE = _core_.SAVE
235HIDE_READONLY = _core_.HIDE_READONLY
236OVERWRITE_PROMPT = _core_.OVERWRITE_PROMPT
237FILE_MUST_EXIST = _core_.FILE_MUST_EXIST
238MULTIPLE = _core_.MULTIPLE
239CHANGE_DIR = _core_.CHANGE_DIR
240ACCEL_ALT = _core_.ACCEL_ALT
241ACCEL_CTRL = _core_.ACCEL_CTRL
242ACCEL_SHIFT = _core_.ACCEL_SHIFT
243ACCEL_NORMAL = _core_.ACCEL_NORMAL
244PD_AUTO_HIDE = _core_.PD_AUTO_HIDE
245PD_APP_MODAL = _core_.PD_APP_MODAL
246PD_CAN_ABORT = _core_.PD_CAN_ABORT
247PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
248PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
249PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
250DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
251DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
252MENU_TEAROFF = _core_.MENU_TEAROFF
253MB_DOCKABLE = _core_.MB_DOCKABLE
254NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE
255FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE
256LI_HORIZONTAL = _core_.LI_HORIZONTAL
257LI_VERTICAL = _core_.LI_VERTICAL
258WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY
259WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS
260WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT
261WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND
262WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE
263WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES
264MM_TEXT = _core_.MM_TEXT
265MM_LOMETRIC = _core_.MM_LOMETRIC
266MM_HIMETRIC = _core_.MM_HIMETRIC
267MM_LOENGLISH = _core_.MM_LOENGLISH
268MM_HIENGLISH = _core_.MM_HIENGLISH
269MM_TWIPS = _core_.MM_TWIPS
270MM_ISOTROPIC = _core_.MM_ISOTROPIC
271MM_ANISOTROPIC = _core_.MM_ANISOTROPIC
272MM_POINTS = _core_.MM_POINTS
273MM_METRIC = _core_.MM_METRIC
274CENTRE = _core_.CENTRE
275CENTER = _core_.CENTER
276HORIZONTAL = _core_.HORIZONTAL
277VERTICAL = _core_.VERTICAL
278BOTH = _core_.BOTH
279LEFT = _core_.LEFT
280RIGHT = _core_.RIGHT
281UP = _core_.UP
282DOWN = _core_.DOWN
283TOP = _core_.TOP
284BOTTOM = _core_.BOTTOM
285NORTH = _core_.NORTH
286SOUTH = _core_.SOUTH
287WEST = _core_.WEST
288EAST = _core_.EAST
289ALL = _core_.ALL
290ALIGN_NOT = _core_.ALIGN_NOT
291ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL
292ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL
293ALIGN_LEFT = _core_.ALIGN_LEFT
294ALIGN_TOP = _core_.ALIGN_TOP
295ALIGN_RIGHT = _core_.ALIGN_RIGHT
296ALIGN_BOTTOM = _core_.ALIGN_BOTTOM
297ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL
298ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL
299ALIGN_CENTER = _core_.ALIGN_CENTER
300ALIGN_CENTRE = _core_.ALIGN_CENTRE
301ALIGN_MASK = _core_.ALIGN_MASK
302STRETCH_NOT = _core_.STRETCH_NOT
303SHRINK = _core_.SHRINK
304GROW = _core_.GROW
305EXPAND = _core_.EXPAND
306SHAPED = _core_.SHAPED
307FIXED_MINSIZE = _core_.FIXED_MINSIZE
308TILE = _core_.TILE
309ADJUST_MINSIZE = _core_.ADJUST_MINSIZE
310BORDER_DEFAULT = _core_.BORDER_DEFAULT
311BORDER_NONE = _core_.BORDER_NONE
312BORDER_STATIC = _core_.BORDER_STATIC
313BORDER_SIMPLE = _core_.BORDER_SIMPLE
314BORDER_RAISED = _core_.BORDER_RAISED
315BORDER_SUNKEN = _core_.BORDER_SUNKEN
316BORDER_DOUBLE = _core_.BORDER_DOUBLE
317BORDER_MASK = _core_.BORDER_MASK
0f63ec68
RD
318BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
319BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
320BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
d55e5bfc
RD
321DEFAULT = _core_.DEFAULT
322DECORATIVE = _core_.DECORATIVE
323ROMAN = _core_.ROMAN
324SCRIPT = _core_.SCRIPT
325SWISS = _core_.SWISS
326MODERN = _core_.MODERN
327TELETYPE = _core_.TELETYPE
328VARIABLE = _core_.VARIABLE
329FIXED = _core_.FIXED
330NORMAL = _core_.NORMAL
331LIGHT = _core_.LIGHT
332BOLD = _core_.BOLD
333ITALIC = _core_.ITALIC
334SLANT = _core_.SLANT
335SOLID = _core_.SOLID
336DOT = _core_.DOT
337LONG_DASH = _core_.LONG_DASH
338SHORT_DASH = _core_.SHORT_DASH
339DOT_DASH = _core_.DOT_DASH
340USER_DASH = _core_.USER_DASH
341TRANSPARENT = _core_.TRANSPARENT
342STIPPLE = _core_.STIPPLE
343BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
344CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
345FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
346CROSS_HATCH = _core_.CROSS_HATCH
347HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH
348VERTICAL_HATCH = _core_.VERTICAL_HATCH
349JOIN_BEVEL = _core_.JOIN_BEVEL
350JOIN_MITER = _core_.JOIN_MITER
351JOIN_ROUND = _core_.JOIN_ROUND
352CAP_ROUND = _core_.CAP_ROUND
353CAP_PROJECTING = _core_.CAP_PROJECTING
354CAP_BUTT = _core_.CAP_BUTT
355CLEAR = _core_.CLEAR
356XOR = _core_.XOR
357INVERT = _core_.INVERT
358OR_REVERSE = _core_.OR_REVERSE
359AND_REVERSE = _core_.AND_REVERSE
360COPY = _core_.COPY
361AND = _core_.AND
362AND_INVERT = _core_.AND_INVERT
363NO_OP = _core_.NO_OP
364NOR = _core_.NOR
365EQUIV = _core_.EQUIV
366SRC_INVERT = _core_.SRC_INVERT
367OR_INVERT = _core_.OR_INVERT
368NAND = _core_.NAND
369OR = _core_.OR
370SET = _core_.SET
371WXK_BACK = _core_.WXK_BACK
372WXK_TAB = _core_.WXK_TAB
373WXK_RETURN = _core_.WXK_RETURN
374WXK_ESCAPE = _core_.WXK_ESCAPE
375WXK_SPACE = _core_.WXK_SPACE
376WXK_DELETE = _core_.WXK_DELETE
377WXK_START = _core_.WXK_START
378WXK_LBUTTON = _core_.WXK_LBUTTON
379WXK_RBUTTON = _core_.WXK_RBUTTON
380WXK_CANCEL = _core_.WXK_CANCEL
381WXK_MBUTTON = _core_.WXK_MBUTTON
382WXK_CLEAR = _core_.WXK_CLEAR
383WXK_SHIFT = _core_.WXK_SHIFT
384WXK_ALT = _core_.WXK_ALT
385WXK_CONTROL = _core_.WXK_CONTROL
386WXK_MENU = _core_.WXK_MENU
387WXK_PAUSE = _core_.WXK_PAUSE
388WXK_CAPITAL = _core_.WXK_CAPITAL
389WXK_PRIOR = _core_.WXK_PRIOR
390WXK_NEXT = _core_.WXK_NEXT
391WXK_END = _core_.WXK_END
392WXK_HOME = _core_.WXK_HOME
393WXK_LEFT = _core_.WXK_LEFT
394WXK_UP = _core_.WXK_UP
395WXK_RIGHT = _core_.WXK_RIGHT
396WXK_DOWN = _core_.WXK_DOWN
397WXK_SELECT = _core_.WXK_SELECT
398WXK_PRINT = _core_.WXK_PRINT
399WXK_EXECUTE = _core_.WXK_EXECUTE
400WXK_SNAPSHOT = _core_.WXK_SNAPSHOT
401WXK_INSERT = _core_.WXK_INSERT
402WXK_HELP = _core_.WXK_HELP
403WXK_NUMPAD0 = _core_.WXK_NUMPAD0
404WXK_NUMPAD1 = _core_.WXK_NUMPAD1
405WXK_NUMPAD2 = _core_.WXK_NUMPAD2
406WXK_NUMPAD3 = _core_.WXK_NUMPAD3
407WXK_NUMPAD4 = _core_.WXK_NUMPAD4
408WXK_NUMPAD5 = _core_.WXK_NUMPAD5
409WXK_NUMPAD6 = _core_.WXK_NUMPAD6
410WXK_NUMPAD7 = _core_.WXK_NUMPAD7
411WXK_NUMPAD8 = _core_.WXK_NUMPAD8
412WXK_NUMPAD9 = _core_.WXK_NUMPAD9
413WXK_MULTIPLY = _core_.WXK_MULTIPLY
414WXK_ADD = _core_.WXK_ADD
415WXK_SEPARATOR = _core_.WXK_SEPARATOR
416WXK_SUBTRACT = _core_.WXK_SUBTRACT
417WXK_DECIMAL = _core_.WXK_DECIMAL
418WXK_DIVIDE = _core_.WXK_DIVIDE
419WXK_F1 = _core_.WXK_F1
420WXK_F2 = _core_.WXK_F2
421WXK_F3 = _core_.WXK_F3
422WXK_F4 = _core_.WXK_F4
423WXK_F5 = _core_.WXK_F5
424WXK_F6 = _core_.WXK_F6
425WXK_F7 = _core_.WXK_F7
426WXK_F8 = _core_.WXK_F8
427WXK_F9 = _core_.WXK_F9
428WXK_F10 = _core_.WXK_F10
429WXK_F11 = _core_.WXK_F11
430WXK_F12 = _core_.WXK_F12
431WXK_F13 = _core_.WXK_F13
432WXK_F14 = _core_.WXK_F14
433WXK_F15 = _core_.WXK_F15
434WXK_F16 = _core_.WXK_F16
435WXK_F17 = _core_.WXK_F17
436WXK_F18 = _core_.WXK_F18
437WXK_F19 = _core_.WXK_F19
438WXK_F20 = _core_.WXK_F20
439WXK_F21 = _core_.WXK_F21
440WXK_F22 = _core_.WXK_F22
441WXK_F23 = _core_.WXK_F23
442WXK_F24 = _core_.WXK_F24
443WXK_NUMLOCK = _core_.WXK_NUMLOCK
444WXK_SCROLL = _core_.WXK_SCROLL
445WXK_PAGEUP = _core_.WXK_PAGEUP
446WXK_PAGEDOWN = _core_.WXK_PAGEDOWN
447WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE
448WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB
449WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER
450WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1
451WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2
452WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3
453WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4
454WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME
455WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT
456WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP
457WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT
458WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN
459WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR
460WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP
461WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT
462WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN
463WXK_NUMPAD_END = _core_.WXK_NUMPAD_END
464WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN
465WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT
466WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE
467WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL
468WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY
469WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD
470WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR
471WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT
472WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL
473WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE
474WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
475WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
476WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
477PAPER_NONE = _core_.PAPER_NONE
478PAPER_LETTER = _core_.PAPER_LETTER
479PAPER_LEGAL = _core_.PAPER_LEGAL
480PAPER_A4 = _core_.PAPER_A4
481PAPER_CSHEET = _core_.PAPER_CSHEET
482PAPER_DSHEET = _core_.PAPER_DSHEET
483PAPER_ESHEET = _core_.PAPER_ESHEET
484PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL
485PAPER_TABLOID = _core_.PAPER_TABLOID
486PAPER_LEDGER = _core_.PAPER_LEDGER
487PAPER_STATEMENT = _core_.PAPER_STATEMENT
488PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE
489PAPER_A3 = _core_.PAPER_A3
490PAPER_A4SMALL = _core_.PAPER_A4SMALL
491PAPER_A5 = _core_.PAPER_A5
492PAPER_B4 = _core_.PAPER_B4
493PAPER_B5 = _core_.PAPER_B5
494PAPER_FOLIO = _core_.PAPER_FOLIO
495PAPER_QUARTO = _core_.PAPER_QUARTO
496PAPER_10X14 = _core_.PAPER_10X14
497PAPER_11X17 = _core_.PAPER_11X17
498PAPER_NOTE = _core_.PAPER_NOTE
499PAPER_ENV_9 = _core_.PAPER_ENV_9
500PAPER_ENV_10 = _core_.PAPER_ENV_10
501PAPER_ENV_11 = _core_.PAPER_ENV_11
502PAPER_ENV_12 = _core_.PAPER_ENV_12
503PAPER_ENV_14 = _core_.PAPER_ENV_14
504PAPER_ENV_DL = _core_.PAPER_ENV_DL
505PAPER_ENV_C5 = _core_.PAPER_ENV_C5
506PAPER_ENV_C3 = _core_.PAPER_ENV_C3
507PAPER_ENV_C4 = _core_.PAPER_ENV_C4
508PAPER_ENV_C6 = _core_.PAPER_ENV_C6
509PAPER_ENV_C65 = _core_.PAPER_ENV_C65
510PAPER_ENV_B4 = _core_.PAPER_ENV_B4
511PAPER_ENV_B5 = _core_.PAPER_ENV_B5
512PAPER_ENV_B6 = _core_.PAPER_ENV_B6
513PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY
514PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH
515PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL
516PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US
517PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN
518PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN
519PAPER_ISO_B4 = _core_.PAPER_ISO_B4
520PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD
521PAPER_9X11 = _core_.PAPER_9X11
522PAPER_10X11 = _core_.PAPER_10X11
523PAPER_15X11 = _core_.PAPER_15X11
524PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE
525PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA
526PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA
527PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA
528PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA
529PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE
530PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE
531PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE
532PAPER_A_PLUS = _core_.PAPER_A_PLUS
533PAPER_B_PLUS = _core_.PAPER_B_PLUS
534PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS
535PAPER_A4_PLUS = _core_.PAPER_A4_PLUS
536PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE
537PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE
538PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA
539PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA
540PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA
541PAPER_A2 = _core_.PAPER_A2
542PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
543PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
544DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
545DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
546DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
547ITEM_SEPARATOR = _core_.ITEM_SEPARATOR
548ITEM_NORMAL = _core_.ITEM_NORMAL
549ITEM_CHECK = _core_.ITEM_CHECK
550ITEM_RADIO = _core_.ITEM_RADIO
551ITEM_MAX = _core_.ITEM_MAX
552HT_NOWHERE = _core_.HT_NOWHERE
553HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST
554HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1
555HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2
556HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1
557HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2
558HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB
559HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1
560HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2
561HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST
562HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE
563HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE
564HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR
565HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR
566HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER
567HT_MAX = _core_.HT_MAX
568MOD_NONE = _core_.MOD_NONE
569MOD_ALT = _core_.MOD_ALT
570MOD_CONTROL = _core_.MOD_CONTROL
571MOD_SHIFT = _core_.MOD_SHIFT
572MOD_WIN = _core_.MOD_WIN
573UPDATE_UI_NONE = _core_.UPDATE_UI_NONE
574UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE
575UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE
576#---------------------------------------------------------------------------
577
578class Object(object):
579 """
580 The base class for most wx objects, although in wxPython not
581 much functionality is needed nor exposed.
582 """
583 def __init__(self): raise RuntimeError, "No constructor defined"
584 def __repr__(self):
585 return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
586 def GetClassName(*args, **kwargs):
587 """
588 GetClassName(self) -> String
589
590 Returns the class name of the C++ class using wxRTTI.
591 """
592 return _core_.Object_GetClassName(*args, **kwargs)
593
594 def Destroy(*args, **kwargs):
595 """
596 Destroy(self)
597
598 Deletes the C++ object this Python object is a proxy for.
599 """
600 return _core_.Object_Destroy(*args, **kwargs)
601
602
603class ObjectPtr(Object):
604 def __init__(self, this):
605 self.this = this
606 if not hasattr(self,"thisown"): self.thisown = 0
607 self.__class__ = Object
608_core_.Object_swigregister(ObjectPtr)
609_wxPySetDictionary = _core_._wxPySetDictionary
610
611_wxPyFixStockObjects = _core_._wxPyFixStockObjects
612
613cvar = _core_.cvar
614EmptyString = cvar.EmptyString
615
616#---------------------------------------------------------------------------
617
618BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID
619BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP
620BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO
621BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR
622BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM
623BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA
624BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM
625BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA
626BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF
627BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF
628BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG
629BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG
630BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM
631BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX
632BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT
633BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON
634BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI
635BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF
636BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR
637BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY
638CURSOR_NONE = _core_.CURSOR_NONE
639CURSOR_ARROW = _core_.CURSOR_ARROW
640CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW
641CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE
642CURSOR_CHAR = _core_.CURSOR_CHAR
643CURSOR_CROSS = _core_.CURSOR_CROSS
644CURSOR_HAND = _core_.CURSOR_HAND
645CURSOR_IBEAM = _core_.CURSOR_IBEAM
646CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON
647CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER
648CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON
649CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY
650CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH
651CURSOR_PENCIL = _core_.CURSOR_PENCIL
652CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT
653CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT
654CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW
655CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON
656CURSOR_SIZENESW = _core_.CURSOR_SIZENESW
657CURSOR_SIZENS = _core_.CURSOR_SIZENS
658CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE
659CURSOR_SIZEWE = _core_.CURSOR_SIZEWE
660CURSOR_SIZING = _core_.CURSOR_SIZING
661CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN
662CURSOR_WAIT = _core_.CURSOR_WAIT
663CURSOR_WATCH = _core_.CURSOR_WATCH
664CURSOR_BLANK = _core_.CURSOR_BLANK
665CURSOR_DEFAULT = _core_.CURSOR_DEFAULT
666CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW
667CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT
668CURSOR_MAX = _core_.CURSOR_MAX
669#---------------------------------------------------------------------------
670
671class Size(object):
672 """
79fccf9d
RD
673 wx.Size is a useful data structure used to represent the size of
674 something. It simply contians integer width and height proprtites.
675 In most places in wxPython where a wx.Size is expected a
676 (width,height) tuple can be used instead.
d55e5bfc
RD
677 """
678 def __repr__(self):
679 return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
680 width = property(_core_.Size_width_get, _core_.Size_width_set)
681 height = property(_core_.Size_height_get, _core_.Size_height_set)
682 x = width; y = height
683 def __init__(self, *args, **kwargs):
684 """
685 __init__(self, int w=0, int h=0) -> Size
686
687 Creates a size object.
688 """
689 newobj = _core_.new_Size(*args, **kwargs)
690 self.this = newobj.this
691 self.thisown = 1
692 del newobj.thisown
693 def __del__(self, destroy=_core_.delete_Size):
694 """__del__(self)"""
695 try:
696 if self.thisown: destroy(self)
697 except: pass
698
699 def __eq__(*args, **kwargs):
700 """
701 __eq__(self, Size sz) -> bool
702
703 Test for equality of wx.Size objects.
704 """
705 return _core_.Size___eq__(*args, **kwargs)
706
707 def __ne__(*args, **kwargs):
708 """
709 __ne__(self, Size sz) -> bool
710
711 Test for inequality.
712 """
713 return _core_.Size___ne__(*args, **kwargs)
714
715 def __add__(*args, **kwargs):
716 """
717 __add__(self, Size sz) -> Size
718
719 Add sz's proprties to this and return the result.
720 """
721 return _core_.Size___add__(*args, **kwargs)
722
723 def __sub__(*args, **kwargs):
724 """
725 __sub__(self, Size sz) -> Size
726
727 Subtract sz's properties from this and return the result.
728 """
729 return _core_.Size___sub__(*args, **kwargs)
730
731 def IncTo(*args, **kwargs):
732 """
733 IncTo(self, Size sz)
734
735 Increments this object so that both of its dimensions are not less
736 than the corresponding dimensions of the size.
737 """
738 return _core_.Size_IncTo(*args, **kwargs)
739
740 def DecTo(*args, **kwargs):
741 """
742 DecTo(self, Size sz)
743
744 Decrements this object so that both of its dimensions are not greater
745 than the corresponding dimensions of the size.
746 """
747 return _core_.Size_DecTo(*args, **kwargs)
748
749 def Set(*args, **kwargs):
750 """
751 Set(self, int w, int h)
752
753 Set both width and height.
754 """
755 return _core_.Size_Set(*args, **kwargs)
756
757 def SetWidth(*args, **kwargs):
758 """SetWidth(self, int w)"""
759 return _core_.Size_SetWidth(*args, **kwargs)
760
761 def SetHeight(*args, **kwargs):
762 """SetHeight(self, int h)"""
763 return _core_.Size_SetHeight(*args, **kwargs)
764
765 def GetWidth(*args, **kwargs):
766 """GetWidth(self) -> int"""
767 return _core_.Size_GetWidth(*args, **kwargs)
768
769 def GetHeight(*args, **kwargs):
770 """GetHeight(self) -> int"""
771 return _core_.Size_GetHeight(*args, **kwargs)
772
773 def IsFullySpecified(*args, **kwargs):
774 """
775 IsFullySpecified(self) -> bool
776
777 Returns True if both components of the size are non-default values.
778 """
779 return _core_.Size_IsFullySpecified(*args, **kwargs)
780
781 def SetDefaults(*args, **kwargs):
782 """
783 SetDefaults(self, Size size)
784
79fccf9d
RD
785 Combine this size with the other one replacing the default components
786 of this object (i.e. equal to -1) with those of the other.
d55e5bfc
RD
787 """
788 return _core_.Size_SetDefaults(*args, **kwargs)
789
790 def Get(*args, **kwargs):
791 """
792 Get() -> (width,height)
793
794 Returns the width and height properties as a tuple.
795 """
796 return _core_.Size_Get(*args, **kwargs)
797
79fccf9d 798 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
799 def __str__(self): return str(self.Get())
800 def __repr__(self): return 'wx.Size'+str(self.Get())
801 def __len__(self): return len(self.Get())
802 def __getitem__(self, index): return self.Get()[index]
803 def __setitem__(self, index, val):
804 if index == 0: self.width = val
805 elif index == 1: self.height = val
806 else: raise IndexError
807 def __nonzero__(self): return self.Get() != (0,0)
808 __safe_for_unpickling__ = True
809 def __reduce__(self): return (wx.Size, self.Get())
810
811
812class SizePtr(Size):
813 def __init__(self, this):
814 self.this = this
815 if not hasattr(self,"thisown"): self.thisown = 0
816 self.__class__ = Size
817_core_.Size_swigregister(SizePtr)
818
819#---------------------------------------------------------------------------
820
821class RealPoint(object):
822 """
79fccf9d
RD
823 A data structure for representing a point or position with floating
824 point x and y properties. In wxPython most places that expect a
825 wx.RealPoint can also accept a (x,y) tuple.
d55e5bfc
RD
826 """
827 def __repr__(self):
828 return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
829 x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
830 y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
831 def __init__(self, *args, **kwargs):
832 """
833 __init__(self, double x=0.0, double y=0.0) -> RealPoint
834
835 Create a wx.RealPoint object
836 """
837 newobj = _core_.new_RealPoint(*args, **kwargs)
838 self.this = newobj.this
839 self.thisown = 1
840 del newobj.thisown
841 def __del__(self, destroy=_core_.delete_RealPoint):
842 """__del__(self)"""
843 try:
844 if self.thisown: destroy(self)
845 except: pass
846
847 def __eq__(*args, **kwargs):
848 """
849 __eq__(self, RealPoint pt) -> bool
850
851 Test for equality of wx.RealPoint objects.
852 """
853 return _core_.RealPoint___eq__(*args, **kwargs)
854
855 def __ne__(*args, **kwargs):
856 """
857 __ne__(self, RealPoint pt) -> bool
858
859 Test for inequality of wx.RealPoint objects.
860 """
861 return _core_.RealPoint___ne__(*args, **kwargs)
862
863 def __add__(*args, **kwargs):
864 """
865 __add__(self, RealPoint pt) -> RealPoint
866
867 Add pt's proprties to this and return the result.
868 """
869 return _core_.RealPoint___add__(*args, **kwargs)
870
871 def __sub__(*args, **kwargs):
872 """
873 __sub__(self, RealPoint pt) -> RealPoint
874
875 Subtract pt's proprties from this and return the result
876 """
877 return _core_.RealPoint___sub__(*args, **kwargs)
878
879 def Set(*args, **kwargs):
880 """
881 Set(self, double x, double y)
882
883 Set both the x and y properties
884 """
885 return _core_.RealPoint_Set(*args, **kwargs)
886
887 def Get(*args, **kwargs):
888 """
889 Get() -> (x,y)
890
891 Return the x and y properties as a tuple.
892 """
893 return _core_.RealPoint_Get(*args, **kwargs)
894
79fccf9d 895 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
896 def __str__(self): return str(self.Get())
897 def __repr__(self): return 'wx.RealPoint'+str(self.Get())
898 def __len__(self): return len(self.Get())
899 def __getitem__(self, index): return self.Get()[index]
900 def __setitem__(self, index, val):
901 if index == 0: self.x = val
902 elif index == 1: self.y = val
903 else: raise IndexError
904 def __nonzero__(self): return self.Get() != (0.0, 0.0)
905 __safe_for_unpickling__ = True
906 def __reduce__(self): return (wx.RealPoint, self.Get())
907
908
909class RealPointPtr(RealPoint):
910 def __init__(self, this):
911 self.this = this
912 if not hasattr(self,"thisown"): self.thisown = 0
913 self.__class__ = RealPoint
914_core_.RealPoint_swigregister(RealPointPtr)
915
916#---------------------------------------------------------------------------
917
918class Point(object):
919 """
79fccf9d
RD
920 A data structure for representing a point or position with integer x
921 and y properties. Most places in wxPython that expect a wx.Point can
922 also accept a (x,y) tuple.
d55e5bfc
RD
923 """
924 def __repr__(self):
925 return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
926 x = property(_core_.Point_x_get, _core_.Point_x_set)
927 y = property(_core_.Point_y_get, _core_.Point_y_set)
928 def __init__(self, *args, **kwargs):
929 """
930 __init__(self, int x=0, int y=0) -> Point
931
932 Create a wx.Point object
933 """
934 newobj = _core_.new_Point(*args, **kwargs)
935 self.this = newobj.this
936 self.thisown = 1
937 del newobj.thisown
938 def __del__(self, destroy=_core_.delete_Point):
939 """__del__(self)"""
940 try:
941 if self.thisown: destroy(self)
942 except: pass
943
944 def __eq__(*args, **kwargs):
945 """
946 __eq__(self, Point pt) -> bool
947
948 Test for equality of wx.Point objects.
949 """
950 return _core_.Point___eq__(*args, **kwargs)
951
952 def __ne__(*args, **kwargs):
953 """
954 __ne__(self, Point pt) -> bool
955
956 Test for inequality of wx.Point objects.
957 """
958 return _core_.Point___ne__(*args, **kwargs)
959
960 def __add__(*args, **kwargs):
961 """
962 __add__(self, Point pt) -> Point
963
964 Add pt's proprties to this and return the result.
965 """
966 return _core_.Point___add__(*args, **kwargs)
967
968 def __sub__(*args, **kwargs):
969 """
970 __sub__(self, Point pt) -> Point
971
972 Subtract pt's proprties from this and return the result
973 """
974 return _core_.Point___sub__(*args, **kwargs)
975
976 def __iadd__(*args, **kwargs):
977 """
978 __iadd__(self, Point pt) -> Point
979
980 Add pt to this object.
981 """
982 return _core_.Point___iadd__(*args, **kwargs)
983
984 def __isub__(*args, **kwargs):
985 """
986 __isub__(self, Point pt) -> Point
987
988 Subtract pt from this object.
989 """
990 return _core_.Point___isub__(*args, **kwargs)
991
992 def Set(*args, **kwargs):
993 """
994 Set(self, long x, long y)
995
996 Set both the x and y properties
997 """
998 return _core_.Point_Set(*args, **kwargs)
999
1000 def Get(*args, **kwargs):
1001 """
1002 Get() -> (x,y)
1003
1004 Return the x and y properties as a tuple.
1005 """
1006 return _core_.Point_Get(*args, **kwargs)
1007
79fccf9d 1008 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1009 def __str__(self): return str(self.Get())
1010 def __repr__(self): return 'wx.Point'+str(self.Get())
1011 def __len__(self): return len(self.Get())
1012 def __getitem__(self, index): return self.Get()[index]
1013 def __setitem__(self, index, val):
1014 if index == 0: self.x = val
1015 elif index == 1: self.y = val
1016 else: raise IndexError
1017 def __nonzero__(self): return self.Get() != (0,0)
1018 __safe_for_unpickling__ = True
1019 def __reduce__(self): return (wx.Point, self.Get())
1020
1021
1022class PointPtr(Point):
1023 def __init__(self, this):
1024 self.this = this
1025 if not hasattr(self,"thisown"): self.thisown = 0
1026 self.__class__ = Point
1027_core_.Point_swigregister(PointPtr)
1028
1029#---------------------------------------------------------------------------
1030
1031class Rect(object):
1032 """
79fccf9d
RD
1033 A class for representing and manipulating rectangles. It has x, y,
1034 width and height properties. In wxPython most palces that expect a
1035 wx.Rect can also accept a (x,y,width,height) tuple.
d55e5bfc
RD
1036 """
1037 def __repr__(self):
1038 return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1039 def __init__(self, *args, **kwargs):
1040 """
1041 __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
1042
1043 Create a new Rect object.
1044 """
1045 newobj = _core_.new_Rect(*args, **kwargs)
1046 self.this = newobj.this
1047 self.thisown = 1
1048 del newobj.thisown
1049 def __del__(self, destroy=_core_.delete_Rect):
1050 """__del__(self)"""
1051 try:
1052 if self.thisown: destroy(self)
1053 except: pass
1054
1055 def GetX(*args, **kwargs):
1056 """GetX(self) -> int"""
1057 return _core_.Rect_GetX(*args, **kwargs)
1058
1059 def SetX(*args, **kwargs):
1060 """SetX(self, int x)"""
1061 return _core_.Rect_SetX(*args, **kwargs)
1062
1063 def GetY(*args, **kwargs):
1064 """GetY(self) -> int"""
1065 return _core_.Rect_GetY(*args, **kwargs)
1066
1067 def SetY(*args, **kwargs):
1068 """SetY(self, int y)"""
1069 return _core_.Rect_SetY(*args, **kwargs)
1070
1071 def GetWidth(*args, **kwargs):
1072 """GetWidth(self) -> int"""
1073 return _core_.Rect_GetWidth(*args, **kwargs)
1074
1075 def SetWidth(*args, **kwargs):
1076 """SetWidth(self, int w)"""
1077 return _core_.Rect_SetWidth(*args, **kwargs)
1078
1079 def GetHeight(*args, **kwargs):
1080 """GetHeight(self) -> int"""
1081 return _core_.Rect_GetHeight(*args, **kwargs)
1082
1083 def SetHeight(*args, **kwargs):
1084 """SetHeight(self, int h)"""
1085 return _core_.Rect_SetHeight(*args, **kwargs)
1086
1087 def GetPosition(*args, **kwargs):
1088 """GetPosition(self) -> Point"""
1089 return _core_.Rect_GetPosition(*args, **kwargs)
1090
1091 def SetPosition(*args, **kwargs):
1092 """SetPosition(self, Point p)"""
1093 return _core_.Rect_SetPosition(*args, **kwargs)
1094
1095 def GetSize(*args, **kwargs):
1096 """GetSize(self) -> Size"""
1097 return _core_.Rect_GetSize(*args, **kwargs)
1098
1099 def SetSize(*args, **kwargs):
1100 """SetSize(self, Size s)"""
1101 return _core_.Rect_SetSize(*args, **kwargs)
1102
1103 def GetTopLeft(*args, **kwargs):
1104 """GetTopLeft(self) -> Point"""
1105 return _core_.Rect_GetTopLeft(*args, **kwargs)
1106
1107 def SetTopLeft(*args, **kwargs):
1108 """SetTopLeft(self, Point p)"""
1109 return _core_.Rect_SetTopLeft(*args, **kwargs)
1110
1111 def GetBottomRight(*args, **kwargs):
1112 """GetBottomRight(self) -> Point"""
1113 return _core_.Rect_GetBottomRight(*args, **kwargs)
1114
1115 def SetBottomRight(*args, **kwargs):
1116 """SetBottomRight(self, Point p)"""
1117 return _core_.Rect_SetBottomRight(*args, **kwargs)
1118
1119 def GetLeft(*args, **kwargs):
1120 """GetLeft(self) -> int"""
1121 return _core_.Rect_GetLeft(*args, **kwargs)
1122
1123 def GetTop(*args, **kwargs):
1124 """GetTop(self) -> int"""
1125 return _core_.Rect_GetTop(*args, **kwargs)
1126
1127 def GetBottom(*args, **kwargs):
1128 """GetBottom(self) -> int"""
1129 return _core_.Rect_GetBottom(*args, **kwargs)
1130
1131 def GetRight(*args, **kwargs):
1132 """GetRight(self) -> int"""
1133 return _core_.Rect_GetRight(*args, **kwargs)
1134
1135 def SetLeft(*args, **kwargs):
1136 """SetLeft(self, int left)"""
1137 return _core_.Rect_SetLeft(*args, **kwargs)
1138
1139 def SetRight(*args, **kwargs):
1140 """SetRight(self, int right)"""
1141 return _core_.Rect_SetRight(*args, **kwargs)
1142
1143 def SetTop(*args, **kwargs):
1144 """SetTop(self, int top)"""
1145 return _core_.Rect_SetTop(*args, **kwargs)
1146
1147 def SetBottom(*args, **kwargs):
1148 """SetBottom(self, int bottom)"""
1149 return _core_.Rect_SetBottom(*args, **kwargs)
1150
1151 position = property(GetPosition, SetPosition)
1152 size = property(GetSize, SetSize)
1153 left = property(GetLeft, SetLeft)
1154 right = property(GetRight, SetRight)
1155 top = property(GetTop, SetTop)
1156 bottom = property(GetBottom, SetBottom)
1157
1158 def Inflate(*args, **kwargs):
1159 """
1160 Inflate(self, int dx, int dy) -> Rect
1161
79fccf9d
RD
1162 Increase the rectangle size by dx in x direction and dy in y
1163 direction. Both or one of) parameters may be negative to decrease the
1164 rectangle size.
d55e5bfc
RD
1165 """
1166 return _core_.Rect_Inflate(*args, **kwargs)
1167
1168 def Deflate(*args, **kwargs):
1169 """
1170 Deflate(self, int dx, int dy) -> Rect
1171
79fccf9d
RD
1172 Decrease the rectangle size by dx in x direction and dy in y
1173 direction. Both or one of) parameters may be negative to increase the
1174 rectngle size. This method is the opposite of Inflate.
d55e5bfc
RD
1175 """
1176 return _core_.Rect_Deflate(*args, **kwargs)
1177
1178 def OffsetXY(*args, **kwargs):
1179 """
1180 OffsetXY(self, int dx, int dy)
1181
79fccf9d
RD
1182 Moves the rectangle by the specified offset. If dx is positive, the
1183 rectangle is moved to the right, if dy is positive, it is moved to the
1184 bottom, otherwise it is moved to the left or top respectively.
d55e5bfc
RD
1185 """
1186 return _core_.Rect_OffsetXY(*args, **kwargs)
1187
1188 def Offset(*args, **kwargs):
1189 """
1190 Offset(self, Point pt)
1191
1192 Same as OffsetXY but uses dx,dy from Point
1193 """
1194 return _core_.Rect_Offset(*args, **kwargs)
1195
1196 def Intersect(*args, **kwargs):
1197 """
1198 Intersect(self, Rect rect) -> Rect
1199
1200 Return the intersectsion of this rectangle and rect.
1201 """
1202 return _core_.Rect_Intersect(*args, **kwargs)
1203
1204 def __add__(*args, **kwargs):
1205 """
1206 __add__(self, Rect rect) -> Rect
1207
1208 Add the properties of rect to this rectangle and return the result.
1209 """
1210 return _core_.Rect___add__(*args, **kwargs)
1211
1212 def __iadd__(*args, **kwargs):
1213 """
1214 __iadd__(self, Rect rect) -> Rect
1215
1216 Add the properties of rect to this rectangle, updating this rectangle.
1217 """
1218 return _core_.Rect___iadd__(*args, **kwargs)
1219
1220 def __eq__(*args, **kwargs):
1221 """
1222 __eq__(self, Rect rect) -> bool
1223
1224 Test for equality.
1225 """
1226 return _core_.Rect___eq__(*args, **kwargs)
1227
1228 def __ne__(*args, **kwargs):
1229 """
1230 __ne__(self, Rect rect) -> bool
1231
1232 Test for inequality.
1233 """
1234 return _core_.Rect___ne__(*args, **kwargs)
1235
1236 def InsideXY(*args, **kwargs):
1237 """
1238 InsideXY(self, int x, int y) -> bool
1239
1240 Return True if the point is (not strcitly) inside the rect.
1241 """
1242 return _core_.Rect_InsideXY(*args, **kwargs)
1243
1244 def Inside(*args, **kwargs):
1245 """
1246 Inside(self, Point pt) -> bool
1247
1248 Return True if the point is (not strcitly) inside the rect.
1249 """
1250 return _core_.Rect_Inside(*args, **kwargs)
1251
1252 def Intersects(*args, **kwargs):
1253 """
1254 Intersects(self, Rect rect) -> bool
1255
1256 Returns True if the rectangles have a non empty intersection.
1257 """
1258 return _core_.Rect_Intersects(*args, **kwargs)
1259
1260 x = property(_core_.Rect_x_get, _core_.Rect_x_set)
1261 y = property(_core_.Rect_y_get, _core_.Rect_y_set)
1262 width = property(_core_.Rect_width_get, _core_.Rect_width_set)
1263 height = property(_core_.Rect_height_get, _core_.Rect_height_set)
1264 def Set(*args, **kwargs):
1265 """
1266 Set(self, int x=0, int y=0, int width=0, int height=0)
1267
1268 Set all rectangle properties.
1269 """
1270 return _core_.Rect_Set(*args, **kwargs)
1271
1272 def Get(*args, **kwargs):
1273 """
1274 Get() -> (x,y,width,height)
1275
1276 Return the rectangle properties as a tuple.
1277 """
1278 return _core_.Rect_Get(*args, **kwargs)
1279
79fccf9d 1280 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1281 def __str__(self): return str(self.Get())
1282 def __repr__(self): return 'wx.Rect'+str(self.Get())
1283 def __len__(self): return len(self.Get())
1284 def __getitem__(self, index): return self.Get()[index]
1285 def __setitem__(self, index, val):
1286 if index == 0: self.x = val
1287 elif index == 1: self.y = val
1288 elif index == 2: self.width = val
1289 elif index == 3: self.height = val
1290 else: raise IndexError
1291 def __nonzero__(self): return self.Get() != (0,0,0,0)
1292 __safe_for_unpickling__ = True
1293 def __reduce__(self): return (wx.Rect, self.Get())
1294
1295
1296class RectPtr(Rect):
1297 def __init__(self, this):
1298 self.this = this
1299 if not hasattr(self,"thisown"): self.thisown = 0
1300 self.__class__ = Rect
1301_core_.Rect_swigregister(RectPtr)
1302
1303def RectPP(*args, **kwargs):
1304 """
1305 RectPP(Point topLeft, Point bottomRight) -> Rect
1306
1307 Create a new Rect object from Points representing two corners.
1308 """
1309 val = _core_.new_RectPP(*args, **kwargs)
1310 val.thisown = 1
1311 return val
1312
1313def RectPS(*args, **kwargs):
1314 """
1315 RectPS(Point pos, Size size) -> Rect
1316
1317 Create a new Rect from a position and size.
1318 """
1319 val = _core_.new_RectPS(*args, **kwargs)
1320 val.thisown = 1
1321 return val
1322
1323
1324def IntersectRect(*args, **kwargs):
1325 """
1326 IntersectRect(Rect r1, Rect r2) -> Rect
1327
1328 Calculate and return the intersection of r1 and r2.
1329 """
1330 return _core_.IntersectRect(*args, **kwargs)
1331#---------------------------------------------------------------------------
1332
1333class Point2D(object):
79fccf9d
RD
1334 """
1335 wx.Point2Ds represent a point or a vector in a 2d coordinate system
1336 with floating point values.
1337 """
d55e5bfc
RD
1338 def __repr__(self):
1339 return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1340 def __init__(self, *args, **kwargs):
1341 """
1342 __init__(self, double x=0.0, double y=0.0) -> Point2D
1343
1344 Create a w.Point2D object.
1345 """
1346 newobj = _core_.new_Point2D(*args, **kwargs)
1347 self.this = newobj.this
1348 self.thisown = 1
1349 del newobj.thisown
1350 def GetFloor(*args, **kwargs):
a8eff060
RD
1351 """
1352 GetFloor() -> (x,y)
1353
1354 Convert to integer
1355 """
d55e5bfc
RD
1356 return _core_.Point2D_GetFloor(*args, **kwargs)
1357
1358 def GetRounded(*args, **kwargs):
a8eff060
RD
1359 """
1360 GetRounded() -> (x,y)
1361
1362 Convert to integer
1363 """
d55e5bfc
RD
1364 return _core_.Point2D_GetRounded(*args, **kwargs)
1365
1366 def GetVectorLength(*args, **kwargs):
1367 """GetVectorLength(self) -> double"""
1368 return _core_.Point2D_GetVectorLength(*args, **kwargs)
1369
1370 def GetVectorAngle(*args, **kwargs):
1371 """GetVectorAngle(self) -> double"""
1372 return _core_.Point2D_GetVectorAngle(*args, **kwargs)
1373
1374 def SetVectorLength(*args, **kwargs):
1375 """SetVectorLength(self, double length)"""
1376 return _core_.Point2D_SetVectorLength(*args, **kwargs)
1377
1378 def SetVectorAngle(*args, **kwargs):
1379 """SetVectorAngle(self, double degrees)"""
1380 return _core_.Point2D_SetVectorAngle(*args, **kwargs)
1381
1382 def SetPolarCoordinates(self, angle, length):
1383 self.SetVectorLength(length)
1384 self.SetVectorAngle(angle)
1385 def Normalize(self):
1386 self.SetVectorLength(1.0)
1387
1388 def GetDistance(*args, **kwargs):
1389 """GetDistance(self, Point2D pt) -> double"""
1390 return _core_.Point2D_GetDistance(*args, **kwargs)
1391
1392 def GetDistanceSquare(*args, **kwargs):
1393 """GetDistanceSquare(self, Point2D pt) -> double"""
1394 return _core_.Point2D_GetDistanceSquare(*args, **kwargs)
1395
1396 def GetDotProduct(*args, **kwargs):
1397 """GetDotProduct(self, Point2D vec) -> double"""
1398 return _core_.Point2D_GetDotProduct(*args, **kwargs)
1399
1400 def GetCrossProduct(*args, **kwargs):
1401 """GetCrossProduct(self, Point2D vec) -> double"""
1402 return _core_.Point2D_GetCrossProduct(*args, **kwargs)
1403
1404 def __neg__(*args, **kwargs):
1405 """
1406 __neg__(self) -> Point2D
1407
1408 the reflection of this point
1409 """
1410 return _core_.Point2D___neg__(*args, **kwargs)
1411
1412 def __iadd__(*args, **kwargs):
1413 """__iadd__(self, Point2D pt) -> Point2D"""
1414 return _core_.Point2D___iadd__(*args, **kwargs)
1415
1416 def __isub__(*args, **kwargs):
1417 """__isub__(self, Point2D pt) -> Point2D"""
1418 return _core_.Point2D___isub__(*args, **kwargs)
1419
1420 def __imul__(*args, **kwargs):
1421 """__imul__(self, Point2D pt) -> Point2D"""
1422 return _core_.Point2D___imul__(*args, **kwargs)
1423
1424 def __idiv__(*args, **kwargs):
1425 """__idiv__(self, Point2D pt) -> Point2D"""
1426 return _core_.Point2D___idiv__(*args, **kwargs)
1427
1428 def __eq__(*args, **kwargs):
1429 """
1430 __eq__(self, Point2D pt) -> bool
1431
1432 Test for equality
1433 """
1434 return _core_.Point2D___eq__(*args, **kwargs)
1435
1436 def __ne__(*args, **kwargs):
1437 """
1438 __ne__(self, Point2D pt) -> bool
1439
1440 Test for inequality
1441 """
1442 return _core_.Point2D___ne__(*args, **kwargs)
1443
1444 x = property(_core_.Point2D_x_get, _core_.Point2D_x_set)
1445 y = property(_core_.Point2D_y_get, _core_.Point2D_y_set)
1446 def Set(*args, **kwargs):
1447 """Set(self, double x=0, double y=0)"""
1448 return _core_.Point2D_Set(*args, **kwargs)
1449
1450 def Get(*args, **kwargs):
1451 """
1452 Get() -> (x,y)
1453
1454 Return x and y properties as a tuple.
1455 """
1456 return _core_.Point2D_Get(*args, **kwargs)
1457
79fccf9d 1458 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
1459 def __str__(self): return str(self.Get())
1460 def __repr__(self): return 'wx.Point2D'+str(self.Get())
1461 def __len__(self): return len(self.Get())
1462 def __getitem__(self, index): return self.Get()[index]
1463 def __setitem__(self, index, val):
1464 if index == 0: self.x = val
1465 elif index == 1: self.y = val
1466 else: raise IndexError
1467 def __nonzero__(self): return self.Get() != (0.0, 0.0)
1468 __safe_for_unpickling__ = True
1469 def __reduce__(self): return (wx.Point2D, self.Get())
1470
1471
1472class Point2DPtr(Point2D):
1473 def __init__(self, this):
1474 self.this = this
1475 if not hasattr(self,"thisown"): self.thisown = 0
1476 self.__class__ = Point2D
1477_core_.Point2D_swigregister(Point2DPtr)
1478
1479def Point2DCopy(*args, **kwargs):
1480 """
1481 Point2DCopy(Point2D pt) -> Point2D
1482
1483 Create a w.Point2D object.
1484 """
1485 val = _core_.new_Point2DCopy(*args, **kwargs)
1486 val.thisown = 1
1487 return val
1488
1489def Point2DFromPoint(*args, **kwargs):
1490 """
1491 Point2DFromPoint(Point pt) -> Point2D
1492
1493 Create a w.Point2D object.
1494 """
1495 val = _core_.new_Point2DFromPoint(*args, **kwargs)
1496 val.thisown = 1
1497 return val
1498
1499#---------------------------------------------------------------------------
1500
1501FromStart = _core_.FromStart
1502FromCurrent = _core_.FromCurrent
1503FromEnd = _core_.FromEnd
1504class InputStream(object):
1505 def __repr__(self):
1506 return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1507 def __init__(self, *args, **kwargs):
1508 """__init__(self, PyObject p) -> InputStream"""
1509 newobj = _core_.new_InputStream(*args, **kwargs)
1510 self.this = newobj.this
1511 self.thisown = 1
1512 del newobj.thisown
1513 def close(*args, **kwargs):
1514 """close(self)"""
1515 return _core_.InputStream_close(*args, **kwargs)
1516
1517 def flush(*args, **kwargs):
1518 """flush(self)"""
1519 return _core_.InputStream_flush(*args, **kwargs)
1520
1521 def eof(*args, **kwargs):
1522 """eof(self) -> bool"""
1523 return _core_.InputStream_eof(*args, **kwargs)
1524
1525 def read(*args, **kwargs):
1526 """read(self, int size=-1) -> PyObject"""
1527 return _core_.InputStream_read(*args, **kwargs)
1528
1529 def readline(*args, **kwargs):
1530 """readline(self, int size=-1) -> PyObject"""
1531 return _core_.InputStream_readline(*args, **kwargs)
1532
1533 def readlines(*args, **kwargs):
1534 """readlines(self, int sizehint=-1) -> PyObject"""
1535 return _core_.InputStream_readlines(*args, **kwargs)
1536
1537 def seek(*args, **kwargs):
1538 """seek(self, int offset, int whence=0)"""
1539 return _core_.InputStream_seek(*args, **kwargs)
1540
1541 def tell(*args, **kwargs):
1542 """tell(self) -> int"""
1543 return _core_.InputStream_tell(*args, **kwargs)
1544
1545 def Peek(*args, **kwargs):
1546 """Peek(self) -> char"""
1547 return _core_.InputStream_Peek(*args, **kwargs)
1548
1549 def GetC(*args, **kwargs):
1550 """GetC(self) -> char"""
1551 return _core_.InputStream_GetC(*args, **kwargs)
1552
1553 def LastRead(*args, **kwargs):
1554 """LastRead(self) -> size_t"""
1555 return _core_.InputStream_LastRead(*args, **kwargs)
1556
1557 def CanRead(*args, **kwargs):
1558 """CanRead(self) -> bool"""
1559 return _core_.InputStream_CanRead(*args, **kwargs)
1560
1561 def Eof(*args, **kwargs):
1562 """Eof(self) -> bool"""
1563 return _core_.InputStream_Eof(*args, **kwargs)
1564
1565 def Ungetch(*args, **kwargs):
1566 """Ungetch(self, char c) -> bool"""
1567 return _core_.InputStream_Ungetch(*args, **kwargs)
1568
1569 def SeekI(*args, **kwargs):
1570 """SeekI(self, long pos, int mode=FromStart) -> long"""
1571 return _core_.InputStream_SeekI(*args, **kwargs)
1572
1573 def TellI(*args, **kwargs):
1574 """TellI(self) -> long"""
1575 return _core_.InputStream_TellI(*args, **kwargs)
1576
1577
1578class InputStreamPtr(InputStream):
1579 def __init__(self, this):
1580 self.this = this
1581 if not hasattr(self,"thisown"): self.thisown = 0
1582 self.__class__ = InputStream
1583_core_.InputStream_swigregister(InputStreamPtr)
1584DefaultPosition = cvar.DefaultPosition
1585DefaultSize = cvar.DefaultSize
1586
1587class OutputStream(object):
1588 def __init__(self): raise RuntimeError, "No constructor defined"
1589 def __repr__(self):
1590 return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1591 def write(*args, **kwargs):
1592 """write(self, PyObject obj)"""
1593 return _core_.OutputStream_write(*args, **kwargs)
1594
1595
1596class OutputStreamPtr(OutputStream):
1597 def __init__(self, this):
1598 self.this = this
1599 if not hasattr(self,"thisown"): self.thisown = 0
1600 self.__class__ = OutputStream
1601_core_.OutputStream_swigregister(OutputStreamPtr)
1602
1603#---------------------------------------------------------------------------
1604
1605class FSFile(Object):
1606 def __repr__(self):
1607 return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1608 def __init__(self, *args, **kwargs):
1609 """
1610 __init__(self, InputStream stream, String loc, String mimetype, String anchor,
1611 DateTime modif) -> FSFile
1612 """
1613 newobj = _core_.new_FSFile(*args, **kwargs)
1614 self.this = newobj.this
1615 self.thisown = 1
1616 del newobj.thisown
4cf4100f
RD
1617 self.thisown = 0 # It will normally be deleted by the user of the wxFileSystem
1618
d55e5bfc
RD
1619 def __del__(self, destroy=_core_.delete_FSFile):
1620 """__del__(self)"""
1621 try:
1622 if self.thisown: destroy(self)
1623 except: pass
1624
1625 def GetStream(*args, **kwargs):
1626 """GetStream(self) -> InputStream"""
1627 return _core_.FSFile_GetStream(*args, **kwargs)
1628
1629 def GetMimeType(*args, **kwargs):
1630 """GetMimeType(self) -> String"""
1631 return _core_.FSFile_GetMimeType(*args, **kwargs)
1632
1633 def GetLocation(*args, **kwargs):
1634 """GetLocation(self) -> String"""
1635 return _core_.FSFile_GetLocation(*args, **kwargs)
1636
1637 def GetAnchor(*args, **kwargs):
1638 """GetAnchor(self) -> String"""
1639 return _core_.FSFile_GetAnchor(*args, **kwargs)
1640
1641 def GetModificationTime(*args, **kwargs):
1642 """GetModificationTime(self) -> DateTime"""
1643 return _core_.FSFile_GetModificationTime(*args, **kwargs)
1644
1645
1646class FSFilePtr(FSFile):
1647 def __init__(self, this):
1648 self.this = this
1649 if not hasattr(self,"thisown"): self.thisown = 0
1650 self.__class__ = FSFile
1651_core_.FSFile_swigregister(FSFilePtr)
1652
1653class CPPFileSystemHandler(object):
1654 def __init__(self): raise RuntimeError, "No constructor defined"
1655 def __repr__(self):
1656 return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1657
1658class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
1659 def __init__(self, this):
1660 self.this = this
1661 if not hasattr(self,"thisown"): self.thisown = 0
1662 self.__class__ = CPPFileSystemHandler
1663_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
1664
1665class FileSystemHandler(CPPFileSystemHandler):
1666 def __repr__(self):
1667 return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1668 def __init__(self, *args, **kwargs):
1669 """__init__(self) -> FileSystemHandler"""
1670 newobj = _core_.new_FileSystemHandler(*args, **kwargs)
1671 self.this = newobj.this
1672 self.thisown = 1
1673 del newobj.thisown
1674 self._setCallbackInfo(self, FileSystemHandler)
1675
1676 def _setCallbackInfo(*args, **kwargs):
1677 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1678 return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs)
1679
1680 def CanOpen(*args, **kwargs):
1681 """CanOpen(self, String location) -> bool"""
1682 return _core_.FileSystemHandler_CanOpen(*args, **kwargs)
1683
1684 def OpenFile(*args, **kwargs):
1685 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1686 return _core_.FileSystemHandler_OpenFile(*args, **kwargs)
1687
1688 def FindFirst(*args, **kwargs):
1689 """FindFirst(self, String spec, int flags=0) -> String"""
1690 return _core_.FileSystemHandler_FindFirst(*args, **kwargs)
1691
1692 def FindNext(*args, **kwargs):
1693 """FindNext(self) -> String"""
1694 return _core_.FileSystemHandler_FindNext(*args, **kwargs)
1695
1696 def GetProtocol(*args, **kwargs):
1697 """GetProtocol(self, String location) -> String"""
1698 return _core_.FileSystemHandler_GetProtocol(*args, **kwargs)
1699
1700 def GetLeftLocation(*args, **kwargs):
1701 """GetLeftLocation(self, String location) -> String"""
1702 return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs)
1703
1704 def GetAnchor(*args, **kwargs):
1705 """GetAnchor(self, String location) -> String"""
1706 return _core_.FileSystemHandler_GetAnchor(*args, **kwargs)
1707
1708 def GetRightLocation(*args, **kwargs):
1709 """GetRightLocation(self, String location) -> String"""
1710 return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs)
1711
1712 def GetMimeTypeFromExt(*args, **kwargs):
1713 """GetMimeTypeFromExt(self, String location) -> String"""
1714 return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
1715
1716
1717class FileSystemHandlerPtr(FileSystemHandler):
1718 def __init__(self, this):
1719 self.this = this
1720 if not hasattr(self,"thisown"): self.thisown = 0
1721 self.__class__ = FileSystemHandler
1722_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
1723
1724class FileSystem(Object):
1725 def __repr__(self):
1726 return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1727 def __init__(self, *args, **kwargs):
1728 """__init__(self) -> FileSystem"""
1729 newobj = _core_.new_FileSystem(*args, **kwargs)
1730 self.this = newobj.this
1731 self.thisown = 1
1732 del newobj.thisown
1733 def __del__(self, destroy=_core_.delete_FileSystem):
1734 """__del__(self)"""
1735 try:
1736 if self.thisown: destroy(self)
1737 except: pass
1738
1739 def ChangePathTo(*args, **kwargs):
1740 """ChangePathTo(self, String location, bool is_dir=False)"""
1741 return _core_.FileSystem_ChangePathTo(*args, **kwargs)
1742
1743 def GetPath(*args, **kwargs):
1744 """GetPath(self) -> String"""
1745 return _core_.FileSystem_GetPath(*args, **kwargs)
1746
1747 def OpenFile(*args, **kwargs):
1748 """OpenFile(self, String location) -> FSFile"""
1749 return _core_.FileSystem_OpenFile(*args, **kwargs)
1750
1751 def FindFirst(*args, **kwargs):
1752 """FindFirst(self, String spec, int flags=0) -> String"""
1753 return _core_.FileSystem_FindFirst(*args, **kwargs)
1754
1755 def FindNext(*args, **kwargs):
1756 """FindNext(self) -> String"""
1757 return _core_.FileSystem_FindNext(*args, **kwargs)
1758
1759 def AddHandler(*args, **kwargs):
c24da6d6 1760 """AddHandler(CPPFileSystemHandler handler)"""
d55e5bfc
RD
1761 return _core_.FileSystem_AddHandler(*args, **kwargs)
1762
1763 AddHandler = staticmethod(AddHandler)
1764 def CleanUpHandlers(*args, **kwargs):
c24da6d6 1765 """CleanUpHandlers()"""
d55e5bfc
RD
1766 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1767
1768 CleanUpHandlers = staticmethod(CleanUpHandlers)
1769 def FileNameToURL(*args, **kwargs):
c24da6d6 1770 """FileNameToURL(String filename) -> String"""
d55e5bfc
RD
1771 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1772
1773 FileNameToURL = staticmethod(FileNameToURL)
1774
1775class FileSystemPtr(FileSystem):
1776 def __init__(self, this):
1777 self.this = this
1778 if not hasattr(self,"thisown"): self.thisown = 0
1779 self.__class__ = FileSystem
1780_core_.FileSystem_swigregister(FileSystemPtr)
1781
1782def FileSystem_AddHandler(*args, **kwargs):
1783 """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
1784 return _core_.FileSystem_AddHandler(*args, **kwargs)
1785
1786def FileSystem_CleanUpHandlers(*args, **kwargs):
1787 """FileSystem_CleanUpHandlers()"""
1788 return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
1789
1790def FileSystem_FileNameToURL(*args, **kwargs):
1791 """FileSystem_FileNameToURL(String filename) -> String"""
1792 return _core_.FileSystem_FileNameToURL(*args, **kwargs)
1793
1794
1795def FileSystem_URLToFileName(*args, **kwargs):
1796 """FileSystem_URLToFileName(String url) -> String"""
1797 return _core_.FileSystem_URLToFileName(*args, **kwargs)
1798class InternetFSHandler(CPPFileSystemHandler):
1799 def __repr__(self):
1800 return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1801 def __init__(self, *args, **kwargs):
1802 """__init__(self) -> InternetFSHandler"""
1803 newobj = _core_.new_InternetFSHandler(*args, **kwargs)
1804 self.this = newobj.this
1805 self.thisown = 1
1806 del newobj.thisown
1807 def CanOpen(*args, **kwargs):
1808 """CanOpen(self, String location) -> bool"""
1809 return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
1810
1811 def OpenFile(*args, **kwargs):
1812 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1813 return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
1814
1815
1816class InternetFSHandlerPtr(InternetFSHandler):
1817 def __init__(self, this):
1818 self.this = this
1819 if not hasattr(self,"thisown"): self.thisown = 0
1820 self.__class__ = InternetFSHandler
1821_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
1822
1823class ZipFSHandler(CPPFileSystemHandler):
1824 def __repr__(self):
1825 return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1826 def __init__(self, *args, **kwargs):
1827 """__init__(self) -> ZipFSHandler"""
1828 newobj = _core_.new_ZipFSHandler(*args, **kwargs)
1829 self.this = newobj.this
1830 self.thisown = 1
1831 del newobj.thisown
1832 def CanOpen(*args, **kwargs):
1833 """CanOpen(self, String location) -> bool"""
1834 return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
1835
1836 def OpenFile(*args, **kwargs):
1837 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1838 return _core_.ZipFSHandler_OpenFile(*args, **kwargs)
1839
1840 def FindFirst(*args, **kwargs):
1841 """FindFirst(self, String spec, int flags=0) -> String"""
1842 return _core_.ZipFSHandler_FindFirst(*args, **kwargs)
1843
1844 def FindNext(*args, **kwargs):
1845 """FindNext(self) -> String"""
1846 return _core_.ZipFSHandler_FindNext(*args, **kwargs)
1847
1848
1849class ZipFSHandlerPtr(ZipFSHandler):
1850 def __init__(self, this):
1851 self.this = this
1852 if not hasattr(self,"thisown"): self.thisown = 0
1853 self.__class__ = ZipFSHandler
1854_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
1855
1856
1857def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
1858 """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
1859 return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
1860
1861def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
1862 """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
1863 return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
1864
1865def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
1866 """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
1867 return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
1868def MemoryFSHandler_AddFile(filename, a, b=''):
1869 if isinstance(a, wx.Image):
1870 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1871 elif isinstance(a, wx.Bitmap):
1872 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1873 elif type(a) == str:
1874 __wxMemoryFSHandler_AddFile_Data(filename, a)
1875 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1876
1877class MemoryFSHandler(CPPFileSystemHandler):
1878 def __repr__(self):
1879 return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1880 def __init__(self, *args, **kwargs):
1881 """__init__(self) -> MemoryFSHandler"""
1882 newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
1883 self.this = newobj.this
1884 self.thisown = 1
1885 del newobj.thisown
1886 def RemoveFile(*args, **kwargs):
c24da6d6 1887 """RemoveFile(String filename)"""
d55e5bfc
RD
1888 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1889
1890 RemoveFile = staticmethod(RemoveFile)
1891 AddFile = staticmethod(MemoryFSHandler_AddFile)
1892 def CanOpen(*args, **kwargs):
1893 """CanOpen(self, String location) -> bool"""
1894 return _core_.MemoryFSHandler_CanOpen(*args, **kwargs)
1895
1896 def OpenFile(*args, **kwargs):
1897 """OpenFile(self, FileSystem fs, String location) -> FSFile"""
1898 return _core_.MemoryFSHandler_OpenFile(*args, **kwargs)
1899
1900 def FindFirst(*args, **kwargs):
1901 """FindFirst(self, String spec, int flags=0) -> String"""
1902 return _core_.MemoryFSHandler_FindFirst(*args, **kwargs)
1903
1904 def FindNext(*args, **kwargs):
1905 """FindNext(self) -> String"""
1906 return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
1907
1908
1909class MemoryFSHandlerPtr(MemoryFSHandler):
1910 def __init__(self, this):
1911 self.this = this
1912 if not hasattr(self,"thisown"): self.thisown = 0
1913 self.__class__ = MemoryFSHandler
1914_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
1915
1916def MemoryFSHandler_RemoveFile(*args, **kwargs):
1917 """MemoryFSHandler_RemoveFile(String filename)"""
1918 return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
1919
1920#---------------------------------------------------------------------------
1921
1922class ImageHandler(Object):
1923 def __init__(self): raise RuntimeError, "No constructor defined"
1924 def __repr__(self):
1925 return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1926 def GetName(*args, **kwargs):
1927 """GetName(self) -> String"""
1928 return _core_.ImageHandler_GetName(*args, **kwargs)
1929
1930 def GetExtension(*args, **kwargs):
1931 """GetExtension(self) -> String"""
1932 return _core_.ImageHandler_GetExtension(*args, **kwargs)
1933
1934 def GetType(*args, **kwargs):
1935 """GetType(self) -> long"""
1936 return _core_.ImageHandler_GetType(*args, **kwargs)
1937
1938 def GetMimeType(*args, **kwargs):
1939 """GetMimeType(self) -> String"""
1940 return _core_.ImageHandler_GetMimeType(*args, **kwargs)
1941
1942 def CanRead(*args, **kwargs):
1943 """CanRead(self, String name) -> bool"""
1944 return _core_.ImageHandler_CanRead(*args, **kwargs)
1945
1946 def SetName(*args, **kwargs):
1947 """SetName(self, String name)"""
1948 return _core_.ImageHandler_SetName(*args, **kwargs)
1949
1950 def SetExtension(*args, **kwargs):
1951 """SetExtension(self, String extension)"""
1952 return _core_.ImageHandler_SetExtension(*args, **kwargs)
1953
1954 def SetType(*args, **kwargs):
1955 """SetType(self, long type)"""
1956 return _core_.ImageHandler_SetType(*args, **kwargs)
1957
1958 def SetMimeType(*args, **kwargs):
1959 """SetMimeType(self, String mimetype)"""
1960 return _core_.ImageHandler_SetMimeType(*args, **kwargs)
1961
1962
1963class ImageHandlerPtr(ImageHandler):
1964 def __init__(self, this):
1965 self.this = this
1966 if not hasattr(self,"thisown"): self.thisown = 0
1967 self.__class__ = ImageHandler
1968_core_.ImageHandler_swigregister(ImageHandlerPtr)
1969
1970class ImageHistogram(object):
1971 def __repr__(self):
1972 return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
1973 def __init__(self, *args, **kwargs):
1974 """__init__(self) -> ImageHistogram"""
1975 newobj = _core_.new_ImageHistogram(*args, **kwargs)
1976 self.this = newobj.this
1977 self.thisown = 1
1978 del newobj.thisown
1979 def MakeKey(*args, **kwargs):
1980 """
c24da6d6 1981 MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
d55e5bfc
RD
1982
1983 Get the key in the histogram for the given RGB values
1984 """
1985 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
1986
1987 MakeKey = staticmethod(MakeKey)
1988 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
1989 """
1990 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
1991
1992 Find first colour that is not used in the image and has higher RGB
1993 values than startR, startG, startB. Returns a tuple consisting of a
1994 success flag and rgb values.
1995 """
d55e5bfc
RD
1996 return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
1997
1998
1999class ImageHistogramPtr(ImageHistogram):
2000 def __init__(self, this):
2001 self.this = this
2002 if not hasattr(self,"thisown"): self.thisown = 0
2003 self.__class__ = ImageHistogram
2004_core_.ImageHistogram_swigregister(ImageHistogramPtr)
2005
2006def ImageHistogram_MakeKey(*args, **kwargs):
2007 """
2008 ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
2009
2010 Get the key in the histogram for the given RGB values
2011 """
2012 return _core_.ImageHistogram_MakeKey(*args, **kwargs)
2013
2014class Image(Object):
2015 def __repr__(self):
2016 return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2017 def __init__(self, *args, **kwargs):
2018 """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2019 newobj = _core_.new_Image(*args, **kwargs)
2020 self.this = newobj.this
2021 self.thisown = 1
2022 del newobj.thisown
2023 def __del__(self, destroy=_core_.delete_Image):
2024 """__del__(self)"""
2025 try:
2026 if self.thisown: destroy(self)
2027 except: pass
2028
2029 def Create(*args, **kwargs):
2030 """Create(self, int width, int height)"""
2031 return _core_.Image_Create(*args, **kwargs)
2032
2033 def Destroy(*args, **kwargs):
2034 """
2035 Destroy(self)
2036
2037 Deletes the C++ object this Python object is a proxy for.
2038 """
2039 return _core_.Image_Destroy(*args, **kwargs)
2040
2041 def Scale(*args, **kwargs):
2042 """Scale(self, int width, int height) -> Image"""
2043 return _core_.Image_Scale(*args, **kwargs)
2044
2045 def ShrinkBy(*args, **kwargs):
2046 """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
2047 return _core_.Image_ShrinkBy(*args, **kwargs)
2048
2049 def Rescale(*args, **kwargs):
2050 """Rescale(self, int width, int height) -> Image"""
2051 return _core_.Image_Rescale(*args, **kwargs)
2052
2053 def SetRGB(*args, **kwargs):
2054 """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
2055 return _core_.Image_SetRGB(*args, **kwargs)
2056
2057 def GetRed(*args, **kwargs):
2058 """GetRed(self, int x, int y) -> unsigned char"""
2059 return _core_.Image_GetRed(*args, **kwargs)
2060
2061 def GetGreen(*args, **kwargs):
2062 """GetGreen(self, int x, int y) -> unsigned char"""
2063 return _core_.Image_GetGreen(*args, **kwargs)
2064
2065 def GetBlue(*args, **kwargs):
2066 """GetBlue(self, int x, int y) -> unsigned char"""
2067 return _core_.Image_GetBlue(*args, **kwargs)
2068
2069 def SetAlpha(*args, **kwargs):
2070 """SetAlpha(self, int x, int y, unsigned char alpha)"""
2071 return _core_.Image_SetAlpha(*args, **kwargs)
2072
2073 def GetAlpha(*args, **kwargs):
2074 """GetAlpha(self, int x, int y) -> unsigned char"""
2075 return _core_.Image_GetAlpha(*args, **kwargs)
2076
2077 def HasAlpha(*args, **kwargs):
2078 """HasAlpha(self) -> bool"""
2079 return _core_.Image_HasAlpha(*args, **kwargs)
2080
2081 def FindFirstUnusedColour(*args, **kwargs):
a8eff060
RD
2082 """
2083 FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
2084
2085 Find first colour that is not used in the image and has higher RGB
2086 values than startR, startG, startB. Returns a tuple consisting of a
2087 success flag and rgb values.
2088 """
d55e5bfc
RD
2089 return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
2090
4cf4100f
RD
2091 def ConvertAlphaToMask(*args, **kwargs):
2092 """
2093 ConvertAlphaToMask(self, byte threshold=128) -> bool
2094
2095 If the image has alpha channel, this method converts it to mask. All pixels
2096 with alpha value less than ``threshold`` are replaced with mask colour and the
2097 alpha channel is removed. Mask colour is chosen automatically using
2098 `FindFirstUnusedColour`.
2099
2100 If the image image doesn't have alpha channel, ConvertAlphaToMask does
2101 nothing.
2102 """
2103 return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
2104
d55e5bfc
RD
2105 def SetMaskFromImage(*args, **kwargs):
2106 """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
2107 return _core_.Image_SetMaskFromImage(*args, **kwargs)
2108
2109 def CanRead(*args, **kwargs):
c24da6d6 2110 """CanRead(String name) -> bool"""
d55e5bfc
RD
2111 return _core_.Image_CanRead(*args, **kwargs)
2112
2113 CanRead = staticmethod(CanRead)
2114 def GetImageCount(*args, **kwargs):
c24da6d6 2115 """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
d55e5bfc
RD
2116 return _core_.Image_GetImageCount(*args, **kwargs)
2117
2118 GetImageCount = staticmethod(GetImageCount)
2119 def LoadFile(*args, **kwargs):
2120 """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2121 return _core_.Image_LoadFile(*args, **kwargs)
2122
2123 def LoadMimeFile(*args, **kwargs):
2124 """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
2125 return _core_.Image_LoadMimeFile(*args, **kwargs)
2126
2127 def SaveFile(*args, **kwargs):
2128 """SaveFile(self, String name, int type) -> bool"""
2129 return _core_.Image_SaveFile(*args, **kwargs)
2130
2131 def SaveMimeFile(*args, **kwargs):
2132 """SaveMimeFile(self, String name, String mimetype) -> bool"""
2133 return _core_.Image_SaveMimeFile(*args, **kwargs)
2134
2135 def CanReadStream(*args, **kwargs):
c24da6d6 2136 """CanReadStream(InputStream stream) -> bool"""
d55e5bfc
RD
2137 return _core_.Image_CanReadStream(*args, **kwargs)
2138
2139 CanReadStream = staticmethod(CanReadStream)
2140 def LoadStream(*args, **kwargs):
2141 """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
2142 return _core_.Image_LoadStream(*args, **kwargs)
2143
2144 def LoadMimeStream(*args, **kwargs):
2145 """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
2146 return _core_.Image_LoadMimeStream(*args, **kwargs)
2147
2148 def Ok(*args, **kwargs):
2149 """Ok(self) -> bool"""
2150 return _core_.Image_Ok(*args, **kwargs)
2151
2152 def GetWidth(*args, **kwargs):
2153 """GetWidth(self) -> int"""
2154 return _core_.Image_GetWidth(*args, **kwargs)
2155
2156 def GetHeight(*args, **kwargs):
2157 """GetHeight(self) -> int"""
2158 return _core_.Image_GetHeight(*args, **kwargs)
2159
2160 def GetSize(*args, **kwargs):
2161 """GetSize(self) -> Size"""
2162 return _core_.Image_GetSize(*args, **kwargs)
2163
2164 def GetSubImage(*args, **kwargs):
2165 """GetSubImage(self, Rect rect) -> Image"""
2166 return _core_.Image_GetSubImage(*args, **kwargs)
2167
2168 def Copy(*args, **kwargs):
2169 """Copy(self) -> Image"""
2170 return _core_.Image_Copy(*args, **kwargs)
2171
2172 def Paste(*args, **kwargs):
2173 """Paste(self, Image image, int x, int y)"""
2174 return _core_.Image_Paste(*args, **kwargs)
2175
2176 def GetData(*args, **kwargs):
2177 """GetData(self) -> PyObject"""
2178 return _core_.Image_GetData(*args, **kwargs)
2179
2180 def SetData(*args, **kwargs):
2181 """SetData(self, PyObject data)"""
2182 return _core_.Image_SetData(*args, **kwargs)
2183
2184 def GetDataBuffer(*args, **kwargs):
2185 """GetDataBuffer(self) -> PyObject"""
2186 return _core_.Image_GetDataBuffer(*args, **kwargs)
2187
2188 def SetDataBuffer(*args, **kwargs):
2189 """SetDataBuffer(self, PyObject data)"""
2190 return _core_.Image_SetDataBuffer(*args, **kwargs)
2191
2192 def GetAlphaData(*args, **kwargs):
2193 """GetAlphaData(self) -> PyObject"""
2194 return _core_.Image_GetAlphaData(*args, **kwargs)
2195
2196 def SetAlphaData(*args, **kwargs):
2197 """SetAlphaData(self, PyObject data)"""
2198 return _core_.Image_SetAlphaData(*args, **kwargs)
2199
2200 def GetAlphaBuffer(*args, **kwargs):
2201 """GetAlphaBuffer(self) -> PyObject"""
2202 return _core_.Image_GetAlphaBuffer(*args, **kwargs)
2203
2204 def SetAlphaBuffer(*args, **kwargs):
2205 """SetAlphaBuffer(self, PyObject data)"""
2206 return _core_.Image_SetAlphaBuffer(*args, **kwargs)
2207
2208 def SetMaskColour(*args, **kwargs):
2209 """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
2210 return _core_.Image_SetMaskColour(*args, **kwargs)
2211
2212 def GetMaskRed(*args, **kwargs):
2213 """GetMaskRed(self) -> unsigned char"""
2214 return _core_.Image_GetMaskRed(*args, **kwargs)
2215
2216 def GetMaskGreen(*args, **kwargs):
2217 """GetMaskGreen(self) -> unsigned char"""
2218 return _core_.Image_GetMaskGreen(*args, **kwargs)
2219
2220 def GetMaskBlue(*args, **kwargs):
2221 """GetMaskBlue(self) -> unsigned char"""
2222 return _core_.Image_GetMaskBlue(*args, **kwargs)
2223
2224 def SetMask(*args, **kwargs):
2225 """SetMask(self, bool mask=True)"""
2226 return _core_.Image_SetMask(*args, **kwargs)
2227
2228 def HasMask(*args, **kwargs):
2229 """HasMask(self) -> bool"""
2230 return _core_.Image_HasMask(*args, **kwargs)
2231
2232 def Rotate(*args, **kwargs):
2233 """
2234 Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
2235 Point offset_after_rotation=None) -> Image
2236 """
2237 return _core_.Image_Rotate(*args, **kwargs)
2238
2239 def Rotate90(*args, **kwargs):
2240 """Rotate90(self, bool clockwise=True) -> Image"""
2241 return _core_.Image_Rotate90(*args, **kwargs)
2242
2243 def Mirror(*args, **kwargs):
2244 """Mirror(self, bool horizontally=True) -> Image"""
2245 return _core_.Image_Mirror(*args, **kwargs)
2246
2247 def Replace(*args, **kwargs):
2248 """
2249 Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
2250 unsigned char r2, unsigned char g2, unsigned char b2)
2251 """
2252 return _core_.Image_Replace(*args, **kwargs)
2253
2254 def ConvertToMono(*args, **kwargs):
2255 """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
2256 return _core_.Image_ConvertToMono(*args, **kwargs)
2257
2258 def SetOption(*args, **kwargs):
2259 """SetOption(self, String name, String value)"""
2260 return _core_.Image_SetOption(*args, **kwargs)
2261
2262 def SetOptionInt(*args, **kwargs):
2263 """SetOptionInt(self, String name, int value)"""
2264 return _core_.Image_SetOptionInt(*args, **kwargs)
2265
2266 def GetOption(*args, **kwargs):
2267 """GetOption(self, String name) -> String"""
2268 return _core_.Image_GetOption(*args, **kwargs)
2269
2270 def GetOptionInt(*args, **kwargs):
2271 """GetOptionInt(self, String name) -> int"""
2272 return _core_.Image_GetOptionInt(*args, **kwargs)
2273
2274 def HasOption(*args, **kwargs):
2275 """HasOption(self, String name) -> bool"""
2276 return _core_.Image_HasOption(*args, **kwargs)
2277
2278 def CountColours(*args, **kwargs):
2279 """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long"""
2280 return _core_.Image_CountColours(*args, **kwargs)
2281
2282 def ComputeHistogram(*args, **kwargs):
2283 """ComputeHistogram(self, ImageHistogram h) -> unsigned long"""
2284 return _core_.Image_ComputeHistogram(*args, **kwargs)
2285
2286 def AddHandler(*args, **kwargs):
c24da6d6 2287 """AddHandler(ImageHandler handler)"""
d55e5bfc
RD
2288 return _core_.Image_AddHandler(*args, **kwargs)
2289
2290 AddHandler = staticmethod(AddHandler)
2291 def InsertHandler(*args, **kwargs):
c24da6d6 2292 """InsertHandler(ImageHandler handler)"""
d55e5bfc
RD
2293 return _core_.Image_InsertHandler(*args, **kwargs)
2294
2295 InsertHandler = staticmethod(InsertHandler)
2296 def RemoveHandler(*args, **kwargs):
c24da6d6 2297 """RemoveHandler(String name) -> bool"""
d55e5bfc
RD
2298 return _core_.Image_RemoveHandler(*args, **kwargs)
2299
2300 RemoveHandler = staticmethod(RemoveHandler)
2301 def GetImageExtWildcard(*args, **kwargs):
c24da6d6 2302 """GetImageExtWildcard() -> String"""
d55e5bfc
RD
2303 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2304
2305 GetImageExtWildcard = staticmethod(GetImageExtWildcard)
2306 def ConvertToBitmap(*args, **kwargs):
1fbf26be 2307 """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
d55e5bfc
RD
2308 return _core_.Image_ConvertToBitmap(*args, **kwargs)
2309
2310 def ConvertToMonoBitmap(*args, **kwargs):
2311 """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
2312 return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
2313
2314 def __nonzero__(self): return self.Ok()
2315
2316class ImagePtr(Image):
2317 def __init__(self, this):
2318 self.this = this
2319 if not hasattr(self,"thisown"): self.thisown = 0
2320 self.__class__ = Image
2321_core_.Image_swigregister(ImagePtr)
2322
2323def ImageFromMime(*args, **kwargs):
2324 """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
2325 val = _core_.new_ImageFromMime(*args, **kwargs)
2326 val.thisown = 1
2327 return val
2328
2329def ImageFromStream(*args, **kwargs):
2330 """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
2331 val = _core_.new_ImageFromStream(*args, **kwargs)
2332 val.thisown = 1
2333 return val
2334
2335def ImageFromStreamMime(*args, **kwargs):
2336 """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
2337 val = _core_.new_ImageFromStreamMime(*args, **kwargs)
2338 val.thisown = 1
2339 return val
2340
c24da6d6
RD
2341def EmptyImage(*args, **kwargs):
2342 """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
2343 val = _core_.new_EmptyImage(*args, **kwargs)
d55e5bfc
RD
2344 val.thisown = 1
2345 return val
2346
2347def ImageFromBitmap(*args, **kwargs):
2348 """ImageFromBitmap(Bitmap bitmap) -> Image"""
2349 val = _core_.new_ImageFromBitmap(*args, **kwargs)
2350 val.thisown = 1
2351 return val
2352
2353def ImageFromData(*args, **kwargs):
2354 """ImageFromData(int width, int height, unsigned char data) -> Image"""
2355 val = _core_.new_ImageFromData(*args, **kwargs)
2356 val.thisown = 1
2357 return val
2358
2359def Image_CanRead(*args, **kwargs):
2360 """Image_CanRead(String name) -> bool"""
2361 return _core_.Image_CanRead(*args, **kwargs)
2362
2363def Image_GetImageCount(*args, **kwargs):
2364 """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
2365 return _core_.Image_GetImageCount(*args, **kwargs)
2366
2367def Image_CanReadStream(*args, **kwargs):
2368 """Image_CanReadStream(InputStream stream) -> bool"""
2369 return _core_.Image_CanReadStream(*args, **kwargs)
2370
2371def Image_AddHandler(*args, **kwargs):
2372 """Image_AddHandler(ImageHandler handler)"""
2373 return _core_.Image_AddHandler(*args, **kwargs)
2374
2375def Image_InsertHandler(*args, **kwargs):
2376 """Image_InsertHandler(ImageHandler handler)"""
2377 return _core_.Image_InsertHandler(*args, **kwargs)
2378
2379def Image_RemoveHandler(*args, **kwargs):
2380 """Image_RemoveHandler(String name) -> bool"""
2381 return _core_.Image_RemoveHandler(*args, **kwargs)
2382
2383def Image_GetImageExtWildcard(*args, **kwargs):
2384 """Image_GetImageExtWildcard() -> String"""
2385 return _core_.Image_GetImageExtWildcard(*args, **kwargs)
2386
a07a67e6
RD
2387def InitAllImageHandlers():
2388 """
2389 The former functionality of InitAllImageHanders is now done internal to
2390 the _core_ extension module and so this function has become a simple NOP.
2391 """
2392 pass
d55e5bfc 2393
d55e5bfc
RD
2394IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
2395IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
2396BMP_24BPP = _core_.BMP_24BPP
2397BMP_8BPP = _core_.BMP_8BPP
2398BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
2399BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY
2400BMP_8BPP_RED = _core_.BMP_8BPP_RED
2401BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE
2402BMP_4BPP = _core_.BMP_4BPP
2403BMP_1BPP = _core_.BMP_1BPP
2404BMP_1BPP_BW = _core_.BMP_1BPP_BW
2405class BMPHandler(ImageHandler):
2406 def __repr__(self):
2407 return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2408 def __init__(self, *args, **kwargs):
2409 """__init__(self) -> BMPHandler"""
2410 newobj = _core_.new_BMPHandler(*args, **kwargs)
2411 self.this = newobj.this
2412 self.thisown = 1
2413 del newobj.thisown
2414
2415class BMPHandlerPtr(BMPHandler):
2416 def __init__(self, this):
2417 self.this = this
2418 if not hasattr(self,"thisown"): self.thisown = 0
2419 self.__class__ = BMPHandler
2420_core_.BMPHandler_swigregister(BMPHandlerPtr)
2421NullImage = cvar.NullImage
2422IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
2423IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
2424IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
2425IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
2426IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
2427
2428class ICOHandler(BMPHandler):
2429 def __repr__(self):
2430 return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2431 def __init__(self, *args, **kwargs):
2432 """__init__(self) -> ICOHandler"""
2433 newobj = _core_.new_ICOHandler(*args, **kwargs)
2434 self.this = newobj.this
2435 self.thisown = 1
2436 del newobj.thisown
2437
2438class ICOHandlerPtr(ICOHandler):
2439 def __init__(self, this):
2440 self.this = this
2441 if not hasattr(self,"thisown"): self.thisown = 0
2442 self.__class__ = ICOHandler
2443_core_.ICOHandler_swigregister(ICOHandlerPtr)
2444
2445class CURHandler(ICOHandler):
2446 def __repr__(self):
2447 return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2448 def __init__(self, *args, **kwargs):
2449 """__init__(self) -> CURHandler"""
2450 newobj = _core_.new_CURHandler(*args, **kwargs)
2451 self.this = newobj.this
2452 self.thisown = 1
2453 del newobj.thisown
2454
2455class CURHandlerPtr(CURHandler):
2456 def __init__(self, this):
2457 self.this = this
2458 if not hasattr(self,"thisown"): self.thisown = 0
2459 self.__class__ = CURHandler
2460_core_.CURHandler_swigregister(CURHandlerPtr)
2461
2462class ANIHandler(CURHandler):
2463 def __repr__(self):
2464 return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2465 def __init__(self, *args, **kwargs):
2466 """__init__(self) -> ANIHandler"""
2467 newobj = _core_.new_ANIHandler(*args, **kwargs)
2468 self.this = newobj.this
2469 self.thisown = 1
2470 del newobj.thisown
2471
2472class ANIHandlerPtr(ANIHandler):
2473 def __init__(self, this):
2474 self.this = this
2475 if not hasattr(self,"thisown"): self.thisown = 0
2476 self.__class__ = ANIHandler
2477_core_.ANIHandler_swigregister(ANIHandlerPtr)
2478
2479class PNGHandler(ImageHandler):
2480 def __repr__(self):
2481 return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2482 def __init__(self, *args, **kwargs):
2483 """__init__(self) -> PNGHandler"""
2484 newobj = _core_.new_PNGHandler(*args, **kwargs)
2485 self.this = newobj.this
2486 self.thisown = 1
2487 del newobj.thisown
2488
2489class PNGHandlerPtr(PNGHandler):
2490 def __init__(self, this):
2491 self.this = this
2492 if not hasattr(self,"thisown"): self.thisown = 0
2493 self.__class__ = PNGHandler
2494_core_.PNGHandler_swigregister(PNGHandlerPtr)
2495
2496class GIFHandler(ImageHandler):
2497 def __repr__(self):
2498 return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2499 def __init__(self, *args, **kwargs):
2500 """__init__(self) -> GIFHandler"""
2501 newobj = _core_.new_GIFHandler(*args, **kwargs)
2502 self.this = newobj.this
2503 self.thisown = 1
2504 del newobj.thisown
2505
2506class GIFHandlerPtr(GIFHandler):
2507 def __init__(self, this):
2508 self.this = this
2509 if not hasattr(self,"thisown"): self.thisown = 0
2510 self.__class__ = GIFHandler
2511_core_.GIFHandler_swigregister(GIFHandlerPtr)
2512
2513class PCXHandler(ImageHandler):
2514 def __repr__(self):
2515 return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2516 def __init__(self, *args, **kwargs):
2517 """__init__(self) -> PCXHandler"""
2518 newobj = _core_.new_PCXHandler(*args, **kwargs)
2519 self.this = newobj.this
2520 self.thisown = 1
2521 del newobj.thisown
2522
2523class PCXHandlerPtr(PCXHandler):
2524 def __init__(self, this):
2525 self.this = this
2526 if not hasattr(self,"thisown"): self.thisown = 0
2527 self.__class__ = PCXHandler
2528_core_.PCXHandler_swigregister(PCXHandlerPtr)
2529
2530class JPEGHandler(ImageHandler):
2531 def __repr__(self):
2532 return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2533 def __init__(self, *args, **kwargs):
2534 """__init__(self) -> JPEGHandler"""
2535 newobj = _core_.new_JPEGHandler(*args, **kwargs)
2536 self.this = newobj.this
2537 self.thisown = 1
2538 del newobj.thisown
2539
2540class JPEGHandlerPtr(JPEGHandler):
2541 def __init__(self, this):
2542 self.this = this
2543 if not hasattr(self,"thisown"): self.thisown = 0
2544 self.__class__ = JPEGHandler
2545_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
2546
2547class PNMHandler(ImageHandler):
2548 def __repr__(self):
2549 return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2550 def __init__(self, *args, **kwargs):
2551 """__init__(self) -> PNMHandler"""
2552 newobj = _core_.new_PNMHandler(*args, **kwargs)
2553 self.this = newobj.this
2554 self.thisown = 1
2555 del newobj.thisown
2556
2557class PNMHandlerPtr(PNMHandler):
2558 def __init__(self, this):
2559 self.this = this
2560 if not hasattr(self,"thisown"): self.thisown = 0
2561 self.__class__ = PNMHandler
2562_core_.PNMHandler_swigregister(PNMHandlerPtr)
2563
2564class XPMHandler(ImageHandler):
2565 def __repr__(self):
2566 return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2567 def __init__(self, *args, **kwargs):
2568 """__init__(self) -> XPMHandler"""
2569 newobj = _core_.new_XPMHandler(*args, **kwargs)
2570 self.this = newobj.this
2571 self.thisown = 1
2572 del newobj.thisown
2573
2574class XPMHandlerPtr(XPMHandler):
2575 def __init__(self, this):
2576 self.this = this
2577 if not hasattr(self,"thisown"): self.thisown = 0
2578 self.__class__ = XPMHandler
2579_core_.XPMHandler_swigregister(XPMHandlerPtr)
2580
2581class TIFFHandler(ImageHandler):
2582 def __repr__(self):
2583 return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2584 def __init__(self, *args, **kwargs):
2585 """__init__(self) -> TIFFHandler"""
2586 newobj = _core_.new_TIFFHandler(*args, **kwargs)
2587 self.this = newobj.this
2588 self.thisown = 1
2589 del newobj.thisown
2590
2591class TIFFHandlerPtr(TIFFHandler):
2592 def __init__(self, this):
2593 self.this = this
2594 if not hasattr(self,"thisown"): self.thisown = 0
2595 self.__class__ = TIFFHandler
2596_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
2597
c0de73ae
RD
2598QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
2599QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
2600class Quantize(object):
2601 """Performs quantization, or colour reduction, on a wxImage."""
2602 def __init__(self): raise RuntimeError, "No constructor defined"
2603 def __repr__(self):
2604 return "<%s.%s; proxy of C++ wxQuantize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2605 def Quantize(*args, **kwargs):
2606 """
2607 Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2608
2609 Reduce the colours in the source image and put the result into the
2610 destination image, setting the palette in the destination if
2611 needed. Both images may be the same, to overwrite the source image.
2612 """
2613 return _core_.Quantize_Quantize(*args, **kwargs)
2614
2615 Quantize = staticmethod(Quantize)
2616
2617class QuantizePtr(Quantize):
2618 def __init__(self, this):
2619 self.this = this
2620 if not hasattr(self,"thisown"): self.thisown = 0
2621 self.__class__ = Quantize
2622_core_.Quantize_swigregister(QuantizePtr)
2623
2624def Quantize_Quantize(*args, **kwargs):
2625 """
2626 Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
2627
2628 Reduce the colours in the source image and put the result into the
2629 destination image, setting the palette in the destination if
2630 needed. Both images may be the same, to overwrite the source image.
2631 """
2632 return _core_.Quantize_Quantize(*args, **kwargs)
2633
d55e5bfc
RD
2634#---------------------------------------------------------------------------
2635
2636class EvtHandler(Object):
2637 def __repr__(self):
2638 return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2639 def __init__(self, *args, **kwargs):
2640 """__init__(self) -> EvtHandler"""
2641 newobj = _core_.new_EvtHandler(*args, **kwargs)
2642 self.this = newobj.this
2643 self.thisown = 1
2644 del newobj.thisown
2645 def GetNextHandler(*args, **kwargs):
2646 """GetNextHandler(self) -> EvtHandler"""
2647 return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
2648
2649 def GetPreviousHandler(*args, **kwargs):
2650 """GetPreviousHandler(self) -> EvtHandler"""
2651 return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs)
2652
2653 def SetNextHandler(*args, **kwargs):
2654 """SetNextHandler(self, EvtHandler handler)"""
2655 return _core_.EvtHandler_SetNextHandler(*args, **kwargs)
2656
2657 def SetPreviousHandler(*args, **kwargs):
2658 """SetPreviousHandler(self, EvtHandler handler)"""
2659 return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs)
2660
2661 def GetEvtHandlerEnabled(*args, **kwargs):
2662 """GetEvtHandlerEnabled(self) -> bool"""
2663 return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs)
2664
2665 def SetEvtHandlerEnabled(*args, **kwargs):
2666 """SetEvtHandlerEnabled(self, bool enabled)"""
2667 return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs)
2668
2669 def ProcessEvent(*args, **kwargs):
2670 """ProcessEvent(self, Event event) -> bool"""
2671 return _core_.EvtHandler_ProcessEvent(*args, **kwargs)
2672
2673 def AddPendingEvent(*args, **kwargs):
2674 """AddPendingEvent(self, Event event)"""
2675 return _core_.EvtHandler_AddPendingEvent(*args, **kwargs)
2676
2677 def ProcessPendingEvents(*args, **kwargs):
2678 """ProcessPendingEvents(self)"""
2679 return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
2680
2681 def Connect(*args, **kwargs):
2682 """Connect(self, int id, int lastId, int eventType, PyObject func)"""
2683 return _core_.EvtHandler_Connect(*args, **kwargs)
2684
2685 def Disconnect(*args, **kwargs):
2686 """Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool"""
2687 return _core_.EvtHandler_Disconnect(*args, **kwargs)
2688
2689 def _setOORInfo(*args, **kwargs):
2690 """_setOORInfo(self, PyObject _self)"""
2691 return _core_.EvtHandler__setOORInfo(*args, **kwargs)
2692
2693 def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2694 """
2695 Bind an event to an event handler.
2696
caef1a4d
RD
2697 :param event: One of the EVT_* objects that specifies the
2698 type of event to bind,
d55e5bfc 2699
caef1a4d
RD
2700 :param handler: A callable object to be invoked when the
2701 event is delivered to self. Pass None to
2702 disconnect an event handler.
d55e5bfc 2703
caef1a4d
RD
2704 :param source: Sometimes the event originates from a
2705 different window than self, but you still
2706 want to catch it in self. (For example, a
2707 button event delivered to a frame.) By
2708 passing the source of the event, the event
2709 handling system is able to differentiate
2710 between the same event type from different
2711 controls.
d55e5bfc 2712
caef1a4d
RD
2713 :param id: Used to spcify the event source by ID instead
2714 of instance.
2715
2716 :param id2: Used when it is desirable to bind a handler
2717 to a range of IDs, such as with EVT_MENU_RANGE.
d55e5bfc
RD
2718 """
2719 if source is not None:
2720 id = source.GetId()
2721 event.Bind(self, id, id2, handler)
2722
c24da6d6
RD
2723 def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
2724 """
2725 Disconencts the event handler binding for event from self.
2726 Returns True if successful.
2727 """
2728 if source is not None:
2729 id = source.GetId()
2730 return event.Unbind(self, id, id2)
d55e5bfc
RD
2731
2732
2733class EvtHandlerPtr(EvtHandler):
2734 def __init__(self, this):
2735 self.this = this
2736 if not hasattr(self,"thisown"): self.thisown = 0
2737 self.__class__ = EvtHandler
2738_core_.EvtHandler_swigregister(EvtHandlerPtr)
2739
2740#---------------------------------------------------------------------------
2741
2742class PyEventBinder(object):
2743 """
2744 Instances of this class are used to bind specific events to event
2745 handlers.
2746 """
2747 def __init__(self, evtType, expectedIDs=0):
2748 if expectedIDs not in [0, 1, 2]:
2749 raise ValueError, "Invalid number of expectedIDs"
2750 self.expectedIDs = expectedIDs
2751
2752 if type(evtType) == list or type(evtType) == tuple:
2753 self.evtType = evtType
2754 else:
2755 self.evtType = [evtType]
2756
2757
2758 def Bind(self, target, id1, id2, function):
2759 """Bind this set of event types to target."""
2760 for et in self.evtType:
2761 target.Connect(id1, id2, et, function)
2762
c24da6d6
RD
2763
2764 def Unbind(self, target, id1, id2):
2765 """Remove an event binding."""
2766 success = 0
2767 for et in self.evtType:
2768 success += target.Disconnect(id1, id2, et)
2769 return success != 0
2770
d55e5bfc
RD
2771
2772 def __call__(self, *args):
2773 """
2774 For backwards compatibility with the old EVT_* functions.
2775 Should be called with either (window, func), (window, ID,
2776 func) or (window, ID1, ID2, func) parameters depending on the
2777 type of the event.
2778 """
2779 assert len(args) == 2 + self.expectedIDs
2780 id1 = wx.ID_ANY
2781 id2 = wx.ID_ANY
2782 target = args[0]
2783 if self.expectedIDs == 0:
2784 func = args[1]
2785 elif self.expectedIDs == 1:
2786 id1 = args[1]
2787 func = args[2]
2788 elif self.expectedIDs == 2:
2789 id1 = args[1]
2790 id2 = args[2]
2791 func = args[3]
2792 else:
2793 raise ValueError, "Unexpected number of IDs"
2794
2795 self.Bind(target, id1, id2, func)
2796
2797
2798# These two are square pegs that don't fit the PyEventBinder hole...
2799def EVT_COMMAND(win, id, cmd, func):
2800 win.Connect(id, -1, cmd, func)
2801def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
2802 win.Connect(id1, id2, cmd, func)
2803
2804
2805#---------------------------------------------------------------------------
2806
2807#---------------------------------------------------------------------------
2808
2809EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
2810EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
2811
2812def NewEventType(*args, **kwargs):
2813 """NewEventType() -> wxEventType"""
2814 return _core_.NewEventType(*args, **kwargs)
2815wxEVT_NULL = _core_.wxEVT_NULL
2816wxEVT_FIRST = _core_.wxEVT_FIRST
2817wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
2818wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED
2819wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED
2820wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED
2821wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED
2822wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
2823wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
2824wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED
2825wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED
2826wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED
2827wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED
2828wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED
2829wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED
2830wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED
2831wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED
2832wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED
2833wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER
2834wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN
2835wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP
2836wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN
2837wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP
2838wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN
2839wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP
2840wxEVT_MOTION = _core_.wxEVT_MOTION
2841wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW
2842wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW
2843wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK
2844wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK
2845wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK
2846wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS
2847wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS
2848wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS
2849wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL
2850wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN
2851wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP
2852wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN
2853wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP
2854wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN
2855wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP
2856wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION
2857wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW
2858wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW
2859wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK
2860wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK
2861wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK
2862wxEVT_CHAR = _core_.wxEVT_CHAR
2863wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK
2864wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY
2865wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN
2866wxEVT_KEY_UP = _core_.wxEVT_KEY_UP
2867wxEVT_HOTKEY = _core_.wxEVT_HOTKEY
2868wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR
2869wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP
2870wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM
2871wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP
2872wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN
2873wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP
2874wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
2875wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
2876wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
2877wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
2878wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
2879wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
2880wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
2881wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN
2882wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP
2883wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN
2884wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK
2885wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE
2886wxEVT_SIZE = _core_.wxEVT_SIZE
2887wxEVT_MOVE = _core_.wxEVT_MOVE
2888wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW
2889wxEVT_END_SESSION = _core_.wxEVT_END_SESSION
2890wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION
2891wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP
2892wxEVT_POWER = _core_.wxEVT_POWER
2893wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE
2894wxEVT_CREATE = _core_.wxEVT_CREATE
2895wxEVT_DESTROY = _core_.wxEVT_DESTROY
2896wxEVT_SHOW = _core_.wxEVT_SHOW
2897wxEVT_ICONIZE = _core_.wxEVT_ICONIZE
2898wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE
2899wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED
2900wxEVT_PAINT = _core_.wxEVT_PAINT
2901wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND
2902wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT
2903wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON
2904wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN
2905wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE
2906wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT
2907wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU
2908wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED
2909wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED
2910wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED
2911wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE
2912wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED
2913wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES
2914wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM
2915wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM
2916wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM
2917wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG
2918wxEVT_IDLE = _core_.wxEVT_IDLE
2919wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
2920wxEVT_SIZING = _core_.wxEVT_SIZING
2921wxEVT_MOVING = _core_.wxEVT_MOVING
2922wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
2923wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
2924wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
2925wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK
2926wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS
2927wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS
2928wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER
2929#
2930# Create some event binders
2931EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
2932EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
2933EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
2934EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
2935EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
2936EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2937EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2938EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
2939EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
2940EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
2941EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
2942EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
2943EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
2944EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1)
2945EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
2946EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
2947EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
2948EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1)
2949EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
2950EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
2951EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
2952EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
2953EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
2954EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
2955EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
2956EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
2957EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
2958EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
2959EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
2960EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
2961EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
2962EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
2963EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
2964EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
2965EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
2966EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
2967EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
2968EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
2969EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
2970EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
2971
2972EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
2973EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
2974EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
2975EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
2976EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
2977EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
2978EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
2979EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
2980EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
2981EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
2982EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
2983EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
2984EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
2985
2986EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
2987 wxEVT_LEFT_UP,
2988 wxEVT_MIDDLE_DOWN,
2989 wxEVT_MIDDLE_UP,
2990 wxEVT_RIGHT_DOWN,
2991 wxEVT_RIGHT_UP,
2992 wxEVT_MOTION,
2993 wxEVT_LEFT_DCLICK,
2994 wxEVT_MIDDLE_DCLICK,
2995 wxEVT_RIGHT_DCLICK,
2996 wxEVT_ENTER_WINDOW,
2997 wxEVT_LEAVE_WINDOW,
2998 wxEVT_MOUSEWHEEL
2999 ])
3000
3001
3002# Scrolling from wxWindow (sent to wxScrolledWindow)
3003EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
3004 wxEVT_SCROLLWIN_BOTTOM,
3005 wxEVT_SCROLLWIN_LINEUP,
3006 wxEVT_SCROLLWIN_LINEDOWN,
3007 wxEVT_SCROLLWIN_PAGEUP,
3008 wxEVT_SCROLLWIN_PAGEDOWN,
3009 wxEVT_SCROLLWIN_THUMBTRACK,
3010 wxEVT_SCROLLWIN_THUMBRELEASE,
3011 ])
3012
3013EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
3014EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
3015EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
3016EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
3017EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
3018EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
3019EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
3020EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
3021
3022# Scrolling from wxSlider and wxScrollBar
3023EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3024 wxEVT_SCROLL_BOTTOM,
3025 wxEVT_SCROLL_LINEUP,
3026 wxEVT_SCROLL_LINEDOWN,
3027 wxEVT_SCROLL_PAGEUP,
3028 wxEVT_SCROLL_PAGEDOWN,
3029 wxEVT_SCROLL_THUMBTRACK,
3030 wxEVT_SCROLL_THUMBRELEASE,
3031 wxEVT_SCROLL_ENDSCROLL,
3032 ])
3033
3034EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
3035EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
3036EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
3037EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
3038EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
3039EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
3040EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
3041EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
3042EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
3043
3044# Scrolling from wxSlider and wxScrollBar, with an id
3045EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
3046 wxEVT_SCROLL_BOTTOM,
3047 wxEVT_SCROLL_LINEUP,
3048 wxEVT_SCROLL_LINEDOWN,
3049 wxEVT_SCROLL_PAGEUP,
3050 wxEVT_SCROLL_PAGEDOWN,
3051 wxEVT_SCROLL_THUMBTRACK,
3052 wxEVT_SCROLL_THUMBRELEASE,
3053 wxEVT_SCROLL_ENDSCROLL,
3054 ], 1)
3055
3056EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
3057EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1)
3058EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
3059EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
3060EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1)
3061EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
3062EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
3063EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
3064EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
3065
3066EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
3067EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
3068EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
3069EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1)
3070EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1)
3071EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1)
3072EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2)
3073EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1)
3074EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1)
3075EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1)
3076
3077EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1)
3078EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1)
3079EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1)
3080EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1)
3081EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2)
3082EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1)
3083EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2)
3084EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1)
3085EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1)
3086
3087
3088EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1)
3089EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1)
3090EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1)
3091EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1)
3092EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1)
3093EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1)
3094EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1)
3095
3096EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
3097
3098EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1)
3099EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2)
3100
3101EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
3102
3103
3104
3105#---------------------------------------------------------------------------
3106
3107class Event(Object):
3108 def __init__(self): raise RuntimeError, "No constructor defined"
3109 def __repr__(self):
3110 return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3111 def __del__(self, destroy=_core_.delete_Event):
3112 """__del__(self)"""
3113 try:
3114 if self.thisown: destroy(self)
3115 except: pass
3116
3117 def SetEventType(*args, **kwargs):
3118 """SetEventType(self, wxEventType typ)"""
3119 return _core_.Event_SetEventType(*args, **kwargs)
3120
3121 def GetEventType(*args, **kwargs):
3122 """GetEventType(self) -> wxEventType"""
3123 return _core_.Event_GetEventType(*args, **kwargs)
3124
3125 def GetEventObject(*args, **kwargs):
3126 """GetEventObject(self) -> Object"""
3127 return _core_.Event_GetEventObject(*args, **kwargs)
3128
3129 def SetEventObject(*args, **kwargs):
3130 """SetEventObject(self, Object obj)"""
3131 return _core_.Event_SetEventObject(*args, **kwargs)
3132
3133 def GetTimestamp(*args, **kwargs):
3134 """GetTimestamp(self) -> long"""
3135 return _core_.Event_GetTimestamp(*args, **kwargs)
3136
3137 def SetTimestamp(*args, **kwargs):
3138 """SetTimestamp(self, long ts=0)"""
3139 return _core_.Event_SetTimestamp(*args, **kwargs)
3140
3141 def GetId(*args, **kwargs):
3142 """GetId(self) -> int"""
3143 return _core_.Event_GetId(*args, **kwargs)
3144
3145 def SetId(*args, **kwargs):
3146 """SetId(self, int Id)"""
3147 return _core_.Event_SetId(*args, **kwargs)
3148
3149 def IsCommandEvent(*args, **kwargs):
3150 """IsCommandEvent(self) -> bool"""
3151 return _core_.Event_IsCommandEvent(*args, **kwargs)
3152
3153 def Skip(*args, **kwargs):
3154 """Skip(self, bool skip=True)"""
3155 return _core_.Event_Skip(*args, **kwargs)
3156
3157 def GetSkipped(*args, **kwargs):
3158 """GetSkipped(self) -> bool"""
3159 return _core_.Event_GetSkipped(*args, **kwargs)
3160
3161 def ShouldPropagate(*args, **kwargs):
3162 """ShouldPropagate(self) -> bool"""
3163 return _core_.Event_ShouldPropagate(*args, **kwargs)
3164
3165 def StopPropagation(*args, **kwargs):
3166 """StopPropagation(self) -> int"""
3167 return _core_.Event_StopPropagation(*args, **kwargs)
3168
3169 def ResumePropagation(*args, **kwargs):
3170 """ResumePropagation(self, int propagationLevel)"""
3171 return _core_.Event_ResumePropagation(*args, **kwargs)
3172
3173 def Clone(*args, **kwargs):
3174 """Clone(self) -> Event"""
3175 return _core_.Event_Clone(*args, **kwargs)
3176
3177
3178class EventPtr(Event):
3179 def __init__(self, this):
3180 self.this = this
3181 if not hasattr(self,"thisown"): self.thisown = 0
3182 self.__class__ = Event
3183_core_.Event_swigregister(EventPtr)
3184
3185#---------------------------------------------------------------------------
3186
3187class PropagationDisabler(object):
3188 def __repr__(self):
3189 return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3190 def __init__(self, *args, **kwargs):
3191 """__init__(self, Event event) -> PropagationDisabler"""
3192 newobj = _core_.new_PropagationDisabler(*args, **kwargs)
3193 self.this = newobj.this
3194 self.thisown = 1
3195 del newobj.thisown
3196 def __del__(self, destroy=_core_.delete_PropagationDisabler):
3197 """__del__(self)"""
3198 try:
3199 if self.thisown: destroy(self)
3200 except: pass
3201
3202
3203class PropagationDisablerPtr(PropagationDisabler):
3204 def __init__(self, this):
3205 self.this = this
3206 if not hasattr(self,"thisown"): self.thisown = 0
3207 self.__class__ = PropagationDisabler
3208_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
3209
3210class PropagateOnce(object):
3211 def __repr__(self):
3212 return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3213 def __init__(self, *args, **kwargs):
3214 """__init__(self, Event event) -> PropagateOnce"""
3215 newobj = _core_.new_PropagateOnce(*args, **kwargs)
3216 self.this = newobj.this
3217 self.thisown = 1
3218 del newobj.thisown
3219 def __del__(self, destroy=_core_.delete_PropagateOnce):
3220 """__del__(self)"""
3221 try:
3222 if self.thisown: destroy(self)
3223 except: pass
3224
3225
3226class PropagateOncePtr(PropagateOnce):
3227 def __init__(self, this):
3228 self.this = this
3229 if not hasattr(self,"thisown"): self.thisown = 0
3230 self.__class__ = PropagateOnce
3231_core_.PropagateOnce_swigregister(PropagateOncePtr)
3232
3233#---------------------------------------------------------------------------
3234
3235class CommandEvent(Event):
3236 def __repr__(self):
3237 return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3238 def __init__(self, *args, **kwargs):
3239 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
3240 newobj = _core_.new_CommandEvent(*args, **kwargs)
3241 self.this = newobj.this
3242 self.thisown = 1
3243 del newobj.thisown
3244 def GetSelection(*args, **kwargs):
3245 """GetSelection(self) -> int"""
3246 return _core_.CommandEvent_GetSelection(*args, **kwargs)
3247
3248 def SetString(*args, **kwargs):
3249 """SetString(self, String s)"""
3250 return _core_.CommandEvent_SetString(*args, **kwargs)
3251
3252 def GetString(*args, **kwargs):
3253 """GetString(self) -> String"""
3254 return _core_.CommandEvent_GetString(*args, **kwargs)
3255
3256 def IsChecked(*args, **kwargs):
3257 """IsChecked(self) -> bool"""
3258 return _core_.CommandEvent_IsChecked(*args, **kwargs)
3259
3260 Checked = IsChecked
3261 def IsSelection(*args, **kwargs):
3262 """IsSelection(self) -> bool"""
3263 return _core_.CommandEvent_IsSelection(*args, **kwargs)
3264
3265 def SetExtraLong(*args, **kwargs):
3266 """SetExtraLong(self, long extraLong)"""
3267 return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
3268
3269 def GetExtraLong(*args, **kwargs):
3270 """GetExtraLong(self) -> long"""
3271 return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
3272
3273 def SetInt(*args, **kwargs):
3274 """SetInt(self, int i)"""
3275 return _core_.CommandEvent_SetInt(*args, **kwargs)
3276
3277 def GetInt(*args, **kwargs):
3278 """GetInt(self) -> long"""
3279 return _core_.CommandEvent_GetInt(*args, **kwargs)
3280
3281 def Clone(*args, **kwargs):
3282 """Clone(self) -> Event"""
3283 return _core_.CommandEvent_Clone(*args, **kwargs)
3284
3285
3286class CommandEventPtr(CommandEvent):
3287 def __init__(self, this):
3288 self.this = this
3289 if not hasattr(self,"thisown"): self.thisown = 0
3290 self.__class__ = CommandEvent
3291_core_.CommandEvent_swigregister(CommandEventPtr)
3292
3293#---------------------------------------------------------------------------
3294
3295class NotifyEvent(CommandEvent):
3296 def __repr__(self):
3297 return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3298 def __init__(self, *args, **kwargs):
3299 """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
3300 newobj = _core_.new_NotifyEvent(*args, **kwargs)
3301 self.this = newobj.this
3302 self.thisown = 1
3303 del newobj.thisown
3304 def Veto(*args, **kwargs):
3305 """Veto(self)"""
3306 return _core_.NotifyEvent_Veto(*args, **kwargs)
3307
3308 def Allow(*args, **kwargs):
3309 """Allow(self)"""
3310 return _core_.NotifyEvent_Allow(*args, **kwargs)
3311
3312 def IsAllowed(*args, **kwargs):
3313 """IsAllowed(self) -> bool"""
3314 return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
3315
3316
3317class NotifyEventPtr(NotifyEvent):
3318 def __init__(self, this):
3319 self.this = this
3320 if not hasattr(self,"thisown"): self.thisown = 0
3321 self.__class__ = NotifyEvent
3322_core_.NotifyEvent_swigregister(NotifyEventPtr)
3323
3324#---------------------------------------------------------------------------
3325
3326class ScrollEvent(CommandEvent):
3327 def __repr__(self):
3328 return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3329 def __init__(self, *args, **kwargs):
3330 """
3331 __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
3332 int orient=0) -> ScrollEvent
3333 """
3334 newobj = _core_.new_ScrollEvent(*args, **kwargs)
3335 self.this = newobj.this
3336 self.thisown = 1
3337 del newobj.thisown
3338 def GetOrientation(*args, **kwargs):
3339 """GetOrientation(self) -> int"""
3340 return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
3341
3342 def GetPosition(*args, **kwargs):
3343 """GetPosition(self) -> int"""
3344 return _core_.ScrollEvent_GetPosition(*args, **kwargs)
3345
3346 def SetOrientation(*args, **kwargs):
3347 """SetOrientation(self, int orient)"""
3348 return _core_.ScrollEvent_SetOrientation(*args, **kwargs)
3349
3350 def SetPosition(*args, **kwargs):
3351 """SetPosition(self, int pos)"""
3352 return _core_.ScrollEvent_SetPosition(*args, **kwargs)
3353
3354
3355class ScrollEventPtr(ScrollEvent):
3356 def __init__(self, this):
3357 self.this = this
3358 if not hasattr(self,"thisown"): self.thisown = 0
3359 self.__class__ = ScrollEvent
3360_core_.ScrollEvent_swigregister(ScrollEventPtr)
3361
3362#---------------------------------------------------------------------------
3363
3364class ScrollWinEvent(Event):
3365 def __repr__(self):
3366 return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3367 def __init__(self, *args, **kwargs):
3368 """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
3369 newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
3370 self.this = newobj.this
3371 self.thisown = 1
3372 del newobj.thisown
3373 def GetOrientation(*args, **kwargs):
3374 """GetOrientation(self) -> int"""
3375 return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
3376
3377 def GetPosition(*args, **kwargs):
3378 """GetPosition(self) -> int"""
3379 return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
3380
3381 def SetOrientation(*args, **kwargs):
3382 """SetOrientation(self, int orient)"""
3383 return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs)
3384
3385 def SetPosition(*args, **kwargs):
3386 """SetPosition(self, int pos)"""
3387 return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
3388
3389
3390class ScrollWinEventPtr(ScrollWinEvent):
3391 def __init__(self, this):
3392 self.this = this
3393 if not hasattr(self,"thisown"): self.thisown = 0
3394 self.__class__ = ScrollWinEvent
3395_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
3396
3397#---------------------------------------------------------------------------
3398
3399MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY
3400MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE
3401MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT
3402MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
3403MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
3404class MouseEvent(Event):
3405 def __repr__(self):
3406 return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3407 def __init__(self, *args, **kwargs):
3408 """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
3409 newobj = _core_.new_MouseEvent(*args, **kwargs)
3410 self.this = newobj.this
3411 self.thisown = 1
3412 del newobj.thisown
3413 def IsButton(*args, **kwargs):
3414 """IsButton(self) -> bool"""
3415 return _core_.MouseEvent_IsButton(*args, **kwargs)
3416
3417 def ButtonDown(*args, **kwargs):
3418 """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
3419 return _core_.MouseEvent_ButtonDown(*args, **kwargs)
3420
3421 def ButtonDClick(*args, **kwargs):
3422 """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
3423 return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
3424
3425 def ButtonUp(*args, **kwargs):
3426 """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
3427 return _core_.MouseEvent_ButtonUp(*args, **kwargs)
3428
3429 def Button(*args, **kwargs):
3430 """Button(self, int but) -> bool"""
3431 return _core_.MouseEvent_Button(*args, **kwargs)
3432
3433 def ButtonIsDown(*args, **kwargs):
3434 """ButtonIsDown(self, int but) -> bool"""
3435 return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
3436
3437 def GetButton(*args, **kwargs):
3438 """GetButton(self) -> int"""
3439 return _core_.MouseEvent_GetButton(*args, **kwargs)
3440
3441 def ControlDown(*args, **kwargs):
3442 """ControlDown(self) -> bool"""
3443 return _core_.MouseEvent_ControlDown(*args, **kwargs)
3444
3445 def MetaDown(*args, **kwargs):
3446 """MetaDown(self) -> bool"""
3447 return _core_.MouseEvent_MetaDown(*args, **kwargs)
3448
3449 def AltDown(*args, **kwargs):
3450 """AltDown(self) -> bool"""
3451 return _core_.MouseEvent_AltDown(*args, **kwargs)
3452
3453 def ShiftDown(*args, **kwargs):
3454 """ShiftDown(self) -> bool"""
3455 return _core_.MouseEvent_ShiftDown(*args, **kwargs)
3456
412d302d
RD
3457 def CmdDown(*args, **kwargs):
3458 """
3459 CmdDown(self) -> bool
3460
3461 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3462 platforms but the special "Apple" (a.k.a as "Command") key on
3463 Macs: it makes often sense to use it instead of, say, `ControlDown`
3464 because Cmd key is used for the same thing under Mac as Ctrl
3465 elsewhere. The Ctrl still exists, it's just not used for this
3466 purpose. So for non-Mac platforms this is the same as `ControlDown`
3467 and Macs this is the same as `MetaDown`.
3468 """
3469 return _core_.MouseEvent_CmdDown(*args, **kwargs)
3470
d55e5bfc
RD
3471 def LeftDown(*args, **kwargs):
3472 """LeftDown(self) -> bool"""
3473 return _core_.MouseEvent_LeftDown(*args, **kwargs)
3474
3475 def MiddleDown(*args, **kwargs):
3476 """MiddleDown(self) -> bool"""
3477 return _core_.MouseEvent_MiddleDown(*args, **kwargs)
3478
3479 def RightDown(*args, **kwargs):
3480 """RightDown(self) -> bool"""
3481 return _core_.MouseEvent_RightDown(*args, **kwargs)
3482
3483 def LeftUp(*args, **kwargs):
3484 """LeftUp(self) -> bool"""
3485 return _core_.MouseEvent_LeftUp(*args, **kwargs)
3486
3487 def MiddleUp(*args, **kwargs):
3488 """MiddleUp(self) -> bool"""
3489 return _core_.MouseEvent_MiddleUp(*args, **kwargs)
3490
3491 def RightUp(*args, **kwargs):
3492 """RightUp(self) -> bool"""
3493 return _core_.MouseEvent_RightUp(*args, **kwargs)
3494
3495 def LeftDClick(*args, **kwargs):
3496 """LeftDClick(self) -> bool"""
3497 return _core_.MouseEvent_LeftDClick(*args, **kwargs)
3498
3499 def MiddleDClick(*args, **kwargs):
3500 """MiddleDClick(self) -> bool"""
3501 return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
3502
3503 def RightDClick(*args, **kwargs):
3504 """RightDClick(self) -> bool"""
3505 return _core_.MouseEvent_RightDClick(*args, **kwargs)
3506
3507 def LeftIsDown(*args, **kwargs):
3508 """LeftIsDown(self) -> bool"""
3509 return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
3510
3511 def MiddleIsDown(*args, **kwargs):
3512 """MiddleIsDown(self) -> bool"""
3513 return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
3514
3515 def RightIsDown(*args, **kwargs):
3516 """RightIsDown(self) -> bool"""
3517 return _core_.MouseEvent_RightIsDown(*args, **kwargs)
3518
3519 def Dragging(*args, **kwargs):
3520 """Dragging(self) -> bool"""
3521 return _core_.MouseEvent_Dragging(*args, **kwargs)
3522
3523 def Moving(*args, **kwargs):
3524 """Moving(self) -> bool"""
3525 return _core_.MouseEvent_Moving(*args, **kwargs)
3526
3527 def Entering(*args, **kwargs):
3528 """Entering(self) -> bool"""
3529 return _core_.MouseEvent_Entering(*args, **kwargs)
3530
3531 def Leaving(*args, **kwargs):
3532 """Leaving(self) -> bool"""
3533 return _core_.MouseEvent_Leaving(*args, **kwargs)
3534
3535 def GetPosition(*args, **kwargs):
3536 """
3537 GetPosition(self) -> Point
3538
79fccf9d
RD
3539 Returns the position of the mouse in window coordinates when the event
3540 happened.
d55e5bfc
RD
3541 """
3542 return _core_.MouseEvent_GetPosition(*args, **kwargs)
3543
3544 def GetPositionTuple(*args, **kwargs):
3545 """
3546 GetPositionTuple() -> (x,y)
3547
79fccf9d
RD
3548 Returns the position of the mouse in window coordinates when the event
3549 happened.
d55e5bfc
RD
3550 """
3551 return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
3552
3553 def GetLogicalPosition(*args, **kwargs):
3554 """GetLogicalPosition(self, DC dc) -> Point"""
3555 return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
3556
3557 def GetX(*args, **kwargs):
3558 """GetX(self) -> int"""
3559 return _core_.MouseEvent_GetX(*args, **kwargs)
3560
3561 def GetY(*args, **kwargs):
3562 """GetY(self) -> int"""
3563 return _core_.MouseEvent_GetY(*args, **kwargs)
3564
3565 def GetWheelRotation(*args, **kwargs):
3566 """GetWheelRotation(self) -> int"""
3567 return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
3568
3569 def GetWheelDelta(*args, **kwargs):
3570 """GetWheelDelta(self) -> int"""
3571 return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
3572
3573 def GetLinesPerAction(*args, **kwargs):
3574 """GetLinesPerAction(self) -> int"""
3575 return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
3576
3577 def IsPageScroll(*args, **kwargs):
3578 """IsPageScroll(self) -> bool"""
3579 return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
3580
3581 m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
3582 m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set)
3583 m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set)
3584 m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set)
3585 m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set)
3586 m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set)
3587 m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set)
3588 m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set)
3589 m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set)
3590 m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
3591 m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
3592 m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
3593
3594class MouseEventPtr(MouseEvent):
3595 def __init__(self, this):
3596 self.this = this
3597 if not hasattr(self,"thisown"): self.thisown = 0
3598 self.__class__ = MouseEvent
3599_core_.MouseEvent_swigregister(MouseEventPtr)
3600
3601#---------------------------------------------------------------------------
3602
3603class SetCursorEvent(Event):
3604 def __repr__(self):
3605 return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3606 def __init__(self, *args, **kwargs):
3607 """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
3608 newobj = _core_.new_SetCursorEvent(*args, **kwargs)
3609 self.this = newobj.this
3610 self.thisown = 1
3611 del newobj.thisown
3612 def GetX(*args, **kwargs):
3613 """GetX(self) -> int"""
3614 return _core_.SetCursorEvent_GetX(*args, **kwargs)
3615
3616 def GetY(*args, **kwargs):
3617 """GetY(self) -> int"""
3618 return _core_.SetCursorEvent_GetY(*args, **kwargs)
3619
3620 def SetCursor(*args, **kwargs):
3621 """SetCursor(self, Cursor cursor)"""
3622 return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
3623
3624 def GetCursor(*args, **kwargs):
3625 """GetCursor(self) -> Cursor"""
3626 return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
3627
3628 def HasCursor(*args, **kwargs):
3629 """HasCursor(self) -> bool"""
3630 return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
3631
3632
3633class SetCursorEventPtr(SetCursorEvent):
3634 def __init__(self, this):
3635 self.this = this
3636 if not hasattr(self,"thisown"): self.thisown = 0
3637 self.__class__ = SetCursorEvent
3638_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
3639
3640#---------------------------------------------------------------------------
3641
3642class KeyEvent(Event):
3643 def __repr__(self):
3644 return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3645 def __init__(self, *args, **kwargs):
3646 """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
3647 newobj = _core_.new_KeyEvent(*args, **kwargs)
3648 self.this = newobj.this
3649 self.thisown = 1
3650 del newobj.thisown
3651 def ControlDown(*args, **kwargs):
3652 """ControlDown(self) -> bool"""
3653 return _core_.KeyEvent_ControlDown(*args, **kwargs)
3654
3655 def MetaDown(*args, **kwargs):
3656 """MetaDown(self) -> bool"""
3657 return _core_.KeyEvent_MetaDown(*args, **kwargs)
3658
3659 def AltDown(*args, **kwargs):
3660 """AltDown(self) -> bool"""
3661 return _core_.KeyEvent_AltDown(*args, **kwargs)
3662
3663 def ShiftDown(*args, **kwargs):
3664 """ShiftDown(self) -> bool"""
3665 return _core_.KeyEvent_ShiftDown(*args, **kwargs)
3666
412d302d
RD
3667 def CmdDown(*args, **kwargs):
3668 """
3669 CmdDown(self) -> bool
3670
3671 "Cmd" is a pseudo key which is the same as Control for PC and Unix
3672 platforms but the special "Apple" (a.k.a as "Command") key on
3673 Macs: it makes often sense to use it instead of, say, `ControlDown`
3674 because Cmd key is used for the same thing under Mac as Ctrl
3675 elsewhere. The Ctrl still exists, it's just not used for this
3676 purpose. So for non-Mac platforms this is the same as `ControlDown`
3677 and Macs this is the same as `MetaDown`.
3678 """
3679 return _core_.KeyEvent_CmdDown(*args, **kwargs)
3680
d55e5bfc
RD
3681 def HasModifiers(*args, **kwargs):
3682 """HasModifiers(self) -> bool"""
3683 return _core_.KeyEvent_HasModifiers(*args, **kwargs)
3684
3685 def GetKeyCode(*args, **kwargs):
3686 """GetKeyCode(self) -> int"""
3687 return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
3688
3689 KeyCode = GetKeyCode
19272049
RD
3690 def GetUnicodeKey(*args, **kwargs):
3691 """GetUnicodeKey(self) -> int"""
3692 return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
d55e5bfc 3693
19272049 3694 GetUniChar = GetUnicodeKey
d55e5bfc
RD
3695 def GetRawKeyCode(*args, **kwargs):
3696 """GetRawKeyCode(self) -> unsigned int"""
3697 return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
3698
3699 def GetRawKeyFlags(*args, **kwargs):
3700 """GetRawKeyFlags(self) -> unsigned int"""
3701 return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
3702
3703 def GetPosition(*args, **kwargs):
3704 """
3705 GetPosition(self) -> Point
3706
3707 Find the position of the event.
3708 """
3709 return _core_.KeyEvent_GetPosition(*args, **kwargs)
3710
3711 def GetPositionTuple(*args, **kwargs):
3712 """
3713 GetPositionTuple() -> (x,y)
3714
3715 Find the position of the event.
3716 """
3717 return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
3718
3719 def GetX(*args, **kwargs):
3720 """GetX(self) -> int"""
3721 return _core_.KeyEvent_GetX(*args, **kwargs)
3722
3723 def GetY(*args, **kwargs):
3724 """GetY(self) -> int"""
3725 return _core_.KeyEvent_GetY(*args, **kwargs)
3726
3727 m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
3728 m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set)
3729 m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set)
3730 m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set)
3731 m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set)
3732 m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set)
3733 m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set)
3734 m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
3735 m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
3736 m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
3737
3738class KeyEventPtr(KeyEvent):
3739 def __init__(self, this):
3740 self.this = this
3741 if not hasattr(self,"thisown"): self.thisown = 0
3742 self.__class__ = KeyEvent
3743_core_.KeyEvent_swigregister(KeyEventPtr)
3744
3745#---------------------------------------------------------------------------
3746
3747class SizeEvent(Event):
3748 def __repr__(self):
3749 return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3750 def __init__(self, *args, **kwargs):
3751 """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
3752 newobj = _core_.new_SizeEvent(*args, **kwargs)
3753 self.this = newobj.this
3754 self.thisown = 1
3755 del newobj.thisown
3756 def GetSize(*args, **kwargs):
3757 """GetSize(self) -> Size"""
3758 return _core_.SizeEvent_GetSize(*args, **kwargs)
3759
3760 def GetRect(*args, **kwargs):
3761 """GetRect(self) -> Rect"""
3762 return _core_.SizeEvent_GetRect(*args, **kwargs)
3763
3764 def SetRect(*args, **kwargs):
3765 """SetRect(self, Rect rect)"""
3766 return _core_.SizeEvent_SetRect(*args, **kwargs)
3767
3768 def SetSize(*args, **kwargs):
3769 """SetSize(self, Size size)"""
3770 return _core_.SizeEvent_SetSize(*args, **kwargs)
3771
3772 m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
3773 m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
3774
3775class SizeEventPtr(SizeEvent):
3776 def __init__(self, this):
3777 self.this = this
3778 if not hasattr(self,"thisown"): self.thisown = 0
3779 self.__class__ = SizeEvent
3780_core_.SizeEvent_swigregister(SizeEventPtr)
3781
3782#---------------------------------------------------------------------------
3783
3784class MoveEvent(Event):
3785 def __repr__(self):
3786 return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3787 def __init__(self, *args, **kwargs):
3788 """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
3789 newobj = _core_.new_MoveEvent(*args, **kwargs)
3790 self.this = newobj.this
3791 self.thisown = 1
3792 del newobj.thisown
3793 def GetPosition(*args, **kwargs):
3794 """GetPosition(self) -> Point"""
3795 return _core_.MoveEvent_GetPosition(*args, **kwargs)
3796
3797 def GetRect(*args, **kwargs):
3798 """GetRect(self) -> Rect"""
3799 return _core_.MoveEvent_GetRect(*args, **kwargs)
3800
3801 def SetRect(*args, **kwargs):
3802 """SetRect(self, Rect rect)"""
3803 return _core_.MoveEvent_SetRect(*args, **kwargs)
3804
3805 def SetPosition(*args, **kwargs):
3806 """SetPosition(self, Point pos)"""
3807 return _core_.MoveEvent_SetPosition(*args, **kwargs)
3808
3809 m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
3810 m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
3811
3812class MoveEventPtr(MoveEvent):
3813 def __init__(self, this):
3814 self.this = this
3815 if not hasattr(self,"thisown"): self.thisown = 0
3816 self.__class__ = MoveEvent
3817_core_.MoveEvent_swigregister(MoveEventPtr)
3818
3819#---------------------------------------------------------------------------
3820
3821class PaintEvent(Event):
3822 def __repr__(self):
3823 return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3824 def __init__(self, *args, **kwargs):
3825 """__init__(self, int Id=0) -> PaintEvent"""
3826 newobj = _core_.new_PaintEvent(*args, **kwargs)
3827 self.this = newobj.this
3828 self.thisown = 1
3829 del newobj.thisown
3830
3831class PaintEventPtr(PaintEvent):
3832 def __init__(self, this):
3833 self.this = this
3834 if not hasattr(self,"thisown"): self.thisown = 0
3835 self.__class__ = PaintEvent
3836_core_.PaintEvent_swigregister(PaintEventPtr)
3837
3838class NcPaintEvent(Event):
3839 def __repr__(self):
3840 return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3841 def __init__(self, *args, **kwargs):
3842 """__init__(self, int winid=0) -> NcPaintEvent"""
3843 newobj = _core_.new_NcPaintEvent(*args, **kwargs)
3844 self.this = newobj.this
3845 self.thisown = 1
3846 del newobj.thisown
3847
3848class NcPaintEventPtr(NcPaintEvent):
3849 def __init__(self, this):
3850 self.this = this
3851 if not hasattr(self,"thisown"): self.thisown = 0
3852 self.__class__ = NcPaintEvent
3853_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
3854
3855#---------------------------------------------------------------------------
3856
3857class EraseEvent(Event):
3858 def __repr__(self):
3859 return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3860 def __init__(self, *args, **kwargs):
3861 """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
3862 newobj = _core_.new_EraseEvent(*args, **kwargs)
3863 self.this = newobj.this
3864 self.thisown = 1
3865 del newobj.thisown
3866 def GetDC(*args, **kwargs):
3867 """GetDC(self) -> DC"""
3868 return _core_.EraseEvent_GetDC(*args, **kwargs)
3869
3870
3871class EraseEventPtr(EraseEvent):
3872 def __init__(self, this):
3873 self.this = this
3874 if not hasattr(self,"thisown"): self.thisown = 0
3875 self.__class__ = EraseEvent
3876_core_.EraseEvent_swigregister(EraseEventPtr)
3877
3878#---------------------------------------------------------------------------
3879
3880class FocusEvent(Event):
3881 def __repr__(self):
3882 return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3883 def __init__(self, *args, **kwargs):
3884 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
3885 newobj = _core_.new_FocusEvent(*args, **kwargs)
3886 self.this = newobj.this
3887 self.thisown = 1
3888 del newobj.thisown
3889 def GetWindow(*args, **kwargs):
3890 """GetWindow(self) -> Window"""
3891 return _core_.FocusEvent_GetWindow(*args, **kwargs)
3892
3893 def SetWindow(*args, **kwargs):
3894 """SetWindow(self, Window win)"""
3895 return _core_.FocusEvent_SetWindow(*args, **kwargs)
3896
3897
3898class FocusEventPtr(FocusEvent):
3899 def __init__(self, this):
3900 self.this = this
3901 if not hasattr(self,"thisown"): self.thisown = 0
3902 self.__class__ = FocusEvent
3903_core_.FocusEvent_swigregister(FocusEventPtr)
3904
3905#---------------------------------------------------------------------------
3906
3907class ChildFocusEvent(CommandEvent):
3908 def __repr__(self):
3909 return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3910 def __init__(self, *args, **kwargs):
3911 """__init__(self, Window win=None) -> ChildFocusEvent"""
3912 newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
3913 self.this = newobj.this
3914 self.thisown = 1
3915 del newobj.thisown
3916 def GetWindow(*args, **kwargs):
3917 """GetWindow(self) -> Window"""
3918 return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
3919
3920
3921class ChildFocusEventPtr(ChildFocusEvent):
3922 def __init__(self, this):
3923 self.this = this
3924 if not hasattr(self,"thisown"): self.thisown = 0
3925 self.__class__ = ChildFocusEvent
3926_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
3927
3928#---------------------------------------------------------------------------
3929
3930class ActivateEvent(Event):
3931 def __repr__(self):
3932 return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3933 def __init__(self, *args, **kwargs):
3934 """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
3935 newobj = _core_.new_ActivateEvent(*args, **kwargs)
3936 self.this = newobj.this
3937 self.thisown = 1
3938 del newobj.thisown
3939 def GetActive(*args, **kwargs):
3940 """GetActive(self) -> bool"""
3941 return _core_.ActivateEvent_GetActive(*args, **kwargs)
3942
3943
3944class ActivateEventPtr(ActivateEvent):
3945 def __init__(self, this):
3946 self.this = this
3947 if not hasattr(self,"thisown"): self.thisown = 0
3948 self.__class__ = ActivateEvent
3949_core_.ActivateEvent_swigregister(ActivateEventPtr)
3950
3951#---------------------------------------------------------------------------
3952
3953class InitDialogEvent(Event):
3954 def __repr__(self):
3955 return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3956 def __init__(self, *args, **kwargs):
3957 """__init__(self, int Id=0) -> InitDialogEvent"""
3958 newobj = _core_.new_InitDialogEvent(*args, **kwargs)
3959 self.this = newobj.this
3960 self.thisown = 1
3961 del newobj.thisown
3962
3963class InitDialogEventPtr(InitDialogEvent):
3964 def __init__(self, this):
3965 self.this = this
3966 if not hasattr(self,"thisown"): self.thisown = 0
3967 self.__class__ = InitDialogEvent
3968_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
3969
3970#---------------------------------------------------------------------------
3971
3972class MenuEvent(Event):
3973 def __repr__(self):
3974 return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3975 def __init__(self, *args, **kwargs):
3976 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
3977 newobj = _core_.new_MenuEvent(*args, **kwargs)
3978 self.this = newobj.this
3979 self.thisown = 1
3980 del newobj.thisown
3981 def GetMenuId(*args, **kwargs):
3982 """GetMenuId(self) -> int"""
3983 return _core_.MenuEvent_GetMenuId(*args, **kwargs)
3984
3985 def IsPopup(*args, **kwargs):
3986 """IsPopup(self) -> bool"""
3987 return _core_.MenuEvent_IsPopup(*args, **kwargs)
3988
3989 def GetMenu(*args, **kwargs):
3990 """GetMenu(self) -> Menu"""
3991 return _core_.MenuEvent_GetMenu(*args, **kwargs)
3992
3993
3994class MenuEventPtr(MenuEvent):
3995 def __init__(self, this):
3996 self.this = this
3997 if not hasattr(self,"thisown"): self.thisown = 0
3998 self.__class__ = MenuEvent
3999_core_.MenuEvent_swigregister(MenuEventPtr)
4000
4001#---------------------------------------------------------------------------
4002
4003class CloseEvent(Event):
4004 def __repr__(self):
4005 return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4006 def __init__(self, *args, **kwargs):
4007 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
4008 newobj = _core_.new_CloseEvent(*args, **kwargs)
4009 self.this = newobj.this
4010 self.thisown = 1
4011 del newobj.thisown
4012 def SetLoggingOff(*args, **kwargs):
4013 """SetLoggingOff(self, bool logOff)"""
4014 return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
4015
4016 def GetLoggingOff(*args, **kwargs):
4017 """GetLoggingOff(self) -> bool"""
4018 return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
4019
4020 def Veto(*args, **kwargs):
4021 """Veto(self, bool veto=True)"""
4022 return _core_.CloseEvent_Veto(*args, **kwargs)
4023
4024 def SetCanVeto(*args, **kwargs):
4025 """SetCanVeto(self, bool canVeto)"""
4026 return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
4027
4028 def CanVeto(*args, **kwargs):
4029 """CanVeto(self) -> bool"""
4030 return _core_.CloseEvent_CanVeto(*args, **kwargs)
4031
4032 def GetVeto(*args, **kwargs):
4033 """GetVeto(self) -> bool"""
4034 return _core_.CloseEvent_GetVeto(*args, **kwargs)
4035
4036
4037class CloseEventPtr(CloseEvent):
4038 def __init__(self, this):
4039 self.this = this
4040 if not hasattr(self,"thisown"): self.thisown = 0
4041 self.__class__ = CloseEvent
4042_core_.CloseEvent_swigregister(CloseEventPtr)
4043
4044#---------------------------------------------------------------------------
4045
4046class ShowEvent(Event):
4047 def __repr__(self):
4048 return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4049 def __init__(self, *args, **kwargs):
4050 """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
4051 newobj = _core_.new_ShowEvent(*args, **kwargs)
4052 self.this = newobj.this
4053 self.thisown = 1
4054 del newobj.thisown
4055 def SetShow(*args, **kwargs):
4056 """SetShow(self, bool show)"""
4057 return _core_.ShowEvent_SetShow(*args, **kwargs)
4058
4059 def GetShow(*args, **kwargs):
4060 """GetShow(self) -> bool"""
4061 return _core_.ShowEvent_GetShow(*args, **kwargs)
4062
4063
4064class ShowEventPtr(ShowEvent):
4065 def __init__(self, this):
4066 self.this = this
4067 if not hasattr(self,"thisown"): self.thisown = 0
4068 self.__class__ = ShowEvent
4069_core_.ShowEvent_swigregister(ShowEventPtr)
4070
4071#---------------------------------------------------------------------------
4072
4073class IconizeEvent(Event):
4074 def __repr__(self):
4075 return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4076 def __init__(self, *args, **kwargs):
4077 """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
4078 newobj = _core_.new_IconizeEvent(*args, **kwargs)
4079 self.this = newobj.this
4080 self.thisown = 1
4081 del newobj.thisown
4082 def Iconized(*args, **kwargs):
4083 """Iconized(self) -> bool"""
4084 return _core_.IconizeEvent_Iconized(*args, **kwargs)
4085
4086
4087class IconizeEventPtr(IconizeEvent):
4088 def __init__(self, this):
4089 self.this = this
4090 if not hasattr(self,"thisown"): self.thisown = 0
4091 self.__class__ = IconizeEvent
4092_core_.IconizeEvent_swigregister(IconizeEventPtr)
4093
4094#---------------------------------------------------------------------------
4095
4096class MaximizeEvent(Event):
4097 def __repr__(self):
4098 return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4099 def __init__(self, *args, **kwargs):
4100 """__init__(self, int id=0) -> MaximizeEvent"""
4101 newobj = _core_.new_MaximizeEvent(*args, **kwargs)
4102 self.this = newobj.this
4103 self.thisown = 1
4104 del newobj.thisown
4105
4106class MaximizeEventPtr(MaximizeEvent):
4107 def __init__(self, this):
4108 self.this = this
4109 if not hasattr(self,"thisown"): self.thisown = 0
4110 self.__class__ = MaximizeEvent
4111_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
4112
4113#---------------------------------------------------------------------------
4114
4115class DropFilesEvent(Event):
4116 def __init__(self): raise RuntimeError, "No constructor defined"
4117 def __repr__(self):
4118 return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4119 def GetPosition(*args, **kwargs):
4120 """GetPosition(self) -> Point"""
4121 return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
4122
4123 def GetNumberOfFiles(*args, **kwargs):
4124 """GetNumberOfFiles(self) -> int"""
4125 return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
4126
4127 def GetFiles(*args, **kwargs):
4128 """GetFiles(self) -> PyObject"""
4129 return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
4130
4131
4132class DropFilesEventPtr(DropFilesEvent):
4133 def __init__(self, this):
4134 self.this = this
4135 if not hasattr(self,"thisown"): self.thisown = 0
4136 self.__class__ = DropFilesEvent
4137_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
4138
4139#---------------------------------------------------------------------------
4140
4141UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
4142UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
4143class UpdateUIEvent(CommandEvent):
4144 def __repr__(self):
4145 return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4146 def __init__(self, *args, **kwargs):
4147 """__init__(self, int commandId=0) -> UpdateUIEvent"""
4148 newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
4149 self.this = newobj.this
4150 self.thisown = 1
4151 del newobj.thisown
4152 def GetChecked(*args, **kwargs):
4153 """GetChecked(self) -> bool"""
4154 return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
4155
4156 def GetEnabled(*args, **kwargs):
4157 """GetEnabled(self) -> bool"""
4158 return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
4159
4160 def GetText(*args, **kwargs):
4161 """GetText(self) -> String"""
4162 return _core_.UpdateUIEvent_GetText(*args, **kwargs)
4163
4164 def GetSetText(*args, **kwargs):
4165 """GetSetText(self) -> bool"""
4166 return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
4167
4168 def GetSetChecked(*args, **kwargs):
4169 """GetSetChecked(self) -> bool"""
4170 return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
4171
4172 def GetSetEnabled(*args, **kwargs):
4173 """GetSetEnabled(self) -> bool"""
4174 return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
4175
4176 def Check(*args, **kwargs):
4177 """Check(self, bool check)"""
4178 return _core_.UpdateUIEvent_Check(*args, **kwargs)
4179
4180 def Enable(*args, **kwargs):
4181 """Enable(self, bool enable)"""
4182 return _core_.UpdateUIEvent_Enable(*args, **kwargs)
4183
4184 def SetText(*args, **kwargs):
4185 """SetText(self, String text)"""
4186 return _core_.UpdateUIEvent_SetText(*args, **kwargs)
4187
4188 def SetUpdateInterval(*args, **kwargs):
c24da6d6 4189 """SetUpdateInterval(long updateInterval)"""
d55e5bfc
RD
4190 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4191
4192 SetUpdateInterval = staticmethod(SetUpdateInterval)
4193 def GetUpdateInterval(*args, **kwargs):
c24da6d6 4194 """GetUpdateInterval() -> long"""
d55e5bfc
RD
4195 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4196
4197 GetUpdateInterval = staticmethod(GetUpdateInterval)
4198 def CanUpdate(*args, **kwargs):
c24da6d6 4199 """CanUpdate(Window win) -> bool"""
d55e5bfc
RD
4200 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4201
4202 CanUpdate = staticmethod(CanUpdate)
4203 def ResetUpdateTime(*args, **kwargs):
c24da6d6 4204 """ResetUpdateTime()"""
d55e5bfc
RD
4205 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4206
4207 ResetUpdateTime = staticmethod(ResetUpdateTime)
4208 def SetMode(*args, **kwargs):
c24da6d6 4209 """SetMode(int mode)"""
d55e5bfc
RD
4210 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4211
4212 SetMode = staticmethod(SetMode)
4213 def GetMode(*args, **kwargs):
c24da6d6 4214 """GetMode() -> int"""
d55e5bfc
RD
4215 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4216
4217 GetMode = staticmethod(GetMode)
4218
4219class UpdateUIEventPtr(UpdateUIEvent):
4220 def __init__(self, this):
4221 self.this = this
4222 if not hasattr(self,"thisown"): self.thisown = 0
4223 self.__class__ = UpdateUIEvent
4224_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
4225
4226def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
4227 """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
4228 return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
4229
4230def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
4231 """UpdateUIEvent_GetUpdateInterval() -> long"""
4232 return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
4233
4234def UpdateUIEvent_CanUpdate(*args, **kwargs):
4235 """UpdateUIEvent_CanUpdate(Window win) -> bool"""
4236 return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
4237
4238def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
4239 """UpdateUIEvent_ResetUpdateTime()"""
4240 return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
4241
4242def UpdateUIEvent_SetMode(*args, **kwargs):
4243 """UpdateUIEvent_SetMode(int mode)"""
4244 return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
4245
4246def UpdateUIEvent_GetMode(*args, **kwargs):
4247 """UpdateUIEvent_GetMode() -> int"""
4248 return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
4249
4250#---------------------------------------------------------------------------
4251
4252class SysColourChangedEvent(Event):
4253 def __repr__(self):
4254 return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4255 def __init__(self, *args, **kwargs):
4256 """__init__(self) -> SysColourChangedEvent"""
4257 newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
4258 self.this = newobj.this
4259 self.thisown = 1
4260 del newobj.thisown
4261
4262class SysColourChangedEventPtr(SysColourChangedEvent):
4263 def __init__(self, this):
4264 self.this = this
4265 if not hasattr(self,"thisown"): self.thisown = 0
4266 self.__class__ = SysColourChangedEvent
4267_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
4268
4269#---------------------------------------------------------------------------
4270
4271class MouseCaptureChangedEvent(Event):
4272 def __repr__(self):
4273 return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4274 def __init__(self, *args, **kwargs):
4275 """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
4276 newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
4277 self.this = newobj.this
4278 self.thisown = 1
4279 del newobj.thisown
4280 def GetCapturedWindow(*args, **kwargs):
4281 """GetCapturedWindow(self) -> Window"""
4282 return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
4283
4284
4285class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
4286 def __init__(self, this):
4287 self.this = this
4288 if not hasattr(self,"thisown"): self.thisown = 0
4289 self.__class__ = MouseCaptureChangedEvent
4290_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
4291
4292#---------------------------------------------------------------------------
4293
4294class DisplayChangedEvent(Event):
4295 def __repr__(self):
4296 return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4297 def __init__(self, *args, **kwargs):
4298 """__init__(self) -> DisplayChangedEvent"""
4299 newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
4300 self.this = newobj.this
4301 self.thisown = 1
4302 del newobj.thisown
4303
4304class DisplayChangedEventPtr(DisplayChangedEvent):
4305 def __init__(self, this):
4306 self.this = this
4307 if not hasattr(self,"thisown"): self.thisown = 0
4308 self.__class__ = DisplayChangedEvent
4309_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
4310
4311#---------------------------------------------------------------------------
4312
4313class PaletteChangedEvent(Event):
4314 def __repr__(self):
4315 return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4316 def __init__(self, *args, **kwargs):
4317 """__init__(self, int id=0) -> PaletteChangedEvent"""
4318 newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
4319 self.this = newobj.this
4320 self.thisown = 1
4321 del newobj.thisown
4322 def SetChangedWindow(*args, **kwargs):
4323 """SetChangedWindow(self, Window win)"""
4324 return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
4325
4326 def GetChangedWindow(*args, **kwargs):
4327 """GetChangedWindow(self) -> Window"""
4328 return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
4329
4330
4331class PaletteChangedEventPtr(PaletteChangedEvent):
4332 def __init__(self, this):
4333 self.this = this
4334 if not hasattr(self,"thisown"): self.thisown = 0
4335 self.__class__ = PaletteChangedEvent
4336_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
4337
4338#---------------------------------------------------------------------------
4339
4340class QueryNewPaletteEvent(Event):
4341 def __repr__(self):
4342 return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4343 def __init__(self, *args, **kwargs):
4344 """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
4345 newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
4346 self.this = newobj.this
4347 self.thisown = 1
4348 del newobj.thisown
4349 def SetPaletteRealized(*args, **kwargs):
4350 """SetPaletteRealized(self, bool realized)"""
4351 return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
4352
4353 def GetPaletteRealized(*args, **kwargs):
4354 """GetPaletteRealized(self) -> bool"""
4355 return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
4356
4357
4358class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
4359 def __init__(self, this):
4360 self.this = this
4361 if not hasattr(self,"thisown"): self.thisown = 0
4362 self.__class__ = QueryNewPaletteEvent
4363_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
4364
4365#---------------------------------------------------------------------------
4366
4367class NavigationKeyEvent(Event):
4368 def __repr__(self):
4369 return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4370 def __init__(self, *args, **kwargs):
4371 """__init__(self) -> NavigationKeyEvent"""
4372 newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
4373 self.this = newobj.this
4374 self.thisown = 1
4375 del newobj.thisown
4376 def GetDirection(*args, **kwargs):
4377 """GetDirection(self) -> bool"""
4378 return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
4379
4380 def SetDirection(*args, **kwargs):
908b74cd 4381 """SetDirection(self, bool forward)"""
d55e5bfc
RD
4382 return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
4383
4384 def IsWindowChange(*args, **kwargs):
4385 """IsWindowChange(self) -> bool"""
4386 return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
4387
4388 def SetWindowChange(*args, **kwargs):
908b74cd 4389 """SetWindowChange(self, bool ischange)"""
d55e5bfc
RD
4390 return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
4391
908b74cd
RD
4392 def SetFlags(*args, **kwargs):
4393 """SetFlags(self, long flags)"""
4394 return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
4395
d55e5bfc
RD
4396 def GetCurrentFocus(*args, **kwargs):
4397 """GetCurrentFocus(self) -> Window"""
4398 return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
4399
4400 def SetCurrentFocus(*args, **kwargs):
4401 """SetCurrentFocus(self, Window win)"""
4402 return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
4403
b0f7404b 4404 IsBackward = _core_.NavigationKeyEvent_IsBackward
908b74cd
RD
4405 IsForward = _core_.NavigationKeyEvent_IsForward
4406 WinChange = _core_.NavigationKeyEvent_WinChange
d55e5bfc
RD
4407
4408class NavigationKeyEventPtr(NavigationKeyEvent):
4409 def __init__(self, this):
4410 self.this = this
4411 if not hasattr(self,"thisown"): self.thisown = 0
4412 self.__class__ = NavigationKeyEvent
4413_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
4414
4415#---------------------------------------------------------------------------
4416
4417class WindowCreateEvent(CommandEvent):
4418 def __repr__(self):
4419 return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4420 def __init__(self, *args, **kwargs):
4421 """__init__(self, Window win=None) -> WindowCreateEvent"""
4422 newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
4423 self.this = newobj.this
4424 self.thisown = 1
4425 del newobj.thisown
4426 def GetWindow(*args, **kwargs):
4427 """GetWindow(self) -> Window"""
4428 return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
4429
4430
4431class WindowCreateEventPtr(WindowCreateEvent):
4432 def __init__(self, this):
4433 self.this = this
4434 if not hasattr(self,"thisown"): self.thisown = 0
4435 self.__class__ = WindowCreateEvent
4436_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
4437
4438class WindowDestroyEvent(CommandEvent):
4439 def __repr__(self):
4440 return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4441 def __init__(self, *args, **kwargs):
4442 """__init__(self, Window win=None) -> WindowDestroyEvent"""
4443 newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
4444 self.this = newobj.this
4445 self.thisown = 1
4446 del newobj.thisown
4447 def GetWindow(*args, **kwargs):
4448 """GetWindow(self) -> Window"""
4449 return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
4450
4451
4452class WindowDestroyEventPtr(WindowDestroyEvent):
4453 def __init__(self, this):
4454 self.this = this
4455 if not hasattr(self,"thisown"): self.thisown = 0
4456 self.__class__ = WindowDestroyEvent
4457_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
4458
4459#---------------------------------------------------------------------------
4460
4461class ContextMenuEvent(CommandEvent):
4462 def __repr__(self):
4463 return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4464 def __init__(self, *args, **kwargs):
4465 """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
4466 newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
4467 self.this = newobj.this
4468 self.thisown = 1
4469 del newobj.thisown
4470 def GetPosition(*args, **kwargs):
4471 """GetPosition(self) -> Point"""
4472 return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
4473
4474 def SetPosition(*args, **kwargs):
4475 """SetPosition(self, Point pos)"""
4476 return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
4477
4478
4479class ContextMenuEventPtr(ContextMenuEvent):
4480 def __init__(self, this):
4481 self.this = this
4482 if not hasattr(self,"thisown"): self.thisown = 0
4483 self.__class__ = ContextMenuEvent
4484_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
4485
4486#---------------------------------------------------------------------------
4487
4488IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
4489IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
4490class IdleEvent(Event):
4491 def __repr__(self):
4492 return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4493 def __init__(self, *args, **kwargs):
4494 """__init__(self) -> IdleEvent"""
4495 newobj = _core_.new_IdleEvent(*args, **kwargs)
4496 self.this = newobj.this
4497 self.thisown = 1
4498 del newobj.thisown
4499 def RequestMore(*args, **kwargs):
4500 """RequestMore(self, bool needMore=True)"""
4501 return _core_.IdleEvent_RequestMore(*args, **kwargs)
4502
4503 def MoreRequested(*args, **kwargs):
4504 """MoreRequested(self) -> bool"""
4505 return _core_.IdleEvent_MoreRequested(*args, **kwargs)
4506
4507 def SetMode(*args, **kwargs):
c24da6d6 4508 """SetMode(int mode)"""
d55e5bfc
RD
4509 return _core_.IdleEvent_SetMode(*args, **kwargs)
4510
4511 SetMode = staticmethod(SetMode)
4512 def GetMode(*args, **kwargs):
c24da6d6 4513 """GetMode() -> int"""
d55e5bfc
RD
4514 return _core_.IdleEvent_GetMode(*args, **kwargs)
4515
4516 GetMode = staticmethod(GetMode)
4517 def CanSend(*args, **kwargs):
c24da6d6 4518 """CanSend(Window win) -> bool"""
d55e5bfc
RD
4519 return _core_.IdleEvent_CanSend(*args, **kwargs)
4520
4521 CanSend = staticmethod(CanSend)
4522
4523class IdleEventPtr(IdleEvent):
4524 def __init__(self, this):
4525 self.this = this
4526 if not hasattr(self,"thisown"): self.thisown = 0
4527 self.__class__ = IdleEvent
4528_core_.IdleEvent_swigregister(IdleEventPtr)
4529
4530def IdleEvent_SetMode(*args, **kwargs):
4531 """IdleEvent_SetMode(int mode)"""
4532 return _core_.IdleEvent_SetMode(*args, **kwargs)
4533
4534def IdleEvent_GetMode(*args, **kwargs):
4535 """IdleEvent_GetMode() -> int"""
4536 return _core_.IdleEvent_GetMode(*args, **kwargs)
4537
4538def IdleEvent_CanSend(*args, **kwargs):
4539 """IdleEvent_CanSend(Window win) -> bool"""
4540 return _core_.IdleEvent_CanSend(*args, **kwargs)
4541
4542#---------------------------------------------------------------------------
4543
4544class PyEvent(Event):
4545 def __repr__(self):
4546 return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4547 def __init__(self, *args, **kwargs):
4548 """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
4549 newobj = _core_.new_PyEvent(*args, **kwargs)
4550 self.this = newobj.this
4551 self.thisown = 1
4552 del newobj.thisown
4553 self.SetSelf(self)
4554
4555 def __del__(self, destroy=_core_.delete_PyEvent):
4556 """__del__(self)"""
4557 try:
4558 if self.thisown: destroy(self)
4559 except: pass
4560
4561 def SetSelf(*args, **kwargs):
4562 """SetSelf(self, PyObject self)"""
4563 return _core_.PyEvent_SetSelf(*args, **kwargs)
4564
4565 def GetSelf(*args, **kwargs):
4566 """GetSelf(self) -> PyObject"""
4567 return _core_.PyEvent_GetSelf(*args, **kwargs)
4568
4569
4570class PyEventPtr(PyEvent):
4571 def __init__(self, this):
4572 self.this = this
4573 if not hasattr(self,"thisown"): self.thisown = 0
4574 self.__class__ = PyEvent
4575_core_.PyEvent_swigregister(PyEventPtr)
4576
4577class PyCommandEvent(CommandEvent):
4578 def __repr__(self):
4579 return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4580 def __init__(self, *args, **kwargs):
4581 """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
4582 newobj = _core_.new_PyCommandEvent(*args, **kwargs)
4583 self.this = newobj.this
4584 self.thisown = 1
4585 del newobj.thisown
4586 self.SetSelf(self)
4587
4588 def __del__(self, destroy=_core_.delete_PyCommandEvent):
4589 """__del__(self)"""
4590 try:
4591 if self.thisown: destroy(self)
4592 except: pass
4593
4594 def SetSelf(*args, **kwargs):
4595 """SetSelf(self, PyObject self)"""
4596 return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
4597
4598 def GetSelf(*args, **kwargs):
4599 """GetSelf(self) -> PyObject"""
4600 return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
4601
4602
4603class PyCommandEventPtr(PyCommandEvent):
4604 def __init__(self, this):
4605 self.this = this
4606 if not hasattr(self,"thisown"): self.thisown = 0
4607 self.__class__ = PyCommandEvent
4608_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
4609
4610#---------------------------------------------------------------------------
4611
4612PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS
4613PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION
4614PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG
4615PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG
4616PRINT_WINDOWS = _core_.PRINT_WINDOWS
4617PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT
4618class PyApp(EvtHandler):
c24da6d6
RD
4619 """
4620 The ``wx.PyApp`` class is an *implementation detail*, please use the
4621 `wx.App` class (or some other derived class) instead.
4622 """
d55e5bfc
RD
4623 def __repr__(self):
4624 return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4625 def __init__(self, *args, **kwargs):
4626 """
4627 __init__(self) -> PyApp
4628
4629 Create a new application object, starting the bootstrap process.
4630 """
4631 newobj = _core_.new_PyApp(*args, **kwargs)
4632 self.this = newobj.this
4633 self.thisown = 1
4634 del newobj.thisown
4635 self._setCallbackInfo(self, PyApp)
4636 self._setOORInfo(self)
4637
4638 def __del__(self, destroy=_core_.delete_PyApp):
4639 """__del__(self)"""
4640 try:
4641 if self.thisown: destroy(self)
4642 except: pass
4643
4644 def _setCallbackInfo(*args, **kwargs):
4645 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4646 return _core_.PyApp__setCallbackInfo(*args, **kwargs)
4647
4648 def GetAppName(*args, **kwargs):
4649 """
4650 GetAppName(self) -> String
4651
4652 Get the application name.
4653 """
4654 return _core_.PyApp_GetAppName(*args, **kwargs)
4655
4656 def SetAppName(*args, **kwargs):
4657 """
4658 SetAppName(self, String name)
4659
c24da6d6
RD
4660 Set the application name. This value may be used automatically by
4661 `wx.Config` and such.
d55e5bfc
RD
4662 """
4663 return _core_.PyApp_SetAppName(*args, **kwargs)
4664
4665 def GetClassName(*args, **kwargs):
4666 """
4667 GetClassName(self) -> String
4668
4669 Get the application's class name.
4670 """
4671 return _core_.PyApp_GetClassName(*args, **kwargs)
4672
4673 def SetClassName(*args, **kwargs):
4674 """
4675 SetClassName(self, String name)
4676
c24da6d6
RD
4677 Set the application's class name. This value may be used for
4678 X-resources if applicable for the platform
d55e5bfc
RD
4679 """
4680 return _core_.PyApp_SetClassName(*args, **kwargs)
4681
4682 def GetVendorName(*args, **kwargs):
4683 """
4684 GetVendorName(self) -> String
4685
4686 Get the application's vendor name.
4687 """
4688 return _core_.PyApp_GetVendorName(*args, **kwargs)
4689
4690 def SetVendorName(*args, **kwargs):
4691 """
4692 SetVendorName(self, String name)
4693
c24da6d6
RD
4694 Set the application's vendor name. This value may be used
4695 automatically by `wx.Config` and such.
d55e5bfc
RD
4696 """
4697 return _core_.PyApp_SetVendorName(*args, **kwargs)
4698
4699 def GetTraits(*args, **kwargs):
4700 """
4701 GetTraits(self) -> wxAppTraits
4702
c24da6d6
RD
4703 Return (and create if necessary) the app traits object to which we
4704 delegate for everything which either should be configurable by the
4705 user (then he can change the default behaviour simply by overriding
4706 CreateTraits() and returning his own traits object) or which is
4707 GUI/console dependent as then wx.AppTraits allows us to abstract the
4708 differences behind the common facade.
4709
4710 :todo: Add support for overriding CreateAppTraits in wxPython.
d55e5bfc
RD
4711 """
4712 return _core_.PyApp_GetTraits(*args, **kwargs)
4713
4714 def ProcessPendingEvents(*args, **kwargs):
4715 """
4716 ProcessPendingEvents(self)
4717
c24da6d6
RD
4718 Process all events in the Pending Events list -- it is necessary to
4719 call this function to process posted events. This normally happens
4720 during each event loop iteration.
d55e5bfc
RD
4721 """
4722 return _core_.PyApp_ProcessPendingEvents(*args, **kwargs)
4723
4724 def Yield(*args, **kwargs):
4725 """
4726 Yield(self, bool onlyIfNeeded=False) -> bool
4727
c24da6d6
RD
4728 Process all currently pending events right now, instead of waiting
4729 until return to the event loop. It is an error to call ``Yield``
4730 recursively unless the value of ``onlyIfNeeded`` is True.
d55e5bfc 4731
c24da6d6 4732 :warning: This function is dangerous as it can lead to unexpected
79fccf9d
RD
4733 reentrancies (i.e. when called from an event handler it may
4734 result in calling the same event handler again), use with
4735 extreme care or, better, don't use at all!
d55e5bfc 4736
c24da6d6 4737 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
79fccf9d 4738
d55e5bfc
RD
4739 """
4740 return _core_.PyApp_Yield(*args, **kwargs)
4741
4742 def WakeUpIdle(*args, **kwargs):
4743 """
4744 WakeUpIdle(self)
4745
c24da6d6
RD
4746 Make sure that idle events are sent again.
4747 :see: `wx.WakeUpIdle`
d55e5bfc
RD
4748 """
4749 return _core_.PyApp_WakeUpIdle(*args, **kwargs)
4750
4751 def MainLoop(*args, **kwargs):
4752 """
4753 MainLoop(self) -> int
4754
c24da6d6
RD
4755 Execute the main GUI loop, the function doesn't normally return until
4756 all top level windows have been closed and destroyed.
d55e5bfc
RD
4757 """
4758 return _core_.PyApp_MainLoop(*args, **kwargs)
4759
4760 def Exit(*args, **kwargs):
4761 """
4762 Exit(self)
4763
4764 Exit the main loop thus terminating the application.
c24da6d6 4765 :see: `wx.Exit`
d55e5bfc
RD
4766 """
4767 return _core_.PyApp_Exit(*args, **kwargs)
4768
4769 def ExitMainLoop(*args, **kwargs):
4770 """
4771 ExitMainLoop(self)
4772
c24da6d6
RD
4773 Exit the main GUI loop during the next iteration of the main
4774 loop, (i.e. it does not stop the program immediately!)
d55e5bfc
RD
4775 """
4776 return _core_.PyApp_ExitMainLoop(*args, **kwargs)
4777
4778 def Pending(*args, **kwargs):
4779 """
4780 Pending(self) -> bool
4781
4782 Returns True if there are unprocessed events in the event queue.
4783 """
4784 return _core_.PyApp_Pending(*args, **kwargs)
4785
4786 def Dispatch(*args, **kwargs):
4787 """
4788 Dispatch(self) -> bool
4789
4790 Process the first event in the event queue (blocks until an event
4791 appears if there are none currently)
4792 """
4793 return _core_.PyApp_Dispatch(*args, **kwargs)
4794
4795 def ProcessIdle(*args, **kwargs):
4796 """
4797 ProcessIdle(self) -> bool
4798
c24da6d6
RD
4799 Called from the MainLoop when the application becomes idle (there are
4800 no pending events) and sends a `wx.IdleEvent` to all interested
4801 parties. Returns True if more idle events are needed, False if not.
d55e5bfc
RD
4802 """
4803 return _core_.PyApp_ProcessIdle(*args, **kwargs)
4804
4805 def SendIdleEvents(*args, **kwargs):
4806 """
4807 SendIdleEvents(self, Window win, IdleEvent event) -> bool
4808
c24da6d6
RD
4809 Send idle event to window and all subwindows. Returns True if more
4810 idle time is requested.
d55e5bfc
RD
4811 """
4812 return _core_.PyApp_SendIdleEvents(*args, **kwargs)
4813
4814 def IsActive(*args, **kwargs):
4815 """
4816 IsActive(self) -> bool
4817
4818 Return True if our app has focus.
4819 """
4820 return _core_.PyApp_IsActive(*args, **kwargs)
4821
4822 def SetTopWindow(*args, **kwargs):
4823 """
4824 SetTopWindow(self, Window win)
4825
c24da6d6 4826 Set the *main* top level window
d55e5bfc
RD
4827 """
4828 return _core_.PyApp_SetTopWindow(*args, **kwargs)
4829
4830 def GetTopWindow(*args, **kwargs):
4831 """
4832 GetTopWindow(self) -> Window
4833
c24da6d6
RD
4834 Return the *main* top level window (if it hadn't been set previously
4835 with SetTopWindow(), will return just some top level window and, if
4836 there not any, will return None)
d55e5bfc
RD
4837 """
4838 return _core_.PyApp_GetTopWindow(*args, **kwargs)
4839
4840 def SetExitOnFrameDelete(*args, **kwargs):
4841 """
4842 SetExitOnFrameDelete(self, bool flag)
4843
c24da6d6
RD
4844 Control the exit behaviour: by default, the program will exit the main
4845 loop (and so, usually, terminate) when the last top-level program
4846 window is deleted. Beware that if you disable this behaviour (with
4847 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
4848 explicitly from somewhere.
d55e5bfc
RD
4849 """
4850 return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs)
4851
4852 def GetExitOnFrameDelete(*args, **kwargs):
4853 """
4854 GetExitOnFrameDelete(self) -> bool
4855
4856 Get the current exit behaviour setting.
4857 """
4858 return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs)
4859
4860 def SetUseBestVisual(*args, **kwargs):
4861 """
4862 SetUseBestVisual(self, bool flag)
4863
c24da6d6
RD
4864 Set whether the app should try to use the best available visual on
4865 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)
d55e5bfc
RD
4866 """
4867 return _core_.PyApp_SetUseBestVisual(*args, **kwargs)
4868
4869 def GetUseBestVisual(*args, **kwargs):
4870 """
4871 GetUseBestVisual(self) -> bool
4872
4873 Get current UseBestVisual setting.
4874 """
4875 return _core_.PyApp_GetUseBestVisual(*args, **kwargs)
4876
4877 def SetPrintMode(*args, **kwargs):
4878 """SetPrintMode(self, int mode)"""
4879 return _core_.PyApp_SetPrintMode(*args, **kwargs)
4880
4881 def GetPrintMode(*args, **kwargs):
4882 """GetPrintMode(self) -> int"""
4883 return _core_.PyApp_GetPrintMode(*args, **kwargs)
4884
4885 def SetAssertMode(*args, **kwargs):
4886 """
4887 SetAssertMode(self, int mode)
4888
79fccf9d 4889 Set the OnAssert behaviour for debug and hybrid builds.
d55e5bfc
RD
4890 """
4891 return _core_.PyApp_SetAssertMode(*args, **kwargs)
4892
4893 def GetAssertMode(*args, **kwargs):
4894 """
4895 GetAssertMode(self) -> int
4896
4897 Get the current OnAssert behaviour setting.
4898 """
4899 return _core_.PyApp_GetAssertMode(*args, **kwargs)
4900
4901 def GetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 4902 """GetMacSupportPCMenuShortcuts() -> bool"""
d55e5bfc
RD
4903 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4904
4905 GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts)
4906 def GetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 4907 """GetMacAboutMenuItemId() -> long"""
d55e5bfc
RD
4908 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4909
4910 GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId)
4911 def GetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 4912 """GetMacPreferencesMenuItemId() -> long"""
d55e5bfc
RD
4913 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4914
4915 GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId)
4916 def GetMacExitMenuItemId(*args, **kwargs):
c24da6d6 4917 """GetMacExitMenuItemId() -> long"""
d55e5bfc
RD
4918 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4919
4920 GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId)
4921 def GetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 4922 """GetMacHelpMenuTitleName() -> String"""
d55e5bfc
RD
4923 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4924
4925 GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName)
4926 def SetMacSupportPCMenuShortcuts(*args, **kwargs):
c24da6d6 4927 """SetMacSupportPCMenuShortcuts(bool val)"""
d55e5bfc
RD
4928 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
4929
4930 SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts)
4931 def SetMacAboutMenuItemId(*args, **kwargs):
c24da6d6 4932 """SetMacAboutMenuItemId(long val)"""
d55e5bfc
RD
4933 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
4934
4935 SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId)
4936 def SetMacPreferencesMenuItemId(*args, **kwargs):
c24da6d6 4937 """SetMacPreferencesMenuItemId(long val)"""
d55e5bfc
RD
4938 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
4939
4940 SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId)
4941 def SetMacExitMenuItemId(*args, **kwargs):
c24da6d6 4942 """SetMacExitMenuItemId(long val)"""
d55e5bfc
RD
4943 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
4944
4945 SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId)
4946 def SetMacHelpMenuTitleName(*args, **kwargs):
c24da6d6 4947 """SetMacHelpMenuTitleName(String val)"""
d55e5bfc
RD
4948 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
4949
4950 SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName)
4951 def _BootstrapApp(*args, **kwargs):
4952 """
4953 _BootstrapApp(self)
4954
4955 For internal use only
4956 """
4957 return _core_.PyApp__BootstrapApp(*args, **kwargs)
4958
4959 def GetComCtl32Version(*args, **kwargs):
4960 """
c24da6d6 4961 GetComCtl32Version() -> int
d55e5bfc 4962
c24da6d6
RD
4963 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
4964 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
4965 """
4966 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
4967
4968 GetComCtl32Version = staticmethod(GetComCtl32Version)
4969
4970class PyAppPtr(PyApp):
4971 def __init__(self, this):
4972 self.this = this
4973 if not hasattr(self,"thisown"): self.thisown = 0
4974 self.__class__ = PyApp
4975_core_.PyApp_swigregister(PyAppPtr)
4976
4977def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
4978 """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
4979 return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
4980
4981def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
4982 """PyApp_GetMacAboutMenuItemId() -> long"""
4983 return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
4984
4985def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
4986 """PyApp_GetMacPreferencesMenuItemId() -> long"""
4987 return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
4988
4989def PyApp_GetMacExitMenuItemId(*args, **kwargs):
4990 """PyApp_GetMacExitMenuItemId() -> long"""
4991 return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
4992
4993def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
4994 """PyApp_GetMacHelpMenuTitleName() -> String"""
4995 return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
4996
4997def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
4998 """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
4999 return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
5000
5001def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
5002 """PyApp_SetMacAboutMenuItemId(long val)"""
5003 return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
5004
5005def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
5006 """PyApp_SetMacPreferencesMenuItemId(long val)"""
5007 return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
5008
5009def PyApp_SetMacExitMenuItemId(*args, **kwargs):
5010 """PyApp_SetMacExitMenuItemId(long val)"""
5011 return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
5012
5013def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
5014 """PyApp_SetMacHelpMenuTitleName(String val)"""
5015 return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
5016
5017def PyApp_GetComCtl32Version(*args, **kwargs):
5018 """
5019 PyApp_GetComCtl32Version() -> int
5020
c24da6d6
RD
5021 Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
5022 it wasn't found at all. Raises an exception on non-Windows platforms.
d55e5bfc
RD
5023 """
5024 return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
5025
5026#---------------------------------------------------------------------------
5027
5028
5029def Exit(*args, **kwargs):
5030 """
5031 Exit()
5032
5033 Force an exit of the application. Convenience for wx.GetApp().Exit()
5034 """
5035 return _core_.Exit(*args, **kwargs)
5036
5037def Yield(*args, **kwargs):
5038 """
5039 Yield() -> bool
5040
5041 Yield to other apps/messages. Convenience for wx.GetApp().Yield()
5042 """
5043 return _core_.Yield(*args, **kwargs)
5044
5045def YieldIfNeeded(*args, **kwargs):
5046 """
5047 YieldIfNeeded() -> bool
5048
5049 Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
5050 """
5051 return _core_.YieldIfNeeded(*args, **kwargs)
5052
5053def SafeYield(*args, **kwargs):
5054 """
5055 SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
5056
c24da6d6
RD
5057 This function is similar to `wx.Yield`, except that it disables the
5058 user input to all program windows before calling `wx.Yield` and
5059 re-enables it again afterwards. If ``win`` is not None, this window
5060 will remain enabled, allowing the implementation of some limited user
5061 interaction.
d55e5bfc 5062
c24da6d6 5063 :Returns: the result of the call to `wx.Yield`.
d55e5bfc
RD
5064 """
5065 return _core_.SafeYield(*args, **kwargs)
5066
5067def WakeUpIdle(*args, **kwargs):
5068 """
5069 WakeUpIdle()
5070
c24da6d6
RD
5071 Cause the message queue to become empty again, so idle events will be
5072 sent.
d55e5bfc
RD
5073 """
5074 return _core_.WakeUpIdle(*args, **kwargs)
5075
5076def PostEvent(*args, **kwargs):
5077 """
5078 PostEvent(EvtHandler dest, Event event)
5079
c24da6d6
RD
5080 Send an event to a window or other wx.EvtHandler to be processed
5081 later.
d55e5bfc
RD
5082 """
5083 return _core_.PostEvent(*args, **kwargs)
5084
5085def App_CleanUp(*args, **kwargs):
5086 """
5087 App_CleanUp()
5088
79fccf9d 5089 For internal use only, it is used to cleanup after wxWidgets when
c24da6d6 5090 Python shuts down.
d55e5bfc
RD
5091 """
5092 return _core_.App_CleanUp(*args, **kwargs)
5093
5094def GetApp(*args, **kwargs):
5095 """
5096 GetApp() -> PyApp
5097
5098 Return a reference to the current wx.App object.
5099 """
5100 return _core_.GetApp(*args, **kwargs)
5101#----------------------------------------------------------------------
5102
5103class PyOnDemandOutputWindow:
5104 """
5105 A class that can be used for redirecting Python's stdout and
5106 stderr streams. It will do nothing until something is wrriten to
5107 the stream at which point it will create a Frame with a text area
5108 and write the text there.
5109 """
5110 def __init__(self, title = "wxPython: stdout/stderr"):
5111 self.frame = None
5112 self.title = title
412d302d
RD
5113 self.pos = wx.DefaultPosition
5114 self.size = (450, 300)
d55e5bfc
RD
5115 self.parent = None
5116
5117 def SetParent(self, parent):
5118 """Set the window to be used as the popup Frame's parent."""
5119 self.parent = parent
5120
5121
5122 def CreateOutputWindow(self, st):
412d302d
RD
5123 self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
5124 style=wx.DEFAULT_FRAME_STYLE)
d55e5bfc 5125 self.text = wx.TextCtrl(self.frame, -1, "",
412d302d 5126 style=wx.TE_MULTILINE|wx.TE_READONLY)
d55e5bfc 5127 self.text.AppendText(st)
d55e5bfc
RD
5128 self.frame.Show(True)
5129 EVT_CLOSE(self.frame, self.OnCloseWindow)
5130
5131
5132 def OnCloseWindow(self, event):
5133 if self.frame is not None:
5134 self.frame.Destroy()
5135 self.frame = None
5136 self.text = None
5137
5138
5139 # These methods provide the file-like output behaviour.
5140 def write(self, text):
5141 """
5142 Create the output window if needed and write the string to it.
5143 If not called in the context of the gui thread then uses
5144 CallAfter to do the work there.
5145 """
5146 if self.frame is None:
5147 if not wx.Thread_IsMain():
5148 wx.CallAfter(self.CreateOutputWindow, text)
5149 else:
5150 self.CreateOutputWindow(text)
5151 else:
5152 if not wx.Thread_IsMain():
5153 wx.CallAfter(self.text.AppendText, text)
5154 else:
5155 self.text.AppendText(text)
5156
5157
5158 def close(self):
5159 if self.frame is not None:
5160 wx.CallAfter(self.frame.Close)
5161
5162
19272049
RD
5163 def flush(self):
5164 pass
5165
5166
d55e5bfc
RD
5167
5168#----------------------------------------------------------------------
5169
5170_defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
5171
5172class App(wx.PyApp):
5173 """
c24da6d6
RD
5174 The ``wx.App`` class represents the application and is used to:
5175
5176 * bootstrap the wxPython system and initialize the underlying
5177 gui toolkit
5178 * set and get application-wide properties
5179 * implement the windowing system main message or event loop,
5180 and to dispatch events to window instances
5181 * etc.
5182
5183 Every application must have a ``wx.App`` instance, and all
5184 creation of UI objects should be delayed until after the
5185 ``wx.App`` object has been created in order to ensure that the gui
5186 platform and wxWidgets have been fully initialized.
5187
5188 Normally you would derive from this class and implement an
5189 ``OnInit`` method that creates a frame and then calls
5190 ``self.SetTopWindow(frame)``.
5191
5192 :see: `wx.PySimpleApp` for a simpler app class that can be used
79fccf9d 5193 directly.
d55e5bfc 5194 """
c24da6d6 5195
d55e5bfc
RD
5196 outputWindowClass = PyOnDemandOutputWindow
5197
c24da6d6
RD
5198 def __init__(self, redirect=_defRedirect, filename=None,
5199 useBestVisual=False, clearSigInt=True):
5200 """
5201 Construct a ``wx.App`` object.
5202
5203 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
5204 redirected? Defaults to True on Windows and Mac, False
5205 otherwise. If `filename` is None then output will be
5206 redirected to a window that pops up as needed. (You can
5207 control what kind of window is created for the output by
5208 resetting the class variable ``outputWindowClass`` to a
5209 class of your choosing.)
5210
5211 :param filename: The name of a file to redirect output to, if
5212 redirect is True.
5213
5214 :param useBestVisual: Should the app try to use the best
5215 available visual provided by the system (only relevant on
5216 systems that have more than one visual.) This parameter
5217 must be used instead of calling `SetUseBestVisual` later
5218 on because it must be set before the underlying GUI
5219 toolkit is initialized.
5220
5221 :param clearSigInt: Should SIGINT be cleared? This allows the
5222 app to terminate upon a Ctrl-C in the console like other
5223 GUI apps will.
5224
5225 :note: You should override OnInit to do applicaition
5226 initialization to ensure that the system, toolkit and
5227 wxWidgets are fully initialized.
5228 """
d55e5bfc
RD
5229 wx.PyApp.__init__(self)
5230
5231 if wx.Platform == "__WXMAC__":
5232 try:
5233 import MacOS
5234 if not MacOS.WMAvailable():
5235 print """\
5236This program needs access to the screen. Please run with 'pythonw',
5237not 'python', and only when you are logged in on the main display of
5238your Mac."""
5239 _sys.exit(1)
b1f29bf7
RD
5240 except SystemExit:
5241 raise
d55e5bfc
RD
5242 except:
5243 pass
5244
5245 # This has to be done before OnInit
5246 self.SetUseBestVisual(useBestVisual)
5247
5248 # Set the default handler for SIGINT. This fixes a problem
5249 # where if Ctrl-C is pressed in the console that started this
5250 # app then it will not appear to do anything, (not even send
5251 # KeyboardInterrupt???) but will later segfault on exit. By
5252 # setting the default handler then the app will exit, as
5253 # expected (depending on platform.)
c24da6d6
RD
5254 if clearSigInt:
5255 try:
5256 import signal
5257 signal.signal(signal.SIGINT, signal.SIG_DFL)
5258 except:
5259 pass
d55e5bfc
RD
5260
5261 # Save and redirect the stdio to a window?
5262 self.stdioWin = None
5263 self.saveStdio = (_sys.stdout, _sys.stderr)
5264 if redirect:
5265 self.RedirectStdio(filename)
5266
5267 # This finishes the initialization of wxWindows and then calls
5268 # the OnInit that should be present in the derived class
5269 self._BootstrapApp()
5270
5271
5272 def __del__(self):
5273 try:
5274 self.RestoreStdio() # Just in case the MainLoop was overridden
5275 except:
5276 pass
5277
5278
5279 def SetTopWindow(self, frame):
5280 """Set the \"main\" top level window"""
5281 if self.stdioWin:
5282 self.stdioWin.SetParent(frame)
5283 wx.PyApp.SetTopWindow(self, frame)
5284
5285
5286 def MainLoop(self):
5287 """Execute the main GUI event loop"""
5288 wx.PyApp.MainLoop(self)
5289 self.RestoreStdio()
5290
5291
5292 def RedirectStdio(self, filename=None):
5293 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
5294 if filename:
5295 _sys.stdout = _sys.stderr = open(filename, 'a')
5296 else:
5297 self.stdioWin = self.outputWindowClass()
5298 _sys.stdout = _sys.stderr = self.stdioWin
5299
5300
5301 def RestoreStdio(self):
5302 _sys.stdout, _sys.stderr = self.saveStdio
5303
5304
412d302d
RD
5305 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
5306 """
5307 Set the title, position and/or size of the output window if
f5b96ee1
RD
5308 the stdio has been redirected. This should be called before
5309 any output would cause the output window to be created.
412d302d
RD
5310 """
5311 if self.stdioWin:
5312 if title is not None:
5313 self.stdioWin.title = title
5314 if pos is not None:
5315 self.stdioWin.pos = pos
5316 if size is not None:
5317 self.stdioWin.size = size
5318
5319
5320
d55e5bfc 5321
c24da6d6 5322# change from wx.PyApp_XX to wx.App_XX
d55e5bfc
RD
5323App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
5324App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
5325App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
5326App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
5327App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
5328App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
5329App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
5330App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
5331App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
5332App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
5333App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
5334
5335#----------------------------------------------------------------------------
5336
5337class PySimpleApp(wx.App):
5338 """
5339 A simple application class. You can just create one of these and
5340 then then make your top level windows later, and not have to worry
c24da6d6 5341 about OnInit. For example::
d55e5bfc 5342
c24da6d6
RD
5343 app = wx.PySimpleApp()
5344 frame = wx.Frame(None, title='Hello World')
5345 frame.Show()
5346 app.MainLoop()
5347
5348 :see: `wx.App`
5349 """
5350
5351 def __init__(self, redirect=False, filename=None,
5352 useBestVisual=False, clearSigInt=True):
5353 """
5354 :see: `wx.App.__init__`
5355 """
5356 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
d55e5bfc
RD
5357
5358 def OnInit(self):
d55e5bfc
RD
5359 return True
5360
5361
c24da6d6 5362
d55e5bfc
RD
5363# Is anybody using this one?
5364class PyWidgetTester(wx.App):
5365 def __init__(self, size = (250, 100)):
5366 self.size = size
5367 wx.App.__init__(self, 0)
5368
5369 def OnInit(self):
5370 self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size)
5371 self.SetTopWindow(self.frame)
5372 return True
5373
c24da6d6
RD
5374 def SetWidget(self, widgetClass, *args, **kwargs):
5375 w = widgetClass(self.frame, *args, **kwargs)
d55e5bfc
RD
5376 self.frame.Show(True)
5377
5378#----------------------------------------------------------------------------
5379# DO NOT hold any other references to this object. This is how we
c24da6d6 5380# know when to cleanup system resources that wxWidgets is holding. When
d55e5bfc 5381# the sys module is unloaded, the refcount on sys.__wxPythonCleanup
c24da6d6 5382# goes to zero and it calls the wx.App_CleanUp function.
d55e5bfc
RD
5383
5384class __wxPyCleanup:
5385 def __init__(self):
5386 self.cleanup = _core_.App_CleanUp
5387 def __del__(self):
5388 self.cleanup()
5389
5390_sys.__wxPythonCleanup = __wxPyCleanup()
5391
5392## # another possible solution, but it gets called too early...
c24da6d6
RD
5393## import atexit
5394## atexit.register(_core_.wxApp_CleanUp)
d55e5bfc
RD
5395
5396
5397#----------------------------------------------------------------------------
5398
5399#---------------------------------------------------------------------------
5400
5401class AcceleratorEntry(object):
c24da6d6
RD
5402 """
5403 A class used to define items in an `wx.AcceleratorTable`. wxPython
5404 programs can choose to use wx.AcceleratorEntry objects, but using a
5405 list of 3-tuple of integers (flags, keyCode, cmdID) usually works just
79fccf9d 5406 as well. See `__init__` for of the tuple values.
c24da6d6
RD
5407
5408 :see: `wx.AcceleratorTable`
5409 """
d55e5bfc
RD
5410 def __repr__(self):
5411 return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5412 def __init__(self, *args, **kwargs):
c24da6d6
RD
5413 """
5414 __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
5415
5416 Construct a wx.AcceleratorEntry.
c24da6d6 5417 """
d55e5bfc
RD
5418 newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
5419 self.this = newobj.this
5420 self.thisown = 1
5421 del newobj.thisown
5422 def __del__(self, destroy=_core_.delete_AcceleratorEntry):
5423 """__del__(self)"""
5424 try:
5425 if self.thisown: destroy(self)
5426 except: pass
5427
5428 def Set(*args, **kwargs):
c24da6d6
RD
5429 """
5430 Set(self, int flags, int keyCode, int cmd)
d55e5bfc 5431
c24da6d6
RD
5432 (Re)set the attributes of a wx.AcceleratorEntry.
5433 :see `__init__`
5434 """
5435 return _core_.AcceleratorEntry_Set(*args, **kwargs)
d55e5bfc
RD
5436
5437 def GetFlags(*args, **kwargs):
c24da6d6
RD
5438 """
5439 GetFlags(self) -> int
5440
5441 Get the AcceleratorEntry's flags.
5442 """
d55e5bfc
RD
5443 return _core_.AcceleratorEntry_GetFlags(*args, **kwargs)
5444
5445 def GetKeyCode(*args, **kwargs):
c24da6d6
RD
5446 """
5447 GetKeyCode(self) -> int
5448
5449 Get the AcceleratorEntry's keycode.
5450 """
d55e5bfc
RD
5451 return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs)
5452
5453 def GetCommand(*args, **kwargs):
c24da6d6
RD
5454 """
5455 GetCommand(self) -> int
5456
5457 Get the AcceleratorEntry's command ID.
5458 """
d55e5bfc
RD
5459 return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
5460
5461
5462class AcceleratorEntryPtr(AcceleratorEntry):
5463 def __init__(self, this):
5464 self.this = this
5465 if not hasattr(self,"thisown"): self.thisown = 0
5466 self.__class__ = AcceleratorEntry
5467_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
5468
5469class AcceleratorTable(Object):
c24da6d6
RD
5470 """
5471 An accelerator table allows the application to specify a table of
5472 keyboard shortcuts for menus or other commands. On Windows, menu or
5473 button commands are supported; on GTK, only menu commands are
5474 supported.
c24da6d6 5475 """
d55e5bfc
RD
5476 def __repr__(self):
5477 return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5478 def __init__(self, *args, **kwargs):
5479 """
5480 __init__(entries) -> AcceleratorTable
5481
c24da6d6
RD
5482 Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
5483 items or or of 3-tuples (flags, keyCode, cmdID)
5484
5485 :see: `wx.AcceleratorEntry`
d55e5bfc
RD
5486 """
5487 newobj = _core_.new_AcceleratorTable(*args, **kwargs)
5488 self.this = newobj.this
5489 self.thisown = 1
5490 del newobj.thisown
5491 def __del__(self, destroy=_core_.delete_AcceleratorTable):
5492 """__del__(self)"""
5493 try:
5494 if self.thisown: destroy(self)
5495 except: pass
5496
5497 def Ok(*args, **kwargs):
5498 """Ok(self) -> bool"""
5499 return _core_.AcceleratorTable_Ok(*args, **kwargs)
5500
5501
5502class AcceleratorTablePtr(AcceleratorTable):
5503 def __init__(self, this):
5504 self.this = this
5505 if not hasattr(self,"thisown"): self.thisown = 0
5506 self.__class__ = AcceleratorTable
5507_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
5508
5509
5510def GetAccelFromString(*args, **kwargs):
5511 """GetAccelFromString(String label) -> AcceleratorEntry"""
5512 return _core_.GetAccelFromString(*args, **kwargs)
5513#---------------------------------------------------------------------------
5514
5515class VisualAttributes(object):
5516 """struct containing all the visual attributes of a control"""
5517 def __repr__(self):
5518 return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5519 def __init__(self, *args, **kwargs):
5520 """
5521 __init__(self) -> VisualAttributes
5522
5523 struct containing all the visual attributes of a control
5524 """
5525 newobj = _core_.new_VisualAttributes(*args, **kwargs)
5526 self.this = newobj.this
5527 self.thisown = 1
5528 del newobj.thisown
5529 def __del__(self, destroy=_core_.delete_VisualAttributes):
5530 """__del__(self)"""
5531 try:
5532 if self.thisown: destroy(self)
5533 except: pass
5534
5535 font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
5536 colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
5537 colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
5538
5539class VisualAttributesPtr(VisualAttributes):
5540 def __init__(self, this):
5541 self.this = this
5542 if not hasattr(self,"thisown"): self.thisown = 0
5543 self.__class__ = VisualAttributes
5544_core_.VisualAttributes_swigregister(VisualAttributesPtr)
5545NullAcceleratorTable = cvar.NullAcceleratorTable
5546PanelNameStr = cvar.PanelNameStr
5547
5548WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL
5549WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL
5550WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI
5551WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE
5552WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX
5553class Window(EvtHandler):
5554 """
5555 wx.Window is the base class for all windows and represents any visible
5556 object on the screen. All controls, top level windows and so on are
5557 wx.Windows. Sizers and device contexts are not however, as they don't
5558 appear on screen themselves.
5559
5560 """
5561 def __repr__(self):
5562 return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5563 def __init__(self, *args, **kwargs):
5564 """
5565 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
5566 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
5567
5568 Construct and show a generic Window.
5569 """
5570 newobj = _core_.new_Window(*args, **kwargs)
5571 self.this = newobj.this
5572 self.thisown = 1
5573 del newobj.thisown
5574 self._setOORInfo(self)
5575
5576 def Create(*args, **kwargs):
5577 """
5578 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
5579 Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool
5580
5581 Create the GUI part of the Window for 2-phase creation mode.
5582 """
5583 return _core_.Window_Create(*args, **kwargs)
5584
5585 def Close(*args, **kwargs):
5586 """
5587 Close(self, bool force=False) -> bool
5588
5589 This function simply generates a EVT_CLOSE event whose handler usually
5590 tries to close the window. It doesn't close the window itself,
5591 however. If force is False (the default) then the window's close
5592 handler will be allowed to veto the destruction of the window.
d55e5bfc
RD
5593 """
5594 return _core_.Window_Close(*args, **kwargs)
5595
5596 def Destroy(*args, **kwargs):
5597 """
5598 Destroy(self) -> bool
5599
5600 Destroys the window safely. Frames and dialogs are not destroyed
5601 immediately when this function is called -- they are added to a list
5602 of windows to be deleted on idle time, when all the window's events
5603 have been processed. This prevents problems with events being sent to
5604 non-existent windows.
5605
5606 Returns True if the window has either been successfully deleted, or it
5607 has been added to the list of windows pending real deletion.
5608 """
5609 return _core_.Window_Destroy(*args, **kwargs)
5610
5611 def DestroyChildren(*args, **kwargs):
5612 """
5613 DestroyChildren(self) -> bool
5614
79fccf9d
RD
5615 Destroys all children of a window. Called automatically by the
5616 destructor.
d55e5bfc
RD
5617 """
5618 return _core_.Window_DestroyChildren(*args, **kwargs)
5619
5620 def IsBeingDeleted(*args, **kwargs):
5621 """
5622 IsBeingDeleted(self) -> bool
5623
5624 Is the window in the process of being deleted?
5625 """
5626 return _core_.Window_IsBeingDeleted(*args, **kwargs)
5627
5628 def SetTitle(*args, **kwargs):
5629 """
5630 SetTitle(self, String title)
5631
5632 Sets the window's title. Applicable only to frames and dialogs.
5633 """
5634 return _core_.Window_SetTitle(*args, **kwargs)
5635
5636 def GetTitle(*args, **kwargs):
5637 """
5638 GetTitle(self) -> String
5639
5640 Gets the window's title. Applicable only to frames and dialogs.
5641 """
5642 return _core_.Window_GetTitle(*args, **kwargs)
5643
5644 def SetLabel(*args, **kwargs):
5645 """
5646 SetLabel(self, String label)
5647
5648 Set the text which the window shows in its label if applicable.
5649 """
5650 return _core_.Window_SetLabel(*args, **kwargs)
5651
5652 def GetLabel(*args, **kwargs):
5653 """
5654 GetLabel(self) -> String
5655
79fccf9d
RD
5656 Generic way of getting a label from any window, for identification
5657 purposes. The interpretation of this function differs from class to
5658 class. For frames and dialogs, the value returned is the title. For
5659 buttons or static text controls, it is the button text. This function
5660 can be useful for meta-programs such as testing tools or special-needs
5661 access programs)which need to identify windows by name.
d55e5bfc
RD
5662 """
5663 return _core_.Window_GetLabel(*args, **kwargs)
5664
5665 def SetName(*args, **kwargs):
5666 """
5667 SetName(self, String name)
5668
79fccf9d
RD
5669 Sets the window's name. The window name is used for ressource setting
5670 in X, it is not the same as the window title/label
d55e5bfc
RD
5671 """
5672 return _core_.Window_SetName(*args, **kwargs)
5673
5674 def GetName(*args, **kwargs):
5675 """
5676 GetName(self) -> String
5677
79fccf9d
RD
5678 Returns the windows name. This name is not guaranteed to be unique;
5679 it is up to the programmer to supply an appropriate name in the window
5680 constructor or via wx.Window.SetName.
d55e5bfc
RD
5681 """
5682 return _core_.Window_GetName(*args, **kwargs)
5683
5684 def SetWindowVariant(*args, **kwargs):
5685 """
5686 SetWindowVariant(self, int variant)
5687
79fccf9d
RD
5688 Sets the variant of the window/font size to use for this window, if
5689 the platform supports variants, for example, wxMac.
d55e5bfc
RD
5690 """
5691 return _core_.Window_SetWindowVariant(*args, **kwargs)
5692
5693 def GetWindowVariant(*args, **kwargs):
5694 """GetWindowVariant(self) -> int"""
5695 return _core_.Window_GetWindowVariant(*args, **kwargs)
5696
5697 def SetId(*args, **kwargs):
5698 """
5699 SetId(self, int winid)
5700
5701 Sets the identifier of the window. Each window has an integer
5702 identifier. If the application has not provided one, an identifier
5703 will be generated. Normally, the identifier should be provided on
5704 creation and should not be modified subsequently.
5705 """
5706 return _core_.Window_SetId(*args, **kwargs)
5707
5708 def GetId(*args, **kwargs):
5709 """
5710 GetId(self) -> int
5711
5712 Returns the identifier of the window. Each window has an integer
5713 identifier. If the application has not provided one (or the default Id
5714 -1 is used) then an unique identifier with a negative value will be
5715 generated.
5716 """
5717 return _core_.Window_GetId(*args, **kwargs)
5718
5719 def NewControlId(*args, **kwargs):
5720 """
c24da6d6 5721 NewControlId() -> int
d55e5bfc
RD
5722
5723 Generate a control id for the controls which were not given one.
5724 """
5725 return _core_.Window_NewControlId(*args, **kwargs)
5726
5727 NewControlId = staticmethod(NewControlId)
5728 def NextControlId(*args, **kwargs):
5729 """
c24da6d6 5730 NextControlId(int winid) -> int
d55e5bfc
RD
5731
5732 Get the id of the control following the one with the given
79fccf9d 5733 autogenerated) id
d55e5bfc
RD
5734 """
5735 return _core_.Window_NextControlId(*args, **kwargs)
5736
5737 NextControlId = staticmethod(NextControlId)
5738 def PrevControlId(*args, **kwargs):
5739 """
c24da6d6 5740 PrevControlId(int winid) -> int
d55e5bfc
RD
5741
5742 Get the id of the control preceding the one with the given
79fccf9d 5743 autogenerated) id
d55e5bfc
RD
5744 """
5745 return _core_.Window_PrevControlId(*args, **kwargs)
5746
5747 PrevControlId = staticmethod(PrevControlId)
5748 def SetSize(*args, **kwargs):
5749 """
5750 SetSize(self, Size size)
5751
5752 Sets the size of the window in pixels.
5753 """
5754 return _core_.Window_SetSize(*args, **kwargs)
5755
5756 def SetDimensions(*args, **kwargs):
5757 """
5758 SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
5759
5760 Sets the position and size of the window in pixels. The sizeFlags
5761 parameter indicates the interpretation of the other params if they are
5762 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
5763 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
5764 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
5765 dimensions of -1 and less to be interpreted as real dimensions, not
5766 default values.
5767 """
5768 return _core_.Window_SetDimensions(*args, **kwargs)
5769
5770 def SetRect(*args, **kwargs):
5771 """
5772 SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
5773
5774 Sets the position and size of the window in pixels using a wx.Rect.
5775 """
5776 return _core_.Window_SetRect(*args, **kwargs)
5777
5778 def SetSizeWH(*args, **kwargs):
5779 """
5780 SetSizeWH(self, int width, int height)
5781
5782 Sets the size of the window in pixels.
5783 """
5784 return _core_.Window_SetSizeWH(*args, **kwargs)
5785
5786 def Move(*args, **kwargs):
5787 """
5788 Move(self, Point pt, int flags=SIZE_USE_EXISTING)
5789
5790 Moves the window to the given position.
5791 """
5792 return _core_.Window_Move(*args, **kwargs)
5793
5794 SetPosition = Move
5795 def MoveXY(*args, **kwargs):
5796 """
5797 MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
5798
5799 Moves the window to the given position.
5800 """
5801 return _core_.Window_MoveXY(*args, **kwargs)
5802
f8167d6e
RD
5803 def SetBestFittingSize(*args, **kwargs):
5804 """
5805 SetBestFittingSize(self, Size size=DefaultSize)
5806
5807 A 'Smart' SetSize that will fill in default size components with the
5808 window's *best size* values. Also set's the minsize for use with sizers.
5809 """
5810 return _core_.Window_SetBestFittingSize(*args, **kwargs)
5811
d55e5bfc
RD
5812 def Raise(*args, **kwargs):
5813 """
5814 Raise(self)
5815
5816 Raises the window to the top of the window hierarchy if it is a
5817 managed window (dialog or frame).
5818 """
5819 return _core_.Window_Raise(*args, **kwargs)
5820
5821 def Lower(*args, **kwargs):
5822 """
5823 Lower(self)
5824
5825 Lowers the window to the bottom of the window hierarchy if it is a
5826 managed window (dialog or frame).
5827 """
5828 return _core_.Window_Lower(*args, **kwargs)
5829
5830 def SetClientSize(*args, **kwargs):
5831 """
5832 SetClientSize(self, Size size)
5833
5834 This sets the size of the window client area in pixels. Using this
5835 function to size a window tends to be more device-independent than
5836 wx.Window.SetSize, since the application need not worry about what
5837 dimensions the border or title bar have when trying to fit the window
5838 around panel items, for example.
5839 """
5840 return _core_.Window_SetClientSize(*args, **kwargs)
5841
5842 def SetClientSizeWH(*args, **kwargs):
5843 """
5844 SetClientSizeWH(self, int width, int height)
5845
5846 This sets the size of the window client area in pixels. Using this
5847 function to size a window tends to be more device-independent than
5848 wx.Window.SetSize, since the application need not worry about what
5849 dimensions the border or title bar have when trying to fit the window
5850 around panel items, for example.
5851 """
5852 return _core_.Window_SetClientSizeWH(*args, **kwargs)
5853
5854 def SetClientRect(*args, **kwargs):
5855 """
5856 SetClientRect(self, Rect rect)
5857
5858 This sets the size of the window client area in pixels. Using this
5859 function to size a window tends to be more device-independent than
5860 wx.Window.SetSize, since the application need not worry about what
5861 dimensions the border or title bar have when trying to fit the window
5862 around panel items, for example.
5863 """
5864 return _core_.Window_SetClientRect(*args, **kwargs)
5865
5866 def GetPosition(*args, **kwargs):
5867 """
5868 GetPosition(self) -> Point
5869
5870 Get the window's position.
5871 """
5872 return _core_.Window_GetPosition(*args, **kwargs)
5873
5874 def GetPositionTuple(*args, **kwargs):
5875 """
5876 GetPositionTuple() -> (x,y)
5877
5878 Get the window's position.
5879 """
5880 return _core_.Window_GetPositionTuple(*args, **kwargs)
5881
5882 def GetSize(*args, **kwargs):
5883 """
5884 GetSize(self) -> Size
5885
5886 Get the window size.
5887 """
5888 return _core_.Window_GetSize(*args, **kwargs)
5889
5890 def GetSizeTuple(*args, **kwargs):
5891 """
5892 GetSizeTuple() -> (width, height)
5893
5894 Get the window size.
5895 """
5896 return _core_.Window_GetSizeTuple(*args, **kwargs)
5897
5898 def GetRect(*args, **kwargs):
5899 """
5900 GetRect(self) -> Rect
5901
5902 Returns the size and position of the window as a wx.Rect object.
5903 """
5904 return _core_.Window_GetRect(*args, **kwargs)
5905
5906 def GetClientSize(*args, **kwargs):
5907 """
5908 GetClientSize(self) -> Size
5909
5910 This gets the size of the window's 'client area' in pixels. The client
5911 area is the area which may be drawn on by the programmer, excluding
5912 title bar, border, scrollbars, etc.
5913 """
5914 return _core_.Window_GetClientSize(*args, **kwargs)
5915
5916 def GetClientSizeTuple(*args, **kwargs):
5917 """
5918 GetClientSizeTuple() -> (width, height)
5919
5920 This gets the size of the window's 'client area' in pixels. The client
5921 area is the area which may be drawn on by the programmer, excluding
5922 title bar, border, scrollbars, etc.
5923 """
5924 return _core_.Window_GetClientSizeTuple(*args, **kwargs)
5925
5926 def GetClientAreaOrigin(*args, **kwargs):
5927 """
5928 GetClientAreaOrigin(self) -> Point
5929
5930 Get the origin of the client area of the window relative to the
5931 window's top left corner (the client area may be shifted because of
5932 the borders, scrollbars, other decorations...)
5933 """
5934 return _core_.Window_GetClientAreaOrigin(*args, **kwargs)
5935
5936 def GetClientRect(*args, **kwargs):
5937 """
5938 GetClientRect(self) -> Rect
5939
629f3c1b 5940 Get the client area position and size as a `wx.Rect` object.
d55e5bfc
RD
5941 """
5942 return _core_.Window_GetClientRect(*args, **kwargs)
5943
5944 def GetBestSize(*args, **kwargs):
5945 """
5946 GetBestSize(self) -> Size
5947
248ed943 5948 This function returns the best acceptable minimal size for the
79fccf9d
RD
5949 window, if applicable. For example, for a static text control, it will
5950 be the minimal size such that the control label is not truncated. For
5951 windows containing subwindows (suzh aswx.Panel), the size returned by
5952 this function will be the same as the size the window would have had
5953 after calling Fit.
d55e5bfc
RD
5954 """
5955 return _core_.Window_GetBestSize(*args, **kwargs)
5956
5957 def GetBestSizeTuple(*args, **kwargs):
5958 """
5959 GetBestSizeTuple() -> (width, height)
5960
248ed943 5961 This function returns the best acceptable minimal size for the
79fccf9d
RD
5962 window, if applicable. For example, for a static text control, it will
5963 be the minimal size such that the control label is not truncated. For
5964 windows containing subwindows (suzh aswx.Panel), the size returned by
5965 this function will be the same as the size the window would have had
5966 after calling Fit.
d55e5bfc
RD
5967 """
5968 return _core_.Window_GetBestSizeTuple(*args, **kwargs)
5969
a001823c
RD
5970 def InvalidateBestSize(*args, **kwargs):
5971 """
5972 InvalidateBestSize(self)
5973
5974 Reset the cached best size value so it will be recalculated the next
5975 time it is needed.
5976 """
5977 return _core_.Window_InvalidateBestSize(*args, **kwargs)
5978
5979 def GetBestFittingSize(*args, **kwargs):
5980 """
5981 GetBestFittingSize(self) -> Size
5982
5983 This function will merge the window's best size into the window's
5984 minimum size, giving priority to the min size components, and returns
5985 the results.
5986
5987 """
5988 return _core_.Window_GetBestFittingSize(*args, **kwargs)
5989
d55e5bfc
RD
5990 def GetAdjustedBestSize(*args, **kwargs):
5991 """
5992 GetAdjustedBestSize(self) -> Size
5993
5994 This method is similar to GetBestSize, except in one
5995 thing. GetBestSize should return the minimum untruncated size of the
5996 window, while this method will return the largest of BestSize and any
5997 user specified minimum size. ie. it is the minimum size the window
5998 should currently be drawn at, not the minimal size it can possibly
5999 tolerate.
6000 """
6001 return _core_.Window_GetAdjustedBestSize(*args, **kwargs)
6002
6003 def Center(*args, **kwargs):
6004 """
6005 Center(self, int direction=BOTH)
6006
6007 Centers the window. The parameter specifies the direction for
6008 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
6009 also include wx.CENTER_ON_SCREEN flag if you want to center the window
6010 on the entire screen and not on its parent window. If it is a
6011 top-level window and has no parent then it will always be centered
6012 relative to the screen.
6013 """
6014 return _core_.Window_Center(*args, **kwargs)
6015
6016 Centre = Center
6017 def CenterOnScreen(*args, **kwargs):
6018 """
6019 CenterOnScreen(self, int dir=BOTH)
6020
6021 Center on screen (only works for top level windows)
6022 """
6023 return _core_.Window_CenterOnScreen(*args, **kwargs)
6024
6025 CentreOnScreen = CenterOnScreen
6026 def CenterOnParent(*args, **kwargs):
6027 """
6028 CenterOnParent(self, int dir=BOTH)
6029
6030 Center with respect to the the parent window
6031 """
6032 return _core_.Window_CenterOnParent(*args, **kwargs)
6033
6034 CentreOnParent = CenterOnParent
6035 def Fit(*args, **kwargs):
6036 """
6037 Fit(self)
6038
6039 Sizes the window so that it fits around its subwindows. This function
6040 won't do anything if there are no subwindows and will only really work
6041 correctly if sizers are used for the subwindows layout. Also, if the
6042 window has exactly one subwindow it is better (faster and the result
6043 is more precise as Fit adds some margin to account for fuzziness of
6044 its calculations) to call window.SetClientSize(child.GetSize())
6045 instead of calling Fit.
6046 """
6047 return _core_.Window_Fit(*args, **kwargs)
6048
6049 def FitInside(*args, **kwargs):
6050 """
6051 FitInside(self)
6052
6053 Similar to Fit, but sizes the interior (virtual) size of a
6054 window. Mainly useful with scrolled windows to reset scrollbars after
6055 sizing changes that do not trigger a size event, and/or scrolled
6056 windows without an interior sizer. This function similarly won't do
6057 anything if there are no subwindows.
6058 """
6059 return _core_.Window_FitInside(*args, **kwargs)
6060
03837c5c 6061 def SetSizeHints(*args, **kwargs):
d55e5bfc
RD
6062 """
6063 SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
6064 int incH=-1)
d55e5bfc
RD
6065
6066 Allows specification of minimum and maximum window sizes, and window
6067 size increments. If a pair of values is not set (or set to -1), the
6068 default values will be used. If this function is called, the user
908b74cd
RD
6069 will not be able to size the window outside the given bounds (if it is
6070 a top-level window.) Sizers will also inspect the minimum window size
6071 and will use that value if set when calculating layout.
6072
6073 The resizing increments are only significant under Motif or Xt.
d55e5bfc 6074 """
03837c5c 6075 return _core_.Window_SetSizeHints(*args, **kwargs)
d55e5bfc 6076
03837c5c
RD
6077 def SetSizeHintsSz(*args, **kwargs):
6078 """
6079 SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
6080
6081 Allows specification of minimum and maximum window sizes, and window
6082 size increments. If a pair of values is not set (or set to -1), the
6083 default values will be used. If this function is called, the user
6084 will not be able to size the window outside the given bounds (if it is
6085 a top-level window.) Sizers will also inspect the minimum window size
6086 and will use that value if set when calculating layout.
6087
6088 The resizing increments are only significant under Motif or Xt.
6089 """
6090 return _core_.Window_SetSizeHintsSz(*args, **kwargs)
6091
6092 def SetVirtualSizeHints(*args, **kwargs):
d55e5bfc 6093 """
908b74cd 6094 SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
d55e5bfc
RD
6095
6096 Allows specification of minimum and maximum virtual window sizes. If a
6097 pair of values is not set (or set to -1), the default values will be
6098 used. If this function is called, the user will not be able to size
6099 the virtual area of the window outside the given bounds.
6100 """
03837c5c
RD
6101 return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
6102
6103 def SetVirtualSizeHintsSz(*args, **kwargs):
6104 """
6105 SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
6106
6107 Allows specification of minimum and maximum virtual window sizes. If a
6108 pair of values is not set (or set to -1), the default values will be
6109 used. If this function is called, the user will not be able to size
6110 the virtual area of the window outside the given bounds.
6111 """
6112 return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
d55e5bfc 6113
908b74cd
RD
6114 def GetMaxSize(*args, **kwargs):
6115 """GetMaxSize(self) -> Size"""
6116 return _core_.Window_GetMaxSize(*args, **kwargs)
6117
6118 def GetMinSize(*args, **kwargs):
6119 """GetMinSize(self) -> Size"""
6120 return _core_.Window_GetMinSize(*args, **kwargs)
6121
6122 def SetMinSize(*args, **kwargs):
6123 """
6124 SetMinSize(self, Size minSize)
6125
6126 A more convenient method than `SetSizeHints` for setting just the
6127 min size.
6128 """
6129 return _core_.Window_SetMinSize(*args, **kwargs)
6130
6131 def SetMaxSize(*args, **kwargs):
6132 """
6133 SetMaxSize(self, Size maxSize)
6134
6135 A more convenient method than `SetSizeHints` for setting just the
6136 max size.
6137 """
6138 return _core_.Window_SetMaxSize(*args, **kwargs)
6139
d55e5bfc
RD
6140 def GetMinWidth(*args, **kwargs):
6141 """GetMinWidth(self) -> int"""
6142 return _core_.Window_GetMinWidth(*args, **kwargs)
6143
6144 def GetMinHeight(*args, **kwargs):
6145 """GetMinHeight(self) -> int"""
6146 return _core_.Window_GetMinHeight(*args, **kwargs)
6147
6148 def GetMaxWidth(*args, **kwargs):
6149 """GetMaxWidth(self) -> int"""
6150 return _core_.Window_GetMaxWidth(*args, **kwargs)
6151
6152 def GetMaxHeight(*args, **kwargs):
6153 """GetMaxHeight(self) -> int"""
6154 return _core_.Window_GetMaxHeight(*args, **kwargs)
6155
d55e5bfc
RD
6156 def SetVirtualSize(*args, **kwargs):
6157 """
6158 SetVirtualSize(self, Size size)
6159
6160 Set the the virtual size of a window in pixels. For most windows this
6161 is just the client area of the window, but for some like scrolled
6162 windows it is more or less independent of the screen window size.
6163 """
6164 return _core_.Window_SetVirtualSize(*args, **kwargs)
6165
6166 def SetVirtualSizeWH(*args, **kwargs):
6167 """
6168 SetVirtualSizeWH(self, int w, int h)
6169
6170 Set the the virtual size of a window in pixels. For most windows this
6171 is just the client area of the window, but for some like scrolled
6172 windows it is more or less independent of the screen window size.
6173 """
6174 return _core_.Window_SetVirtualSizeWH(*args, **kwargs)
6175
6176 def GetVirtualSize(*args, **kwargs):
6177 """
6178 GetVirtualSize(self) -> Size
6179
6180 Get the the virtual size of the window in pixels. For most windows
6181 this is just the client area of the window, but for some like scrolled
6182 windows it is more or less independent of the screen window size.
6183 """
6184 return _core_.Window_GetVirtualSize(*args, **kwargs)
6185
6186 def GetVirtualSizeTuple(*args, **kwargs):
6187 """
6188 GetVirtualSizeTuple() -> (width, height)
6189
6190 Get the the virtual size of the window in pixels. For most windows
6191 this is just the client area of the window, but for some like scrolled
6192 windows it is more or less independent of the screen window size.
6193 """
6194 return _core_.Window_GetVirtualSizeTuple(*args, **kwargs)
6195
6196 def GetBestVirtualSize(*args, **kwargs):
6197 """
6198 GetBestVirtualSize(self) -> Size
6199
6200 Return the largest of ClientSize and BestSize (as determined by a
6201 sizer, interior children, or other means)
6202 """
6203 return _core_.Window_GetBestVirtualSize(*args, **kwargs)
6204
6205 def Show(*args, **kwargs):
6206 """
6207 Show(self, bool show=True) -> bool
6208
6209 Shows or hides the window. You may need to call Raise for a top level
6210 window if you want to bring it to top, although this is not needed if
6211 Show is called immediately after the frame creation. Returns True if
6212 the window has been shown or hidden or False if nothing was done
6213 because it already was in the requested state.
6214 """
6215 return _core_.Window_Show(*args, **kwargs)
6216
6217 def Hide(*args, **kwargs):
6218 """
6219 Hide(self) -> bool
6220
6221 Equivalent to calling Show(False).
6222 """
6223 return _core_.Window_Hide(*args, **kwargs)
6224
6225 def Enable(*args, **kwargs):
6226 """
6227 Enable(self, bool enable=True) -> bool
6228
6229 Enable or disable the window for user input. Note that when a parent
6230 window is disabled, all of its children are disabled as well and they
6231 are reenabled again when the parent is. Returns true if the window
6232 has been enabled or disabled, false if nothing was done, i.e. if the
6233 window had already been in the specified state.
6234 """
6235 return _core_.Window_Enable(*args, **kwargs)
6236
6237 def Disable(*args, **kwargs):
6238 """
6239 Disable(self) -> bool
6240
6241 Disables the window, same as Enable(false).
6242 """
6243 return _core_.Window_Disable(*args, **kwargs)
6244
6245 def IsShown(*args, **kwargs):
6246 """
6247 IsShown(self) -> bool
6248
6249 Returns true if the window is shown, false if it has been hidden.
6250 """
6251 return _core_.Window_IsShown(*args, **kwargs)
6252
6253 def IsEnabled(*args, **kwargs):
6254 """
6255 IsEnabled(self) -> bool
6256
6257 Returns true if the window is enabled for input, false otherwise.
6258 """
6259 return _core_.Window_IsEnabled(*args, **kwargs)
6260
6261 def SetWindowStyleFlag(*args, **kwargs):
6262 """
6263 SetWindowStyleFlag(self, long style)
6264
79fccf9d
RD
6265 Sets the style of the window. Please note that some styles cannot be
6266 changed after the window creation and that Refresh() might need to be
6267 called after changing the others for the change to take place
6268 immediately.
d55e5bfc
RD
6269 """
6270 return _core_.Window_SetWindowStyleFlag(*args, **kwargs)
6271
6272 def GetWindowStyleFlag(*args, **kwargs):
6273 """
6274 GetWindowStyleFlag(self) -> long
6275
6276 Gets the window style that was passed to the constructor or Create
6277 method.
6278 """
6279 return _core_.Window_GetWindowStyleFlag(*args, **kwargs)
6280
6281 SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag
6282 def HasFlag(*args, **kwargs):
6283 """
6284 HasFlag(self, int flag) -> bool
6285
6286 Test if the given style is set for this window.
6287 """
6288 return _core_.Window_HasFlag(*args, **kwargs)
6289
6290 def IsRetained(*args, **kwargs):
6291 """
6292 IsRetained(self) -> bool
6293
6294 Returns true if the window is retained, false otherwise. Retained
6295 windows are only available on X platforms.
6296 """
6297 return _core_.Window_IsRetained(*args, **kwargs)
6298
6299 def SetExtraStyle(*args, **kwargs):
6300 """
6301 SetExtraStyle(self, long exStyle)
6302
6303 Sets the extra style bits for the window. Extra styles are the less
6304 often used style bits which can't be set with the constructor or with
6305 SetWindowStyleFlag()
6306 """
6307 return _core_.Window_SetExtraStyle(*args, **kwargs)
6308
6309 def GetExtraStyle(*args, **kwargs):
6310 """
6311 GetExtraStyle(self) -> long
6312
6313 Returns the extra style bits for the window.
6314 """
6315 return _core_.Window_GetExtraStyle(*args, **kwargs)
6316
6317 def MakeModal(*args, **kwargs):
6318 """
6319 MakeModal(self, bool modal=True)
6320
6321 Disables all other windows in the application so that the user can
6322 only interact with this window. Passing False will reverse this
6323 effect.
6324 """
6325 return _core_.Window_MakeModal(*args, **kwargs)
6326
6327 def SetThemeEnabled(*args, **kwargs):
6328 """
6329 SetThemeEnabled(self, bool enableTheme)
6330
6331 This function tells a window if it should use the system's "theme"
6332 code to draw the windows' background instead if its own background
6333 drawing code. This will only have an effect on platforms that support
6334 the notion of themes in user defined windows. One such platform is
6335 GTK+ where windows can have (very colourful) backgrounds defined by a
6336 user's selected theme.
6337
6338 Dialogs, notebook pages and the status bar have this flag set to true
6339 by default so that the default look and feel is simulated best.
6340 """
6341 return _core_.Window_SetThemeEnabled(*args, **kwargs)
6342
6343 def GetThemeEnabled(*args, **kwargs):
6344 """
6345 GetThemeEnabled(self) -> bool
6346
6347 Return the themeEnabled flag.
6348 """
6349 return _core_.Window_GetThemeEnabled(*args, **kwargs)
6350
6351 def SetFocus(*args, **kwargs):
6352 """
6353 SetFocus(self)
6354
6355 Set's the focus to this window, allowing it to receive keyboard input.
6356 """
6357 return _core_.Window_SetFocus(*args, **kwargs)
6358
6359 def SetFocusFromKbd(*args, **kwargs):
6360 """
6361 SetFocusFromKbd(self)
6362
6363 Set focus to this window as the result of a keyboard action. Normally
6364 only called internally.
6365 """
6366 return _core_.Window_SetFocusFromKbd(*args, **kwargs)
6367
6368 def FindFocus(*args, **kwargs):
6369 """
c24da6d6 6370 FindFocus() -> Window
d55e5bfc
RD
6371
6372 Returns the window or control that currently has the keyboard focus,
6373 or None.
6374 """
6375 return _core_.Window_FindFocus(*args, **kwargs)
6376
6377 FindFocus = staticmethod(FindFocus)
6378 def AcceptsFocus(*args, **kwargs):
6379 """
6380 AcceptsFocus(self) -> bool
6381
6382 Can this window have focus?
6383 """
6384 return _core_.Window_AcceptsFocus(*args, **kwargs)
6385
6386 def AcceptsFocusFromKeyboard(*args, **kwargs):
6387 """
6388 AcceptsFocusFromKeyboard(self) -> bool
6389
6390 Can this window be given focus by keyboard navigation? if not, the
6391 only way to give it focus (provided it accepts it at all) is to click
6392 it.
6393 """
6394 return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs)
6395
6396 def GetDefaultItem(*args, **kwargs):
6397 """
6398 GetDefaultItem(self) -> Window
6399
6400 Get the default child of this parent, i.e. the one which is activated
6401 by pressing <Enter> such as the OK button on a wx.Dialog.
6402 """
6403 return _core_.Window_GetDefaultItem(*args, **kwargs)
6404
6405 def SetDefaultItem(*args, **kwargs):
6406 """
6407 SetDefaultItem(self, Window child) -> Window
6408
6409 Set this child as default, return the old default.
6410 """
6411 return _core_.Window_SetDefaultItem(*args, **kwargs)
6412
6413 def SetTmpDefaultItem(*args, **kwargs):
6414 """
6415 SetTmpDefaultItem(self, Window win)
6416
6417 Set this child as temporary default
6418 """
6419 return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
6420
908b74cd
RD
6421 def Navigate(*args, **kwargs):
6422 """
6423 Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
6424
a8eff060
RD
6425 Does keyboard navigation from this window to another, by sending a
6426 `wx.NavigationKeyEvent`.
908b74cd
RD
6427 """
6428 return _core_.Window_Navigate(*args, **kwargs)
6429
bf26d883
RD
6430 def MoveAfterInTabOrder(*args, **kwargs):
6431 """
6432 MoveAfterInTabOrder(self, Window win)
6433
6434 Moves this window in the tab navigation order after the specified
6435 sibling window. This means that when the user presses the TAB key on
6436 that other window, the focus switches to this window.
6437
6438 The default tab order is the same as creation order. This function
6439 and `MoveBeforeInTabOrder` allow to change it after creating all the
6440 windows.
6441
6442 """
6443 return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
6444
6445 def MoveBeforeInTabOrder(*args, **kwargs):
6446 """
6447 MoveBeforeInTabOrder(self, Window win)
6448
6449 Same as `MoveAfterInTabOrder` except that it inserts this window just
6450 before win instead of putting it right after it.
6451 """
6452 return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
6453
d55e5bfc
RD
6454 def GetChildren(*args, **kwargs):
6455 """
6456 GetChildren(self) -> PyObject
6457
6458 Returns a list of the window's children. NOTE: Currently this is a
6459 copy of the child window list maintained by the window, so the return
6460 value of this function is only valid as long as the window's children
6461 do not change.
6462 """
6463 return _core_.Window_GetChildren(*args, **kwargs)
6464
6465 def GetParent(*args, **kwargs):
6466 """
6467 GetParent(self) -> Window
6468
6469 Returns the parent window of this window, or None if there isn't one.
6470 """
6471 return _core_.Window_GetParent(*args, **kwargs)
6472
6473 def GetGrandParent(*args, **kwargs):
6474 """
6475 GetGrandParent(self) -> Window
6476
79fccf9d
RD
6477 Returns the parent of the parent of this window, or None if there
6478 isn't one.
d55e5bfc
RD
6479 """
6480 return _core_.Window_GetGrandParent(*args, **kwargs)
6481
6482 def IsTopLevel(*args, **kwargs):
6483 """
6484 IsTopLevel(self) -> bool
6485
6486 Returns true if the given window is a top-level one. Currently all
6487 frames and dialogs are always considered to be top-level windows (even
6488 if they have a parent window).
6489 """
6490 return _core_.Window_IsTopLevel(*args, **kwargs)
6491
6492 def Reparent(*args, **kwargs):
6493 """
6494 Reparent(self, Window newParent) -> bool
6495
6496 Reparents the window, i.e the window will be removed from its current
6497 parent window (e.g. a non-standard toolbar in a wxFrame) and then
6498 re-inserted into another. Available on Windows and GTK. Returns True
6499 if the parent was changed, False otherwise (error or newParent ==
6500 oldParent)
6501 """
6502 return _core_.Window_Reparent(*args, **kwargs)
6503
6504 def AddChild(*args, **kwargs):
6505 """
6506 AddChild(self, Window child)
6507
6508 Adds a child window. This is called automatically by window creation
6509 functions so should not be required by the application programmer.
6510 """
6511 return _core_.Window_AddChild(*args, **kwargs)
6512
6513 def RemoveChild(*args, **kwargs):
6514 """
6515 RemoveChild(self, Window child)
6516
6517 Removes a child window. This is called automatically by window
6518 deletion functions so should not be required by the application
6519 programmer.
6520 """
6521 return _core_.Window_RemoveChild(*args, **kwargs)
6522
6523 def FindWindowById(*args, **kwargs):
6524 """
6525 FindWindowById(self, long winid) -> Window
6526
6527 Find a chld of this window by window ID
6528 """
6529 return _core_.Window_FindWindowById(*args, **kwargs)
6530
6531 def FindWindowByName(*args, **kwargs):
6532 """
6533 FindWindowByName(self, String name) -> Window
6534
6535 Find a child of this window by name
6536 """
6537 return _core_.Window_FindWindowByName(*args, **kwargs)
6538
6539 def GetEventHandler(*args, **kwargs):
6540 """
6541 GetEventHandler(self) -> EvtHandler
6542
6543 Returns the event handler for this window. By default, the window is
6544 its own event handler.
6545 """
6546 return _core_.Window_GetEventHandler(*args, **kwargs)
6547
6548 def SetEventHandler(*args, **kwargs):
6549 """
6550 SetEventHandler(self, EvtHandler handler)
6551
6552 Sets the event handler for this window. An event handler is an object
6553 that is capable of processing the events sent to a window. By default,
6554 the window is its own event handler, but an application may wish to
6555 substitute another, for example to allow central implementation of
6556 event-handling for a variety of different window classes.
6557
79fccf9d 6558 It is usually better to use `wx.Window.PushEventHandler` since this sets
d55e5bfc
RD
6559 up a chain of event handlers, where an event not handled by one event
6560 handler is handed to the next one in the chain.
6561 """
6562 return _core_.Window_SetEventHandler(*args, **kwargs)
6563
6564 def PushEventHandler(*args, **kwargs):
6565 """
6566 PushEventHandler(self, EvtHandler handler)
6567
6568 Pushes this event handler onto the event handler stack for the window.
6569 An event handler is an object that is capable of processing the events
6570 sent to a window. By default, the window is its own event handler, but
6571 an application may wish to substitute another, for example to allow
6572 central implementation of event-handling for a variety of different
6573 window classes.
6574
6575 wx.Window.PushEventHandler allows an application to set up a chain of
6576 event handlers, where an event not handled by one event handler is
79fccf9d 6577 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
d55e5bfc
RD
6578 remove the event handler.
6579 """
6580 return _core_.Window_PushEventHandler(*args, **kwargs)
6581
6582 def PopEventHandler(*args, **kwargs):
6583 """
6584 PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
6585
6586 Removes and returns the top-most event handler on the event handler
6587 stack. If deleteHandler is True then the wx.EvtHandler object will be
6588 destroyed after it is popped.
6589 """
6590 return _core_.Window_PopEventHandler(*args, **kwargs)
6591
6592 def RemoveEventHandler(*args, **kwargs):
6593 """
6594 RemoveEventHandler(self, EvtHandler handler) -> bool
6595
79fccf9d
RD
6596 Find the given handler in the event handler chain and remove (but not
6597 delete) it from the event handler chain, return True if it was found
6598 and False otherwise (this also results in an assert failure so this
6599 function should only be called when the handler is supposed to be
6600 there.)
d55e5bfc
RD
6601 """
6602 return _core_.Window_RemoveEventHandler(*args, **kwargs)
6603
6604 def SetValidator(*args, **kwargs):
6605 """
6606 SetValidator(self, Validator validator)
6607
6608 Deletes the current validator (if any) and sets the window validator,
6609 having called wx.Validator.Clone to create a new validator of this
6610 type.
6611 """
6612 return _core_.Window_SetValidator(*args, **kwargs)
6613
6614 def GetValidator(*args, **kwargs):
6615 """
6616 GetValidator(self) -> Validator
6617
6618 Returns a pointer to the current validator for the window, or None if
6619 there is none.
6620 """
6621 return _core_.Window_GetValidator(*args, **kwargs)
6622
6623 def Validate(*args, **kwargs):
6624 """
6625 Validate(self) -> bool
6626
6627 Validates the current values of the child controls using their
79fccf9d
RD
6628 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6629 style flag set, the method will also call Validate() of all child
6630 windows. Returns false if any of the validations failed.
d55e5bfc
RD
6631 """
6632 return _core_.Window_Validate(*args, **kwargs)
6633
6634 def TransferDataToWindow(*args, **kwargs):
6635 """
6636 TransferDataToWindow(self) -> bool
6637
79fccf9d
RD
6638 Transfers values to child controls from data areas specified by their
6639 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
6640 style flag set, the method will also call TransferDataToWindow() of
6641 all child windows.
d55e5bfc
RD
6642 """
6643 return _core_.Window_TransferDataToWindow(*args, **kwargs)
6644
6645 def TransferDataFromWindow(*args, **kwargs):
6646 """
6647 TransferDataFromWindow(self) -> bool
6648
79fccf9d
RD
6649 Transfers values from child controls to data areas specified by their
6650 validators. Returns false if a transfer failed. If the window has
6651 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
6652 also call TransferDataFromWindow() of all child windows.
d55e5bfc
RD
6653 """
6654 return _core_.Window_TransferDataFromWindow(*args, **kwargs)
6655
6656 def InitDialog(*args, **kwargs):
6657 """
6658 InitDialog(self)
6659
79fccf9d
RD
6660 Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
6661 to the dialog via validators.
d55e5bfc
RD
6662 """
6663 return _core_.Window_InitDialog(*args, **kwargs)
6664
6665 def SetAcceleratorTable(*args, **kwargs):
6666 """
6667 SetAcceleratorTable(self, AcceleratorTable accel)
6668
6669 Sets the accelerator table for this window.
6670 """
6671 return _core_.Window_SetAcceleratorTable(*args, **kwargs)
6672
6673 def GetAcceleratorTable(*args, **kwargs):
6674 """
6675 GetAcceleratorTable(self) -> AcceleratorTable
6676
6677 Gets the accelerator table for this window.
6678 """
6679 return _core_.Window_GetAcceleratorTable(*args, **kwargs)
6680
6681 def RegisterHotKey(*args, **kwargs):
6682 """
6683 RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
6684
6685 Registers a system wide hotkey. Every time the user presses the hotkey
6686 registered here, this window will receive a hotkey event. It will
6687 receive the event even if the application is in the background and
6688 does not have the input focus because the user is working with some
6689 other application. To bind an event handler function to this hotkey
6690 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
6691 hotkey was registered successfully.
6692 """
6693 return _core_.Window_RegisterHotKey(*args, **kwargs)
6694
6695 def UnregisterHotKey(*args, **kwargs):
6696 """
6697 UnregisterHotKey(self, int hotkeyId) -> bool
6698
6699 Unregisters a system wide hotkey.
6700 """
6701 return _core_.Window_UnregisterHotKey(*args, **kwargs)
6702
6703 def ConvertDialogPointToPixels(*args, **kwargs):
6704 """
6705 ConvertDialogPointToPixels(self, Point pt) -> Point
6706
6707 Converts a point or size from dialog units to pixels. Dialog units
6708 are used for maintaining a dialog's proportions even if the font
6709 changes. For the x dimension, the dialog units are multiplied by the
6710 average character width and then divided by 4. For the y dimension,
6711 the dialog units are multiplied by the average character height and
6712 then divided by 8.
6713 """
6714 return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs)
6715
6716 def ConvertDialogSizeToPixels(*args, **kwargs):
6717 """
6718 ConvertDialogSizeToPixels(self, Size sz) -> Size
6719
6720 Converts a point or size from dialog units to pixels. Dialog units
6721 are used for maintaining a dialog's proportions even if the font
6722 changes. For the x dimension, the dialog units are multiplied by the
6723 average character width and then divided by 4. For the y dimension,
6724 the dialog units are multiplied by the average character height and
6725 then divided by 8.
6726 """
6727 return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs)
6728
6729 def DLG_PNT(*args, **kwargs):
6730 """
6731 DLG_PNT(self, Point pt) -> Point
6732
6733 Converts a point or size from dialog units to pixels. Dialog units
6734 are used for maintaining a dialog's proportions even if the font
6735 changes. For the x dimension, the dialog units are multiplied by the
6736 average character width and then divided by 4. For the y dimension,
6737 the dialog units are multiplied by the average character height and
6738 then divided by 8.
6739 """
6740 return _core_.Window_DLG_PNT(*args, **kwargs)
6741
6742 def DLG_SZE(*args, **kwargs):
6743 """
6744 DLG_SZE(self, Size sz) -> Size
6745
6746 Converts a point or size from dialog units to pixels. Dialog units
6747 are used for maintaining a dialog's proportions even if the font
6748 changes. For the x dimension, the dialog units are multiplied by the
6749 average character width and then divided by 4. For the y dimension,
6750 the dialog units are multiplied by the average character height and
6751 then divided by 8.
6752 """
6753 return _core_.Window_DLG_SZE(*args, **kwargs)
6754
6755 def ConvertPixelPointToDialog(*args, **kwargs):
6756 """ConvertPixelPointToDialog(self, Point pt) -> Point"""
6757 return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs)
6758
6759 def ConvertPixelSizeToDialog(*args, **kwargs):
6760 """ConvertPixelSizeToDialog(self, Size sz) -> Size"""
6761 return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs)
6762
6763 def WarpPointer(*args, **kwargs):
6764 """
6765 WarpPointer(self, int x, int y)
6766
6767 Moves the pointer to the given position on the window.
6768
6769 NOTE: This function is not supported under Mac because Apple Human
6770 Interface Guidelines forbid moving the mouse cursor programmatically.
6771 """
6772 return _core_.Window_WarpPointer(*args, **kwargs)
6773
6774 def CaptureMouse(*args, **kwargs):
6775 """
6776 CaptureMouse(self)
6777
6778 Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
6779 release the capture.
6780
6781 Note that wxWindows maintains the stack of windows having captured the
6782 mouse and when the mouse is released the capture returns to the window
6783 which had had captured it previously and it is only really released if
6784 there were no previous window. In particular, this means that you must
6785 release the mouse as many times as you capture it.
6786 """
6787 return _core_.Window_CaptureMouse(*args, **kwargs)
6788
6789 def ReleaseMouse(*args, **kwargs):
6790 """
6791 ReleaseMouse(self)
6792
6793 Releases mouse input captured with wx.Window.CaptureMouse.
6794 """
6795 return _core_.Window_ReleaseMouse(*args, **kwargs)
6796
6797 def GetCapture(*args, **kwargs):
6798 """
c24da6d6 6799 GetCapture() -> Window
d55e5bfc
RD
6800
6801 Returns the window which currently captures the mouse or None
6802 """
6803 return _core_.Window_GetCapture(*args, **kwargs)
6804
6805 GetCapture = staticmethod(GetCapture)
6806 def HasCapture(*args, **kwargs):
6807 """
6808 HasCapture(self) -> bool
6809
6810 Returns true if this window has the current mouse capture.
6811 """
6812 return _core_.Window_HasCapture(*args, **kwargs)
6813
6814 def Refresh(*args, **kwargs):
6815 """
6816 Refresh(self, bool eraseBackground=True, Rect rect=None)
6817
6818 Mark the specified rectangle (or the whole window) as "dirty" so it
6819 will be repainted. Causes an EVT_PAINT event to be generated and sent
6820 to the window.
6821 """
6822 return _core_.Window_Refresh(*args, **kwargs)
6823
6824 def RefreshRect(*args, **kwargs):
6825 """
6826 RefreshRect(self, Rect rect)
6827
6828 Redraws the contents of the given rectangle: the area inside it will
6829 be repainted. This is the same as Refresh but has a nicer syntax.
6830 """
6831 return _core_.Window_RefreshRect(*args, **kwargs)
6832
6833 def Update(*args, **kwargs):
6834 """
6835 Update(self)
6836
6837 Calling this method immediately repaints the invalidated area of the
6838 window instead of waiting for the EVT_PAINT event to happen, (normally
6839 this would usually only happen when the flow of control returns to the
6840 event loop.) Notice that this function doesn't refresh the window and
6841 does nothing if the window has been already repainted. Use Refresh
6842 first if you want to immediately redraw the window (or some portion of
6843 it) unconditionally.
6844 """
6845 return _core_.Window_Update(*args, **kwargs)
6846
6847 def ClearBackground(*args, **kwargs):
6848 """
6849 ClearBackground(self)
6850
6851 Clears the window by filling it with the current background
6852 colour. Does not cause an erase background event to be generated.
6853 """
6854 return _core_.Window_ClearBackground(*args, **kwargs)
6855
6856 def Freeze(*args, **kwargs):
6857 """
6858 Freeze(self)
6859
79fccf9d
RD
6860 Freezes the window or, in other words, prevents any updates from
6861 taking place on screen, the window is not redrawn at all. Thaw must be
6862 called to reenable window redrawing. Calls to Freeze/Thaw may be
6863 nested, with the actual Thaw being delayed until all the nesting has
6864 been undone.
d55e5bfc
RD
6865
6866 This method is useful for visual appearance optimization (for example,
6867 it is a good idea to use it before inserting large amount of text into
6868 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
6869 for all controls so it is mostly just a hint to wxWindows and not a
6870 mandatory directive.
6871 """
6872 return _core_.Window_Freeze(*args, **kwargs)
6873
6874 def Thaw(*args, **kwargs):
6875 """
6876 Thaw(self)
6877
6878 Reenables window updating after a previous call to Freeze. Calls to
79fccf9d
RD
6879 Freeze/Thaw may be nested, so Thaw must be called the same number of
6880 times that Freeze was before the window will be updated.
d55e5bfc
RD
6881 """
6882 return _core_.Window_Thaw(*args, **kwargs)
6883
6884 def PrepareDC(*args, **kwargs):
6885 """
6886 PrepareDC(self, DC dc)
6887
6888 Call this function to prepare the device context for drawing a
6889 scrolled image. It sets the device origin according to the current
6890 scroll position.
6891 """
6892 return _core_.Window_PrepareDC(*args, **kwargs)
6893
6894 def GetUpdateRegion(*args, **kwargs):
6895 """
6896 GetUpdateRegion(self) -> Region
6897
6898 Returns the region specifying which parts of the window have been
6899 damaged. Should only be called within an EVT_PAINT handler.
6900 """
6901 return _core_.Window_GetUpdateRegion(*args, **kwargs)
6902
6903 def GetUpdateClientRect(*args, **kwargs):
6904 """
6905 GetUpdateClientRect(self) -> Rect
6906
6907 Get the update rectangle region bounding box in client coords.
6908 """
6909 return _core_.Window_GetUpdateClientRect(*args, **kwargs)
6910
6911 def IsExposed(*args, **kwargs):
6912 """
6913 IsExposed(self, int x, int y, int w=1, int h=1) -> bool
6914
6915 Returns true if the given point or rectangle area has been exposed
6916 since the last repaint. Call this in an paint event handler to
6917 optimize redrawing by only redrawing those areas, which have been
6918 exposed.
6919 """
6920 return _core_.Window_IsExposed(*args, **kwargs)
6921
6922 def IsExposedPoint(*args, **kwargs):
6923 """
6924 IsExposedPoint(self, Point pt) -> bool
6925
6926 Returns true if the given point or rectangle area has been exposed
6927 since the last repaint. Call this in an paint event handler to
6928 optimize redrawing by only redrawing those areas, which have been
6929 exposed.
6930 """
6931 return _core_.Window_IsExposedPoint(*args, **kwargs)
6932
6933 def IsExposedRect(*args, **kwargs):
6934 """
6935 IsExposedRect(self, Rect rect) -> bool
6936
6937 Returns true if the given point or rectangle area has been exposed
6938 since the last repaint. Call this in an paint event handler to
6939 optimize redrawing by only redrawing those areas, which have been
6940 exposed.
6941 """
6942 return _core_.Window_IsExposedRect(*args, **kwargs)
6943
6944 def GetDefaultAttributes(*args, **kwargs):
6945 """
6946 GetDefaultAttributes(self) -> VisualAttributes
6947
79fccf9d
RD
6948 Get the default attributes for an instance of this class. This is
6949 useful if you want to use the same font or colour in your own control
6950 as in a standard control -- which is a much better idea than hard
6951 coding specific colours or fonts which might look completely out of
caef1a4d 6952 place on the user's system, especially if it uses themes.
d55e5bfc
RD
6953 """
6954 return _core_.Window_GetDefaultAttributes(*args, **kwargs)
6955
6956 def GetClassDefaultAttributes(*args, **kwargs):
6957 """
c24da6d6 6958 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
d55e5bfc 6959
79fccf9d
RD
6960 Get the default attributes for this class. This is useful if you want
6961 to use the same font or colour in your own control as in a standard
6962 control -- which is a much better idea than hard coding specific
caef1a4d
RD
6963 colours or fonts which might look completely out of place on the
6964 user's system, especially if it uses themes.
d55e5bfc
RD
6965
6966 The variant parameter is only relevant under Mac currently and is
79fccf9d 6967 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
6968 the returned font. See `wx.Window.SetWindowVariant` for more about
6969 this.
d55e5bfc
RD
6970 """
6971 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
6972
6973 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
6974 def SetBackgroundColour(*args, **kwargs):
6975 """
6976 SetBackgroundColour(self, Colour colour) -> bool
6977
6978 Sets the background colour of the window. Returns True if the colour
6979 was changed. The background colour is usually painted by the default
6980 EVT_ERASE_BACKGROUND event handler function under Windows and
f8167d6e
RD
6981 automatically under GTK. Using `wx.NullColour` will reset the window
6982 to the default background colour.
d55e5bfc 6983
caef1a4d 6984 Note that setting the background colour may not cause an immediate
f8167d6e 6985 refresh, so you may wish to call `ClearBackground` or `Refresh` after
d55e5bfc
RD
6986 calling this function.
6987
f8167d6e
RD
6988 Using this function will disable attempts to use themes for this
6989 window, if the system supports them. Use with care since usually the
6990 themes represent the appearance chosen by the user to be used for all
6991 applications on the system.
d55e5bfc
RD
6992 """
6993 return _core_.Window_SetBackgroundColour(*args, **kwargs)
6994
412d302d
RD
6995 def SetOwnBackgroundColour(*args, **kwargs):
6996 """SetOwnBackgroundColour(self, Colour colour)"""
6997 return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
d55e5bfc
RD
6998
6999 def SetForegroundColour(*args, **kwargs):
7000 """
7001 SetForegroundColour(self, Colour colour) -> bool
7002
7003 Sets the foreground colour of the window. Returns True is the colour
7004 was changed. The interpretation of foreground colour is dependent on
7005 the window class; it may be the text colour or other colour, or it may
7006 not be used at all.
7007 """
7008 return _core_.Window_SetForegroundColour(*args, **kwargs)
7009
fa47d7a7
VS
7010 def SetOwnForegroundColour(*args, **kwargs):
7011 """SetOwnForegroundColour(self, Colour colour)"""
7012 return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
d55e5bfc
RD
7013
7014 def GetBackgroundColour(*args, **kwargs):
7015 """
7016 GetBackgroundColour(self) -> Colour
7017
7018 Returns the background colour of the window.
7019 """
7020 return _core_.Window_GetBackgroundColour(*args, **kwargs)
7021
7022 def GetForegroundColour(*args, **kwargs):
7023 """
7024 GetForegroundColour(self) -> Colour
7025
7026 Returns the foreground colour of the window. The interpretation of
7027 foreground colour is dependent on the window class; it may be the text
7028 colour or other colour, or it may not be used at all.
7029 """
7030 return _core_.Window_GetForegroundColour(*args, **kwargs)
7031
0f63ec68
RD
7032 def SetBackgroundStyle(*args, **kwargs):
7033 """
7034 SetBackgroundStyle(self, int style) -> bool
7035
7036 Returns the background style of the window. The background style
7037 indicates how the background of the window is drawn.
7038
7039 ====================== ========================================
7040 wx.BG_STYLE_SYSTEM The background colour or pattern should
7041 be determined by the system
7042 wx.BG_STYLE_COLOUR The background should be a solid colour
7043 wx.BG_STYLE_CUSTOM The background will be implemented by the
7044 application.
7045 ====================== ========================================
7046
7047 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
7048 a custom background, such as a tiled bitmap. Currently the style has
7049 no effect on other platforms.
7050
7051 :see: `GetBackgroundStyle`, `SetBackgroundColour`
7052 """
7053 return _core_.Window_SetBackgroundStyle(*args, **kwargs)
7054
7055 def GetBackgroundStyle(*args, **kwargs):
7056 """
7057 GetBackgroundStyle(self) -> int
7058
7059 Returns the background style of the window.
7060
7061 :see: `SetBackgroundStyle`
7062 """
7063 return _core_.Window_GetBackgroundStyle(*args, **kwargs)
7064
d55e5bfc
RD
7065 def SetCursor(*args, **kwargs):
7066 """
7067 SetCursor(self, Cursor cursor) -> bool
7068
7069 Sets the window's cursor. Notice that the window cursor also sets it
7070 for the children of the window implicitly.
7071
7072 The cursor may be wx.NullCursor in which case the window cursor will
7073 be reset back to default.
7074 """
7075 return _core_.Window_SetCursor(*args, **kwargs)
7076
7077 def GetCursor(*args, **kwargs):
7078 """
7079 GetCursor(self) -> Cursor
7080
7081 Return the cursor associated with this window.
7082 """
7083 return _core_.Window_GetCursor(*args, **kwargs)
7084
7085 def SetFont(*args, **kwargs):
7086 """
7087 SetFont(self, Font font) -> bool
7088
7089 Sets the font for this window.
7090 """
7091 return _core_.Window_SetFont(*args, **kwargs)
7092
fa47d7a7
VS
7093 def SetOwnFont(*args, **kwargs):
7094 """SetOwnFont(self, Font font)"""
7095 return _core_.Window_SetOwnFont(*args, **kwargs)
d55e5bfc
RD
7096
7097 def GetFont(*args, **kwargs):
7098 """
7099 GetFont(self) -> Font
7100
7101 Returns the default font used for this window.
7102 """
7103 return _core_.Window_GetFont(*args, **kwargs)
7104
7105 def SetCaret(*args, **kwargs):
7106 """
7107 SetCaret(self, Caret caret)
7108
7109 Sets the caret associated with the window.
7110 """
7111 return _core_.Window_SetCaret(*args, **kwargs)
7112
7113 def GetCaret(*args, **kwargs):
7114 """
7115 GetCaret(self) -> Caret
7116
7117 Returns the caret associated with the window.
7118 """
7119 return _core_.Window_GetCaret(*args, **kwargs)
7120
7121 def GetCharHeight(*args, **kwargs):
7122 """
7123 GetCharHeight(self) -> int
7124
7125 Get the (average) character size for the current font.
7126 """
7127 return _core_.Window_GetCharHeight(*args, **kwargs)
7128
7129 def GetCharWidth(*args, **kwargs):
7130 """
7131 GetCharWidth(self) -> int
7132
7133 Get the (average) character size for the current font.
7134 """
7135 return _core_.Window_GetCharWidth(*args, **kwargs)
7136
7137 def GetTextExtent(*args, **kwargs):
a8eff060
RD
7138 """
7139 GetTextExtent(String string) -> (width, height)
7140
7141 Get the width and height of the text using the current font.
7142 """
d55e5bfc
RD
7143 return _core_.Window_GetTextExtent(*args, **kwargs)
7144
7145 def GetFullTextExtent(*args, **kwargs):
7146 """
7147 GetFullTextExtent(String string, Font font=None) ->
7148 (width, height, descent, externalLeading)
7149
7150 Get the width, height, decent and leading of the text using the
7151 current or specified font.
7152 """
7153 return _core_.Window_GetFullTextExtent(*args, **kwargs)
7154
7155 def ClientToScreenXY(*args, **kwargs):
7156 """
7157 ClientToScreenXY(int x, int y) -> (x,y)
7158
7159 Converts to screen coordinates from coordinates relative to this window.
7160 """
7161 return _core_.Window_ClientToScreenXY(*args, **kwargs)
7162
7163 def ScreenToClientXY(*args, **kwargs):
7164 """
7165 ScreenToClientXY(int x, int y) -> (x,y)
7166
7167 Converts from screen to client window coordinates.
7168 """
7169 return _core_.Window_ScreenToClientXY(*args, **kwargs)
7170
7171 def ClientToScreen(*args, **kwargs):
7172 """
7173 ClientToScreen(self, Point pt) -> Point
7174
7175 Converts to screen coordinates from coordinates relative to this window.
7176 """
7177 return _core_.Window_ClientToScreen(*args, **kwargs)
7178
7179 def ScreenToClient(*args, **kwargs):
7180 """
7181 ScreenToClient(self, Point pt) -> Point
7182
7183 Converts from screen to client window coordinates.
7184 """
7185 return _core_.Window_ScreenToClient(*args, **kwargs)
7186
7187 def HitTestXY(*args, **kwargs):
7188 """
7189 HitTestXY(self, int x, int y) -> int
7190
7191 Test where the given (in client coords) point lies
7192 """
7193 return _core_.Window_HitTestXY(*args, **kwargs)
7194
7195 def HitTest(*args, **kwargs):
7196 """
7197 HitTest(self, Point pt) -> int
7198
7199 Test where the given (in client coords) point lies
7200 """
7201 return _core_.Window_HitTest(*args, **kwargs)
7202
7203 def GetBorder(*args):
7204 """
7205 GetBorder(self, long flags) -> int
7206 GetBorder(self) -> int
7207
7208 Get border for the flags of this window
7209 """
7210 return _core_.Window_GetBorder(*args)
7211
7212 def UpdateWindowUI(*args, **kwargs):
7213 """
7214 UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
7215
7216 This function sends EVT_UPDATE_UI events to the window. The particular
7217 implementation depends on the window; for example a wx.ToolBar will
7218 send an update UI event for each toolbar button, and a wx.Frame will
7219 send an update UI event for each menubar menu item. You can call this
7220 function from your application to ensure that your UI is up-to-date at
7221 a particular point in time (as far as your EVT_UPDATE_UI handlers are
7222 concerned). This may be necessary if you have called
7223 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
7224 limit the overhead that wxWindows incurs by sending update UI events
7225 in idle time.
d55e5bfc
RD
7226 """
7227 return _core_.Window_UpdateWindowUI(*args, **kwargs)
7228
7229 def PopupMenuXY(*args, **kwargs):
7230 """
7a0b95b0 7231 PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
d55e5bfc 7232
7a0b95b0
RD
7233 Pops up the given menu at the specified coordinates, relative to this window,
7234 and returns control when the user has dismissed the menu. If a menu item is
7235 selected, the corresponding menu event is generated and will be processed as
7236 usual. If the default position is given then the current position of the
7237 mouse cursor will be used.
d55e5bfc
RD
7238 """
7239 return _core_.Window_PopupMenuXY(*args, **kwargs)
7240
7241 def PopupMenu(*args, **kwargs):
7242 """
7a0b95b0 7243 PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
d55e5bfc 7244
7a0b95b0
RD
7245 Pops up the given menu at the specified coordinates, relative to this window,
7246 and returns control when the user has dismissed the menu. If a menu item is
7247 selected, the corresponding menu event is generated and will be processed as
7248 usual. If the default position is given then the current position of the
7249 mouse cursor will be used.
d55e5bfc
RD
7250 """
7251 return _core_.Window_PopupMenu(*args, **kwargs)
7252
7253 def GetHandle(*args, **kwargs):
7254 """
7255 GetHandle(self) -> long
7256
7257 Returns the platform-specific handle (as a long integer) of the
7258 physical window. Currently on wxMac it returns the handle of the
7259 toplevel parent of the window.
7260 """
7261 return _core_.Window_GetHandle(*args, **kwargs)
7262
629e65c2
RD
7263 def AssociateHandle(*args, **kwargs):
7264 """
7265 AssociateHandle(self, long handle)
7266
7267 Associate the window with a new native handle
7268 """
7269 return _core_.Window_AssociateHandle(*args, **kwargs)
7270
7271 def DissociateHandle(*args, **kwargs):
7272 """
7273 DissociateHandle(self)
7274
7275 Dissociate the current native handle from the window
7276 """
7277 return _core_.Window_DissociateHandle(*args, **kwargs)
7278
d55e5bfc
RD
7279 def OnPaint(*args, **kwargs):
7280 """OnPaint(self, PaintEvent event)"""
7281 return _core_.Window_OnPaint(*args, **kwargs)
7282
7283 def HasScrollbar(*args, **kwargs):
7284 """
7285 HasScrollbar(self, int orient) -> bool
7286
7287 Does the window have the scrollbar for this orientation?
7288 """
7289 return _core_.Window_HasScrollbar(*args, **kwargs)
7290
7291 def SetScrollbar(*args, **kwargs):
7292 """
79fccf9d 7293 SetScrollbar(self, int orientation, int position, int thumbSize, int range,
d55e5bfc
RD
7294 bool refresh=True)
7295
7296 Sets the scrollbar properties of a built-in scrollbar.
d55e5bfc
RD
7297 """
7298 return _core_.Window_SetScrollbar(*args, **kwargs)
7299
7300 def SetScrollPos(*args, **kwargs):
7301 """
7302 SetScrollPos(self, int orientation, int pos, bool refresh=True)
7303
7304 Sets the position of one of the built-in scrollbars.
7305 """
7306 return _core_.Window_SetScrollPos(*args, **kwargs)
7307
7308 def GetScrollPos(*args, **kwargs):
7309 """
7310 GetScrollPos(self, int orientation) -> int
7311
7312 Returns the built-in scrollbar position.
7313 """
7314 return _core_.Window_GetScrollPos(*args, **kwargs)
7315
7316 def GetScrollThumb(*args, **kwargs):
7317 """
7318 GetScrollThumb(self, int orientation) -> int
7319
7320 Returns the built-in scrollbar thumb size.
7321 """
7322 return _core_.Window_GetScrollThumb(*args, **kwargs)
7323
7324 def GetScrollRange(*args, **kwargs):
7325 """
7326 GetScrollRange(self, int orientation) -> int
7327
7328 Returns the built-in scrollbar range.
7329 """
7330 return _core_.Window_GetScrollRange(*args, **kwargs)
7331
7332 def ScrollWindow(*args, **kwargs):
7333 """
7334 ScrollWindow(self, int dx, int dy, Rect rect=None)
7335
7336 Physically scrolls the pixels in the window and move child windows
7337 accordingly. Use this function to optimise your scrolling
7338 implementations, to minimise the area that must be redrawn. Note that
7339 it is rarely required to call this function from a user program.
d55e5bfc
RD
7340 """
7341 return _core_.Window_ScrollWindow(*args, **kwargs)
7342
7343 def ScrollLines(*args, **kwargs):
7344 """
7345 ScrollLines(self, int lines) -> bool
7346
7347 If the platform and window class supports it, scrolls the window by
7348 the given number of lines down, if lines is positive, or up if lines
7349 is negative. Returns True if the window was scrolled, False if it was
7350 already on top/bottom and nothing was done.
7351 """
7352 return _core_.Window_ScrollLines(*args, **kwargs)
7353
7354 def ScrollPages(*args, **kwargs):
7355 """
7356 ScrollPages(self, int pages) -> bool
7357
79fccf9d 7358 If the platform and window class supports it, scrolls the window by
d55e5bfc
RD
7359 the given number of pages down, if pages is positive, or up if pages
7360 is negative. Returns True if the window was scrolled, False if it was
7361 already on top/bottom and nothing was done.
7362 """
7363 return _core_.Window_ScrollPages(*args, **kwargs)
7364
7365 def LineUp(*args, **kwargs):
7366 """
7367 LineUp(self) -> bool
7368
7369 This is just a wrapper for ScrollLines(-1).
7370 """
7371 return _core_.Window_LineUp(*args, **kwargs)
7372
7373 def LineDown(*args, **kwargs):
7374 """
7375 LineDown(self) -> bool
7376
7377 This is just a wrapper for ScrollLines(1).
7378 """
7379 return _core_.Window_LineDown(*args, **kwargs)
7380
7381 def PageUp(*args, **kwargs):
7382 """
7383 PageUp(self) -> bool
7384
7385 This is just a wrapper for ScrollPages(-1).
7386 """
7387 return _core_.Window_PageUp(*args, **kwargs)
7388
7389 def PageDown(*args, **kwargs):
7390 """
7391 PageDown(self) -> bool
7392
7393 This is just a wrapper for ScrollPages(1).
7394 """
7395 return _core_.Window_PageDown(*args, **kwargs)
7396
7397 def SetHelpText(*args, **kwargs):
7398 """
7399 SetHelpText(self, String text)
7400
7401 Sets the help text to be used as context-sensitive help for this
7402 window. Note that the text is actually stored by the current
7403 wxHelpProvider implementation, and not in the window object itself.
7404 """
7405 return _core_.Window_SetHelpText(*args, **kwargs)
7406
7407 def SetHelpTextForId(*args, **kwargs):
7408 """
7409 SetHelpTextForId(self, String text)
7410
7411 Associate this help text with all windows with the same id as this
7412 one.
7413 """
7414 return _core_.Window_SetHelpTextForId(*args, **kwargs)
7415
7416 def GetHelpText(*args, **kwargs):
7417 """
7418 GetHelpText(self) -> String
7419
7420 Gets the help text to be used as context-sensitive help for this
7421 window. Note that the text is actually stored by the current
7422 wxHelpProvider implementation, and not in the window object itself.
7423 """
7424 return _core_.Window_GetHelpText(*args, **kwargs)
7425
7426 def SetToolTipString(*args, **kwargs):
7427 """
7428 SetToolTipString(self, String tip)
7429
7430 Attach a tooltip to the window.
7431 """
7432 return _core_.Window_SetToolTipString(*args, **kwargs)
7433
7434 def SetToolTip(*args, **kwargs):
7435 """
7436 SetToolTip(self, ToolTip tip)
7437
7438 Attach a tooltip to the window.
7439 """
7440 return _core_.Window_SetToolTip(*args, **kwargs)
7441
7442 def GetToolTip(*args, **kwargs):
7443 """
7444 GetToolTip(self) -> ToolTip
7445
7446 get the associated tooltip or None if none
7447 """
7448 return _core_.Window_GetToolTip(*args, **kwargs)
7449
7450 def SetDropTarget(*args, **kwargs):
7451 """
7452 SetDropTarget(self, DropTarget dropTarget)
7453
7454 Associates a drop target with this window. If the window already has
7455 a drop target, it is deleted.
7456 """
7457 return _core_.Window_SetDropTarget(*args, **kwargs)
7458
7459 def GetDropTarget(*args, **kwargs):
7460 """
7461 GetDropTarget(self) -> DropTarget
7462
7463 Returns the associated drop target, which may be None.
7464 """
7465 return _core_.Window_GetDropTarget(*args, **kwargs)
7466
7467 def DragAcceptFiles(*args, **kwargs):
7468 """
7469 DragAcceptFiles(self, bool accept)
7470
7471 Enables or disables eligibility for drop file events, EVT_DROP_FILES.
7472 Only available on Windows.
7473 """
7474 return _core_.Window_DragAcceptFiles(*args, **kwargs)
7475
7476 def SetConstraints(*args, **kwargs):
7477 """
7478 SetConstraints(self, LayoutConstraints constraints)
7479
7480 Sets the window to have the given layout constraints. If an existing
7481 layout constraints object is already owned by the window, it will be
7482 deleted. Pass None to disassociate and delete the window's current
7483 constraints.
7484
7485 You must call SetAutoLayout to tell a window to use the constraints
7486 automatically in its default EVT_SIZE handler; otherwise, you must
7487 handle EVT_SIZE yourself and call Layout() explicitly. When setting
7488 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
7489 effect.
7490 """
7491 return _core_.Window_SetConstraints(*args, **kwargs)
7492
7493 def GetConstraints(*args, **kwargs):
7494 """
7495 GetConstraints(self) -> LayoutConstraints
7496
7497 Returns a pointer to the window's layout constraints, or None if there
7498 are none.
7499 """
7500 return _core_.Window_GetConstraints(*args, **kwargs)
7501
7502 def SetAutoLayout(*args, **kwargs):
7503 """
7504 SetAutoLayout(self, bool autoLayout)
7505
7506 Determines whether the Layout function will be called automatically
7507 when the window is resized. It is called implicitly by SetSizer but
7508 if you use SetConstraints you should call it manually or otherwise the
7509 window layout won't be correctly updated when its size changes.
7510 """
7511 return _core_.Window_SetAutoLayout(*args, **kwargs)
7512
7513 def GetAutoLayout(*args, **kwargs):
7514 """
7515 GetAutoLayout(self) -> bool
7516
7517 Returns the current autoLayout setting
7518 """
7519 return _core_.Window_GetAutoLayout(*args, **kwargs)
7520
7521 def Layout(*args, **kwargs):
7522 """
7523 Layout(self) -> bool
7524
7525 Invokes the constraint-based layout algorithm or the sizer-based
7526 algorithm for this window. See SetAutoLayout: when auto layout is on,
7527 this function gets called automatically by the default EVT_SIZE
7528 handler when the window is resized.
7529 """
7530 return _core_.Window_Layout(*args, **kwargs)
7531
7532 def SetSizer(*args, **kwargs):
7533 """
7534 SetSizer(self, Sizer sizer, bool deleteOld=True)
7535
7536 Sets the window to have the given layout sizer. The window will then
7537 own the object, and will take care of its deletion. If an existing
7538 layout sizer object is already owned by the window, it will be deleted
7539 if the deleteOld parameter is true. Note that this function will also
7540 call SetAutoLayout implicitly with a True parameter if the sizer is
7541 non-NoneL and False otherwise.
7542 """
7543 return _core_.Window_SetSizer(*args, **kwargs)
7544
7545 def SetSizerAndFit(*args, **kwargs):
7546 """
7547 SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
7548
7549 The same as SetSizer, except it also sets the size hints for the
7550 window based on the sizer's minimum size.
7551 """
7552 return _core_.Window_SetSizerAndFit(*args, **kwargs)
7553
7554 def GetSizer(*args, **kwargs):
7555 """
7556 GetSizer(self) -> Sizer
7557
7558 Return the sizer associated with the window by a previous call to
7559 SetSizer or None if there isn't one.
7560 """
7561 return _core_.Window_GetSizer(*args, **kwargs)
7562
7563 def SetContainingSizer(*args, **kwargs):
7564 """
7565 SetContainingSizer(self, Sizer sizer)
7566
7567 This normally does not need to be called by application code. It is
7568 called internally when a window is added to a sizer, and is used so
7569 the window can remove itself from the sizer when it is destroyed.
7570 """
7571 return _core_.Window_SetContainingSizer(*args, **kwargs)
7572
7573 def GetContainingSizer(*args, **kwargs):
7574 """
7575 GetContainingSizer(self) -> Sizer
7576
7577 Return the sizer that this window is a member of, if any, otherwise None.
7578 """
7579 return _core_.Window_GetContainingSizer(*args, **kwargs)
7580
7581 def InheritAttributes(*args, **kwargs):
7582 """
7583 InheritAttributes(self)
7584
79fccf9d
RD
7585 This function is (or should be, in case of custom controls) called
7586 during window creation to intelligently set up the window visual
7587 attributes, that is the font and the foreground and background
7588 colours.
7589
7590 By 'intelligently' the following is meant: by default, all windows use
7591 their own default attributes. However if some of the parent's
7592 attributes are explicitly changed (that is, using SetFont and not
fa47d7a7 7593 SetOwnFont) and if the corresponding attribute hadn't been
79fccf9d
RD
7594 explicitly set for this window itself, then this window takes the same
7595 value as used by the parent. In addition, if the window overrides
7596 ShouldInheritColours to return false, the colours will not be changed
7597 no matter what and only the font might.
7598
7599 This rather complicated logic is necessary in order to accomodate the
7600 different usage scenarius. The most common one is when all default
7601 attributes are used and in this case, nothing should be inherited as
7602 in modern GUIs different controls use different fonts (and colours)
7603 than their siblings so they can't inherit the same value from the
7604 parent. However it was also deemed desirable to allow to simply change
7605 the attributes of all children at once by just changing the font or
7606 colour of their common parent, hence in this case we do inherit the
7607 parents attributes.
7608
d55e5bfc
RD
7609 """
7610 return _core_.Window_InheritAttributes(*args, **kwargs)
7611
7612 def ShouldInheritColours(*args, **kwargs):
7613 """
7614 ShouldInheritColours(self) -> bool
7615
7616 Return true from here to allow the colours of this window to be
79fccf9d
RD
7617 changed by InheritAttributes, returning false forbids inheriting them
7618 from the parent window.
d55e5bfc 7619
79fccf9d
RD
7620 The base class version returns false, but this method is overridden in
7621 wxControl where it returns true.
d55e5bfc
RD
7622 """
7623 return _core_.Window_ShouldInheritColours(*args, **kwargs)
7624
7625 def PostCreate(self, pre):
7626 """
7627 Phase 3 of the 2-phase create <wink!>
7628 Call this method after precreating the window with the 2-phase create method.
7629 """
7630 self.this = pre.this
7631 self.thisown = pre.thisown
7632 pre.thisown = 0
7633 if hasattr(self, '_setOORInfo'):
7634 self._setOORInfo(self)
7635 if hasattr(self, '_setCallbackInfo'):
7636 self._setCallbackInfo(self, self.__class__)
7637
7638
7639class WindowPtr(Window):
7640 def __init__(self, this):
7641 self.this = this
7642 if not hasattr(self,"thisown"): self.thisown = 0
7643 self.__class__ = Window
7644_core_.Window_swigregister(WindowPtr)
7645
7646def PreWindow(*args, **kwargs):
7647 """
7648 PreWindow() -> Window
7649
7650 Precreate a Window for 2-phase creation.
7651 """
7652 val = _core_.new_PreWindow(*args, **kwargs)
7653 val.thisown = 1
7654 return val
7655
7656def Window_NewControlId(*args, **kwargs):
7657 """
7658 Window_NewControlId() -> int
7659
7660 Generate a control id for the controls which were not given one.
7661 """
7662 return _core_.Window_NewControlId(*args, **kwargs)
7663
7664def Window_NextControlId(*args, **kwargs):
7665 """
7666 Window_NextControlId(int winid) -> int
7667
7668 Get the id of the control following the one with the given
79fccf9d 7669 autogenerated) id
d55e5bfc
RD
7670 """
7671 return _core_.Window_NextControlId(*args, **kwargs)
7672
7673def Window_PrevControlId(*args, **kwargs):
7674 """
7675 Window_PrevControlId(int winid) -> int
7676
7677 Get the id of the control preceding the one with the given
79fccf9d 7678 autogenerated) id
d55e5bfc
RD
7679 """
7680 return _core_.Window_PrevControlId(*args, **kwargs)
7681
7682def Window_FindFocus(*args, **kwargs):
7683 """
7684 Window_FindFocus() -> Window
7685
7686 Returns the window or control that currently has the keyboard focus,
7687 or None.
7688 """
7689 return _core_.Window_FindFocus(*args, **kwargs)
7690
7691def Window_GetCapture(*args, **kwargs):
7692 """
7693 Window_GetCapture() -> Window
7694
7695 Returns the window which currently captures the mouse or None
7696 """
7697 return _core_.Window_GetCapture(*args, **kwargs)
7698
7699def Window_GetClassDefaultAttributes(*args, **kwargs):
7700 """
7701 Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
7702
79fccf9d
RD
7703 Get the default attributes for this class. This is useful if you want
7704 to use the same font or colour in your own control as in a standard
7705 control -- which is a much better idea than hard coding specific
caef1a4d
RD
7706 colours or fonts which might look completely out of place on the
7707 user's system, especially if it uses themes.
d55e5bfc
RD
7708
7709 The variant parameter is only relevant under Mac currently and is
79fccf9d 7710 ignore under other platforms. Under Mac, it will change the size of
caef1a4d
RD
7711 the returned font. See `wx.Window.SetWindowVariant` for more about
7712 this.
d55e5bfc
RD
7713 """
7714 return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
7715
7716def DLG_PNT(win, point_or_x, y=None):
7717 """
7718 Convenience function for converting a Point or (x,y) in
7719 dialog units to pixel units.
7720 """
7721 if y is None:
7722 return win.ConvertDialogPointToPixels(point_or_x)
7723 else:
7724 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
7725
7726def DLG_SZE(win, size_width, height=None):
7727 """
7728 Convenience function for converting a Size or (w,h) in
7729 dialog units to pixel units.
7730 """
7731 if height is None:
7732 return win.ConvertDialogSizeToPixels(size_width)
7733 else:
7734 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
7735
7736
7737def FindWindowById(*args, **kwargs):
7738 """
7739 FindWindowById(long id, Window parent=None) -> Window
7740
7741 Find the first window in the application with the given id. If parent
7742 is None, the search will start from all top-level frames and dialog
7743 boxes; if non-None, the search will be limited to the given window
7744 hierarchy. The search is recursive in both cases.
7745 """
7746 return _core_.FindWindowById(*args, **kwargs)
7747
7748def FindWindowByName(*args, **kwargs):
7749 """
7750 FindWindowByName(String name, Window parent=None) -> Window
7751
7752 Find a window by its name (as given in a window constructor or Create
7753 function call). If parent is None, the search will start from all
7754 top-level frames and dialog boxes; if non-None, the search will be
7755 limited to the given window hierarchy. The search is recursive in both
7756 cases.
7757
7758 If no window with such name is found, wx.FindWindowByLabel is called.
7759 """
7760 return _core_.FindWindowByName(*args, **kwargs)
7761
7762def FindWindowByLabel(*args, **kwargs):
7763 """
7764 FindWindowByLabel(String label, Window parent=None) -> Window
7765
7766 Find a window by its label. Depending on the type of window, the label
7767 may be a window title or panel item label. If parent is None, the
7768 search will start from all top-level frames and dialog boxes; if
7769 non-None, the search will be limited to the given window
7770 hierarchy. The search is recursive in both cases.
7771 """
7772 return _core_.FindWindowByLabel(*args, **kwargs)
7773
7774def Window_FromHWND(*args, **kwargs):
7775 """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
7776 return _core_.Window_FromHWND(*args, **kwargs)
7777#---------------------------------------------------------------------------
7778
7779class Validator(EvtHandler):
7780 def __repr__(self):
7781 return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7782 def __init__(self, *args, **kwargs):
7783 """__init__(self) -> Validator"""
7784 newobj = _core_.new_Validator(*args, **kwargs)
7785 self.this = newobj.this
7786 self.thisown = 1
7787 del newobj.thisown
7788 self._setOORInfo(self)
7789
7790 def Clone(*args, **kwargs):
7791 """Clone(self) -> Validator"""
7792 return _core_.Validator_Clone(*args, **kwargs)
7793
7794 def Validate(*args, **kwargs):
7795 """Validate(self, Window parent) -> bool"""
7796 return _core_.Validator_Validate(*args, **kwargs)
7797
7798 def TransferToWindow(*args, **kwargs):
7799 """TransferToWindow(self) -> bool"""
7800 return _core_.Validator_TransferToWindow(*args, **kwargs)
7801
7802 def TransferFromWindow(*args, **kwargs):
7803 """TransferFromWindow(self) -> bool"""
7804 return _core_.Validator_TransferFromWindow(*args, **kwargs)
7805
7806 def GetWindow(*args, **kwargs):
7807 """GetWindow(self) -> Window"""
7808 return _core_.Validator_GetWindow(*args, **kwargs)
7809
7810 def SetWindow(*args, **kwargs):
7811 """SetWindow(self, Window window)"""
7812 return _core_.Validator_SetWindow(*args, **kwargs)
7813
7814 def IsSilent(*args, **kwargs):
c24da6d6 7815 """IsSilent() -> bool"""
d55e5bfc
RD
7816 return _core_.Validator_IsSilent(*args, **kwargs)
7817
7818 IsSilent = staticmethod(IsSilent)
7819 def SetBellOnError(*args, **kwargs):
c24da6d6 7820 """SetBellOnError(int doIt=True)"""
d55e5bfc
RD
7821 return _core_.Validator_SetBellOnError(*args, **kwargs)
7822
7823 SetBellOnError = staticmethod(SetBellOnError)
7824
7825class ValidatorPtr(Validator):
7826 def __init__(self, this):
7827 self.this = this
7828 if not hasattr(self,"thisown"): self.thisown = 0
7829 self.__class__ = Validator
7830_core_.Validator_swigregister(ValidatorPtr)
7831
7832def Validator_IsSilent(*args, **kwargs):
7833 """Validator_IsSilent() -> bool"""
7834 return _core_.Validator_IsSilent(*args, **kwargs)
7835
7836def Validator_SetBellOnError(*args, **kwargs):
7837 """Validator_SetBellOnError(int doIt=True)"""
7838 return _core_.Validator_SetBellOnError(*args, **kwargs)
7839
7840class PyValidator(Validator):
7841 def __repr__(self):
7842 return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7843 def __init__(self, *args, **kwargs):
7844 """__init__(self) -> PyValidator"""
7845 newobj = _core_.new_PyValidator(*args, **kwargs)
7846 self.this = newobj.this
7847 self.thisown = 1
7848 del newobj.thisown
7849
7850 self._setCallbackInfo(self, PyValidator, 1)
7851 self._setOORInfo(self)
7852
7853 def _setCallbackInfo(*args, **kwargs):
7854 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
7855 return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
7856
7857
7858class PyValidatorPtr(PyValidator):
7859 def __init__(self, this):
7860 self.this = this
7861 if not hasattr(self,"thisown"): self.thisown = 0
7862 self.__class__ = PyValidator
7863_core_.PyValidator_swigregister(PyValidatorPtr)
7864
7865#---------------------------------------------------------------------------
7866
7867class Menu(EvtHandler):
7868 def __repr__(self):
7869 return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
7870 def __init__(self, *args, **kwargs):
7871 """__init__(self, String title=EmptyString, long style=0) -> Menu"""
7872 newobj = _core_.new_Menu(*args, **kwargs)
7873 self.this = newobj.this
7874 self.thisown = 1
7875 del newobj.thisown
7876 self._setOORInfo(self)
7877
7878 def Append(*args, **kwargs):
7879 """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7880 return _core_.Menu_Append(*args, **kwargs)
7881
7882 def AppendSeparator(*args, **kwargs):
7883 """AppendSeparator(self) -> MenuItem"""
7884 return _core_.Menu_AppendSeparator(*args, **kwargs)
7885
7886 def AppendCheckItem(*args, **kwargs):
7887 """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7888 return _core_.Menu_AppendCheckItem(*args, **kwargs)
7889
7890 def AppendRadioItem(*args, **kwargs):
7891 """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7892 return _core_.Menu_AppendRadioItem(*args, **kwargs)
7893
7894 def AppendMenu(*args, **kwargs):
7895 """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7896 return _core_.Menu_AppendMenu(*args, **kwargs)
7897
7898 def AppendItem(*args, **kwargs):
7899 """AppendItem(self, MenuItem item) -> MenuItem"""
7900 return _core_.Menu_AppendItem(*args, **kwargs)
7901
7902 def Break(*args, **kwargs):
7903 """Break(self)"""
7904 return _core_.Menu_Break(*args, **kwargs)
7905
7906 def InsertItem(*args, **kwargs):
7907 """InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
7908 return _core_.Menu_InsertItem(*args, **kwargs)
7909
7910 def Insert(*args, **kwargs):
7911 """
7912 Insert(self, size_t pos, int id, String text, String help=EmptyString,
7913 int kind=ITEM_NORMAL) -> MenuItem
7914 """
7915 return _core_.Menu_Insert(*args, **kwargs)
7916
7917 def InsertSeparator(*args, **kwargs):
7918 """InsertSeparator(self, size_t pos) -> MenuItem"""
7919 return _core_.Menu_InsertSeparator(*args, **kwargs)
7920
7921 def InsertCheckItem(*args, **kwargs):
7922 """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7923 return _core_.Menu_InsertCheckItem(*args, **kwargs)
7924
7925 def InsertRadioItem(*args, **kwargs):
7926 """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem"""
7927 return _core_.Menu_InsertRadioItem(*args, **kwargs)
7928
7929 def InsertMenu(*args, **kwargs):
7930 """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7931 return _core_.Menu_InsertMenu(*args, **kwargs)
7932
7933 def PrependItem(*args, **kwargs):
7934 """PrependItem(self, MenuItem item) -> MenuItem"""
7935 return _core_.Menu_PrependItem(*args, **kwargs)
7936
7937 def Prepend(*args, **kwargs):
7938 """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
7939 return _core_.Menu_Prepend(*args, **kwargs)
7940
7941 def PrependSeparator(*args, **kwargs):
7942 """PrependSeparator(self) -> MenuItem"""
7943 return _core_.Menu_PrependSeparator(*args, **kwargs)
7944
7945 def PrependCheckItem(*args, **kwargs):
7946 """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7947 return _core_.Menu_PrependCheckItem(*args, **kwargs)
7948
7949 def PrependRadioItem(*args, **kwargs):
7950 """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem"""
7951 return _core_.Menu_PrependRadioItem(*args, **kwargs)
7952
7953 def PrependMenu(*args, **kwargs):
7954 """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
7955 return _core_.Menu_PrependMenu(*args, **kwargs)
7956
7957 def Remove(*args, **kwargs):
7958 """Remove(self, int id) -> MenuItem"""
7959 return _core_.Menu_Remove(*args, **kwargs)
7960
7961 def RemoveItem(*args, **kwargs):
7962 """RemoveItem(self, MenuItem item) -> MenuItem"""
7963 return _core_.Menu_RemoveItem(*args, **kwargs)
7964
7965 def Delete(*args, **kwargs):
7966 """Delete(self, int id) -> bool"""
7967 return _core_.Menu_Delete(*args, **kwargs)
7968
7969 def DeleteItem(*args, **kwargs):
7970 """DeleteItem(self, MenuItem item) -> bool"""
7971 return _core_.Menu_DeleteItem(*args, **kwargs)
7972
7973 def Destroy(*args, **kwargs):
7974 """
7975 Destroy(self)
7976
7977 Deletes the C++ object this Python object is a proxy for.
7978 """
7979 return _core_.Menu_Destroy(*args, **kwargs)
7980
7981 def DestroyId(*args, **kwargs):
7982 """
7983 DestroyId(self, int id) -> bool
7984
7985 Deletes the C++ object this Python object is a proxy for.
7986 """
7987 return _core_.Menu_DestroyId(*args, **kwargs)
7988
7989 def DestroyItem(*args, **kwargs):
7990 """
7991 DestroyItem(self, MenuItem item) -> bool
7992
7993 Deletes the C++ object this Python object is a proxy for.
7994 """
7995 return _core_.Menu_DestroyItem(*args, **kwargs)
7996
7997 def GetMenuItemCount(*args, **kwargs):
7998 """GetMenuItemCount(self) -> size_t"""
7999 return _core_.Menu_GetMenuItemCount(*args, **kwargs)
8000
8001 def GetMenuItems(*args, **kwargs):
8002 """GetMenuItems(self) -> PyObject"""
8003 return _core_.Menu_GetMenuItems(*args, **kwargs)
8004
8005 def FindItem(*args, **kwargs):
8006 """FindItem(self, String item) -> int"""
8007 return _core_.Menu_FindItem(*args, **kwargs)
8008
8009 def FindItemById(*args, **kwargs):
8010 """FindItemById(self, int id) -> MenuItem"""
8011 return _core_.Menu_FindItemById(*args, **kwargs)
8012
8013 def FindItemByPosition(*args, **kwargs):
8014 """FindItemByPosition(self, size_t position) -> MenuItem"""
8015 return _core_.Menu_FindItemByPosition(*args, **kwargs)
8016
8017 def Enable(*args, **kwargs):
8018 """Enable(self, int id, bool enable)"""
8019 return _core_.Menu_Enable(*args, **kwargs)
8020
8021 def IsEnabled(*args, **kwargs):
8022 """IsEnabled(self, int id) -> bool"""
8023 return _core_.Menu_IsEnabled(*args, **kwargs)
8024
8025 def Check(*args, **kwargs):
8026 """Check(self, int id, bool check)"""
8027 return _core_.Menu_Check(*args, **kwargs)
8028
8029 def IsChecked(*args, **kwargs):
8030 """IsChecked(self, int id) -> bool"""
8031 return _core_.Menu_IsChecked(*args, **kwargs)
8032
8033 def SetLabel(*args, **kwargs):
8034 """SetLabel(self, int id, String label)"""
8035 return _core_.Menu_SetLabel(*args, **kwargs)
8036
8037 def GetLabel(*args, **kwargs):
8038 """GetLabel(self, int id) -> String"""
8039 return _core_.Menu_GetLabel(*args, **kwargs)
8040
8041 def SetHelpString(*args, **kwargs):
8042 """SetHelpString(self, int id, String helpString)"""
8043 return _core_.Menu_SetHelpString(*args, **kwargs)
8044
8045 def GetHelpString(*args, **kwargs):
8046 """GetHelpString(self, int id) -> String"""
8047 return _core_.Menu_GetHelpString(*args, **kwargs)
8048
8049 def SetTitle(*args, **kwargs):
8050 """SetTitle(self, String title)"""
8051 return _core_.Menu_SetTitle(*args, **kwargs)
8052
8053 def GetTitle(*args, **kwargs):
8054 """GetTitle(self) -> String"""
8055 return _core_.Menu_GetTitle(*args, **kwargs)
8056
8057 def SetEventHandler(*args, **kwargs):
8058 """SetEventHandler(self, EvtHandler handler)"""
8059 return _core_.Menu_SetEventHandler(*args, **kwargs)
8060
8061 def GetEventHandler(*args, **kwargs):
8062 """GetEventHandler(self) -> EvtHandler"""
8063 return _core_.Menu_GetEventHandler(*args, **kwargs)
8064
8065 def SetInvokingWindow(*args, **kwargs):
8066 """SetInvokingWindow(self, Window win)"""
8067 return _core_.Menu_SetInvokingWindow(*args, **kwargs)
8068
8069 def GetInvokingWindow(*args, **kwargs):
8070 """GetInvokingWindow(self) -> Window"""
8071 return _core_.Menu_GetInvokingWindow(*args, **kwargs)
8072
8073 def GetStyle(*args, **kwargs):
8074 """GetStyle(self) -> long"""
8075 return _core_.Menu_GetStyle(*args, **kwargs)
8076
8077 def UpdateUI(*args, **kwargs):
8078 """UpdateUI(self, EvtHandler source=None)"""
8079 return _core_.Menu_UpdateUI(*args, **kwargs)
8080
8081 def GetMenuBar(*args, **kwargs):
8082 """GetMenuBar(self) -> MenuBar"""
8083 return _core_.Menu_GetMenuBar(*args, **kwargs)
8084
8085 def Attach(*args, **kwargs):
8086 """Attach(self, wxMenuBarBase menubar)"""
8087 return _core_.Menu_Attach(*args, **kwargs)
8088
8089 def Detach(*args, **kwargs):
8090 """Detach(self)"""
8091 return _core_.Menu_Detach(*args, **kwargs)
8092
8093 def IsAttached(*args, **kwargs):
8094 """IsAttached(self) -> bool"""
8095 return _core_.Menu_IsAttached(*args, **kwargs)
8096
8097 def SetParent(*args, **kwargs):
8098 """SetParent(self, Menu parent)"""
8099 return _core_.Menu_SetParent(*args, **kwargs)
8100
8101 def GetParent(*args, **kwargs):
8102 """GetParent(self) -> Menu"""
8103 return _core_.Menu_GetParent(*args, **kwargs)
8104
8105
8106class MenuPtr(Menu):
8107 def __init__(self, this):
8108 self.this = this
8109 if not hasattr(self,"thisown"): self.thisown = 0
8110 self.__class__ = Menu
8111_core_.Menu_swigregister(MenuPtr)
8112DefaultValidator = cvar.DefaultValidator
8113
8114#---------------------------------------------------------------------------
8115
8116class MenuBar(Window):
8117 def __repr__(self):
8118 return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8119 def __init__(self, *args, **kwargs):
8120 """__init__(self, long style=0) -> MenuBar"""
8121 newobj = _core_.new_MenuBar(*args, **kwargs)
8122 self.this = newobj.this
8123 self.thisown = 1
8124 del newobj.thisown
8125 self._setOORInfo(self)
8126
8127 def Append(*args, **kwargs):
8128 """Append(self, Menu menu, String title) -> bool"""
8129 return _core_.MenuBar_Append(*args, **kwargs)
8130
8131 def Insert(*args, **kwargs):
8132 """Insert(self, size_t pos, Menu menu, String title) -> bool"""
8133 return _core_.MenuBar_Insert(*args, **kwargs)
8134
8135 def GetMenuCount(*args, **kwargs):
8136 """GetMenuCount(self) -> size_t"""
8137 return _core_.MenuBar_GetMenuCount(*args, **kwargs)
8138
8139 def GetMenu(*args, **kwargs):
8140 """GetMenu(self, size_t pos) -> Menu"""
8141 return _core_.MenuBar_GetMenu(*args, **kwargs)
8142
8143 def Replace(*args, **kwargs):
8144 """Replace(self, size_t pos, Menu menu, String title) -> Menu"""
8145 return _core_.MenuBar_Replace(*args, **kwargs)
8146
8147 def Remove(*args, **kwargs):
8148 """Remove(self, size_t pos) -> Menu"""
8149 return _core_.MenuBar_Remove(*args, **kwargs)
8150
8151 def EnableTop(*args, **kwargs):
8152 """EnableTop(self, size_t pos, bool enable)"""
8153 return _core_.MenuBar_EnableTop(*args, **kwargs)
8154
8155 def IsEnabledTop(*args, **kwargs):
8156 """IsEnabledTop(self, size_t pos) -> bool"""
8157 return _core_.MenuBar_IsEnabledTop(*args, **kwargs)
8158
8159 def SetLabelTop(*args, **kwargs):
8160 """SetLabelTop(self, size_t pos, String label)"""
8161 return _core_.MenuBar_SetLabelTop(*args, **kwargs)
8162
8163 def GetLabelTop(*args, **kwargs):
8164 """GetLabelTop(self, size_t pos) -> String"""
8165 return _core_.MenuBar_GetLabelTop(*args, **kwargs)
8166
8167 def FindMenuItem(*args, **kwargs):
8168 """FindMenuItem(self, String menu, String item) -> int"""
8169 return _core_.MenuBar_FindMenuItem(*args, **kwargs)
8170
8171 def FindItemById(*args, **kwargs):
8172 """FindItemById(self, int id) -> MenuItem"""
8173 return _core_.MenuBar_FindItemById(*args, **kwargs)
8174
8175 def FindMenu(*args, **kwargs):
8176 """FindMenu(self, String title) -> int"""
8177 return _core_.MenuBar_FindMenu(*args, **kwargs)
8178
8179 def Enable(*args, **kwargs):
8180 """Enable(self, int id, bool enable)"""
8181 return _core_.MenuBar_Enable(*args, **kwargs)
8182
8183 def Check(*args, **kwargs):
8184 """Check(self, int id, bool check)"""
8185 return _core_.MenuBar_Check(*args, **kwargs)
8186
8187 def IsChecked(*args, **kwargs):
8188 """IsChecked(self, int id) -> bool"""
8189 return _core_.MenuBar_IsChecked(*args, **kwargs)
8190
8191 def IsEnabled(*args, **kwargs):
8192 """IsEnabled(self, int id) -> bool"""
8193 return _core_.MenuBar_IsEnabled(*args, **kwargs)
8194
8195 def SetLabel(*args, **kwargs):
8196 """SetLabel(self, int id, String label)"""
8197 return _core_.MenuBar_SetLabel(*args, **kwargs)
8198
8199 def GetLabel(*args, **kwargs):
8200 """GetLabel(self, int id) -> String"""
8201 return _core_.MenuBar_GetLabel(*args, **kwargs)
8202
8203 def SetHelpString(*args, **kwargs):
8204 """SetHelpString(self, int id, String helpString)"""
8205 return _core_.MenuBar_SetHelpString(*args, **kwargs)
8206
8207 def GetHelpString(*args, **kwargs):
8208 """GetHelpString(self, int id) -> String"""
8209 return _core_.MenuBar_GetHelpString(*args, **kwargs)
8210
8211 def GetFrame(*args, **kwargs):
8212 """GetFrame(self) -> wxFrame"""
8213 return _core_.MenuBar_GetFrame(*args, **kwargs)
8214
8215 def IsAttached(*args, **kwargs):
8216 """IsAttached(self) -> bool"""
8217 return _core_.MenuBar_IsAttached(*args, **kwargs)
8218
8219 def Attach(*args, **kwargs):
8220 """Attach(self, wxFrame frame)"""
8221 return _core_.MenuBar_Attach(*args, **kwargs)
8222
8223 def Detach(*args, **kwargs):
8224 """Detach(self)"""
8225 return _core_.MenuBar_Detach(*args, **kwargs)
8226
8227
8228class MenuBarPtr(MenuBar):
8229 def __init__(self, this):
8230 self.this = this
8231 if not hasattr(self,"thisown"): self.thisown = 0
8232 self.__class__ = MenuBar
8233_core_.MenuBar_swigregister(MenuBarPtr)
8234
8235#---------------------------------------------------------------------------
8236
8237class MenuItem(Object):
8238 def __repr__(self):
8239 return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8240 def __init__(self, *args, **kwargs):
8241 """
8242 __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
8243 String help=EmptyString, int kind=ITEM_NORMAL,
8244 Menu subMenu=None) -> MenuItem
8245 """
8246 newobj = _core_.new_MenuItem(*args, **kwargs)
8247 self.this = newobj.this
8248 self.thisown = 1
8249 del newobj.thisown
8250 def GetMenu(*args, **kwargs):
8251 """GetMenu(self) -> Menu"""
8252 return _core_.MenuItem_GetMenu(*args, **kwargs)
8253
8254 def SetMenu(*args, **kwargs):
8255 """SetMenu(self, Menu menu)"""
8256 return _core_.MenuItem_SetMenu(*args, **kwargs)
8257
8258 def SetId(*args, **kwargs):
8259 """SetId(self, int id)"""
8260 return _core_.MenuItem_SetId(*args, **kwargs)
8261
8262 def GetId(*args, **kwargs):
8263 """GetId(self) -> int"""
8264 return _core_.MenuItem_GetId(*args, **kwargs)
8265
8266 def IsSeparator(*args, **kwargs):
8267 """IsSeparator(self) -> bool"""
8268 return _core_.MenuItem_IsSeparator(*args, **kwargs)
8269
8270 def SetText(*args, **kwargs):
8271 """SetText(self, String str)"""
8272 return _core_.MenuItem_SetText(*args, **kwargs)
8273
8274 def GetLabel(*args, **kwargs):
8275 """GetLabel(self) -> String"""
8276 return _core_.MenuItem_GetLabel(*args, **kwargs)
8277
8278 def GetText(*args, **kwargs):
8279 """GetText(self) -> String"""
8280 return _core_.MenuItem_GetText(*args, **kwargs)
8281
8282 def GetLabelFromText(*args, **kwargs):
c24da6d6 8283 """GetLabelFromText(String text) -> String"""
d55e5bfc
RD
8284 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8285
8286 GetLabelFromText = staticmethod(GetLabelFromText)
8287 def GetKind(*args, **kwargs):
8288 """GetKind(self) -> int"""
8289 return _core_.MenuItem_GetKind(*args, **kwargs)
8290
8291 def SetKind(*args, **kwargs):
8292 """SetKind(self, int kind)"""
8293 return _core_.MenuItem_SetKind(*args, **kwargs)
8294
8295 def SetCheckable(*args, **kwargs):
8296 """SetCheckable(self, bool checkable)"""
8297 return _core_.MenuItem_SetCheckable(*args, **kwargs)
8298
8299 def IsCheckable(*args, **kwargs):
8300 """IsCheckable(self) -> bool"""
8301 return _core_.MenuItem_IsCheckable(*args, **kwargs)
8302
8303 def IsSubMenu(*args, **kwargs):
8304 """IsSubMenu(self) -> bool"""
8305 return _core_.MenuItem_IsSubMenu(*args, **kwargs)
8306
8307 def SetSubMenu(*args, **kwargs):
8308 """SetSubMenu(self, Menu menu)"""
8309 return _core_.MenuItem_SetSubMenu(*args, **kwargs)
8310
8311 def GetSubMenu(*args, **kwargs):
8312 """GetSubMenu(self) -> Menu"""
8313 return _core_.MenuItem_GetSubMenu(*args, **kwargs)
8314
8315 def Enable(*args, **kwargs):
8316 """Enable(self, bool enable=True)"""
8317 return _core_.MenuItem_Enable(*args, **kwargs)
8318
8319 def IsEnabled(*args, **kwargs):
8320 """IsEnabled(self) -> bool"""
8321 return _core_.MenuItem_IsEnabled(*args, **kwargs)
8322
8323 def Check(*args, **kwargs):
8324 """Check(self, bool check=True)"""
8325 return _core_.MenuItem_Check(*args, **kwargs)
8326
8327 def IsChecked(*args, **kwargs):
8328 """IsChecked(self) -> bool"""
8329 return _core_.MenuItem_IsChecked(*args, **kwargs)
8330
8331 def Toggle(*args, **kwargs):
8332 """Toggle(self)"""
8333 return _core_.MenuItem_Toggle(*args, **kwargs)
8334
8335 def SetHelp(*args, **kwargs):
8336 """SetHelp(self, String str)"""
8337 return _core_.MenuItem_SetHelp(*args, **kwargs)
8338
8339 def GetHelp(*args, **kwargs):
8340 """GetHelp(self) -> String"""
8341 return _core_.MenuItem_GetHelp(*args, **kwargs)
8342
8343 def GetAccel(*args, **kwargs):
8344 """GetAccel(self) -> AcceleratorEntry"""
8345 return _core_.MenuItem_GetAccel(*args, **kwargs)
8346
8347 def SetAccel(*args, **kwargs):
8348 """SetAccel(self, AcceleratorEntry accel)"""
8349 return _core_.MenuItem_SetAccel(*args, **kwargs)
8350
8351 def SetFont(*args, **kwargs):
8352 """SetFont(self, Font font)"""
8353 return _core_.MenuItem_SetFont(*args, **kwargs)
8354
8355 def GetFont(*args, **kwargs):
8356 """GetFont(self) -> Font"""
8357 return _core_.MenuItem_GetFont(*args, **kwargs)
8358
8359 def SetTextColour(*args, **kwargs):
8360 """SetTextColour(self, Colour colText)"""
8361 return _core_.MenuItem_SetTextColour(*args, **kwargs)
8362
8363 def GetTextColour(*args, **kwargs):
8364 """GetTextColour(self) -> Colour"""
8365 return _core_.MenuItem_GetTextColour(*args, **kwargs)
8366
8367 def SetBackgroundColour(*args, **kwargs):
8368 """SetBackgroundColour(self, Colour colBack)"""
8369 return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
8370
8371 def GetBackgroundColour(*args, **kwargs):
8372 """GetBackgroundColour(self) -> Colour"""
8373 return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
8374
8375 def SetBitmaps(*args, **kwargs):
8376 """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
8377 return _core_.MenuItem_SetBitmaps(*args, **kwargs)
8378
8379 def SetDisabledBitmap(*args, **kwargs):
8380 """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
8381 return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
8382
8383 def GetDisabledBitmap(*args, **kwargs):
8384 """GetDisabledBitmap(self) -> Bitmap"""
8385 return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
8386
8387 def SetMarginWidth(*args, **kwargs):
8388 """SetMarginWidth(self, int nWidth)"""
8389 return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
8390
8391 def GetMarginWidth(*args, **kwargs):
8392 """GetMarginWidth(self) -> int"""
8393 return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
8394
8395 def GetDefaultMarginWidth(*args, **kwargs):
c24da6d6 8396 """GetDefaultMarginWidth() -> int"""
d55e5bfc
RD
8397 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8398
8399 GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
8400 def IsOwnerDrawn(*args, **kwargs):
8401 """IsOwnerDrawn(self) -> bool"""
8402 return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
8403
8404 def SetOwnerDrawn(*args, **kwargs):
8405 """SetOwnerDrawn(self, bool ownerDrawn=True)"""
8406 return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
8407
8408 def ResetOwnerDrawn(*args, **kwargs):
8409 """ResetOwnerDrawn(self)"""
8410 return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
8411
8412 def SetBitmap(*args, **kwargs):
8413 """SetBitmap(self, Bitmap bitmap)"""
8414 return _core_.MenuItem_SetBitmap(*args, **kwargs)
8415
8416 def GetBitmap(*args, **kwargs):
8417 """GetBitmap(self) -> Bitmap"""
8418 return _core_.MenuItem_GetBitmap(*args, **kwargs)
8419
8420
8421class MenuItemPtr(MenuItem):
8422 def __init__(self, this):
8423 self.this = this
8424 if not hasattr(self,"thisown"): self.thisown = 0
8425 self.__class__ = MenuItem
8426_core_.MenuItem_swigregister(MenuItemPtr)
8427
8428def MenuItem_GetLabelFromText(*args, **kwargs):
8429 """MenuItem_GetLabelFromText(String text) -> String"""
8430 return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
8431
8432def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
8433 """MenuItem_GetDefaultMarginWidth() -> int"""
8434 return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
8435
8436#---------------------------------------------------------------------------
8437
8438class Control(Window):
8439 """
8440 This is the base class for a control or 'widget'.
8441
79fccf9d
RD
8442 A control is generally a small window which processes user input
8443 and/or displays one or more item of data.
d55e5bfc
RD
8444 """
8445 def __repr__(self):
8446 return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8447 def __init__(self, *args, **kwargs):
8448 """
248ed943
RD
8449 __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
8450 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8451 String name=ControlNameStr) -> Control
8452
79fccf9d
RD
8453 Create a Control. Normally you should only call this from a subclass'
8454 __init__ as a plain old wx.Control is not very useful.
d55e5bfc
RD
8455 """
8456 newobj = _core_.new_Control(*args, **kwargs)
8457 self.this = newobj.this
8458 self.thisown = 1
8459 del newobj.thisown
8460 self._setOORInfo(self)
8461
8462 def Create(*args, **kwargs):
8463 """
248ed943
RD
8464 Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
8465 Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
d55e5bfc
RD
8466 String name=ControlNameStr) -> bool
8467
8468 Do the 2nd phase and create the GUI control.
8469 """
8470 return _core_.Control_Create(*args, **kwargs)
8471
8472 def Command(*args, **kwargs):
8473 """
8474 Command(self, CommandEvent event)
8475
79fccf9d
RD
8476 Simulates the effect of the user issuing a command to the item.
8477
8478 :see: `wx.CommandEvent`
8479
d55e5bfc
RD
8480 """
8481 return _core_.Control_Command(*args, **kwargs)
8482
8483 def GetLabel(*args, **kwargs):
8484 """
8485 GetLabel(self) -> String
8486
8487 Return a control's text.
8488 """
8489 return _core_.Control_GetLabel(*args, **kwargs)
8490
8491 def SetLabel(*args, **kwargs):
8492 """
8493 SetLabel(self, String label)
8494
8495 Sets the item's text.
8496 """
8497 return _core_.Control_SetLabel(*args, **kwargs)
8498
a001823c 8499 def GetClassDefaultAttributes(*args, **kwargs):
f8167d6e 8500 """
a001823c 8501 GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
f8167d6e 8502
a001823c
RD
8503 Get the default attributes for this class. This is useful if you want
8504 to use the same font or colour in your own control as in a standard
8505 control -- which is a much better idea than hard coding specific
8506 colours or fonts which might look completely out of place on the
8507 user's system, especially if it uses themes.
f8167d6e 8508
a001823c
RD
8509 The variant parameter is only relevant under Mac currently and is
8510 ignore under other platforms. Under Mac, it will change the size of
8511 the returned font. See `wx.Window.SetWindowVariant` for more about
8512 this.
f8167d6e 8513 """
d55e5bfc
RD
8514 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8515
8516 GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
8517
8518class ControlPtr(Control):
8519 def __init__(self, this):
8520 self.this = this
8521 if not hasattr(self,"thisown"): self.thisown = 0
8522 self.__class__ = Control
8523_core_.Control_swigregister(ControlPtr)
8524ControlNameStr = cvar.ControlNameStr
8525
8526def PreControl(*args, **kwargs):
8527 """
8528 PreControl() -> Control
8529
8530 Precreate a Control control for 2-phase creation
8531 """
8532 val = _core_.new_PreControl(*args, **kwargs)
8533 val.thisown = 1
8534 return val
8535
8536def Control_GetClassDefaultAttributes(*args, **kwargs):
a001823c
RD
8537 """
8538 Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
8539
8540 Get the default attributes for this class. This is useful if you want
8541 to use the same font or colour in your own control as in a standard
8542 control -- which is a much better idea than hard coding specific
8543 colours or fonts which might look completely out of place on the
8544 user's system, especially if it uses themes.
8545
8546 The variant parameter is only relevant under Mac currently and is
8547 ignore under other platforms. Under Mac, it will change the size of
8548 the returned font. See `wx.Window.SetWindowVariant` for more about
8549 this.
8550 """
d55e5bfc
RD
8551 return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
8552
8553#---------------------------------------------------------------------------
8554
8555class ItemContainer(object):
8556 """
8557 wx.ItemContainer defines an interface which is implemented by all
79fccf9d
RD
8558 controls which have string subitems, each of which may be selected,
8559 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
8560 `wx.ComboBox` which implements an extended interface deriving from
8561 this one.
d55e5bfc 8562
79fccf9d
RD
8563 It defines the methods for accessing the control's items and although
8564 each of the derived classes implements them differently, they still
8565 all conform to the same interface.
d55e5bfc 8566
79fccf9d
RD
8567 The items in a wx.ItemContainer have (non empty) string labels and,
8568 optionally, client data associated with them.
d55e5bfc
RD
8569
8570 """
8571 def __init__(self): raise RuntimeError, "No constructor defined"
8572 def __repr__(self):
8573 return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8574 def Append(*args, **kwargs):
8575 """
8576 Append(self, String item, PyObject clientData=None) -> int
8577
79fccf9d
RD
8578 Adds the item to the control, associating the given data with the item
8579 if not None. The return value is the index of the newly added item
8580 which may be different from the last one if the control is sorted (e.g.
8581 has wx.LB_SORT or wx.CB_SORT style).
d55e5bfc
RD
8582 """
8583 return _core_.ItemContainer_Append(*args, **kwargs)
8584
8585 def AppendItems(*args, **kwargs):
8586 """
f5b96ee1 8587 AppendItems(self, List strings)
d55e5bfc 8588
79fccf9d
RD
8589 Apend several items at once to the control. Notice that calling this
8590 method may be much faster than appending the items one by one if you
8591 need to add a lot of items.
d55e5bfc
RD
8592 """
8593 return _core_.ItemContainer_AppendItems(*args, **kwargs)
8594
8595 def Insert(*args, **kwargs):
8596 """
8597 Insert(self, String item, int pos, PyObject clientData=None) -> int
8598
79fccf9d 8599 Insert an item into the control before the item at the ``pos`` index,
d55e5bfc
RD
8600 optionally associating some data object with the item.
8601 """
8602 return _core_.ItemContainer_Insert(*args, **kwargs)
8603
8604 def Clear(*args, **kwargs):
8605 """
8606 Clear(self)
8607
8608 Removes all items from the control.
8609 """
8610 return _core_.ItemContainer_Clear(*args, **kwargs)
8611
8612 def Delete(*args, **kwargs):
8613 """
8614 Delete(self, int n)
8615
79fccf9d
RD
8616 Deletes the item at the zero-based index 'n' from the control. Note
8617 that it is an error (signalled by a `wx.PyAssertionError` exception if
8618 enabled) to remove an item with the index negative or greater or equal
8619 than the number of items in the control.
d55e5bfc
RD
8620 """
8621 return _core_.ItemContainer_Delete(*args, **kwargs)
8622
8623 def GetCount(*args, **kwargs):
8624 """
8625 GetCount(self) -> int
8626
8627 Returns the number of items in the control.
8628 """
8629 return _core_.ItemContainer_GetCount(*args, **kwargs)
8630
8631 def IsEmpty(*args, **kwargs):
8632 """
8633 IsEmpty(self) -> bool
8634
8635 Returns True if the control is empty or False if it has some items.
8636 """
8637 return _core_.ItemContainer_IsEmpty(*args, **kwargs)
8638
8639 def GetString(*args, **kwargs):
8640 """
8641 GetString(self, int n) -> String
8642
8643 Returns the label of the item with the given index.
8644 """
8645 return _core_.ItemContainer_GetString(*args, **kwargs)
8646
8647 def GetStrings(*args, **kwargs):
8648 """GetStrings(self) -> wxArrayString"""
8649 return _core_.ItemContainer_GetStrings(*args, **kwargs)
8650
8651 def SetString(*args, **kwargs):
8652 """
8653 SetString(self, int n, String s)
8654
8655 Sets the label for the given item.
8656 """
8657 return _core_.ItemContainer_SetString(*args, **kwargs)
8658
8659 def FindString(*args, **kwargs):
8660 """
8661 FindString(self, String s) -> int
8662
8663 Finds an item whose label matches the given string. Returns the
79fccf9d
RD
8664 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
8665 found.
d55e5bfc
RD
8666 """
8667 return _core_.ItemContainer_FindString(*args, **kwargs)
8668
8669 def Select(*args, **kwargs):
8670 """
8671 Select(self, int n)
8672
8673 Sets the item at index 'n' to be the selected item.
8674 """
8675 return _core_.ItemContainer_Select(*args, **kwargs)
8676
8677 SetSelection = Select
8678 def GetSelection(*args, **kwargs):
8679 """
8680 GetSelection(self) -> int
8681
79fccf9d
RD
8682 Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
8683 is selected.
d55e5bfc
RD
8684 """
8685 return _core_.ItemContainer_GetSelection(*args, **kwargs)
8686
8687 def GetStringSelection(*args, **kwargs):
8688 """
8689 GetStringSelection(self) -> String
8690
79fccf9d
RD
8691 Returns the label of the selected item or an empty string if no item
8692 is selected.
d55e5bfc
RD
8693 """
8694 return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
8695
8696 def GetClientData(*args, **kwargs):
8697 """
8698 GetClientData(self, int n) -> PyObject
8699
8700 Returns the client data associated with the given item, (if any.)
8701 """
8702 return _core_.ItemContainer_GetClientData(*args, **kwargs)
8703
8704 def SetClientData(*args, **kwargs):
8705 """
8706 SetClientData(self, int n, PyObject clientData)
8707
8708 Associate the given client data with the item at position n.
8709 """
8710 return _core_.ItemContainer_SetClientData(*args, **kwargs)
8711
8712
8713class ItemContainerPtr(ItemContainer):
8714 def __init__(self, this):
8715 self.this = this
8716 if not hasattr(self,"thisown"): self.thisown = 0
8717 self.__class__ = ItemContainer
8718_core_.ItemContainer_swigregister(ItemContainerPtr)
8719
8720#---------------------------------------------------------------------------
8721
8722class ControlWithItems(Control,ItemContainer):
8723 """
79fccf9d
RD
8724 wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
8725 wx.Control class, and is used for the base class of various controls
8726 that have items.
d55e5bfc
RD
8727 """
8728 def __init__(self): raise RuntimeError, "No constructor defined"
8729 def __repr__(self):
8730 return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8731
8732class ControlWithItemsPtr(ControlWithItems):
8733 def __init__(self, this):
8734 self.this = this
8735 if not hasattr(self,"thisown"): self.thisown = 0
8736 self.__class__ = ControlWithItems
8737_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
8738
8739#---------------------------------------------------------------------------
8740
8741class SizerItem(Object):
248ed943
RD
8742 """
8743 The wx.SizerItem class is used to track the position, size and other
8744 attributes of each item managed by a `wx.Sizer`. In normal usage user
8745 code should never need to deal directly with a wx.SizerItem, but
8746 custom classes derived from `wx.PySizer` will probably need to use the
8747 collection of wx.SizerItems held by wx.Sizer when calculating layout.
8748
8749 :see: `wx.Sizer`, `wx.GBSizerItem`
8750 """
d55e5bfc
RD
8751 def __repr__(self):
8752 return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
8753 def __init__(self, *args, **kwargs):
248ed943
RD
8754 """
8755 __init__(self) -> SizerItem
8756
8757 Constructs an empty wx.SizerItem. Either a window, sizer or spacer
8758 size will need to be set before this item can be used in a Sizer.
8759
8760 You will probably never need to create a wx.SizerItem directly as they
8761 are created automatically when the sizer's Add, Insert or Prepend
8762 methods are called.
8763
8764 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
8765 """
d55e5bfc
RD
8766 newobj = _core_.new_SizerItem(*args, **kwargs)
8767 self.this = newobj.this
8768 self.thisown = 1
8769 del newobj.thisown
8770 def DeleteWindows(*args, **kwargs):
248ed943
RD
8771 """
8772 DeleteWindows(self)
8773
8774 Destroy the window or the windows in a subsizer, depending on the type
8775 of item.
8776 """
d55e5bfc
RD
8777 return _core_.SizerItem_DeleteWindows(*args, **kwargs)
8778
8779 def DetachSizer(*args, **kwargs):
248ed943
RD
8780 """
8781 DetachSizer(self)
8782
8783 Enable deleting the SizerItem without destroying the contained sizer.
8784 """
d55e5bfc
RD
8785 return _core_.SizerItem_DetachSizer(*args, **kwargs)
8786
8787 def GetSize(*args, **kwargs):
248ed943
RD
8788 """
8789 GetSize(self) -> Size
8790
8791 Get the current size of the item, as set in the last Layout.
8792 """
d55e5bfc
RD
8793 return _core_.SizerItem_GetSize(*args, **kwargs)
8794
8795 def CalcMin(*args, **kwargs):
248ed943
RD
8796 """
8797 CalcMin(self) -> Size
8798
8799 Calculates the minimum desired size for the item, including any space
8800 needed by borders.
8801 """
d55e5bfc
RD
8802 return _core_.SizerItem_CalcMin(*args, **kwargs)
8803
8804 def SetDimension(*args, **kwargs):
248ed943
RD
8805 """
8806 SetDimension(self, Point pos, Size size)
8807
8808 Set the position and size of the space allocated for this item by the
8809 sizer, and adjust the position and size of the item (window or
8810 subsizer) to be within that space taking alignment and borders into
8811 account.
8812 """
d55e5bfc
RD
8813 return _core_.SizerItem_SetDimension(*args, **kwargs)
8814
8815 def GetMinSize(*args, **kwargs):
248ed943
RD
8816 """
8817 GetMinSize(self) -> Size
8818
8819 Get the minimum size needed for the item.
8820 """
d55e5bfc
RD
8821 return _core_.SizerItem_GetMinSize(*args, **kwargs)
8822
a001823c
RD
8823 def GetMinSizeWithBorder(*args, **kwargs):
8824 """
8825 GetMinSizeWithBorder(self) -> Size
8826
8827 Get the minimum size needed for the item with space for the borders
8828 added, if needed.
8829 """
8830 return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
8831
d55e5bfc
RD
8832 def SetInitSize(*args, **kwargs):
8833 """SetInitSize(self, int x, int y)"""
8834 return _core_.SizerItem_SetInitSize(*args, **kwargs)
8835
8836 def SetRatioWH(*args, **kwargs):
248ed943
RD
8837 """
8838 SetRatioWH(self, int width, int height)
8839
8840 Set the ratio item attribute.
8841 """
d55e5bfc
RD
8842 return _core_.SizerItem_SetRatioWH(*args, **kwargs)
8843
8844 def SetRatioSize(*args, **kwargs):
248ed943
RD
8845 """
8846 SetRatioSize(self, Size size)
8847
8848 Set the ratio item attribute.
8849 """
d55e5bfc
RD
8850 return _core_.SizerItem_SetRatioSize(*args, **kwargs)
8851
8852 def SetRatio(*args, **kwargs):
248ed943
RD
8853 """
8854 SetRatio(self, float ratio)
8855
8856 Set the ratio item attribute.
8857 """
d55e5bfc
RD
8858 return _core_.SizerItem_SetRatio(*args, **kwargs)
8859
8860 def GetRatio(*args, **kwargs):
248ed943
RD
8861 """
8862 GetRatio(self) -> float
8863
8864 Set the ratio item attribute.
8865 """
d55e5bfc
RD
8866 return _core_.SizerItem_GetRatio(*args, **kwargs)
8867
8868 def IsWindow(*args, **kwargs):
248ed943
RD
8869 """
8870 IsWindow(self) -> bool
8871
8872 Is this sizer item a window?
8873 """
d55e5bfc
RD
8874 return _core_.SizerItem_IsWindow(*args, **kwargs)
8875
8876 def IsSizer(*args, **kwargs):
248ed943
RD
8877 """
8878 IsSizer(self) -> bool
8879
8880 Is this sizer item a subsizer?
8881 """
d55e5bfc
RD
8882 return _core_.SizerItem_IsSizer(*args, **kwargs)
8883
8884 def IsSpacer(*args, **kwargs):
248ed943
RD
8885 """
8886 IsSpacer(self) -> bool
8887
8888 Is this sizer item a spacer?
8889 """
d55e5bfc
RD
8890 return _core_.SizerItem_IsSpacer(*args, **kwargs)
8891
8892 def SetProportion(*args, **kwargs):
248ed943
RD
8893 """
8894 SetProportion(self, int proportion)
8895
8896 Set the proportion value for this item.
8897 """
d55e5bfc
RD
8898 return _core_.SizerItem_SetProportion(*args, **kwargs)
8899
8900 def GetProportion(*args, **kwargs):
248ed943
RD
8901 """
8902 GetProportion(self) -> int
8903
8904 Get the proportion value for this item.
8905 """
d55e5bfc
RD
8906 return _core_.SizerItem_GetProportion(*args, **kwargs)
8907
248ed943
RD
8908 SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
8909 GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
d55e5bfc 8910 def SetFlag(*args, **kwargs):
248ed943
RD
8911 """
8912 SetFlag(self, int flag)
8913
8914 Set the flag value for this item.
8915 """
d55e5bfc
RD
8916 return _core_.SizerItem_SetFlag(*args, **kwargs)
8917
8918 def GetFlag(*args, **kwargs):
248ed943
RD
8919 """
8920 GetFlag(self) -> int
8921
8922 Get the flag value for this item.
8923 """
d55e5bfc
RD
8924 return _core_.SizerItem_GetFlag(*args, **kwargs)
8925
8926 def SetBorder(*args, **kwargs):
248ed943
RD
8927 """
8928 SetBorder(self, int border)
8929
8930 Set the border value for this item.
8931 """
d55e5bfc
RD
8932 return _core_.SizerItem_SetBorder(*args, **kwargs)
8933
8934 def GetBorder(*args, **kwargs):
248ed943
RD
8935 """
8936 GetBorder(self) -> int
8937
8938 Get the border value for this item.
8939 """
d55e5bfc
RD
8940 return _core_.SizerItem_GetBorder(*args, **kwargs)
8941
8942 def GetWindow(*args, **kwargs):
248ed943
RD
8943 """
8944 GetWindow(self) -> Window
8945
8946 Get the window (if any) that is managed by this sizer item.
8947 """
d55e5bfc
RD
8948 return _core_.SizerItem_GetWindow(*args, **kwargs)
8949
8950 def SetWindow(*args, **kwargs):
248ed943
RD
8951 """
8952 SetWindow(self, Window window)
8953
8954 Set the window to be managed by this sizer item.
8955 """
d55e5bfc
RD
8956 return _core_.SizerItem_SetWindow(*args, **kwargs)
8957
8958 def GetSizer(*args, **kwargs):
248ed943
RD
8959 """
8960 GetSizer(self) -> Sizer
8961
8962 Get the subsizer (if any) that is managed by this sizer item.
8963 """
d55e5bfc
RD
8964 return _core_.SizerItem_GetSizer(*args, **kwargs)
8965
8966 def SetSizer(*args, **kwargs):
248ed943
RD
8967 """
8968 SetSizer(self, Sizer sizer)
8969
8970 Set the subsizer to be managed by this sizer item.
8971 """
d55e5bfc
RD
8972 return _core_.SizerItem_SetSizer(*args, **kwargs)
8973
8974 def GetSpacer(*args, **kwargs):
248ed943
RD
8975 """
8976 GetSpacer(self) -> Size
8977
8978 Get the size of the spacer managed by this sizer item.
8979 """
d55e5bfc
RD
8980 return _core_.SizerItem_GetSpacer(*args, **kwargs)
8981
8982 def SetSpacer(*args, **kwargs):
248ed943
RD
8983 """
8984 SetSpacer(self, Size size)
8985
8986 Set the size of the spacer to be managed by this sizer item.
8987 """
d55e5bfc
RD
8988 return _core_.SizerItem_SetSpacer(*args, **kwargs)
8989
8990 def Show(*args, **kwargs):
248ed943
RD
8991 """
8992 Show(self, bool show)
8993
8994 Set the show item attribute, which sizers use to determine if the item
8995 is to be made part of the layout or not. If the item is tracking a
8996 window then it is shown or hidden as needed.
8997 """
d55e5bfc
RD
8998 return _core_.SizerItem_Show(*args, **kwargs)
8999
9000 def IsShown(*args, **kwargs):
248ed943
RD
9001 """
9002 IsShown(self) -> bool
9003
9004 Is the item to be shown in the layout?
9005 """
d55e5bfc
RD
9006 return _core_.SizerItem_IsShown(*args, **kwargs)
9007
9008 def GetPosition(*args, **kwargs):
248ed943
RD
9009 """
9010 GetPosition(self) -> Point
9011
9012 Returns the current position of the item, as set in the last Layout.
9013 """
d55e5bfc
RD
9014 return _core_.SizerItem_GetPosition(*args, **kwargs)
9015
9016 def GetUserData(*args, **kwargs):
248ed943
RD
9017 """
9018 GetUserData(self) -> PyObject
9019
9020 Returns the userData associated with this sizer item, or None if there
9021 isn't any.
9022 """
d55e5bfc
RD
9023 return _core_.SizerItem_GetUserData(*args, **kwargs)
9024
9025
9026class SizerItemPtr(SizerItem):
9027 def __init__(self, this):
9028 self.this = this
9029 if not hasattr(self,"thisown"): self.thisown = 0
9030 self.__class__ = SizerItem
9031_core_.SizerItem_swigregister(SizerItemPtr)
9032
248ed943 9033def SizerItemWindow(*args, **kwargs):
d55e5bfc 9034 """
248ed943
RD
9035 SizerItemWindow(Window window, int proportion, int flag, int border,
9036 PyObject userData=None) -> SizerItem
9037
9038 Constructs a `wx.SizerItem` for tracking a window.
d55e5bfc 9039 """
248ed943 9040 val = _core_.new_SizerItemWindow(*args, **kwargs)
d55e5bfc
RD
9041 val.thisown = 1
9042 return val
9043
248ed943 9044def SizerItemSpacer(*args, **kwargs):
d55e5bfc 9045 """
248ed943
RD
9046 SizerItemSpacer(int width, int height, int proportion, int flag, int border,
9047 PyObject userData=None) -> SizerItem
9048
9049 Constructs a `wx.SizerItem` for tracking a spacer.
d55e5bfc 9050 """
248ed943 9051 val = _core_.new_SizerItemSpacer(*args, **kwargs)
d55e5bfc
RD
9052 val.thisown = 1
9053 return val
9054
9055def SizerItemSizer(*args, **kwargs):
9056 """
9057 SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
248ed943
RD
9058 PyObject userData=None) -> SizerItem
9059
9060 Constructs a `wx.SizerItem` for tracking a subsizer
d55e5bfc
RD
9061 """
9062 val = _core_.new_SizerItemSizer(*args, **kwargs)
9063 val.thisown = 1
9064 return val
9065
9066class Sizer(Object):
248ed943
RD
9067 """
9068 wx.Sizer is the abstract base class used for laying out subwindows in
9069 a window. You cannot use wx.Sizer directly; instead, you will have to
9070 use one of the sizer classes derived from it such as `wx.BoxSizer`,
9071 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
9072 and `wx.GridBagSizer`.
9073
9074 The concept implemented by sizers in wxWidgets is closely related to
9075 layout tools in other GUI toolkits, such as Java's AWT, the GTK
9076 toolkit or the Qt toolkit. It is based upon the idea of the individual
9077 subwindows reporting their minimal required size and their ability to
9078 get stretched if the size of the parent window has changed. This will
9079 most often mean that the programmer does not set the original size of
9080 a dialog in the beginning, rather the dialog will assigned a sizer and
9081 this sizer will be queried about the recommended size. The sizer in
9082 turn will query its children, which can be normal windows or contorls,
9083 empty space or other sizers, so that a hierarchy of sizers can be
9084 constructed. Note that wxSizer does not derive from wxWindow and thus
9085 do not interfere with tab ordering and requires very little resources
9086 compared to a real window on screen.
9087
9088 What makes sizers so well fitted for use in wxWidgets is the fact that
9089 every control reports its own minimal size and the algorithm can
9090 handle differences in font sizes or different window (dialog item)
9091 sizes on different platforms without problems. If for example the
9092 standard font as well as the overall design of Mac widgets requires
9093 more space than on Windows, then the initial size of a dialog using a
9094 sizer will automatically be bigger on Mac than on Windows.
9095 """
d55e5bfc
RD
9096 def __init__(self): raise RuntimeError, "No constructor defined"
9097 def __repr__(self):
9098 return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9099 def _setOORInfo(*args, **kwargs):
9100 """_setOORInfo(self, PyObject _self)"""
9101 return _core_.Sizer__setOORInfo(*args, **kwargs)
9102
9103 def Add(*args, **kwargs):
9104 """
248ed943 9105 Add(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 9106 PyObject userData=None)
248ed943
RD
9107
9108 Appends a child item to the sizer.
d55e5bfc
RD
9109 """
9110 return _core_.Sizer_Add(*args, **kwargs)
9111
9112 def Insert(*args, **kwargs):
9113 """
248ed943
RD
9114 Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
9115 PyObject userData=None)
9116
9117 Inserts a new item into the list of items managed by this sizer before
9118 the item at index *before*. See `Add` for a description of the parameters.
d55e5bfc
RD
9119 """
9120 return _core_.Sizer_Insert(*args, **kwargs)
9121
9122 def Prepend(*args, **kwargs):
9123 """
248ed943 9124 Prepend(self, item, int proportion=0, int flag=0, int border=0,
d55e5bfc 9125 PyObject userData=None)
248ed943
RD
9126
9127 Adds a new item to the begining of the list of sizer items managed by
9128 this sizer. See `Add` for a description of the parameters.
d55e5bfc
RD
9129 """
9130 return _core_.Sizer_Prepend(*args, **kwargs)
9131
9132 def Remove(*args, **kwargs):
248ed943
RD
9133 """
9134 Remove(self, item) -> bool
9135
9136 Removes an item from the sizer and destroys it. This method does not
9137 cause any layout or resizing to take place, call `Layout` to update
9138 the layout on screen after removing a child from the sizer. The
9139 *item* parameter can be either a window, a sizer, or the zero-based
9140 index of an item to remove. Returns True if the child item was found
9141 and removed.
9142 """
d55e5bfc
RD
9143 return _core_.Sizer_Remove(*args, **kwargs)
9144
1a6bba1e 9145 def Detach(*args, **kwargs):
248ed943
RD
9146 """
9147 Detach(self, item) -> bool
9148
9149 Detaches an item from the sizer without destroying it. This method
9150 does not cause any layout or resizing to take place, call `Layout` to
9151 do so. The *item* parameter can be either a window, a sizer, or the
9152 zero-based index of the item to be detached. Returns True if the child item
9153 was found and detached.
9154 """
1a6bba1e
RD
9155 return _core_.Sizer_Detach(*args, **kwargs)
9156
d55e5bfc
RD
9157 def _SetItemMinSize(*args, **kwargs):
9158 """_SetItemMinSize(self, PyObject item, Size size)"""
9159 return _core_.Sizer__SetItemMinSize(*args, **kwargs)
9160
248ed943
RD
9161 def SetItemMinSize(self, item, *args):
9162 """
9163 SetItemMinSize(self, item, Size size)
9164
9165 Sets the minimum size that will be allocated for an item in the sizer.
9166 The *item* parameter can be either a window, a sizer, or the
9167 zero-based index of the item. If a window or sizer is given then it
9168 will be searched for recursivly in subsizers if neccessary.
9169 """
9170 if len(args) == 2:
9171 # for backward compatibility accept separate width,height args too
9172 return self._SetItemMinSize(item, args)
9173 else:
9174 return self._SetItemMinSize(item, args[0])
9175
d55e5bfc 9176 def AddItem(*args, **kwargs):
248ed943
RD
9177 """
9178 AddItem(self, SizerItem item)
9179
9180 Adds a `wx.SizerItem` to the sizer.
9181 """
d55e5bfc
RD
9182 return _core_.Sizer_AddItem(*args, **kwargs)
9183
9184 def InsertItem(*args, **kwargs):
248ed943
RD
9185 """
9186 InsertItem(self, int index, SizerItem item)
9187
9188 Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
9189 """
d55e5bfc
RD
9190 return _core_.Sizer_InsertItem(*args, **kwargs)
9191
9192 def PrependItem(*args, **kwargs):
248ed943
RD
9193 """
9194 PrependItem(self, SizerItem item)
9195
9196 Prepends a `wx.SizerItem` to the sizer.
9197 """
d55e5bfc
RD
9198 return _core_.Sizer_PrependItem(*args, **kwargs)
9199
248ed943 9200 def AddMany(self, items):
c24da6d6
RD
9201 """
9202 AddMany is a convenience method for adding several items
9203 to a sizer at one time. Simply pass it a list of tuples,
9204 where each tuple consists of the parameters that you
9205 would normally pass to the `Add` method.
9206 """
248ed943
RD
9207 for item in items:
9208 if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
9209 item = (item, )
9210 self.Add(*item)
d55e5bfc
RD
9211
9212 # for backwards compatibility only, please do not use in new code
c24da6d6
RD
9213 AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
9214 AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
9215 AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
9216 PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
9217 PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
9218 PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
9219 InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
9220 InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
9221 InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
9222 RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
9223 RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
9224 RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
d55e5bfc
RD
9225
9226
d55e5bfc 9227 def SetDimension(*args, **kwargs):
248ed943
RD
9228 """
9229 SetDimension(self, int x, int y, int width, int height)
9230
9231 Call this to force the sizer to take the given dimension and thus
9232 force the items owned by the sizer to resize themselves according to
9233 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
9234 methods.
9235 """
d55e5bfc
RD
9236 return _core_.Sizer_SetDimension(*args, **kwargs)
9237
9238 def SetMinSize(*args, **kwargs):
248ed943
RD
9239 """
9240 SetMinSize(self, Size size)
9241
9242 Call this to give the sizer a minimal size. Normally, the sizer will
9243 calculate its minimal size based purely on how much space its children
9244 need. After calling this method `GetMinSize` will return either the
9245 minimal size as requested by its children or the minimal size set
9246 here, depending on which is bigger.
9247 """
d55e5bfc
RD
9248 return _core_.Sizer_SetMinSize(*args, **kwargs)
9249
9250 def GetSize(*args, **kwargs):
248ed943
RD
9251 """
9252 GetSize(self) -> Size
9253
9254 Returns the current size of the space managed by the sizer.
9255 """
d55e5bfc
RD
9256 return _core_.Sizer_GetSize(*args, **kwargs)
9257
9258 def GetPosition(*args, **kwargs):
248ed943
RD
9259 """
9260 GetPosition(self) -> Point
9261
9262 Returns the current position of the sizer's managed space.
9263 """
d55e5bfc
RD
9264 return _core_.Sizer_GetPosition(*args, **kwargs)
9265
9266 def GetMinSize(*args, **kwargs):
248ed943
RD
9267 """
9268 GetMinSize(self) -> Size
9269
9270 Returns the minimal size of the sizer. This is either the combined
9271 minimal size of all the children and their borders or the minimal size
9272 set by SetMinSize, depending on which is bigger.
9273 """
d55e5bfc
RD
9274 return _core_.Sizer_GetMinSize(*args, **kwargs)
9275
9276 def GetSizeTuple(self):
1a6bba1e 9277 return self.GetSize().Get()
d55e5bfc 9278 def GetPositionTuple(self):
1a6bba1e 9279 return self.GetPosition().Get()
d55e5bfc 9280 def GetMinSizeTuple(self):
1a6bba1e 9281 return self.GetMinSize().Get()
d55e5bfc
RD
9282
9283 def RecalcSizes(*args, **kwargs):
248ed943
RD
9284 """
9285 RecalcSizes(self)
9286
9287 Using the sizes calculated by `CalcMin` reposition and resize all the
9288 items managed by this sizer. You should not need to call this directly as
9289 it is called by `Layout`.
9290 """
d55e5bfc
RD
9291 return _core_.Sizer_RecalcSizes(*args, **kwargs)
9292
9293 def CalcMin(*args, **kwargs):
248ed943
RD
9294 """
9295 CalcMin(self) -> Size
9296
9297 This method is where the sizer will do the actual calculation of its
9298 children's minimal sizes. You should not need to call this directly as
9299 it is called by `Layout`.
9300 """
d55e5bfc
RD
9301 return _core_.Sizer_CalcMin(*args, **kwargs)
9302
9303 def Layout(*args, **kwargs):
248ed943
RD
9304 """
9305 Layout(self)
9306
9307 This method will force the recalculation and layout of the items
9308 controlled by the sizer using the current space allocated to the
9309 sizer. Normally this is called automatically from the owning window's
9310 EVT_SIZE handler, but it is also useful to call it from user code when
9311 one of the items in a sizer change size, or items are added or
9312 removed.
9313 """
d55e5bfc
RD
9314 return _core_.Sizer_Layout(*args, **kwargs)
9315
9316 def Fit(*args, **kwargs):
248ed943
RD
9317 """
9318 Fit(self, Window window) -> Size
9319
9320 Tell the sizer to resize the *window* to match the sizer's minimal
9321 size. This is commonly done in the constructor of the window itself in
9322 order to set its initial size to match the needs of the children as
9323 determined by the sizer. Returns the new size.
9324
9325 For a top level window this is the total window size, not the client size.
9326 """
d55e5bfc
RD
9327 return _core_.Sizer_Fit(*args, **kwargs)
9328
9329 def FitInside(*args, **kwargs):
248ed943
RD
9330 """
9331 FitInside(self, Window window)
9332
9333 Tell the sizer to resize the *virtual size* of the *window* to match the
9334 sizer's minimal size. This will not alter the on screen size of the
9335 window, but may cause the addition/removal/alteration of scrollbars
9336 required to view the virtual area in windows which manage it.
9337
9338 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
9339
9340 """
d55e5bfc
RD
9341 return _core_.Sizer_FitInside(*args, **kwargs)
9342
9343 def SetSizeHints(*args, **kwargs):
248ed943
RD
9344 """
9345 SetSizeHints(self, Window window)
9346
9347 Tell the sizer to set (and `Fit`) the minimal size of the *window* to
9348 match the sizer's minimal size. This is commonly done in the
9349 constructor of the window itself if the window is resizable (as are
9350 many dialogs under Unix and frames on probably all platforms) in order
9351 to prevent the window from being sized smaller than the minimal size
9352 required by the sizer.
9353 """
d55e5bfc
RD
9354 return _core_.Sizer_SetSizeHints(*args, **kwargs)
9355
9356 def SetVirtualSizeHints(*args, **kwargs):
248ed943
RD
9357 """
9358 SetVirtualSizeHints(self, Window window)
9359
9360 Tell the sizer to set the minimal size of the window virtual area to
9361 match the sizer's minimal size. For windows with managed scrollbars
9362 this will set them appropriately.
9363
9364 :see: `wx.ScrolledWindow.SetScrollbars`
9365
9366 """
d55e5bfc
RD
9367 return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
9368
9369 def Clear(*args, **kwargs):
248ed943
RD
9370 """
9371 Clear(self, bool deleteWindows=False)
9372
9373 Clear all items from the sizer, optionally destroying the window items
9374 as well.
9375 """
d55e5bfc
RD
9376 return _core_.Sizer_Clear(*args, **kwargs)
9377
9378 def DeleteWindows(*args, **kwargs):
248ed943
RD
9379 """
9380 DeleteWindows(self)
9381
9382 Destroy all windows managed by the sizer.
9383 """
d55e5bfc
RD
9384 return _core_.Sizer_DeleteWindows(*args, **kwargs)
9385
9386 def GetChildren(*args, **kwargs):
248ed943
RD
9387 """
9388 GetChildren(sefl) -> list
9389
9390 Returns a list of all the `wx.SizerItem` objects managed by the sizer.
9391 """
d55e5bfc
RD
9392 return _core_.Sizer_GetChildren(*args, **kwargs)
9393
9394 def Show(*args, **kwargs):
248ed943 9395 """
629e65c2 9396 Show(self, item, bool show=True, bool recursive=False) -> bool
d55e5bfc 9397
248ed943
RD
9398 Shows or hides an item managed by the sizer. To make a sizer item
9399 disappear or reappear, use Show followed by `Layout`. The *item*
9400 parameter can be either a window, a sizer, or the zero-based index of
629e65c2
RD
9401 the item. Use the recursive parameter to show or hide an item in a
9402 subsizer. Returns True if the item was found.
248ed943
RD
9403 """
9404 return _core_.Sizer_Show(*args, **kwargs)
d55e5bfc
RD
9405
9406 def IsShown(*args, **kwargs):
248ed943
RD
9407 """
9408 IsShown(self, item)
9409
9410 Determines if the item is currently shown. sizer. To make a sizer
9411 item disappear or reappear, use Show followed by `Layout`. The *item*
9412 parameter can be either a window, a sizer, or the zero-based index of
9413 the item.
9414 """
d55e5bfc
RD
9415 return _core_.Sizer_IsShown(*args, **kwargs)
9416
629e65c2 9417 def Hide(self, item, recursive=False):
248ed943 9418 """
629e65c2 9419 A convenience method for Show(item, False, recursive).
248ed943 9420 """
629e65c2 9421 return self.Show(item, False, recursive)
248ed943 9422
d55e5bfc 9423 def ShowItems(*args, **kwargs):
248ed943
RD
9424 """
9425 ShowItems(self, bool show)
9426
9427 Recursively call `wx.Window.Show` on all sizer items.
9428 """
d55e5bfc
RD
9429 return _core_.Sizer_ShowItems(*args, **kwargs)
9430
9431
9432class SizerPtr(Sizer):
9433 def __init__(self, this):
9434 self.this = this
9435 if not hasattr(self,"thisown"): self.thisown = 0
9436 self.__class__ = Sizer
9437_core_.Sizer_swigregister(SizerPtr)
9438
9439class PySizer(Sizer):
248ed943
RD
9440 """
9441 wx.PySizer is a special version of `wx.Sizer` that has been
9442 instrumented to allow the C++ virtual methods to be overloaded in
9443 Python derived classes. You would derive from this class if you are
9444 wanting to implement a custom sizer in Python code. Simply implement
9445 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
9446 For example::
9447
9448 class MySizer(wx.PySizer):
9449 def __init__(self):
9450 wx.PySizer.__init__(self)
9451
9452 def CalcMin(self):
9453 for item in self.GetChildren():
9454 # calculate the total minimum width and height needed
9455 # by all items in the sizer according to this sizer's
9456 # layout algorithm.
9457 ...
9458 return wx.Size(width, height)
9459
9460 def RecalcSizes(self):
9461 # find the space allotted to this sizer
9462 pos = self.GetPosition()
9463 size = self.GetSize()
9464 for item in self.GetChildren():
9465 # Recalculate (if necessary) the position and size of
9466 # each item and then call item.SetDimension to do the
9467 # actual positioning and sizing of the items within the
9468 # space alloted to this sizer.
9469 ...
9470 item.SetDimension(itemPos, itemSize)
9471
9472
9473 When `Layout` is called it first calls `CalcMin` followed by
9474 `RecalcSizes` so you can optimize a bit by saving the results of
9475 `CalcMin` and resuing them in `RecalcSizes`.
9476
9477 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
9478
9479
9480 """
d55e5bfc
RD
9481 def __repr__(self):
9482 return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9483 def __init__(self, *args, **kwargs):
248ed943
RD
9484 """
9485 __init__(self) -> PySizer
9486
9487 Creates a wx.PySizer. Must be called from the __init__ in the derived
9488 class.
9489 """
d55e5bfc
RD
9490 newobj = _core_.new_PySizer(*args, **kwargs)
9491 self.this = newobj.this
9492 self.thisown = 1
9493 del newobj.thisown
9494 self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
9495
9496 def _setCallbackInfo(*args, **kwargs):
9497 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
9498 return _core_.PySizer__setCallbackInfo(*args, **kwargs)
9499
9500
9501class PySizerPtr(PySizer):
9502 def __init__(self, this):
9503 self.this = this
9504 if not hasattr(self,"thisown"): self.thisown = 0
9505 self.__class__ = PySizer
9506_core_.PySizer_swigregister(PySizerPtr)
9507
9508#---------------------------------------------------------------------------
9509
9510class BoxSizer(Sizer):
248ed943
RD
9511 """
9512 The basic idea behind a box sizer is that windows will most often be
9513 laid out in rather simple basic geometry, typically in a row or a
9514 column or nested hierarchies of either. A wx.BoxSizer will lay out
9515 its items in a simple row or column, depending on the orientation
9516 parameter passed to the constructor.
9517 """
d55e5bfc
RD
9518 def __repr__(self):
9519 return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9520 def __init__(self, *args, **kwargs):
248ed943
RD
9521 """
9522 __init__(self, int orient=HORIZONTAL) -> BoxSizer
9523
9524 Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
9525 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
9526 sizer.
9527 """
d55e5bfc
RD
9528 newobj = _core_.new_BoxSizer(*args, **kwargs)
9529 self.this = newobj.this
9530 self.thisown = 1
9531 del newobj.thisown
9532 self._setOORInfo(self)
9533
9534 def GetOrientation(*args, **kwargs):
248ed943
RD
9535 """
9536 GetOrientation(self) -> int
9537
9538 Returns the current orientation of the sizer.
9539 """
d55e5bfc
RD
9540 return _core_.BoxSizer_GetOrientation(*args, **kwargs)
9541
9542 def SetOrientation(*args, **kwargs):
248ed943
RD
9543 """
9544 SetOrientation(self, int orient)
d55e5bfc 9545
248ed943
RD
9546 Resets the orientation of the sizer.
9547 """
9548 return _core_.BoxSizer_SetOrientation(*args, **kwargs)
d55e5bfc
RD
9549
9550
9551class BoxSizerPtr(BoxSizer):
9552 def __init__(self, this):
9553 self.this = this
9554 if not hasattr(self,"thisown"): self.thisown = 0
9555 self.__class__ = BoxSizer
9556_core_.BoxSizer_swigregister(BoxSizerPtr)
9557
9558#---------------------------------------------------------------------------
9559
9560class StaticBoxSizer(BoxSizer):
248ed943
RD
9561 """
9562 wx.StaticBoxSizer derives from and functions identically to the
9563 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
9564 manages. Note that this static box must be created separately and
9565 passed to the sizer constructor.
9566 """
d55e5bfc
RD
9567 def __repr__(self):
9568 return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9569 def __init__(self, *args, **kwargs):
248ed943
RD
9570 """
9571 __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
9572
9573 Constructor. It takes an associated static box and the orientation
9574 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
9575 ``wx.HORIZONTAL``.
9576 """
d55e5bfc
RD
9577 newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
9578 self.this = newobj.this
9579 self.thisown = 1
9580 del newobj.thisown
9581 self._setOORInfo(self)
9582
9583 def GetStaticBox(*args, **kwargs):
248ed943
RD
9584 """
9585 GetStaticBox(self) -> StaticBox
d55e5bfc 9586
248ed943
RD
9587 Returns the static box associated with this sizer.
9588 """
9589 return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
d55e5bfc
RD
9590
9591
9592class StaticBoxSizerPtr(StaticBoxSizer):
9593 def __init__(self, this):
9594 self.this = this
9595 if not hasattr(self,"thisown"): self.thisown = 0
9596 self.__class__ = StaticBoxSizer
9597_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
9598
9599#---------------------------------------------------------------------------
9600
9601class GridSizer(Sizer):
248ed943
RD
9602 """
9603 A grid sizer is a sizer which lays out its children in a
9604 two-dimensional table with all cells having the same size. In other
9605 words, the width of each cell within the grid is the width of the
9606 widest item added to the sizer and the height of each grid cell is the
9607 height of the tallest item. An optional vertical and/or horizontal
9608 gap between items can also be specified (in pixels.)
9609
9610 Items are placed in the cells of the grid in the order they are added,
9611 in row-major order. In other words, the first row is filled first,
9612 then the second, and so on until all items have been added. (If
9613 neccessary, additional rows will be added as items are added.) If you
9614 need to have greater control over the cells that items are placed in
9615 then use the `wx.GridBagSizer`.
9616
9617 """
d55e5bfc
RD
9618 def __repr__(self):
9619 return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9620 def __init__(self, *args, **kwargs):
248ed943
RD
9621 """
9622 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
9623
9624 Constructor for a wx.GridSizer. *rows* and *cols* determine the number
9625 of columns and rows in the sizer - if either of the parameters is
9626 zero, it will be calculated to from the total number of children in
9627 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9628 define extra space between all children.
9629 """
d55e5bfc
RD
9630 newobj = _core_.new_GridSizer(*args, **kwargs)
9631 self.this = newobj.this
9632 self.thisown = 1
9633 del newobj.thisown
9634 self._setOORInfo(self)
9635
d55e5bfc 9636 def SetCols(*args, **kwargs):
248ed943
RD
9637 """
9638 SetCols(self, int cols)
9639
9640 Sets the number of columns in the sizer.
9641 """
d55e5bfc
RD
9642 return _core_.GridSizer_SetCols(*args, **kwargs)
9643
9644 def SetRows(*args, **kwargs):
248ed943
RD
9645 """
9646 SetRows(self, int rows)
9647
9648 Sets the number of rows in the sizer.
9649 """
d55e5bfc
RD
9650 return _core_.GridSizer_SetRows(*args, **kwargs)
9651
9652 def SetVGap(*args, **kwargs):
248ed943
RD
9653 """
9654 SetVGap(self, int gap)
9655
9656 Sets the vertical gap (in pixels) between the cells in the sizer.
9657 """
d55e5bfc
RD
9658 return _core_.GridSizer_SetVGap(*args, **kwargs)
9659
9660 def SetHGap(*args, **kwargs):
248ed943
RD
9661 """
9662 SetHGap(self, int gap)
9663
9664 Sets the horizontal gap (in pixels) between cells in the sizer
9665 """
d55e5bfc
RD
9666 return _core_.GridSizer_SetHGap(*args, **kwargs)
9667
9668 def GetCols(*args, **kwargs):
248ed943
RD
9669 """
9670 GetCols(self) -> int
9671
9672 Returns the number of columns in the sizer.
9673 """
d55e5bfc
RD
9674 return _core_.GridSizer_GetCols(*args, **kwargs)
9675
9676 def GetRows(*args, **kwargs):
248ed943
RD
9677 """
9678 GetRows(self) -> int
9679
9680 Returns the number of rows in the sizer.
9681 """
d55e5bfc
RD
9682 return _core_.GridSizer_GetRows(*args, **kwargs)
9683
9684 def GetVGap(*args, **kwargs):
248ed943
RD
9685 """
9686 GetVGap(self) -> int
9687
9688 Returns the vertical gap (in pixels) between the cells in the sizer.
9689 """
d55e5bfc
RD
9690 return _core_.GridSizer_GetVGap(*args, **kwargs)
9691
9692 def GetHGap(*args, **kwargs):
248ed943
RD
9693 """
9694 GetHGap(self) -> int
9695
9696 Returns the horizontal gap (in pixels) between cells in the sizer.
9697 """
d55e5bfc
RD
9698 return _core_.GridSizer_GetHGap(*args, **kwargs)
9699
9700
9701class GridSizerPtr(GridSizer):
9702 def __init__(self, this):
9703 self.this = this
9704 if not hasattr(self,"thisown"): self.thisown = 0
9705 self.__class__ = GridSizer
9706_core_.GridSizer_swigregister(GridSizerPtr)
9707
9708#---------------------------------------------------------------------------
9709
9710FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE
9711FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
9712FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
9713class FlexGridSizer(GridSizer):
248ed943
RD
9714 """
9715 A flex grid sizer is a sizer which lays out its children in a
9716 two-dimensional table with all table cells in one row having the same
9717 height and all cells in one column having the same width, but all
9718 rows or all columns are not necessarily the same height or width as in
9719 the `wx.GridSizer`.
9720
9721 wx.FlexGridSizer can also size items equally in one direction but
9722 unequally ("flexibly") in the other. If the sizer is only flexible
9723 in one direction (this can be changed using `SetFlexibleDirection`), it
9724 needs to be decided how the sizer should grow in the other ("non
9725 flexible") direction in order to fill the available space. The
9726 `SetNonFlexibleGrowMode` method serves this purpose.
9727
9728
9729 """
d55e5bfc
RD
9730 def __repr__(self):
9731 return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9732 def __init__(self, *args, **kwargs):
248ed943
RD
9733 """
9734 __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
9735
9736 Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
9737 number of columns and rows in the sizer - if either of the parameters
9738 is zero, it will be calculated to from the total number of children in
9739 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
9740 define extra space between all children.
9741 """
d55e5bfc
RD
9742 newobj = _core_.new_FlexGridSizer(*args, **kwargs)
9743 self.this = newobj.this
9744 self.thisown = 1
9745 del newobj.thisown
9746 self._setOORInfo(self)
9747
248ed943
RD
9748 def AddGrowableRow(*args, **kwargs):
9749 """
9750 AddGrowableRow(self, size_t idx, int proportion=0)
d55e5bfc 9751
248ed943
RD
9752 Specifies that row *idx* (starting from zero) should be grown if there
9753 is extra space available to the sizer.
d55e5bfc 9754
248ed943
RD
9755 The *proportion* parameter has the same meaning as the stretch factor
9756 for the box sizers except that if all proportions are 0, then all
9757 columns are resized equally (instead of not being resized at all).
9758 """
d55e5bfc
RD
9759 return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
9760
9761 def RemoveGrowableRow(*args, **kwargs):
248ed943
RD
9762 """
9763 RemoveGrowableRow(self, size_t idx)
9764
9765 Specifies that row *idx* is no longer growable.
9766 """
d55e5bfc
RD
9767 return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
9768
9769 def AddGrowableCol(*args, **kwargs):
248ed943
RD
9770 """
9771 AddGrowableCol(self, size_t idx, int proportion=0)
9772
9773 Specifies that column *idx* (starting from zero) should be grown if
9774 there is extra space available to the sizer.
9775
9776 The *proportion* parameter has the same meaning as the stretch factor
9777 for the box sizers except that if all proportions are 0, then all
9778 columns are resized equally (instead of not being resized at all).
9779 """
d55e5bfc
RD
9780 return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
9781
9782 def RemoveGrowableCol(*args, **kwargs):
248ed943
RD
9783 """
9784 RemoveGrowableCol(self, size_t idx)
9785
9786 Specifies that column *idx* is no longer growable.
9787 """
d55e5bfc
RD
9788 return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
9789
9790 def SetFlexibleDirection(*args, **kwargs):
248ed943
RD
9791 """
9792 SetFlexibleDirection(self, int direction)
9793
9794 Specifies whether the sizer should flexibly resize its columns, rows,
9795 or both. Argument *direction* can be one of the following values. Any
9796 other value is ignored.
9797
9798 ============== =======================================
9799 wx.VERTICAL Rows are flexibly sized.
9800 wx.HORIZONTAL Columns are flexibly sized.
9801 wx.BOTH Both rows and columns are flexibly sized
9802 (this is the default value).
9803 ============== =======================================
9804
9805 Note that this method does not trigger relayout.
9806
9807 """
d55e5bfc
RD
9808 return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
9809
9810 def GetFlexibleDirection(*args, **kwargs):
248ed943
RD
9811 """
9812 GetFlexibleDirection(self) -> int
9813
9814 Returns a value that specifies whether the sizer
9815 flexibly resizes its columns, rows, or both (default).
9816
9817 :see: `SetFlexibleDirection`
9818 """
d55e5bfc
RD
9819 return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
9820
9821 def SetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9822 """
9823 SetNonFlexibleGrowMode(self, int mode)
9824
9825 Specifies how the sizer should grow in the non-flexible direction if
9826 there is one (so `SetFlexibleDirection` must have been called
9827 previously). Argument *mode* can be one of the following values:
9828
9829 ========================== =================================================
9830 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
9831 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
9832 `AddGrowableCol` and `AddGrowableRow`. In this
9833 case equal sizing applies to minimum sizes of
9834 columns or rows (this is the default value).
9835 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
9836 the non flexible direction, whether they are
9837 growable or not in the flexbile direction.
9838 ========================== =================================================
9839
9840 Note that this method does not trigger relayout.
9841
9842
9843 """
d55e5bfc
RD
9844 return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
9845
9846 def GetNonFlexibleGrowMode(*args, **kwargs):
248ed943
RD
9847 """
9848 GetNonFlexibleGrowMode(self) -> int
9849
9850 Returns the value that specifies how the sizer grows in the
9851 non-flexible direction if there is one.
9852
9853 :see: `SetNonFlexibleGrowMode`
9854 """
d55e5bfc
RD
9855 return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
9856
9857 def GetRowHeights(*args, **kwargs):
a8eff060
RD
9858 """
9859 GetRowHeights(self) -> list
9860
9861 Returns a list of integers representing the heights of each of the
9862 rows in the sizer.
9863 """
d55e5bfc
RD
9864 return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
9865
9866 def GetColWidths(*args, **kwargs):
a8eff060
RD
9867 """
9868 GetColWidths(self) -> list
9869
9870 Returns a list of integers representing the widths of each of the
9871 columns in the sizer.
9872 """
d55e5bfc
RD
9873 return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
9874
9875
9876class FlexGridSizerPtr(FlexGridSizer):
9877 def __init__(self, this):
9878 self.this = this
9879 if not hasattr(self,"thisown"): self.thisown = 0
9880 self.__class__ = FlexGridSizer
9881_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
9882
9883#---------------------------------------------------------------------------
9884
9885class GBPosition(object):
248ed943
RD
9886 """
9887 This class represents the position of an item in a virtual grid of
9888 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9889 typemaps that will automatically convert from a 2-element sequence of
9890 integers to a wx.GBPosition, so you can use the more pythonic
9891 representation of the position nearly transparently in Python code.
9892 """
d55e5bfc
RD
9893 def __repr__(self):
9894 return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9895 def __init__(self, *args, **kwargs):
248ed943
RD
9896 """
9897 __init__(self, int row=0, int col=0) -> GBPosition
9898
9899 This class represents the position of an item in a virtual grid of
9900 rows and columns managed by a `wx.GridBagSizer`. wxPython has
9901 typemaps that will automatically convert from a 2-element sequence of
9902 integers to a wx.GBPosition, so you can use the more pythonic
9903 representation of the position nearly transparently in Python code.
9904 """
d55e5bfc
RD
9905 newobj = _core_.new_GBPosition(*args, **kwargs)
9906 self.this = newobj.this
9907 self.thisown = 1
9908 del newobj.thisown
9909 def GetRow(*args, **kwargs):
9910 """GetRow(self) -> int"""
9911 return _core_.GBPosition_GetRow(*args, **kwargs)
9912
9913 def GetCol(*args, **kwargs):
9914 """GetCol(self) -> int"""
9915 return _core_.GBPosition_GetCol(*args, **kwargs)
9916
9917 def SetRow(*args, **kwargs):
9918 """SetRow(self, int row)"""
9919 return _core_.GBPosition_SetRow(*args, **kwargs)
9920
9921 def SetCol(*args, **kwargs):
9922 """SetCol(self, int col)"""
9923 return _core_.GBPosition_SetCol(*args, **kwargs)
9924
9925 def __eq__(*args, **kwargs):
9926 """__eq__(self, GBPosition other) -> bool"""
9927 return _core_.GBPosition___eq__(*args, **kwargs)
9928
9929 def __ne__(*args, **kwargs):
9930 """__ne__(self, GBPosition other) -> bool"""
9931 return _core_.GBPosition___ne__(*args, **kwargs)
9932
9933 def Set(*args, **kwargs):
9934 """Set(self, int row=0, int col=0)"""
9935 return _core_.GBPosition_Set(*args, **kwargs)
9936
9937 def Get(*args, **kwargs):
9938 """Get(self) -> PyObject"""
9939 return _core_.GBPosition_Get(*args, **kwargs)
9940
79fccf9d 9941 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
9942 def __str__(self): return str(self.Get())
9943 def __repr__(self): return 'wx.GBPosition'+str(self.Get())
9944 def __len__(self): return len(self.Get())
9945 def __getitem__(self, index): return self.Get()[index]
9946 def __setitem__(self, index, val):
9947 if index == 0: self.SetRow(val)
9948 elif index == 1: self.SetCol(val)
9949 else: raise IndexError
9950 def __nonzero__(self): return self.Get() != (0,0)
9951 __safe_for_unpickling__ = True
9952 def __reduce__(self): return (wx.GBPosition, self.Get())
9953
9954 row = property(GetRow, SetRow)
9955 col = property(GetCol, SetCol)
9956
9957
9958class GBPositionPtr(GBPosition):
9959 def __init__(self, this):
9960 self.this = this
9961 if not hasattr(self,"thisown"): self.thisown = 0
9962 self.__class__ = GBPosition
9963_core_.GBPosition_swigregister(GBPositionPtr)
9964
9965class GBSpan(object):
248ed943
RD
9966 """
9967 This class is used to hold the row and column spanning attributes of
9968 items in a `wx.GridBagSizer`. wxPython has typemaps that will
9969 automatically convert from a 2-element sequence of integers to a
9970 wx.GBSpan, so you can use the more pythonic representation of the span
9971 nearly transparently in Python code.
9972
9973 """
d55e5bfc
RD
9974 def __repr__(self):
9975 return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
9976 def __init__(self, *args, **kwargs):
248ed943
RD
9977 """
9978 __init__(self, int rowspan=1, int colspan=1) -> GBSpan
9979
9980 Construct a new wxGBSpan, optionally setting the rowspan and
9981 colspan. The default is (1,1). (Meaning that the item occupies one
9982 cell in each direction.
9983 """
d55e5bfc
RD
9984 newobj = _core_.new_GBSpan(*args, **kwargs)
9985 self.this = newobj.this
9986 self.thisown = 1
9987 del newobj.thisown
9988 def GetRowspan(*args, **kwargs):
9989 """GetRowspan(self) -> int"""
9990 return _core_.GBSpan_GetRowspan(*args, **kwargs)
9991
9992 def GetColspan(*args, **kwargs):
9993 """GetColspan(self) -> int"""
9994 return _core_.GBSpan_GetColspan(*args, **kwargs)
9995
9996 def SetRowspan(*args, **kwargs):
9997 """SetRowspan(self, int rowspan)"""
9998 return _core_.GBSpan_SetRowspan(*args, **kwargs)
9999
10000 def SetColspan(*args, **kwargs):
10001 """SetColspan(self, int colspan)"""
10002 return _core_.GBSpan_SetColspan(*args, **kwargs)
10003
10004 def __eq__(*args, **kwargs):
10005 """__eq__(self, GBSpan other) -> bool"""
10006 return _core_.GBSpan___eq__(*args, **kwargs)
10007
10008 def __ne__(*args, **kwargs):
10009 """__ne__(self, GBSpan other) -> bool"""
10010 return _core_.GBSpan___ne__(*args, **kwargs)
10011
10012 def Set(*args, **kwargs):
10013 """Set(self, int rowspan=1, int colspan=1)"""
10014 return _core_.GBSpan_Set(*args, **kwargs)
10015
10016 def Get(*args, **kwargs):
10017 """Get(self) -> PyObject"""
10018 return _core_.GBSpan_Get(*args, **kwargs)
10019
79fccf9d 10020 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
d55e5bfc
RD
10021 def __str__(self): return str(self.Get())
10022 def __repr__(self): return 'wx.GBSpan'+str(self.Get())
10023 def __len__(self): return len(self.Get())
10024 def __getitem__(self, index): return self.Get()[index]
10025 def __setitem__(self, index, val):
10026 if index == 0: self.SetRowspan(val)
10027 elif index == 1: self.SetColspan(val)
10028 else: raise IndexError
10029 def __nonzero__(self): return self.Get() != (0,0)
10030 __safe_for_unpickling__ = True
10031 def __reduce__(self): return (wx.GBSpan, self.Get())
10032
10033 rowspan = property(GetRowspan, SetRowspan)
10034 colspan = property(GetColspan, SetColspan)
10035
10036
10037class GBSpanPtr(GBSpan):
10038 def __init__(self, this):
10039 self.this = this
10040 if not hasattr(self,"thisown"): self.thisown = 0
10041 self.__class__ = GBSpan
10042_core_.GBSpan_swigregister(GBSpanPtr)
10043
10044class GBSizerItem(SizerItem):
248ed943
RD
10045 """
10046 The wx.GBSizerItem class is used to track the additional data about
10047 items in a `wx.GridBagSizer` such as the item's position in the grid
10048 and how many rows or columns it spans.
10049
10050 """
d55e5bfc
RD
10051 def __repr__(self):
10052 return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10053 def __init__(self, *args, **kwargs):
248ed943
RD
10054 """
10055 __init__(self) -> GBSizerItem
10056
10057 Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
10058 size will need to be set, as well as a position and span before this
10059 item can be used in a Sizer.
10060
10061 You will probably never need to create a wx.GBSizerItem directly as they
10062 are created automatically when the sizer's Add method is called.
10063 """
d55e5bfc
RD
10064 newobj = _core_.new_GBSizerItem(*args, **kwargs)
10065 self.this = newobj.this
10066 self.thisown = 1
10067 del newobj.thisown
10068 def GetPos(*args, **kwargs):
248ed943
RD
10069 """
10070 GetPos(self) -> GBPosition
10071
10072 Get the grid position of the item
10073 """
d55e5bfc
RD
10074 return _core_.GBSizerItem_GetPos(*args, **kwargs)
10075
10076 def GetPosTuple(self): return self.GetPos().Get()
10077 def GetSpan(*args, **kwargs):
248ed943
RD
10078 """
10079 GetSpan(self) -> GBSpan
10080
10081 Get the row and column spanning of the item
10082 """
d55e5bfc
RD
10083 return _core_.GBSizerItem_GetSpan(*args, **kwargs)
10084
10085 def GetSpanTuple(self): return self.GetSpan().Get()
10086 def SetPos(*args, **kwargs):
248ed943
RD
10087 """
10088 SetPos(self, GBPosition pos) -> bool
10089
10090 If the item is already a member of a sizer then first ensure that
10091 there is no other item that would intersect with this one at the new
10092 position, then set the new position. Returns True if the change is
10093 successful and after the next Layout() the item will be moved.
10094 """
d55e5bfc
RD
10095 return _core_.GBSizerItem_SetPos(*args, **kwargs)
10096
10097 def SetSpan(*args, **kwargs):
248ed943
RD
10098 """
10099 SetSpan(self, GBSpan span) -> bool
10100
10101 If the item is already a member of a sizer then first ensure that
10102 there is no other item that would intersect with this one with its new
10103 spanning size, then set the new spanning. Returns True if the change
10104 is successful and after the next Layout() the item will be resized.
10105
10106 """
d55e5bfc
RD
10107 return _core_.GBSizerItem_SetSpan(*args, **kwargs)
10108
248ed943 10109 def Intersects(*args, **kwargs):
d55e5bfc
RD
10110 """
10111 Intersects(self, GBSizerItem other) -> bool
248ed943
RD
10112
10113 Returns True if this item and the other item instersect.
d55e5bfc 10114 """
248ed943
RD
10115 return _core_.GBSizerItem_Intersects(*args, **kwargs)
10116
10117 def IntersectsPos(*args, **kwargs):
10118 """
10119 IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
10120
10121 Returns True if the given pos/span would intersect with this item.
10122 """
10123 return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
d55e5bfc
RD
10124
10125 def GetEndPos(*args, **kwargs):
248ed943
RD
10126 """
10127 GetEndPos(self) -> GBPosition
10128
10129 Get the row and column of the endpoint of this item.
10130 """
d55e5bfc
RD
10131 return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
10132
10133 def GetGBSizer(*args, **kwargs):
248ed943
RD
10134 """
10135 GetGBSizer(self) -> GridBagSizer
10136
10137 Get the sizer this item is a member of.
10138 """
d55e5bfc
RD
10139 return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
10140
10141 def SetGBSizer(*args, **kwargs):
248ed943
RD
10142 """
10143 SetGBSizer(self, GridBagSizer sizer)
10144
10145 Set the sizer this item is a member of.
10146 """
d55e5bfc
RD
10147 return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
10148
10149
10150class GBSizerItemPtr(GBSizerItem):
10151 def __init__(self, this):
10152 self.this = this
10153 if not hasattr(self,"thisown"): self.thisown = 0
10154 self.__class__ = GBSizerItem
10155_core_.GBSizerItem_swigregister(GBSizerItemPtr)
10156DefaultSpan = cvar.DefaultSpan
10157
10158def GBSizerItemWindow(*args, **kwargs):
10159 """
10160 GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10161 int border, PyObject userData=None) -> GBSizerItem
10162
10163 Construct a `wx.GBSizerItem` for a window.
d55e5bfc
RD
10164 """
10165 val = _core_.new_GBSizerItemWindow(*args, **kwargs)
10166 val.thisown = 1
10167 return val
10168
10169def GBSizerItemSizer(*args, **kwargs):
10170 """
10171 GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
248ed943
RD
10172 int border, PyObject userData=None) -> GBSizerItem
10173
10174 Construct a `wx.GBSizerItem` for a sizer
d55e5bfc
RD
10175 """
10176 val = _core_.new_GBSizerItemSizer(*args, **kwargs)
10177 val.thisown = 1
10178 return val
10179
10180def GBSizerItemSpacer(*args, **kwargs):
10181 """
10182 GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
248ed943
RD
10183 int flag, int border, PyObject userData=None) -> GBSizerItem
10184
10185 Construct a `wx.GBSizerItem` for a spacer.
d55e5bfc
RD
10186 """
10187 val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
10188 val.thisown = 1
10189 return val
10190
10191class GridBagSizer(FlexGridSizer):
248ed943
RD
10192 """
10193 A `wx.Sizer` that can lay out items in a virtual grid like a
10194 `wx.FlexGridSizer` but in this case explicit positioning of the items
10195 is allowed using `wx.GBPosition`, and items can optionally span more
10196 than one row and/or column using `wx.GBSpan`. The total size of the
10197 virtual grid is determined by the largest row and column that items are
10198 positioned at, adjusted for spanning.
10199
10200 """
d55e5bfc
RD
10201 def __repr__(self):
10202 return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10203 def __init__(self, *args, **kwargs):
248ed943
RD
10204 """
10205 __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
10206
10207 Constructor, with optional parameters to specify the gap between the
10208 rows and columns.
10209 """
d55e5bfc
RD
10210 newobj = _core_.new_GridBagSizer(*args, **kwargs)
10211 self.this = newobj.this
10212 self.thisown = 1
10213 del newobj.thisown
10214 def Add(*args, **kwargs):
10215 """
248ed943
RD
10216 Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
10217 int border=0, userData=None)
10218
10219 Adds an item to the sizer at the grid cell *pos*, optionally spanning
10220 more than one row or column as specified with *span*. The remaining
10221 args behave similarly to `wx.Sizer.Add`.
10222
10223 Returns True if the item was successfully placed at the given cell
10224 position, False if something was already there.
10225
d55e5bfc
RD
10226 """
10227 return _core_.GridBagSizer_Add(*args, **kwargs)
10228
10229 def AddItem(*args, **kwargs):
248ed943
RD
10230 """
10231 Add(self, GBSizerItem item) -> bool
10232
10233 Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
10234 the item was successfully placed at its given cell position, False if
10235 something was already there.
10236 """
d55e5bfc
RD
10237 return _core_.GridBagSizer_AddItem(*args, **kwargs)
10238
10239 def GetEmptyCellSize(*args, **kwargs):
248ed943
RD
10240 """
10241 GetEmptyCellSize(self) -> Size
10242
10243 Get the size used for cells in the grid with no item.
10244 """
d55e5bfc
RD
10245 return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
10246
10247 def SetEmptyCellSize(*args, **kwargs):
248ed943
RD
10248 """
10249 SetEmptyCellSize(self, Size sz)
10250
10251 Set the size used for cells in the grid with no item.
10252 """
d55e5bfc
RD
10253 return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
10254
10255 def GetItemPosition(*args):
10256 """
248ed943
RD
10257 GetItemPosition(self, item) -> GBPosition
10258
10259 Get the grid position of the specified *item* where *item* is either a
10260 window or subsizer that is a member of this sizer, or a zero-based
10261 index of an item.
d55e5bfc
RD
10262 """
10263 return _core_.GridBagSizer_GetItemPosition(*args)
10264
10265 def SetItemPosition(*args):
10266 """
248ed943
RD
10267 SetItemPosition(self, item, GBPosition pos) -> bool
10268
10269 Set the grid position of the specified *item* where *item* is either a
10270 window or subsizer that is a member of this sizer, or a zero-based
10271 index of an item. Returns True on success. If the move is not
10272 allowed (because an item is already there) then False is returned.
10273
d55e5bfc
RD
10274 """
10275 return _core_.GridBagSizer_SetItemPosition(*args)
10276
10277 def GetItemSpan(*args):
10278 """
248ed943
RD
10279 GetItemSpan(self, item) -> GBSpan
10280
10281 Get the row/col spanning of the specified *item* where *item* is
10282 either a window or subsizer that is a member of this sizer, or a
10283 zero-based index of an item.
d55e5bfc
RD
10284 """
10285 return _core_.GridBagSizer_GetItemSpan(*args)
10286
10287 def SetItemSpan(*args):
10288 """
248ed943
RD
10289 SetItemSpan(self, item, GBSpan span) -> bool
10290
10291 Set the row/col spanning of the specified *item* where *item* is
10292 either a window or subsizer that is a member of this sizer, or a
10293 zero-based index of an item. Returns True on success. If the move is
10294 not allowed (because an item is already there) then False is returned.
d55e5bfc
RD
10295 """
10296 return _core_.GridBagSizer_SetItemSpan(*args)
10297
10298 def FindItem(*args):
10299 """
248ed943
RD
10300 FindItem(self, item) -> GBSizerItem
10301
10302 Find the sizer item for the given window or subsizer, returns None if
10303 not found. (non-recursive)
d55e5bfc
RD
10304 """
10305 return _core_.GridBagSizer_FindItem(*args)
10306
10307 def FindItemAtPosition(*args, **kwargs):
248ed943
RD
10308 """
10309 FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
10310
10311 Return the sizer item for the given grid cell, or None if there is no
10312 item at that position. (non-recursive)
10313 """
d55e5bfc
RD
10314 return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
10315
10316 def FindItemAtPoint(*args, **kwargs):
248ed943
RD
10317 """
10318 FindItemAtPoint(self, Point pt) -> GBSizerItem
10319
10320 Return the sizer item located at the point given in *pt*, or None if
10321 there is no item at that point. The (x,y) coordinates in pt correspond
10322 to the client coordinates of the window using the sizer for
10323 layout. (non-recursive)
10324 """
d55e5bfc
RD
10325 return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
10326
248ed943
RD
10327 def CheckForIntersection(*args, **kwargs):
10328 """
10329 CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
d55e5bfc 10330
248ed943
RD
10331 Look at all items and see if any intersect (or would overlap) the
10332 given *item*. Returns True if so, False if there would be no overlap.
10333 If an *excludeItem* is given then it will not be checked for
10334 intersection, for example it may be the item we are checking the
10335 position of.
d55e5bfc 10336
248ed943
RD
10337 """
10338 return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
d55e5bfc 10339
248ed943 10340 def CheckForIntersectionPos(*args, **kwargs):
d55e5bfc 10341 """
248ed943
RD
10342 CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
10343
10344 Look at all items and see if any intersect (or would overlap) the
10345 given position and span. Returns True if so, False if there would be
10346 no overlap. If an *excludeItem* is given then it will not be checked
10347 for intersection, for example it may be the item we are checking the
10348 position of.
d55e5bfc 10349 """
248ed943 10350 return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
d55e5bfc
RD
10351
10352
10353class GridBagSizerPtr(GridBagSizer):
10354 def __init__(self, this):
10355 self.this = this
10356 if not hasattr(self,"thisown"): self.thisown = 0
10357 self.__class__ = GridBagSizer
10358_core_.GridBagSizer_swigregister(GridBagSizerPtr)
10359
10360#---------------------------------------------------------------------------
10361
10362Left = _core_.Left
10363Top = _core_.Top
10364Right = _core_.Right
10365Bottom = _core_.Bottom
10366Width = _core_.Width
10367Height = _core_.Height
10368Centre = _core_.Centre
10369Center = _core_.Center
10370CentreX = _core_.CentreX
10371CentreY = _core_.CentreY
10372Unconstrained = _core_.Unconstrained
10373AsIs = _core_.AsIs
10374PercentOf = _core_.PercentOf
10375Above = _core_.Above
10376Below = _core_.Below
10377LeftOf = _core_.LeftOf
10378RightOf = _core_.RightOf
10379SameAs = _core_.SameAs
10380Absolute = _core_.Absolute
10381class IndividualLayoutConstraint(Object):
10382 """
79fccf9d
RD
10383 Objects of this class are stored in the `wx.LayoutConstraints` class as
10384 one of eight possible constraints that a window can be involved in.
10385 You will never need to create an instance of
10386 wx.IndividualLayoutConstraint, rather you should create a
10387 `wx.LayoutConstraints` instance and use the individual contstraints
d55e5bfc 10388 that it contains.
d55e5bfc
RD
10389 """
10390 def __init__(self): raise RuntimeError, "No constructor defined"
10391 def __repr__(self):
10392 return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10393 def Set(*args, **kwargs):
79fccf9d
RD
10394 """
10395 Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
10396
10397 Sets the properties of the constraint. Normally called by one of the
10398 convenience functions such as Above, RightOf, SameAs.
10399 """
d55e5bfc
RD
10400 return _core_.IndividualLayoutConstraint_Set(*args, **kwargs)
10401
10402 def LeftOf(*args, **kwargs):
10403 """
10404 LeftOf(self, Window sibling, int marg=0)
10405
79fccf9d
RD
10406 Constrains this edge to be to the left of the given window, with an
10407 optional margin. Implicitly, this is relative to the left edge of the
10408 other window.
d55e5bfc
RD
10409 """
10410 return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs)
10411
10412 def RightOf(*args, **kwargs):
10413 """
10414 RightOf(self, Window sibling, int marg=0)
10415
79fccf9d
RD
10416 Constrains this edge to be to the right of the given window, with an
10417 optional margin. Implicitly, this is relative to the right edge of the
10418 other window.
d55e5bfc
RD
10419 """
10420 return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs)
10421
10422 def Above(*args, **kwargs):
10423 """
10424 Above(self, Window sibling, int marg=0)
10425
79fccf9d
RD
10426 Constrains this edge to be above the given window, with an optional
10427 margin. Implicitly, this is relative to the top edge of the other
10428 window.
d55e5bfc
RD
10429 """
10430 return _core_.IndividualLayoutConstraint_Above(*args, **kwargs)
10431
10432 def Below(*args, **kwargs):
10433 """
10434 Below(self, Window sibling, int marg=0)
10435
79fccf9d
RD
10436 Constrains this edge to be below the given window, with an optional
10437 margin. Implicitly, this is relative to the bottom edge of the other
10438 window.
d55e5bfc
RD
10439 """
10440 return _core_.IndividualLayoutConstraint_Below(*args, **kwargs)
10441
10442 def SameAs(*args, **kwargs):
10443 """
10444 SameAs(self, Window otherW, int edge, int marg=0)
10445
79fccf9d
RD
10446 Constrains this edge or dimension to be to the same as the edge of the
10447 given window, with an optional margin.
d55e5bfc
RD
10448 """
10449 return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs)
10450
10451 def PercentOf(*args, **kwargs):
10452 """
10453 PercentOf(self, Window otherW, int wh, int per)
10454
79fccf9d
RD
10455 Constrains this edge or dimension to be to a percentage of the given
10456 window, with an optional margin.
d55e5bfc
RD
10457 """
10458 return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs)
10459
10460 def Absolute(*args, **kwargs):
10461 """
10462 Absolute(self, int val)
10463
79fccf9d 10464 Constrains this edge or dimension to be the given absolute value.
d55e5bfc
RD
10465 """
10466 return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs)
10467
10468 def Unconstrained(*args, **kwargs):
10469 """
10470 Unconstrained(self)
10471
79fccf9d
RD
10472 Sets this edge or dimension to be unconstrained, that is, dependent on
10473 other edges and dimensions from which this value can be deduced.
d55e5bfc
RD
10474 """
10475 return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs)
10476
10477 def AsIs(*args, **kwargs):
10478 """
10479 AsIs(self)
10480
79fccf9d
RD
10481 Sets this edge or constraint to be whatever the window's value is at
10482 the moment. If either of the width and height constraints are *as is*,
10483 the window will not be resized, but moved instead. This is important
10484 when considering panel items which are intended to have a default
10485 size, such as a button, which may take its size from the size of the
10486 button label.
d55e5bfc
RD
10487 """
10488 return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs)
10489
10490 def GetOtherWindow(*args, **kwargs):
10491 """GetOtherWindow(self) -> Window"""
10492 return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs)
10493
10494 def GetMyEdge(*args, **kwargs):
10495 """GetMyEdge(self) -> int"""
10496 return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs)
10497
10498 def SetEdge(*args, **kwargs):
10499 """SetEdge(self, int which)"""
10500 return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs)
10501
10502 def SetValue(*args, **kwargs):
10503 """SetValue(self, int v)"""
10504 return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs)
10505
10506 def GetMargin(*args, **kwargs):
10507 """GetMargin(self) -> int"""
10508 return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs)
10509
10510 def SetMargin(*args, **kwargs):
10511 """SetMargin(self, int m)"""
10512 return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs)
10513
10514 def GetValue(*args, **kwargs):
10515 """GetValue(self) -> int"""
10516 return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs)
10517
10518 def GetPercent(*args, **kwargs):
10519 """GetPercent(self) -> int"""
10520 return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs)
10521
10522 def GetOtherEdge(*args, **kwargs):
10523 """GetOtherEdge(self) -> int"""
10524 return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs)
10525
10526 def GetDone(*args, **kwargs):
10527 """GetDone(self) -> bool"""
10528 return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs)
10529
10530 def SetDone(*args, **kwargs):
10531 """SetDone(self, bool d)"""
10532 return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs)
10533
10534 def GetRelationship(*args, **kwargs):
10535 """GetRelationship(self) -> int"""
10536 return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs)
10537
10538 def SetRelationship(*args, **kwargs):
10539 """SetRelationship(self, int r)"""
10540 return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs)
10541
10542 def ResetIfWin(*args, **kwargs):
10543 """
10544 ResetIfWin(self, Window otherW) -> bool
10545
10546 Reset constraint if it mentions otherWin
10547 """
10548 return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs)
10549
10550 def SatisfyConstraint(*args, **kwargs):
10551 """
10552 SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool
10553
10554 Try to satisfy constraint
10555 """
10556 return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs)
10557
10558 def GetEdge(*args, **kwargs):
10559 """
10560 GetEdge(self, int which, Window thisWin, Window other) -> int
10561
10562 Get the value of this edge or dimension, or if this
10563 is not determinable, -1.
10564 """
10565 return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
10566
10567
10568class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
10569 def __init__(self, this):
10570 self.this = this
10571 if not hasattr(self,"thisown"): self.thisown = 0
10572 self.__class__ = IndividualLayoutConstraint
10573_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
10574
10575class LayoutConstraints(Object):
10576 """
79fccf9d
RD
10577 **Note:** constraints are now deprecated and you should use sizers
10578 instead.
d55e5bfc 10579
79fccf9d
RD
10580 Objects of this class can be associated with a window to define its
10581 layout constraints, with respect to siblings or its parent.
d55e5bfc
RD
10582
10583 The class consists of the following eight constraints of class
10584 wx.IndividualLayoutConstraint, some or all of which should be accessed
10585 directly to set the appropriate constraints.
10586
10587 * left: represents the left hand edge of the window
10588 * right: represents the right hand edge of the window
10589 * top: represents the top edge of the window
10590 * bottom: represents the bottom edge of the window
10591 * width: represents the width of the window
10592 * height: represents the height of the window
10593 * centreX: represents the horizontal centre point of the window
10594 * centreY: represents the vertical centre point of the window
10595
79fccf9d
RD
10596 Most constraints are initially set to have the relationship
10597 wxUnconstrained, which means that their values should be calculated by
10598 looking at known constraints. The exceptions are width and height,
10599 which are set to wxAsIs to ensure that if the user does not specify a
10600 constraint, the existing width and height will be used, to be
10601 compatible with panel items which often have take a default size. If
10602 the constraint is ``wx.AsIs``, the dimension will not be changed.
10603
10604 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
d55e5bfc
RD
10605
10606 """
10607 def __repr__(self):
10608 return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
10609 left = property(_core_.LayoutConstraints_left_get)
10610 top = property(_core_.LayoutConstraints_top_get)
10611 right = property(_core_.LayoutConstraints_right_get)
10612 bottom = property(_core_.LayoutConstraints_bottom_get)
10613 width = property(_core_.LayoutConstraints_width_get)
10614 height = property(_core_.LayoutConstraints_height_get)
10615 centreX = property(_core_.LayoutConstraints_centreX_get)
10616 centreY = property(_core_.LayoutConstraints_centreY_get)
10617 def __init__(self, *args, **kwargs):
10618 """__init__(self) -> LayoutConstraints"""
10619 newobj = _core_.new_LayoutConstraints(*args, **kwargs)
10620 self.this = newobj.this
10621 self.thisown = 1
10622 del newobj.thisown
10623 def SatisfyConstraints(*args, **kwargs):
10624 """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
10625 return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
10626
10627 def AreSatisfied(*args, **kwargs):
10628 """AreSatisfied(self) -> bool"""
10629 return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
10630
10631
10632class LayoutConstraintsPtr(LayoutConstraints):
10633 def __init__(self, this):
10634 self.this = this
10635 if not hasattr(self,"thisown"): self.thisown = 0
10636 self.__class__ = LayoutConstraints
10637_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
10638
10639#----------------------------------------------------------------------------
10640
10641# Use Python's bool constants if available, make some if not
10642try:
10643 True
10644except NameError:
10645 __builtins__.True = 1==1
10646 __builtins__.False = 1==0
10647 def bool(value): return not not value
10648 __builtins__.bool = bool
10649
10650
10651
10652# workarounds for bad wxRTTI names
10653__wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
10654__wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
10655__wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
10656
10657
10658#----------------------------------------------------------------------------
10659# Load version numbers from __version__... Ensure that major and minor
0f63ec68 10660# versions are the same for both wxPython and wxWidgets.
d55e5bfc
RD
10661
10662from __version__ import *
10663__version__ = VERSION_STRING
10664
0f63ec68
RD
10665assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
10666assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
d55e5bfc
RD
10667if RELEASE_VERSION != _core_.RELEASE_VERSION:
10668 import warnings
0f63ec68 10669 warnings.warn("wxPython/wxWidgets release number mismatch")
d55e5bfc
RD
10670
10671#----------------------------------------------------------------------------
10672
10673class PyDeadObjectError(AttributeError):
10674 pass
10675
10676class _wxPyDeadObject(object):
10677 """
10678 Instances of wx objects that are OOR capable will have their __class__
10679 changed to this class when the C++ object is deleted. This should help
10680 prevent crashes due to referencing a bogus C++ pointer.
10681 """
10682 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
10683 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
10684
10685 def __repr__(self):
10686 if not hasattr(self, "_name"):
10687 self._name = "[unknown]"
10688 return self.reprStr % self._name
10689
10690 def __getattr__(self, *args):
10691 if not hasattr(self, "_name"):
10692 self._name = "[unknown]"
10693 raise PyDeadObjectError(self.attrStr % self._name)
10694
10695 def __nonzero__(self):
10696 return 0
10697
10698
10699
10700class PyUnbornObjectError(AttributeError):
10701 pass
10702
10703class _wxPyUnbornObject(object):
10704 """
10705 Some stock objects are created when the wx._core module is
10706 imported, but their C++ instance is not created until the wx.App
10707 object is created and initialized. These object instances will
10708 temporarily have their __class__ changed to this class so an
10709 exception will be raised if they are used before the C++ instance
10710 is ready.
10711 """
10712
10713 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
10714 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
10715
10716 def __repr__(self):
10717 #if not hasattr(self, "_name"):
10718 # self._name = "[unknown]"
10719 return self.reprStr #% self._name
10720
10721 def __getattr__(self, *args):
10722 #if not hasattr(self, "_name"):
10723 # self._name = "[unknown]"
10724 raise PyUnbornObjectError(self.attrStr) # % self._name )
10725
10726 def __nonzero__(self):
10727 return 0
10728
10729
10730#----------------------------------------------------------------------------
10731_wxPyCallAfterId = None
10732
10733def CallAfter(callable, *args, **kw):
10734 """
10735 Call the specified function after the current and pending event
10736 handlers have been completed. This is also good for making GUI
0439c23b
RD
10737 method calls from non-GUI threads. Any extra positional or
10738 keyword args are passed on to the callable when it is called.
10739
10740 :see: `wx.FutureCall`
d55e5bfc
RD
10741 """
10742 app = wx.GetApp()
a001823c 10743 assert app is not None, 'No wx.App created yet'
d55e5bfc
RD
10744
10745 global _wxPyCallAfterId
10746 if _wxPyCallAfterId is None:
10747 _wxPyCallAfterId = wx.NewEventType()
10748 app.Connect(-1, -1, _wxPyCallAfterId,
10749 lambda event: event.callable(*event.args, **event.kw) )
10750 evt = wx.PyEvent()
10751 evt.SetEventType(_wxPyCallAfterId)
10752 evt.callable = callable
10753 evt.args = args
10754 evt.kw = kw
10755 wx.PostEvent(app, evt)
10756
10757
10758#----------------------------------------------------------------------------
10759
10760
10761class FutureCall:
10762 """
10763 A convenience class for wx.Timer, that calls the given callable
10764 object once after the given amount of milliseconds, passing any
10765 positional or keyword args. The return value of the callable is
0439c23b 10766 availbale after it has been run with the `GetResult` method.
d55e5bfc
RD
10767
10768 If you don't need to get the return value or restart the timer
10769 then there is no need to hold a reference to this object. It will
10770 hold a reference to itself while the timer is running (the timer
10771 has a reference to self.Notify) but the cycle will be broken when
10772 the timer completes, automatically cleaning up the wx.FutureCall
10773 object.
0439c23b
RD
10774
10775 :see: `wx.CallAfter`
d55e5bfc
RD
10776 """
10777 def __init__(self, millis, callable, *args, **kwargs):
10778 self.millis = millis
10779 self.callable = callable
10780 self.SetArgs(*args, **kwargs)
10781 self.runCount = 0
10782 self.running = False
10783 self.hasRun = False
10784 self.result = None
10785 self.timer = None
10786 self.Start()
10787
10788 def __del__(self):
10789 self.Stop()
10790
10791
10792 def Start(self, millis=None, *args, **kwargs):
10793 """
10794 (Re)start the timer
10795 """
10796 self.hasRun = False
10797 if millis is not None:
10798 self.millis = millis
10799 if args or kwargs:
10800 self.SetArgs(*args, **kwargs)
10801 self.Stop()
10802 self.timer = wx.PyTimer(self.Notify)
10803 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
10804 self.running = True
10805 Restart = Start
10806
10807
10808 def Stop(self):
10809 """
10810 Stop and destroy the timer.
10811 """
10812 if self.timer is not None:
10813 self.timer.Stop()
10814 self.timer = None
10815
10816
10817 def GetInterval(self):
10818 if self.timer is not None:
10819 return self.timer.GetInterval()
10820 else:
10821 return 0
10822
10823
10824 def IsRunning(self):
10825 return self.timer is not None and self.timer.IsRunning()
10826
10827
10828 def SetArgs(self, *args, **kwargs):
10829 """
10830 (Re)set the args passed to the callable object. This is
10831 useful in conjunction with Restart if you want to schedule a
10832 new call to the same callable object but with different
10833 parameters.
10834 """
10835 self.args = args
10836 self.kwargs = kwargs
10837
10838
10839 def HasRun(self):
10840 return self.hasRun
10841
10842 def GetResult(self):
10843 return self.result
10844
10845 def Notify(self):
10846 """
10847 The timer has expired so call the callable.
10848 """
10849 if self.callable and getattr(self.callable, 'im_self', True):
10850 self.runCount += 1
10851 self.running = False
10852 self.result = self.callable(*self.args, **self.kwargs)
10853 self.hasRun = True
10854 if not self.running:
10855 # if it wasn't restarted, then cleanup
10856 wx.CallAfter(self.Stop)
10857
10858
10859
10860#----------------------------------------------------------------------------
10861# Control which items in this module should be documented by epydoc.
10862# We allow only classes and functions, which will help reduce the size
10863# of the docs by filtering out the zillions of constants, EVT objects,
10864# and etc that don't make much sense by themselves, but are instead
10865# documented (or will be) as part of the classes/functions/methods
10866# where they should be used.
10867
c24da6d6
RD
10868class __DocFilter:
10869 """
10870 A filter for epydoc that only allows non-Ptr classes and
10871 fucntions, in order to reduce the clutter in the API docs.
10872 """
10873 def __init__(self, globals):
10874 self._globals = globals
10875
10876 def __call__(self, name):
10877 import types
10878 obj = self._globals.get(name, None)
10879 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
10880 return False
10881 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
10882 return False
10883 return True
d55e5bfc
RD
10884
10885#----------------------------------------------------------------------------
10886#----------------------------------------------------------------------------
10887
10888# Import other modules in this package that should show up in the
10889# "core" wx namespace
10890from _gdi import *
10891from _windows import *
10892from _controls import *
10893from _misc import *
10894
10895
10896# Fixup the stock objects since they can't be used yet. (They will be
10897# restored in wx.PyApp.OnInit.)
10898_core_._wxPyFixStockObjects()
10899
10900#----------------------------------------------------------------------------
10901#----------------------------------------------------------------------------
10902
10903