]>
Commit | Line | Data |
---|---|---|
0085ce49 | 1 | # This file was created automatically by SWIG 1.3.29. |
d14a1e28 RD |
2 | # Don't modify this file, modify the SWIG interface instead. |
3 | ||
54f9ee45 | 4 | import _core_ |
0085ce49 RD |
5 | import new |
6 | new_instancemethod = new.instancemethod | |
093d3ff1 | 7 | def _swig_setattr_nondynamic(self,class_type,name,value,static=1): |
0085ce49 | 8 | if (name == "thisown"): return self.this.own(value) |
093d3ff1 | 9 | if (name == "this"): |
0085ce49 RD |
10 | if type(value).__name__ == 'PySwigObject': |
11 | self.__dict__[name] = value | |
093d3ff1 RD |
12 | return |
13 | method = class_type.__swig_setmethods__.get(name,None) | |
14 | if method: return method(self,value) | |
0085ce49 | 15 | if (not static) or hasattr(self,name): |
093d3ff1 RD |
16 | self.__dict__[name] = value |
17 | else: | |
18 | raise AttributeError("You cannot add attributes to %s" % self) | |
19 | ||
20 | def _swig_setattr(self,class_type,name,value): | |
21 | return _swig_setattr_nondynamic(self,class_type,name,value,0) | |
22 | ||
23 | def _swig_getattr(self,class_type,name): | |
0085ce49 | 24 | if (name == "thisown"): return self.this.own() |
093d3ff1 RD |
25 | method = class_type.__swig_getmethods__.get(name,None) |
26 | if method: return method(self) | |
27 | raise AttributeError,name | |
28 | ||
0085ce49 RD |
29 | def _swig_repr(self): |
30 | try: strthis = "proxy of " + self.this.__repr__() | |
31 | except: strthis = "" | |
32 | return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,) | |
33 | ||
093d3ff1 RD |
34 | import types |
35 | try: | |
36 | _object = types.ObjectType | |
37 | _newclass = 1 | |
38 | except AttributeError: | |
39 | class _object : pass | |
40 | _newclass = 0 | |
41 | del types | |
42 | ||
43 | ||
44 | def _swig_setattr_nondynamic_method(set): | |
45 | def set_attr(self,name,value): | |
0085ce49 RD |
46 | if (name == "thisown"): return self.this.own(value) |
47 | if hasattr(self,name) or (name == "this"): | |
093d3ff1 RD |
48 | set(self,name,value) |
49 | else: | |
50 | raise AttributeError("You cannot add attributes to %s" % self) | |
51 | return set_attr | |
52 | ||
53 | ||
d14a1e28 RD |
54 | #// Give a reference to the dictionary of this module to the C++ extension |
55 | #// code. | |
54f9ee45 | 56 | _core_._wxPySetDictionary(vars()) |
d14a1e28 RD |
57 | |
58 | #// A little trick to make 'wx' be a reference to this module so wx.Names can | |
59 | #// be used here. | |
60 | import sys as _sys | |
61 | wx = _sys.modules[__name__] | |
62 | ||
66c033b4 RD |
63 | |
64 | #---------------------------------------------------------------------------- | |
65 | ||
66 | def _deprecated(callable, msg=None): | |
67 | """ | |
68 | Create a wrapper function that will raise a DeprecationWarning | |
69 | before calling the callable. | |
70 | """ | |
71 | if msg is None: | |
72 | msg = "%s is deprecated" % callable | |
73 | def deprecatedWrapper(*args, **kwargs): | |
74 | import warnings | |
75 | warnings.warn(msg, DeprecationWarning, stacklevel=2) | |
76 | return callable(*args, **kwargs) | |
77 | deprecatedWrapper.__doc__ = msg | |
78 | return deprecatedWrapper | |
79 | ||
80 | ||
81 | #---------------------------------------------------------------------------- | |
82 | ||
54f9ee45 RD |
83 | NOT_FOUND = _core_.NOT_FOUND |
84 | VSCROLL = _core_.VSCROLL | |
85 | HSCROLL = _core_.HSCROLL | |
86 | CAPTION = _core_.CAPTION | |
87 | DOUBLE_BORDER = _core_.DOUBLE_BORDER | |
88 | SUNKEN_BORDER = _core_.SUNKEN_BORDER | |
89 | RAISED_BORDER = _core_.RAISED_BORDER | |
90 | BORDER = _core_.BORDER | |
91 | SIMPLE_BORDER = _core_.SIMPLE_BORDER | |
92 | STATIC_BORDER = _core_.STATIC_BORDER | |
93 | TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW | |
94 | NO_BORDER = _core_.NO_BORDER | |
bcd0d7b6 | 95 | DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER |
6d88e192 | 96 | DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE |
54f9ee45 RD |
97 | TAB_TRAVERSAL = _core_.TAB_TRAVERSAL |
98 | WANTS_CHARS = _core_.WANTS_CHARS | |
99 | POPUP_WINDOW = _core_.POPUP_WINDOW | |
100 | CENTER_FRAME = _core_.CENTER_FRAME | |
101 | CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN | |
102 | CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN | |
54f9ee45 RD |
103 | CLIP_CHILDREN = _core_.CLIP_CHILDREN |
104 | CLIP_SIBLINGS = _core_.CLIP_SIBLINGS | |
092f0ed7 | 105 | WINDOW_STYLE_MASK = _core_.WINDOW_STYLE_MASK |
54f9ee45 RD |
106 | ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB |
107 | RETAINED = _core_.RETAINED | |
108 | BACKINGSTORE = _core_.BACKINGSTORE | |
109 | COLOURED = _core_.COLOURED | |
110 | FIXED_LENGTH = _core_.FIXED_LENGTH | |
111 | LB_NEEDED_SB = _core_.LB_NEEDED_SB | |
112 | LB_ALWAYS_SB = _core_.LB_ALWAYS_SB | |
113 | LB_SORT = _core_.LB_SORT | |
114 | LB_SINGLE = _core_.LB_SINGLE | |
115 | LB_MULTIPLE = _core_.LB_MULTIPLE | |
116 | LB_EXTENDED = _core_.LB_EXTENDED | |
117 | LB_OWNERDRAW = _core_.LB_OWNERDRAW | |
118 | LB_HSCROLL = _core_.LB_HSCROLL | |
119 | PROCESS_ENTER = _core_.PROCESS_ENTER | |
120 | PASSWORD = _core_.PASSWORD | |
121 | CB_SIMPLE = _core_.CB_SIMPLE | |
122 | CB_DROPDOWN = _core_.CB_DROPDOWN | |
123 | CB_SORT = _core_.CB_SORT | |
124 | CB_READONLY = _core_.CB_READONLY | |
125 | RA_HORIZONTAL = _core_.RA_HORIZONTAL | |
126 | RA_VERTICAL = _core_.RA_VERTICAL | |
127 | RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS | |
128 | RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS | |
fef4c27a | 129 | RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX |
54f9ee45 RD |
130 | RB_GROUP = _core_.RB_GROUP |
131 | RB_SINGLE = _core_.RB_SINGLE | |
54f9ee45 RD |
132 | SB_HORIZONTAL = _core_.SB_HORIZONTAL |
133 | SB_VERTICAL = _core_.SB_VERTICAL | |
fef4c27a | 134 | RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX |
54f9ee45 RD |
135 | ST_SIZEGRIP = _core_.ST_SIZEGRIP |
136 | ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE | |
e9d6f3a4 RD |
137 | ST_DOTS_MIDDLE = _core_.ST_DOTS_MIDDLE |
138 | ST_DOTS_END = _core_.ST_DOTS_END | |
54f9ee45 RD |
139 | FLOOD_SURFACE = _core_.FLOOD_SURFACE |
140 | FLOOD_BORDER = _core_.FLOOD_BORDER | |
141 | ODDEVEN_RULE = _core_.ODDEVEN_RULE | |
142 | WINDING_RULE = _core_.WINDING_RULE | |
143 | TOOL_TOP = _core_.TOOL_TOP | |
144 | TOOL_BOTTOM = _core_.TOOL_BOTTOM | |
145 | TOOL_LEFT = _core_.TOOL_LEFT | |
146 | TOOL_RIGHT = _core_.TOOL_RIGHT | |
147 | OK = _core_.OK | |
148 | YES_NO = _core_.YES_NO | |
149 | CANCEL = _core_.CANCEL | |
150 | YES = _core_.YES | |
151 | NO = _core_.NO | |
152 | NO_DEFAULT = _core_.NO_DEFAULT | |
153 | YES_DEFAULT = _core_.YES_DEFAULT | |
154 | ICON_EXCLAMATION = _core_.ICON_EXCLAMATION | |
155 | ICON_HAND = _core_.ICON_HAND | |
156 | ICON_QUESTION = _core_.ICON_QUESTION | |
157 | ICON_INFORMATION = _core_.ICON_INFORMATION | |
158 | ICON_STOP = _core_.ICON_STOP | |
159 | ICON_ASTERISK = _core_.ICON_ASTERISK | |
160 | ICON_MASK = _core_.ICON_MASK | |
161 | ICON_WARNING = _core_.ICON_WARNING | |
162 | ICON_ERROR = _core_.ICON_ERROR | |
163 | FORWARD = _core_.FORWARD | |
164 | BACKWARD = _core_.BACKWARD | |
165 | RESET = _core_.RESET | |
166 | HELP = _core_.HELP | |
167 | MORE = _core_.MORE | |
168 | SETUP = _core_.SETUP | |
169 | SIZE_AUTO_WIDTH = _core_.SIZE_AUTO_WIDTH | |
170 | SIZE_AUTO_HEIGHT = _core_.SIZE_AUTO_HEIGHT | |
171 | SIZE_AUTO = _core_.SIZE_AUTO | |
172 | SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING | |
173 | SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE | |
943e8dfd | 174 | SIZE_FORCE = _core_.SIZE_FORCE |
54f9ee45 RD |
175 | PORTRAIT = _core_.PORTRAIT |
176 | LANDSCAPE = _core_.LANDSCAPE | |
177 | PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH | |
178 | PRINT_QUALITY_MEDIUM = _core_.PRINT_QUALITY_MEDIUM | |
179 | PRINT_QUALITY_LOW = _core_.PRINT_QUALITY_LOW | |
180 | PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT | |
181 | ID_ANY = _core_.ID_ANY | |
182 | ID_SEPARATOR = _core_.ID_SEPARATOR | |
943e8dfd | 183 | ID_NONE = _core_.ID_NONE |
54f9ee45 RD |
184 | ID_LOWEST = _core_.ID_LOWEST |
185 | ID_OPEN = _core_.ID_OPEN | |
186 | ID_CLOSE = _core_.ID_CLOSE | |
187 | ID_NEW = _core_.ID_NEW | |
188 | ID_SAVE = _core_.ID_SAVE | |
189 | ID_SAVEAS = _core_.ID_SAVEAS | |
190 | ID_REVERT = _core_.ID_REVERT | |
191 | ID_EXIT = _core_.ID_EXIT | |
192 | ID_UNDO = _core_.ID_UNDO | |
193 | ID_REDO = _core_.ID_REDO | |
194 | ID_HELP = _core_.ID_HELP | |
195 | ID_PRINT = _core_.ID_PRINT | |
196 | ID_PRINT_SETUP = _core_.ID_PRINT_SETUP | |
fc46b7f3 | 197 | ID_PAGE_SETUP = _core_.ID_PAGE_SETUP |
54f9ee45 RD |
198 | ID_PREVIEW = _core_.ID_PREVIEW |
199 | ID_ABOUT = _core_.ID_ABOUT | |
200 | ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS | |
201 | ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS | |
202 | ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES | |
203 | ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT | |
10044bf1 RD |
204 | ID_HELP_INDEX = _core_.ID_HELP_INDEX |
205 | ID_HELP_SEARCH = _core_.ID_HELP_SEARCH | |
54f9ee45 RD |
206 | ID_CLOSE_ALL = _core_.ID_CLOSE_ALL |
207 | ID_PREFERENCES = _core_.ID_PREFERENCES | |
97ab0f6a | 208 | ID_EDIT = _core_.ID_EDIT |
54f9ee45 RD |
209 | ID_CUT = _core_.ID_CUT |
210 | ID_COPY = _core_.ID_COPY | |
211 | ID_PASTE = _core_.ID_PASTE | |
212 | ID_CLEAR = _core_.ID_CLEAR | |
213 | ID_FIND = _core_.ID_FIND | |
214 | ID_DUPLICATE = _core_.ID_DUPLICATE | |
215 | ID_SELECTALL = _core_.ID_SELECTALL | |
216 | ID_DELETE = _core_.ID_DELETE | |
217 | ID_REPLACE = _core_.ID_REPLACE | |
218 | ID_REPLACE_ALL = _core_.ID_REPLACE_ALL | |
219 | ID_PROPERTIES = _core_.ID_PROPERTIES | |
220 | ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS | |
221 | ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS | |
222 | ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS | |
223 | ID_VIEW_LIST = _core_.ID_VIEW_LIST | |
224 | ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE | |
225 | ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME | |
226 | ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE | |
227 | ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE | |
97ab0f6a | 228 | ID_FILE = _core_.ID_FILE |
54f9ee45 RD |
229 | ID_FILE1 = _core_.ID_FILE1 |
230 | ID_FILE2 = _core_.ID_FILE2 | |
231 | ID_FILE3 = _core_.ID_FILE3 | |
232 | ID_FILE4 = _core_.ID_FILE4 | |
233 | ID_FILE5 = _core_.ID_FILE5 | |
234 | ID_FILE6 = _core_.ID_FILE6 | |
235 | ID_FILE7 = _core_.ID_FILE7 | |
236 | ID_FILE8 = _core_.ID_FILE8 | |
237 | ID_FILE9 = _core_.ID_FILE9 | |
238 | ID_OK = _core_.ID_OK | |
239 | ID_CANCEL = _core_.ID_CANCEL | |
240 | ID_APPLY = _core_.ID_APPLY | |
241 | ID_YES = _core_.ID_YES | |
242 | ID_NO = _core_.ID_NO | |
243 | ID_STATIC = _core_.ID_STATIC | |
244 | ID_FORWARD = _core_.ID_FORWARD | |
245 | ID_BACKWARD = _core_.ID_BACKWARD | |
246 | ID_DEFAULT = _core_.ID_DEFAULT | |
247 | ID_MORE = _core_.ID_MORE | |
248 | ID_SETUP = _core_.ID_SETUP | |
249 | ID_RESET = _core_.ID_RESET | |
250 | ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP | |
251 | ID_YESTOALL = _core_.ID_YESTOALL | |
252 | ID_NOTOALL = _core_.ID_NOTOALL | |
253 | ID_ABORT = _core_.ID_ABORT | |
254 | ID_RETRY = _core_.ID_RETRY | |
255 | ID_IGNORE = _core_.ID_IGNORE | |
7bc1e663 RD |
256 | ID_ADD = _core_.ID_ADD |
257 | ID_REMOVE = _core_.ID_REMOVE | |
258 | ID_UP = _core_.ID_UP | |
259 | ID_DOWN = _core_.ID_DOWN | |
260 | ID_HOME = _core_.ID_HOME | |
261 | ID_REFRESH = _core_.ID_REFRESH | |
262 | ID_STOP = _core_.ID_STOP | |
263 | ID_INDEX = _core_.ID_INDEX | |
264 | ID_BOLD = _core_.ID_BOLD | |
265 | ID_ITALIC = _core_.ID_ITALIC | |
266 | ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER | |
267 | ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL | |
268 | ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT | |
269 | ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT | |
270 | ID_UNDERLINE = _core_.ID_UNDERLINE | |
271 | ID_INDENT = _core_.ID_INDENT | |
272 | ID_UNINDENT = _core_.ID_UNINDENT | |
273 | ID_ZOOM_100 = _core_.ID_ZOOM_100 | |
274 | ID_ZOOM_FIT = _core_.ID_ZOOM_FIT | |
275 | ID_ZOOM_IN = _core_.ID_ZOOM_IN | |
276 | ID_ZOOM_OUT = _core_.ID_ZOOM_OUT | |
277 | ID_UNDELETE = _core_.ID_UNDELETE | |
278 | ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED | |
54f9ee45 | 279 | ID_HIGHEST = _core_.ID_HIGHEST |
54f9ee45 RD |
280 | MENU_TEAROFF = _core_.MENU_TEAROFF |
281 | MB_DOCKABLE = _core_.MB_DOCKABLE | |
282 | NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE | |
283 | FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE | |
284 | LI_HORIZONTAL = _core_.LI_HORIZONTAL | |
285 | LI_VERTICAL = _core_.LI_VERTICAL | |
286 | WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY | |
287 | WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS | |
288 | WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT | |
289 | WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND | |
290 | WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE | |
291 | WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES | |
292 | MM_TEXT = _core_.MM_TEXT | |
293 | MM_LOMETRIC = _core_.MM_LOMETRIC | |
294 | MM_HIMETRIC = _core_.MM_HIMETRIC | |
295 | MM_LOENGLISH = _core_.MM_LOENGLISH | |
296 | MM_HIENGLISH = _core_.MM_HIENGLISH | |
297 | MM_TWIPS = _core_.MM_TWIPS | |
298 | MM_ISOTROPIC = _core_.MM_ISOTROPIC | |
299 | MM_ANISOTROPIC = _core_.MM_ANISOTROPIC | |
300 | MM_POINTS = _core_.MM_POINTS | |
301 | MM_METRIC = _core_.MM_METRIC | |
302 | CENTRE = _core_.CENTRE | |
303 | CENTER = _core_.CENTER | |
304 | HORIZONTAL = _core_.HORIZONTAL | |
305 | VERTICAL = _core_.VERTICAL | |
306 | BOTH = _core_.BOTH | |
307 | LEFT = _core_.LEFT | |
308 | RIGHT = _core_.RIGHT | |
309 | UP = _core_.UP | |
310 | DOWN = _core_.DOWN | |
311 | TOP = _core_.TOP | |
312 | BOTTOM = _core_.BOTTOM | |
313 | NORTH = _core_.NORTH | |
314 | SOUTH = _core_.SOUTH | |
315 | WEST = _core_.WEST | |
316 | EAST = _core_.EAST | |
317 | ALL = _core_.ALL | |
318 | ALIGN_NOT = _core_.ALIGN_NOT | |
319 | ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL | |
320 | ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL | |
321 | ALIGN_LEFT = _core_.ALIGN_LEFT | |
322 | ALIGN_TOP = _core_.ALIGN_TOP | |
323 | ALIGN_RIGHT = _core_.ALIGN_RIGHT | |
324 | ALIGN_BOTTOM = _core_.ALIGN_BOTTOM | |
325 | ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL | |
326 | ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL | |
327 | ALIGN_CENTER = _core_.ALIGN_CENTER | |
328 | ALIGN_CENTRE = _core_.ALIGN_CENTRE | |
329 | ALIGN_MASK = _core_.ALIGN_MASK | |
330 | STRETCH_NOT = _core_.STRETCH_NOT | |
331 | SHRINK = _core_.SHRINK | |
332 | GROW = _core_.GROW | |
333 | EXPAND = _core_.EXPAND | |
334 | SHAPED = _core_.SHAPED | |
335 | FIXED_MINSIZE = _core_.FIXED_MINSIZE | |
336 | TILE = _core_.TILE | |
337 | ADJUST_MINSIZE = _core_.ADJUST_MINSIZE | |
338 | BORDER_DEFAULT = _core_.BORDER_DEFAULT | |
339 | BORDER_NONE = _core_.BORDER_NONE | |
340 | BORDER_STATIC = _core_.BORDER_STATIC | |
341 | BORDER_SIMPLE = _core_.BORDER_SIMPLE | |
342 | BORDER_RAISED = _core_.BORDER_RAISED | |
343 | BORDER_SUNKEN = _core_.BORDER_SUNKEN | |
344 | BORDER_DOUBLE = _core_.BORDER_DOUBLE | |
345 | BORDER_MASK = _core_.BORDER_MASK | |
7bc1e663 RD |
346 | BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM |
347 | BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR | |
348 | BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM | |
54f9ee45 RD |
349 | DEFAULT = _core_.DEFAULT |
350 | DECORATIVE = _core_.DECORATIVE | |
351 | ROMAN = _core_.ROMAN | |
352 | SCRIPT = _core_.SCRIPT | |
353 | SWISS = _core_.SWISS | |
354 | MODERN = _core_.MODERN | |
355 | TELETYPE = _core_.TELETYPE | |
356 | VARIABLE = _core_.VARIABLE | |
357 | FIXED = _core_.FIXED | |
358 | NORMAL = _core_.NORMAL | |
359 | LIGHT = _core_.LIGHT | |
360 | BOLD = _core_.BOLD | |
361 | ITALIC = _core_.ITALIC | |
362 | SLANT = _core_.SLANT | |
363 | SOLID = _core_.SOLID | |
364 | DOT = _core_.DOT | |
365 | LONG_DASH = _core_.LONG_DASH | |
366 | SHORT_DASH = _core_.SHORT_DASH | |
367 | DOT_DASH = _core_.DOT_DASH | |
368 | USER_DASH = _core_.USER_DASH | |
369 | TRANSPARENT = _core_.TRANSPARENT | |
370 | STIPPLE = _core_.STIPPLE | |
d04418a7 RD |
371 | STIPPLE_MASK = _core_.STIPPLE_MASK |
372 | STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE | |
54f9ee45 RD |
373 | BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH |
374 | CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH | |
375 | FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH | |
376 | CROSS_HATCH = _core_.CROSS_HATCH | |
377 | HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH | |
378 | VERTICAL_HATCH = _core_.VERTICAL_HATCH | |
379 | JOIN_BEVEL = _core_.JOIN_BEVEL | |
380 | JOIN_MITER = _core_.JOIN_MITER | |
381 | JOIN_ROUND = _core_.JOIN_ROUND | |
382 | CAP_ROUND = _core_.CAP_ROUND | |
383 | CAP_PROJECTING = _core_.CAP_PROJECTING | |
384 | CAP_BUTT = _core_.CAP_BUTT | |
385 | CLEAR = _core_.CLEAR | |
386 | XOR = _core_.XOR | |
387 | INVERT = _core_.INVERT | |
388 | OR_REVERSE = _core_.OR_REVERSE | |
389 | AND_REVERSE = _core_.AND_REVERSE | |
390 | COPY = _core_.COPY | |
391 | AND = _core_.AND | |
392 | AND_INVERT = _core_.AND_INVERT | |
393 | NO_OP = _core_.NO_OP | |
394 | NOR = _core_.NOR | |
395 | EQUIV = _core_.EQUIV | |
396 | SRC_INVERT = _core_.SRC_INVERT | |
397 | OR_INVERT = _core_.OR_INVERT | |
398 | NAND = _core_.NAND | |
399 | OR = _core_.OR | |
400 | SET = _core_.SET | |
401 | WXK_BACK = _core_.WXK_BACK | |
402 | WXK_TAB = _core_.WXK_TAB | |
403 | WXK_RETURN = _core_.WXK_RETURN | |
404 | WXK_ESCAPE = _core_.WXK_ESCAPE | |
405 | WXK_SPACE = _core_.WXK_SPACE | |
406 | WXK_DELETE = _core_.WXK_DELETE | |
407 | WXK_START = _core_.WXK_START | |
408 | WXK_LBUTTON = _core_.WXK_LBUTTON | |
409 | WXK_RBUTTON = _core_.WXK_RBUTTON | |
410 | WXK_CANCEL = _core_.WXK_CANCEL | |
411 | WXK_MBUTTON = _core_.WXK_MBUTTON | |
412 | WXK_CLEAR = _core_.WXK_CLEAR | |
413 | WXK_SHIFT = _core_.WXK_SHIFT | |
414 | WXK_ALT = _core_.WXK_ALT | |
415 | WXK_CONTROL = _core_.WXK_CONTROL | |
416 | WXK_MENU = _core_.WXK_MENU | |
417 | WXK_PAUSE = _core_.WXK_PAUSE | |
418 | WXK_CAPITAL = _core_.WXK_CAPITAL | |
419 | WXK_PRIOR = _core_.WXK_PRIOR | |
420 | WXK_NEXT = _core_.WXK_NEXT | |
421 | WXK_END = _core_.WXK_END | |
422 | WXK_HOME = _core_.WXK_HOME | |
423 | WXK_LEFT = _core_.WXK_LEFT | |
424 | WXK_UP = _core_.WXK_UP | |
425 | WXK_RIGHT = _core_.WXK_RIGHT | |
426 | WXK_DOWN = _core_.WXK_DOWN | |
427 | WXK_SELECT = _core_.WXK_SELECT | |
428 | WXK_PRINT = _core_.WXK_PRINT | |
429 | WXK_EXECUTE = _core_.WXK_EXECUTE | |
430 | WXK_SNAPSHOT = _core_.WXK_SNAPSHOT | |
431 | WXK_INSERT = _core_.WXK_INSERT | |
432 | WXK_HELP = _core_.WXK_HELP | |
433 | WXK_NUMPAD0 = _core_.WXK_NUMPAD0 | |
434 | WXK_NUMPAD1 = _core_.WXK_NUMPAD1 | |
435 | WXK_NUMPAD2 = _core_.WXK_NUMPAD2 | |
436 | WXK_NUMPAD3 = _core_.WXK_NUMPAD3 | |
437 | WXK_NUMPAD4 = _core_.WXK_NUMPAD4 | |
438 | WXK_NUMPAD5 = _core_.WXK_NUMPAD5 | |
439 | WXK_NUMPAD6 = _core_.WXK_NUMPAD6 | |
440 | WXK_NUMPAD7 = _core_.WXK_NUMPAD7 | |
441 | WXK_NUMPAD8 = _core_.WXK_NUMPAD8 | |
442 | WXK_NUMPAD9 = _core_.WXK_NUMPAD9 | |
443 | WXK_MULTIPLY = _core_.WXK_MULTIPLY | |
444 | WXK_ADD = _core_.WXK_ADD | |
445 | WXK_SEPARATOR = _core_.WXK_SEPARATOR | |
446 | WXK_SUBTRACT = _core_.WXK_SUBTRACT | |
447 | WXK_DECIMAL = _core_.WXK_DECIMAL | |
448 | WXK_DIVIDE = _core_.WXK_DIVIDE | |
449 | WXK_F1 = _core_.WXK_F1 | |
450 | WXK_F2 = _core_.WXK_F2 | |
451 | WXK_F3 = _core_.WXK_F3 | |
452 | WXK_F4 = _core_.WXK_F4 | |
453 | WXK_F5 = _core_.WXK_F5 | |
454 | WXK_F6 = _core_.WXK_F6 | |
455 | WXK_F7 = _core_.WXK_F7 | |
456 | WXK_F8 = _core_.WXK_F8 | |
457 | WXK_F9 = _core_.WXK_F9 | |
458 | WXK_F10 = _core_.WXK_F10 | |
459 | WXK_F11 = _core_.WXK_F11 | |
460 | WXK_F12 = _core_.WXK_F12 | |
461 | WXK_F13 = _core_.WXK_F13 | |
462 | WXK_F14 = _core_.WXK_F14 | |
463 | WXK_F15 = _core_.WXK_F15 | |
464 | WXK_F16 = _core_.WXK_F16 | |
465 | WXK_F17 = _core_.WXK_F17 | |
466 | WXK_F18 = _core_.WXK_F18 | |
467 | WXK_F19 = _core_.WXK_F19 | |
468 | WXK_F20 = _core_.WXK_F20 | |
469 | WXK_F21 = _core_.WXK_F21 | |
470 | WXK_F22 = _core_.WXK_F22 | |
471 | WXK_F23 = _core_.WXK_F23 | |
472 | WXK_F24 = _core_.WXK_F24 | |
473 | WXK_NUMLOCK = _core_.WXK_NUMLOCK | |
474 | WXK_SCROLL = _core_.WXK_SCROLL | |
475 | WXK_PAGEUP = _core_.WXK_PAGEUP | |
476 | WXK_PAGEDOWN = _core_.WXK_PAGEDOWN | |
477 | WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE | |
478 | WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB | |
479 | WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER | |
480 | WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1 | |
481 | WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2 | |
482 | WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3 | |
483 | WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4 | |
484 | WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME | |
485 | WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT | |
486 | WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP | |
487 | WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT | |
488 | WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN | |
489 | WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR | |
490 | WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP | |
491 | WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT | |
492 | WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN | |
493 | WXK_NUMPAD_END = _core_.WXK_NUMPAD_END | |
494 | WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN | |
495 | WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT | |
496 | WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE | |
497 | WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL | |
498 | WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY | |
499 | WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD | |
500 | WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR | |
501 | WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT | |
502 | WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL | |
503 | WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE | |
504 | WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT | |
505 | WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT | |
506 | WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU | |
88c6b281 RD |
507 | WXK_COMMAND = _core_.WXK_COMMAND |
508 | WXK_SPECIAL1 = _core_.WXK_SPECIAL1 | |
509 | WXK_SPECIAL2 = _core_.WXK_SPECIAL2 | |
510 | WXK_SPECIAL3 = _core_.WXK_SPECIAL3 | |
511 | WXK_SPECIAL4 = _core_.WXK_SPECIAL4 | |
512 | WXK_SPECIAL5 = _core_.WXK_SPECIAL5 | |
513 | WXK_SPECIAL6 = _core_.WXK_SPECIAL6 | |
514 | WXK_SPECIAL7 = _core_.WXK_SPECIAL7 | |
515 | WXK_SPECIAL8 = _core_.WXK_SPECIAL8 | |
516 | WXK_SPECIAL9 = _core_.WXK_SPECIAL9 | |
517 | WXK_SPECIAL10 = _core_.WXK_SPECIAL10 | |
518 | WXK_SPECIAL11 = _core_.WXK_SPECIAL11 | |
519 | WXK_SPECIAL12 = _core_.WXK_SPECIAL12 | |
520 | WXK_SPECIAL13 = _core_.WXK_SPECIAL13 | |
521 | WXK_SPECIAL14 = _core_.WXK_SPECIAL14 | |
522 | WXK_SPECIAL15 = _core_.WXK_SPECIAL15 | |
523 | WXK_SPECIAL16 = _core_.WXK_SPECIAL16 | |
524 | WXK_SPECIAL17 = _core_.WXK_SPECIAL17 | |
525 | WXK_SPECIAL18 = _core_.WXK_SPECIAL18 | |
526 | WXK_SPECIAL19 = _core_.WXK_SPECIAL19 | |
527 | WXK_SPECIAL20 = _core_.WXK_SPECIAL20 | |
54f9ee45 RD |
528 | PAPER_NONE = _core_.PAPER_NONE |
529 | PAPER_LETTER = _core_.PAPER_LETTER | |
530 | PAPER_LEGAL = _core_.PAPER_LEGAL | |
531 | PAPER_A4 = _core_.PAPER_A4 | |
532 | PAPER_CSHEET = _core_.PAPER_CSHEET | |
533 | PAPER_DSHEET = _core_.PAPER_DSHEET | |
534 | PAPER_ESHEET = _core_.PAPER_ESHEET | |
535 | PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL | |
536 | PAPER_TABLOID = _core_.PAPER_TABLOID | |
537 | PAPER_LEDGER = _core_.PAPER_LEDGER | |
538 | PAPER_STATEMENT = _core_.PAPER_STATEMENT | |
539 | PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE | |
540 | PAPER_A3 = _core_.PAPER_A3 | |
541 | PAPER_A4SMALL = _core_.PAPER_A4SMALL | |
542 | PAPER_A5 = _core_.PAPER_A5 | |
543 | PAPER_B4 = _core_.PAPER_B4 | |
544 | PAPER_B5 = _core_.PAPER_B5 | |
545 | PAPER_FOLIO = _core_.PAPER_FOLIO | |
546 | PAPER_QUARTO = _core_.PAPER_QUARTO | |
547 | PAPER_10X14 = _core_.PAPER_10X14 | |
548 | PAPER_11X17 = _core_.PAPER_11X17 | |
549 | PAPER_NOTE = _core_.PAPER_NOTE | |
550 | PAPER_ENV_9 = _core_.PAPER_ENV_9 | |
551 | PAPER_ENV_10 = _core_.PAPER_ENV_10 | |
552 | PAPER_ENV_11 = _core_.PAPER_ENV_11 | |
553 | PAPER_ENV_12 = _core_.PAPER_ENV_12 | |
554 | PAPER_ENV_14 = _core_.PAPER_ENV_14 | |
555 | PAPER_ENV_DL = _core_.PAPER_ENV_DL | |
556 | PAPER_ENV_C5 = _core_.PAPER_ENV_C5 | |
557 | PAPER_ENV_C3 = _core_.PAPER_ENV_C3 | |
558 | PAPER_ENV_C4 = _core_.PAPER_ENV_C4 | |
559 | PAPER_ENV_C6 = _core_.PAPER_ENV_C6 | |
560 | PAPER_ENV_C65 = _core_.PAPER_ENV_C65 | |
561 | PAPER_ENV_B4 = _core_.PAPER_ENV_B4 | |
562 | PAPER_ENV_B5 = _core_.PAPER_ENV_B5 | |
563 | PAPER_ENV_B6 = _core_.PAPER_ENV_B6 | |
564 | PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY | |
565 | PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH | |
566 | PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL | |
567 | PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US | |
568 | PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN | |
569 | PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN | |
570 | PAPER_ISO_B4 = _core_.PAPER_ISO_B4 | |
571 | PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD | |
572 | PAPER_9X11 = _core_.PAPER_9X11 | |
573 | PAPER_10X11 = _core_.PAPER_10X11 | |
574 | PAPER_15X11 = _core_.PAPER_15X11 | |
575 | PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE | |
576 | PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA | |
577 | PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA | |
578 | PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA | |
579 | PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA | |
580 | PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE | |
581 | PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE | |
582 | PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE | |
583 | PAPER_A_PLUS = _core_.PAPER_A_PLUS | |
584 | PAPER_B_PLUS = _core_.PAPER_B_PLUS | |
585 | PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS | |
586 | PAPER_A4_PLUS = _core_.PAPER_A4_PLUS | |
587 | PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE | |
588 | PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE | |
589 | PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA | |
590 | PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA | |
591 | PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA | |
592 | PAPER_A2 = _core_.PAPER_A2 | |
593 | PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE | |
594 | PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE | |
6c75a4cf RD |
595 | PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD |
596 | PAPER_A6 = _core_.PAPER_A6 | |
597 | PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2 | |
598 | PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3 | |
599 | PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3 | |
600 | PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4 | |
601 | PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED | |
602 | PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED | |
603 | PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED | |
604 | PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED | |
605 | PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED | |
606 | PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED | |
607 | PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED | |
608 | PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED | |
609 | PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED | |
610 | PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED | |
611 | PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED | |
612 | PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED | |
613 | PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED | |
614 | PAPER_B6_JIS = _core_.PAPER_B6_JIS | |
615 | PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED | |
616 | PAPER_12X11 = _core_.PAPER_12X11 | |
617 | PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4 | |
618 | PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED | |
619 | PAPER_P16K = _core_.PAPER_P16K | |
620 | PAPER_P32K = _core_.PAPER_P32K | |
621 | PAPER_P32KBIG = _core_.PAPER_P32KBIG | |
622 | PAPER_PENV_1 = _core_.PAPER_PENV_1 | |
623 | PAPER_PENV_2 = _core_.PAPER_PENV_2 | |
624 | PAPER_PENV_3 = _core_.PAPER_PENV_3 | |
625 | PAPER_PENV_4 = _core_.PAPER_PENV_4 | |
626 | PAPER_PENV_5 = _core_.PAPER_PENV_5 | |
627 | PAPER_PENV_6 = _core_.PAPER_PENV_6 | |
628 | PAPER_PENV_7 = _core_.PAPER_PENV_7 | |
629 | PAPER_PENV_8 = _core_.PAPER_PENV_8 | |
630 | PAPER_PENV_9 = _core_.PAPER_PENV_9 | |
631 | PAPER_PENV_10 = _core_.PAPER_PENV_10 | |
632 | PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED | |
633 | PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED | |
634 | PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED | |
635 | PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED | |
636 | PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED | |
637 | PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED | |
638 | PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED | |
639 | PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED | |
640 | PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED | |
641 | PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED | |
642 | PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED | |
643 | PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED | |
644 | PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED | |
54f9ee45 RD |
645 | DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX |
646 | DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL | |
647 | DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL | |
648 | ITEM_SEPARATOR = _core_.ITEM_SEPARATOR | |
649 | ITEM_NORMAL = _core_.ITEM_NORMAL | |
650 | ITEM_CHECK = _core_.ITEM_CHECK | |
651 | ITEM_RADIO = _core_.ITEM_RADIO | |
652 | ITEM_MAX = _core_.ITEM_MAX | |
653 | HT_NOWHERE = _core_.HT_NOWHERE | |
654 | HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST | |
655 | HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1 | |
656 | HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2 | |
657 | HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1 | |
658 | HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2 | |
659 | HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB | |
660 | HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1 | |
661 | HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2 | |
662 | HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST | |
663 | HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE | |
664 | HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE | |
665 | HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR | |
666 | HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR | |
667 | HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER | |
668 | HT_MAX = _core_.HT_MAX | |
669 | MOD_NONE = _core_.MOD_NONE | |
670 | MOD_ALT = _core_.MOD_ALT | |
671 | MOD_CONTROL = _core_.MOD_CONTROL | |
943e8dfd | 672 | MOD_ALTGR = _core_.MOD_ALTGR |
54f9ee45 | 673 | MOD_SHIFT = _core_.MOD_SHIFT |
943e8dfd | 674 | MOD_META = _core_.MOD_META |
54f9ee45 | 675 | MOD_WIN = _core_.MOD_WIN |
943e8dfd RD |
676 | MOD_CMD = _core_.MOD_CMD |
677 | MOD_ALL = _core_.MOD_ALL | |
54f9ee45 RD |
678 | UPDATE_UI_NONE = _core_.UPDATE_UI_NONE |
679 | UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE | |
680 | UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE | |
994453b8 RD |
681 | Layout_Default = _core_.Layout_Default |
682 | Layout_LeftToRight = _core_.Layout_LeftToRight | |
683 | Layout_RightToLeft = _core_.Layout_RightToLeft | |
d14a1e28 RD |
684 | #--------------------------------------------------------------------------- |
685 | ||
686 | class Object(object): | |
0df68c9f RD |
687 | """ |
688 | The base class for most wx objects, although in wxPython not | |
689 | much functionality is needed nor exposed. | |
690 | """ | |
0085ce49 RD |
691 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
692 | def __init__(self): raise AttributeError, "No constructor defined" | |
693 | __repr__ = _swig_repr | |
e811c8ce | 694 | def GetClassName(*args, **kwargs): |
0df68c9f | 695 | """ |
a95a7133 | 696 | GetClassName(self) -> String |
e811c8ce | 697 | |
a95a7133 | 698 | Returns the class name of the C++ class using wxRTTI. |
0df68c9f | 699 | """ |
54f9ee45 | 700 | return _core_.Object_GetClassName(*args, **kwargs) |
e811c8ce RD |
701 | |
702 | def Destroy(*args, **kwargs): | |
0df68c9f | 703 | """ |
a95a7133 | 704 | Destroy(self) |
e811c8ce | 705 | |
0df68c9f RD |
706 | Deletes the C++ object this Python object is a proxy for. |
707 | """ | |
b39fe951 RD |
708 | args[0].this.own(False) |
709 | return _core_.Object_Destroy(*args, **kwargs) | |
e811c8ce | 710 | |
8f514ab4 RD |
711 | def IsSameAs(*args, **kwargs): |
712 | """ | |
713 | IsSameAs(self, Object p) -> bool | |
714 | ||
715 | For wx.Objects that use C++ reference counting internally, this method | |
716 | can be used to determine if two objects are referencing the same data | |
717 | object. | |
718 | """ | |
719 | return _core_.Object_IsSameAs(*args, **kwargs) | |
720 | ||
33d6fd3b | 721 | ClassName = property(GetClassName,doc="See `GetClassName`") |
2131d850 | 722 | _core_.Object_swigregister(Object) |
54f9ee45 | 723 | _wxPySetDictionary = _core_._wxPySetDictionary |
54f9ee45 | 724 | cvar = _core_.cvar |
196addbf | 725 | EmptyString = cvar.EmptyString |
d14a1e28 RD |
726 | |
727 | #--------------------------------------------------------------------------- | |
728 | ||
54f9ee45 RD |
729 | BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID |
730 | BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP | |
731 | BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO | |
732 | BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR | |
733 | BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM | |
734 | BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA | |
735 | BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM | |
736 | BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA | |
737 | BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF | |
738 | BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF | |
739 | BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG | |
740 | BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG | |
741 | BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM | |
742 | BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX | |
743 | BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT | |
744 | BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON | |
745 | BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI | |
746 | BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF | |
8f514ab4 | 747 | BITMAP_TYPE_TGA = _core_.BITMAP_TYPE_TGA |
54f9ee45 RD |
748 | BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR |
749 | BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY | |
750 | CURSOR_NONE = _core_.CURSOR_NONE | |
751 | CURSOR_ARROW = _core_.CURSOR_ARROW | |
752 | CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW | |
753 | CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE | |
754 | CURSOR_CHAR = _core_.CURSOR_CHAR | |
755 | CURSOR_CROSS = _core_.CURSOR_CROSS | |
756 | CURSOR_HAND = _core_.CURSOR_HAND | |
757 | CURSOR_IBEAM = _core_.CURSOR_IBEAM | |
758 | CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON | |
759 | CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER | |
760 | CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON | |
761 | CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY | |
762 | CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH | |
763 | CURSOR_PENCIL = _core_.CURSOR_PENCIL | |
764 | CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT | |
765 | CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT | |
766 | CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW | |
767 | CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON | |
768 | CURSOR_SIZENESW = _core_.CURSOR_SIZENESW | |
769 | CURSOR_SIZENS = _core_.CURSOR_SIZENS | |
770 | CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE | |
771 | CURSOR_SIZEWE = _core_.CURSOR_SIZEWE | |
772 | CURSOR_SIZING = _core_.CURSOR_SIZING | |
773 | CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN | |
774 | CURSOR_WAIT = _core_.CURSOR_WAIT | |
775 | CURSOR_WATCH = _core_.CURSOR_WATCH | |
776 | CURSOR_BLANK = _core_.CURSOR_BLANK | |
777 | CURSOR_DEFAULT = _core_.CURSOR_DEFAULT | |
778 | CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW | |
779 | CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT | |
780 | CURSOR_MAX = _core_.CURSOR_MAX | |
d14a1e28 RD |
781 | #--------------------------------------------------------------------------- |
782 | ||
783 | class Size(object): | |
0df68c9f | 784 | """ |
41e2b43e | 785 | wx.Size is a useful data structure used to represent the size of |
0085ce49 RD |
786 | something. It simply contains integer width and height |
787 | properties. In most places in wxPython where a wx.Size is | |
093d3ff1 | 788 | expected a (width, height) tuple can be used instead. |
0df68c9f | 789 | """ |
0085ce49 RD |
790 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
791 | __repr__ = _swig_repr | |
54f9ee45 RD |
792 | width = property(_core_.Size_width_get, _core_.Size_width_set) |
793 | height = property(_core_.Size_height_get, _core_.Size_height_set) | |
242b7b46 | 794 | x = width; y = height |
0085ce49 | 795 | def __init__(self, *args, **kwargs): |
0df68c9f | 796 | """ |
a95a7133 | 797 | __init__(self, int w=0, int h=0) -> Size |
e811c8ce | 798 | |
0df68c9f RD |
799 | Creates a size object. |
800 | """ | |
0085ce49 RD |
801 | _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs)) |
802 | __swig_destroy__ = _core_.delete_Size | |
803 | __del__ = lambda self : None; | |
e811c8ce | 804 | def __eq__(*args, **kwargs): |
0df68c9f | 805 | """ |
e9d6f3a4 | 806 | __eq__(self, PyObject other) -> bool |
e811c8ce | 807 | |
0df68c9f RD |
808 | Test for equality of wx.Size objects. |
809 | """ | |
54f9ee45 | 810 | return _core_.Size___eq__(*args, **kwargs) |
e811c8ce RD |
811 | |
812 | def __ne__(*args, **kwargs): | |
0df68c9f | 813 | """ |
e9d6f3a4 | 814 | __ne__(self, PyObject other) -> bool |
e811c8ce | 815 | |
e9d6f3a4 | 816 | Test for inequality of wx.Size objects. |
0df68c9f | 817 | """ |
54f9ee45 | 818 | return _core_.Size___ne__(*args, **kwargs) |
e811c8ce RD |
819 | |
820 | def __add__(*args, **kwargs): | |
0df68c9f | 821 | """ |
a95a7133 | 822 | __add__(self, Size sz) -> Size |
e811c8ce | 823 | |
0df68c9f RD |
824 | Add sz's proprties to this and return the result. |
825 | """ | |
54f9ee45 | 826 | return _core_.Size___add__(*args, **kwargs) |
e811c8ce RD |
827 | |
828 | def __sub__(*args, **kwargs): | |
0df68c9f | 829 | """ |
a95a7133 | 830 | __sub__(self, Size sz) -> Size |
e811c8ce | 831 | |
0df68c9f RD |
832 | Subtract sz's properties from this and return the result. |
833 | """ | |
54f9ee45 | 834 | return _core_.Size___sub__(*args, **kwargs) |
e811c8ce RD |
835 | |
836 | def IncTo(*args, **kwargs): | |
0df68c9f | 837 | """ |
a95a7133 | 838 | IncTo(self, Size sz) |
e811c8ce | 839 | |
0df68c9f RD |
840 | Increments this object so that both of its dimensions are not less |
841 | than the corresponding dimensions of the size. | |
842 | """ | |
54f9ee45 | 843 | return _core_.Size_IncTo(*args, **kwargs) |
e811c8ce RD |
844 | |
845 | def DecTo(*args, **kwargs): | |
0df68c9f | 846 | """ |
a95a7133 | 847 | DecTo(self, Size sz) |
e811c8ce | 848 | |
0df68c9f RD |
849 | Decrements this object so that both of its dimensions are not greater |
850 | than the corresponding dimensions of the size. | |
851 | """ | |
54f9ee45 | 852 | return _core_.Size_DecTo(*args, **kwargs) |
e811c8ce | 853 | |
f5263701 RD |
854 | def IncBy(*args, **kwargs): |
855 | """IncBy(self, int dx, int dy)""" | |
856 | return _core_.Size_IncBy(*args, **kwargs) | |
857 | ||
858 | def DecBy(*args, **kwargs): | |
859 | """DecBy(self, int dx, int dy)""" | |
860 | return _core_.Size_DecBy(*args, **kwargs) | |
861 | ||
10044bf1 RD |
862 | def Scale(*args, **kwargs): |
863 | """ | |
864 | Scale(self, float xscale, float yscale) | |
865 | ||
866 | Scales the dimensions of this object by the given factors. | |
867 | """ | |
868 | return _core_.Size_Scale(*args, **kwargs) | |
869 | ||
e811c8ce | 870 | def Set(*args, **kwargs): |
0df68c9f | 871 | """ |
a95a7133 | 872 | Set(self, int w, int h) |
e811c8ce | 873 | |
0df68c9f RD |
874 | Set both width and height. |
875 | """ | |
54f9ee45 | 876 | return _core_.Size_Set(*args, **kwargs) |
e811c8ce RD |
877 | |
878 | def SetWidth(*args, **kwargs): | |
a95a7133 | 879 | """SetWidth(self, int w)""" |
54f9ee45 | 880 | return _core_.Size_SetWidth(*args, **kwargs) |
e811c8ce RD |
881 | |
882 | def SetHeight(*args, **kwargs): | |
a95a7133 | 883 | """SetHeight(self, int h)""" |
54f9ee45 | 884 | return _core_.Size_SetHeight(*args, **kwargs) |
e811c8ce RD |
885 | |
886 | def GetWidth(*args, **kwargs): | |
a95a7133 | 887 | """GetWidth(self) -> int""" |
54f9ee45 | 888 | return _core_.Size_GetWidth(*args, **kwargs) |
e811c8ce RD |
889 | |
890 | def GetHeight(*args, **kwargs): | |
a95a7133 | 891 | """GetHeight(self) -> int""" |
54f9ee45 | 892 | return _core_.Size_GetHeight(*args, **kwargs) |
e811c8ce | 893 | |
74a57fcd RD |
894 | def IsFullySpecified(*args, **kwargs): |
895 | """ | |
a95a7133 | 896 | IsFullySpecified(self) -> bool |
74a57fcd RD |
897 | |
898 | Returns True if both components of the size are non-default values. | |
899 | """ | |
54f9ee45 | 900 | return _core_.Size_IsFullySpecified(*args, **kwargs) |
74a57fcd RD |
901 | |
902 | def SetDefaults(*args, **kwargs): | |
903 | """ | |
a95a7133 | 904 | SetDefaults(self, Size size) |
74a57fcd | 905 | |
41e2b43e RD |
906 | Combine this size with the other one replacing the default components |
907 | of this object (i.e. equal to -1) with those of the other. | |
74a57fcd | 908 | """ |
54f9ee45 | 909 | return _core_.Size_SetDefaults(*args, **kwargs) |
74a57fcd | 910 | |
e811c8ce | 911 | def Get(*args, **kwargs): |
0df68c9f RD |
912 | """ |
913 | Get() -> (width,height) | |
e811c8ce | 914 | |
0df68c9f RD |
915 | Returns the width and height properties as a tuple. |
916 | """ | |
54f9ee45 | 917 | return _core_.Size_Get(*args, **kwargs) |
e811c8ce | 918 | |
41e2b43e | 919 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
920 | def __str__(self): return str(self.Get()) |
921 | def __repr__(self): return 'wx.Size'+str(self.Get()) | |
922 | def __len__(self): return len(self.Get()) | |
923 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
924 | def __setitem__(self, index, val): |
925 | if index == 0: self.width = val | |
926 | elif index == 1: self.height = val | |
927 | else: raise IndexError | |
e811c8ce | 928 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
929 | __safe_for_unpickling__ = True |
930 | def __reduce__(self): return (wx.Size, self.Get()) | |
d14a1e28 | 931 | |
2131d850 | 932 | _core_.Size_swigregister(Size) |
d14a1e28 RD |
933 | |
934 | #--------------------------------------------------------------------------- | |
935 | ||
936 | class RealPoint(object): | |
0df68c9f | 937 | """ |
41e2b43e RD |
938 | A data structure for representing a point or position with floating |
939 | point x and y properties. In wxPython most places that expect a | |
940 | wx.RealPoint can also accept a (x,y) tuple. | |
0df68c9f | 941 | """ |
0085ce49 RD |
942 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
943 | __repr__ = _swig_repr | |
54f9ee45 RD |
944 | x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set) |
945 | y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set) | |
0085ce49 | 946 | def __init__(self, *args, **kwargs): |
0df68c9f | 947 | """ |
a95a7133 | 948 | __init__(self, double x=0.0, double y=0.0) -> RealPoint |
e811c8ce | 949 | |
0df68c9f RD |
950 | Create a wx.RealPoint object |
951 | """ | |
0085ce49 RD |
952 | _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs)) |
953 | __swig_destroy__ = _core_.delete_RealPoint | |
954 | __del__ = lambda self : None; | |
e811c8ce | 955 | def __eq__(*args, **kwargs): |
0df68c9f | 956 | """ |
e9d6f3a4 | 957 | __eq__(self, PyObject other) -> bool |
e811c8ce | 958 | |
0df68c9f RD |
959 | Test for equality of wx.RealPoint objects. |
960 | """ | |
54f9ee45 | 961 | return _core_.RealPoint___eq__(*args, **kwargs) |
e811c8ce RD |
962 | |
963 | def __ne__(*args, **kwargs): | |
0df68c9f | 964 | """ |
e9d6f3a4 | 965 | __ne__(self, PyObject other) -> bool |
e811c8ce | 966 | |
0df68c9f RD |
967 | Test for inequality of wx.RealPoint objects. |
968 | """ | |
54f9ee45 | 969 | return _core_.RealPoint___ne__(*args, **kwargs) |
e811c8ce RD |
970 | |
971 | def __add__(*args, **kwargs): | |
0df68c9f | 972 | """ |
a95a7133 | 973 | __add__(self, RealPoint pt) -> RealPoint |
e811c8ce | 974 | |
0df68c9f RD |
975 | Add pt's proprties to this and return the result. |
976 | """ | |
54f9ee45 | 977 | return _core_.RealPoint___add__(*args, **kwargs) |
e811c8ce RD |
978 | |
979 | def __sub__(*args, **kwargs): | |
0df68c9f | 980 | """ |
a95a7133 | 981 | __sub__(self, RealPoint pt) -> RealPoint |
e811c8ce | 982 | |
0df68c9f RD |
983 | Subtract pt's proprties from this and return the result |
984 | """ | |
54f9ee45 | 985 | return _core_.RealPoint___sub__(*args, **kwargs) |
e811c8ce RD |
986 | |
987 | def Set(*args, **kwargs): | |
0df68c9f | 988 | """ |
a95a7133 | 989 | Set(self, double x, double y) |
e811c8ce | 990 | |
0df68c9f RD |
991 | Set both the x and y properties |
992 | """ | |
54f9ee45 | 993 | return _core_.RealPoint_Set(*args, **kwargs) |
e811c8ce RD |
994 | |
995 | def Get(*args, **kwargs): | |
0df68c9f RD |
996 | """ |
997 | Get() -> (x,y) | |
e811c8ce | 998 | |
0df68c9f RD |
999 | Return the x and y properties as a tuple. |
1000 | """ | |
54f9ee45 | 1001 | return _core_.RealPoint_Get(*args, **kwargs) |
e811c8ce | 1002 | |
41e2b43e | 1003 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1004 | def __str__(self): return str(self.Get()) |
1005 | def __repr__(self): return 'wx.RealPoint'+str(self.Get()) | |
1006 | def __len__(self): return len(self.Get()) | |
1007 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 | 1008 | def __setitem__(self, index, val): |
e811c8ce RD |
1009 | if index == 0: self.x = val |
1010 | elif index == 1: self.y = val | |
d14a1e28 | 1011 | else: raise IndexError |
e811c8ce | 1012 | def __nonzero__(self): return self.Get() != (0.0, 0.0) |
74e96f3d RD |
1013 | __safe_for_unpickling__ = True |
1014 | def __reduce__(self): return (wx.RealPoint, self.Get()) | |
d14a1e28 | 1015 | |
2131d850 | 1016 | _core_.RealPoint_swigregister(RealPoint) |
d14a1e28 RD |
1017 | |
1018 | #--------------------------------------------------------------------------- | |
1019 | ||
1020 | class Point(object): | |
0df68c9f | 1021 | """ |
41e2b43e RD |
1022 | A data structure for representing a point or position with integer x |
1023 | and y properties. Most places in wxPython that expect a wx.Point can | |
1024 | also accept a (x,y) tuple. | |
0df68c9f | 1025 | """ |
0085ce49 RD |
1026 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1027 | __repr__ = _swig_repr | |
54f9ee45 RD |
1028 | x = property(_core_.Point_x_get, _core_.Point_x_set) |
1029 | y = property(_core_.Point_y_get, _core_.Point_y_set) | |
0085ce49 | 1030 | def __init__(self, *args, **kwargs): |
0df68c9f | 1031 | """ |
a95a7133 | 1032 | __init__(self, int x=0, int y=0) -> Point |
e811c8ce | 1033 | |
0df68c9f RD |
1034 | Create a wx.Point object |
1035 | """ | |
0085ce49 RD |
1036 | _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs)) |
1037 | __swig_destroy__ = _core_.delete_Point | |
1038 | __del__ = lambda self : None; | |
e811c8ce | 1039 | def __eq__(*args, **kwargs): |
0df68c9f | 1040 | """ |
e9d6f3a4 | 1041 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1042 | |
0df68c9f RD |
1043 | Test for equality of wx.Point objects. |
1044 | """ | |
54f9ee45 | 1045 | return _core_.Point___eq__(*args, **kwargs) |
e811c8ce RD |
1046 | |
1047 | def __ne__(*args, **kwargs): | |
0df68c9f | 1048 | """ |
e9d6f3a4 | 1049 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1050 | |
0df68c9f RD |
1051 | Test for inequality of wx.Point objects. |
1052 | """ | |
54f9ee45 | 1053 | return _core_.Point___ne__(*args, **kwargs) |
e811c8ce RD |
1054 | |
1055 | def __add__(*args, **kwargs): | |
0df68c9f | 1056 | """ |
a95a7133 | 1057 | __add__(self, Point pt) -> Point |
e811c8ce | 1058 | |
0df68c9f RD |
1059 | Add pt's proprties to this and return the result. |
1060 | """ | |
54f9ee45 | 1061 | return _core_.Point___add__(*args, **kwargs) |
e811c8ce RD |
1062 | |
1063 | def __sub__(*args, **kwargs): | |
0df68c9f | 1064 | """ |
a95a7133 | 1065 | __sub__(self, Point pt) -> Point |
e811c8ce | 1066 | |
0df68c9f RD |
1067 | Subtract pt's proprties from this and return the result |
1068 | """ | |
54f9ee45 | 1069 | return _core_.Point___sub__(*args, **kwargs) |
e811c8ce RD |
1070 | |
1071 | def __iadd__(*args, **kwargs): | |
0df68c9f | 1072 | """ |
a95a7133 | 1073 | __iadd__(self, Point pt) -> Point |
e811c8ce | 1074 | |
0df68c9f RD |
1075 | Add pt to this object. |
1076 | """ | |
54f9ee45 | 1077 | return _core_.Point___iadd__(*args, **kwargs) |
e811c8ce RD |
1078 | |
1079 | def __isub__(*args, **kwargs): | |
0df68c9f | 1080 | """ |
a95a7133 | 1081 | __isub__(self, Point pt) -> Point |
e811c8ce | 1082 | |
0df68c9f RD |
1083 | Subtract pt from this object. |
1084 | """ | |
54f9ee45 | 1085 | return _core_.Point___isub__(*args, **kwargs) |
e811c8ce RD |
1086 | |
1087 | def Set(*args, **kwargs): | |
0df68c9f | 1088 | """ |
a95a7133 | 1089 | Set(self, long x, long y) |
e811c8ce | 1090 | |
0df68c9f RD |
1091 | Set both the x and y properties |
1092 | """ | |
54f9ee45 | 1093 | return _core_.Point_Set(*args, **kwargs) |
e811c8ce RD |
1094 | |
1095 | def Get(*args, **kwargs): | |
0df68c9f RD |
1096 | """ |
1097 | Get() -> (x,y) | |
e811c8ce | 1098 | |
0df68c9f RD |
1099 | Return the x and y properties as a tuple. |
1100 | """ | |
54f9ee45 | 1101 | return _core_.Point_Get(*args, **kwargs) |
e811c8ce | 1102 | |
41e2b43e | 1103 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1104 | def __str__(self): return str(self.Get()) |
1105 | def __repr__(self): return 'wx.Point'+str(self.Get()) | |
1106 | def __len__(self): return len(self.Get()) | |
1107 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
1108 | def __setitem__(self, index, val): |
1109 | if index == 0: self.x = val | |
1110 | elif index == 1: self.y = val | |
1111 | else: raise IndexError | |
e811c8ce | 1112 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
1113 | __safe_for_unpickling__ = True |
1114 | def __reduce__(self): return (wx.Point, self.Get()) | |
d14a1e28 | 1115 | |
2131d850 | 1116 | _core_.Point_swigregister(Point) |
d14a1e28 RD |
1117 | |
1118 | #--------------------------------------------------------------------------- | |
1119 | ||
1120 | class Rect(object): | |
0df68c9f | 1121 | """ |
41e2b43e RD |
1122 | A class for representing and manipulating rectangles. It has x, y, |
1123 | width and height properties. In wxPython most palces that expect a | |
1124 | wx.Rect can also accept a (x,y,width,height) tuple. | |
0df68c9f | 1125 | """ |
0085ce49 RD |
1126 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1127 | __repr__ = _swig_repr | |
1128 | def __init__(self, *args, **kwargs): | |
0df68c9f | 1129 | """ |
a95a7133 | 1130 | __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect |
e811c8ce | 1131 | |
0df68c9f RD |
1132 | Create a new Rect object. |
1133 | """ | |
0085ce49 RD |
1134 | _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs)) |
1135 | __swig_destroy__ = _core_.delete_Rect | |
1136 | __del__ = lambda self : None; | |
e811c8ce | 1137 | def GetX(*args, **kwargs): |
a95a7133 | 1138 | """GetX(self) -> int""" |
54f9ee45 | 1139 | return _core_.Rect_GetX(*args, **kwargs) |
e811c8ce RD |
1140 | |
1141 | def SetX(*args, **kwargs): | |
a95a7133 | 1142 | """SetX(self, int x)""" |
54f9ee45 | 1143 | return _core_.Rect_SetX(*args, **kwargs) |
e811c8ce RD |
1144 | |
1145 | def GetY(*args, **kwargs): | |
a95a7133 | 1146 | """GetY(self) -> int""" |
54f9ee45 | 1147 | return _core_.Rect_GetY(*args, **kwargs) |
e811c8ce RD |
1148 | |
1149 | def SetY(*args, **kwargs): | |
a95a7133 | 1150 | """SetY(self, int y)""" |
54f9ee45 | 1151 | return _core_.Rect_SetY(*args, **kwargs) |
e811c8ce RD |
1152 | |
1153 | def GetWidth(*args, **kwargs): | |
a95a7133 | 1154 | """GetWidth(self) -> int""" |
54f9ee45 | 1155 | return _core_.Rect_GetWidth(*args, **kwargs) |
e811c8ce RD |
1156 | |
1157 | def SetWidth(*args, **kwargs): | |
a95a7133 | 1158 | """SetWidth(self, int w)""" |
54f9ee45 | 1159 | return _core_.Rect_SetWidth(*args, **kwargs) |
e811c8ce RD |
1160 | |
1161 | def GetHeight(*args, **kwargs): | |
a95a7133 | 1162 | """GetHeight(self) -> int""" |
54f9ee45 | 1163 | return _core_.Rect_GetHeight(*args, **kwargs) |
e811c8ce RD |
1164 | |
1165 | def SetHeight(*args, **kwargs): | |
a95a7133 | 1166 | """SetHeight(self, int h)""" |
54f9ee45 | 1167 | return _core_.Rect_SetHeight(*args, **kwargs) |
e811c8ce RD |
1168 | |
1169 | def GetPosition(*args, **kwargs): | |
a95a7133 | 1170 | """GetPosition(self) -> Point""" |
54f9ee45 | 1171 | return _core_.Rect_GetPosition(*args, **kwargs) |
e811c8ce RD |
1172 | |
1173 | def SetPosition(*args, **kwargs): | |
a95a7133 | 1174 | """SetPosition(self, Point p)""" |
54f9ee45 | 1175 | return _core_.Rect_SetPosition(*args, **kwargs) |
e811c8ce RD |
1176 | |
1177 | def GetSize(*args, **kwargs): | |
a95a7133 | 1178 | """GetSize(self) -> Size""" |
54f9ee45 | 1179 | return _core_.Rect_GetSize(*args, **kwargs) |
e811c8ce RD |
1180 | |
1181 | def SetSize(*args, **kwargs): | |
a95a7133 | 1182 | """SetSize(self, Size s)""" |
54f9ee45 | 1183 | return _core_.Rect_SetSize(*args, **kwargs) |
e811c8ce | 1184 | |
aff4cc5c RD |
1185 | def IsEmpty(*args, **kwargs): |
1186 | """IsEmpty(self) -> bool""" | |
1187 | return _core_.Rect_IsEmpty(*args, **kwargs) | |
1188 | ||
c9c7117a | 1189 | def GetTopLeft(*args, **kwargs): |
a95a7133 | 1190 | """GetTopLeft(self) -> Point""" |
54f9ee45 | 1191 | return _core_.Rect_GetTopLeft(*args, **kwargs) |
c9c7117a RD |
1192 | |
1193 | def SetTopLeft(*args, **kwargs): | |
a95a7133 | 1194 | """SetTopLeft(self, Point p)""" |
54f9ee45 | 1195 | return _core_.Rect_SetTopLeft(*args, **kwargs) |
c9c7117a RD |
1196 | |
1197 | def GetBottomRight(*args, **kwargs): | |
a95a7133 | 1198 | """GetBottomRight(self) -> Point""" |
54f9ee45 | 1199 | return _core_.Rect_GetBottomRight(*args, **kwargs) |
c9c7117a RD |
1200 | |
1201 | def SetBottomRight(*args, **kwargs): | |
a95a7133 | 1202 | """SetBottomRight(self, Point p)""" |
54f9ee45 | 1203 | return _core_.Rect_SetBottomRight(*args, **kwargs) |
c9c7117a | 1204 | |
5acb46e0 RD |
1205 | def GetTopRight(*args, **kwargs): |
1206 | """GetTopRight(self) -> Point""" | |
1207 | return _core_.Rect_GetTopRight(*args, **kwargs) | |
1208 | ||
1209 | def SetTopRight(*args, **kwargs): | |
1210 | """SetTopRight(self, Point p)""" | |
1211 | return _core_.Rect_SetTopRight(*args, **kwargs) | |
1212 | ||
1213 | def GetBottomLeft(*args, **kwargs): | |
1214 | """GetBottomLeft(self) -> Point""" | |
1215 | return _core_.Rect_GetBottomLeft(*args, **kwargs) | |
1216 | ||
1217 | def SetBottomLeft(*args, **kwargs): | |
1218 | """SetBottomLeft(self, Point p)""" | |
1219 | return _core_.Rect_SetBottomLeft(*args, **kwargs) | |
1220 | ||
e811c8ce | 1221 | def GetLeft(*args, **kwargs): |
a95a7133 | 1222 | """GetLeft(self) -> int""" |
54f9ee45 | 1223 | return _core_.Rect_GetLeft(*args, **kwargs) |
e811c8ce RD |
1224 | |
1225 | def GetTop(*args, **kwargs): | |
a95a7133 | 1226 | """GetTop(self) -> int""" |
54f9ee45 | 1227 | return _core_.Rect_GetTop(*args, **kwargs) |
e811c8ce RD |
1228 | |
1229 | def GetBottom(*args, **kwargs): | |
a95a7133 | 1230 | """GetBottom(self) -> int""" |
54f9ee45 | 1231 | return _core_.Rect_GetBottom(*args, **kwargs) |
e811c8ce RD |
1232 | |
1233 | def GetRight(*args, **kwargs): | |
a95a7133 | 1234 | """GetRight(self) -> int""" |
54f9ee45 | 1235 | return _core_.Rect_GetRight(*args, **kwargs) |
e811c8ce RD |
1236 | |
1237 | def SetLeft(*args, **kwargs): | |
a95a7133 | 1238 | """SetLeft(self, int left)""" |
54f9ee45 | 1239 | return _core_.Rect_SetLeft(*args, **kwargs) |
e811c8ce RD |
1240 | |
1241 | def SetRight(*args, **kwargs): | |
a95a7133 | 1242 | """SetRight(self, int right)""" |
54f9ee45 | 1243 | return _core_.Rect_SetRight(*args, **kwargs) |
e811c8ce RD |
1244 | |
1245 | def SetTop(*args, **kwargs): | |
a95a7133 | 1246 | """SetTop(self, int top)""" |
54f9ee45 | 1247 | return _core_.Rect_SetTop(*args, **kwargs) |
e811c8ce RD |
1248 | |
1249 | def SetBottom(*args, **kwargs): | |
a95a7133 | 1250 | """SetBottom(self, int bottom)""" |
54f9ee45 | 1251 | return _core_.Rect_SetBottom(*args, **kwargs) |
e811c8ce RD |
1252 | |
1253 | position = property(GetPosition, SetPosition) | |
1254 | size = property(GetSize, SetSize) | |
1255 | left = property(GetLeft, SetLeft) | |
1256 | right = property(GetRight, SetRight) | |
1257 | top = property(GetTop, SetTop) | |
1258 | bottom = property(GetBottom, SetBottom) | |
1259 | ||
1260 | def Inflate(*args, **kwargs): | |
0df68c9f | 1261 | """ |
a95a7133 | 1262 | Inflate(self, int dx, int dy) -> Rect |
e811c8ce | 1263 | |
8e738329 RD |
1264 | Increases the size of the rectangle. |
1265 | ||
1266 | The left border is moved farther left and the right border is moved | |
1267 | farther right by ``dx``. The upper border is moved farther up and the | |
1268 | bottom border is moved farther down by ``dy``. (Note the the width and | |
1269 | height of the rectangle thus change by ``2*dx`` and ``2*dy``, | |
1270 | respectively.) If one or both of ``dx`` and ``dy`` are negative, the | |
1271 | opposite happens: the rectangle size decreases in the respective | |
1272 | direction. | |
1273 | ||
1274 | The change is made to the rectangle inplace, if instead you need a | |
1275 | copy that is inflated, preserving the original then make the copy | |
1276 | first:: | |
1277 | ||
1278 | copy = wx.Rect(*original) | |
1279 | copy.Inflate(10,15) | |
1280 | ||
1281 | ||
0df68c9f | 1282 | """ |
54f9ee45 | 1283 | return _core_.Rect_Inflate(*args, **kwargs) |
e811c8ce RD |
1284 | |
1285 | def Deflate(*args, **kwargs): | |
0df68c9f | 1286 | """ |
a95a7133 | 1287 | Deflate(self, int dx, int dy) -> Rect |
e811c8ce | 1288 | |
8e738329 RD |
1289 | Decrease the rectangle size. This method is the opposite of `Inflate` |
1290 | in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to | |
1291 | `Inflate` for a full description. | |
0df68c9f | 1292 | """ |
54f9ee45 | 1293 | return _core_.Rect_Deflate(*args, **kwargs) |
e811c8ce RD |
1294 | |
1295 | def OffsetXY(*args, **kwargs): | |
0df68c9f | 1296 | """ |
a95a7133 | 1297 | OffsetXY(self, int dx, int dy) |
e811c8ce | 1298 | |
41e2b43e RD |
1299 | Moves the rectangle by the specified offset. If dx is positive, the |
1300 | rectangle is moved to the right, if dy is positive, it is moved to the | |
1301 | bottom, otherwise it is moved to the left or top respectively. | |
0df68c9f | 1302 | """ |
54f9ee45 | 1303 | return _core_.Rect_OffsetXY(*args, **kwargs) |
e811c8ce RD |
1304 | |
1305 | def Offset(*args, **kwargs): | |
0df68c9f | 1306 | """ |
a95a7133 | 1307 | Offset(self, Point pt) |
e811c8ce | 1308 | |
b1fcee84 | 1309 | Same as `OffsetXY` but uses dx,dy from Point |
0df68c9f | 1310 | """ |
54f9ee45 | 1311 | return _core_.Rect_Offset(*args, **kwargs) |
e811c8ce RD |
1312 | |
1313 | def Intersect(*args, **kwargs): | |
0df68c9f | 1314 | """ |
a95a7133 | 1315 | Intersect(self, Rect rect) -> Rect |
e811c8ce | 1316 | |
5cbf236d | 1317 | Returns the intersectsion of this rectangle and rect. |
0df68c9f | 1318 | """ |
54f9ee45 | 1319 | return _core_.Rect_Intersect(*args, **kwargs) |
e811c8ce | 1320 | |
5cbf236d RD |
1321 | def Union(*args, **kwargs): |
1322 | """ | |
1323 | Union(self, Rect rect) -> Rect | |
1324 | ||
1325 | Returns the union of this rectangle and rect. | |
1326 | """ | |
1327 | return _core_.Rect_Union(*args, **kwargs) | |
1328 | ||
e811c8ce | 1329 | def __add__(*args, **kwargs): |
0df68c9f | 1330 | """ |
a95a7133 | 1331 | __add__(self, Rect rect) -> Rect |
e811c8ce | 1332 | |
0df68c9f RD |
1333 | Add the properties of rect to this rectangle and return the result. |
1334 | """ | |
54f9ee45 | 1335 | return _core_.Rect___add__(*args, **kwargs) |
e811c8ce RD |
1336 | |
1337 | def __iadd__(*args, **kwargs): | |
0df68c9f | 1338 | """ |
a95a7133 | 1339 | __iadd__(self, Rect rect) -> Rect |
e811c8ce | 1340 | |
0df68c9f RD |
1341 | Add the properties of rect to this rectangle, updating this rectangle. |
1342 | """ | |
54f9ee45 | 1343 | return _core_.Rect___iadd__(*args, **kwargs) |
e811c8ce RD |
1344 | |
1345 | def __eq__(*args, **kwargs): | |
0df68c9f | 1346 | """ |
e9d6f3a4 | 1347 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1348 | |
e9d6f3a4 | 1349 | Test for equality of wx.Rect objects. |
0df68c9f | 1350 | """ |
54f9ee45 | 1351 | return _core_.Rect___eq__(*args, **kwargs) |
e811c8ce RD |
1352 | |
1353 | def __ne__(*args, **kwargs): | |
0df68c9f | 1354 | """ |
e9d6f3a4 | 1355 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1356 | |
e9d6f3a4 | 1357 | Test for inequality of wx.Rect objects. |
0df68c9f | 1358 | """ |
54f9ee45 | 1359 | return _core_.Rect___ne__(*args, **kwargs) |
e811c8ce | 1360 | |
33d6fd3b | 1361 | def ContainsXY(*args, **kwargs): |
0df68c9f | 1362 | """ |
33d6fd3b | 1363 | ContainsXY(self, int x, int y) -> bool |
e811c8ce | 1364 | |
33d6fd3b | 1365 | Return True if the point is inside the rect. |
0df68c9f | 1366 | """ |
33d6fd3b | 1367 | return _core_.Rect_ContainsXY(*args, **kwargs) |
e811c8ce | 1368 | |
33d6fd3b | 1369 | def Contains(*args, **kwargs): |
0df68c9f | 1370 | """ |
33d6fd3b | 1371 | Contains(self, Point pt) -> bool |
e811c8ce | 1372 | |
33d6fd3b | 1373 | Return True if the point is inside the rect. |
0df68c9f | 1374 | """ |
33d6fd3b | 1375 | return _core_.Rect_Contains(*args, **kwargs) |
e811c8ce | 1376 | |
33d6fd3b | 1377 | def ContainsRect(*args, **kwargs): |
fc46b7f3 | 1378 | """ |
33d6fd3b | 1379 | ContainsRect(self, Rect rect) -> bool |
fc46b7f3 RD |
1380 | |
1381 | Returns ``True`` if the given rectangle is completely inside this | |
1382 | rectangle or touches its boundary. | |
1383 | """ | |
33d6fd3b RD |
1384 | return _core_.Rect_ContainsRect(*args, **kwargs) |
1385 | ||
72ef6efb RD |
1386 | #Inside = wx._deprecated(Contains, "Use `Contains` instead.") |
1387 | #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.") | |
1388 | #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.") | |
1389 | Inside = Contains | |
1390 | InsideXY = ContainsXY | |
1391 | InsideRect = ContainsRect | |
fc46b7f3 | 1392 | |
e811c8ce | 1393 | def Intersects(*args, **kwargs): |
0df68c9f | 1394 | """ |
a95a7133 | 1395 | Intersects(self, Rect rect) -> bool |
e811c8ce | 1396 | |
0df68c9f RD |
1397 | Returns True if the rectangles have a non empty intersection. |
1398 | """ | |
54f9ee45 | 1399 | return _core_.Rect_Intersects(*args, **kwargs) |
e811c8ce | 1400 | |
b1fcee84 RD |
1401 | def CenterIn(*args, **kwargs): |
1402 | """ | |
1403 | CenterIn(self, Rect r, int dir=BOTH) -> Rect | |
1404 | ||
1405 | Center this rectangle within the one passed to the method, which is | |
1406 | usually, but not necessarily, the larger one. | |
1407 | """ | |
1408 | return _core_.Rect_CenterIn(*args, **kwargs) | |
1409 | ||
1410 | CentreIn = CenterIn | |
54f9ee45 RD |
1411 | x = property(_core_.Rect_x_get, _core_.Rect_x_set) |
1412 | y = property(_core_.Rect_y_get, _core_.Rect_y_set) | |
1413 | width = property(_core_.Rect_width_get, _core_.Rect_width_set) | |
1414 | height = property(_core_.Rect_height_get, _core_.Rect_height_set) | |
e811c8ce | 1415 | def Set(*args, **kwargs): |
0df68c9f | 1416 | """ |
a95a7133 | 1417 | Set(self, int x=0, int y=0, int width=0, int height=0) |
e811c8ce | 1418 | |
0df68c9f RD |
1419 | Set all rectangle properties. |
1420 | """ | |
54f9ee45 | 1421 | return _core_.Rect_Set(*args, **kwargs) |
e811c8ce RD |
1422 | |
1423 | def Get(*args, **kwargs): | |
0df68c9f RD |
1424 | """ |
1425 | Get() -> (x,y,width,height) | |
e811c8ce | 1426 | |
0df68c9f RD |
1427 | Return the rectangle properties as a tuple. |
1428 | """ | |
54f9ee45 | 1429 | return _core_.Rect_Get(*args, **kwargs) |
e811c8ce | 1430 | |
41e2b43e | 1431 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1432 | def __str__(self): return str(self.Get()) |
1433 | def __repr__(self): return 'wx.Rect'+str(self.Get()) | |
1434 | def __len__(self): return len(self.Get()) | |
1435 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
1436 | def __setitem__(self, index, val): |
1437 | if index == 0: self.x = val | |
1438 | elif index == 1: self.y = val | |
1439 | elif index == 2: self.width = val | |
1440 | elif index == 3: self.height = val | |
1441 | else: raise IndexError | |
e811c8ce | 1442 | def __nonzero__(self): return self.Get() != (0,0,0,0) |
74e96f3d RD |
1443 | __safe_for_unpickling__ = True |
1444 | def __reduce__(self): return (wx.Rect, self.Get()) | |
d14a1e28 | 1445 | |
33d6fd3b RD |
1446 | Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`") |
1447 | BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`") | |
5acb46e0 | 1448 | BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`") |
33d6fd3b RD |
1449 | Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") |
1450 | Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`") | |
1451 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") | |
1452 | Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`") | |
1453 | Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") | |
1454 | Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`") | |
1455 | TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`") | |
5acb46e0 | 1456 | TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`") |
33d6fd3b RD |
1457 | Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") |
1458 | X = property(GetX,SetX,doc="See `GetX` and `SetX`") | |
1459 | Y = property(GetY,SetY,doc="See `GetY` and `SetY`") | |
1460 | Empty = property(IsEmpty,doc="See `IsEmpty`") | |
2131d850 | 1461 | _core_.Rect_swigregister(Rect) |
d14a1e28 RD |
1462 | |
1463 | def RectPP(*args, **kwargs): | |
0df68c9f RD |
1464 | """ |
1465 | RectPP(Point topLeft, Point bottomRight) -> Rect | |
e811c8ce | 1466 | |
0df68c9f RD |
1467 | Create a new Rect object from Points representing two corners. |
1468 | """ | |
54f9ee45 | 1469 | val = _core_.new_RectPP(*args, **kwargs) |
d14a1e28 RD |
1470 | return val |
1471 | ||
1472 | def RectPS(*args, **kwargs): | |
0df68c9f RD |
1473 | """ |
1474 | RectPS(Point pos, Size size) -> Rect | |
e811c8ce | 1475 | |
0df68c9f RD |
1476 | Create a new Rect from a position and size. |
1477 | """ | |
54f9ee45 | 1478 | val = _core_.new_RectPS(*args, **kwargs) |
d14a1e28 RD |
1479 | return val |
1480 | ||
d3b6e4ff RD |
1481 | def RectS(*args, **kwargs): |
1482 | """ | |
1483 | RectS(Size size) -> Rect | |
1484 | ||
1485 | Create a new Rect from a size only. | |
1486 | """ | |
1487 | val = _core_.new_RectS(*args, **kwargs) | |
d3b6e4ff RD |
1488 | return val |
1489 | ||
d14a1e28 | 1490 | |
e811c8ce | 1491 | def IntersectRect(*args, **kwargs): |
0085ce49 | 1492 | """ |
0df68c9f | 1493 | IntersectRect(Rect r1, Rect r2) -> Rect |
e811c8ce | 1494 | |
0df68c9f RD |
1495 | Calculate and return the intersection of r1 and r2. |
1496 | """ | |
0085ce49 | 1497 | return _core_.IntersectRect(*args, **kwargs) |
d14a1e28 RD |
1498 | #--------------------------------------------------------------------------- |
1499 | ||
1500 | class Point2D(object): | |
41e2b43e RD |
1501 | """ |
1502 | wx.Point2Ds represent a point or a vector in a 2d coordinate system | |
1503 | with floating point values. | |
1504 | """ | |
0085ce49 RD |
1505 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1506 | __repr__ = _swig_repr | |
1507 | def __init__(self, *args, **kwargs): | |
0df68c9f | 1508 | """ |
a95a7133 | 1509 | __init__(self, double x=0.0, double y=0.0) -> Point2D |
e811c8ce | 1510 | |
0df68c9f RD |
1511 | Create a w.Point2D object. |
1512 | """ | |
0085ce49 | 1513 | _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs)) |
b39fe951 RD |
1514 | __swig_destroy__ = _core_.delete_Point2D |
1515 | __del__ = lambda self : None; | |
e811c8ce | 1516 | def GetFloor(*args, **kwargs): |
fd2dc343 RD |
1517 | """ |
1518 | GetFloor() -> (x,y) | |
1519 | ||
1520 | Convert to integer | |
1521 | """ | |
54f9ee45 | 1522 | return _core_.Point2D_GetFloor(*args, **kwargs) |
e811c8ce RD |
1523 | |
1524 | def GetRounded(*args, **kwargs): | |
fd2dc343 RD |
1525 | """ |
1526 | GetRounded() -> (x,y) | |
1527 | ||
1528 | Convert to integer | |
1529 | """ | |
54f9ee45 | 1530 | return _core_.Point2D_GetRounded(*args, **kwargs) |
e811c8ce RD |
1531 | |
1532 | def GetVectorLength(*args, **kwargs): | |
a95a7133 | 1533 | """GetVectorLength(self) -> double""" |
54f9ee45 | 1534 | return _core_.Point2D_GetVectorLength(*args, **kwargs) |
e811c8ce RD |
1535 | |
1536 | def GetVectorAngle(*args, **kwargs): | |
a95a7133 | 1537 | """GetVectorAngle(self) -> double""" |
54f9ee45 | 1538 | return _core_.Point2D_GetVectorAngle(*args, **kwargs) |
e811c8ce RD |
1539 | |
1540 | def SetVectorLength(*args, **kwargs): | |
a95a7133 | 1541 | """SetVectorLength(self, double length)""" |
54f9ee45 | 1542 | return _core_.Point2D_SetVectorLength(*args, **kwargs) |
e811c8ce RD |
1543 | |
1544 | def SetVectorAngle(*args, **kwargs): | |
a95a7133 | 1545 | """SetVectorAngle(self, double degrees)""" |
54f9ee45 | 1546 | return _core_.Point2D_SetVectorAngle(*args, **kwargs) |
e811c8ce | 1547 | |
d14a1e28 RD |
1548 | def SetPolarCoordinates(self, angle, length): |
1549 | self.SetVectorLength(length) | |
1550 | self.SetVectorAngle(angle) | |
1551 | def Normalize(self): | |
1552 | self.SetVectorLength(1.0) | |
1553 | ||
e811c8ce | 1554 | def GetDistance(*args, **kwargs): |
a95a7133 | 1555 | """GetDistance(self, Point2D pt) -> double""" |
54f9ee45 | 1556 | return _core_.Point2D_GetDistance(*args, **kwargs) |
e811c8ce RD |
1557 | |
1558 | def GetDistanceSquare(*args, **kwargs): | |
a95a7133 | 1559 | """GetDistanceSquare(self, Point2D pt) -> double""" |
54f9ee45 | 1560 | return _core_.Point2D_GetDistanceSquare(*args, **kwargs) |
e811c8ce RD |
1561 | |
1562 | def GetDotProduct(*args, **kwargs): | |
a95a7133 | 1563 | """GetDotProduct(self, Point2D vec) -> double""" |
54f9ee45 | 1564 | return _core_.Point2D_GetDotProduct(*args, **kwargs) |
e811c8ce RD |
1565 | |
1566 | def GetCrossProduct(*args, **kwargs): | |
a95a7133 | 1567 | """GetCrossProduct(self, Point2D vec) -> double""" |
54f9ee45 | 1568 | return _core_.Point2D_GetCrossProduct(*args, **kwargs) |
e811c8ce RD |
1569 | |
1570 | def __neg__(*args, **kwargs): | |
0df68c9f | 1571 | """ |
a95a7133 | 1572 | __neg__(self) -> Point2D |
e811c8ce | 1573 | |
0df68c9f RD |
1574 | the reflection of this point |
1575 | """ | |
54f9ee45 | 1576 | return _core_.Point2D___neg__(*args, **kwargs) |
e811c8ce RD |
1577 | |
1578 | def __iadd__(*args, **kwargs): | |
a95a7133 | 1579 | """__iadd__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1580 | return _core_.Point2D___iadd__(*args, **kwargs) |
e811c8ce RD |
1581 | |
1582 | def __isub__(*args, **kwargs): | |
a95a7133 | 1583 | """__isub__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1584 | return _core_.Point2D___isub__(*args, **kwargs) |
e811c8ce RD |
1585 | |
1586 | def __imul__(*args, **kwargs): | |
a95a7133 | 1587 | """__imul__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1588 | return _core_.Point2D___imul__(*args, **kwargs) |
e811c8ce RD |
1589 | |
1590 | def __idiv__(*args, **kwargs): | |
a95a7133 | 1591 | """__idiv__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1592 | return _core_.Point2D___idiv__(*args, **kwargs) |
e811c8ce RD |
1593 | |
1594 | def __eq__(*args, **kwargs): | |
0df68c9f | 1595 | """ |
e9d6f3a4 | 1596 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1597 | |
e9d6f3a4 | 1598 | Test for equality of wx.Point2D objects. |
0df68c9f | 1599 | """ |
54f9ee45 | 1600 | return _core_.Point2D___eq__(*args, **kwargs) |
e811c8ce RD |
1601 | |
1602 | def __ne__(*args, **kwargs): | |
0df68c9f | 1603 | """ |
e9d6f3a4 | 1604 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1605 | |
e9d6f3a4 | 1606 | Test for inequality of wx.Point2D objects. |
0df68c9f | 1607 | """ |
54f9ee45 | 1608 | return _core_.Point2D___ne__(*args, **kwargs) |
e811c8ce | 1609 | |
54f9ee45 RD |
1610 | x = property(_core_.Point2D_x_get, _core_.Point2D_x_set) |
1611 | y = property(_core_.Point2D_y_get, _core_.Point2D_y_set) | |
e811c8ce | 1612 | def Set(*args, **kwargs): |
a95a7133 | 1613 | """Set(self, double x=0, double y=0)""" |
54f9ee45 | 1614 | return _core_.Point2D_Set(*args, **kwargs) |
e811c8ce RD |
1615 | |
1616 | def Get(*args, **kwargs): | |
0df68c9f RD |
1617 | """ |
1618 | Get() -> (x,y) | |
e811c8ce | 1619 | |
0df68c9f RD |
1620 | Return x and y properties as a tuple. |
1621 | """ | |
54f9ee45 | 1622 | return _core_.Point2D_Get(*args, **kwargs) |
e811c8ce | 1623 | |
41e2b43e | 1624 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1625 | def __str__(self): return str(self.Get()) |
1626 | def __repr__(self): return 'wx.Point2D'+str(self.Get()) | |
1627 | def __len__(self): return len(self.Get()) | |
1628 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 | 1629 | def __setitem__(self, index, val): |
e811c8ce RD |
1630 | if index == 0: self.x = val |
1631 | elif index == 1: self.y = val | |
d14a1e28 | 1632 | else: raise IndexError |
e811c8ce | 1633 | def __nonzero__(self): return self.Get() != (0.0, 0.0) |
74e96f3d RD |
1634 | __safe_for_unpickling__ = True |
1635 | def __reduce__(self): return (wx.Point2D, self.Get()) | |
d14a1e28 | 1636 | |
33d6fd3b RD |
1637 | Floor = property(GetFloor,doc="See `GetFloor`") |
1638 | Rounded = property(GetRounded,doc="See `GetRounded`") | |
1639 | VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`") | |
1640 | VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`") | |
2131d850 | 1641 | _core_.Point2D_swigregister(Point2D) |
d14a1e28 RD |
1642 | |
1643 | def Point2DCopy(*args, **kwargs): | |
0df68c9f RD |
1644 | """ |
1645 | Point2DCopy(Point2D pt) -> Point2D | |
e811c8ce | 1646 | |
0df68c9f RD |
1647 | Create a w.Point2D object. |
1648 | """ | |
54f9ee45 | 1649 | val = _core_.new_Point2DCopy(*args, **kwargs) |
d14a1e28 RD |
1650 | return val |
1651 | ||
1652 | def Point2DFromPoint(*args, **kwargs): | |
0df68c9f RD |
1653 | """ |
1654 | Point2DFromPoint(Point pt) -> Point2D | |
e811c8ce | 1655 | |
0df68c9f RD |
1656 | Create a w.Point2D object. |
1657 | """ | |
54f9ee45 | 1658 | val = _core_.new_Point2DFromPoint(*args, **kwargs) |
d14a1e28 RD |
1659 | return val |
1660 | ||
1661 | #--------------------------------------------------------------------------- | |
1662 | ||
70d7cb34 RD |
1663 | Inside = _core_.Inside |
1664 | OutLeft = _core_.OutLeft | |
1665 | OutRight = _core_.OutRight | |
1666 | OutTop = _core_.OutTop | |
1667 | OutBottom = _core_.OutBottom | |
1668 | class Rect2D(object): | |
1669 | """ | |
1670 | wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system | |
1671 | with floating point component values. | |
1672 | """ | |
1673 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
1674 | __repr__ = _swig_repr | |
1675 | def __init__(self, *args, **kwargs): | |
1676 | """ | |
1677 | __init__(self, wxDouble x=0.0, wxDouble y=0.0, wxDouble w=0.0, wxDouble h=0.0) -> Rect2D | |
1678 | ||
1679 | wx.Rect2D is a rectangle, with position and size, in a 2D coordinate system | |
1680 | with floating point component values. | |
1681 | """ | |
1682 | _core_.Rect2D_swiginit(self,_core_.new_Rect2D(*args, **kwargs)) | |
1683 | __swig_destroy__ = _core_.delete_Rect2D | |
1684 | __del__ = lambda self : None; | |
1685 | def GetPosition(*args, **kwargs): | |
1686 | """GetPosition(self) -> Point2D""" | |
1687 | return _core_.Rect2D_GetPosition(*args, **kwargs) | |
1688 | ||
1689 | def GetSize(*args, **kwargs): | |
1690 | """GetSize(self) -> Size""" | |
1691 | return _core_.Rect2D_GetSize(*args, **kwargs) | |
1692 | ||
1693 | def GetLeft(*args, **kwargs): | |
1694 | """GetLeft(self) -> wxDouble""" | |
1695 | return _core_.Rect2D_GetLeft(*args, **kwargs) | |
1696 | ||
1697 | def SetLeft(*args, **kwargs): | |
1698 | """SetLeft(self, wxDouble n)""" | |
1699 | return _core_.Rect2D_SetLeft(*args, **kwargs) | |
1700 | ||
1701 | def MoveLeftTo(*args, **kwargs): | |
1702 | """MoveLeftTo(self, wxDouble n)""" | |
1703 | return _core_.Rect2D_MoveLeftTo(*args, **kwargs) | |
1704 | ||
1705 | def GetTop(*args, **kwargs): | |
1706 | """GetTop(self) -> wxDouble""" | |
1707 | return _core_.Rect2D_GetTop(*args, **kwargs) | |
1708 | ||
1709 | def SetTop(*args, **kwargs): | |
1710 | """SetTop(self, wxDouble n)""" | |
1711 | return _core_.Rect2D_SetTop(*args, **kwargs) | |
1712 | ||
1713 | def MoveTopTo(*args, **kwargs): | |
1714 | """MoveTopTo(self, wxDouble n)""" | |
1715 | return _core_.Rect2D_MoveTopTo(*args, **kwargs) | |
1716 | ||
1717 | def GetBottom(*args, **kwargs): | |
1718 | """GetBottom(self) -> wxDouble""" | |
1719 | return _core_.Rect2D_GetBottom(*args, **kwargs) | |
1720 | ||
1721 | def SetBottom(*args, **kwargs): | |
1722 | """SetBottom(self, wxDouble n)""" | |
1723 | return _core_.Rect2D_SetBottom(*args, **kwargs) | |
1724 | ||
1725 | def MoveBottomTo(*args, **kwargs): | |
1726 | """MoveBottomTo(self, wxDouble n)""" | |
1727 | return _core_.Rect2D_MoveBottomTo(*args, **kwargs) | |
1728 | ||
1729 | def GetRight(*args, **kwargs): | |
1730 | """GetRight(self) -> wxDouble""" | |
1731 | return _core_.Rect2D_GetRight(*args, **kwargs) | |
1732 | ||
1733 | def SetRight(*args, **kwargs): | |
1734 | """SetRight(self, wxDouble n)""" | |
1735 | return _core_.Rect2D_SetRight(*args, **kwargs) | |
1736 | ||
1737 | def MoveRightTo(*args, **kwargs): | |
1738 | """MoveRightTo(self, wxDouble n)""" | |
1739 | return _core_.Rect2D_MoveRightTo(*args, **kwargs) | |
1740 | ||
1741 | def GetLeftTop(*args, **kwargs): | |
1742 | """GetLeftTop(self) -> Point2D""" | |
1743 | return _core_.Rect2D_GetLeftTop(*args, **kwargs) | |
1744 | ||
1745 | def SetLeftTop(*args, **kwargs): | |
1746 | """SetLeftTop(self, Point2D pt)""" | |
1747 | return _core_.Rect2D_SetLeftTop(*args, **kwargs) | |
1748 | ||
1749 | def MoveLeftTopTo(*args, **kwargs): | |
1750 | """MoveLeftTopTo(self, Point2D pt)""" | |
1751 | return _core_.Rect2D_MoveLeftTopTo(*args, **kwargs) | |
1752 | ||
1753 | def GetLeftBottom(*args, **kwargs): | |
1754 | """GetLeftBottom(self) -> Point2D""" | |
1755 | return _core_.Rect2D_GetLeftBottom(*args, **kwargs) | |
1756 | ||
1757 | def SetLeftBottom(*args, **kwargs): | |
1758 | """SetLeftBottom(self, Point2D pt)""" | |
1759 | return _core_.Rect2D_SetLeftBottom(*args, **kwargs) | |
1760 | ||
1761 | def MoveLeftBottomTo(*args, **kwargs): | |
1762 | """MoveLeftBottomTo(self, Point2D pt)""" | |
1763 | return _core_.Rect2D_MoveLeftBottomTo(*args, **kwargs) | |
1764 | ||
1765 | def GetRightTop(*args, **kwargs): | |
1766 | """GetRightTop(self) -> Point2D""" | |
1767 | return _core_.Rect2D_GetRightTop(*args, **kwargs) | |
1768 | ||
1769 | def SetRightTop(*args, **kwargs): | |
1770 | """SetRightTop(self, Point2D pt)""" | |
1771 | return _core_.Rect2D_SetRightTop(*args, **kwargs) | |
1772 | ||
1773 | def MoveRightTopTo(*args, **kwargs): | |
1774 | """MoveRightTopTo(self, Point2D pt)""" | |
1775 | return _core_.Rect2D_MoveRightTopTo(*args, **kwargs) | |
1776 | ||
1777 | def GetRightBottom(*args, **kwargs): | |
1778 | """GetRightBottom(self) -> Point2D""" | |
1779 | return _core_.Rect2D_GetRightBottom(*args, **kwargs) | |
1780 | ||
1781 | def SetRightBottom(*args, **kwargs): | |
1782 | """SetRightBottom(self, Point2D pt)""" | |
1783 | return _core_.Rect2D_SetRightBottom(*args, **kwargs) | |
1784 | ||
1785 | def MoveRightBottomTo(*args, **kwargs): | |
1786 | """MoveRightBottomTo(self, Point2D pt)""" | |
1787 | return _core_.Rect2D_MoveRightBottomTo(*args, **kwargs) | |
1788 | ||
1789 | def GetCentre(*args, **kwargs): | |
1790 | """GetCentre(self) -> Point2D""" | |
1791 | return _core_.Rect2D_GetCentre(*args, **kwargs) | |
1792 | ||
1793 | def SetCentre(*args, **kwargs): | |
1794 | """SetCentre(self, Point2D pt)""" | |
1795 | return _core_.Rect2D_SetCentre(*args, **kwargs) | |
1796 | ||
1797 | def MoveCentreTo(*args, **kwargs): | |
1798 | """MoveCentreTo(self, Point2D pt)""" | |
1799 | return _core_.Rect2D_MoveCentreTo(*args, **kwargs) | |
1800 | ||
1801 | def GetOutcode(*args, **kwargs): | |
1802 | """GetOutcode(self, Point2D pt) -> int""" | |
1803 | return _core_.Rect2D_GetOutcode(*args, **kwargs) | |
1804 | ||
1805 | def Contains(*args, **kwargs): | |
1806 | """Contains(self, Point2D pt) -> bool""" | |
1807 | return _core_.Rect2D_Contains(*args, **kwargs) | |
1808 | ||
1809 | def ContainsRect(*args, **kwargs): | |
1810 | """ContainsRect(self, Rect2D rect) -> bool""" | |
1811 | return _core_.Rect2D_ContainsRect(*args, **kwargs) | |
1812 | ||
1813 | def IsEmpty(*args, **kwargs): | |
1814 | """IsEmpty(self) -> bool""" | |
1815 | return _core_.Rect2D_IsEmpty(*args, **kwargs) | |
1816 | ||
1817 | def HaveEqualSize(*args, **kwargs): | |
1818 | """HaveEqualSize(self, Rect2D rect) -> bool""" | |
1819 | return _core_.Rect2D_HaveEqualSize(*args, **kwargs) | |
1820 | ||
1821 | def Inset(*args): | |
1822 | """ | |
1823 | Inset(self, wxDouble x, wxDouble y) | |
1824 | Inset(self, wxDouble left, wxDouble top, wxDouble right, wxDouble bottom) | |
1825 | """ | |
1826 | return _core_.Rect2D_Inset(*args) | |
1827 | ||
1828 | def Offset(*args, **kwargs): | |
1829 | """Offset(self, Point2D pt)""" | |
1830 | return _core_.Rect2D_Offset(*args, **kwargs) | |
1831 | ||
1832 | def ConstrainTo(*args, **kwargs): | |
1833 | """ConstrainTo(self, Rect2D rect)""" | |
1834 | return _core_.Rect2D_ConstrainTo(*args, **kwargs) | |
1835 | ||
1836 | def Interpolate(*args, **kwargs): | |
1837 | """Interpolate(self, int widthfactor, int heightfactor) -> Point2D""" | |
1838 | return _core_.Rect2D_Interpolate(*args, **kwargs) | |
1839 | ||
1840 | def Intersect(*args, **kwargs): | |
1841 | """Intersect(self, Rect2D otherRect)""" | |
1842 | return _core_.Rect2D_Intersect(*args, **kwargs) | |
1843 | ||
1844 | def CreateIntersection(*args, **kwargs): | |
1845 | """CreateIntersection(self, Rect2D otherRect) -> Rect2D""" | |
1846 | return _core_.Rect2D_CreateIntersection(*args, **kwargs) | |
1847 | ||
1848 | def Intersects(*args, **kwargs): | |
1849 | """Intersects(self, Rect2D rect) -> bool""" | |
1850 | return _core_.Rect2D_Intersects(*args, **kwargs) | |
1851 | ||
1852 | def Union(*args, **kwargs): | |
1853 | """Union(self, Rect2D otherRect)""" | |
1854 | return _core_.Rect2D_Union(*args, **kwargs) | |
1855 | ||
1856 | def CreateUnion(*args, **kwargs): | |
1857 | """CreateUnion(self, Rect2D otherRect) -> Rect2D""" | |
1858 | return _core_.Rect2D_CreateUnion(*args, **kwargs) | |
1859 | ||
1860 | def Scale(*args): | |
1861 | """ | |
1862 | Scale(self, wxDouble f) | |
1863 | Scale(self, int num, int denum) | |
1864 | """ | |
1865 | return _core_.Rect2D_Scale(*args) | |
1866 | ||
1867 | def __eq__(*args, **kwargs): | |
1868 | """ | |
1869 | __eq__(self, PyObject other) -> bool | |
1870 | ||
1871 | Test for equality of wx.Rect2D objects. | |
1872 | """ | |
1873 | return _core_.Rect2D___eq__(*args, **kwargs) | |
1874 | ||
1875 | def __ne__(*args, **kwargs): | |
1876 | """ | |
1877 | __ne__(self, PyObject other) -> bool | |
1878 | ||
1879 | Test for inequality of wx.Rect2D objects. | |
1880 | """ | |
1881 | return _core_.Rect2D___ne__(*args, **kwargs) | |
1882 | ||
1883 | x = property(_core_.Rect2D_x_get, _core_.Rect2D_x_set) | |
1884 | y = property(_core_.Rect2D_y_get, _core_.Rect2D_y_set) | |
1885 | width = property(_core_.Rect2D_width_get, _core_.Rect2D_width_set) | |
1886 | height = property(_core_.Rect2D_height_get, _core_.Rect2D_height_set) | |
1887 | def Set(*args, **kwargs): | |
1888 | """Set(self, wxDouble x=0, wxDouble y=0, wxDouble width=0, wxDouble height=0)""" | |
1889 | return _core_.Rect2D_Set(*args, **kwargs) | |
1890 | ||
1891 | def Get(*args, **kwargs): | |
1892 | """ | |
1893 | Get() -> (x,y, width, height) | |
1894 | ||
1895 | Return x, y, width and height y properties as a tuple. | |
1896 | """ | |
1897 | return _core_.Rect2D_Get(*args, **kwargs) | |
1898 | ||
1899 | def __str__(self): return str(self.Get()) | |
1900 | def __repr__(self): return 'wx.Rect2D'+str(self.Get()) | |
1901 | def __len__(self): return len(self.Get()) | |
1902 | def __getitem__(self, index): return self.Get()[index] | |
1903 | def __setitem__(self, index, val): | |
1904 | if index == 0: self.x = val | |
1905 | elif index == 1: self.y = val | |
1906 | elif index == 2: self.width = val | |
1907 | elif index == 3: self.height = val | |
1908 | else: raise IndexError | |
1909 | def __nonzero__(self): return self.Get() != (0.0, 0.0, 0.0, 0.0) | |
1910 | __safe_for_unpickling__ = True | |
1911 | def __reduce__(self): return (wx.Rect2D, self.Get()) | |
1912 | ||
1913 | _core_.Rect2D_swigregister(Rect2D) | |
1914 | ||
1915 | #--------------------------------------------------------------------------- | |
1916 | ||
54f9ee45 RD |
1917 | FromStart = _core_.FromStart |
1918 | FromCurrent = _core_.FromCurrent | |
1919 | FromEnd = _core_.FromEnd | |
d14a1e28 | 1920 | class InputStream(object): |
093d3ff1 | 1921 | """Proxy of C++ InputStream class""" |
0085ce49 RD |
1922 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1923 | __repr__ = _swig_repr | |
1924 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1925 | """__init__(self, PyObject p) -> InputStream""" |
0085ce49 RD |
1926 | _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs)) |
1927 | __swig_destroy__ = _core_.delete_InputStream | |
1928 | __del__ = lambda self : None; | |
e811c8ce | 1929 | def close(*args, **kwargs): |
a95a7133 | 1930 | """close(self)""" |
54f9ee45 | 1931 | return _core_.InputStream_close(*args, **kwargs) |
e811c8ce RD |
1932 | |
1933 | def flush(*args, **kwargs): | |
a95a7133 | 1934 | """flush(self)""" |
54f9ee45 | 1935 | return _core_.InputStream_flush(*args, **kwargs) |
e811c8ce RD |
1936 | |
1937 | def eof(*args, **kwargs): | |
a95a7133 | 1938 | """eof(self) -> bool""" |
54f9ee45 | 1939 | return _core_.InputStream_eof(*args, **kwargs) |
e811c8ce RD |
1940 | |
1941 | def read(*args, **kwargs): | |
a95a7133 | 1942 | """read(self, int size=-1) -> PyObject""" |
54f9ee45 | 1943 | return _core_.InputStream_read(*args, **kwargs) |
e811c8ce RD |
1944 | |
1945 | def readline(*args, **kwargs): | |
a95a7133 | 1946 | """readline(self, int size=-1) -> PyObject""" |
54f9ee45 | 1947 | return _core_.InputStream_readline(*args, **kwargs) |
e811c8ce RD |
1948 | |
1949 | def readlines(*args, **kwargs): | |
a95a7133 | 1950 | """readlines(self, int sizehint=-1) -> PyObject""" |
54f9ee45 | 1951 | return _core_.InputStream_readlines(*args, **kwargs) |
e811c8ce RD |
1952 | |
1953 | def seek(*args, **kwargs): | |
a95a7133 | 1954 | """seek(self, int offset, int whence=0)""" |
54f9ee45 | 1955 | return _core_.InputStream_seek(*args, **kwargs) |
e811c8ce RD |
1956 | |
1957 | def tell(*args, **kwargs): | |
a95a7133 | 1958 | """tell(self) -> int""" |
54f9ee45 | 1959 | return _core_.InputStream_tell(*args, **kwargs) |
e811c8ce RD |
1960 | |
1961 | def Peek(*args, **kwargs): | |
a95a7133 | 1962 | """Peek(self) -> char""" |
54f9ee45 | 1963 | return _core_.InputStream_Peek(*args, **kwargs) |
e811c8ce RD |
1964 | |
1965 | def GetC(*args, **kwargs): | |
a95a7133 | 1966 | """GetC(self) -> char""" |
54f9ee45 | 1967 | return _core_.InputStream_GetC(*args, **kwargs) |
e811c8ce RD |
1968 | |
1969 | def LastRead(*args, **kwargs): | |
a95a7133 | 1970 | """LastRead(self) -> size_t""" |
54f9ee45 | 1971 | return _core_.InputStream_LastRead(*args, **kwargs) |
e811c8ce RD |
1972 | |
1973 | def CanRead(*args, **kwargs): | |
a95a7133 | 1974 | """CanRead(self) -> bool""" |
54f9ee45 | 1975 | return _core_.InputStream_CanRead(*args, **kwargs) |
e811c8ce RD |
1976 | |
1977 | def Eof(*args, **kwargs): | |
a95a7133 | 1978 | """Eof(self) -> bool""" |
54f9ee45 | 1979 | return _core_.InputStream_Eof(*args, **kwargs) |
e811c8ce RD |
1980 | |
1981 | def Ungetch(*args, **kwargs): | |
a95a7133 | 1982 | """Ungetch(self, char c) -> bool""" |
54f9ee45 | 1983 | return _core_.InputStream_Ungetch(*args, **kwargs) |
e811c8ce RD |
1984 | |
1985 | def SeekI(*args, **kwargs): | |
a95a7133 | 1986 | """SeekI(self, long pos, int mode=FromStart) -> long""" |
54f9ee45 | 1987 | return _core_.InputStream_SeekI(*args, **kwargs) |
e811c8ce RD |
1988 | |
1989 | def TellI(*args, **kwargs): | |
a95a7133 | 1990 | """TellI(self) -> long""" |
54f9ee45 | 1991 | return _core_.InputStream_TellI(*args, **kwargs) |
e811c8ce | 1992 | |
2131d850 | 1993 | _core_.InputStream_swigregister(InputStream) |
d14a1e28 RD |
1994 | DefaultPosition = cvar.DefaultPosition |
1995 | DefaultSize = cvar.DefaultSize | |
1996 | ||
1997 | class OutputStream(object): | |
093d3ff1 | 1998 | """Proxy of C++ OutputStream class""" |
0085ce49 RD |
1999 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2000 | def __init__(self): raise AttributeError, "No constructor defined" | |
2001 | __repr__ = _swig_repr | |
e811c8ce | 2002 | def write(*args, **kwargs): |
a95a7133 | 2003 | """write(self, PyObject obj)""" |
54f9ee45 | 2004 | return _core_.OutputStream_write(*args, **kwargs) |
e811c8ce | 2005 | |
0085ce49 RD |
2006 | def LastWrite(*args, **kwargs): |
2007 | """LastWrite(self) -> size_t""" | |
2008 | return _core_.OutputStream_LastWrite(*args, **kwargs) | |
d14a1e28 | 2009 | |
2131d850 | 2010 | _core_.OutputStream_swigregister(OutputStream) |
d14a1e28 RD |
2011 | |
2012 | #--------------------------------------------------------------------------- | |
2013 | ||
2014 | class FSFile(Object): | |
093d3ff1 | 2015 | """Proxy of C++ FSFile class""" |
0085ce49 RD |
2016 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2017 | __repr__ = _swig_repr | |
2018 | def __init__(self, *args, **kwargs): | |
0df68c9f | 2019 | """ |
a95a7133 | 2020 | __init__(self, InputStream stream, String loc, String mimetype, String anchor, |
196addbf | 2021 | DateTime modif) -> FSFile |
0df68c9f | 2022 | """ |
0085ce49 | 2023 | _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs)) |
0085ce49 RD |
2024 | __swig_destroy__ = _core_.delete_FSFile |
2025 | __del__ = lambda self : None; | |
e811c8ce | 2026 | def GetStream(*args, **kwargs): |
a95a7133 | 2027 | """GetStream(self) -> InputStream""" |
54f9ee45 | 2028 | return _core_.FSFile_GetStream(*args, **kwargs) |
e811c8ce | 2029 | |
97ab0f6a RD |
2030 | def DetachStream(*args, **kwargs): |
2031 | """DetachStream(self)""" | |
2032 | return _core_.FSFile_DetachStream(*args, **kwargs) | |
2033 | ||
e811c8ce | 2034 | def GetMimeType(*args, **kwargs): |
a95a7133 | 2035 | """GetMimeType(self) -> String""" |
54f9ee45 | 2036 | return _core_.FSFile_GetMimeType(*args, **kwargs) |
e811c8ce RD |
2037 | |
2038 | def GetLocation(*args, **kwargs): | |
a95a7133 | 2039 | """GetLocation(self) -> String""" |
54f9ee45 | 2040 | return _core_.FSFile_GetLocation(*args, **kwargs) |
e811c8ce RD |
2041 | |
2042 | def GetAnchor(*args, **kwargs): | |
a95a7133 | 2043 | """GetAnchor(self) -> String""" |
54f9ee45 | 2044 | return _core_.FSFile_GetAnchor(*args, **kwargs) |
e811c8ce RD |
2045 | |
2046 | def GetModificationTime(*args, **kwargs): | |
a95a7133 | 2047 | """GetModificationTime(self) -> DateTime""" |
54f9ee45 | 2048 | return _core_.FSFile_GetModificationTime(*args, **kwargs) |
e811c8ce | 2049 | |
97ab0f6a RD |
2050 | Anchor = property(GetAnchor,doc="See `GetAnchor`") |
2051 | Location = property(GetLocation,doc="See `GetLocation`") | |
2052 | MimeType = property(GetMimeType,doc="See `GetMimeType`") | |
2053 | ModificationTime = property(GetModificationTime,doc="See `GetModificationTime`") | |
2054 | Stream = property(GetStream,doc="See `GetStream`") | |
2131d850 | 2055 | _core_.FSFile_swigregister(FSFile) |
d14a1e28 RD |
2056 | |
2057 | class CPPFileSystemHandler(object): | |
093d3ff1 | 2058 | """Proxy of C++ CPPFileSystemHandler class""" |
0085ce49 RD |
2059 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2060 | def __init__(self): raise AttributeError, "No constructor defined" | |
2061 | __repr__ = _swig_repr | |
50f151d7 RD |
2062 | __swig_destroy__ = _core_.delete_CPPFileSystemHandler |
2063 | __del__ = lambda self : None; | |
2131d850 | 2064 | _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler) |
d14a1e28 RD |
2065 | |
2066 | class FileSystemHandler(CPPFileSystemHandler): | |
093d3ff1 | 2067 | """Proxy of C++ FileSystemHandler class""" |
0085ce49 RD |
2068 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2069 | __repr__ = _swig_repr | |
2070 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2071 | """__init__(self) -> FileSystemHandler""" |
0085ce49 | 2072 | _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs)) |
c25f90f6 | 2073 | FileSystemHandler._setCallbackInfo(self, self, FileSystemHandler) |
e811c8ce RD |
2074 | |
2075 | def _setCallbackInfo(*args, **kwargs): | |
a95a7133 | 2076 | """_setCallbackInfo(self, PyObject self, PyObject _class)""" |
54f9ee45 | 2077 | return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs) |
e811c8ce RD |
2078 | |
2079 | def CanOpen(*args, **kwargs): | |
a95a7133 | 2080 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 2081 | return _core_.FileSystemHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
2082 | |
2083 | def OpenFile(*args, **kwargs): | |
a95a7133 | 2084 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 2085 | return _core_.FileSystemHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
2086 | |
2087 | def FindFirst(*args, **kwargs): | |
a95a7133 | 2088 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 2089 | return _core_.FileSystemHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
2090 | |
2091 | def FindNext(*args, **kwargs): | |
a95a7133 | 2092 | """FindNext(self) -> String""" |
54f9ee45 | 2093 | return _core_.FileSystemHandler_FindNext(*args, **kwargs) |
e811c8ce RD |
2094 | |
2095 | def GetProtocol(*args, **kwargs): | |
a95a7133 | 2096 | """GetProtocol(self, String location) -> String""" |
54f9ee45 | 2097 | return _core_.FileSystemHandler_GetProtocol(*args, **kwargs) |
e811c8ce RD |
2098 | |
2099 | def GetLeftLocation(*args, **kwargs): | |
a95a7133 | 2100 | """GetLeftLocation(self, String location) -> String""" |
54f9ee45 | 2101 | return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs) |
e811c8ce RD |
2102 | |
2103 | def GetAnchor(*args, **kwargs): | |
a95a7133 | 2104 | """GetAnchor(self, String location) -> String""" |
54f9ee45 | 2105 | return _core_.FileSystemHandler_GetAnchor(*args, **kwargs) |
e811c8ce RD |
2106 | |
2107 | def GetRightLocation(*args, **kwargs): | |
a95a7133 | 2108 | """GetRightLocation(self, String location) -> String""" |
54f9ee45 | 2109 | return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs) |
e811c8ce RD |
2110 | |
2111 | def GetMimeTypeFromExt(*args, **kwargs): | |
a95a7133 | 2112 | """GetMimeTypeFromExt(self, String location) -> String""" |
54f9ee45 | 2113 | return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs) |
e811c8ce | 2114 | |
97ab0f6a RD |
2115 | Anchor = property(GetAnchor,doc="See `GetAnchor`") |
2116 | LeftLocation = property(GetLeftLocation,doc="See `GetLeftLocation`") | |
2117 | MimeTypeFromExt = property(GetMimeTypeFromExt,doc="See `GetMimeTypeFromExt`") | |
2118 | Protocol = property(GetProtocol,doc="See `GetProtocol`") | |
2119 | RightLocation = property(GetRightLocation,doc="See `GetRightLocation`") | |
2131d850 | 2120 | _core_.FileSystemHandler_swigregister(FileSystemHandler) |
d14a1e28 RD |
2121 | |
2122 | class FileSystem(Object): | |
093d3ff1 | 2123 | """Proxy of C++ FileSystem class""" |
0085ce49 RD |
2124 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2125 | __repr__ = _swig_repr | |
2126 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2127 | """__init__(self) -> FileSystem""" |
0085ce49 RD |
2128 | _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs)) |
2129 | __swig_destroy__ = _core_.delete_FileSystem | |
2130 | __del__ = lambda self : None; | |
e811c8ce | 2131 | def ChangePathTo(*args, **kwargs): |
a95a7133 | 2132 | """ChangePathTo(self, String location, bool is_dir=False)""" |
54f9ee45 | 2133 | return _core_.FileSystem_ChangePathTo(*args, **kwargs) |
e811c8ce RD |
2134 | |
2135 | def GetPath(*args, **kwargs): | |
a95a7133 | 2136 | """GetPath(self) -> String""" |
54f9ee45 | 2137 | return _core_.FileSystem_GetPath(*args, **kwargs) |
e811c8ce RD |
2138 | |
2139 | def OpenFile(*args, **kwargs): | |
a95a7133 | 2140 | """OpenFile(self, String location) -> FSFile""" |
54f9ee45 | 2141 | return _core_.FileSystem_OpenFile(*args, **kwargs) |
e811c8ce RD |
2142 | |
2143 | def FindFirst(*args, **kwargs): | |
a95a7133 | 2144 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 2145 | return _core_.FileSystem_FindFirst(*args, **kwargs) |
e811c8ce RD |
2146 | |
2147 | def FindNext(*args, **kwargs): | |
a95a7133 | 2148 | """FindNext(self) -> String""" |
54f9ee45 | 2149 | return _core_.FileSystem_FindNext(*args, **kwargs) |
e811c8ce RD |
2150 | |
2151 | def AddHandler(*args, **kwargs): | |
66c033b4 | 2152 | """AddHandler(CPPFileSystemHandler handler)""" |
54f9ee45 | 2153 | return _core_.FileSystem_AddHandler(*args, **kwargs) |
e811c8ce RD |
2154 | |
2155 | AddHandler = staticmethod(AddHandler) | |
97ab0f6a RD |
2156 | def RemoveHandler(*args, **kwargs): |
2157 | """RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler""" | |
2158 | return _core_.FileSystem_RemoveHandler(*args, **kwargs) | |
2159 | ||
2160 | RemoveHandler = staticmethod(RemoveHandler) | |
e811c8ce | 2161 | def CleanUpHandlers(*args, **kwargs): |
66c033b4 | 2162 | """CleanUpHandlers()""" |
54f9ee45 | 2163 | return _core_.FileSystem_CleanUpHandlers(*args, **kwargs) |
e811c8ce RD |
2164 | |
2165 | CleanUpHandlers = staticmethod(CleanUpHandlers) | |
2166 | def FileNameToURL(*args, **kwargs): | |
66c033b4 | 2167 | """FileNameToURL(String filename) -> String""" |
54f9ee45 | 2168 | return _core_.FileSystem_FileNameToURL(*args, **kwargs) |
e811c8ce RD |
2169 | |
2170 | FileNameToURL = staticmethod(FileNameToURL) | |
2ef75293 RD |
2171 | def URLToFileName(*args, **kwargs): |
2172 | """URLToFileName(String url) -> String""" | |
2173 | return _core_.FileSystem_URLToFileName(*args, **kwargs) | |
2174 | ||
2175 | URLToFileName = staticmethod(URLToFileName) | |
97ab0f6a | 2176 | Path = property(GetPath,doc="See `GetPath`") |
2131d850 | 2177 | _core_.FileSystem_swigregister(FileSystem) |
d14a1e28 | 2178 | |
e811c8ce | 2179 | def FileSystem_AddHandler(*args, **kwargs): |
0085ce49 RD |
2180 | """FileSystem_AddHandler(CPPFileSystemHandler handler)""" |
2181 | return _core_.FileSystem_AddHandler(*args, **kwargs) | |
d14a1e28 | 2182 | |
97ab0f6a RD |
2183 | def FileSystem_RemoveHandler(*args, **kwargs): |
2184 | """FileSystem_RemoveHandler(CPPFileSystemHandler handler) -> CPPFileSystemHandler""" | |
2185 | return _core_.FileSystem_RemoveHandler(*args, **kwargs) | |
2186 | ||
0085ce49 RD |
2187 | def FileSystem_CleanUpHandlers(*args): |
2188 | """FileSystem_CleanUpHandlers()""" | |
2189 | return _core_.FileSystem_CleanUpHandlers(*args) | |
d14a1e28 | 2190 | |
e811c8ce | 2191 | def FileSystem_FileNameToURL(*args, **kwargs): |
0085ce49 RD |
2192 | """FileSystem_FileNameToURL(String filename) -> String""" |
2193 | return _core_.FileSystem_FileNameToURL(*args, **kwargs) | |
d14a1e28 | 2194 | |
e811c8ce | 2195 | def FileSystem_URLToFileName(*args, **kwargs): |
0085ce49 RD |
2196 | """FileSystem_URLToFileName(String url) -> String""" |
2197 | return _core_.FileSystem_URLToFileName(*args, **kwargs) | |
2ef75293 | 2198 | |
d14a1e28 | 2199 | class InternetFSHandler(CPPFileSystemHandler): |
093d3ff1 | 2200 | """Proxy of C++ InternetFSHandler class""" |
0085ce49 RD |
2201 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2202 | __repr__ = _swig_repr | |
2203 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2204 | """__init__(self) -> InternetFSHandler""" |
0085ce49 | 2205 | _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs)) |
e811c8ce | 2206 | def CanOpen(*args, **kwargs): |
a95a7133 | 2207 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 2208 | return _core_.InternetFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
2209 | |
2210 | def OpenFile(*args, **kwargs): | |
a95a7133 | 2211 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 2212 | return _core_.InternetFSHandler_OpenFile(*args, **kwargs) |
e811c8ce | 2213 | |
2131d850 | 2214 | _core_.InternetFSHandler_swigregister(InternetFSHandler) |
d14a1e28 RD |
2215 | |
2216 | class ZipFSHandler(CPPFileSystemHandler): | |
093d3ff1 | 2217 | """Proxy of C++ ZipFSHandler class""" |
0085ce49 RD |
2218 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2219 | __repr__ = _swig_repr | |
2220 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2221 | """__init__(self) -> ZipFSHandler""" |
0085ce49 | 2222 | _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs)) |
e811c8ce | 2223 | def CanOpen(*args, **kwargs): |
a95a7133 | 2224 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 2225 | return _core_.ZipFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
2226 | |
2227 | def OpenFile(*args, **kwargs): | |
a95a7133 | 2228 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 2229 | return _core_.ZipFSHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
2230 | |
2231 | def FindFirst(*args, **kwargs): | |
a95a7133 | 2232 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 2233 | return _core_.ZipFSHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
2234 | |
2235 | def FindNext(*args, **kwargs): | |
a95a7133 | 2236 | """FindNext(self) -> String""" |
54f9ee45 | 2237 | return _core_.ZipFSHandler_FindNext(*args, **kwargs) |
e811c8ce | 2238 | |
2131d850 | 2239 | _core_.ZipFSHandler_swigregister(ZipFSHandler) |
d14a1e28 RD |
2240 | |
2241 | ||
e811c8ce | 2242 | def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs): |
0085ce49 RD |
2243 | """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)""" |
2244 | return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs) | |
d14a1e28 | 2245 | |
e811c8ce | 2246 | def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs): |
0085ce49 RD |
2247 | """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)""" |
2248 | return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs) | |
d14a1e28 | 2249 | |
e811c8ce | 2250 | def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs): |
0085ce49 RD |
2251 | """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)""" |
2252 | return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs) | |
2ef75293 RD |
2253 | def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1): |
2254 | """ | |
2255 | Add 'file' to the memory filesystem. The dataItem parameter can | |
2256 | either be a `wx.Bitmap`, `wx.Image` or a string that can contain | |
2257 | arbitrary data. If a bitmap or image is used then the imgType | |
2258 | parameter should specify what kind of image file it should be | |
2259 | written as, wx.BITMAP_TYPE_PNG, etc. | |
2260 | """ | |
2261 | if isinstance(dataItem, wx.Image): | |
2262 | __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType) | |
2263 | elif isinstance(dataItem, wx.Bitmap): | |
2264 | __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType) | |
2265 | elif type(dataItem) == str: | |
2266 | __wxMemoryFSHandler_AddFile_Data(filename, dataItem) | |
2267 | else: | |
2268 | raise TypeError, 'wx.Image, wx.Bitmap or string expected' | |
d14a1e28 RD |
2269 | |
2270 | class MemoryFSHandler(CPPFileSystemHandler): | |
093d3ff1 | 2271 | """Proxy of C++ MemoryFSHandler class""" |
0085ce49 RD |
2272 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2273 | __repr__ = _swig_repr | |
2274 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2275 | """__init__(self) -> MemoryFSHandler""" |
0085ce49 | 2276 | _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs)) |
e811c8ce | 2277 | def RemoveFile(*args, **kwargs): |
66c033b4 | 2278 | """RemoveFile(String filename)""" |
54f9ee45 | 2279 | return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs) |
e811c8ce RD |
2280 | |
2281 | RemoveFile = staticmethod(RemoveFile) | |
d14a1e28 | 2282 | AddFile = staticmethod(MemoryFSHandler_AddFile) |
e811c8ce | 2283 | def CanOpen(*args, **kwargs): |
a95a7133 | 2284 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 2285 | return _core_.MemoryFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
2286 | |
2287 | def OpenFile(*args, **kwargs): | |
a95a7133 | 2288 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 2289 | return _core_.MemoryFSHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
2290 | |
2291 | def FindFirst(*args, **kwargs): | |
a95a7133 | 2292 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 2293 | return _core_.MemoryFSHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
2294 | |
2295 | def FindNext(*args, **kwargs): | |
a95a7133 | 2296 | """FindNext(self) -> String""" |
54f9ee45 | 2297 | return _core_.MemoryFSHandler_FindNext(*args, **kwargs) |
e811c8ce | 2298 | |
2131d850 | 2299 | _core_.MemoryFSHandler_swigregister(MemoryFSHandler) |
d14a1e28 | 2300 | |
e811c8ce | 2301 | def MemoryFSHandler_RemoveFile(*args, **kwargs): |
0085ce49 RD |
2302 | """MemoryFSHandler_RemoveFile(String filename)""" |
2303 | return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs) | |
d14a1e28 | 2304 | |
bcd0d7b6 RD |
2305 | IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT |
2306 | IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD | |
2307 | IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE | |
f5263701 RD |
2308 | IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL |
2309 | IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH | |
d14a1e28 RD |
2310 | #--------------------------------------------------------------------------- |
2311 | ||
2312 | class ImageHandler(Object): | |
27fb7603 RD |
2313 | """ |
2314 | This is the base class for implementing image file loading/saving, and | |
2315 | image creation from data. It is used within `wx.Image` and is not | |
2316 | normally seen by the application. | |
2317 | """ | |
0085ce49 RD |
2318 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2319 | def __init__(self): raise AttributeError, "No constructor defined" | |
2320 | __repr__ = _swig_repr | |
e811c8ce | 2321 | def GetName(*args, **kwargs): |
a95a7133 | 2322 | """GetName(self) -> String""" |
54f9ee45 | 2323 | return _core_.ImageHandler_GetName(*args, **kwargs) |
e811c8ce RD |
2324 | |
2325 | def GetExtension(*args, **kwargs): | |
a95a7133 | 2326 | """GetExtension(self) -> String""" |
54f9ee45 | 2327 | return _core_.ImageHandler_GetExtension(*args, **kwargs) |
e811c8ce RD |
2328 | |
2329 | def GetType(*args, **kwargs): | |
a95a7133 | 2330 | """GetType(self) -> long""" |
54f9ee45 | 2331 | return _core_.ImageHandler_GetType(*args, **kwargs) |
e811c8ce RD |
2332 | |
2333 | def GetMimeType(*args, **kwargs): | |
a95a7133 | 2334 | """GetMimeType(self) -> String""" |
54f9ee45 | 2335 | return _core_.ImageHandler_GetMimeType(*args, **kwargs) |
e811c8ce RD |
2336 | |
2337 | def CanRead(*args, **kwargs): | |
a95a7133 | 2338 | """CanRead(self, String name) -> bool""" |
54f9ee45 | 2339 | return _core_.ImageHandler_CanRead(*args, **kwargs) |
e811c8ce | 2340 | |
b02396e8 RD |
2341 | def CanReadStream(*args, **kwargs): |
2342 | """CanReadStream(self, InputStream stream) -> bool""" | |
2343 | return _core_.ImageHandler_CanReadStream(*args, **kwargs) | |
2344 | ||
e811c8ce | 2345 | def SetName(*args, **kwargs): |
a95a7133 | 2346 | """SetName(self, String name)""" |
54f9ee45 | 2347 | return _core_.ImageHandler_SetName(*args, **kwargs) |
e811c8ce RD |
2348 | |
2349 | def SetExtension(*args, **kwargs): | |
a95a7133 | 2350 | """SetExtension(self, String extension)""" |
54f9ee45 | 2351 | return _core_.ImageHandler_SetExtension(*args, **kwargs) |
e811c8ce RD |
2352 | |
2353 | def SetType(*args, **kwargs): | |
a95a7133 | 2354 | """SetType(self, long type)""" |
54f9ee45 | 2355 | return _core_.ImageHandler_SetType(*args, **kwargs) |
e811c8ce RD |
2356 | |
2357 | def SetMimeType(*args, **kwargs): | |
a95a7133 | 2358 | """SetMimeType(self, String mimetype)""" |
54f9ee45 | 2359 | return _core_.ImageHandler_SetMimeType(*args, **kwargs) |
e811c8ce | 2360 | |
97ab0f6a RD |
2361 | Extension = property(GetExtension,SetExtension,doc="See `GetExtension` and `SetExtension`") |
2362 | MimeType = property(GetMimeType,SetMimeType,doc="See `GetMimeType` and `SetMimeType`") | |
2363 | Name = property(GetName,SetName,doc="See `GetName` and `SetName`") | |
2364 | Type = property(GetType,SetType,doc="See `GetType` and `SetType`") | |
2131d850 | 2365 | _core_.ImageHandler_swigregister(ImageHandler) |
d14a1e28 | 2366 | |
943e8dfd RD |
2367 | class PyImageHandler(ImageHandler): |
2368 | """ | |
2369 | This is the base class for implementing image file loading/saving, and | |
2370 | image creation from data, all written in Python. To create a custom | |
2371 | image handler derive a new class from wx.PyImageHandler and provide | |
2372 | the following methods:: | |
2373 | ||
2374 | def DoCanRead(self, stream) --> bool | |
2375 | '''Check if this handler can read the image on the stream''' | |
2376 | ||
2377 | def LoadFile(self, image, stream, verbose, index) --> bool | |
2378 | '''Load image data from the stream and load it into image.''' | |
2379 | ||
2380 | def SaveFile(self, image, stream, verbose) --> bool | |
2381 | '''Save the iamge data in image to the stream using | |
2382 | this handler's image file format.''' | |
2383 | ||
2384 | def GetImageCount(self, stream) --> int | |
2385 | '''If this image format can hold more than one image, | |
2386 | how many does the image on the stream have?''' | |
2387 | ||
2388 | To activate your handler create an instance of it and pass it to | |
2389 | `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and | |
2390 | `SetExtension` from your constructor. | |
2391 | ||
2392 | """ | |
0085ce49 RD |
2393 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2394 | __repr__ = _swig_repr | |
2395 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2396 | """ |
2397 | __init__(self) -> PyImageHandler | |
2398 | ||
2399 | This is the base class for implementing image file loading/saving, and | |
2400 | image creation from data, all written in Python. To create a custom | |
2401 | image handler derive a new class from wx.PyImageHandler and provide | |
2402 | the following methods:: | |
2403 | ||
2404 | def DoCanRead(self, stream) --> bool | |
2405 | '''Check if this handler can read the image on the stream''' | |
2406 | ||
2407 | def LoadFile(self, image, stream, verbose, index) --> bool | |
2408 | '''Load image data from the stream and load it into image.''' | |
2409 | ||
2410 | def SaveFile(self, image, stream, verbose) --> bool | |
2411 | '''Save the iamge data in image to the stream using | |
2412 | this handler's image file format.''' | |
2413 | ||
2414 | def GetImageCount(self, stream) --> int | |
2415 | '''If this image format can hold more than one image, | |
2416 | how many does the image on the stream have?''' | |
2417 | ||
2418 | To activate your handler create an instance of it and pass it to | |
2419 | `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and | |
2420 | `SetExtension` from your constructor. | |
2421 | ||
2422 | """ | |
0085ce49 | 2423 | _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs)) |
943e8dfd RD |
2424 | self._SetSelf(self) |
2425 | ||
2426 | def _SetSelf(*args, **kwargs): | |
2427 | """_SetSelf(self, PyObject self)""" | |
2428 | return _core_.PyImageHandler__SetSelf(*args, **kwargs) | |
2429 | ||
2131d850 | 2430 | _core_.PyImageHandler_swigregister(PyImageHandler) |
943e8dfd | 2431 | |
d14a1e28 | 2432 | class ImageHistogram(object): |
093d3ff1 | 2433 | """Proxy of C++ ImageHistogram class""" |
0085ce49 RD |
2434 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2435 | __repr__ = _swig_repr | |
2436 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2437 | """__init__(self) -> ImageHistogram""" |
0085ce49 | 2438 | _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs)) |
e811c8ce | 2439 | def MakeKey(*args, **kwargs): |
0df68c9f | 2440 | """ |
7a27cf7c | 2441 | MakeKey(byte r, byte g, byte b) -> unsigned long |
e811c8ce | 2442 | |
0df68c9f RD |
2443 | Get the key in the histogram for the given RGB values |
2444 | """ | |
54f9ee45 | 2445 | return _core_.ImageHistogram_MakeKey(*args, **kwargs) |
e811c8ce RD |
2446 | |
2447 | MakeKey = staticmethod(MakeKey) | |
2448 | def FindFirstUnusedColour(*args, **kwargs): | |
fd2dc343 RD |
2449 | """ |
2450 | FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) | |
2451 | ||
2452 | Find first colour that is not used in the image and has higher RGB | |
2453 | values than startR, startG, startB. Returns a tuple consisting of a | |
2454 | success flag and rgb values. | |
2455 | """ | |
54f9ee45 | 2456 | return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs) |
e811c8ce | 2457 | |
f1cbd8fa RD |
2458 | def GetCount(*args, **kwargs): |
2459 | """ | |
2460 | GetCount(self, unsigned long key) -> unsigned long | |
2461 | ||
2462 | Returns the pixel count for the given key. Use `MakeKey` to create a | |
2463 | key value from a RGB tripple. | |
2464 | """ | |
2465 | return _core_.ImageHistogram_GetCount(*args, **kwargs) | |
2466 | ||
2467 | def GetCountRGB(*args, **kwargs): | |
2468 | """ | |
7a27cf7c | 2469 | GetCountRGB(self, byte r, byte g, byte b) -> unsigned long |
f1cbd8fa RD |
2470 | |
2471 | Returns the pixel count for the given RGB values. | |
2472 | """ | |
2473 | return _core_.ImageHistogram_GetCountRGB(*args, **kwargs) | |
2474 | ||
2475 | def GetCountColour(*args, **kwargs): | |
2476 | """ | |
2477 | GetCountColour(self, Colour colour) -> unsigned long | |
2478 | ||
2479 | Returns the pixel count for the given `wx.Colour` value. | |
2480 | """ | |
2481 | return _core_.ImageHistogram_GetCountColour(*args, **kwargs) | |
2482 | ||
2131d850 | 2483 | _core_.ImageHistogram_swigregister(ImageHistogram) |
d14a1e28 | 2484 | |
e811c8ce | 2485 | def ImageHistogram_MakeKey(*args, **kwargs): |
0085ce49 | 2486 | """ |
7a27cf7c | 2487 | ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long |
e811c8ce | 2488 | |
0df68c9f RD |
2489 | Get the key in the histogram for the given RGB values |
2490 | """ | |
0085ce49 | 2491 | return _core_.ImageHistogram_MakeKey(*args, **kwargs) |
d14a1e28 | 2492 | |
943e8dfd RD |
2493 | class Image_RGBValue(object): |
2494 | """ | |
2495 | An object that contains values for red, green and blue which represent | |
2496 | the value of a color. It is used by `wx.Image.HSVtoRGB` and | |
2497 | `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB | |
2498 | color space. | |
2499 | """ | |
0085ce49 RD |
2500 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2501 | __repr__ = _swig_repr | |
2502 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2503 | """ |
2504 | __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue | |
2505 | ||
2506 | Constructor. | |
2507 | """ | |
0085ce49 | 2508 | _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs)) |
943e8dfd RD |
2509 | red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set) |
2510 | green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set) | |
2511 | blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set) | |
2131d850 | 2512 | _core_.Image_RGBValue_swigregister(Image_RGBValue) |
943e8dfd RD |
2513 | |
2514 | class Image_HSVValue(object): | |
2515 | """ | |
2516 | An object that contains values for hue, saturation and value which | |
2517 | represent the value of a color. It is used by `wx.Image.HSVtoRGB` and | |
2518 | `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB | |
2519 | color space. | |
2520 | """ | |
0085ce49 RD |
2521 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2522 | __repr__ = _swig_repr | |
2523 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2524 | """ |
2525 | __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue | |
2526 | ||
2527 | Constructor. | |
2528 | """ | |
0085ce49 | 2529 | _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs)) |
943e8dfd RD |
2530 | hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set) |
2531 | saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set) | |
2532 | value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set) | |
2131d850 | 2533 | _core_.Image_HSVValue_swigregister(Image_HSVValue) |
943e8dfd | 2534 | |
d14a1e28 | 2535 | class Image(Object): |
7a27cf7c RD |
2536 | """ |
2537 | A platform-independent image class. An image can be created from | |
2538 | data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a | |
2539 | variety of formats. Functions are available to set and get image | |
2540 | bits, so it can be used for basic image manipulation. | |
2541 | ||
2542 | A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a | |
2543 | platform-specific `wx.Bitmap` object must be created from it using the | |
2544 | `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a | |
2545 | device context, using `wx.DC.DrawBitmap`. | |
2546 | ||
2547 | One colour value of the image may be used as a mask colour which will | |
2548 | lead to the automatic creation of a `wx.Mask` object associated to the | |
2549 | bitmap object. | |
2550 | ||
2551 | wx.Image supports alpha channel data, that is in addition to a byte | |
2552 | for the red, green and blue colour components for each pixel it also | |
2553 | stores a byte representing the pixel opacity. An alpha value of 0 | |
2554 | corresponds to a transparent pixel (null opacity) while a value of 255 | |
2555 | means that the pixel is 100% opaque. | |
2556 | ||
2557 | Unlike RGB data, not all images have an alpha channel and before using | |
2558 | `GetAlpha` you should check if this image contains an alpha channel | |
2559 | with `HasAlpha`. Note that currently only images loaded from PNG files | |
2560 | with transparency information will have an alpha channel. | |
2561 | """ | |
0085ce49 RD |
2562 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2563 | __repr__ = _swig_repr | |
2564 | def __init__(self, *args, **kwargs): | |
7a27cf7c RD |
2565 | """ |
2566 | __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image | |
2567 | ||
2568 | Loads an image from a file. | |
2569 | """ | |
0085ce49 RD |
2570 | _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs)) |
2571 | __swig_destroy__ = _core_.delete_Image | |
2572 | __del__ = lambda self : None; | |
e811c8ce | 2573 | def Create(*args, **kwargs): |
7a27cf7c RD |
2574 | """ |
2575 | Create(self, int width, int height, bool clear=True) | |
2576 | ||
2577 | Creates a fresh image. If clear is ``True``, the new image will be | |
2578 | initialized to black. Otherwise, the image data will be uninitialized. | |
2579 | """ | |
54f9ee45 | 2580 | return _core_.Image_Create(*args, **kwargs) |
e811c8ce RD |
2581 | |
2582 | def Destroy(*args, **kwargs): | |
0df68c9f | 2583 | """ |
a95a7133 | 2584 | Destroy(self) |
e811c8ce | 2585 | |
7a27cf7c | 2586 | Destroys the image data. |
0df68c9f | 2587 | """ |
b39fe951 RD |
2588 | args[0].this.own(False) |
2589 | return _core_.Image_Destroy(*args, **kwargs) | |
e811c8ce RD |
2590 | |
2591 | def Scale(*args, **kwargs): | |
7a27cf7c | 2592 | """ |
f5263701 | 2593 | Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image |
7a27cf7c RD |
2594 | |
2595 | Returns a scaled version of the image. This is also useful for scaling | |
2596 | bitmaps in general as the only other way to scale bitmaps is to blit a | |
f5263701 RD |
2597 | `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter |
2598 | specifies what method to use for resampling the image. It can be | |
2599 | either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling | |
2600 | method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses | |
2601 | bicubic and box averaging resampling methods for upsampling and | |
2602 | downsampling respectively. | |
7a27cf7c | 2603 | """ |
54f9ee45 | 2604 | return _core_.Image_Scale(*args, **kwargs) |
e811c8ce | 2605 | |
f5263701 RD |
2606 | def ResampleBox(*args, **kwargs): |
2607 | """ResampleBox(self, int width, int height) -> Image""" | |
2608 | return _core_.Image_ResampleBox(*args, **kwargs) | |
2609 | ||
2610 | def ResampleBicubic(*args, **kwargs): | |
2611 | """ResampleBicubic(self, int width, int height) -> Image""" | |
2612 | return _core_.Image_ResampleBicubic(*args, **kwargs) | |
2613 | ||
2614 | def Blur(*args, **kwargs): | |
2615 | """ | |
2616 | Blur(self, int radius) -> Image | |
2617 | ||
2618 | Blurs the image in both horizontal and vertical directions by the | |
2619 | specified pixel ``radius``. This should not be used when using a | |
2620 | single mask colour for transparency. | |
2621 | """ | |
2622 | return _core_.Image_Blur(*args, **kwargs) | |
2623 | ||
2624 | def BlurHorizontal(*args, **kwargs): | |
2625 | """ | |
2626 | BlurHorizontal(self, int radius) -> Image | |
2627 | ||
2628 | Blurs the image in the horizontal direction only. This should not be | |
2629 | used when using a single mask colour for transparency. | |
2630 | ||
2631 | """ | |
2632 | return _core_.Image_BlurHorizontal(*args, **kwargs) | |
2633 | ||
2634 | def BlurVertical(*args, **kwargs): | |
2635 | """ | |
2636 | BlurVertical(self, int radius) -> Image | |
2637 | ||
2638 | Blurs the image in the vertical direction only. This should not be | |
2639 | used when using a single mask colour for transparency. | |
2640 | """ | |
2641 | return _core_.Image_BlurVertical(*args, **kwargs) | |
2642 | ||
e811c8ce | 2643 | def ShrinkBy(*args, **kwargs): |
7a27cf7c RD |
2644 | """ |
2645 | ShrinkBy(self, int xFactor, int yFactor) -> Image | |
2646 | ||
2647 | Return a version of the image scaled smaller by the given factors. | |
2648 | """ | |
54f9ee45 | 2649 | return _core_.Image_ShrinkBy(*args, **kwargs) |
e811c8ce RD |
2650 | |
2651 | def Rescale(*args, **kwargs): | |
7a27cf7c | 2652 | """ |
f5263701 | 2653 | Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image |
7a27cf7c RD |
2654 | |
2655 | Changes the size of the image in-place by scaling it: after a call to | |
2656 | this function, the image will have the given width and height. | |
2657 | ||
2658 | Returns the (modified) image itself. | |
2659 | """ | |
54f9ee45 | 2660 | return _core_.Image_Rescale(*args, **kwargs) |
e811c8ce | 2661 | |
aff4cc5c | 2662 | def Resize(*args, **kwargs): |
7a27cf7c RD |
2663 | """ |
2664 | Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image | |
2665 | ||
2666 | Changes the size of the image in-place without scaling it, by adding | |
2667 | either a border with the given colour or cropping as necessary. The | |
2668 | image is pasted into a new image with the given size and background | |
2669 | colour at the position pos relative to the upper left of the new | |
2670 | image. If red = green = blue = -1 then use either the current mask | |
2671 | colour if set or find, use, and set a suitable mask colour for any | |
2672 | newly exposed areas. | |
2673 | ||
2674 | Returns the (modified) image itself. | |
2675 | """ | |
aff4cc5c RD |
2676 | return _core_.Image_Resize(*args, **kwargs) |
2677 | ||
e811c8ce | 2678 | def SetRGB(*args, **kwargs): |
7a27cf7c RD |
2679 | """ |
2680 | SetRGB(self, int x, int y, byte r, byte g, byte b) | |
2681 | ||
2682 | Sets the pixel at the given coordinate. This routine performs | |
2683 | bounds-checks for the coordinate so it can be considered a safe way to | |
2684 | manipulate the data, but in some cases this might be too slow so that | |
2685 | the data will have to be set directly. In that case you will have to | |
2686 | get access to the image data using the `GetData` method. | |
2687 | """ | |
54f9ee45 | 2688 | return _core_.Image_SetRGB(*args, **kwargs) |
e811c8ce | 2689 | |
aff4cc5c | 2690 | def SetRGBRect(*args, **kwargs): |
7a27cf7c RD |
2691 | """ |
2692 | SetRGBRect(self, Rect rect, byte r, byte g, byte b) | |
2693 | ||
2694 | Sets the colour of the pixels within the given rectangle. This routine | |
2695 | performs bounds-checks for the rectangle so it can be considered a | |
2696 | safe way to manipulate the data. | |
2697 | """ | |
aff4cc5c RD |
2698 | return _core_.Image_SetRGBRect(*args, **kwargs) |
2699 | ||
e811c8ce | 2700 | def GetRed(*args, **kwargs): |
7a27cf7c RD |
2701 | """ |
2702 | GetRed(self, int x, int y) -> byte | |
2703 | ||
2704 | Returns the red intensity at the given coordinate. | |
2705 | """ | |
54f9ee45 | 2706 | return _core_.Image_GetRed(*args, **kwargs) |
e811c8ce RD |
2707 | |
2708 | def GetGreen(*args, **kwargs): | |
7a27cf7c RD |
2709 | """ |
2710 | GetGreen(self, int x, int y) -> byte | |
2711 | ||
2712 | Returns the green intensity at the given coordinate. | |
2713 | """ | |
54f9ee45 | 2714 | return _core_.Image_GetGreen(*args, **kwargs) |
e811c8ce RD |
2715 | |
2716 | def GetBlue(*args, **kwargs): | |
7a27cf7c RD |
2717 | """ |
2718 | GetBlue(self, int x, int y) -> byte | |
2719 | ||
2720 | Returns the blue intensity at the given coordinate. | |
2721 | """ | |
54f9ee45 | 2722 | return _core_.Image_GetBlue(*args, **kwargs) |
e811c8ce RD |
2723 | |
2724 | def SetAlpha(*args, **kwargs): | |
7a27cf7c RD |
2725 | """ |
2726 | SetAlpha(self, int x, int y, byte alpha) | |
2727 | ||
2728 | Sets the alpha value for the given pixel. This function should only be | |
2729 | called if the image has alpha channel data, use `HasAlpha` to check | |
2730 | for this. | |
2731 | """ | |
54f9ee45 | 2732 | return _core_.Image_SetAlpha(*args, **kwargs) |
e811c8ce RD |
2733 | |
2734 | def GetAlpha(*args, **kwargs): | |
7a27cf7c RD |
2735 | """ |
2736 | GetAlpha(self, int x, int y) -> byte | |
2737 | ||
2738 | Returns the alpha value for the given pixel. This function may only be | |
2739 | called for the images with alpha channel, use `HasAlpha` to check for | |
2740 | this. | |
2741 | ||
2742 | The returned value is the *opacity* of the image, i.e. the value of 0 | |
2743 | corresponds to the fully transparent pixels while the value of 255 to | |
2744 | the fully opaque pixels. | |
2745 | """ | |
54f9ee45 | 2746 | return _core_.Image_GetAlpha(*args, **kwargs) |
e811c8ce RD |
2747 | |
2748 | def HasAlpha(*args, **kwargs): | |
7a27cf7c RD |
2749 | """ |
2750 | HasAlpha(self) -> bool | |
2751 | ||
2752 | Returns true if this image has alpha channel, false otherwise. | |
2753 | """ | |
54f9ee45 | 2754 | return _core_.Image_HasAlpha(*args, **kwargs) |
e811c8ce | 2755 | |
68350608 RD |
2756 | def InitAlpha(*args, **kwargs): |
2757 | """ | |
2758 | InitAlpha(self) | |
2759 | ||
2760 | Initializes the image alpha channel data. It is an error to call it if | |
2761 | the image already has alpha data. If it doesn't, alpha data will be by | |
2762 | default initialized to all pixels being fully opaque. But if the image | |
2763 | has a a mask colour, all mask pixels will be completely transparent. | |
2764 | """ | |
2765 | return _core_.Image_InitAlpha(*args, **kwargs) | |
2766 | ||
bcd0d7b6 RD |
2767 | def IsTransparent(*args, **kwargs): |
2768 | """ | |
7a27cf7c | 2769 | IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool |
bcd0d7b6 | 2770 | |
7a27cf7c RD |
2771 | Returns ``True`` if this pixel is masked or has an alpha value less |
2772 | than the spcified threshold. | |
bcd0d7b6 RD |
2773 | """ |
2774 | return _core_.Image_IsTransparent(*args, **kwargs) | |
2775 | ||
e811c8ce | 2776 | def FindFirstUnusedColour(*args, **kwargs): |
fd2dc343 RD |
2777 | """ |
2778 | FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) | |
2779 | ||
2780 | Find first colour that is not used in the image and has higher RGB | |
2781 | values than startR, startG, startB. Returns a tuple consisting of a | |
2782 | success flag and rgb values. | |
2783 | """ | |
54f9ee45 | 2784 | return _core_.Image_FindFirstUnusedColour(*args, **kwargs) |
e811c8ce | 2785 | |
4cf4100f RD |
2786 | def ConvertAlphaToMask(*args, **kwargs): |
2787 | """ | |
bcd0d7b6 | 2788 | ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool |
4cf4100f | 2789 | |
7a27cf7c RD |
2790 | If the image has alpha channel, this method converts it to mask. All |
2791 | pixels with alpha value less than ``threshold`` are replaced with the | |
2792 | mask colour and the alpha channel is removed. The mask colour is | |
2793 | chosen automatically using `FindFirstUnusedColour`. | |
4cf4100f RD |
2794 | |
2795 | If the image image doesn't have alpha channel, ConvertAlphaToMask does | |
2796 | nothing. | |
2797 | """ | |
2798 | return _core_.Image_ConvertAlphaToMask(*args, **kwargs) | |
2799 | ||
8fb0e70a RD |
2800 | def ConvertColourToAlpha(*args, **kwargs): |
2801 | """ | |
7a27cf7c | 2802 | ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool |
8fb0e70a RD |
2803 | |
2804 | This method converts an image where the original alpha information is | |
2805 | only available as a shades of a colour (actually shades of grey) | |
2806 | typically when you draw anti-aliased text into a bitmap. The DC | |
2807 | drawing routines draw grey values on the black background although | |
2808 | they actually mean to draw white with differnt alpha values. This | |
2809 | method reverses it, assuming a black (!) background and white text. | |
2810 | The method will then fill up the whole image with the colour given. | |
2811 | """ | |
2812 | return _core_.Image_ConvertColourToAlpha(*args, **kwargs) | |
2813 | ||
e811c8ce | 2814 | def SetMaskFromImage(*args, **kwargs): |
7a27cf7c RD |
2815 | """ |
2816 | SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool | |
2817 | ||
2818 | Sets the image's mask so that the pixels that have RGB value of | |
2819 | ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done | |
2820 | by first finding an unused colour in the image, setting this colour as | |
2821 | the mask colour and then using this colour to draw all pixels in the | |
2822 | image who corresponding pixel in mask has given RGB value. | |
2823 | ||
2824 | Returns ``False`` if ``mask`` does not have same dimensions as the | |
2825 | image or if there is no unused colour left. Returns ``True`` if the | |
2826 | mask was successfully applied. | |
2827 | ||
2828 | Note that this method involves computing the histogram, which is | |
2829 | computationally intensive operation. | |
2830 | """ | |
54f9ee45 | 2831 | return _core_.Image_SetMaskFromImage(*args, **kwargs) |
e811c8ce RD |
2832 | |
2833 | def CanRead(*args, **kwargs): | |
7a27cf7c RD |
2834 | """ |
2835 | CanRead(String filename) -> bool | |
2836 | ||
2837 | Returns True if the image handlers can read this file. | |
2838 | """ | |
54f9ee45 | 2839 | return _core_.Image_CanRead(*args, **kwargs) |
e811c8ce RD |
2840 | |
2841 | CanRead = staticmethod(CanRead) | |
2842 | def GetImageCount(*args, **kwargs): | |
7a27cf7c RD |
2843 | """ |
2844 | GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int | |
2845 | ||
2846 | If the image file contains more than one image and the image handler | |
2847 | is capable of retrieving these individually, this function will return | |
2848 | the number of available images. | |
2849 | """ | |
54f9ee45 | 2850 | return _core_.Image_GetImageCount(*args, **kwargs) |
e811c8ce RD |
2851 | |
2852 | GetImageCount = staticmethod(GetImageCount) | |
2853 | def LoadFile(*args, **kwargs): | |
7a27cf7c RD |
2854 | """ |
2855 | LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool | |
2856 | ||
2857 | Loads an image from a file. If no handler type is provided, the | |
2858 | library will try to autodetect the format. | |
2859 | """ | |
54f9ee45 | 2860 | return _core_.Image_LoadFile(*args, **kwargs) |
e811c8ce RD |
2861 | |
2862 | def LoadMimeFile(*args, **kwargs): | |
7a27cf7c RD |
2863 | """ |
2864 | LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool | |
2865 | ||
2866 | Loads an image from a file, specifying the image type with a MIME type | |
2867 | string. | |
2868 | """ | |
54f9ee45 | 2869 | return _core_.Image_LoadMimeFile(*args, **kwargs) |
e811c8ce RD |
2870 | |
2871 | def SaveFile(*args, **kwargs): | |
7a27cf7c RD |
2872 | """ |
2873 | SaveFile(self, String name, int type) -> bool | |
2874 | ||
2875 | Saves an image in the named file. | |
2876 | """ | |
54f9ee45 | 2877 | return _core_.Image_SaveFile(*args, **kwargs) |
e811c8ce RD |
2878 | |
2879 | def SaveMimeFile(*args, **kwargs): | |
7a27cf7c RD |
2880 | """ |
2881 | SaveMimeFile(self, String name, String mimetype) -> bool | |
2882 | ||
2883 | Saves an image in the named file. | |
2884 | """ | |
54f9ee45 | 2885 | return _core_.Image_SaveMimeFile(*args, **kwargs) |
e811c8ce RD |
2886 | |
2887 | def CanReadStream(*args, **kwargs): | |
7a27cf7c RD |
2888 | """ |
2889 | CanReadStream(InputStream stream) -> bool | |
2890 | ||
2891 | Returns True if the image handlers can read an image file from the | |
2892 | data currently on the input stream, or a readable Python file-like | |
2893 | object. | |
2894 | """ | |
54f9ee45 | 2895 | return _core_.Image_CanReadStream(*args, **kwargs) |
e811c8ce RD |
2896 | |
2897 | CanReadStream = staticmethod(CanReadStream) | |
2898 | def LoadStream(*args, **kwargs): | |
7a27cf7c RD |
2899 | """ |
2900 | LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool | |
2901 | ||
2902 | Loads an image from an input stream or a readable Python file-like | |
2903 | object. If no handler type is provided, the library will try to | |
2904 | autodetect the format. | |
2905 | """ | |
54f9ee45 | 2906 | return _core_.Image_LoadStream(*args, **kwargs) |
e811c8ce RD |
2907 | |
2908 | def LoadMimeStream(*args, **kwargs): | |
7a27cf7c RD |
2909 | """ |
2910 | LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool | |
2911 | ||
2912 | Loads an image from an input stream or a readable Python file-like | |
2913 | object, using a MIME type string to specify the image file format. | |
2914 | """ | |
54f9ee45 | 2915 | return _core_.Image_LoadMimeStream(*args, **kwargs) |
e811c8ce | 2916 | |
b39fe951 | 2917 | def IsOk(*args, **kwargs): |
7a27cf7c | 2918 | """ |
b39fe951 | 2919 | IsOk(self) -> bool |
7a27cf7c RD |
2920 | |
2921 | Returns true if image data is present. | |
2922 | """ | |
b39fe951 | 2923 | return _core_.Image_IsOk(*args, **kwargs) |
e811c8ce | 2924 | |
b39fe951 | 2925 | Ok = IsOk |
e811c8ce | 2926 | def GetWidth(*args, **kwargs): |
7a27cf7c RD |
2927 | """ |
2928 | GetWidth(self) -> int | |
2929 | ||
2930 | Gets the width of the image in pixels. | |
2931 | """ | |
54f9ee45 | 2932 | return _core_.Image_GetWidth(*args, **kwargs) |
e811c8ce RD |
2933 | |
2934 | def GetHeight(*args, **kwargs): | |
7a27cf7c RD |
2935 | """ |
2936 | GetHeight(self) -> int | |
2937 | ||
2938 | Gets the height of the image in pixels. | |
2939 | """ | |
54f9ee45 | 2940 | return _core_.Image_GetHeight(*args, **kwargs) |
e811c8ce | 2941 | |
b2df227b | 2942 | def GetSize(*args, **kwargs): |
7a27cf7c RD |
2943 | """ |
2944 | GetSize(self) -> Size | |
2945 | ||
2946 | Returns the size of the image in pixels. | |
2947 | """ | |
54f9ee45 | 2948 | return _core_.Image_GetSize(*args, **kwargs) |
b2df227b | 2949 | |
e811c8ce | 2950 | def GetSubImage(*args, **kwargs): |
7a27cf7c RD |
2951 | """ |
2952 | GetSubImage(self, Rect rect) -> Image | |
2953 | ||
2954 | Returns a sub image of the current one as long as the rect belongs | |
2955 | entirely to the image. | |
2956 | """ | |
54f9ee45 | 2957 | return _core_.Image_GetSubImage(*args, **kwargs) |
e811c8ce | 2958 | |
aff4cc5c | 2959 | def Size(*args, **kwargs): |
7a27cf7c RD |
2960 | """ |
2961 | Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image | |
2962 | ||
2963 | Returns a resized version of this image without scaling it by adding | |
2964 | either a border with the given colour or cropping as necessary. The | |
2965 | image is pasted into a new image with the given size and background | |
2966 | colour at the position ``pos`` relative to the upper left of the new | |
2967 | image. If red = green = blue = -1 then use either the current mask | |
2968 | colour if set or find, use, and set a suitable mask colour for any | |
2969 | newly exposed areas. | |
2970 | """ | |
aff4cc5c RD |
2971 | return _core_.Image_Size(*args, **kwargs) |
2972 | ||
e811c8ce | 2973 | def Copy(*args, **kwargs): |
7a27cf7c RD |
2974 | """ |
2975 | Copy(self) -> Image | |
2976 | ||
2977 | Returns an identical copy of the image. | |
2978 | """ | |
54f9ee45 | 2979 | return _core_.Image_Copy(*args, **kwargs) |
e811c8ce RD |
2980 | |
2981 | def Paste(*args, **kwargs): | |
7a27cf7c RD |
2982 | """ |
2983 | Paste(self, Image image, int x, int y) | |
2984 | ||
2985 | Pastes ``image`` into this instance and takes care of the mask colour | |
2986 | and any out of bounds problems. | |
2987 | """ | |
54f9ee45 | 2988 | return _core_.Image_Paste(*args, **kwargs) |
e811c8ce RD |
2989 | |
2990 | def GetData(*args, **kwargs): | |
61d07ac7 RD |
2991 | """ |
2992 | GetData(self) -> PyObject | |
2993 | ||
2994 | Returns a string containing a copy of the RGB bytes of the image. | |
2995 | """ | |
54f9ee45 | 2996 | return _core_.Image_GetData(*args, **kwargs) |
e811c8ce RD |
2997 | |
2998 | def SetData(*args, **kwargs): | |
61d07ac7 RD |
2999 | """ |
3000 | SetData(self, buffer data) | |
3001 | ||
3002 | Resets the Image's RGB data from a buffer of RGB bytes. Accepts | |
3003 | either a string or a buffer object holding the data and the length of | |
3004 | the data must be width*height*3. | |
3005 | """ | |
54f9ee45 | 3006 | return _core_.Image_SetData(*args, **kwargs) |
e811c8ce RD |
3007 | |
3008 | def GetDataBuffer(*args, **kwargs): | |
61d07ac7 RD |
3009 | """ |
3010 | GetDataBuffer(self) -> PyObject | |
3011 | ||
3012 | Returns a writable Python buffer object that is pointing at the RGB | |
7a27cf7c RD |
3013 | image data buffer inside the wx.Image. You need to ensure that you do |
3014 | not use this buffer object after the image has been destroyed. | |
61d07ac7 | 3015 | """ |
54f9ee45 | 3016 | return _core_.Image_GetDataBuffer(*args, **kwargs) |
e811c8ce RD |
3017 | |
3018 | def SetDataBuffer(*args, **kwargs): | |
61d07ac7 RD |
3019 | """ |
3020 | SetDataBuffer(self, buffer data) | |
3021 | ||
3022 | Sets the internal image data pointer to point at a Python buffer | |
7a27cf7c RD |
3023 | object. This can save making an extra copy of the data but you must |
3024 | ensure that the buffer object lives longer than the wx.Image does. | |
61d07ac7 | 3025 | """ |
54f9ee45 | 3026 | return _core_.Image_SetDataBuffer(*args, **kwargs) |
e811c8ce RD |
3027 | |
3028 | def GetAlphaData(*args, **kwargs): | |
61d07ac7 RD |
3029 | """ |
3030 | GetAlphaData(self) -> PyObject | |
3031 | ||
3032 | Returns a string containing a copy of the alpha bytes of the image. | |
3033 | """ | |
54f9ee45 | 3034 | return _core_.Image_GetAlphaData(*args, **kwargs) |
e811c8ce RD |
3035 | |
3036 | def SetAlphaData(*args, **kwargs): | |
61d07ac7 RD |
3037 | """ |
3038 | SetAlphaData(self, buffer alpha) | |
3039 | ||
3040 | Resets the Image's alpha data from a buffer of bytes. Accepts either | |
3041 | a string or a buffer object holding the data and the length of the | |
3042 | data must be width*height. | |
3043 | """ | |
54f9ee45 | 3044 | return _core_.Image_SetAlphaData(*args, **kwargs) |
e811c8ce RD |
3045 | |
3046 | def GetAlphaBuffer(*args, **kwargs): | |
fc46b7f3 RD |
3047 | """ |
3048 | GetAlphaBuffer(self) -> PyObject | |
3049 | ||
3050 | Returns a writable Python buffer object that is pointing at the Alpha | |
3051 | data buffer inside the wx.Image. You need to ensure that you do not | |
3052 | use this buffer object after the image has been destroyed. | |
3053 | """ | |
54f9ee45 | 3054 | return _core_.Image_GetAlphaBuffer(*args, **kwargs) |
e811c8ce RD |
3055 | |
3056 | def SetAlphaBuffer(*args, **kwargs): | |
fc46b7f3 RD |
3057 | """ |
3058 | SetAlphaBuffer(self, buffer alpha) | |
3059 | ||
3060 | Sets the internal image alpha pointer to point at a Python buffer | |
3061 | object. This can save making an extra copy of the data but you must | |
3062 | ensure that the buffer object lives as long as the wx.Image does. | |
3063 | """ | |
54f9ee45 | 3064 | return _core_.Image_SetAlphaBuffer(*args, **kwargs) |
e811c8ce RD |
3065 | |
3066 | def SetMaskColour(*args, **kwargs): | |
7a27cf7c RD |
3067 | """ |
3068 | SetMaskColour(self, byte r, byte g, byte b) | |
3069 | ||
3070 | Sets the mask colour for this image (and tells the image to use the | |
3071 | mask). | |
3072 | """ | |
54f9ee45 | 3073 | return _core_.Image_SetMaskColour(*args, **kwargs) |
e811c8ce | 3074 | |
aff4cc5c RD |
3075 | def GetOrFindMaskColour(*args, **kwargs): |
3076 | """ | |
3077 | GetOrFindMaskColour() -> (r,g,b) | |
3078 | ||
3079 | Get the current mask colour or find a suitable colour. | |
3080 | """ | |
3081 | return _core_.Image_GetOrFindMaskColour(*args, **kwargs) | |
3082 | ||
e811c8ce | 3083 | def GetMaskRed(*args, **kwargs): |
7a27cf7c RD |
3084 | """ |
3085 | GetMaskRed(self) -> byte | |
3086 | ||
3087 | Gets the red component of the mask colour. | |
3088 | """ | |
54f9ee45 | 3089 | return _core_.Image_GetMaskRed(*args, **kwargs) |
e811c8ce RD |
3090 | |
3091 | def GetMaskGreen(*args, **kwargs): | |
7a27cf7c RD |
3092 | """ |
3093 | GetMaskGreen(self) -> byte | |
3094 | ||
3095 | Gets the green component of the mask colour. | |
3096 | """ | |
54f9ee45 | 3097 | return _core_.Image_GetMaskGreen(*args, **kwargs) |
e811c8ce RD |
3098 | |
3099 | def GetMaskBlue(*args, **kwargs): | |
7a27cf7c RD |
3100 | """ |
3101 | GetMaskBlue(self) -> byte | |
3102 | ||
3103 | Gets the blue component of the mask colour. | |
3104 | """ | |
54f9ee45 | 3105 | return _core_.Image_GetMaskBlue(*args, **kwargs) |
e811c8ce RD |
3106 | |
3107 | def SetMask(*args, **kwargs): | |
7a27cf7c RD |
3108 | """ |
3109 | SetMask(self, bool mask=True) | |
3110 | ||
3111 | Specifies whether there is a mask or not. The area of the mask is | |
3112 | determined by the current mask colour. | |
3113 | """ | |
54f9ee45 | 3114 | return _core_.Image_SetMask(*args, **kwargs) |
e811c8ce RD |
3115 | |
3116 | def HasMask(*args, **kwargs): | |
7a27cf7c RD |
3117 | """ |
3118 | HasMask(self) -> bool | |
3119 | ||
3120 | Returns ``True`` if there is a mask active, ``False`` otherwise. | |
3121 | """ | |
54f9ee45 | 3122 | return _core_.Image_HasMask(*args, **kwargs) |
e811c8ce RD |
3123 | |
3124 | def Rotate(*args, **kwargs): | |
0df68c9f | 3125 | """ |
a95a7133 | 3126 | Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True, |
0df68c9f | 3127 | Point offset_after_rotation=None) -> Image |
7a27cf7c RD |
3128 | |
3129 | Rotates the image about the given point, by ``angle`` radians. Passing | |
3130 | ``True`` to ``interpolating`` results in better image quality, but is | |
3131 | slower. If the image has a mask, then the mask colour is used for the | |
3132 | uncovered pixels in the rotated image background. Otherwise, black | |
3133 | will be used as the fill colour. | |
3134 | ||
3135 | Returns the rotated image, leaving this image intact. | |
0df68c9f | 3136 | """ |
54f9ee45 | 3137 | return _core_.Image_Rotate(*args, **kwargs) |
e811c8ce RD |
3138 | |
3139 | def Rotate90(*args, **kwargs): | |
7a27cf7c RD |
3140 | """ |
3141 | Rotate90(self, bool clockwise=True) -> Image | |
3142 | ||
3143 | Returns a copy of the image rotated 90 degrees in the direction | |
3144 | indicated by ``clockwise``. | |
3145 | """ | |
54f9ee45 | 3146 | return _core_.Image_Rotate90(*args, **kwargs) |
e811c8ce RD |
3147 | |
3148 | def Mirror(*args, **kwargs): | |
7a27cf7c RD |
3149 | """ |
3150 | Mirror(self, bool horizontally=True) -> Image | |
3151 | ||
3152 | Returns a mirrored copy of the image. The parameter ``horizontally`` | |
3153 | indicates the orientation. | |
3154 | """ | |
54f9ee45 | 3155 | return _core_.Image_Mirror(*args, **kwargs) |
e811c8ce RD |
3156 | |
3157 | def Replace(*args, **kwargs): | |
0df68c9f | 3158 | """ |
7a27cf7c RD |
3159 | Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2) |
3160 | ||
3161 | Replaces the colour specified by ``(r1,g1,b1)`` by the colour | |
3162 | ``(r2,g2,b2)``. | |
0df68c9f | 3163 | """ |
54f9ee45 | 3164 | return _core_.Image_Replace(*args, **kwargs) |
e811c8ce | 3165 | |
32fe5131 RD |
3166 | def ConvertToGreyscale(*args, **kwargs): |
3167 | """ | |
3168 | ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image | |
3169 | ||
3170 | Convert to greyscale image. Uses the luminance component (Y) of the | |
3171 | image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb), | |
3172 | defaults to ITU-T BT.601 | |
3173 | """ | |
3174 | return _core_.Image_ConvertToGreyscale(*args, **kwargs) | |
3175 | ||
e811c8ce | 3176 | def ConvertToMono(*args, **kwargs): |
7a27cf7c RD |
3177 | """ |
3178 | ConvertToMono(self, byte r, byte g, byte b) -> Image | |
3179 | ||
3180 | Returns monochromatic version of the image. The returned image has | |
3181 | white colour where the original has ``(r,g,b)`` colour and black | |
3182 | colour everywhere else. | |
3183 | """ | |
54f9ee45 | 3184 | return _core_.Image_ConvertToMono(*args, **kwargs) |
e811c8ce RD |
3185 | |
3186 | def SetOption(*args, **kwargs): | |
7a27cf7c RD |
3187 | """ |
3188 | SetOption(self, String name, String value) | |
3189 | ||
3190 | Sets an image handler defined option. For example, when saving as a | |
3191 | JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a | |
3192 | number between 0 and 100 (0 is terrible, 100 is very good). | |
3193 | """ | |
54f9ee45 | 3194 | return _core_.Image_SetOption(*args, **kwargs) |
e811c8ce RD |
3195 | |
3196 | def SetOptionInt(*args, **kwargs): | |
7a27cf7c RD |
3197 | """ |
3198 | SetOptionInt(self, String name, int value) | |
3199 | ||
3200 | Sets an image option as an integer. | |
3201 | """ | |
54f9ee45 | 3202 | return _core_.Image_SetOptionInt(*args, **kwargs) |
e811c8ce RD |
3203 | |
3204 | def GetOption(*args, **kwargs): | |
7a27cf7c RD |
3205 | """ |
3206 | GetOption(self, String name) -> String | |
3207 | ||
3208 | Gets the value of an image handler option. | |
3209 | """ | |
54f9ee45 | 3210 | return _core_.Image_GetOption(*args, **kwargs) |
e811c8ce RD |
3211 | |
3212 | def GetOptionInt(*args, **kwargs): | |
7a27cf7c RD |
3213 | """ |
3214 | GetOptionInt(self, String name) -> int | |
3215 | ||
3216 | Gets the value of an image handler option as an integer. If the given | |
3217 | option is not present, the function returns 0. | |
3218 | """ | |
54f9ee45 | 3219 | return _core_.Image_GetOptionInt(*args, **kwargs) |
e811c8ce RD |
3220 | |
3221 | def HasOption(*args, **kwargs): | |
7a27cf7c RD |
3222 | """ |
3223 | HasOption(self, String name) -> bool | |
3224 | ||
3225 | Returns true if the given option is present. | |
3226 | """ | |
54f9ee45 | 3227 | return _core_.Image_HasOption(*args, **kwargs) |
e811c8ce RD |
3228 | |
3229 | def CountColours(*args, **kwargs): | |
a95a7133 | 3230 | """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long""" |
54f9ee45 | 3231 | return _core_.Image_CountColours(*args, **kwargs) |
e811c8ce RD |
3232 | |
3233 | def ComputeHistogram(*args, **kwargs): | |
a95a7133 | 3234 | """ComputeHistogram(self, ImageHistogram h) -> unsigned long""" |
54f9ee45 | 3235 | return _core_.Image_ComputeHistogram(*args, **kwargs) |
e811c8ce RD |
3236 | |
3237 | def AddHandler(*args, **kwargs): | |
66c033b4 | 3238 | """AddHandler(ImageHandler handler)""" |
54f9ee45 | 3239 | return _core_.Image_AddHandler(*args, **kwargs) |
e811c8ce RD |
3240 | |
3241 | AddHandler = staticmethod(AddHandler) | |
3242 | def InsertHandler(*args, **kwargs): | |
66c033b4 | 3243 | """InsertHandler(ImageHandler handler)""" |
54f9ee45 | 3244 | return _core_.Image_InsertHandler(*args, **kwargs) |
e811c8ce RD |
3245 | |
3246 | InsertHandler = staticmethod(InsertHandler) | |
3247 | def RemoveHandler(*args, **kwargs): | |
66c033b4 | 3248 | """RemoveHandler(String name) -> bool""" |
54f9ee45 | 3249 | return _core_.Image_RemoveHandler(*args, **kwargs) |
e811c8ce RD |
3250 | |
3251 | RemoveHandler = staticmethod(RemoveHandler) | |
0085ce49 RD |
3252 | def GetHandlers(*args, **kwargs): |
3253 | """GetHandlers() -> PyObject""" | |
3254 | return _core_.Image_GetHandlers(*args, **kwargs) | |
3255 | ||
3256 | GetHandlers = staticmethod(GetHandlers) | |
e811c8ce | 3257 | def GetImageExtWildcard(*args, **kwargs): |
7a27cf7c RD |
3258 | """ |
3259 | GetImageExtWildcard() -> String | |
3260 | ||
3261 | Iterates all registered wxImageHandler objects, and returns a string | |
3262 | containing file extension masks suitable for passing to file open/save | |
3263 | dialog boxes. | |
3264 | """ | |
54f9ee45 | 3265 | return _core_.Image_GetImageExtWildcard(*args, **kwargs) |
e811c8ce RD |
3266 | |
3267 | GetImageExtWildcard = staticmethod(GetImageExtWildcard) | |
3268 | def ConvertToBitmap(*args, **kwargs): | |
1fbf26be | 3269 | """ConvertToBitmap(self, int depth=-1) -> Bitmap""" |
54f9ee45 | 3270 | return _core_.Image_ConvertToBitmap(*args, **kwargs) |
e811c8ce RD |
3271 | |
3272 | def ConvertToMonoBitmap(*args, **kwargs): | |
7a27cf7c | 3273 | """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap""" |
54f9ee45 | 3274 | return _core_.Image_ConvertToMonoBitmap(*args, **kwargs) |
e811c8ce | 3275 | |
943e8dfd RD |
3276 | def RotateHue(*args, **kwargs): |
3277 | """ | |
3278 | RotateHue(self, double angle) | |
3279 | ||
3280 | Rotates the hue of each pixel of the image. Hue is a double in the | |
3281 | range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees | |
3282 | """ | |
3283 | return _core_.Image_RotateHue(*args, **kwargs) | |
3284 | ||
3285 | def RGBtoHSV(*args, **kwargs): | |
3286 | """ | |
3287 | RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue | |
3288 | ||
3289 | Converts a color in RGB color space to HSV color space. | |
3290 | """ | |
3291 | return _core_.Image_RGBtoHSV(*args, **kwargs) | |
3292 | ||
3293 | RGBtoHSV = staticmethod(RGBtoHSV) | |
3294 | def HSVtoRGB(*args, **kwargs): | |
3295 | """ | |
3296 | HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue | |
3297 | ||
3298 | Converts a color in HSV color space to RGB color space. | |
3299 | """ | |
3300 | return _core_.Image_HSVtoRGB(*args, **kwargs) | |
3301 | ||
3302 | HSVtoRGB = staticmethod(HSVtoRGB) | |
b39fe951 | 3303 | def __nonzero__(self): return self.IsOk() |
97ab0f6a RD |
3304 | AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`") |
3305 | AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`") | |
3306 | Data = property(GetData,SetData,doc="See `GetData` and `SetData`") | |
3307 | DataBuffer = property(GetDataBuffer,SetDataBuffer,doc="See `GetDataBuffer` and `SetDataBuffer`") | |
3308 | Height = property(GetHeight,doc="See `GetHeight`") | |
3309 | MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`") | |
3310 | MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`") | |
3311 | MaskRed = property(GetMaskRed,doc="See `GetMaskRed`") | |
97ab0f6a | 3312 | Width = property(GetWidth,doc="See `GetWidth`") |
2131d850 | 3313 | _core_.Image_swigregister(Image) |
d14a1e28 RD |
3314 | |
3315 | def ImageFromMime(*args, **kwargs): | |
7a27cf7c RD |
3316 | """ |
3317 | ImageFromMime(String name, String mimetype, int index=-1) -> Image | |
3318 | ||
3319 | Loads an image from a file, using a MIME type string (such as | |
3320 | 'image/jpeg') to specify image type. | |
3321 | """ | |
54f9ee45 | 3322 | val = _core_.new_ImageFromMime(*args, **kwargs) |
d14a1e28 RD |
3323 | return val |
3324 | ||
3325 | def ImageFromStream(*args, **kwargs): | |
7a27cf7c RD |
3326 | """ |
3327 | ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image | |
3328 | ||
3329 | Loads an image from an input stream, or any readable Python file-like | |
3330 | object. | |
3331 | """ | |
54f9ee45 | 3332 | val = _core_.new_ImageFromStream(*args, **kwargs) |
d14a1e28 RD |
3333 | return val |
3334 | ||
3335 | def ImageFromStreamMime(*args, **kwargs): | |
7a27cf7c RD |
3336 | """ |
3337 | ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image | |
3338 | ||
3339 | Loads an image from an input stream, or any readable Python file-like | |
3340 | object, specifying the image format with a MIME type string. | |
3341 | """ | |
54f9ee45 | 3342 | val = _core_.new_ImageFromStreamMime(*args, **kwargs) |
d14a1e28 RD |
3343 | return val |
3344 | ||
66c033b4 | 3345 | def EmptyImage(*args, **kwargs): |
61d07ac7 RD |
3346 | """ |
3347 | EmptyImage(int width=0, int height=0, bool clear=True) -> Image | |
3348 | ||
3349 | Construct an empty image of a given size, optionally setting all | |
3350 | pixels to black. | |
3351 | """ | |
66c033b4 | 3352 | val = _core_.new_EmptyImage(*args, **kwargs) |
d14a1e28 RD |
3353 | return val |
3354 | ||
3355 | def ImageFromBitmap(*args, **kwargs): | |
61d07ac7 RD |
3356 | """ |
3357 | ImageFromBitmap(Bitmap bitmap) -> Image | |
3358 | ||
3359 | Construct an Image from a `wx.Bitmap`. | |
3360 | """ | |
54f9ee45 | 3361 | val = _core_.new_ImageFromBitmap(*args, **kwargs) |
d14a1e28 RD |
3362 | return val |
3363 | ||
3364 | def ImageFromData(*args, **kwargs): | |
61d07ac7 RD |
3365 | """ |
3366 | ImageFromData(int width, int height, buffer data) -> Image | |
3367 | ||
3368 | Construct an Image from a buffer of RGB bytes. Accepts either a | |
3369 | string or a buffer object holding the data and the length of the data | |
3370 | must be width*height*3. | |
3371 | """ | |
54f9ee45 | 3372 | val = _core_.new_ImageFromData(*args, **kwargs) |
d14a1e28 RD |
3373 | return val |
3374 | ||
1823fbb4 | 3375 | def ImageFromDataWithAlpha(*args, **kwargs): |
61d07ac7 RD |
3376 | """ |
3377 | ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image | |
3378 | ||
3379 | Construct an Image from a buffer of RGB bytes with an Alpha channel. | |
3380 | Accepts either a string or a buffer object holding the data and the | |
7a27cf7c RD |
3381 | length of the data must be width*height*3 bytes, and the length of the |
3382 | alpha data must be width*height bytes. | |
61d07ac7 | 3383 | """ |
1823fbb4 | 3384 | val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs) |
1823fbb4 RD |
3385 | return val |
3386 | ||
e811c8ce | 3387 | def Image_CanRead(*args, **kwargs): |
0085ce49 | 3388 | """ |
7a27cf7c RD |
3389 | Image_CanRead(String filename) -> bool |
3390 | ||
3391 | Returns True if the image handlers can read this file. | |
3392 | """ | |
0085ce49 | 3393 | return _core_.Image_CanRead(*args, **kwargs) |
d14a1e28 | 3394 | |
e811c8ce | 3395 | def Image_GetImageCount(*args, **kwargs): |
0085ce49 | 3396 | """ |
7a27cf7c RD |
3397 | Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int |
3398 | ||
3399 | If the image file contains more than one image and the image handler | |
3400 | is capable of retrieving these individually, this function will return | |
3401 | the number of available images. | |
3402 | """ | |
0085ce49 | 3403 | return _core_.Image_GetImageCount(*args, **kwargs) |
d14a1e28 | 3404 | |
e811c8ce | 3405 | def Image_CanReadStream(*args, **kwargs): |
0085ce49 | 3406 | """ |
7a27cf7c RD |
3407 | Image_CanReadStream(InputStream stream) -> bool |
3408 | ||
3409 | Returns True if the image handlers can read an image file from the | |
3410 | data currently on the input stream, or a readable Python file-like | |
3411 | object. | |
3412 | """ | |
0085ce49 | 3413 | return _core_.Image_CanReadStream(*args, **kwargs) |
d14a1e28 | 3414 | |
e811c8ce | 3415 | def Image_AddHandler(*args, **kwargs): |
0085ce49 RD |
3416 | """Image_AddHandler(ImageHandler handler)""" |
3417 | return _core_.Image_AddHandler(*args, **kwargs) | |
d14a1e28 | 3418 | |
e811c8ce | 3419 | def Image_InsertHandler(*args, **kwargs): |
0085ce49 RD |
3420 | """Image_InsertHandler(ImageHandler handler)""" |
3421 | return _core_.Image_InsertHandler(*args, **kwargs) | |
d14a1e28 | 3422 | |
e811c8ce | 3423 | def Image_RemoveHandler(*args, **kwargs): |
0085ce49 RD |
3424 | """Image_RemoveHandler(String name) -> bool""" |
3425 | return _core_.Image_RemoveHandler(*args, **kwargs) | |
d14a1e28 | 3426 | |
0085ce49 RD |
3427 | def Image_GetHandlers(*args): |
3428 | """Image_GetHandlers() -> PyObject""" | |
3429 | return _core_.Image_GetHandlers(*args) | |
3430 | ||
3431 | def Image_GetImageExtWildcard(*args): | |
3432 | """ | |
7a27cf7c RD |
3433 | Image_GetImageExtWildcard() -> String |
3434 | ||
3435 | Iterates all registered wxImageHandler objects, and returns a string | |
3436 | containing file extension masks suitable for passing to file open/save | |
3437 | dialog boxes. | |
3438 | """ | |
0085ce49 | 3439 | return _core_.Image_GetImageExtWildcard(*args) |
d14a1e28 | 3440 | |
943e8dfd | 3441 | def Image_RGBtoHSV(*args, **kwargs): |
0085ce49 | 3442 | """ |
943e8dfd RD |
3443 | Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue |
3444 | ||
3445 | Converts a color in RGB color space to HSV color space. | |
3446 | """ | |
0085ce49 | 3447 | return _core_.Image_RGBtoHSV(*args, **kwargs) |
943e8dfd RD |
3448 | |
3449 | def Image_HSVtoRGB(*args, **kwargs): | |
0085ce49 | 3450 | """ |
943e8dfd RD |
3451 | Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue |
3452 | ||
3453 | Converts a color in HSV color space to RGB color space. | |
3454 | """ | |
0085ce49 | 3455 | return _core_.Image_HSVtoRGB(*args, **kwargs) |
943e8dfd | 3456 | |
fc46b7f3 RD |
3457 | |
3458 | def _ImageFromBuffer(*args, **kwargs): | |
3459 | """_ImageFromBuffer(int width, int height, buffer data, buffer alpha=None) -> Image""" | |
3460 | return _core_._ImageFromBuffer(*args, **kwargs) | |
3461 | def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None): | |
3462 | """ | |
3463 | Creates a `wx.Image` from the data in dataBuffer. The dataBuffer | |
eec1c382 RD |
3464 | parameter must be a Python object that implements the buffer interface, |
3465 | such as a string, array, etc. The dataBuffer object is expected to | |
3466 | contain a series of RGB bytes and be width*height*3 bytes long. A buffer | |
3467 | object can optionally be supplied for the image's alpha channel data, and | |
3468 | it is expected to be width*height bytes long. | |
fc46b7f3 RD |
3469 | |
3470 | The wx.Image will be created with its data and alpha pointers initialized | |
3471 | to the memory address pointed to by the buffer objects, thus saving the | |
3472 | time needed to copy the image data from the buffer object to the wx.Image. | |
3473 | While this has advantages, it also has the shoot-yourself-in-the-foot | |
3474 | risks associated with sharing a C pointer between two objects. | |
3475 | ||
3476 | To help alleviate the risk a reference to the data and alpha buffer | |
3477 | objects are kept with the wx.Image, so that they won't get deleted until | |
3478 | after the wx.Image is deleted. However please be aware that it is not | |
3479 | guaranteed that an object won't move its memory buffer to a new location | |
3480 | when it needs to resize its contents. If that happens then the wx.Image | |
3481 | will end up referring to an invalid memory location and could cause the | |
3482 | application to crash. Therefore care should be taken to not manipulate | |
3483 | the objects used for the data and alpha buffers in a way that would cause | |
3484 | them to change size. | |
3485 | """ | |
fc46b7f3 RD |
3486 | image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer) |
3487 | image._buffer = dataBuffer | |
3488 | image._alpha = alphaBuffer | |
3489 | return image | |
3490 | ||
5e4ca4a8 RD |
3491 | def InitAllImageHandlers(): |
3492 | """ | |
3493 | The former functionality of InitAllImageHanders is now done internal to | |
3494 | the _core_ extension module and so this function has become a simple NOP. | |
3495 | """ | |
3496 | pass | |
d14a1e28 | 3497 | |
54f9ee45 RD |
3498 | IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES |
3499 | IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM | |
b9d6a5f3 RD |
3500 | PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR |
3501 | PNG_TYPE_GREY = _core_.PNG_TYPE_GREY | |
3502 | PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED | |
54f9ee45 RD |
3503 | BMP_24BPP = _core_.BMP_24BPP |
3504 | BMP_8BPP = _core_.BMP_8BPP | |
3505 | BMP_8BPP_GREY = _core_.BMP_8BPP_GREY | |
3506 | BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY | |
3507 | BMP_8BPP_RED = _core_.BMP_8BPP_RED | |
3508 | BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE | |
3509 | BMP_4BPP = _core_.BMP_4BPP | |
3510 | BMP_1BPP = _core_.BMP_1BPP | |
3511 | BMP_1BPP_BW = _core_.BMP_1BPP_BW | |
d14a1e28 | 3512 | class BMPHandler(ImageHandler): |
27fb7603 | 3513 | """A `wx.ImageHandler` for \*.bmp bitmap files.""" |
0085ce49 RD |
3514 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3515 | __repr__ = _swig_repr | |
3516 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3517 | """ |
3518 | __init__(self) -> BMPHandler | |
3519 | ||
3520 | A `wx.ImageHandler` for \*.bmp bitmap files. | |
3521 | """ | |
0085ce49 | 3522 | _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs)) |
2131d850 | 3523 | _core_.BMPHandler_swigregister(BMPHandler) |
d14a1e28 | 3524 | NullImage = cvar.NullImage |
0c243d93 | 3525 | IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME |
d14a1e28 RD |
3526 | IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT |
3527 | IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X | |
3528 | IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y | |
3529 | IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION | |
0c243d93 RD |
3530 | IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX |
3531 | IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY | |
d14a1e28 | 3532 | IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT |
24d7cbea | 3533 | IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY |
0c243d93 RD |
3534 | IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE |
3535 | IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL | |
3536 | IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION | |
3537 | IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR | |
b9d6a5f3 RD |
3538 | IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT |
3539 | IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH | |
d14a1e28 RD |
3540 | |
3541 | class ICOHandler(BMPHandler): | |
27fb7603 | 3542 | """A `wx.ImageHandler` for \*.ico icon files.""" |
0085ce49 RD |
3543 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3544 | __repr__ = _swig_repr | |
3545 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3546 | """ |
3547 | __init__(self) -> ICOHandler | |
3548 | ||
3549 | A `wx.ImageHandler` for \*.ico icon files. | |
3550 | """ | |
0085ce49 | 3551 | _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs)) |
2131d850 | 3552 | _core_.ICOHandler_swigregister(ICOHandler) |
d14a1e28 RD |
3553 | |
3554 | class CURHandler(ICOHandler): | |
27fb7603 | 3555 | """A `wx.ImageHandler` for \*.cur cursor files.""" |
0085ce49 RD |
3556 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3557 | __repr__ = _swig_repr | |
3558 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3559 | """ |
3560 | __init__(self) -> CURHandler | |
3561 | ||
3562 | A `wx.ImageHandler` for \*.cur cursor files. | |
3563 | """ | |
0085ce49 | 3564 | _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs)) |
2131d850 | 3565 | _core_.CURHandler_swigregister(CURHandler) |
d14a1e28 RD |
3566 | |
3567 | class ANIHandler(CURHandler): | |
27fb7603 | 3568 | """A `wx.ImageHandler` for \*.ani animated cursor files.""" |
0085ce49 RD |
3569 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3570 | __repr__ = _swig_repr | |
3571 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3572 | """ |
3573 | __init__(self) -> ANIHandler | |
3574 | ||
3575 | A `wx.ImageHandler` for \*.ani animated cursor files. | |
3576 | """ | |
0085ce49 | 3577 | _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs)) |
2131d850 | 3578 | _core_.ANIHandler_swigregister(ANIHandler) |
d14a1e28 RD |
3579 | |
3580 | class PNGHandler(ImageHandler): | |
27fb7603 | 3581 | """A `wx.ImageHandler` for PNG image files.""" |
0085ce49 RD |
3582 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3583 | __repr__ = _swig_repr | |
3584 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3585 | """ |
3586 | __init__(self) -> PNGHandler | |
3587 | ||
3588 | A `wx.ImageHandler` for PNG image files. | |
3589 | """ | |
0085ce49 | 3590 | _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs)) |
2131d850 | 3591 | _core_.PNGHandler_swigregister(PNGHandler) |
d14a1e28 RD |
3592 | |
3593 | class GIFHandler(ImageHandler): | |
27fb7603 | 3594 | """A `wx.ImageHandler` for GIF image files.""" |
0085ce49 RD |
3595 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3596 | __repr__ = _swig_repr | |
3597 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3598 | """ |
3599 | __init__(self) -> GIFHandler | |
3600 | ||
3601 | A `wx.ImageHandler` for GIF image files. | |
3602 | """ | |
0085ce49 | 3603 | _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs)) |
2131d850 | 3604 | _core_.GIFHandler_swigregister(GIFHandler) |
d14a1e28 RD |
3605 | |
3606 | class PCXHandler(ImageHandler): | |
27fb7603 | 3607 | """A `wx.ImageHandler` for PCX imager files.""" |
0085ce49 RD |
3608 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3609 | __repr__ = _swig_repr | |
3610 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3611 | """ |
3612 | __init__(self) -> PCXHandler | |
3613 | ||
3614 | A `wx.ImageHandler` for PCX imager files. | |
3615 | """ | |
0085ce49 | 3616 | _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs)) |
2131d850 | 3617 | _core_.PCXHandler_swigregister(PCXHandler) |
d14a1e28 RD |
3618 | |
3619 | class JPEGHandler(ImageHandler): | |
27fb7603 | 3620 | """A `wx.ImageHandler` for JPEG/JPG image files.""" |
0085ce49 RD |
3621 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3622 | __repr__ = _swig_repr | |
3623 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3624 | """ |
3625 | __init__(self) -> JPEGHandler | |
3626 | ||
3627 | A `wx.ImageHandler` for JPEG/JPG image files. | |
3628 | """ | |
0085ce49 | 3629 | _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs)) |
2131d850 | 3630 | _core_.JPEGHandler_swigregister(JPEGHandler) |
d14a1e28 RD |
3631 | |
3632 | class PNMHandler(ImageHandler): | |
27fb7603 | 3633 | """A `wx.ImageHandler` for PNM image files.""" |
0085ce49 RD |
3634 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3635 | __repr__ = _swig_repr | |
3636 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3637 | """ |
3638 | __init__(self) -> PNMHandler | |
3639 | ||
3640 | A `wx.ImageHandler` for PNM image files. | |
3641 | """ | |
0085ce49 | 3642 | _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs)) |
2131d850 | 3643 | _core_.PNMHandler_swigregister(PNMHandler) |
d14a1e28 RD |
3644 | |
3645 | class XPMHandler(ImageHandler): | |
27fb7603 | 3646 | """A `wx.ImageHandler` for XPM image.""" |
0085ce49 RD |
3647 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3648 | __repr__ = _swig_repr | |
3649 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3650 | """ |
3651 | __init__(self) -> XPMHandler | |
3652 | ||
3653 | A `wx.ImageHandler` for XPM image. | |
3654 | """ | |
0085ce49 | 3655 | _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs)) |
2131d850 | 3656 | _core_.XPMHandler_swigregister(XPMHandler) |
d14a1e28 RD |
3657 | |
3658 | class TIFFHandler(ImageHandler): | |
27fb7603 | 3659 | """A `wx.ImageHandler` for TIFF image files.""" |
0085ce49 RD |
3660 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3661 | __repr__ = _swig_repr | |
3662 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3663 | """ |
3664 | __init__(self) -> TIFFHandler | |
3665 | ||
3666 | A `wx.ImageHandler` for TIFF image files. | |
3667 | """ | |
0085ce49 | 3668 | _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs)) |
2131d850 | 3669 | _core_.TIFFHandler_swigregister(TIFFHandler) |
d14a1e28 | 3670 | |
580080c5 RD |
3671 | class TGAHandler(ImageHandler): |
3672 | """A `wx.ImageHandler` for TGA image files.""" | |
3673 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
3674 | __repr__ = _swig_repr | |
3675 | def __init__(self, *args, **kwargs): | |
3676 | """ | |
3677 | __init__(self) -> TGAHandler | |
3678 | ||
3679 | A `wx.ImageHandler` for TGA image files. | |
3680 | """ | |
3681 | _core_.TGAHandler_swiginit(self,_core_.new_TGAHandler(*args, **kwargs)) | |
3682 | _core_.TGAHandler_swigregister(TGAHandler) | |
3683 | ||
c0de73ae RD |
3684 | QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS |
3685 | QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE | |
3686 | class Quantize(object): | |
3687 | """Performs quantization, or colour reduction, on a wxImage.""" | |
0085ce49 RD |
3688 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3689 | def __init__(self): raise AttributeError, "No constructor defined" | |
3690 | __repr__ = _swig_repr | |
c0de73ae RD |
3691 | def Quantize(*args, **kwargs): |
3692 | """ | |
3693 | Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool | |
3694 | ||
3695 | Reduce the colours in the source image and put the result into the | |
3696 | destination image, setting the palette in the destination if | |
3697 | needed. Both images may be the same, to overwrite the source image. | |
3698 | """ | |
3699 | return _core_.Quantize_Quantize(*args, **kwargs) | |
3700 | ||
3701 | Quantize = staticmethod(Quantize) | |
2131d850 | 3702 | _core_.Quantize_swigregister(Quantize) |
c0de73ae RD |
3703 | |
3704 | def Quantize_Quantize(*args, **kwargs): | |
0085ce49 | 3705 | """ |
c0de73ae RD |
3706 | Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool |
3707 | ||
3708 | Reduce the colours in the source image and put the result into the | |
3709 | destination image, setting the palette in the destination if | |
3710 | needed. Both images may be the same, to overwrite the source image. | |
3711 | """ | |
0085ce49 | 3712 | return _core_.Quantize_Quantize(*args, **kwargs) |
c0de73ae | 3713 | |
d14a1e28 RD |
3714 | #--------------------------------------------------------------------------- |
3715 | ||
3716 | class EvtHandler(Object): | |
093d3ff1 | 3717 | """Proxy of C++ EvtHandler class""" |
0085ce49 RD |
3718 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3719 | __repr__ = _swig_repr | |
3720 | def __init__(self, *args, **kwargs): | |
a95a7133 | 3721 | """__init__(self) -> EvtHandler""" |
0085ce49 | 3722 | _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs)) |
d49bdf34 RD |
3723 | self._setOORInfo(self) |
3724 | ||
e811c8ce | 3725 | def GetNextHandler(*args, **kwargs): |
a95a7133 | 3726 | """GetNextHandler(self) -> EvtHandler""" |
54f9ee45 | 3727 | return _core_.EvtHandler_GetNextHandler(*args, **kwargs) |
e811c8ce RD |
3728 | |
3729 | def GetPreviousHandler(*args, **kwargs): | |
a95a7133 | 3730 | """GetPreviousHandler(self) -> EvtHandler""" |
54f9ee45 | 3731 | return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs) |
e811c8ce RD |
3732 | |
3733 | def SetNextHandler(*args, **kwargs): | |
a95a7133 | 3734 | """SetNextHandler(self, EvtHandler handler)""" |
54f9ee45 | 3735 | return _core_.EvtHandler_SetNextHandler(*args, **kwargs) |
e811c8ce RD |
3736 | |
3737 | def SetPreviousHandler(*args, **kwargs): | |
a95a7133 | 3738 | """SetPreviousHandler(self, EvtHandler handler)""" |
54f9ee45 | 3739 | return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs) |
e811c8ce RD |
3740 | |
3741 | def GetEvtHandlerEnabled(*args, **kwargs): | |
a95a7133 | 3742 | """GetEvtHandlerEnabled(self) -> bool""" |
54f9ee45 | 3743 | return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs) |
e811c8ce RD |
3744 | |
3745 | def SetEvtHandlerEnabled(*args, **kwargs): | |
a95a7133 | 3746 | """SetEvtHandlerEnabled(self, bool enabled)""" |
54f9ee45 | 3747 | return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs) |
e811c8ce RD |
3748 | |
3749 | def ProcessEvent(*args, **kwargs): | |
a95a7133 | 3750 | """ProcessEvent(self, Event event) -> bool""" |
54f9ee45 | 3751 | return _core_.EvtHandler_ProcessEvent(*args, **kwargs) |
e811c8ce RD |
3752 | |
3753 | def AddPendingEvent(*args, **kwargs): | |
a95a7133 | 3754 | """AddPendingEvent(self, Event event)""" |
54f9ee45 | 3755 | return _core_.EvtHandler_AddPendingEvent(*args, **kwargs) |
e811c8ce RD |
3756 | |
3757 | def ProcessPendingEvents(*args, **kwargs): | |
a95a7133 | 3758 | """ProcessPendingEvents(self)""" |
54f9ee45 | 3759 | return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs) |
e811c8ce RD |
3760 | |
3761 | def Connect(*args, **kwargs): | |
a95a7133 | 3762 | """Connect(self, int id, int lastId, int eventType, PyObject func)""" |
54f9ee45 | 3763 | return _core_.EvtHandler_Connect(*args, **kwargs) |
e811c8ce RD |
3764 | |
3765 | def Disconnect(*args, **kwargs): | |
2131d850 | 3766 | """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool""" |
54f9ee45 | 3767 | return _core_.EvtHandler_Disconnect(*args, **kwargs) |
e811c8ce RD |
3768 | |
3769 | def _setOORInfo(*args, **kwargs): | |
689b42ee | 3770 | """_setOORInfo(self, PyObject _self, bool incref=True)""" |
7e08d4ef | 3771 | val = _core_.EvtHandler__setOORInfo(*args, **kwargs) |
15665b47 | 3772 | args[0].this.own(False) |
7e08d4ef | 3773 | return val |
e811c8ce | 3774 | |
d14a1e28 RD |
3775 | def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): |
3776 | """ | |
3777 | Bind an event to an event handler. | |
3778 | ||
db3e571a RD |
3779 | :param event: One of the EVT_* objects that specifies the |
3780 | type of event to bind, | |
d14a1e28 | 3781 | |
db3e571a RD |
3782 | :param handler: A callable object to be invoked when the |
3783 | event is delivered to self. Pass None to | |
3784 | disconnect an event handler. | |
d14a1e28 | 3785 | |
db3e571a RD |
3786 | :param source: Sometimes the event originates from a |
3787 | different window than self, but you still | |
3788 | want to catch it in self. (For example, a | |
3789 | button event delivered to a frame.) By | |
3790 | passing the source of the event, the event | |
3791 | handling system is able to differentiate | |
3792 | between the same event type from different | |
3793 | controls. | |
d14a1e28 | 3794 | |
db3e571a RD |
3795 | :param id: Used to spcify the event source by ID instead |
3796 | of instance. | |
3797 | ||
3798 | :param id2: Used when it is desirable to bind a handler | |
3799 | to a range of IDs, such as with EVT_MENU_RANGE. | |
d14a1e28 RD |
3800 | """ |
3801 | if source is not None: | |
3802 | id = source.GetId() | |
3803 | event.Bind(self, id, id2, handler) | |
3804 | ||
66c033b4 RD |
3805 | def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): |
3806 | """ | |
3807 | Disconencts the event handler binding for event from self. | |
3808 | Returns True if successful. | |
3809 | """ | |
3810 | if source is not None: | |
3811 | id = source.GetId() | |
3812 | return event.Unbind(self, id, id2) | |
d14a1e28 | 3813 | |
97ab0f6a RD |
3814 | EvtHandlerEnabled = property(GetEvtHandlerEnabled,SetEvtHandlerEnabled,doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`") |
3815 | NextHandler = property(GetNextHandler,SetNextHandler,doc="See `GetNextHandler` and `SetNextHandler`") | |
3816 | PreviousHandler = property(GetPreviousHandler,SetPreviousHandler,doc="See `GetPreviousHandler` and `SetPreviousHandler`") | |
2131d850 | 3817 | _core_.EvtHandler_swigregister(EvtHandler) |
d14a1e28 RD |
3818 | |
3819 | #--------------------------------------------------------------------------- | |
3820 | ||
3821 | class PyEventBinder(object): | |
3822 | """ | |
3823 | Instances of this class are used to bind specific events to event | |
3824 | handlers. | |
3825 | """ | |
3826 | def __init__(self, evtType, expectedIDs=0): | |
3827 | if expectedIDs not in [0, 1, 2]: | |
3828 | raise ValueError, "Invalid number of expectedIDs" | |
3829 | self.expectedIDs = expectedIDs | |
3830 | ||
3831 | if type(evtType) == list or type(evtType) == tuple: | |
3832 | self.evtType = evtType | |
3833 | else: | |
3834 | self.evtType = [evtType] | |
3835 | ||
3836 | ||
3837 | def Bind(self, target, id1, id2, function): | |
3838 | """Bind this set of event types to target.""" | |
3839 | for et in self.evtType: | |
3840 | target.Connect(id1, id2, et, function) | |
3841 | ||
66c033b4 RD |
3842 | |
3843 | def Unbind(self, target, id1, id2): | |
3844 | """Remove an event binding.""" | |
3845 | success = 0 | |
3846 | for et in self.evtType: | |
3847 | success += target.Disconnect(id1, id2, et) | |
3848 | return success != 0 | |
3849 | ||
b08d67c2 RD |
3850 | def _getEvtType(self): |
3851 | """ | |
3852 | Make it easy to get to the default wxEventType typeID for this | |
3853 | event binder. | |
3854 | """ | |
3855 | return self.evtType[0] | |
3856 | ||
3857 | typeId = property(_getEvtType) | |
3858 | ||
d14a1e28 RD |
3859 | |
3860 | def __call__(self, *args): | |
3861 | """ | |
3862 | For backwards compatibility with the old EVT_* functions. | |
3863 | Should be called with either (window, func), (window, ID, | |
3864 | func) or (window, ID1, ID2, func) parameters depending on the | |
3865 | type of the event. | |
3866 | """ | |
3867 | assert len(args) == 2 + self.expectedIDs | |
3868 | id1 = wx.ID_ANY | |
3869 | id2 = wx.ID_ANY | |
3870 | target = args[0] | |
3871 | if self.expectedIDs == 0: | |
3872 | func = args[1] | |
3873 | elif self.expectedIDs == 1: | |
3874 | id1 = args[1] | |
3875 | func = args[2] | |
3876 | elif self.expectedIDs == 2: | |
3877 | id1 = args[1] | |
3878 | id2 = args[2] | |
3879 | func = args[3] | |
3880 | else: | |
3881 | raise ValueError, "Unexpected number of IDs" | |
3882 | ||
3883 | self.Bind(target, id1, id2, func) | |
3884 | ||
3885 | ||
3886 | # These two are square pegs that don't fit the PyEventBinder hole... | |
3887 | def EVT_COMMAND(win, id, cmd, func): | |
3888 | win.Connect(id, -1, cmd, func) | |
3889 | def EVT_COMMAND_RANGE(win, id1, id2, cmd, func): | |
3890 | win.Connect(id1, id2, cmd, func) | |
3891 | ||
3892 | ||
3893 | #--------------------------------------------------------------------------- | |
3894 | ||
3895 | #--------------------------------------------------------------------------- | |
3896 | ||
54f9ee45 RD |
3897 | EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE |
3898 | EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX | |
d14a1e28 | 3899 | |
0085ce49 | 3900 | def NewEventType(*args): |
2131d850 | 3901 | """NewEventType() -> EventType""" |
0085ce49 | 3902 | return _core_.NewEventType(*args) |
54f9ee45 RD |
3903 | wxEVT_NULL = _core_.wxEVT_NULL |
3904 | wxEVT_FIRST = _core_.wxEVT_FIRST | |
3905 | wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST | |
3906 | wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED | |
3907 | wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED | |
3908 | wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED | |
3909 | wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED | |
3910 | wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED | |
3911 | wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED | |
3912 | wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED | |
3913 | wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED | |
3914 | wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED | |
3915 | wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED | |
3916 | wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED | |
3917 | wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED | |
3918 | wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED | |
3919 | wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED | |
3920 | wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED | |
3921 | wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER | |
3922 | wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN | |
3923 | wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP | |
3924 | wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN | |
3925 | wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP | |
3926 | wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN | |
3927 | wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP | |
3928 | wxEVT_MOTION = _core_.wxEVT_MOTION | |
3929 | wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW | |
3930 | wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW | |
3931 | wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK | |
3932 | wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK | |
3933 | wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK | |
3934 | wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS | |
3935 | wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS | |
3936 | wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS | |
3937 | wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL | |
3938 | wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN | |
3939 | wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP | |
3940 | wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN | |
3941 | wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP | |
3942 | wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN | |
3943 | wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP | |
3944 | wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION | |
3945 | wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW | |
3946 | wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW | |
3947 | wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK | |
3948 | wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK | |
3949 | wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK | |
3950 | wxEVT_CHAR = _core_.wxEVT_CHAR | |
3951 | wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK | |
3952 | wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY | |
3953 | wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN | |
3954 | wxEVT_KEY_UP = _core_.wxEVT_KEY_UP | |
3955 | wxEVT_HOTKEY = _core_.wxEVT_HOTKEY | |
3956 | wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR | |
3957 | wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP | |
3958 | wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM | |
3959 | wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP | |
3960 | wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN | |
3961 | wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP | |
3962 | wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN | |
3963 | wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK | |
3964 | wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE | |
4f433fef RD |
3965 | wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED |
3966 | wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED | |
54f9ee45 RD |
3967 | wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP |
3968 | wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM | |
3969 | wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP | |
3970 | wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN | |
3971 | wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP | |
3972 | wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN | |
3973 | wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK | |
3974 | wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE | |
3975 | wxEVT_SIZE = _core_.wxEVT_SIZE | |
3976 | wxEVT_MOVE = _core_.wxEVT_MOVE | |
3977 | wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW | |
3978 | wxEVT_END_SESSION = _core_.wxEVT_END_SESSION | |
3979 | wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION | |
3980 | wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP | |
54f9ee45 RD |
3981 | wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE |
3982 | wxEVT_CREATE = _core_.wxEVT_CREATE | |
3983 | wxEVT_DESTROY = _core_.wxEVT_DESTROY | |
3984 | wxEVT_SHOW = _core_.wxEVT_SHOW | |
3985 | wxEVT_ICONIZE = _core_.wxEVT_ICONIZE | |
3986 | wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE | |
3987 | wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED | |
34e0a3bb | 3988 | wxEVT_MOUSE_CAPTURE_LOST = _core_.wxEVT_MOUSE_CAPTURE_LOST |
54f9ee45 RD |
3989 | wxEVT_PAINT = _core_.wxEVT_PAINT |
3990 | wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND | |
3991 | wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT | |
3992 | wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON | |
3993 | wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN | |
3994 | wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE | |
3995 | wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT | |
3996 | wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU | |
3997 | wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED | |
3998 | wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED | |
3999 | wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED | |
4000 | wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE | |
4001 | wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED | |
4002 | wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES | |
4003 | wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM | |
4004 | wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM | |
4005 | wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM | |
4006 | wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG | |
4007 | wxEVT_IDLE = _core_.wxEVT_IDLE | |
4008 | wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI | |
4009 | wxEVT_SIZING = _core_.wxEVT_SIZING | |
4010 | wxEVT_MOVING = _core_.wxEVT_MOVING | |
88c6b281 | 4011 | wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE |
2131d850 RD |
4012 | wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY |
4013 | wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT | |
4014 | wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE | |
54f9ee45 RD |
4015 | wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK |
4016 | wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK | |
4017 | wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK | |
4018 | wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK | |
4019 | wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS | |
4020 | wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS | |
4021 | wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER | |
d14a1e28 RD |
4022 | # |
4023 | # Create some event binders | |
4024 | EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE ) | |
4025 | EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING ) | |
4026 | EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE ) | |
4027 | EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING ) | |
4028 | EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW ) | |
4029 | EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION ) | |
4030 | EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION ) | |
4031 | EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT ) | |
4032 | EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT ) | |
4033 | EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND ) | |
4034 | EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR ) | |
4035 | EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN ) | |
4036 | EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP ) | |
704eda0c | 4037 | EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1) |
d14a1e28 RD |
4038 | EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK ) |
4039 | EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN ) | |
4040 | EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE ) | |
4041 | EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1) | |
4042 | EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT ) | |
4043 | EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS ) | |
4044 | EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS ) | |
4045 | EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS ) | |
4046 | EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE ) | |
4047 | EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP ) | |
704eda0c | 4048 | EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE ) |
d14a1e28 RD |
4049 | EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION ) |
4050 | EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION ) | |
4051 | EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES ) | |
4052 | EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG ) | |
4053 | EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED ) | |
4054 | EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED ) | |
4055 | EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW ) | |
4056 | EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE ) | |
4057 | EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE ) | |
4058 | EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY ) | |
4059 | EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED ) | |
4060 | EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE ) | |
4061 | EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE ) | |
4062 | EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY ) | |
4063 | EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR ) | |
4064 | EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED ) | |
34e0a3bb | 4065 | EVT_MOUSE_CAPTURE_LOST = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_LOST ) |
d14a1e28 RD |
4066 | |
4067 | EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN ) | |
4068 | EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP ) | |
4069 | EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN ) | |
4070 | EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP ) | |
4071 | EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN ) | |
4072 | EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP ) | |
4073 | EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION ) | |
4074 | EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK ) | |
4075 | EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK ) | |
4076 | EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK ) | |
4077 | EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW ) | |
4078 | EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW ) | |
4079 | EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL ) | |
4080 | ||
4081 | EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN, | |
4082 | wxEVT_LEFT_UP, | |
4083 | wxEVT_MIDDLE_DOWN, | |
4084 | wxEVT_MIDDLE_UP, | |
4085 | wxEVT_RIGHT_DOWN, | |
4086 | wxEVT_RIGHT_UP, | |
4087 | wxEVT_MOTION, | |
4088 | wxEVT_LEFT_DCLICK, | |
4089 | wxEVT_MIDDLE_DCLICK, | |
4090 | wxEVT_RIGHT_DCLICK, | |
4091 | wxEVT_ENTER_WINDOW, | |
4092 | wxEVT_LEAVE_WINDOW, | |
4093 | wxEVT_MOUSEWHEEL | |
4094 | ]) | |
4095 | ||
4096 | ||
4097 | # Scrolling from wxWindow (sent to wxScrolledWindow) | |
704eda0c | 4098 | EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP, |
d14a1e28 RD |
4099 | wxEVT_SCROLLWIN_BOTTOM, |
4100 | wxEVT_SCROLLWIN_LINEUP, | |
4101 | wxEVT_SCROLLWIN_LINEDOWN, | |
704eda0c | 4102 | wxEVT_SCROLLWIN_PAGEUP, |
d14a1e28 RD |
4103 | wxEVT_SCROLLWIN_PAGEDOWN, |
4104 | wxEVT_SCROLLWIN_THUMBTRACK, | |
4105 | wxEVT_SCROLLWIN_THUMBRELEASE, | |
4106 | ]) | |
4107 | ||
4108 | EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP ) | |
4109 | EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM ) | |
4110 | EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP ) | |
4111 | EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN ) | |
4112 | EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP ) | |
4113 | EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN ) | |
4114 | EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK ) | |
4115 | EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE ) | |
4116 | ||
27fb7603 | 4117 | # Scrolling from wx.Slider and wx.ScrollBar |
704eda0c RD |
4118 | EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, |
4119 | wxEVT_SCROLL_BOTTOM, | |
4120 | wxEVT_SCROLL_LINEUP, | |
4121 | wxEVT_SCROLL_LINEDOWN, | |
4122 | wxEVT_SCROLL_PAGEUP, | |
4123 | wxEVT_SCROLL_PAGEDOWN, | |
4124 | wxEVT_SCROLL_THUMBTRACK, | |
4125 | wxEVT_SCROLL_THUMBRELEASE, | |
4f433fef | 4126 | wxEVT_SCROLL_CHANGED, |
d14a1e28 RD |
4127 | ]) |
4128 | ||
4129 | EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP ) | |
4130 | EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM ) | |
4131 | EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP ) | |
4132 | EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN ) | |
4133 | EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP ) | |
4134 | EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN ) | |
4135 | EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK ) | |
4136 | EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE ) | |
4f433fef RD |
4137 | EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED ) |
4138 | EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED | |
704eda0c | 4139 | |
27fb7603 | 4140 | # Scrolling from wx.Slider and wx.ScrollBar, with an id |
704eda0c RD |
4141 | EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, |
4142 | wxEVT_SCROLL_BOTTOM, | |
4143 | wxEVT_SCROLL_LINEUP, | |
4144 | wxEVT_SCROLL_LINEDOWN, | |
4145 | wxEVT_SCROLL_PAGEUP, | |
4146 | wxEVT_SCROLL_PAGEDOWN, | |
4147 | wxEVT_SCROLL_THUMBTRACK, | |
d14a1e28 | 4148 | wxEVT_SCROLL_THUMBRELEASE, |
4f433fef | 4149 | wxEVT_SCROLL_CHANGED, |
d14a1e28 RD |
4150 | ], 1) |
4151 | ||
4152 | EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1) | |
4153 | EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1) | |
4154 | EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1) | |
4155 | EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1) | |
4156 | EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1) | |
4157 | EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1) | |
4158 | EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1) | |
4159 | EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1) | |
4f433fef RD |
4160 | EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1) |
4161 | EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED | |
d14a1e28 | 4162 | |
d14a1e28 RD |
4163 | EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1) |
4164 | EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1) | |
4165 | EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1) | |
4166 | EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1) | |
4167 | EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1) | |
4168 | EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1) | |
4169 | EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2) | |
4170 | EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1) | |
4171 | EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1) | |
4172 | EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1) | |
4173 | ||
4174 | EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1) | |
4175 | EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1) | |
4176 | EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1) | |
4177 | EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1) | |
4178 | EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2) | |
4179 | EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1) | |
4180 | EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2) | |
4181 | EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1) | |
4182 | EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1) | |
4183 | ||
4184 | ||
4185 | EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1) | |
4186 | EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1) | |
4187 | EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1) | |
4188 | EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1) | |
4189 | EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1) | |
4190 | EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1) | |
4191 | EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1) | |
4192 | ||
4193 | EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE ) | |
4194 | ||
4195 | EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1) | |
4196 | EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2) | |
4197 | ||
4198 | EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) | |
4199 | ||
2131d850 RD |
4200 | EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT ) |
4201 | EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY ) | |
4202 | EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE ) | |
d14a1e28 RD |
4203 | |
4204 | ||
4205 | #--------------------------------------------------------------------------- | |
4206 | ||
4207 | class Event(Object): | |
27fb7603 RD |
4208 | """ |
4209 | An event is a structure holding information about an event passed to a | |
4210 | callback or member function. wx.Event is an abstract base class for | |
4211 | other event classes | |
4212 | """ | |
0085ce49 RD |
4213 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4214 | def __init__(self): raise AttributeError, "No constructor defined" | |
4215 | __repr__ = _swig_repr | |
4216 | __swig_destroy__ = _core_.delete_Event | |
4217 | __del__ = lambda self : None; | |
e811c8ce | 4218 | def SetEventType(*args, **kwargs): |
27fb7603 | 4219 | """ |
2131d850 | 4220 | SetEventType(self, EventType typ) |
27fb7603 RD |
4221 | |
4222 | Sets the specific type of the event. | |
4223 | """ | |
54f9ee45 | 4224 | return _core_.Event_SetEventType(*args, **kwargs) |
e811c8ce RD |
4225 | |
4226 | def GetEventType(*args, **kwargs): | |
27fb7603 | 4227 | """ |
2131d850 | 4228 | GetEventType(self) -> EventType |
27fb7603 RD |
4229 | |
4230 | Returns the identifier of the given event type, such as | |
4231 | ``wxEVT_COMMAND_BUTTON_CLICKED``. | |
4232 | """ | |
54f9ee45 | 4233 | return _core_.Event_GetEventType(*args, **kwargs) |
e811c8ce RD |
4234 | |
4235 | def GetEventObject(*args, **kwargs): | |
27fb7603 RD |
4236 | """ |
4237 | GetEventObject(self) -> Object | |
4238 | ||
4239 | Returns the object (usually a window) associated with the event, if | |
4240 | any. | |
4241 | """ | |
54f9ee45 | 4242 | return _core_.Event_GetEventObject(*args, **kwargs) |
e811c8ce RD |
4243 | |
4244 | def SetEventObject(*args, **kwargs): | |
27fb7603 RD |
4245 | """ |
4246 | SetEventObject(self, Object obj) | |
4247 | ||
4248 | Sets the originating object, or in other words, obj is normally the | |
4249 | object that is sending the event. | |
4250 | """ | |
54f9ee45 | 4251 | return _core_.Event_SetEventObject(*args, **kwargs) |
e811c8ce RD |
4252 | |
4253 | def GetTimestamp(*args, **kwargs): | |
a95a7133 | 4254 | """GetTimestamp(self) -> long""" |
54f9ee45 | 4255 | return _core_.Event_GetTimestamp(*args, **kwargs) |
e811c8ce RD |
4256 | |
4257 | def SetTimestamp(*args, **kwargs): | |
a95a7133 | 4258 | """SetTimestamp(self, long ts=0)""" |
54f9ee45 | 4259 | return _core_.Event_SetTimestamp(*args, **kwargs) |
e811c8ce RD |
4260 | |
4261 | def GetId(*args, **kwargs): | |
27fb7603 RD |
4262 | """ |
4263 | GetId(self) -> int | |
4264 | ||
4265 | Returns the identifier associated with this event, such as a button | |
4266 | command id. | |
4267 | """ | |
54f9ee45 | 4268 | return _core_.Event_GetId(*args, **kwargs) |
e811c8ce RD |
4269 | |
4270 | def SetId(*args, **kwargs): | |
27fb7603 RD |
4271 | """ |
4272 | SetId(self, int Id) | |
4273 | ||
4274 | Set's the ID for the event. This is usually the ID of the window that | |
4275 | is sending the event, but it can also be a command id from a menu | |
4276 | item, etc. | |
4277 | """ | |
54f9ee45 | 4278 | return _core_.Event_SetId(*args, **kwargs) |
e811c8ce RD |
4279 | |
4280 | def IsCommandEvent(*args, **kwargs): | |
27fb7603 RD |
4281 | """ |
4282 | IsCommandEvent(self) -> bool | |
4283 | ||
4284 | Returns true if the event is or is derived from `wx.CommandEvent` else | |
4285 | it returns false. Note: Exists only for optimization purposes. | |
4286 | """ | |
54f9ee45 | 4287 | return _core_.Event_IsCommandEvent(*args, **kwargs) |
e811c8ce RD |
4288 | |
4289 | def Skip(*args, **kwargs): | |
51b83b37 RD |
4290 | """ |
4291 | Skip(self, bool skip=True) | |
4292 | ||
6b449b19 RD |
4293 | This method can be used inside an event handler to control whether |
4294 | further event handlers bound to this event will be called after the | |
4295 | current one returns. Without Skip() (or equivalently if Skip(False) is | |
4296 | used), the event will not be processed any more. If Skip(True) is | |
4297 | called, the event processing system continues searching for a further | |
4298 | handler function for this event, even though it has been processed | |
4299 | already in the current handler. | |
51b83b37 | 4300 | """ |
54f9ee45 | 4301 | return _core_.Event_Skip(*args, **kwargs) |
e811c8ce RD |
4302 | |
4303 | def GetSkipped(*args, **kwargs): | |
27fb7603 RD |
4304 | """ |
4305 | GetSkipped(self) -> bool | |
4306 | ||
4307 | Returns true if the event handler should be skipped, false otherwise. | |
4308 | :see: `Skip` | |
4309 | """ | |
54f9ee45 | 4310 | return _core_.Event_GetSkipped(*args, **kwargs) |
e811c8ce RD |
4311 | |
4312 | def ShouldPropagate(*args, **kwargs): | |
27fb7603 RD |
4313 | """ |
4314 | ShouldPropagate(self) -> bool | |
4315 | ||
4316 | Test if this event should be propagated to the parent window or not, | |
4317 | i.e. if the propagation level is currently greater than 0. | |
4318 | """ | |
54f9ee45 | 4319 | return _core_.Event_ShouldPropagate(*args, **kwargs) |
e811c8ce RD |
4320 | |
4321 | def StopPropagation(*args, **kwargs): | |
27fb7603 RD |
4322 | """ |
4323 | StopPropagation(self) -> int | |
4324 | ||
4325 | Stop the event from propagating to its parent window. Returns the old | |
4326 | propagation level value which may be later passed to | |
4327 | `ResumePropagation` to allow propagating the event again. | |
4328 | """ | |
54f9ee45 | 4329 | return _core_.Event_StopPropagation(*args, **kwargs) |
e811c8ce RD |
4330 | |
4331 | def ResumePropagation(*args, **kwargs): | |
27fb7603 RD |
4332 | """ |
4333 | ResumePropagation(self, int propagationLevel) | |
4334 | ||
4335 | Resume the event propagation by restoring the propagation level. (For | |
4336 | example, you can use the value returned by an earlier call to | |
4337 | `StopPropagation`.) | |
4338 | ||
4339 | """ | |
54f9ee45 | 4340 | return _core_.Event_ResumePropagation(*args, **kwargs) |
e811c8ce RD |
4341 | |
4342 | def Clone(*args, **kwargs): | |
a95a7133 | 4343 | """Clone(self) -> Event""" |
54f9ee45 | 4344 | return _core_.Event_Clone(*args, **kwargs) |
e811c8ce | 4345 | |
97ab0f6a RD |
4346 | EventObject = property(GetEventObject,SetEventObject,doc="See `GetEventObject` and `SetEventObject`") |
4347 | EventType = property(GetEventType,SetEventType,doc="See `GetEventType` and `SetEventType`") | |
4348 | Id = property(GetId,SetId,doc="See `GetId` and `SetId`") | |
4349 | Skipped = property(GetSkipped,doc="See `GetSkipped`") | |
4350 | Timestamp = property(GetTimestamp,SetTimestamp,doc="See `GetTimestamp` and `SetTimestamp`") | |
2131d850 | 4351 | _core_.Event_swigregister(Event) |
d14a1e28 RD |
4352 | |
4353 | #--------------------------------------------------------------------------- | |
4354 | ||
4355 | class PropagationDisabler(object): | |
27fb7603 RD |
4356 | """ |
4357 | Helper class to temporarily change an event not to propagate. Simply | |
4358 | create an instance of this class and then whe it is destroyed the | |
4359 | propogation of the event will be restored. | |
4360 | """ | |
0085ce49 RD |
4361 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4362 | __repr__ = _swig_repr | |
4363 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
4364 | """ |
4365 | __init__(self, Event event) -> PropagationDisabler | |
4366 | ||
4367 | Helper class to temporarily change an event not to propagate. Simply | |
4368 | create an instance of this class and then whe it is destroyed the | |
4369 | propogation of the event will be restored. | |
4370 | """ | |
0085ce49 RD |
4371 | _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs)) |
4372 | __swig_destroy__ = _core_.delete_PropagationDisabler | |
4373 | __del__ = lambda self : None; | |
2131d850 | 4374 | _core_.PropagationDisabler_swigregister(PropagationDisabler) |
d14a1e28 RD |
4375 | |
4376 | class PropagateOnce(object): | |
27fb7603 RD |
4377 | """ |
4378 | A helper class that will temporarily lower propagation level of an | |
4379 | event. Simply create an instance of this class and then whe it is | |
4380 | destroyed the propogation of the event will be restored. | |
4381 | """ | |
0085ce49 RD |
4382 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4383 | __repr__ = _swig_repr | |
4384 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
4385 | """ |
4386 | __init__(self, Event event) -> PropagateOnce | |
4387 | ||
4388 | A helper class that will temporarily lower propagation level of an | |
4389 | event. Simply create an instance of this class and then whe it is | |
4390 | destroyed the propogation of the event will be restored. | |
4391 | """ | |
0085ce49 RD |
4392 | _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs)) |
4393 | __swig_destroy__ = _core_.delete_PropagateOnce | |
4394 | __del__ = lambda self : None; | |
2131d850 | 4395 | _core_.PropagateOnce_swigregister(PropagateOnce) |
d14a1e28 RD |
4396 | |
4397 | #--------------------------------------------------------------------------- | |
4398 | ||
4399 | class CommandEvent(Event): | |
27fb7603 RD |
4400 | """ |
4401 | This event class contains information about command events, which | |
4402 | originate from a variety of simple controls, as well as menus and | |
4403 | toolbars. | |
4404 | """ | |
0085ce49 RD |
4405 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4406 | __repr__ = _swig_repr | |
4407 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4408 | """ |
2131d850 | 4409 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent |
27fb7603 RD |
4410 | |
4411 | This event class contains information about command events, which | |
4412 | originate from a variety of simple controls, as well as menus and | |
4413 | toolbars. | |
4414 | """ | |
0085ce49 | 4415 | _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs)) |
e811c8ce | 4416 | def GetSelection(*args, **kwargs): |
27fb7603 RD |
4417 | """ |
4418 | GetSelection(self) -> int | |
4419 | ||
4420 | Returns item index for a listbox or choice selection event (not valid | |
4421 | for a deselection). | |
4422 | """ | |
54f9ee45 | 4423 | return _core_.CommandEvent_GetSelection(*args, **kwargs) |
e811c8ce RD |
4424 | |
4425 | def SetString(*args, **kwargs): | |
a95a7133 | 4426 | """SetString(self, String s)""" |
54f9ee45 | 4427 | return _core_.CommandEvent_SetString(*args, **kwargs) |
e811c8ce RD |
4428 | |
4429 | def GetString(*args, **kwargs): | |
27fb7603 RD |
4430 | """ |
4431 | GetString(self) -> String | |
4432 | ||
4433 | Returns item string for a listbox or choice selection event (not valid | |
4434 | for a deselection). | |
4435 | """ | |
54f9ee45 | 4436 | return _core_.CommandEvent_GetString(*args, **kwargs) |
e811c8ce RD |
4437 | |
4438 | def IsChecked(*args, **kwargs): | |
27fb7603 RD |
4439 | """ |
4440 | IsChecked(self) -> bool | |
4441 | ||
4442 | This method can be used with checkbox and menu events: for the | |
4443 | checkboxes, the method returns true for a selection event and false | |
4444 | for a deselection one. For the menu events, this method indicates if | |
4445 | the menu item just has become checked or unchecked (and thus only | |
4446 | makes sense for checkable menu items). | |
4447 | """ | |
54f9ee45 | 4448 | return _core_.CommandEvent_IsChecked(*args, **kwargs) |
e811c8ce | 4449 | |
242b7b46 | 4450 | Checked = IsChecked |
e811c8ce | 4451 | def IsSelection(*args, **kwargs): |
27fb7603 RD |
4452 | """ |
4453 | IsSelection(self) -> bool | |
4454 | ||
4455 | For a listbox or similar event, returns true if it is a selection, | |
4456 | false if it is a deselection. | |
4457 | """ | |
54f9ee45 | 4458 | return _core_.CommandEvent_IsSelection(*args, **kwargs) |
e811c8ce RD |
4459 | |
4460 | def SetExtraLong(*args, **kwargs): | |
a95a7133 | 4461 | """SetExtraLong(self, long extraLong)""" |
54f9ee45 | 4462 | return _core_.CommandEvent_SetExtraLong(*args, **kwargs) |
e811c8ce RD |
4463 | |
4464 | def GetExtraLong(*args, **kwargs): | |
27fb7603 RD |
4465 | """ |
4466 | GetExtraLong(self) -> long | |
4467 | ||
5ba5649b RD |
4468 | Returns extra information dependant on the event objects type. If the |
4469 | event comes from a listbox selection, it is a boolean determining | |
4470 | whether the event was a selection (true) or a deselection (false). A | |
4471 | listbox deselection only occurs for multiple-selection boxes, and in | |
4472 | this case the index and string values are indeterminate and the | |
4473 | listbox must be examined by the application. | |
27fb7603 | 4474 | """ |
54f9ee45 | 4475 | return _core_.CommandEvent_GetExtraLong(*args, **kwargs) |
e811c8ce RD |
4476 | |
4477 | def SetInt(*args, **kwargs): | |
a95a7133 | 4478 | """SetInt(self, int i)""" |
54f9ee45 | 4479 | return _core_.CommandEvent_SetInt(*args, **kwargs) |
e811c8ce RD |
4480 | |
4481 | def GetInt(*args, **kwargs): | |
27fb7603 | 4482 | """ |
01f6b6d3 | 4483 | GetInt(self) -> int |
27fb7603 | 4484 | |
5ba5649b RD |
4485 | Returns the integer identifier corresponding to a listbox, choice or |
4486 | radiobox selection (only if the event was a selection, not a | |
4487 | deselection), or a boolean value representing the value of a checkbox. | |
27fb7603 | 4488 | """ |
54f9ee45 | 4489 | return _core_.CommandEvent_GetInt(*args, **kwargs) |
e811c8ce | 4490 | |
0085ce49 RD |
4491 | def GetClientData(*args, **kwargs): |
4492 | """ | |
4493 | GetClientData(self) -> PyObject | |
4494 | ||
4495 | Returns the client data object for a listbox or choice selection event, (if any.) | |
4496 | """ | |
4497 | return _core_.CommandEvent_GetClientData(*args, **kwargs) | |
4498 | ||
4499 | def SetClientData(*args, **kwargs): | |
4500 | """ | |
4501 | SetClientData(self, PyObject clientData) | |
4502 | ||
4503 | Associate the given client data with the item at position n. | |
4504 | """ | |
4505 | return _core_.CommandEvent_SetClientData(*args, **kwargs) | |
4506 | ||
4507 | GetClientObject = GetClientData | |
4508 | SetClientObject = SetClientData | |
4509 | ||
e811c8ce | 4510 | def Clone(*args, **kwargs): |
a95a7133 | 4511 | """Clone(self) -> Event""" |
54f9ee45 | 4512 | return _core_.CommandEvent_Clone(*args, **kwargs) |
e811c8ce | 4513 | |
2bf58437 RD |
4514 | ClientData = property(GetClientData,SetClientData,doc="See `GetClientData` and `SetClientData`") |
4515 | ClientObject = property(GetClientObject,SetClientObject,doc="See `GetClientObject` and `SetClientObject`") | |
4516 | ExtraLong = property(GetExtraLong,SetExtraLong,doc="See `GetExtraLong` and `SetExtraLong`") | |
4517 | Int = property(GetInt,SetInt,doc="See `GetInt` and `SetInt`") | |
4518 | Selection = property(GetSelection,doc="See `GetSelection`") | |
4519 | String = property(GetString,SetString,doc="See `GetString` and `SetString`") | |
2131d850 | 4520 | _core_.CommandEvent_swigregister(CommandEvent) |
d14a1e28 RD |
4521 | |
4522 | #--------------------------------------------------------------------------- | |
4523 | ||
4524 | class NotifyEvent(CommandEvent): | |
27fb7603 RD |
4525 | """ |
4526 | An instance of this class (or one of its derived classes) is sent from | |
4527 | a control when the control's state is being changed and the control | |
4528 | allows that change to be prevented from happening. The event handler | |
4529 | can call `Veto` or `Allow` to tell the control what to do. | |
4530 | """ | |
0085ce49 RD |
4531 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4532 | __repr__ = _swig_repr | |
4533 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4534 | """ |
2131d850 | 4535 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent |
27fb7603 RD |
4536 | |
4537 | An instance of this class (or one of its derived classes) is sent from | |
4538 | a control when the control's state is being changed and the control | |
4539 | allows that change to be prevented from happening. The event handler | |
4540 | can call `Veto` or `Allow` to tell the control what to do. | |
4541 | """ | |
0085ce49 | 4542 | _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs)) |
e811c8ce | 4543 | def Veto(*args, **kwargs): |
27fb7603 RD |
4544 | """ |
4545 | Veto(self) | |
4546 | ||
4547 | Prevents the change announced by this event from happening. | |
4548 | ||
4549 | It is in general a good idea to notify the user about the reasons for | |
4550 | vetoing the change because otherwise the applications behaviour (which | |
4551 | just refuses to do what the user wants) might be quite surprising. | |
4552 | """ | |
54f9ee45 | 4553 | return _core_.NotifyEvent_Veto(*args, **kwargs) |
e811c8ce RD |
4554 | |
4555 | def Allow(*args, **kwargs): | |
27fb7603 RD |
4556 | """ |
4557 | Allow(self) | |
4558 | ||
4559 | This is the opposite of `Veto`: it explicitly allows the event to be | |
4560 | processed. For most events it is not necessary to call this method as | |
4561 | the events are allowed anyhow but some are forbidden by default (this | |
4562 | will be mentioned in the corresponding event description). | |
4563 | """ | |
54f9ee45 | 4564 | return _core_.NotifyEvent_Allow(*args, **kwargs) |
e811c8ce RD |
4565 | |
4566 | def IsAllowed(*args, **kwargs): | |
27fb7603 RD |
4567 | """ |
4568 | IsAllowed(self) -> bool | |
4569 | ||
4570 | Returns true if the change is allowed (`Veto` hasn't been called) or | |
4571 | false otherwise (if it was). | |
4572 | """ | |
54f9ee45 | 4573 | return _core_.NotifyEvent_IsAllowed(*args, **kwargs) |
e811c8ce | 4574 | |
2131d850 | 4575 | _core_.NotifyEvent_swigregister(NotifyEvent) |
d14a1e28 RD |
4576 | |
4577 | #--------------------------------------------------------------------------- | |
4578 | ||
4579 | class ScrollEvent(CommandEvent): | |
27fb7603 RD |
4580 | """ |
4581 | A scroll event holds information about events sent from stand-alone | |
4582 | scrollbars and sliders. Note that scrolled windows do not send | |
4583 | instnaces of this event class, but send the `wx.ScrollWinEvent` | |
4584 | instead. | |
4585 | """ | |
0085ce49 RD |
4586 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4587 | __repr__ = _swig_repr | |
4588 | def __init__(self, *args, **kwargs): | |
0df68c9f | 4589 | """ |
2131d850 | 4590 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0, |
0df68c9f RD |
4591 | int orient=0) -> ScrollEvent |
4592 | """ | |
0085ce49 | 4593 | _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs)) |
e811c8ce | 4594 | def GetOrientation(*args, **kwargs): |
27fb7603 RD |
4595 | """ |
4596 | GetOrientation(self) -> int | |
4597 | ||
4598 | Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of | |
4599 | the scrollbar. | |
4600 | """ | |
54f9ee45 | 4601 | return _core_.ScrollEvent_GetOrientation(*args, **kwargs) |
e811c8ce RD |
4602 | |
4603 | def GetPosition(*args, **kwargs): | |
27fb7603 RD |
4604 | """ |
4605 | GetPosition(self) -> int | |
4606 | ||
4607 | Returns the position of the scrollbar. | |
4608 | """ | |
54f9ee45 | 4609 | return _core_.ScrollEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4610 | |
4611 | def SetOrientation(*args, **kwargs): | |
a95a7133 | 4612 | """SetOrientation(self, int orient)""" |
54f9ee45 | 4613 | return _core_.ScrollEvent_SetOrientation(*args, **kwargs) |
e811c8ce RD |
4614 | |
4615 | def SetPosition(*args, **kwargs): | |
a95a7133 | 4616 | """SetPosition(self, int pos)""" |
54f9ee45 | 4617 | return _core_.ScrollEvent_SetPosition(*args, **kwargs) |
e811c8ce | 4618 | |
33d6fd3b RD |
4619 | Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`") |
4620 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") | |
2131d850 | 4621 | _core_.ScrollEvent_swigregister(ScrollEvent) |
d14a1e28 RD |
4622 | |
4623 | #--------------------------------------------------------------------------- | |
4624 | ||
4625 | class ScrollWinEvent(Event): | |
27fb7603 RD |
4626 | """ |
4627 | A wx.ScrollWinEvent holds information about scrolling and is sent from | |
4628 | scrolling windows. | |
4629 | """ | |
0085ce49 RD |
4630 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4631 | __repr__ = _swig_repr | |
4632 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4633 | """ |
2131d850 | 4634 | __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent |
27fb7603 RD |
4635 | |
4636 | A wx.ScrollWinEvent holds information about scrolling and is sent from | |
4637 | scrolling windows. | |
4638 | """ | |
0085ce49 | 4639 | _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs)) |
e811c8ce | 4640 | def GetOrientation(*args, **kwargs): |
27fb7603 RD |
4641 | """ |
4642 | GetOrientation(self) -> int | |
4643 | ||
4644 | Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of | |
4645 | the scrollbar. | |
4646 | """ | |
54f9ee45 | 4647 | return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs) |
e811c8ce RD |
4648 | |
4649 | def GetPosition(*args, **kwargs): | |
27fb7603 RD |
4650 | """ |
4651 | GetPosition(self) -> int | |
4652 | ||
4653 | Returns the position of the scrollbar for the thumb track and release | |
4654 | events. Note that this field can't be used for the other events, you | |
4655 | need to query the window itself for the current position in that case. | |
4656 | """ | |
54f9ee45 | 4657 | return _core_.ScrollWinEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4658 | |
4659 | def SetOrientation(*args, **kwargs): | |
a95a7133 | 4660 | """SetOrientation(self, int orient)""" |
54f9ee45 | 4661 | return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs) |
e811c8ce RD |
4662 | |
4663 | def SetPosition(*args, **kwargs): | |
a95a7133 | 4664 | """SetPosition(self, int pos)""" |
54f9ee45 | 4665 | return _core_.ScrollWinEvent_SetPosition(*args, **kwargs) |
e811c8ce | 4666 | |
33d6fd3b RD |
4667 | Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`") |
4668 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") | |
2131d850 | 4669 | _core_.ScrollWinEvent_swigregister(ScrollWinEvent) |
d14a1e28 RD |
4670 | |
4671 | #--------------------------------------------------------------------------- | |
4672 | ||
54f9ee45 RD |
4673 | MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY |
4674 | MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE | |
4675 | MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT | |
4676 | MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE | |
4677 | MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT | |
d14a1e28 | 4678 | class MouseEvent(Event): |
27fb7603 RD |
4679 | """ |
4680 | This event class contains information about the events generated by | |
4681 | the mouse: they include mouse buttons press and release events and | |
4682 | mouse move events. | |
4683 | ||
4684 | All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for | |
4685 | the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and | |
4686 | ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have | |
4687 | a middle button so a portable application should avoid relying on the | |
4688 | events from it. | |
4689 | ||
4690 | Note the difference between methods like `LeftDown` and `LeftIsDown`: | |
4691 | the former returns true when the event corresponds to the left mouse | |
4692 | button click while the latter returns true if the left mouse button is | |
4693 | currently being pressed. For example, when the user is dragging the | |
4694 | mouse you can use `LeftIsDown` to test whether the left mouse button | |
4695 | is (still) depressed. Also, by convention, if `LeftDown` returns true, | |
4696 | `LeftIsDown` will also return true in wxWidgets whatever the | |
4697 | underlying GUI behaviour is (which is platform-dependent). The same | |
4698 | applies, of course, to other mouse buttons as well. | |
4699 | """ | |
0085ce49 RD |
4700 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4701 | __repr__ = _swig_repr | |
4702 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4703 | """ |
2131d850 | 4704 | __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent |
27fb7603 RD |
4705 | |
4706 | Constructs a wx.MouseEvent. Valid event types are: | |
4707 | ||
4708 | * wxEVT_ENTER_WINDOW | |
4709 | * wxEVT_LEAVE_WINDOW | |
4710 | * wxEVT_LEFT_DOWN | |
4711 | * wxEVT_LEFT_UP | |
4712 | * wxEVT_LEFT_DCLICK | |
4713 | * wxEVT_MIDDLE_DOWN | |
4714 | * wxEVT_MIDDLE_UP | |
4715 | * wxEVT_MIDDLE_DCLICK | |
4716 | * wxEVT_RIGHT_DOWN | |
4717 | * wxEVT_RIGHT_UP | |
4718 | * wxEVT_RIGHT_DCLICK | |
4719 | * wxEVT_MOTION | |
4720 | * wxEVT_MOUSEWHEEL | |
4721 | """ | |
0085ce49 | 4722 | _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs)) |
e811c8ce | 4723 | def IsButton(*args, **kwargs): |
27fb7603 RD |
4724 | """ |
4725 | IsButton(self) -> bool | |
4726 | ||
4727 | Returns true if the event was a mouse button event (not necessarily a | |
4728 | button down event - that may be tested using `ButtonDown`). | |
4729 | """ | |
54f9ee45 | 4730 | return _core_.MouseEvent_IsButton(*args, **kwargs) |
e811c8ce RD |
4731 | |
4732 | def ButtonDown(*args, **kwargs): | |
27fb7603 RD |
4733 | """ |
4734 | ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool | |
4735 | ||
5ba5649b RD |
4736 | If the argument is omitted, this returns true if the event was any |
4737 | mouse button down event. Otherwise the argument specifies which | |
4738 | button-down event shold be checked for (see `Button` for the possible | |
4739 | values). | |
27fb7603 | 4740 | """ |
54f9ee45 | 4741 | return _core_.MouseEvent_ButtonDown(*args, **kwargs) |
e811c8ce RD |
4742 | |
4743 | def ButtonDClick(*args, **kwargs): | |
27fb7603 RD |
4744 | """ |
4745 | ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool | |
4746 | ||
4747 | If the argument is omitted, this returns true if the event was any | |
4748 | mouse double click event. Otherwise the argument specifies which | |
4749 | double click event to check for (see `Button` for the possible | |
4750 | values). | |
4751 | """ | |
54f9ee45 | 4752 | return _core_.MouseEvent_ButtonDClick(*args, **kwargs) |
e811c8ce RD |
4753 | |
4754 | def ButtonUp(*args, **kwargs): | |
27fb7603 RD |
4755 | """ |
4756 | ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool | |
4757 | ||
4758 | If the argument is omitted, this returns true if the event was any | |
5ba5649b RD |
4759 | mouse button up event. Otherwise the argument specifies which button |
4760 | up event to check for (see `Button` for the possible values). | |
27fb7603 | 4761 | """ |
54f9ee45 | 4762 | return _core_.MouseEvent_ButtonUp(*args, **kwargs) |
e811c8ce RD |
4763 | |
4764 | def Button(*args, **kwargs): | |
27fb7603 RD |
4765 | """ |
4766 | Button(self, int button) -> bool | |
4767 | ||
4768 | Returns true if the identified mouse button is changing state. Valid | |
4769 | values of button are: | |
4770 | ||
4771 | ==================== ===================================== | |
4772 | wx.MOUSE_BTN_LEFT check if left button was pressed | |
4773 | wx.MOUSE_BTN_MIDDLE check if middle button was pressed | |
4774 | wx.MOUSE_BTN_RIGHT check if right button was pressed | |
4775 | wx.MOUSE_BTN_ANY check if any button was pressed | |
4776 | ==================== ===================================== | |
4777 | ||
4778 | """ | |
54f9ee45 | 4779 | return _core_.MouseEvent_Button(*args, **kwargs) |
e811c8ce RD |
4780 | |
4781 | def ButtonIsDown(*args, **kwargs): | |
a95a7133 | 4782 | """ButtonIsDown(self, int but) -> bool""" |
54f9ee45 | 4783 | return _core_.MouseEvent_ButtonIsDown(*args, **kwargs) |
e811c8ce RD |
4784 | |
4785 | def GetButton(*args, **kwargs): | |
27fb7603 RD |
4786 | """ |
4787 | GetButton(self) -> int | |
4788 | ||
4789 | Returns the mouse button which generated this event or | |
4790 | wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or | |
4791 | leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for | |
4792 | the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE | |
4793 | and wx.MOUSE_BTN_RIGHT for the same events for the middle and the | |
4794 | right buttons respectively. | |
4795 | """ | |
54f9ee45 | 4796 | return _core_.MouseEvent_GetButton(*args, **kwargs) |
e811c8ce RD |
4797 | |
4798 | def ControlDown(*args, **kwargs): | |
27fb7603 RD |
4799 | """ |
4800 | ControlDown(self) -> bool | |
4801 | ||
4802 | Returns true if the control key was down at the time of the event. | |
4803 | """ | |
54f9ee45 | 4804 | return _core_.MouseEvent_ControlDown(*args, **kwargs) |
e811c8ce RD |
4805 | |
4806 | def MetaDown(*args, **kwargs): | |
27fb7603 RD |
4807 | """ |
4808 | MetaDown(self) -> bool | |
4809 | ||
4810 | Returns true if the Meta key was down at the time of the event. | |
4811 | """ | |
54f9ee45 | 4812 | return _core_.MouseEvent_MetaDown(*args, **kwargs) |
e811c8ce RD |
4813 | |
4814 | def AltDown(*args, **kwargs): | |
27fb7603 RD |
4815 | """ |
4816 | AltDown(self) -> bool | |
4817 | ||
4818 | Returns true if the Alt key was down at the time of the event. | |
4819 | """ | |
54f9ee45 | 4820 | return _core_.MouseEvent_AltDown(*args, **kwargs) |
e811c8ce RD |
4821 | |
4822 | def ShiftDown(*args, **kwargs): | |
27fb7603 RD |
4823 | """ |
4824 | ShiftDown(self) -> bool | |
4825 | ||
4826 | Returns true if the Shift key was down at the time of the event. | |
4827 | """ | |
54f9ee45 | 4828 | return _core_.MouseEvent_ShiftDown(*args, **kwargs) |
e811c8ce | 4829 | |
412d302d RD |
4830 | def CmdDown(*args, **kwargs): |
4831 | """ | |
4832 | CmdDown(self) -> bool | |
4833 | ||
4834 | "Cmd" is a pseudo key which is the same as Control for PC and Unix | |
4835 | platforms but the special "Apple" (a.k.a as "Command") key on | |
5ba5649b | 4836 | Macs. It often makes sense to use it instead of, say, `ControlDown` |
412d302d | 4837 | because Cmd key is used for the same thing under Mac as Ctrl |
27fb7603 | 4838 | elsewhere. The Ctrl key still exists, it's just not used for this |
412d302d RD |
4839 | purpose. So for non-Mac platforms this is the same as `ControlDown` |
4840 | and Macs this is the same as `MetaDown`. | |
4841 | """ | |
4842 | return _core_.MouseEvent_CmdDown(*args, **kwargs) | |
4843 | ||
e811c8ce | 4844 | def LeftDown(*args, **kwargs): |
27fb7603 RD |
4845 | """ |
4846 | LeftDown(self) -> bool | |
4847 | ||
4848 | Returns true if the left mouse button state changed to down. | |
4849 | """ | |
54f9ee45 | 4850 | return _core_.MouseEvent_LeftDown(*args, **kwargs) |
e811c8ce RD |
4851 | |
4852 | def MiddleDown(*args, **kwargs): | |
27fb7603 RD |
4853 | """ |
4854 | MiddleDown(self) -> bool | |
4855 | ||
4856 | Returns true if the middle mouse button state changed to down. | |
4857 | """ | |
54f9ee45 | 4858 | return _core_.MouseEvent_MiddleDown(*args, **kwargs) |
e811c8ce RD |
4859 | |
4860 | def RightDown(*args, **kwargs): | |
27fb7603 RD |
4861 | """ |
4862 | RightDown(self) -> bool | |
4863 | ||
4864 | Returns true if the right mouse button state changed to down. | |
4865 | """ | |
54f9ee45 | 4866 | return _core_.MouseEvent_RightDown(*args, **kwargs) |
e811c8ce RD |
4867 | |
4868 | def LeftUp(*args, **kwargs): | |
27fb7603 RD |
4869 | """ |
4870 | LeftUp(self) -> bool | |
4871 | ||
4872 | Returns true if the left mouse button state changed to up. | |
4873 | """ | |
54f9ee45 | 4874 | return _core_.MouseEvent_LeftUp(*args, **kwargs) |
e811c8ce RD |
4875 | |
4876 | def MiddleUp(*args, **kwargs): | |
27fb7603 RD |
4877 | """ |
4878 | MiddleUp(self) -> bool | |
4879 | ||
4880 | Returns true if the middle mouse button state changed to up. | |
4881 | """ | |
54f9ee45 | 4882 | return _core_.MouseEvent_MiddleUp(*args, **kwargs) |
e811c8ce RD |
4883 | |
4884 | def RightUp(*args, **kwargs): | |
27fb7603 RD |
4885 | """ |
4886 | RightUp(self) -> bool | |
4887 | ||
4888 | Returns true if the right mouse button state changed to up. | |
4889 | """ | |
54f9ee45 | 4890 | return _core_.MouseEvent_RightUp(*args, **kwargs) |
e811c8ce RD |
4891 | |
4892 | def LeftDClick(*args, **kwargs): | |
27fb7603 RD |
4893 | """ |
4894 | LeftDClick(self) -> bool | |
4895 | ||
4896 | Returns true if the event was a left button double click. | |
4897 | """ | |
54f9ee45 | 4898 | return _core_.MouseEvent_LeftDClick(*args, **kwargs) |
e811c8ce RD |
4899 | |
4900 | def MiddleDClick(*args, **kwargs): | |
27fb7603 RD |
4901 | """ |
4902 | MiddleDClick(self) -> bool | |
4903 | ||
4904 | Returns true if the event was a middle button double click. | |
4905 | """ | |
54f9ee45 | 4906 | return _core_.MouseEvent_MiddleDClick(*args, **kwargs) |
e811c8ce RD |
4907 | |
4908 | def RightDClick(*args, **kwargs): | |
27fb7603 RD |
4909 | """ |
4910 | RightDClick(self) -> bool | |
4911 | ||
4912 | Returns true if the event was a right button double click. | |
4913 | """ | |
54f9ee45 | 4914 | return _core_.MouseEvent_RightDClick(*args, **kwargs) |
e811c8ce RD |
4915 | |
4916 | def LeftIsDown(*args, **kwargs): | |
27fb7603 RD |
4917 | """ |
4918 | LeftIsDown(self) -> bool | |
4919 | ||
4920 | Returns true if the left mouse button is currently down, independent | |
4921 | of the current event type. | |
4922 | ||
4923 | Please notice that it is not the same as LeftDown which returns true | |
4924 | if the left mouse button was just pressed. Rather, it describes the | |
4925 | state of the mouse button before the event happened. | |
4926 | ||
4927 | This event is usually used in the mouse event handlers which process | |
4928 | "move mouse" messages to determine whether the user is (still) | |
4929 | dragging the mouse. | |
4930 | """ | |
54f9ee45 | 4931 | return _core_.MouseEvent_LeftIsDown(*args, **kwargs) |
e811c8ce RD |
4932 | |
4933 | def MiddleIsDown(*args, **kwargs): | |
27fb7603 RD |
4934 | """ |
4935 | MiddleIsDown(self) -> bool | |
4936 | ||
4937 | Returns true if the middle mouse button is currently down, independent | |
4938 | of the current event type. | |
4939 | """ | |
54f9ee45 | 4940 | return _core_.MouseEvent_MiddleIsDown(*args, **kwargs) |
e811c8ce RD |
4941 | |
4942 | def RightIsDown(*args, **kwargs): | |
27fb7603 RD |
4943 | """ |
4944 | RightIsDown(self) -> bool | |
4945 | ||
4946 | Returns true if the right mouse button is currently down, independent | |
4947 | of the current event type. | |
4948 | """ | |
54f9ee45 | 4949 | return _core_.MouseEvent_RightIsDown(*args, **kwargs) |
e811c8ce RD |
4950 | |
4951 | def Dragging(*args, **kwargs): | |
27fb7603 RD |
4952 | """ |
4953 | Dragging(self) -> bool | |
4954 | ||
4955 | Returns true if this was a dragging event (motion while a button is | |
4956 | depressed). | |
4957 | """ | |
54f9ee45 | 4958 | return _core_.MouseEvent_Dragging(*args, **kwargs) |
e811c8ce RD |
4959 | |
4960 | def Moving(*args, **kwargs): | |
27fb7603 RD |
4961 | """ |
4962 | Moving(self) -> bool | |
4963 | ||
4964 | Returns true if this was a motion event and no mouse buttons were | |
4965 | pressed. If any mouse button is held pressed, then this method returns | |
4966 | false and Dragging returns true. | |
4967 | """ | |
54f9ee45 | 4968 | return _core_.MouseEvent_Moving(*args, **kwargs) |
e811c8ce RD |
4969 | |
4970 | def Entering(*args, **kwargs): | |
27fb7603 RD |
4971 | """ |
4972 | Entering(self) -> bool | |
4973 | ||
4974 | Returns true if the mouse was entering the window. | |
4975 | """ | |
54f9ee45 | 4976 | return _core_.MouseEvent_Entering(*args, **kwargs) |
e811c8ce RD |
4977 | |
4978 | def Leaving(*args, **kwargs): | |
27fb7603 RD |
4979 | """ |
4980 | Leaving(self) -> bool | |
4981 | ||
4982 | Returns true if the mouse was leaving the window. | |
4983 | """ | |
54f9ee45 | 4984 | return _core_.MouseEvent_Leaving(*args, **kwargs) |
e811c8ce RD |
4985 | |
4986 | def GetPosition(*args, **kwargs): | |
0df68c9f | 4987 | """ |
a95a7133 | 4988 | GetPosition(self) -> Point |
e811c8ce | 4989 | |
27fb7603 RD |
4990 | Returns the pixel position of the mouse in window coordinates when the |
4991 | event happened. | |
0df68c9f | 4992 | """ |
54f9ee45 | 4993 | return _core_.MouseEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4994 | |
4995 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
4996 | """ |
4997 | GetPositionTuple() -> (x,y) | |
e811c8ce | 4998 | |
27fb7603 RD |
4999 | Returns the pixel position of the mouse in window coordinates when the |
5000 | event happened. | |
0df68c9f | 5001 | """ |
54f9ee45 | 5002 | return _core_.MouseEvent_GetPositionTuple(*args, **kwargs) |
e811c8ce RD |
5003 | |
5004 | def GetLogicalPosition(*args, **kwargs): | |
27fb7603 RD |
5005 | """ |
5006 | GetLogicalPosition(self, DC dc) -> Point | |
5007 | ||
5008 | Returns the logical mouse position in pixels (i.e. translated | |
5009 | according to the translation set for the DC, which usually indicates | |
5010 | that the window has been scrolled). | |
5011 | """ | |
54f9ee45 | 5012 | return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs) |
e811c8ce RD |
5013 | |
5014 | def GetX(*args, **kwargs): | |
27fb7603 RD |
5015 | """ |
5016 | GetX(self) -> int | |
5017 | ||
5018 | Returns X coordinate of the physical mouse event position. | |
5019 | """ | |
54f9ee45 | 5020 | return _core_.MouseEvent_GetX(*args, **kwargs) |
e811c8ce RD |
5021 | |
5022 | def GetY(*args, **kwargs): | |
27fb7603 RD |
5023 | """ |
5024 | GetY(self) -> int | |
5025 | ||
5026 | Returns Y coordinate of the physical mouse event position. | |
5027 | """ | |
54f9ee45 | 5028 | return _core_.MouseEvent_GetY(*args, **kwargs) |
e811c8ce RD |
5029 | |
5030 | def GetWheelRotation(*args, **kwargs): | |
27fb7603 RD |
5031 | """ |
5032 | GetWheelRotation(self) -> int | |
5033 | ||
5034 | Get wheel rotation, positive or negative indicates direction of | |
5035 | rotation. Current devices all send an event when rotation is equal to | |
5036 | +/-WheelDelta, but this allows for finer resolution devices to be | |
5037 | created in the future. Because of this you shouldn't assume that one | |
5038 | event is equal to 1 line or whatever, but you should be able to either | |
5039 | do partial line scrolling or wait until +/-WheelDelta rotation values | |
5040 | have been accumulated before scrolling. | |
5041 | """ | |
54f9ee45 | 5042 | return _core_.MouseEvent_GetWheelRotation(*args, **kwargs) |
e811c8ce RD |
5043 | |
5044 | def GetWheelDelta(*args, **kwargs): | |
27fb7603 RD |
5045 | """ |
5046 | GetWheelDelta(self) -> int | |
5047 | ||
5048 | Get wheel delta, normally 120. This is the threshold for action to be | |
5049 | taken, and one such action (for example, scrolling one increment) | |
5050 | should occur for each delta. | |
5051 | """ | |
54f9ee45 | 5052 | return _core_.MouseEvent_GetWheelDelta(*args, **kwargs) |
e811c8ce RD |
5053 | |
5054 | def GetLinesPerAction(*args, **kwargs): | |
27fb7603 RD |
5055 | """ |
5056 | GetLinesPerAction(self) -> int | |
5057 | ||
5058 | Returns the configured number of lines (or whatever) to be scrolled | |
5059 | per wheel action. Defaults to three. | |
5060 | """ | |
54f9ee45 | 5061 | return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs) |
e811c8ce RD |
5062 | |
5063 | def IsPageScroll(*args, **kwargs): | |
27fb7603 RD |
5064 | """ |
5065 | IsPageScroll(self) -> bool | |
5066 | ||
5067 | Returns true if the system has been setup to do page scrolling with | |
5068 | the mouse wheel instead of line scrolling. | |
5069 | """ | |
54f9ee45 RD |
5070 | return _core_.MouseEvent_IsPageScroll(*args, **kwargs) |
5071 | ||
5072 | m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set) | |
5073 | m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set) | |
5074 | m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set) | |
5075 | m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set) | |
5076 | m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set) | |
5077 | m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set) | |
5078 | m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set) | |
5079 | m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set) | |
5080 | m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set) | |
5081 | m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set) | |
5082 | m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set) | |
5083 | m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set) | |
57332a5a RD |
5084 | Button = property(GetButton,doc="See `GetButton`") |
5085 | LinesPerAction = property(GetLinesPerAction,doc="See `GetLinesPerAction`") | |
5086 | LogicalPosition = property(GetLogicalPosition,doc="See `GetLogicalPosition`") | |
5087 | Position = property(GetPosition,doc="See `GetPosition`") | |
5088 | WheelDelta = property(GetWheelDelta,doc="See `GetWheelDelta`") | |
5089 | WheelRotation = property(GetWheelRotation,doc="See `GetWheelRotation`") | |
5090 | X = property(GetX,doc="See `GetX`") | |
5091 | Y = property(GetY,doc="See `GetY`") | |
2131d850 | 5092 | _core_.MouseEvent_swigregister(MouseEvent) |
d14a1e28 RD |
5093 | |
5094 | #--------------------------------------------------------------------------- | |
5095 | ||
5096 | class SetCursorEvent(Event): | |
5ba5649b RD |
5097 | """ |
5098 | A SetCursorEvent is generated when the mouse cursor is about to be set | |
5099 | as a result of mouse motion. This event gives the application the | |
5100 | chance to perform specific mouse cursor processing based on the | |
5101 | current position of the mouse within the window. Use the `SetCursor` | |
5102 | method to specify the cursor you want to be displayed. | |
5103 | """ | |
0085ce49 RD |
5104 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5105 | __repr__ = _swig_repr | |
5106 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5107 | """ |
5108 | __init__(self, int x=0, int y=0) -> SetCursorEvent | |
5109 | ||
5110 | Construct a new `wx.SetCursorEvent`. | |
5111 | """ | |
0085ce49 | 5112 | _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs)) |
e811c8ce | 5113 | def GetX(*args, **kwargs): |
5ba5649b RD |
5114 | """ |
5115 | GetX(self) -> int | |
5116 | ||
5117 | Returns the X coordinate of the mouse in client coordinates. | |
5118 | """ | |
54f9ee45 | 5119 | return _core_.SetCursorEvent_GetX(*args, **kwargs) |
e811c8ce RD |
5120 | |
5121 | def GetY(*args, **kwargs): | |
5ba5649b RD |
5122 | """ |
5123 | GetY(self) -> int | |
5124 | ||
5125 | Returns the Y coordinate of the mouse in client coordinates. | |
5126 | """ | |
54f9ee45 | 5127 | return _core_.SetCursorEvent_GetY(*args, **kwargs) |
e811c8ce RD |
5128 | |
5129 | def SetCursor(*args, **kwargs): | |
5ba5649b RD |
5130 | """ |
5131 | SetCursor(self, Cursor cursor) | |
5132 | ||
5133 | Sets the cursor associated with this event. | |
5134 | """ | |
54f9ee45 | 5135 | return _core_.SetCursorEvent_SetCursor(*args, **kwargs) |
e811c8ce RD |
5136 | |
5137 | def GetCursor(*args, **kwargs): | |
5ba5649b RD |
5138 | """ |
5139 | GetCursor(self) -> Cursor | |
5140 | ||
5141 | Returns a reference to the cursor specified by this event. | |
5142 | """ | |
54f9ee45 | 5143 | return _core_.SetCursorEvent_GetCursor(*args, **kwargs) |
e811c8ce RD |
5144 | |
5145 | def HasCursor(*args, **kwargs): | |
5ba5649b RD |
5146 | """ |
5147 | HasCursor(self) -> bool | |
5148 | ||
5149 | Returns true if the cursor specified by this event is a valid cursor. | |
5150 | """ | |
54f9ee45 | 5151 | return _core_.SetCursorEvent_HasCursor(*args, **kwargs) |
e811c8ce | 5152 | |
33d6fd3b RD |
5153 | Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`") |
5154 | X = property(GetX,doc="See `GetX`") | |
5155 | Y = property(GetY,doc="See `GetY`") | |
2131d850 | 5156 | _core_.SetCursorEvent_swigregister(SetCursorEvent) |
d14a1e28 RD |
5157 | |
5158 | #--------------------------------------------------------------------------- | |
5159 | ||
5160 | class KeyEvent(Event): | |
5ba5649b RD |
5161 | """ |
5162 | This event class contains information about keypress and character | |
5163 | events. These events are only sent to the widget that currently has | |
5164 | the keyboard focus. | |
5165 | ||
5166 | Notice that there are three different kinds of keyboard events in | |
5167 | wxWidgets: key down and up events and char events. The difference | |
5168 | between the first two is clear - the first corresponds to a key press | |
5169 | and the second to a key release - otherwise they are identical. Just | |
5170 | note that if the key is maintained in a pressed state you will | |
5171 | typically get a lot of (automatically generated) down events but only | |
5172 | one up so it is wrong to assume that there is one up event | |
5173 | corresponding to each down one. | |
5174 | ||
5175 | Both key events provide untranslated key codes while the char event | |
5176 | carries the translated one. The untranslated code for alphanumeric | |
5177 | keys is always an upper case value. For the other keys it is one of | |
5178 | WXK_XXX values from the keycodes table. The translated key is, in | |
5179 | general, the character the user expects to appear as the result of the | |
5180 | key combination when typing the text into a text entry zone, for | |
5181 | example. | |
5182 | ||
5183 | A few examples to clarify this (all assume that CAPS LOCK is unpressed | |
5184 | and the standard US keyboard): when the 'A' key is pressed, the key | |
5185 | down event key code is equal to ASCII A == 65. But the char event key | |
5186 | code is ASCII a == 97. On the other hand, if you press both SHIFT and | |
5187 | 'A' keys simultaneously , the key code in key down event will still be | |
5188 | just 'A' while the char event key code parameter will now be 'A' as | |
5189 | well. | |
5190 | ||
5191 | Although in this simple case it is clear that the correct key code | |
5192 | could be found in the key down event handler by checking the value | |
5193 | returned by `ShiftDown`, in general you should use EVT_CHAR for this | |
5194 | as for non alphanumeric keys or non-US keyboard layouts the | |
5195 | translation is keyboard-layout dependent and can only be done properly | |
5196 | by the system itself. | |
5197 | ||
5198 | Another kind of translation is done when the control key is pressed: | |
5199 | for example, for CTRL-A key press the key down event still carries the | |
5200 | same key code 'A' as usual but the char event will have key code of 1, | |
5201 | the ASCII value of this key combination. | |
5202 | ||
5203 | You may discover how the other keys on your system behave | |
5204 | interactively by running the KeyEvents sample in the wxPython demo and | |
5205 | pressing some keys while the blue box at the top has the keyboard | |
5206 | focus. | |
5207 | ||
5208 | **Note**: If a key down event is caught and the event handler does not | |
5209 | call event.Skip() then the coresponding char event will not | |
5210 | happen. This is by design and enables the programs that handle both | |
5211 | types of events to be a bit simpler. | |
5212 | ||
5213 | **Note for Windows programmers**: The key and char events in wxWidgets | |
5214 | are similar to but slightly different from Windows WM_KEYDOWN and | |
5215 | WM_CHAR events. In particular, Alt-x combination will generate a char | |
5216 | event in wxWidgets (unless it is used as an accelerator). | |
5217 | ||
5218 | **Tip**: be sure to call event.Skip() for events that you don't | |
5219 | process in key event function, otherwise menu shortcuts may cease to | |
5220 | work under Windows. | |
5221 | ||
5222 | """ | |
0085ce49 RD |
5223 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5224 | __repr__ = _swig_repr | |
5225 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5226 | """ |
2131d850 | 5227 | __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent |
5ba5649b RD |
5228 | |
5229 | Construct a new `wx.KeyEvent`. Valid event types are: | |
5230 | * | |
5231 | """ | |
0085ce49 | 5232 | _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs)) |
b1fcee84 RD |
5233 | def GetModifiers(*args, **kwargs): |
5234 | """ | |
5235 | GetModifiers(self) -> int | |
5236 | ||
5237 | Returns a bitmask of the current modifier settings. Can be used to | |
5238 | check if the key event has exactly the given modifiers without having | |
5239 | to explicitly check that the other modifiers are not down. For | |
5240 | example:: | |
5241 | ||
5242 | if event.GetModifers() == wx.MOD_CONTROL: | |
5243 | DoSomething() | |
5244 | ||
5245 | """ | |
5246 | return _core_.KeyEvent_GetModifiers(*args, **kwargs) | |
5247 | ||
e811c8ce | 5248 | def ControlDown(*args, **kwargs): |
5ba5649b RD |
5249 | """ |
5250 | ControlDown(self) -> bool | |
5251 | ||
5252 | Returns ``True`` if the Control key was down at the time of the event. | |
5253 | """ | |
54f9ee45 | 5254 | return _core_.KeyEvent_ControlDown(*args, **kwargs) |
e811c8ce RD |
5255 | |
5256 | def MetaDown(*args, **kwargs): | |
5ba5649b RD |
5257 | """ |
5258 | MetaDown(self) -> bool | |
5259 | ||
5260 | Returns ``True`` if the Meta key was down at the time of the event. | |
5261 | """ | |
54f9ee45 | 5262 | return _core_.KeyEvent_MetaDown(*args, **kwargs) |
e811c8ce RD |
5263 | |
5264 | def AltDown(*args, **kwargs): | |
5ba5649b RD |
5265 | """ |
5266 | AltDown(self) -> bool | |
5267 | ||
5268 | Returns ``True`` if the Alt key was down at the time of the event. | |
5269 | """ | |
54f9ee45 | 5270 | return _core_.KeyEvent_AltDown(*args, **kwargs) |
e811c8ce RD |
5271 | |
5272 | def ShiftDown(*args, **kwargs): | |
5ba5649b RD |
5273 | """ |
5274 | ShiftDown(self) -> bool | |
5275 | ||
5276 | Returns ``True`` if the Shift key was down at the time of the event. | |
5277 | """ | |
54f9ee45 | 5278 | return _core_.KeyEvent_ShiftDown(*args, **kwargs) |
e811c8ce | 5279 | |
412d302d RD |
5280 | def CmdDown(*args, **kwargs): |
5281 | """ | |
5282 | CmdDown(self) -> bool | |
5283 | ||
5284 | "Cmd" is a pseudo key which is the same as Control for PC and Unix | |
5285 | platforms but the special "Apple" (a.k.a as "Command") key on | |
5ba5649b | 5286 | Macs. It makes often sense to use it instead of, say, `ControlDown` |
412d302d RD |
5287 | because Cmd key is used for the same thing under Mac as Ctrl |
5288 | elsewhere. The Ctrl still exists, it's just not used for this | |
5289 | purpose. So for non-Mac platforms this is the same as `ControlDown` | |
5290 | and Macs this is the same as `MetaDown`. | |
5291 | """ | |
5292 | return _core_.KeyEvent_CmdDown(*args, **kwargs) | |
5293 | ||
e811c8ce | 5294 | def HasModifiers(*args, **kwargs): |
5ba5649b RD |
5295 | """ |
5296 | HasModifiers(self) -> bool | |
5297 | ||
5298 | Returns true if either CTRL or ALT keys was down at the time of the | |
5299 | key event. Note that this function does not take into account neither | |
5300 | SHIFT nor META key states (the reason for ignoring the latter is that | |
5301 | it is common for NUMLOCK key to be configured as META under X but the | |
5302 | key presses even while NUMLOCK is on should be still processed | |
5303 | normally). | |
5304 | """ | |
54f9ee45 | 5305 | return _core_.KeyEvent_HasModifiers(*args, **kwargs) |
e811c8ce RD |
5306 | |
5307 | def GetKeyCode(*args, **kwargs): | |
5ba5649b RD |
5308 | """ |
5309 | GetKeyCode(self) -> int | |
5310 | ||
5311 | Returns the virtual key code. ASCII events return normal ASCII values, | |
5312 | while non-ASCII events return values such as WXK_LEFT for the left | |
5313 | cursor key. See `wx.KeyEvent` for a full list of the virtual key | |
5314 | codes. | |
5315 | ||
5316 | Note that in Unicode build, the returned value is meaningful only if | |
5317 | the user entered a character that can be represented in current | |
5318 | locale's default charset. You can obtain the corresponding Unicode | |
5319 | character using `GetUnicodeKey`. | |
5320 | """ | |
54f9ee45 | 5321 | return _core_.KeyEvent_GetKeyCode(*args, **kwargs) |
e811c8ce | 5322 | |
19272049 | 5323 | def GetUnicodeKey(*args, **kwargs): |
5ba5649b RD |
5324 | """ |
5325 | GetUnicodeKey(self) -> int | |
5326 | ||
5327 | Returns the Unicode character corresponding to this key event. This | |
5328 | function is only meaningfule in a Unicode build of wxPython. | |
5329 | """ | |
19272049 | 5330 | return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs) |
e811c8ce | 5331 | |
19272049 | 5332 | GetUniChar = GetUnicodeKey |
b850e7f3 RD |
5333 | def SetUnicodeKey(*args, **kwargs): |
5334 | """ | |
5335 | SetUnicodeKey(self, int uniChar) | |
5336 | ||
5337 | Set the Unicode value of the key event, but only if this is a Unicode | |
5338 | build of wxPython. | |
5339 | """ | |
5340 | return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs) | |
5341 | ||
e811c8ce | 5342 | def GetRawKeyCode(*args, **kwargs): |
5ba5649b RD |
5343 | """ |
5344 | GetRawKeyCode(self) -> unsigned int | |
5345 | ||
5346 | Returns the raw key code for this event. This is a platform-dependent | |
5347 | scan code which should only be used in advanced | |
5348 | applications. Currently the raw key codes are not supported by all | |
5349 | ports. | |
5350 | """ | |
54f9ee45 | 5351 | return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs) |
e811c8ce RD |
5352 | |
5353 | def GetRawKeyFlags(*args, **kwargs): | |
5ba5649b RD |
5354 | """ |
5355 | GetRawKeyFlags(self) -> unsigned int | |
5356 | ||
5357 | Returns the low level key flags for this event. The flags are | |
5358 | platform-dependent and should only be used in advanced applications. | |
5359 | Currently the raw key flags are not supported by all ports. | |
5360 | """ | |
54f9ee45 | 5361 | return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs) |
e811c8ce RD |
5362 | |
5363 | def GetPosition(*args, **kwargs): | |
0df68c9f | 5364 | """ |
a95a7133 | 5365 | GetPosition(self) -> Point |
e811c8ce | 5366 | |
5ba5649b | 5367 | Find the position of the event, if applicable. |
0df68c9f | 5368 | """ |
54f9ee45 | 5369 | return _core_.KeyEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
5370 | |
5371 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
5372 | """ |
5373 | GetPositionTuple() -> (x,y) | |
e811c8ce | 5374 | |
5ba5649b | 5375 | Find the position of the event, if applicable. |
0df68c9f | 5376 | """ |
54f9ee45 | 5377 | return _core_.KeyEvent_GetPositionTuple(*args, **kwargs) |
e811c8ce RD |
5378 | |
5379 | def GetX(*args, **kwargs): | |
5ba5649b RD |
5380 | """ |
5381 | GetX(self) -> int | |
5382 | ||
5383 | Returns the X position (in client coordinates) of the event, if | |
5384 | applicable. | |
5385 | """ | |
54f9ee45 | 5386 | return _core_.KeyEvent_GetX(*args, **kwargs) |
e811c8ce RD |
5387 | |
5388 | def GetY(*args, **kwargs): | |
5ba5649b RD |
5389 | """ |
5390 | GetY(self) -> int | |
5391 | ||
5392 | Returns the Y position (in client coordinates) of the event, if | |
5393 | applicable. | |
5394 | """ | |
54f9ee45 RD |
5395 | return _core_.KeyEvent_GetY(*args, **kwargs) |
5396 | ||
5397 | m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set) | |
5398 | m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set) | |
5399 | m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set) | |
5400 | m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set) | |
5401 | m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set) | |
5402 | m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set) | |
5403 | m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set) | |
5404 | m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set) | |
5405 | m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set) | |
5406 | m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set) | |
97ab0f6a RD |
5407 | KeyCode = property(GetKeyCode,doc="See `GetKeyCode`") |
5408 | Modifiers = property(GetModifiers,doc="See `GetModifiers`") | |
5409 | Position = property(GetPosition,doc="See `GetPosition`") | |
5410 | RawKeyCode = property(GetRawKeyCode,doc="See `GetRawKeyCode`") | |
5411 | RawKeyFlags = property(GetRawKeyFlags,doc="See `GetRawKeyFlags`") | |
5412 | UnicodeKey = property(GetUnicodeKey,SetUnicodeKey,doc="See `GetUnicodeKey` and `SetUnicodeKey`") | |
5413 | X = property(GetX,doc="See `GetX`") | |
5414 | Y = property(GetY,doc="See `GetY`") | |
2131d850 | 5415 | _core_.KeyEvent_swigregister(KeyEvent) |
d14a1e28 RD |
5416 | |
5417 | #--------------------------------------------------------------------------- | |
5418 | ||
5419 | class SizeEvent(Event): | |
5ba5649b RD |
5420 | """ |
5421 | A size event holds information about size change events. The EVT_SIZE | |
5422 | handler function will be called when the window it is bound to has | |
5423 | been resized. | |
5424 | ||
5425 | Note that the size passed is of the whole window: call | |
5426 | `wx.Window.GetClientSize` for the area which may be used by the | |
5427 | application. | |
5428 | ||
5429 | When a window is resized, usually only a small part of the window is | |
5430 | damaged and and that area is all that is in the update region for the | |
5431 | next paint event. However, if your drawing depends on the size of the | |
5432 | window, you may need to clear the DC explicitly and repaint the whole | |
5433 | window. In which case, you may need to call `wx.Window.Refresh` to | |
5434 | invalidate the entire window. | |
5435 | ||
5436 | """ | |
0085ce49 RD |
5437 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5438 | __repr__ = _swig_repr | |
5439 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5440 | """ |
5441 | __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent | |
5442 | ||
5443 | Construct a new ``wx.SizeEvent``. | |
5444 | """ | |
0085ce49 | 5445 | _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs)) |
e811c8ce | 5446 | def GetSize(*args, **kwargs): |
5ba5649b RD |
5447 | """ |
5448 | GetSize(self) -> Size | |
5449 | ||
5450 | Returns the entire size of the window generating the size change | |
5451 | event. | |
5452 | """ | |
54f9ee45 | 5453 | return _core_.SizeEvent_GetSize(*args, **kwargs) |
e811c8ce RD |
5454 | |
5455 | def GetRect(*args, **kwargs): | |
a95a7133 | 5456 | """GetRect(self) -> Rect""" |
54f9ee45 | 5457 | return _core_.SizeEvent_GetRect(*args, **kwargs) |
e811c8ce RD |
5458 | |
5459 | def SetRect(*args, **kwargs): | |
a95a7133 | 5460 | """SetRect(self, Rect rect)""" |
54f9ee45 | 5461 | return _core_.SizeEvent_SetRect(*args, **kwargs) |
e811c8ce RD |
5462 | |
5463 | def SetSize(*args, **kwargs): | |
a95a7133 | 5464 | """SetSize(self, Size size)""" |
54f9ee45 | 5465 | return _core_.SizeEvent_SetSize(*args, **kwargs) |
e811c8ce | 5466 | |
54f9ee45 RD |
5467 | m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set) |
5468 | m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set) | |
33d6fd3b RD |
5469 | Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`") |
5470 | Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") | |
2131d850 | 5471 | _core_.SizeEvent_swigregister(SizeEvent) |
d14a1e28 RD |
5472 | |
5473 | #--------------------------------------------------------------------------- | |
5474 | ||
5475 | class MoveEvent(Event): | |
5ba5649b RD |
5476 | """ |
5477 | This event object is sent for EVT_MOVE event bindings when a window is | |
5478 | moved to a new position. | |
5479 | """ | |
0085ce49 RD |
5480 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5481 | __repr__ = _swig_repr | |
5482 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5483 | """ |
5484 | __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent | |
5485 | ||
5486 | Constructor. | |
5487 | """ | |
0085ce49 | 5488 | _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs)) |
e811c8ce | 5489 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
5490 | """ |
5491 | GetPosition(self) -> Point | |
5492 | ||
5493 | Returns the position of the window generating the move change event. | |
5494 | """ | |
54f9ee45 | 5495 | return _core_.MoveEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
5496 | |
5497 | def GetRect(*args, **kwargs): | |
a95a7133 | 5498 | """GetRect(self) -> Rect""" |
54f9ee45 | 5499 | return _core_.MoveEvent_GetRect(*args, **kwargs) |
e811c8ce RD |
5500 | |
5501 | def SetRect(*args, **kwargs): | |
a95a7133 | 5502 | """SetRect(self, Rect rect)""" |
54f9ee45 | 5503 | return _core_.MoveEvent_SetRect(*args, **kwargs) |
e811c8ce RD |
5504 | |
5505 | def SetPosition(*args, **kwargs): | |
a95a7133 | 5506 | """SetPosition(self, Point pos)""" |
54f9ee45 | 5507 | return _core_.MoveEvent_SetPosition(*args, **kwargs) |
e811c8ce | 5508 | |
7557b9b5 RD |
5509 | m_pos = property(GetPosition, SetPosition) |
5510 | m_rect = property(GetRect, SetRect) | |
5511 | ||
57332a5a RD |
5512 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") |
5513 | Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`") | |
2131d850 | 5514 | _core_.MoveEvent_swigregister(MoveEvent) |
d14a1e28 RD |
5515 | |
5516 | #--------------------------------------------------------------------------- | |
5517 | ||
5518 | class PaintEvent(Event): | |
5ba5649b RD |
5519 | """ |
5520 | A paint event is sent when a window's contents needs to be repainted. | |
5521 | Note that in an EVT_PAINT handler the application must *always* create | |
5522 | a `wx.PaintDC` object, even if you do not use it. Otherwise MS | |
5523 | Windows assumes that the window has not been painted yet and will send | |
5524 | the event again, causing endless refreshes. | |
5525 | ||
5526 | You can optimize painting by retrieving the rectangles that have been | |
5527 | damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`, | |
5528 | and only repainting these rectangles. The rectangles are in terms of | |
5529 | the client area, and are unscrolled, so you will need to do some | |
5530 | calculations using the current view position to obtain logical, | |
5531 | scrolled units. | |
5532 | ||
5533 | """ | |
0085ce49 RD |
5534 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5535 | __repr__ = _swig_repr | |
5536 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5537 | """__init__(self, int Id=0) -> PaintEvent""" |
0085ce49 | 5538 | _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs)) |
2131d850 | 5539 | _core_.PaintEvent_swigregister(PaintEvent) |
d14a1e28 RD |
5540 | |
5541 | class NcPaintEvent(Event): | |
093d3ff1 | 5542 | """Proxy of C++ NcPaintEvent class""" |
0085ce49 RD |
5543 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5544 | __repr__ = _swig_repr | |
5545 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5546 | """__init__(self, int winid=0) -> NcPaintEvent""" |
0085ce49 | 5547 | _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs)) |
2131d850 | 5548 | _core_.NcPaintEvent_swigregister(NcPaintEvent) |
d14a1e28 RD |
5549 | |
5550 | #--------------------------------------------------------------------------- | |
5551 | ||
5552 | class EraseEvent(Event): | |
5ba5649b RD |
5553 | """ |
5554 | An erase event is sent whenever the background of a window needs to be | |
5555 | repainted. To intercept this event use the EVT_ERASE_BACKGROUND event | |
5556 | binder. On some platforms, such as GTK+, this event is simulated | |
5557 | (simply generated just before the paint event) and may cause flicker. | |
5558 | ||
5559 | To paint a custom background use the `GetDC` method and use the returned | |
5560 | device context if it is not ``None``, otherwise create a temporary | |
5561 | `wx.ClientDC` and draw on that. | |
5562 | ||
5563 | """ | |
0085ce49 RD |
5564 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5565 | __repr__ = _swig_repr | |
5566 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5567 | """ |
5568 | __init__(self, int Id=0, DC dc=None) -> EraseEvent | |
5569 | ||
5570 | Constructor | |
5571 | """ | |
0085ce49 | 5572 | _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs)) |
e811c8ce | 5573 | def GetDC(*args, **kwargs): |
5ba5649b RD |
5574 | """ |
5575 | GetDC(self) -> DC | |
5576 | ||
5577 | Returns the device context the event handler should draw upon. If | |
5578 | ``None`` is returned then create a temporary `wx.ClientDC` and use | |
5579 | that instead. | |
5580 | """ | |
54f9ee45 | 5581 | return _core_.EraseEvent_GetDC(*args, **kwargs) |
e811c8ce | 5582 | |
97ab0f6a | 5583 | DC = property(GetDC,doc="See `GetDC`") |
2131d850 | 5584 | _core_.EraseEvent_swigregister(EraseEvent) |
d14a1e28 RD |
5585 | |
5586 | #--------------------------------------------------------------------------- | |
5587 | ||
5588 | class FocusEvent(Event): | |
5ba5649b RD |
5589 | """ |
5590 | A focus event is sent when a window's focus changes. The window losing | |
5591 | focus receives an EVT_KILL_FOCUS event while the window gaining it | |
5592 | gets an EVT_SET_FOCUS event. | |
5593 | ||
5594 | Notice that the set focus event happens both when the user gives focus | |
5595 | to the window (whether using the mouse or keyboard) and when it is | |
5596 | done from the program itself using `wx.Window.SetFocus`. | |
5597 | ||
5598 | """ | |
0085ce49 RD |
5599 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5600 | __repr__ = _swig_repr | |
5601 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5602 | """ |
2131d850 | 5603 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent |
5ba5649b RD |
5604 | |
5605 | Constructor | |
5606 | """ | |
0085ce49 | 5607 | _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs)) |
e811c8ce | 5608 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
5609 | """ |
5610 | GetWindow(self) -> Window | |
5611 | ||
5612 | Returns the other window associated with this event, that is the | |
5613 | window which had the focus before for the EVT_SET_FOCUS event and the | |
5614 | window which is going to receive focus for the wxEVT_KILL_FOCUS event. | |
5615 | ||
5616 | Warning: the window returned may be None! | |
5617 | """ | |
54f9ee45 | 5618 | return _core_.FocusEvent_GetWindow(*args, **kwargs) |
e811c8ce RD |
5619 | |
5620 | def SetWindow(*args, **kwargs): | |
a95a7133 | 5621 | """SetWindow(self, Window win)""" |
54f9ee45 | 5622 | return _core_.FocusEvent_SetWindow(*args, **kwargs) |
e811c8ce | 5623 | |
97ab0f6a | 5624 | Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`") |
2131d850 | 5625 | _core_.FocusEvent_swigregister(FocusEvent) |
d14a1e28 RD |
5626 | |
5627 | #--------------------------------------------------------------------------- | |
5628 | ||
5629 | class ChildFocusEvent(CommandEvent): | |
5ba5649b | 5630 | """ |
33d6fd3b RD |
5631 | A child focus event is sent to a (parent-)window when one of its child |
5632 | windows gains focus, so that the window could restore the focus back | |
5633 | to its corresponding child if it loses it now and regains later. | |
5634 | ||
5635 | Notice that child window is the direct child of the window receiving | |
5636 | the event, and so may not be the actual widget recieving focus if it | |
5637 | is further down the containment heirarchy. Use `wx.Window.FindFocus` | |
5638 | to get the widget that is actually receiving focus. | |
5ba5649b | 5639 | """ |
0085ce49 RD |
5640 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5641 | __repr__ = _swig_repr | |
5642 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5643 | """ |
5644 | __init__(self, Window win=None) -> ChildFocusEvent | |
5645 | ||
5646 | Constructor | |
5647 | """ | |
0085ce49 | 5648 | _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs)) |
e811c8ce | 5649 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
5650 | """ |
5651 | GetWindow(self) -> Window | |
5652 | ||
33d6fd3b RD |
5653 | The window, or (grand)parent of the window which has just received the |
5654 | focus. | |
5ba5649b | 5655 | """ |
54f9ee45 | 5656 | return _core_.ChildFocusEvent_GetWindow(*args, **kwargs) |
e811c8ce | 5657 | |
2bf58437 | 5658 | Window = property(GetWindow,doc="See `GetWindow`") |
2131d850 | 5659 | _core_.ChildFocusEvent_swigregister(ChildFocusEvent) |
d14a1e28 RD |
5660 | |
5661 | #--------------------------------------------------------------------------- | |
5662 | ||
5663 | class ActivateEvent(Event): | |
5ba5649b RD |
5664 | """ |
5665 | An activate event is sent when a top-level window or the entire | |
5666 | application is being activated or deactivated. | |
5667 | ||
5668 | A top-level window (a dialog or frame) receives an activate event when | |
5669 | is being activated or deactivated. This is indicated visually by the | |
5670 | title bar changing colour, and a subwindow gaining the keyboard focus. | |
5671 | An application is activated or deactivated when one of its frames | |
5672 | becomes activated, or a frame becomes inactivate resulting in all | |
5673 | application frames being inactive. | |
5674 | ||
5675 | Please note that usually you should call event.Skip() in your handlers | |
5676 | for these events so the default handlers will still be called, as not | |
5677 | doing so can result in strange effects. | |
5678 | ||
5679 | """ | |
0085ce49 RD |
5680 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5681 | __repr__ = _swig_repr | |
5682 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5683 | """ |
2131d850 | 5684 | __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent |
5ba5649b RD |
5685 | |
5686 | Constructor | |
5687 | """ | |
0085ce49 | 5688 | _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs)) |
e811c8ce | 5689 | def GetActive(*args, **kwargs): |
5ba5649b RD |
5690 | """ |
5691 | GetActive(self) -> bool | |
5692 | ||
5693 | Returns true if the application or window is being activated, false | |
5694 | otherwise. | |
5695 | """ | |
54f9ee45 | 5696 | return _core_.ActivateEvent_GetActive(*args, **kwargs) |
e811c8ce | 5697 | |
2bf58437 | 5698 | Active = property(GetActive,doc="See `GetActive`") |
2131d850 | 5699 | _core_.ActivateEvent_swigregister(ActivateEvent) |
d14a1e28 RD |
5700 | |
5701 | #--------------------------------------------------------------------------- | |
5702 | ||
5703 | class InitDialogEvent(Event): | |
5ba5649b RD |
5704 | """ |
5705 | A wx.InitDialogEvent is sent as a dialog is being initialised, or for | |
5706 | any window when `wx.Window.InitDialog` is called. Handlers for this | |
5707 | event can transfer data to the window, or anything else that should be | |
5708 | done before the user begins editing the form. The default handler | |
5709 | calls `wx.Window.TransferDataToWindow`. | |
5710 | """ | |
0085ce49 RD |
5711 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5712 | __repr__ = _swig_repr | |
5713 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5714 | """ |
5715 | __init__(self, int Id=0) -> InitDialogEvent | |
5716 | ||
5717 | Constructor | |
5718 | """ | |
0085ce49 | 5719 | _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs)) |
2131d850 | 5720 | _core_.InitDialogEvent_swigregister(InitDialogEvent) |
d14a1e28 RD |
5721 | |
5722 | #--------------------------------------------------------------------------- | |
5723 | ||
5724 | class MenuEvent(Event): | |
5ba5649b RD |
5725 | """ |
5726 | This class is used for a variety of menu-related events. Note that | |
5727 | these do not include menu command events, which are handled by sending | |
5728 | `wx.CommandEvent` objects. | |
5729 | ||
5730 | The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help | |
5731 | text in the first field of the status bar. | |
5732 | """ | |
0085ce49 RD |
5733 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5734 | __repr__ = _swig_repr | |
5735 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5736 | """ |
2131d850 | 5737 | __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent |
5ba5649b RD |
5738 | |
5739 | Constructor | |
5740 | """ | |
0085ce49 | 5741 | _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs)) |
e811c8ce | 5742 | def GetMenuId(*args, **kwargs): |
5ba5649b RD |
5743 | """ |
5744 | GetMenuId(self) -> int | |
5745 | ||
5746 | Returns the menu identifier associated with the event. This method | |
5747 | should be only used with the HIGHLIGHT events. | |
5748 | """ | |
54f9ee45 | 5749 | return _core_.MenuEvent_GetMenuId(*args, **kwargs) |
e811c8ce RD |
5750 | |
5751 | def IsPopup(*args, **kwargs): | |
5ba5649b RD |
5752 | """ |
5753 | IsPopup(self) -> bool | |
5754 | ||
5755 | Returns ``True`` if the menu which is being opened or closed is a | |
5756 | popup menu, ``False`` if it is a normal one. This method should only | |
5757 | be used with the OPEN and CLOSE events. | |
5758 | """ | |
54f9ee45 | 5759 | return _core_.MenuEvent_IsPopup(*args, **kwargs) |
e811c8ce RD |
5760 | |
5761 | def GetMenu(*args, **kwargs): | |
5ba5649b RD |
5762 | """ |
5763 | GetMenu(self) -> Menu | |
5764 | ||
5765 | Returns the menu which is being opened or closed. This method should | |
5766 | only be used with the OPEN and CLOSE events. | |
5767 | """ | |
54f9ee45 | 5768 | return _core_.MenuEvent_GetMenu(*args, **kwargs) |
e811c8ce | 5769 | |
57332a5a RD |
5770 | Menu = property(GetMenu,doc="See `GetMenu`") |
5771 | MenuId = property(GetMenuId,doc="See `GetMenuId`") | |
2131d850 | 5772 | _core_.MenuEvent_swigregister(MenuEvent) |
d14a1e28 RD |
5773 | |
5774 | #--------------------------------------------------------------------------- | |
5775 | ||
5776 | class CloseEvent(Event): | |
5ba5649b RD |
5777 | """ |
5778 | This event class contains information about window and session close | |
5779 | events. | |
5780 | ||
5781 | The handler function for EVT_CLOSE is called when the user has tried | |
5782 | to close a a frame or dialog box using the window manager controls or | |
5783 | the system menu. It can also be invoked by the application itself | |
5784 | programmatically, for example by calling the `wx.Window.Close` | |
5785 | function. | |
5786 | ||
5787 | You should check whether the application is forcing the deletion of | |
5788 | the window using `CanVeto`. If it returns ``False``, you must destroy | |
5789 | the window using `wx.Window.Destroy`. If the return value is ``True``, | |
5790 | it is up to you whether you respond by destroying the window or not. | |
5791 | For example you may wish to display a message dialog prompting to save | |
5792 | files or to cancel the close. | |
5793 | ||
5794 | If you don't destroy the window, you should call `Veto` to let the | |
5795 | calling code know that you did not destroy the window. This allows the | |
5796 | `wx.Window.Close` function to return ``True`` or ``False`` depending | |
5797 | on whether the close instruction was honored or not. | |
5798 | """ | |
0085ce49 RD |
5799 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5800 | __repr__ = _swig_repr | |
5801 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5802 | """ |
2131d850 | 5803 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent |
5ba5649b RD |
5804 | |
5805 | Constructor. | |
5806 | """ | |
0085ce49 | 5807 | _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs)) |
e811c8ce | 5808 | def SetLoggingOff(*args, **kwargs): |
5ba5649b RD |
5809 | """ |
5810 | SetLoggingOff(self, bool logOff) | |
5811 | ||
5812 | Sets the 'logging off' flag. | |
5813 | """ | |
54f9ee45 | 5814 | return _core_.CloseEvent_SetLoggingOff(*args, **kwargs) |
e811c8ce RD |
5815 | |
5816 | def GetLoggingOff(*args, **kwargs): | |
5ba5649b RD |
5817 | """ |
5818 | GetLoggingOff(self) -> bool | |
5819 | ||
6c75a4cf RD |
5820 | Returns ``True`` if the user is logging off or ``False`` if the |
5821 | system is shutting down. This method can only be called for end | |
5822 | session and query end session events, it doesn't make sense for close | |
5823 | window event. | |
5ba5649b | 5824 | """ |
54f9ee45 | 5825 | return _core_.CloseEvent_GetLoggingOff(*args, **kwargs) |
e811c8ce RD |
5826 | |
5827 | def Veto(*args, **kwargs): | |
5ba5649b RD |
5828 | """ |
5829 | Veto(self, bool veto=True) | |
5830 | ||
5831 | Call this from your event handler to veto a system shutdown or to | |
5832 | signal to the calling application that a window close did not happen. | |
5833 | ||
5834 | You can only veto a shutdown or close if `CanVeto` returns true. | |
5835 | """ | |
54f9ee45 | 5836 | return _core_.CloseEvent_Veto(*args, **kwargs) |
e811c8ce | 5837 | |
5ba5649b RD |
5838 | def GetVeto(*args, **kwargs): |
5839 | """GetVeto(self) -> bool""" | |
5840 | return _core_.CloseEvent_GetVeto(*args, **kwargs) | |
5841 | ||
e811c8ce | 5842 | def SetCanVeto(*args, **kwargs): |
5ba5649b RD |
5843 | """ |
5844 | SetCanVeto(self, bool canVeto) | |
5845 | ||
5846 | Sets the 'can veto' flag. | |
5847 | """ | |
54f9ee45 | 5848 | return _core_.CloseEvent_SetCanVeto(*args, **kwargs) |
e811c8ce RD |
5849 | |
5850 | def CanVeto(*args, **kwargs): | |
5ba5649b RD |
5851 | """ |
5852 | CanVeto(self) -> bool | |
e811c8ce | 5853 | |
5ba5649b RD |
5854 | Returns true if you can veto a system shutdown or a window close |
5855 | event. Vetoing a window close event is not possible if the calling | |
5856 | code wishes to force the application to exit, and so this function | |
5857 | must be called to check this. | |
5858 | """ | |
5859 | return _core_.CloseEvent_CanVeto(*args, **kwargs) | |
e811c8ce | 5860 | |
2bf58437 | 5861 | LoggingOff = property(GetLoggingOff,SetLoggingOff,doc="See `GetLoggingOff` and `SetLoggingOff`") |
2131d850 | 5862 | _core_.CloseEvent_swigregister(CloseEvent) |
d14a1e28 RD |
5863 | |
5864 | #--------------------------------------------------------------------------- | |
5865 | ||
5866 | class ShowEvent(Event): | |
5ba5649b | 5867 | """An EVT_SHOW event is sent when a window is shown or hidden.""" |
0085ce49 RD |
5868 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5869 | __repr__ = _swig_repr | |
5870 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5871 | """ |
5872 | __init__(self, int winid=0, bool show=False) -> ShowEvent | |
5873 | ||
5874 | An EVT_SHOW event is sent when a window is shown or hidden. | |
5875 | """ | |
0085ce49 | 5876 | _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs)) |
e811c8ce | 5877 | def SetShow(*args, **kwargs): |
a95a7133 | 5878 | """SetShow(self, bool show)""" |
54f9ee45 | 5879 | return _core_.ShowEvent_SetShow(*args, **kwargs) |
e811c8ce RD |
5880 | |
5881 | def GetShow(*args, **kwargs): | |
a95a7133 | 5882 | """GetShow(self) -> bool""" |
54f9ee45 | 5883 | return _core_.ShowEvent_GetShow(*args, **kwargs) |
e811c8ce | 5884 | |
33d6fd3b | 5885 | Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`") |
2131d850 | 5886 | _core_.ShowEvent_swigregister(ShowEvent) |
d14a1e28 RD |
5887 | |
5888 | #--------------------------------------------------------------------------- | |
5889 | ||
5890 | class IconizeEvent(Event): | |
5ba5649b RD |
5891 | """ |
5892 | An EVT_ICONIZE event is sent when a frame is iconized (minimized) or | |
5893 | restored. | |
5894 | """ | |
0085ce49 RD |
5895 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5896 | __repr__ = _swig_repr | |
5897 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5898 | """ |
5899 | __init__(self, int id=0, bool iconized=True) -> IconizeEvent | |
5900 | ||
5901 | An EVT_ICONIZE event is sent when a frame is iconized (minimized) or | |
5902 | restored. | |
5903 | """ | |
0085ce49 | 5904 | _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs)) |
e811c8ce | 5905 | def Iconized(*args, **kwargs): |
5ba5649b RD |
5906 | """ |
5907 | Iconized(self) -> bool | |
5908 | ||
5909 | Returns ``True`` if the frame has been iconized, ``False`` if it has | |
5910 | been restored. | |
5911 | """ | |
54f9ee45 | 5912 | return _core_.IconizeEvent_Iconized(*args, **kwargs) |
e811c8ce | 5913 | |
2131d850 | 5914 | _core_.IconizeEvent_swigregister(IconizeEvent) |
d14a1e28 RD |
5915 | |
5916 | #--------------------------------------------------------------------------- | |
5917 | ||
5918 | class MaximizeEvent(Event): | |
5ba5649b | 5919 | """An EVT_MAXIMIZE event is sent when a frame is maximized or restored.""" |
0085ce49 RD |
5920 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5921 | __repr__ = _swig_repr | |
5922 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5923 | """ |
5924 | __init__(self, int id=0) -> MaximizeEvent | |
5925 | ||
5926 | An EVT_MAXIMIZE event is sent when a frame is maximized or restored. | |
5927 | """ | |
0085ce49 | 5928 | _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs)) |
2131d850 | 5929 | _core_.MaximizeEvent_swigregister(MaximizeEvent) |
d14a1e28 RD |
5930 | |
5931 | #--------------------------------------------------------------------------- | |
5932 | ||
5933 | class DropFilesEvent(Event): | |
5ba5649b RD |
5934 | """ |
5935 | This class is used for drop files events, that is, when files have | |
5936 | been dropped onto the window. This functionality is only available | |
5937 | under Windows. The window must have previously been enabled for | |
5938 | dropping by calling `wx.Window.DragAcceptFiles`. | |
5939 | ||
5940 | Important note: this is a separate implementation to the more general | |
5941 | drag and drop implementation using `wx.FileDropTarget`, and etc. This | |
5942 | implementation uses the older, Windows message-based approach of | |
5943 | dropping files. | |
5944 | ||
5945 | Use wx.EVT_DROP_FILES to bind an event handler to receive file drop | |
5946 | events. | |
5947 | ||
5948 | """ | |
0085ce49 RD |
5949 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5950 | def __init__(self): raise AttributeError, "No constructor defined" | |
5951 | __repr__ = _swig_repr | |
e811c8ce | 5952 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
5953 | """ |
5954 | GetPosition(self) -> Point | |
5955 | ||
5956 | Returns the position at which the files were dropped. | |
5957 | """ | |
54f9ee45 | 5958 | return _core_.DropFilesEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
5959 | |
5960 | def GetNumberOfFiles(*args, **kwargs): | |
5ba5649b RD |
5961 | """ |
5962 | GetNumberOfFiles(self) -> int | |
5963 | ||
5964 | Returns the number of files dropped. | |
5965 | """ | |
54f9ee45 | 5966 | return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs) |
e811c8ce RD |
5967 | |
5968 | def GetFiles(*args, **kwargs): | |
5ba5649b RD |
5969 | """ |
5970 | GetFiles(self) -> PyObject | |
5971 | ||
5972 | Returns a list of the filenames that were dropped. | |
5973 | """ | |
54f9ee45 | 5974 | return _core_.DropFilesEvent_GetFiles(*args, **kwargs) |
e811c8ce | 5975 | |
2bf58437 RD |
5976 | Files = property(GetFiles,doc="See `GetFiles`") |
5977 | NumberOfFiles = property(GetNumberOfFiles,doc="See `GetNumberOfFiles`") | |
5978 | Position = property(GetPosition,doc="See `GetPosition`") | |
2131d850 | 5979 | _core_.DropFilesEvent_swigregister(DropFilesEvent) |
d14a1e28 RD |
5980 | |
5981 | #--------------------------------------------------------------------------- | |
5982 | ||
54f9ee45 RD |
5983 | UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL |
5984 | UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED | |
d14a1e28 | 5985 | class UpdateUIEvent(CommandEvent): |
5ba5649b RD |
5986 | """ |
5987 | This class is used for EVT_UPDATE_UI pseudo-events which are sent by | |
5988 | wxWidgets to give an application the chance to update various user | |
5989 | interface elements. | |
5990 | ||
5991 | Without update UI events, an application has to work hard to | |
5992 | check/uncheck, enable/disable, and set the text for elements such as | |
5993 | menu items and toolbar buttons. The code for doing this has to be | |
5994 | mixed up with the code that is invoked when an action is invoked for a | |
5995 | menu item or button. | |
5996 | ||
5997 | With update UI events, you define an event handler to look at the | |
5998 | state of the application and change UI elements accordingly. wxWidgets | |
5999 | will call your handler functions in idle time, so you don't have to | |
6000 | worry where to call this code. In addition to being a clearer and more | |
6001 | declarative method, it also means you don't have to worry whether | |
6002 | you're updating a toolbar or menubar identifier. The same handler can | |
6003 | update a menu item and toolbar button, if the ID values are the same. | |
6004 | ||
6005 | Instead of directly manipulating the menu or button, you call | |
6006 | functions in the event object, such as `Check`. wxWidgets will | |
6007 | determine whether such a call has been made, and which UI element to | |
6008 | update. | |
6009 | ||
6010 | These events will work for popup menus as well as menubars. Just | |
6011 | before a menu is popped up, `wx.Menu.UpdateUI` is called to process | |
6012 | any UI events for the window that owns the menu. | |
6013 | ||
6014 | If you find that the overhead of UI update processing is affecting | |
6015 | your application, you can do one or both of the following: | |
6016 | ||
6017 | 1. Call `wx.UpdateUIEvent.SetMode` with a value of | |
6018 | wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style | |
6019 | wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should | |
6020 | receive update events. No other windows will receive update | |
6021 | events. | |
6022 | ||
6023 | 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond | |
6024 | value to set the delay between updates. You may need to call | |
6025 | `wx.Window.UpdateWindowUI` at critical points, for example when | |
6026 | a dialog is about to be shown, in case the user sees a slight | |
6027 | delay before windows are updated. | |
6028 | ||
6029 | Note that although events are sent in idle time, defining a EVT_IDLE | |
6030 | handler for a window does not affect this because the events are sent | |
6031 | from an internal idle handler. | |
6032 | ||
6033 | wxWidgets tries to optimize update events on some platforms. On | |
6034 | Windows and GTK+, events for menubar items are only sent when the menu | |
6035 | is about to be shown, and not in idle time. | |
6036 | ||
6037 | """ | |
0085ce49 RD |
6038 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6039 | __repr__ = _swig_repr | |
6040 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6041 | """ |
6042 | __init__(self, int commandId=0) -> UpdateUIEvent | |
6043 | ||
6044 | Constructor | |
6045 | """ | |
0085ce49 | 6046 | _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs)) |
e811c8ce | 6047 | def GetChecked(*args, **kwargs): |
5ba5649b RD |
6048 | """ |
6049 | GetChecked(self) -> bool | |
6050 | ||
6051 | Returns ``True`` if the UI element should be checked. | |
6052 | """ | |
54f9ee45 | 6053 | return _core_.UpdateUIEvent_GetChecked(*args, **kwargs) |
e811c8ce RD |
6054 | |
6055 | def GetEnabled(*args, **kwargs): | |
5ba5649b RD |
6056 | """ |
6057 | GetEnabled(self) -> bool | |
6058 | ||
6059 | Returns ``True`` if the UI element should be enabled. | |
6060 | """ | |
54f9ee45 | 6061 | return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs) |
e811c8ce | 6062 | |
b1fcee84 RD |
6063 | def GetShown(*args, **kwargs): |
6064 | """ | |
6065 | GetShown(self) -> bool | |
6066 | ||
6067 | Returns ``True`` if the UI element should be shown. | |
6068 | """ | |
6069 | return _core_.UpdateUIEvent_GetShown(*args, **kwargs) | |
6070 | ||
e811c8ce | 6071 | def GetText(*args, **kwargs): |
5ba5649b RD |
6072 | """ |
6073 | GetText(self) -> String | |
6074 | ||
6075 | Returns the text that should be set for the UI element. | |
6076 | """ | |
54f9ee45 | 6077 | return _core_.UpdateUIEvent_GetText(*args, **kwargs) |
e811c8ce RD |
6078 | |
6079 | def GetSetText(*args, **kwargs): | |
5ba5649b RD |
6080 | """ |
6081 | GetSetText(self) -> bool | |
6082 | ||
6083 | Returns ``True`` if the application has called `SetText`. For | |
6084 | wxWidgets internal use only. | |
6085 | """ | |
54f9ee45 | 6086 | return _core_.UpdateUIEvent_GetSetText(*args, **kwargs) |
e811c8ce RD |
6087 | |
6088 | def GetSetChecked(*args, **kwargs): | |
5ba5649b RD |
6089 | """ |
6090 | GetSetChecked(self) -> bool | |
6091 | ||
6092 | Returns ``True`` if the application has called `Check`. For wxWidgets | |
6093 | internal use only. | |
6094 | """ | |
54f9ee45 | 6095 | return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs) |
e811c8ce RD |
6096 | |
6097 | def GetSetEnabled(*args, **kwargs): | |
5ba5649b RD |
6098 | """ |
6099 | GetSetEnabled(self) -> bool | |
6100 | ||
6101 | Returns ``True`` if the application has called `Enable`. For wxWidgets | |
6102 | internal use only. | |
6103 | """ | |
54f9ee45 | 6104 | return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs) |
e811c8ce | 6105 | |
b1fcee84 RD |
6106 | def GetSetShown(*args, **kwargs): |
6107 | """ | |
6108 | GetSetShown(self) -> bool | |
6109 | ||
6110 | Returns ``True`` if the application has called `Show`. For wxWidgets | |
6111 | internal use only. | |
6112 | """ | |
6113 | return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs) | |
6114 | ||
e811c8ce | 6115 | def Check(*args, **kwargs): |
5ba5649b RD |
6116 | """ |
6117 | Check(self, bool check) | |
6118 | ||
6119 | Check or uncheck the UI element. | |
6120 | """ | |
54f9ee45 | 6121 | return _core_.UpdateUIEvent_Check(*args, **kwargs) |
e811c8ce RD |
6122 | |
6123 | def Enable(*args, **kwargs): | |
5ba5649b RD |
6124 | """ |
6125 | Enable(self, bool enable) | |
6126 | ||
6127 | Enable or disable the UI element. | |
6128 | """ | |
54f9ee45 | 6129 | return _core_.UpdateUIEvent_Enable(*args, **kwargs) |
e811c8ce | 6130 | |
b1fcee84 RD |
6131 | def Show(*args, **kwargs): |
6132 | """ | |
6133 | Show(self, bool show) | |
6134 | ||
6135 | Show or hide the UI element. | |
6136 | """ | |
6137 | return _core_.UpdateUIEvent_Show(*args, **kwargs) | |
6138 | ||
e811c8ce | 6139 | def SetText(*args, **kwargs): |
5ba5649b RD |
6140 | """ |
6141 | SetText(self, String text) | |
6142 | ||
6143 | Sets the text for this UI element. | |
6144 | """ | |
54f9ee45 | 6145 | return _core_.UpdateUIEvent_SetText(*args, **kwargs) |
e811c8ce RD |
6146 | |
6147 | def SetUpdateInterval(*args, **kwargs): | |
5ba5649b RD |
6148 | """ |
6149 | SetUpdateInterval(long updateInterval) | |
6150 | ||
6151 | Sets the interval between updates in milliseconds. Set to -1 to | |
6152 | disable updates, or to 0 to update as frequently as possible. The | |
6153 | default is 0. | |
6154 | ||
6155 | Use this to reduce the overhead of UI update events if your | |
6156 | application has a lot of windows. If you set the value to -1 or | |
6157 | greater than 0, you may also need to call `wx.Window.UpdateWindowUI` | |
6158 | at appropriate points in your application, such as when a dialog is | |
6159 | about to be shown. | |
6160 | """ | |
54f9ee45 | 6161 | return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs) |
e811c8ce RD |
6162 | |
6163 | SetUpdateInterval = staticmethod(SetUpdateInterval) | |
6164 | def GetUpdateInterval(*args, **kwargs): | |
5ba5649b RD |
6165 | """ |
6166 | GetUpdateInterval() -> long | |
6167 | ||
6168 | Returns the current interval between updates in milliseconds. -1 | |
6169 | disables updates, 0 updates as frequently as possible. | |
6170 | """ | |
54f9ee45 | 6171 | return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs) |
e811c8ce RD |
6172 | |
6173 | GetUpdateInterval = staticmethod(GetUpdateInterval) | |
6174 | def CanUpdate(*args, **kwargs): | |
5ba5649b RD |
6175 | """ |
6176 | CanUpdate(Window win) -> bool | |
6177 | ||
6178 | Returns ``True`` if it is appropriate to update (send UI update events | |
6179 | to) this window. | |
6180 | ||
6181 | This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`), | |
6182 | the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update | |
6183 | events were last sent in idle time, and the update interval, to | |
6184 | determine whether events should be sent to this window now. By default | |
6185 | this will always return true because the update mode is initially | |
6186 | wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update | |
6187 | events will be sent as often as possible. You can reduce the frequency | |
6188 | that events are sent by changing the mode and/or setting an update | |
6189 | interval. | |
6190 | ||
6191 | """ | |
54f9ee45 | 6192 | return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs) |
e811c8ce RD |
6193 | |
6194 | CanUpdate = staticmethod(CanUpdate) | |
6195 | def ResetUpdateTime(*args, **kwargs): | |
5ba5649b RD |
6196 | """ |
6197 | ResetUpdateTime() | |
6198 | ||
6199 | Used internally to reset the last-updated time to the current time. It | |
6200 | is assumed that update events are normally sent in idle time, so this | |
6201 | is called at the end of idle processing. | |
6202 | """ | |
54f9ee45 | 6203 | return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs) |
e811c8ce RD |
6204 | |
6205 | ResetUpdateTime = staticmethod(ResetUpdateTime) | |
6206 | def SetMode(*args, **kwargs): | |
5ba5649b RD |
6207 | """ |
6208 | SetMode(int mode) | |
6209 | ||
6210 | Specify how wxWidgets will send update events: to all windows, or only | |
6211 | to those which specify that they will process the events. | |
6212 | ||
6213 | The mode may be one of the following values: | |
6214 | ||
6215 | ============================= ========================================== | |
6216 | wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This | |
6217 | is the default setting. | |
6218 | wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that | |
6219 | have the wx.WS_EX_PROCESS_UI_UPDATES extra | |
6220 | style set. | |
6221 | ============================= ========================================== | |
6222 | ||
6223 | """ | |
54f9ee45 | 6224 | return _core_.UpdateUIEvent_SetMode(*args, **kwargs) |
e811c8ce RD |
6225 | |
6226 | SetMode = staticmethod(SetMode) | |
6227 | def GetMode(*args, **kwargs): | |
5ba5649b RD |
6228 | """ |
6229 | GetMode() -> int | |
6230 | ||
6231 | Returns a value specifying how wxWidgets will send update events: to | |
6232 | all windows, or only to those which specify that they will process the | |
6233 | events. | |
6234 | """ | |
54f9ee45 | 6235 | return _core_.UpdateUIEvent_GetMode(*args, **kwargs) |
e811c8ce RD |
6236 | |
6237 | GetMode = staticmethod(GetMode) | |
dba7934c RD |
6238 | Checked = property(GetChecked,Check,doc="See `GetChecked`") |
6239 | Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`") | |
6240 | Shown = property(GetShown,Show,doc="See `GetShown`") | |
6241 | Text = property(GetText,SetText,doc="See `GetText` and `SetText`") | |
2131d850 | 6242 | _core_.UpdateUIEvent_swigregister(UpdateUIEvent) |
d14a1e28 | 6243 | |
e811c8ce | 6244 | def UpdateUIEvent_SetUpdateInterval(*args, **kwargs): |
0085ce49 | 6245 | """ |
5ba5649b RD |
6246 | UpdateUIEvent_SetUpdateInterval(long updateInterval) |
6247 | ||
6248 | Sets the interval between updates in milliseconds. Set to -1 to | |
6249 | disable updates, or to 0 to update as frequently as possible. The | |
6250 | default is 0. | |
6251 | ||
6252 | Use this to reduce the overhead of UI update events if your | |
6253 | application has a lot of windows. If you set the value to -1 or | |
6254 | greater than 0, you may also need to call `wx.Window.UpdateWindowUI` | |
6255 | at appropriate points in your application, such as when a dialog is | |
6256 | about to be shown. | |
6257 | """ | |
0085ce49 | 6258 | return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs) |
d14a1e28 | 6259 | |
0085ce49 RD |
6260 | def UpdateUIEvent_GetUpdateInterval(*args): |
6261 | """ | |
5ba5649b RD |
6262 | UpdateUIEvent_GetUpdateInterval() -> long |
6263 | ||
6264 | Returns the current interval between updates in milliseconds. -1 | |
6265 | disables updates, 0 updates as frequently as possible. | |
6266 | """ | |
0085ce49 | 6267 | return _core_.UpdateUIEvent_GetUpdateInterval(*args) |
d14a1e28 | 6268 | |
e811c8ce | 6269 | def UpdateUIEvent_CanUpdate(*args, **kwargs): |
0085ce49 | 6270 | """ |
5ba5649b RD |
6271 | UpdateUIEvent_CanUpdate(Window win) -> bool |
6272 | ||
6273 | Returns ``True`` if it is appropriate to update (send UI update events | |
6274 | to) this window. | |
6275 | ||
6276 | This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`), | |
6277 | the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update | |
6278 | events were last sent in idle time, and the update interval, to | |
6279 | determine whether events should be sent to this window now. By default | |
6280 | this will always return true because the update mode is initially | |
6281 | wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update | |
6282 | events will be sent as often as possible. You can reduce the frequency | |
6283 | that events are sent by changing the mode and/or setting an update | |
6284 | interval. | |
6285 | ||
6286 | """ | |
0085ce49 | 6287 | return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs) |
d14a1e28 | 6288 | |
0085ce49 RD |
6289 | def UpdateUIEvent_ResetUpdateTime(*args): |
6290 | """ | |
5ba5649b RD |
6291 | UpdateUIEvent_ResetUpdateTime() |
6292 | ||
6293 | Used internally to reset the last-updated time to the current time. It | |
6294 | is assumed that update events are normally sent in idle time, so this | |
6295 | is called at the end of idle processing. | |
6296 | """ | |
0085ce49 | 6297 | return _core_.UpdateUIEvent_ResetUpdateTime(*args) |
d14a1e28 | 6298 | |
e811c8ce | 6299 | def UpdateUIEvent_SetMode(*args, **kwargs): |
0085ce49 | 6300 | """ |
5ba5649b RD |
6301 | UpdateUIEvent_SetMode(int mode) |
6302 | ||
6303 | Specify how wxWidgets will send update events: to all windows, or only | |
6304 | to those which specify that they will process the events. | |
6305 | ||
6306 | The mode may be one of the following values: | |
6307 | ||
6308 | ============================= ========================================== | |
6309 | wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This | |
6310 | is the default setting. | |
6311 | wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that | |
6312 | have the wx.WS_EX_PROCESS_UI_UPDATES extra | |
6313 | style set. | |
6314 | ============================= ========================================== | |
6315 | ||
6316 | """ | |
0085ce49 | 6317 | return _core_.UpdateUIEvent_SetMode(*args, **kwargs) |
d14a1e28 | 6318 | |
0085ce49 RD |
6319 | def UpdateUIEvent_GetMode(*args): |
6320 | """ | |
5ba5649b RD |
6321 | UpdateUIEvent_GetMode() -> int |
6322 | ||
6323 | Returns a value specifying how wxWidgets will send update events: to | |
6324 | all windows, or only to those which specify that they will process the | |
6325 | events. | |
6326 | """ | |
0085ce49 | 6327 | return _core_.UpdateUIEvent_GetMode(*args) |
d14a1e28 RD |
6328 | |
6329 | #--------------------------------------------------------------------------- | |
6330 | ||
6331 | class SysColourChangedEvent(Event): | |
5ba5649b RD |
6332 | """ |
6333 | This class is used for EVT_SYS_COLOUR_CHANGED, which are generated | |
6334 | when the user changes the colour settings using the control | |
6335 | panel. This is only applicable under Windows. | |
6336 | ||
6337 | The default event handler for this event propagates the event to child | |
6338 | windows, since Windows only sends the events to top-level windows. If | |
6339 | intercepting this event for a top-level window, remember to call | |
6340 | `Skip` so the the base class handler will still be executed, or to | |
6341 | pass the event on to the window's children explicitly. | |
6342 | ||
6343 | """ | |
0085ce49 RD |
6344 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6345 | __repr__ = _swig_repr | |
6346 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6347 | """ |
6348 | __init__(self) -> SysColourChangedEvent | |
6349 | ||
6350 | Constructor | |
6351 | """ | |
0085ce49 | 6352 | _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs)) |
2131d850 | 6353 | _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent) |
d14a1e28 RD |
6354 | |
6355 | #--------------------------------------------------------------------------- | |
6356 | ||
6357 | class MouseCaptureChangedEvent(Event): | |
5ba5649b RD |
6358 | """ |
6359 | An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to | |
6360 | a window that loses its mouse capture. This is called even if | |
6361 | `wx.Window.ReleaseMouse` was called by the application code. Handling | |
6362 | this event allows an application to cater for unexpected capture | |
6363 | releases which might otherwise confuse mouse handling code. | |
6364 | ||
6365 | This event is implemented under Windows only. | |
6366 | """ | |
0085ce49 RD |
6367 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6368 | __repr__ = _swig_repr | |
6369 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6370 | """ |
6371 | __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent | |
6372 | ||
6373 | Constructor | |
6374 | """ | |
0085ce49 | 6375 | _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs)) |
e811c8ce | 6376 | def GetCapturedWindow(*args, **kwargs): |
5ba5649b RD |
6377 | """ |
6378 | GetCapturedWindow(self) -> Window | |
6379 | ||
6380 | Returns the window that gained the capture, or ``None`` if it was a | |
6381 | non-wxWidgets window. | |
6382 | """ | |
54f9ee45 | 6383 | return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs) |
e811c8ce | 6384 | |
57332a5a | 6385 | CapturedWindow = property(GetCapturedWindow,doc="See `GetCapturedWindow`") |
2131d850 | 6386 | _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent) |
d14a1e28 RD |
6387 | |
6388 | #--------------------------------------------------------------------------- | |
6389 | ||
34e0a3bb RD |
6390 | class MouseCaptureLostEvent(Event): |
6391 | """ | |
6392 | A mouse capture lost event is sent to a window that obtained mouse | |
6393 | capture, which was subsequently loss due to "external" event, for | |
6394 | example when a dialog box is shown or if another application captures | |
6395 | the mouse. | |
6396 | ||
6397 | If this happens, this event is sent to all windows that are on the | |
6398 | capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but | |
6399 | didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent | |
6400 | if the capture changes because of a call to CaptureMouse or | |
6401 | ReleaseMouse. | |
6402 | ||
6403 | This event is currently emitted under Windows only. | |
6404 | ||
6405 | """ | |
6406 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
6407 | __repr__ = _swig_repr | |
6408 | def __init__(self, *args, **kwargs): | |
6409 | """ | |
6410 | __init__(self, int winid=0) -> MouseCaptureLostEvent | |
6411 | ||
6412 | A mouse capture lost event is sent to a window that obtained mouse | |
6413 | capture, which was subsequently loss due to "external" event, for | |
6414 | example when a dialog box is shown or if another application captures | |
6415 | the mouse. | |
6416 | ||
6417 | If this happens, this event is sent to all windows that are on the | |
6418 | capture stack (i.e. a window that called `wx.Window.CaptureMouse`, but | |
6419 | didn't call `wx.Window.ReleaseMouse` yet). The event is *not* sent | |
6420 | if the capture changes because of a call to CaptureMouse or | |
6421 | ReleaseMouse. | |
6422 | ||
6423 | This event is currently emitted under Windows only. | |
6424 | ||
6425 | """ | |
6426 | _core_.MouseCaptureLostEvent_swiginit(self,_core_.new_MouseCaptureLostEvent(*args, **kwargs)) | |
6427 | _core_.MouseCaptureLostEvent_swigregister(MouseCaptureLostEvent) | |
6428 | ||
6429 | #--------------------------------------------------------------------------- | |
6430 | ||
d14a1e28 | 6431 | class DisplayChangedEvent(Event): |
5ba5649b RD |
6432 | """ |
6433 | An EVT_DISPLAY_CHANGED event is sent to all windows when the display | |
6434 | resolution has changed. | |
6435 | ||
6436 | This event is implemented under Windows only. | |
6437 | """ | |
0085ce49 RD |
6438 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6439 | __repr__ = _swig_repr | |
6440 | def __init__(self, *args, **kwargs): | |
a95a7133 | 6441 | """__init__(self) -> DisplayChangedEvent""" |
0085ce49 | 6442 | _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs)) |
2131d850 | 6443 | _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent) |
d14a1e28 RD |
6444 | |
6445 | #--------------------------------------------------------------------------- | |
6446 | ||
6447 | class PaletteChangedEvent(Event): | |
5ba5649b RD |
6448 | """ |
6449 | An EVT_PALETTE_CHANGED event is sent when the system palette has | |
6450 | changed, thereby giving each window a chance to redo their own to | |
6451 | match. | |
6452 | ||
6453 | This event is implemented under Windows only. | |
6454 | """ | |
0085ce49 RD |
6455 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6456 | __repr__ = _swig_repr | |
6457 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6458 | """ |
6459 | __init__(self, int id=0) -> PaletteChangedEvent | |
6460 | ||
6461 | An EVT_PALETTE_CHANGED event is sent when the system palette has | |
6462 | changed, thereby giving each window a chance to redo their own to | |
6463 | match. | |
6464 | ||
6465 | This event is implemented under Windows only. | |
6466 | """ | |
0085ce49 | 6467 | _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs)) |
e811c8ce | 6468 | def SetChangedWindow(*args, **kwargs): |
a95a7133 | 6469 | """SetChangedWindow(self, Window win)""" |
54f9ee45 | 6470 | return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs) |
e811c8ce RD |
6471 | |
6472 | def GetChangedWindow(*args, **kwargs): | |
a95a7133 | 6473 | """GetChangedWindow(self) -> Window""" |
54f9ee45 | 6474 | return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs) |
e811c8ce | 6475 | |
33d6fd3b | 6476 | ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`") |
2131d850 | 6477 | _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent) |
d14a1e28 RD |
6478 | |
6479 | #--------------------------------------------------------------------------- | |
6480 | ||
6481 | class QueryNewPaletteEvent(Event): | |
5ba5649b RD |
6482 | """ |
6483 | An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard | |
6484 | focus and should re-do its palette. | |
6485 | ||
6486 | This event is implemented under Windows only. | |
6487 | """ | |
0085ce49 RD |
6488 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6489 | __repr__ = _swig_repr | |
6490 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6491 | """ |
6492 | __init__(self, int winid=0) -> QueryNewPaletteEvent | |
6493 | ||
6494 | Constructor. | |
6495 | """ | |
0085ce49 | 6496 | _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs)) |
e811c8ce | 6497 | def SetPaletteRealized(*args, **kwargs): |
5ba5649b RD |
6498 | """ |
6499 | SetPaletteRealized(self, bool realized) | |
6500 | ||
6501 | App should set this if it changes the palette. | |
6502 | """ | |
54f9ee45 | 6503 | return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs) |
e811c8ce RD |
6504 | |
6505 | def GetPaletteRealized(*args, **kwargs): | |
a95a7133 | 6506 | """GetPaletteRealized(self) -> bool""" |
54f9ee45 | 6507 | return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs) |
e811c8ce | 6508 | |
33d6fd3b | 6509 | PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`") |
2131d850 | 6510 | _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent) |
d14a1e28 RD |
6511 | |
6512 | #--------------------------------------------------------------------------- | |
6513 | ||
6514 | class NavigationKeyEvent(Event): | |
5ba5649b RD |
6515 | """ |
6516 | EVT_NAVIGATION_KEY events are used to control moving the focus between | |
6517 | widgets, otherwise known as tab-traversal. You woudl normally not | |
6518 | catch navigation events in applications as there are already | |
6519 | appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find | |
6520 | it useful to send navigation events in certain situations to change | |
6521 | the focus in certain ways, although it's probably easier to just call | |
6522 | `wx.Window.Navigate`. | |
6523 | """ | |
0085ce49 RD |
6524 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6525 | __repr__ = _swig_repr | |
6526 | def __init__(self, *args, **kwargs): | |
a95a7133 | 6527 | """__init__(self) -> NavigationKeyEvent""" |
0085ce49 | 6528 | _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs)) |
e811c8ce | 6529 | def GetDirection(*args, **kwargs): |
5ba5649b RD |
6530 | """ |
6531 | GetDirection(self) -> bool | |
6532 | ||
6533 | Returns ``True`` if the direction is forward, ``False`` otherwise. | |
6534 | """ | |
54f9ee45 | 6535 | return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs) |
e811c8ce RD |
6536 | |
6537 | def SetDirection(*args, **kwargs): | |
5ba5649b RD |
6538 | """ |
6539 | SetDirection(self, bool forward) | |
6540 | ||
6541 | Specify the direction that the navigation should take. Usually the | |
6542 | difference between using Tab and Shift-Tab. | |
6543 | """ | |
54f9ee45 | 6544 | return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs) |
e811c8ce RD |
6545 | |
6546 | def IsWindowChange(*args, **kwargs): | |
5ba5649b RD |
6547 | """ |
6548 | IsWindowChange(self) -> bool | |
6549 | ||
6550 | Returns ``True`` if window change is allowed. | |
6551 | """ | |
54f9ee45 | 6552 | return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs) |
e811c8ce RD |
6553 | |
6554 | def SetWindowChange(*args, **kwargs): | |
5ba5649b RD |
6555 | """ |
6556 | SetWindowChange(self, bool ischange) | |
6557 | ||
6558 | Specify if the navigation should be able to change parent windows. | |
6559 | For example, changing notebook pages, etc. This is usually implemented | |
6560 | by using Control-Tab. | |
6561 | """ | |
54f9ee45 | 6562 | return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs) |
e811c8ce | 6563 | |
68350608 | 6564 | def IsFromTab(*args, **kwargs): |
5ba5649b RD |
6565 | """ |
6566 | IsFromTab(self) -> bool | |
6567 | ||
6568 | Returns ``True`` if the navigation event is originated from the Tab | |
6569 | key. | |
6570 | """ | |
68350608 RD |
6571 | return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs) |
6572 | ||
6573 | def SetFromTab(*args, **kwargs): | |
5ba5649b RD |
6574 | """ |
6575 | SetFromTab(self, bool bIs) | |
6576 | ||
6577 | Set to true under MSW if the event was generated using the tab key. | |
6578 | This is required for proper navogation over radio buttons. | |
6579 | """ | |
68350608 RD |
6580 | return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs) |
6581 | ||
908b74cd | 6582 | def SetFlags(*args, **kwargs): |
5ba5649b RD |
6583 | """ |
6584 | SetFlags(self, long flags) | |
6585 | ||
6586 | Set the navigation flags to a combination of the following: | |
6587 | ||
6588 | * wx.NavigationKeyEvent.IsBackward | |
6589 | * wx.NavigationKeyEvent.IsForward | |
6590 | * wx.NavigationKeyEvent.WinChange | |
6591 | * wx.NavigationKeyEvent.FromTab | |
6592 | ||
6593 | """ | |
908b74cd RD |
6594 | return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs) |
6595 | ||
e811c8ce | 6596 | def GetCurrentFocus(*args, **kwargs): |
5ba5649b RD |
6597 | """ |
6598 | GetCurrentFocus(self) -> Window | |
6599 | ||
6600 | Returns the child window which currenty has the focus. May be | |
6601 | ``None``. | |
6602 | """ | |
54f9ee45 | 6603 | return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs) |
e811c8ce RD |
6604 | |
6605 | def SetCurrentFocus(*args, **kwargs): | |
5ba5649b RD |
6606 | """ |
6607 | SetCurrentFocus(self, Window win) | |
6608 | ||
6609 | Set the window that has the focus. | |
6610 | """ | |
54f9ee45 | 6611 | return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs) |
e811c8ce | 6612 | |
b0f7404b | 6613 | IsBackward = _core_.NavigationKeyEvent_IsBackward |
908b74cd RD |
6614 | IsForward = _core_.NavigationKeyEvent_IsForward |
6615 | WinChange = _core_.NavigationKeyEvent_WinChange | |
68350608 | 6616 | FromTab = _core_.NavigationKeyEvent_FromTab |
57332a5a RD |
6617 | CurrentFocus = property(GetCurrentFocus,SetCurrentFocus,doc="See `GetCurrentFocus` and `SetCurrentFocus`") |
6618 | Direction = property(GetDirection,SetDirection,doc="See `GetDirection` and `SetDirection`") | |
2131d850 | 6619 | _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent) |
d14a1e28 RD |
6620 | |
6621 | #--------------------------------------------------------------------------- | |
6622 | ||
6623 | class WindowCreateEvent(CommandEvent): | |
5ba5649b RD |
6624 | """ |
6625 | The EVT_WINDOW_CREATE event is sent as soon as the window object (the | |
6626 | underlying GUI object) exists. | |
6627 | """ | |
0085ce49 RD |
6628 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6629 | __repr__ = _swig_repr | |
6630 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6631 | """ |
6632 | __init__(self, Window win=None) -> WindowCreateEvent | |
6633 | ||
6634 | The EVT_WINDOW_CREATE event is sent as soon as the window object (the | |
6635 | underlying GUI object) exists. | |
6636 | """ | |
0085ce49 | 6637 | _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs)) |
e811c8ce | 6638 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
6639 | """ |
6640 | GetWindow(self) -> Window | |
6641 | ||
6642 | Returns the window that this event refers to. | |
6643 | """ | |
54f9ee45 | 6644 | return _core_.WindowCreateEvent_GetWindow(*args, **kwargs) |
e811c8ce | 6645 | |
dba7934c | 6646 | Window = property(GetWindow,doc="See `GetWindow`") |
2131d850 | 6647 | _core_.WindowCreateEvent_swigregister(WindowCreateEvent) |
d14a1e28 RD |
6648 | |
6649 | class WindowDestroyEvent(CommandEvent): | |
5ba5649b | 6650 | """ |
943e8dfd RD |
6651 | The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor |
6652 | when the GUI window is destroyed. | |
6653 | ||
6654 | When a class derived from `wx.Window` is destroyed its destructor will | |
6655 | have already run by the time this event is sent. Therefore this event | |
6656 | will not usually be received at all by the window itself. Since it is | |
6657 | received after the destructor has run, an object should not try to | |
6658 | handle its own wx.WindowDestroyEvent, but it can be used to get | |
6659 | notification of the destruction of another window. | |
5ba5649b | 6660 | """ |
0085ce49 RD |
6661 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6662 | __repr__ = _swig_repr | |
6663 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6664 | """ |
6665 | __init__(self, Window win=None) -> WindowDestroyEvent | |
6666 | ||
943e8dfd RD |
6667 | The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor |
6668 | when the GUI window is destroyed. | |
6669 | ||
6670 | When a class derived from `wx.Window` is destroyed its destructor will | |
6671 | have already run by the time this event is sent. Therefore this event | |
6672 | will not usually be received at all by the window itself. Since it is | |
6673 | received after the destructor has run, an object should not try to | |
6674 | handle its own wx.WindowDestroyEvent, but it can be used to get | |
6675 | notification of the destruction of another window. | |
5ba5649b | 6676 | """ |
0085ce49 | 6677 | _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs)) |
e811c8ce | 6678 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
6679 | """ |
6680 | GetWindow(self) -> Window | |
6681 | ||
6682 | Returns the window that this event refers to. | |
6683 | """ | |
54f9ee45 | 6684 | return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs) |
e811c8ce | 6685 | |
dba7934c | 6686 | Window = property(GetWindow,doc="See `GetWindow`") |
2131d850 | 6687 | _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent) |
d14a1e28 RD |
6688 | |
6689 | #--------------------------------------------------------------------------- | |
6690 | ||
6691 | class ContextMenuEvent(CommandEvent): | |
5ba5649b RD |
6692 | """ |
6693 | This class is used for context menu events (EVT_CONTECT_MENU,) sent to | |
6694 | give the application a chance to show a context (popup) menu. | |
6695 | """ | |
0085ce49 RD |
6696 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6697 | __repr__ = _swig_repr | |
6698 | def __init__(self, *args, **kwargs): | |
5ba5649b | 6699 | """ |
2131d850 | 6700 | __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent |
5ba5649b RD |
6701 | |
6702 | Constructor. | |
6703 | """ | |
0085ce49 | 6704 | _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs)) |
e811c8ce | 6705 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
6706 | """ |
6707 | GetPosition(self) -> Point | |
6708 | ||
6709 | Returns the position (in screen coordinants) at which the menu should | |
6710 | be shown. | |
6711 | """ | |
54f9ee45 | 6712 | return _core_.ContextMenuEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
6713 | |
6714 | def SetPosition(*args, **kwargs): | |
5ba5649b RD |
6715 | """ |
6716 | SetPosition(self, Point pos) | |
6717 | ||
6718 | Sets the position at which the menu should be shown. | |
6719 | """ | |
54f9ee45 | 6720 | return _core_.ContextMenuEvent_SetPosition(*args, **kwargs) |
e811c8ce | 6721 | |
2bf58437 | 6722 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") |
2131d850 | 6723 | _core_.ContextMenuEvent_swigregister(ContextMenuEvent) |
d14a1e28 RD |
6724 | |
6725 | #--------------------------------------------------------------------------- | |
6726 | ||
54f9ee45 RD |
6727 | IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL |
6728 | IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED | |
d14a1e28 | 6729 | class IdleEvent(Event): |
5ba5649b RD |
6730 | """ |
6731 | This class is used for EVT_IDLE events, which are generated and sent | |
6732 | when the application *becomes* idle. In other words, the when the | |
6733 | event queue becomes empty then idle events are sent to all windows (by | |
6734 | default) and as long as none of them call `RequestMore` then there are | |
6735 | no more idle events until after the system event queue has some normal | |
6736 | events and then becomes empty again. | |
6737 | ||
6738 | By default, idle events are sent to all windows. If this is causing a | |
6739 | significant overhead in your application, you can call | |
6740 | `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and | |
6741 | set the wx.WS_EX_PROCESS_IDLE extra window style for every window | |
6742 | which should receive idle events. Then idle events will only be sent | |
6743 | to those windows and not to any others. | |
6744 | """ | |
0085ce49 RD |
6745 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6746 | __repr__ = _swig_repr | |
6747 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6748 | """ |
6749 | __init__(self) -> IdleEvent | |
6750 | ||
6751 | Constructor | |
6752 | """ | |
0085ce49 | 6753 | _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs)) |
e811c8ce | 6754 | def RequestMore(*args, **kwargs): |
5ba5649b RD |
6755 | """ |
6756 | RequestMore(self, bool needMore=True) | |
6757 | ||
6758 | Tells wxWidgets that more processing is required. This function can be | |
6759 | called by an EVT_IDLE handler for a window to indicate that the | |
6760 | application should forward the EVT_IDLE event once more to the | |
6761 | application windows. If no window calls this function during its | |
6762 | EVT_IDLE handler, then the application will remain in a passive event | |
6763 | loop until a new event is posted to the application by the windowing | |
6764 | system. | |
6765 | """ | |
54f9ee45 | 6766 | return _core_.IdleEvent_RequestMore(*args, **kwargs) |
e811c8ce RD |
6767 | |
6768 | def MoreRequested(*args, **kwargs): | |
5ba5649b RD |
6769 | """ |
6770 | MoreRequested(self) -> bool | |
6771 | ||
6772 | Returns ``True`` if the OnIdle function processing this event | |
6773 | requested more processing time. | |
6774 | """ | |
54f9ee45 | 6775 | return _core_.IdleEvent_MoreRequested(*args, **kwargs) |
e811c8ce RD |
6776 | |
6777 | def SetMode(*args, **kwargs): | |
5ba5649b RD |
6778 | """ |
6779 | SetMode(int mode) | |
6780 | ||
6781 | Static method for specifying how wxWidgets will send idle events: to | |
6782 | all windows, or only to those which specify that they will process the | |
6783 | events. | |
6784 | ||
6785 | The mode can be one of the following values: | |
6786 | ||
6787 | ========================= ======================================== | |
6788 | wx.IDLE_PROCESS_ALL Send idle events to all windows | |
6789 | wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have | |
6790 | the wx.WS_EX_PROCESS_IDLE extra style | |
6791 | flag set. | |
6792 | ========================= ======================================== | |
6793 | ||
6794 | """ | |
54f9ee45 | 6795 | return _core_.IdleEvent_SetMode(*args, **kwargs) |
e811c8ce RD |
6796 | |
6797 | SetMode = staticmethod(SetMode) | |
6798 | def GetMode(*args, **kwargs): | |
5ba5649b RD |
6799 | """ |
6800 | GetMode() -> int | |
6801 | ||
6802 | Static method returning a value specifying how wxWidgets will send | |
6803 | idle events: to all windows, or only to those which specify that they | |
6804 | will process the events. | |
6805 | """ | |
54f9ee45 | 6806 | return _core_.IdleEvent_GetMode(*args, **kwargs) |
e811c8ce RD |
6807 | |
6808 | GetMode = staticmethod(GetMode) | |
6809 | def CanSend(*args, **kwargs): | |
5ba5649b RD |
6810 | """ |
6811 | CanSend(Window win) -> bool | |
6812 | ||
6813 | Returns ``True`` if it is appropriate to send idle events to this | |
6814 | window. | |
6815 | ||
6816 | This function looks at the mode used (see `wx.IdleEvent.SetMode`), and | |
6817 | the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle | |
6818 | events should be sent to this window now. By default this will always | |
6819 | return ``True`` because the update mode is initially | |
6820 | wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events | |
6821 | to windows with the wx.WS_EX_PROCESS_IDLE extra window style set. | |
6822 | """ | |
54f9ee45 | 6823 | return _core_.IdleEvent_CanSend(*args, **kwargs) |
e811c8ce RD |
6824 | |
6825 | CanSend = staticmethod(CanSend) | |
2131d850 | 6826 | _core_.IdleEvent_swigregister(IdleEvent) |
d14a1e28 | 6827 | |
e811c8ce | 6828 | def IdleEvent_SetMode(*args, **kwargs): |
0085ce49 | 6829 | """ |
5ba5649b RD |
6830 | IdleEvent_SetMode(int mode) |
6831 | ||
6832 | Static method for specifying how wxWidgets will send idle events: to | |
6833 | all windows, or only to those which specify that they will process the | |
6834 | events. | |
6835 | ||
6836 | The mode can be one of the following values: | |
6837 | ||
6838 | ========================= ======================================== | |
6839 | wx.IDLE_PROCESS_ALL Send idle events to all windows | |
6840 | wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have | |
6841 | the wx.WS_EX_PROCESS_IDLE extra style | |
6842 | flag set. | |
6843 | ========================= ======================================== | |
6844 | ||
6845 | """ | |
0085ce49 | 6846 | return _core_.IdleEvent_SetMode(*args, **kwargs) |
d14a1e28 | 6847 | |
0085ce49 RD |
6848 | def IdleEvent_GetMode(*args): |
6849 | """ | |
5ba5649b RD |
6850 | IdleEvent_GetMode() -> int |
6851 | ||
6852 | Static method returning a value specifying how wxWidgets will send | |
6853 | idle events: to all windows, or only to those which specify that they | |
6854 | will process the events. | |
6855 | """ | |
0085ce49 | 6856 | return _core_.IdleEvent_GetMode(*args) |
d14a1e28 | 6857 | |
e811c8ce | 6858 | def IdleEvent_CanSend(*args, **kwargs): |
0085ce49 | 6859 | """ |
5ba5649b RD |
6860 | IdleEvent_CanSend(Window win) -> bool |
6861 | ||
6862 | Returns ``True`` if it is appropriate to send idle events to this | |
6863 | window. | |
6864 | ||
6865 | This function looks at the mode used (see `wx.IdleEvent.SetMode`), and | |
6866 | the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle | |
6867 | events should be sent to this window now. By default this will always | |
6868 | return ``True`` because the update mode is initially | |
6869 | wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events | |
6870 | to windows with the wx.WS_EX_PROCESS_IDLE extra window style set. | |
6871 | """ | |
0085ce49 | 6872 | return _core_.IdleEvent_CanSend(*args, **kwargs) |
d14a1e28 RD |
6873 | |
6874 | #--------------------------------------------------------------------------- | |
6875 | ||
2131d850 RD |
6876 | class ClipboardTextEvent(CommandEvent): |
6877 | """ | |
6878 | A Clipboard Text event is sent when a window intercepts a text | |
6879 | copy/cut/paste message, i.e. the user has cut/copied/pasted data | |
6880 | from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a | |
6881 | popup menu command, etc. NOTE : under windows these events are *NOT* | |
6882 | generated automatically for a Rich Edit text control. | |
6883 | """ | |
6884 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
6885 | __repr__ = _swig_repr | |
6886 | def __init__(self, *args, **kwargs): | |
6887 | """ | |
6888 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent | |
6889 | ||
6890 | A Clipboard Text event is sent when a window intercepts a text | |
6891 | copy/cut/paste message, i.e. the user has cut/copied/pasted data | |
6892 | from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a | |
6893 | popup menu command, etc. NOTE : under windows these events are *NOT* | |
6894 | generated automatically for a Rich Edit text control. | |
6895 | """ | |
6896 | _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs)) | |
6897 | _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent) | |
6898 | ||
6899 | #--------------------------------------------------------------------------- | |
6900 | ||
d14a1e28 | 6901 | class PyEvent(Event): |
5ba5649b RD |
6902 | """ |
6903 | wx.PyEvent can be used as a base class for implementing custom event | |
6904 | types in Python. You should derived from this class instead of | |
6905 | `wx.Event` because this class is Python-aware and is able to transport | |
6906 | its Python bits safely through the wxWidgets event system and have | |
6907 | them still be there when the event handler is invoked. | |
6908 | ||
6909 | :see: `wx.PyCommandEvent` | |
6910 | ||
6911 | """ | |
0085ce49 RD |
6912 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6913 | __repr__ = _swig_repr | |
6914 | def __init__(self, *args, **kwargs): | |
2131d850 | 6915 | """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent""" |
0085ce49 | 6916 | _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs)) |
5ba5649b | 6917 | self._SetSelf(self) |
e811c8ce | 6918 | |
0085ce49 RD |
6919 | __swig_destroy__ = _core_.delete_PyEvent |
6920 | __del__ = lambda self : None; | |
5ba5649b RD |
6921 | def _SetSelf(*args, **kwargs): |
6922 | """_SetSelf(self, PyObject self)""" | |
6923 | return _core_.PyEvent__SetSelf(*args, **kwargs) | |
e811c8ce | 6924 | |
5ba5649b RD |
6925 | def _GetSelf(*args, **kwargs): |
6926 | """_GetSelf(self) -> PyObject""" | |
6927 | return _core_.PyEvent__GetSelf(*args, **kwargs) | |
e811c8ce | 6928 | |
2131d850 | 6929 | _core_.PyEvent_swigregister(PyEvent) |
d14a1e28 RD |
6930 | |
6931 | class PyCommandEvent(CommandEvent): | |
5ba5649b RD |
6932 | """ |
6933 | wx.PyCommandEvent can be used as a base class for implementing custom | |
6934 | event types in Python, where the event shoudl travel up to parent | |
6935 | windows looking for a handler. You should derived from this class | |
6936 | instead of `wx.CommandEvent` because this class is Python-aware and is | |
6937 | able to transport its Python bits safely through the wxWidgets event | |
6938 | system and have them still be there when the event handler is invoked. | |
6939 | ||
6940 | :see: `wx.PyEvent` | |
6941 | ||
6942 | """ | |
0085ce49 RD |
6943 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6944 | __repr__ = _swig_repr | |
6945 | def __init__(self, *args, **kwargs): | |
2131d850 | 6946 | """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent""" |
0085ce49 | 6947 | _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs)) |
5ba5649b | 6948 | self._SetSelf(self) |
e811c8ce | 6949 | |
0085ce49 RD |
6950 | __swig_destroy__ = _core_.delete_PyCommandEvent |
6951 | __del__ = lambda self : None; | |
5ba5649b RD |
6952 | def _SetSelf(*args, **kwargs): |
6953 | """_SetSelf(self, PyObject self)""" | |
6954 | return _core_.PyCommandEvent__SetSelf(*args, **kwargs) | |
e811c8ce | 6955 | |
5ba5649b RD |
6956 | def _GetSelf(*args, **kwargs): |
6957 | """_GetSelf(self) -> PyObject""" | |
6958 | return _core_.PyCommandEvent__GetSelf(*args, **kwargs) | |
e811c8ce | 6959 | |
2131d850 | 6960 | _core_.PyCommandEvent_swigregister(PyCommandEvent) |
d14a1e28 | 6961 | |
53aa7709 | 6962 | class DateEvent(CommandEvent): |
5ba5649b RD |
6963 | """ |
6964 | This event class holds information about a date change event and is | |
6965 | used together with `wx.DatePickerCtrl`. It also serves as a base class | |
6966 | for `wx.calendar.CalendarEvent`. Bind these event types with | |
6967 | EVT_DATE_CHANGED. | |
6968 | """ | |
0085ce49 RD |
6969 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6970 | __repr__ = _swig_repr | |
6971 | def __init__(self, *args, **kwargs): | |
2131d850 | 6972 | """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent""" |
0085ce49 | 6973 | _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs)) |
53aa7709 | 6974 | def GetDate(*args, **kwargs): |
5ba5649b RD |
6975 | """ |
6976 | GetDate(self) -> DateTime | |
6977 | ||
6978 | Returns the date. | |
6979 | """ | |
53aa7709 RD |
6980 | return _core_.DateEvent_GetDate(*args, **kwargs) |
6981 | ||
6982 | def SetDate(*args, **kwargs): | |
5ba5649b RD |
6983 | """ |
6984 | SetDate(self, DateTime date) | |
6985 | ||
6986 | Sets the date carried by the event, normally only used by the library | |
6987 | internally. | |
6988 | """ | |
53aa7709 RD |
6989 | return _core_.DateEvent_SetDate(*args, **kwargs) |
6990 | ||
2bf58437 | 6991 | Date = property(GetDate,SetDate,doc="See `GetDate` and `SetDate`") |
2131d850 | 6992 | _core_.DateEvent_swigregister(DateEvent) |
53aa7709 RD |
6993 | |
6994 | wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED | |
6995 | EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 ) | |
6996 | ||
d14a1e28 RD |
6997 | #--------------------------------------------------------------------------- |
6998 | ||
54f9ee45 RD |
6999 | PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS |
7000 | PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION | |
7001 | PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG | |
7002 | PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG | |
7003 | PRINT_WINDOWS = _core_.PRINT_WINDOWS | |
7004 | PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT | |
d14a1e28 | 7005 | class PyApp(EvtHandler): |
66c033b4 RD |
7006 | """ |
7007 | The ``wx.PyApp`` class is an *implementation detail*, please use the | |
7008 | `wx.App` class (or some other derived class) instead. | |
7009 | """ | |
0085ce49 RD |
7010 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7011 | __repr__ = _swig_repr | |
7012 | def __init__(self, *args, **kwargs): | |
98e665d3 | 7013 | """ |
a95a7133 | 7014 | __init__(self) -> PyApp |
98e665d3 RD |
7015 | |
7016 | Create a new application object, starting the bootstrap process. | |
7017 | """ | |
0085ce49 | 7018 | _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs)) |
c25f90f6 | 7019 | self._setOORInfo(self, False);PyApp._setCallbackInfo(self, self, PyApp) |
e811c8ce | 7020 | |
0085ce49 RD |
7021 | __swig_destroy__ = _core_.delete_PyApp |
7022 | __del__ = lambda self : None; | |
e811c8ce | 7023 | def _setCallbackInfo(*args, **kwargs): |
c25f90f6 | 7024 | """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref=False)""" |
54f9ee45 | 7025 | return _core_.PyApp__setCallbackInfo(*args, **kwargs) |
e811c8ce RD |
7026 | |
7027 | def GetAppName(*args, **kwargs): | |
0df68c9f | 7028 | """ |
a95a7133 | 7029 | GetAppName(self) -> String |
6c3b4aae | 7030 | |
0df68c9f RD |
7031 | Get the application name. |
7032 | """ | |
54f9ee45 | 7033 | return _core_.PyApp_GetAppName(*args, **kwargs) |
e811c8ce RD |
7034 | |
7035 | def SetAppName(*args, **kwargs): | |
0df68c9f | 7036 | """ |
a95a7133 | 7037 | SetAppName(self, String name) |
6c3b4aae | 7038 | |
66c033b4 RD |
7039 | Set the application name. This value may be used automatically by |
7040 | `wx.Config` and such. | |
0df68c9f | 7041 | """ |
54f9ee45 | 7042 | return _core_.PyApp_SetAppName(*args, **kwargs) |
e811c8ce RD |
7043 | |
7044 | def GetClassName(*args, **kwargs): | |
0df68c9f | 7045 | """ |
a95a7133 | 7046 | GetClassName(self) -> String |
e811c8ce | 7047 | |
0df68c9f RD |
7048 | Get the application's class name. |
7049 | """ | |
54f9ee45 | 7050 | return _core_.PyApp_GetClassName(*args, **kwargs) |
e811c8ce RD |
7051 | |
7052 | def SetClassName(*args, **kwargs): | |
0df68c9f | 7053 | """ |
a95a7133 | 7054 | SetClassName(self, String name) |
6c3b4aae | 7055 | |
66c033b4 RD |
7056 | Set the application's class name. This value may be used for |
7057 | X-resources if applicable for the platform | |
0df68c9f | 7058 | """ |
54f9ee45 | 7059 | return _core_.PyApp_SetClassName(*args, **kwargs) |
e811c8ce RD |
7060 | |
7061 | def GetVendorName(*args, **kwargs): | |
0df68c9f | 7062 | """ |
a95a7133 | 7063 | GetVendorName(self) -> String |
6c3b4aae | 7064 | |
0df68c9f RD |
7065 | Get the application's vendor name. |
7066 | """ | |
54f9ee45 | 7067 | return _core_.PyApp_GetVendorName(*args, **kwargs) |
e811c8ce RD |
7068 | |
7069 | def SetVendorName(*args, **kwargs): | |
0df68c9f | 7070 | """ |
a95a7133 | 7071 | SetVendorName(self, String name) |
6c3b4aae | 7072 | |
66c033b4 RD |
7073 | Set the application's vendor name. This value may be used |
7074 | automatically by `wx.Config` and such. | |
0df68c9f | 7075 | """ |
54f9ee45 | 7076 | return _core_.PyApp_SetVendorName(*args, **kwargs) |
e811c8ce RD |
7077 | |
7078 | def GetTraits(*args, **kwargs): | |
0df68c9f | 7079 | """ |
a95a7133 | 7080 | GetTraits(self) -> wxAppTraits |
6c3b4aae | 7081 | |
66c033b4 RD |
7082 | Return (and create if necessary) the app traits object to which we |
7083 | delegate for everything which either should be configurable by the | |
7084 | user (then he can change the default behaviour simply by overriding | |
7085 | CreateTraits() and returning his own traits object) or which is | |
7086 | GUI/console dependent as then wx.AppTraits allows us to abstract the | |
7087 | differences behind the common facade. | |
7088 | ||
7089 | :todo: Add support for overriding CreateAppTraits in wxPython. | |
0df68c9f | 7090 | """ |
54f9ee45 | 7091 | return _core_.PyApp_GetTraits(*args, **kwargs) |
e811c8ce RD |
7092 | |
7093 | def ProcessPendingEvents(*args, **kwargs): | |
0df68c9f | 7094 | """ |
a95a7133 | 7095 | ProcessPendingEvents(self) |
6c3b4aae | 7096 | |
66c033b4 RD |
7097 | Process all events in the Pending Events list -- it is necessary to |
7098 | call this function to process posted events. This normally happens | |
7099 | during each event loop iteration. | |
0df68c9f | 7100 | """ |
54f9ee45 | 7101 | return _core_.PyApp_ProcessPendingEvents(*args, **kwargs) |
e811c8ce RD |
7102 | |
7103 | def Yield(*args, **kwargs): | |
0df68c9f | 7104 | """ |
a95a7133 | 7105 | Yield(self, bool onlyIfNeeded=False) -> bool |
6c3b4aae | 7106 | |
66c033b4 RD |
7107 | Process all currently pending events right now, instead of waiting |
7108 | until return to the event loop. It is an error to call ``Yield`` | |
7109 | recursively unless the value of ``onlyIfNeeded`` is True. | |
6c3b4aae | 7110 | |
66c033b4 | 7111 | :warning: This function is dangerous as it can lead to unexpected |
41e2b43e RD |
7112 | reentrancies (i.e. when called from an event handler it may |
7113 | result in calling the same event handler again), use with | |
7114 | extreme care or, better, don't use at all! | |
0df68c9f | 7115 | |
66c033b4 | 7116 | :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield` |
41e2b43e | 7117 | |
0df68c9f | 7118 | """ |
54f9ee45 | 7119 | return _core_.PyApp_Yield(*args, **kwargs) |
e811c8ce RD |
7120 | |
7121 | def WakeUpIdle(*args, **kwargs): | |
0df68c9f | 7122 | """ |
a95a7133 | 7123 | WakeUpIdle(self) |
6c3b4aae | 7124 | |
66c033b4 RD |
7125 | Make sure that idle events are sent again. |
7126 | :see: `wx.WakeUpIdle` | |
0df68c9f | 7127 | """ |
54f9ee45 | 7128 | return _core_.PyApp_WakeUpIdle(*args, **kwargs) |
e811c8ce | 7129 | |
1fc3b23a RD |
7130 | def IsMainLoopRunning(*args, **kwargs): |
7131 | """ | |
7132 | IsMainLoopRunning() -> bool | |
7133 | ||
7134 | Returns True if we're running the main loop, i.e. if the events can | |
7135 | currently be dispatched. | |
7136 | """ | |
7137 | return _core_.PyApp_IsMainLoopRunning(*args, **kwargs) | |
7138 | ||
7139 | IsMainLoopRunning = staticmethod(IsMainLoopRunning) | |
e811c8ce | 7140 | def MainLoop(*args, **kwargs): |
0df68c9f | 7141 | """ |
a95a7133 | 7142 | MainLoop(self) -> int |
6c3b4aae | 7143 | |
66c033b4 RD |
7144 | Execute the main GUI loop, the function doesn't normally return until |
7145 | all top level windows have been closed and destroyed. | |
0df68c9f | 7146 | """ |
54f9ee45 | 7147 | return _core_.PyApp_MainLoop(*args, **kwargs) |
e811c8ce RD |
7148 | |
7149 | def Exit(*args, **kwargs): | |
0df68c9f | 7150 | """ |
a95a7133 | 7151 | Exit(self) |
6c3b4aae | 7152 | |
0df68c9f | 7153 | Exit the main loop thus terminating the application. |
66c033b4 | 7154 | :see: `wx.Exit` |
0df68c9f | 7155 | """ |
54f9ee45 | 7156 | return _core_.PyApp_Exit(*args, **kwargs) |
e811c8ce | 7157 | |
97ab0f6a RD |
7158 | def GetLayoutDirection(*args, **kwargs): |
7159 | """ | |
994453b8 | 7160 | GetLayoutDirection(self) -> int |
97ab0f6a RD |
7161 | |
7162 | Return the layout direction for the current locale. | |
7163 | """ | |
7164 | return _core_.PyApp_GetLayoutDirection(*args, **kwargs) | |
7165 | ||
e811c8ce | 7166 | def ExitMainLoop(*args, **kwargs): |
0df68c9f | 7167 | """ |
a95a7133 | 7168 | ExitMainLoop(self) |
6c3b4aae | 7169 | |
66c033b4 RD |
7170 | Exit the main GUI loop during the next iteration of the main |
7171 | loop, (i.e. it does not stop the program immediately!) | |
0df68c9f | 7172 | """ |
54f9ee45 | 7173 | return _core_.PyApp_ExitMainLoop(*args, **kwargs) |
e811c8ce RD |
7174 | |
7175 | def Pending(*args, **kwargs): | |
0df68c9f | 7176 | """ |
a95a7133 | 7177 | Pending(self) -> bool |
6c3b4aae | 7178 | |
0df68c9f RD |
7179 | Returns True if there are unprocessed events in the event queue. |
7180 | """ | |
54f9ee45 | 7181 | return _core_.PyApp_Pending(*args, **kwargs) |
e811c8ce RD |
7182 | |
7183 | def Dispatch(*args, **kwargs): | |
0df68c9f | 7184 | """ |
a95a7133 | 7185 | Dispatch(self) -> bool |
6c3b4aae | 7186 | |
0df68c9f RD |
7187 | Process the first event in the event queue (blocks until an event |
7188 | appears if there are none currently) | |
7189 | """ | |
54f9ee45 | 7190 | return _core_.PyApp_Dispatch(*args, **kwargs) |
e811c8ce RD |
7191 | |
7192 | def ProcessIdle(*args, **kwargs): | |
0df68c9f | 7193 | """ |
a95a7133 | 7194 | ProcessIdle(self) -> bool |
6c3b4aae | 7195 | |
66c033b4 RD |
7196 | Called from the MainLoop when the application becomes idle (there are |
7197 | no pending events) and sends a `wx.IdleEvent` to all interested | |
7198 | parties. Returns True if more idle events are needed, False if not. | |
0df68c9f | 7199 | """ |
54f9ee45 | 7200 | return _core_.PyApp_ProcessIdle(*args, **kwargs) |
e811c8ce RD |
7201 | |
7202 | def SendIdleEvents(*args, **kwargs): | |
0df68c9f | 7203 | """ |
a95a7133 | 7204 | SendIdleEvents(self, Window win, IdleEvent event) -> bool |
e811c8ce | 7205 | |
66c033b4 RD |
7206 | Send idle event to window and all subwindows. Returns True if more |
7207 | idle time is requested. | |
0df68c9f | 7208 | """ |
54f9ee45 | 7209 | return _core_.PyApp_SendIdleEvents(*args, **kwargs) |
e811c8ce RD |
7210 | |
7211 | def IsActive(*args, **kwargs): | |
0df68c9f | 7212 | """ |
a95a7133 | 7213 | IsActive(self) -> bool |
6c3b4aae | 7214 | |
0df68c9f RD |
7215 | Return True if our app has focus. |
7216 | """ | |
54f9ee45 | 7217 | return _core_.PyApp_IsActive(*args, **kwargs) |
e811c8ce RD |
7218 | |
7219 | def SetTopWindow(*args, **kwargs): | |
0df68c9f | 7220 | """ |
a95a7133 | 7221 | SetTopWindow(self, Window win) |
6c3b4aae | 7222 | |
66c033b4 | 7223 | Set the *main* top level window |
0df68c9f | 7224 | """ |
54f9ee45 | 7225 | return _core_.PyApp_SetTopWindow(*args, **kwargs) |
e811c8ce RD |
7226 | |
7227 | def GetTopWindow(*args, **kwargs): | |
0df68c9f | 7228 | """ |
a95a7133 | 7229 | GetTopWindow(self) -> Window |
6c3b4aae | 7230 | |
66c033b4 RD |
7231 | Return the *main* top level window (if it hadn't been set previously |
7232 | with SetTopWindow(), will return just some top level window and, if | |
7233 | there not any, will return None) | |
0df68c9f | 7234 | """ |
54f9ee45 | 7235 | return _core_.PyApp_GetTopWindow(*args, **kwargs) |
e811c8ce RD |
7236 | |
7237 | def SetExitOnFrameDelete(*args, **kwargs): | |
0df68c9f | 7238 | """ |
a95a7133 | 7239 | SetExitOnFrameDelete(self, bool flag) |
0df68c9f | 7240 | |
66c033b4 RD |
7241 | Control the exit behaviour: by default, the program will exit the main |
7242 | loop (and so, usually, terminate) when the last top-level program | |
7243 | window is deleted. Beware that if you disable this behaviour (with | |
7244 | SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop() | |
7245 | explicitly from somewhere. | |
0df68c9f | 7246 | """ |
54f9ee45 | 7247 | return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs) |
e811c8ce RD |
7248 | |
7249 | def GetExitOnFrameDelete(*args, **kwargs): | |
0df68c9f | 7250 | """ |
a95a7133 | 7251 | GetExitOnFrameDelete(self) -> bool |
6c3b4aae | 7252 | |
0df68c9f RD |
7253 | Get the current exit behaviour setting. |
7254 | """ | |
54f9ee45 | 7255 | return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs) |
e811c8ce RD |
7256 | |
7257 | def SetUseBestVisual(*args, **kwargs): | |
0df68c9f | 7258 | """ |
eccab1a7 | 7259 | SetUseBestVisual(self, bool flag, bool forceTrueColour=False) |
6c3b4aae | 7260 | |
66c033b4 RD |
7261 | Set whether the app should try to use the best available visual on |
7262 | systems where more than one is available, (Sun, SGI, XFree86 4, etc.) | |
0df68c9f | 7263 | """ |
54f9ee45 | 7264 | return _core_.PyApp_SetUseBestVisual(*args, **kwargs) |
e811c8ce RD |
7265 | |
7266 | def GetUseBestVisual(*args, **kwargs): | |
0df68c9f | 7267 | """ |
a95a7133 | 7268 | GetUseBestVisual(self) -> bool |
6c3b4aae | 7269 | |
0df68c9f RD |
7270 | Get current UseBestVisual setting. |
7271 | """ | |
54f9ee45 | 7272 | return _core_.PyApp_GetUseBestVisual(*args, **kwargs) |
e811c8ce RD |
7273 | |
7274 | def SetPrintMode(*args, **kwargs): | |
a95a7133 | 7275 | """SetPrintMode(self, int mode)""" |
54f9ee45 | 7276 | return _core_.PyApp_SetPrintMode(*args, **kwargs) |
e811c8ce RD |
7277 | |
7278 | def GetPrintMode(*args, **kwargs): | |
a95a7133 | 7279 | """GetPrintMode(self) -> int""" |
54f9ee45 | 7280 | return _core_.PyApp_GetPrintMode(*args, **kwargs) |
e811c8ce | 7281 | |
e811c8ce | 7282 | def SetAssertMode(*args, **kwargs): |
0df68c9f | 7283 | """ |
a95a7133 | 7284 | SetAssertMode(self, int mode) |
6c3b4aae | 7285 | |
41e2b43e | 7286 | Set the OnAssert behaviour for debug and hybrid builds. |
0df68c9f | 7287 | """ |
54f9ee45 | 7288 | return _core_.PyApp_SetAssertMode(*args, **kwargs) |
e811c8ce | 7289 | |
6c3b4aae | 7290 | def GetAssertMode(*args, **kwargs): |
0df68c9f | 7291 | """ |
a95a7133 | 7292 | GetAssertMode(self) -> int |
6c3b4aae | 7293 | |
0df68c9f RD |
7294 | Get the current OnAssert behaviour setting. |
7295 | """ | |
54f9ee45 | 7296 | return _core_.PyApp_GetAssertMode(*args, **kwargs) |
6c3b4aae | 7297 | |
e811c8ce | 7298 | def GetMacSupportPCMenuShortcuts(*args, **kwargs): |
66c033b4 | 7299 | """GetMacSupportPCMenuShortcuts() -> bool""" |
54f9ee45 | 7300 | return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs) |
e811c8ce RD |
7301 | |
7302 | GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts) | |
7303 | def GetMacAboutMenuItemId(*args, **kwargs): | |
66c033b4 | 7304 | """GetMacAboutMenuItemId() -> long""" |
54f9ee45 | 7305 | return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs) |
e811c8ce RD |
7306 | |
7307 | GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId) | |
7308 | def GetMacPreferencesMenuItemId(*args, **kwargs): | |
66c033b4 | 7309 | """GetMacPreferencesMenuItemId() -> long""" |
54f9ee45 | 7310 | return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs) |
e811c8ce RD |
7311 | |
7312 | GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId) | |
7313 | def GetMacExitMenuItemId(*args, **kwargs): | |
66c033b4 | 7314 | """GetMacExitMenuItemId() -> long""" |
54f9ee45 | 7315 | return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs) |
e811c8ce RD |
7316 | |
7317 | GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId) | |
7318 | def GetMacHelpMenuTitleName(*args, **kwargs): | |
66c033b4 | 7319 | """GetMacHelpMenuTitleName() -> String""" |
54f9ee45 | 7320 | return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs) |
e811c8ce RD |
7321 | |
7322 | GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName) | |
7323 | def SetMacSupportPCMenuShortcuts(*args, **kwargs): | |
66c033b4 | 7324 | """SetMacSupportPCMenuShortcuts(bool val)""" |
54f9ee45 | 7325 | return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs) |
e811c8ce RD |
7326 | |
7327 | SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts) | |
7328 | def SetMacAboutMenuItemId(*args, **kwargs): | |
66c033b4 | 7329 | """SetMacAboutMenuItemId(long val)""" |
54f9ee45 | 7330 | return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs) |
e811c8ce RD |
7331 | |
7332 | SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId) | |
7333 | def SetMacPreferencesMenuItemId(*args, **kwargs): | |
66c033b4 | 7334 | """SetMacPreferencesMenuItemId(long val)""" |
54f9ee45 | 7335 | return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs) |
e811c8ce RD |
7336 | |
7337 | SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId) | |
7338 | def SetMacExitMenuItemId(*args, **kwargs): | |
66c033b4 | 7339 | """SetMacExitMenuItemId(long val)""" |
54f9ee45 | 7340 | return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs) |
e811c8ce RD |
7341 | |
7342 | SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId) | |
7343 | def SetMacHelpMenuTitleName(*args, **kwargs): | |
66c033b4 | 7344 | """SetMacHelpMenuTitleName(String val)""" |
54f9ee45 | 7345 | return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs) |
e811c8ce RD |
7346 | |
7347 | SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName) | |
7348 | def _BootstrapApp(*args, **kwargs): | |
0df68c9f | 7349 | """ |
a95a7133 | 7350 | _BootstrapApp(self) |
6c3b4aae | 7351 | |
0df68c9f RD |
7352 | For internal use only |
7353 | """ | |
54f9ee45 | 7354 | return _core_.PyApp__BootstrapApp(*args, **kwargs) |
e811c8ce RD |
7355 | |
7356 | def GetComCtl32Version(*args, **kwargs): | |
0df68c9f | 7357 | """ |
66c033b4 | 7358 | GetComCtl32Version() -> int |
6c3b4aae | 7359 | |
66c033b4 RD |
7360 | Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if |
7361 | it wasn't found at all. Raises an exception on non-Windows platforms. | |
0df68c9f | 7362 | """ |
54f9ee45 | 7363 | return _core_.PyApp_GetComCtl32Version(*args, **kwargs) |
e811c8ce RD |
7364 | |
7365 | GetComCtl32Version = staticmethod(GetComCtl32Version) | |
33d6fd3b | 7366 | def IsDisplayAvailable(*args, **kwargs): |
fc46b7f3 | 7367 | """ |
33d6fd3b | 7368 | IsDisplayAvailable() -> bool |
fc46b7f3 RD |
7369 | |
7370 | Tests if it is possible to create a GUI in the current environment. | |
7371 | This will mean different things on the different platforms. | |
7372 | ||
7373 | * On X Windows systems this function will return ``False`` if it is | |
7374 | not able to open a connection to the X display, which can happen | |
7375 | if $DISPLAY is not set, or is not set correctly. | |
7376 | ||
7377 | * On Mac OS X a ``False`` return value will mean that wx is not | |
7378 | able to access the window manager, which can happen if logged in | |
7379 | remotely or if running from the normal version of python instead | |
7380 | of the framework version, (i.e., pythonw.) | |
7381 | ||
7382 | * On MS Windows... | |
7383 | ||
7384 | """ | |
33d6fd3b RD |
7385 | return _core_.PyApp_IsDisplayAvailable(*args, **kwargs) |
7386 | ||
7387 | IsDisplayAvailable = staticmethod(IsDisplayAvailable) | |
7388 | AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`") | |
7389 | AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`") | |
7390 | ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`") | |
7391 | ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`") | |
7392 | LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`") | |
7393 | PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`") | |
7394 | TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`") | |
7395 | Traits = property(GetTraits,doc="See `GetTraits`") | |
7396 | UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`") | |
7397 | VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`") | |
7398 | Active = property(IsActive) | |
2131d850 | 7399 | _core_.PyApp_swigregister(PyApp) |
d14a1e28 | 7400 | |
0085ce49 RD |
7401 | def PyApp_IsMainLoopRunning(*args): |
7402 | """ | |
1fc3b23a RD |
7403 | PyApp_IsMainLoopRunning() -> bool |
7404 | ||
7405 | Returns True if we're running the main loop, i.e. if the events can | |
7406 | currently be dispatched. | |
7407 | """ | |
0085ce49 | 7408 | return _core_.PyApp_IsMainLoopRunning(*args) |
1fc3b23a | 7409 | |
0085ce49 RD |
7410 | def PyApp_GetMacSupportPCMenuShortcuts(*args): |
7411 | """PyApp_GetMacSupportPCMenuShortcuts() -> bool""" | |
7412 | return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args) | |
d14a1e28 | 7413 | |
0085ce49 RD |
7414 | def PyApp_GetMacAboutMenuItemId(*args): |
7415 | """PyApp_GetMacAboutMenuItemId() -> long""" | |
7416 | return _core_.PyApp_GetMacAboutMenuItemId(*args) | |
d14a1e28 | 7417 | |
0085ce49 RD |
7418 | def PyApp_GetMacPreferencesMenuItemId(*args): |
7419 | """PyApp_GetMacPreferencesMenuItemId() -> long""" | |
7420 | return _core_.PyApp_GetMacPreferencesMenuItemId(*args) | |
d14a1e28 | 7421 | |
0085ce49 RD |
7422 | def PyApp_GetMacExitMenuItemId(*args): |
7423 | """PyApp_GetMacExitMenuItemId() -> long""" | |
7424 | return _core_.PyApp_GetMacExitMenuItemId(*args) | |
d14a1e28 | 7425 | |
0085ce49 RD |
7426 | def PyApp_GetMacHelpMenuTitleName(*args): |
7427 | """PyApp_GetMacHelpMenuTitleName() -> String""" | |
7428 | return _core_.PyApp_GetMacHelpMenuTitleName(*args) | |
d14a1e28 | 7429 | |
e811c8ce | 7430 | def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs): |
0085ce49 RD |
7431 | """PyApp_SetMacSupportPCMenuShortcuts(bool val)""" |
7432 | return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs) | |
d14a1e28 | 7433 | |
e811c8ce | 7434 | def PyApp_SetMacAboutMenuItemId(*args, **kwargs): |
0085ce49 RD |
7435 | """PyApp_SetMacAboutMenuItemId(long val)""" |
7436 | return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs) | |
d14a1e28 | 7437 | |
e811c8ce | 7438 | def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs): |
0085ce49 RD |
7439 | """PyApp_SetMacPreferencesMenuItemId(long val)""" |
7440 | return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs) | |
d14a1e28 | 7441 | |
e811c8ce | 7442 | def PyApp_SetMacExitMenuItemId(*args, **kwargs): |
0085ce49 RD |
7443 | """PyApp_SetMacExitMenuItemId(long val)""" |
7444 | return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs) | |
d14a1e28 | 7445 | |
e811c8ce | 7446 | def PyApp_SetMacHelpMenuTitleName(*args, **kwargs): |
0085ce49 RD |
7447 | """PyApp_SetMacHelpMenuTitleName(String val)""" |
7448 | return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs) | |
d14a1e28 | 7449 | |
0085ce49 RD |
7450 | def PyApp_GetComCtl32Version(*args): |
7451 | """ | |
0df68c9f | 7452 | PyApp_GetComCtl32Version() -> int |
6c3b4aae | 7453 | |
66c033b4 RD |
7454 | Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if |
7455 | it wasn't found at all. Raises an exception on non-Windows platforms. | |
0df68c9f | 7456 | """ |
0085ce49 | 7457 | return _core_.PyApp_GetComCtl32Version(*args) |
d14a1e28 | 7458 | |
33d6fd3b | 7459 | def PyApp_IsDisplayAvailable(*args): |
fc46b7f3 | 7460 | """ |
33d6fd3b | 7461 | PyApp_IsDisplayAvailable() -> bool |
fc46b7f3 RD |
7462 | |
7463 | Tests if it is possible to create a GUI in the current environment. | |
7464 | This will mean different things on the different platforms. | |
7465 | ||
7466 | * On X Windows systems this function will return ``False`` if it is | |
7467 | not able to open a connection to the X display, which can happen | |
7468 | if $DISPLAY is not set, or is not set correctly. | |
7469 | ||
7470 | * On Mac OS X a ``False`` return value will mean that wx is not | |
7471 | able to access the window manager, which can happen if logged in | |
7472 | remotely or if running from the normal version of python instead | |
7473 | of the framework version, (i.e., pythonw.) | |
7474 | ||
7475 | * On MS Windows... | |
7476 | ||
7477 | """ | |
33d6fd3b | 7478 | return _core_.PyApp_IsDisplayAvailable(*args) |
fc46b7f3 | 7479 | |
d14a1e28 RD |
7480 | #--------------------------------------------------------------------------- |
7481 | ||
7482 | ||
0085ce49 RD |
7483 | def Exit(*args): |
7484 | """ | |
0df68c9f | 7485 | Exit() |
6c3b4aae | 7486 | |
0df68c9f RD |
7487 | Force an exit of the application. Convenience for wx.GetApp().Exit() |
7488 | """ | |
0085ce49 | 7489 | return _core_.Exit(*args) |
d14a1e28 | 7490 | |
0085ce49 RD |
7491 | def Yield(*args): |
7492 | """ | |
0df68c9f | 7493 | Yield() -> bool |
6c3b4aae | 7494 | |
0df68c9f RD |
7495 | Yield to other apps/messages. Convenience for wx.GetApp().Yield() |
7496 | """ | |
0085ce49 | 7497 | return _core_.Yield(*args) |
d14a1e28 | 7498 | |
0085ce49 RD |
7499 | def YieldIfNeeded(*args): |
7500 | """ | |
0df68c9f | 7501 | YieldIfNeeded() -> bool |
6c3b4aae | 7502 | |
0df68c9f RD |
7503 | Yield to other apps/messages. Convenience for wx.GetApp().Yield(True) |
7504 | """ | |
0085ce49 | 7505 | return _core_.YieldIfNeeded(*args) |
d14a1e28 | 7506 | |
e811c8ce | 7507 | def SafeYield(*args, **kwargs): |
0085ce49 | 7508 | """ |
0df68c9f | 7509 | SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool |
6c3b4aae | 7510 | |
66c033b4 RD |
7511 | This function is similar to `wx.Yield`, except that it disables the |
7512 | user input to all program windows before calling `wx.Yield` and | |
7513 | re-enables it again afterwards. If ``win`` is not None, this window | |
7514 | will remain enabled, allowing the implementation of some limited user | |
7515 | interaction. | |
6c3b4aae | 7516 | |
66c033b4 | 7517 | :Returns: the result of the call to `wx.Yield`. |
0df68c9f | 7518 | """ |
0085ce49 | 7519 | return _core_.SafeYield(*args, **kwargs) |
d14a1e28 | 7520 | |
0085ce49 RD |
7521 | def WakeUpIdle(*args): |
7522 | """ | |
0df68c9f | 7523 | WakeUpIdle() |
6c3b4aae | 7524 | |
66c033b4 RD |
7525 | Cause the message queue to become empty again, so idle events will be |
7526 | sent. | |
0df68c9f | 7527 | """ |
0085ce49 | 7528 | return _core_.WakeUpIdle(*args) |
d14a1e28 | 7529 | |
e811c8ce | 7530 | def PostEvent(*args, **kwargs): |
0085ce49 | 7531 | """ |
0df68c9f | 7532 | PostEvent(EvtHandler dest, Event event) |
6c3b4aae | 7533 | |
66c033b4 RD |
7534 | Send an event to a window or other wx.EvtHandler to be processed |
7535 | later. | |
0df68c9f | 7536 | """ |
0085ce49 | 7537 | return _core_.PostEvent(*args, **kwargs) |
d14a1e28 | 7538 | |
0085ce49 RD |
7539 | def App_CleanUp(*args): |
7540 | """ | |
0df68c9f | 7541 | App_CleanUp() |
6c3b4aae | 7542 | |
41e2b43e | 7543 | For internal use only, it is used to cleanup after wxWidgets when |
66c033b4 | 7544 | Python shuts down. |
0df68c9f | 7545 | """ |
0085ce49 | 7546 | return _core_.App_CleanUp(*args) |
d14a1e28 | 7547 | |
0085ce49 RD |
7548 | def GetApp(*args): |
7549 | """ | |
0df68c9f | 7550 | GetApp() -> PyApp |
6c3b4aae | 7551 | |
196addbf | 7552 | Return a reference to the current wx.App object. |
0df68c9f | 7553 | """ |
0085ce49 | 7554 | return _core_.GetApp(*args) |
5cbf236d RD |
7555 | |
7556 | def SetDefaultPyEncoding(*args, **kwargs): | |
0085ce49 | 7557 | """ |
5cbf236d RD |
7558 | SetDefaultPyEncoding(string encoding) |
7559 | ||
7560 | Sets the encoding that wxPython will use when it needs to convert a | |
7561 | Python string or unicode object to or from a wxString. | |
e505d15e RD |
7562 | |
7563 | The default encoding is the value of ``locale.getdefaultlocale()[1]`` | |
7564 | but please be aware that the default encoding within the same locale | |
7565 | may be slightly different on different platforms. For example, please | |
7566 | see http://www.alanwood.net/demos/charsetdiffs.html for differences | |
7567 | between the common latin/roman encodings. | |
5cbf236d | 7568 | """ |
0085ce49 | 7569 | return _core_.SetDefaultPyEncoding(*args, **kwargs) |
5cbf236d | 7570 | |
0085ce49 RD |
7571 | def GetDefaultPyEncoding(*args): |
7572 | """ | |
5cbf236d RD |
7573 | GetDefaultPyEncoding() -> string |
7574 | ||
7575 | Gets the current encoding that wxPython will use when it needs to | |
7576 | convert a Python string or unicode object to or from a wxString. | |
7577 | """ | |
0085ce49 | 7578 | return _core_.GetDefaultPyEncoding(*args) |
d14a1e28 RD |
7579 | #---------------------------------------------------------------------- |
7580 | ||
7581 | class PyOnDemandOutputWindow: | |
6c3b4aae RD |
7582 | """ |
7583 | A class that can be used for redirecting Python's stdout and | |
7584 | stderr streams. It will do nothing until something is wrriten to | |
7585 | the stream at which point it will create a Frame with a text area | |
7586 | and write the text there. | |
7587 | """ | |
d14a1e28 RD |
7588 | def __init__(self, title = "wxPython: stdout/stderr"): |
7589 | self.frame = None | |
7590 | self.title = title | |
412d302d RD |
7591 | self.pos = wx.DefaultPosition |
7592 | self.size = (450, 300) | |
d14a1e28 RD |
7593 | self.parent = None |
7594 | ||
7595 | def SetParent(self, parent): | |
6c3b4aae | 7596 | """Set the window to be used as the popup Frame's parent.""" |
d14a1e28 RD |
7597 | self.parent = parent |
7598 | ||
6c3b4aae RD |
7599 | |
7600 | def CreateOutputWindow(self, st): | |
412d302d RD |
7601 | self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size, |
7602 | style=wx.DEFAULT_FRAME_STYLE) | |
196addbf | 7603 | self.text = wx.TextCtrl(self.frame, -1, "", |
412d302d | 7604 | style=wx.TE_MULTILINE|wx.TE_READONLY) |
d1e20054 | 7605 | self.text.AppendText(st) |
6c3b4aae | 7606 | self.frame.Show(True) |
2131d850 | 7607 | self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow) |
6c3b4aae | 7608 | |
d14a1e28 | 7609 | |
7409c0c6 RD |
7610 | def OnCloseWindow(self, event): |
7611 | if self.frame is not None: | |
7612 | self.frame.Destroy() | |
7613 | self.frame = None | |
7614 | self.text = None | |
7615 | ||
7616 | ||
d14a1e28 | 7617 | # These methods provide the file-like output behaviour. |
6c3b4aae RD |
7618 | def write(self, text): |
7619 | """ | |
7620 | Create the output window if needed and write the string to it. | |
7621 | If not called in the context of the gui thread then uses | |
7622 | CallAfter to do the work there. | |
7623 | """ | |
7624 | if self.frame is None: | |
7625 | if not wx.Thread_IsMain(): | |
7626 | wx.CallAfter(self.CreateOutputWindow, text) | |
7627 | else: | |
7628 | self.CreateOutputWindow(text) | |
7629 | else: | |
7630 | if not wx.Thread_IsMain(): | |
7631 | wx.CallAfter(self.text.AppendText, text) | |
7632 | else: | |
7633 | self.text.AppendText(text) | |
7634 | ||
d14a1e28 RD |
7635 | |
7636 | def close(self): | |
6c3b4aae RD |
7637 | if self.frame is not None: |
7638 | wx.CallAfter(self.frame.Close) | |
7639 | ||
d14a1e28 | 7640 | |
19272049 RD |
7641 | def flush(self): |
7642 | pass | |
7643 | ||
7644 | ||
d14a1e28 RD |
7645 | |
7646 | #---------------------------------------------------------------------- | |
d14a1e28 RD |
7647 | |
7648 | _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__') | |
fc46b7f3 | 7649 | |
d14a1e28 | 7650 | class App(wx.PyApp): |
6c3b4aae | 7651 | """ |
66c033b4 RD |
7652 | The ``wx.App`` class represents the application and is used to: |
7653 | ||
7654 | * bootstrap the wxPython system and initialize the underlying | |
7655 | gui toolkit | |
7656 | * set and get application-wide properties | |
7657 | * implement the windowing system main message or event loop, | |
7658 | and to dispatch events to window instances | |
7659 | * etc. | |
7660 | ||
7661 | Every application must have a ``wx.App`` instance, and all | |
7662 | creation of UI objects should be delayed until after the | |
03e37cd5 RD |
7663 | ``wx.App`` object has been created in order to ensure that the gui |
7664 | platform and wxWidgets have been fully initialized. | |
66c033b4 RD |
7665 | |
7666 | Normally you would derive from this class and implement an | |
7667 | ``OnInit`` method that creates a frame and then calls | |
7668 | ``self.SetTopWindow(frame)``. | |
7669 | ||
03e37cd5 | 7670 | :see: `wx.PySimpleApp` for a simpler app class that can be used |
1c0f361b | 7671 | directly. |
6c3b4aae | 7672 | """ |
66c033b4 | 7673 | |
d14a1e28 RD |
7674 | outputWindowClass = PyOnDemandOutputWindow |
7675 | ||
03e37cd5 RD |
7676 | def __init__(self, redirect=_defRedirect, filename=None, |
7677 | useBestVisual=False, clearSigInt=True): | |
66c033b4 RD |
7678 | """ |
7679 | Construct a ``wx.App`` object. | |
7680 | ||
03e37cd5 RD |
7681 | :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be |
7682 | redirected? Defaults to True on Windows and Mac, False | |
7683 | otherwise. If `filename` is None then output will be | |
7684 | redirected to a window that pops up as needed. (You can | |
7685 | control what kind of window is created for the output by | |
7686 | resetting the class variable ``outputWindowClass`` to a | |
7687 | class of your choosing.) | |
66c033b4 | 7688 | |
03e37cd5 RD |
7689 | :param filename: The name of a file to redirect output to, if |
7690 | redirect is True. | |
66c033b4 RD |
7691 | |
7692 | :param useBestVisual: Should the app try to use the best | |
03e37cd5 RD |
7693 | available visual provided by the system (only relevant on |
7694 | systems that have more than one visual.) This parameter | |
7695 | must be used instead of calling `SetUseBestVisual` later | |
7696 | on because it must be set before the underlying GUI | |
7697 | toolkit is initialized. | |
7698 | ||
7699 | :param clearSigInt: Should SIGINT be cleared? This allows the | |
7700 | app to terminate upon a Ctrl-C in the console like other | |
7701 | GUI apps will. | |
66c033b4 RD |
7702 | |
7703 | :note: You should override OnInit to do applicaition | |
7704 | initialization to ensure that the system, toolkit and | |
7705 | wxWidgets are fully initialized. | |
7706 | """ | |
fc46b7f3 | 7707 | |
d14a1e28 RD |
7708 | wx.PyApp.__init__(self) |
7709 | ||
fc46b7f3 | 7710 | # make sure we can create a GUI |
33d6fd3b | 7711 | if not self.IsDisplayAvailable(): |
fc46b7f3 RD |
7712 | |
7713 | if wx.Platform == "__WXMAC__": | |
7714 | msg = """This program needs access to the screen. | |
7715 | Please run with 'pythonw', not 'python', and only when you are logged | |
7716 | in on the main display of your Mac.""" | |
7717 | ||
7718 | elif wx.Platform == "__WXGTK__": | |
7719 | msg ="Unable to access the X Display, is $DISPLAY set properly?" | |
d14a1e28 | 7720 | |
fc46b7f3 RD |
7721 | else: |
7722 | msg = "Unable to create GUI" | |
7723 | # TODO: more description is needed for wxMSW... | |
7724 | ||
7725 | raise SystemExit(msg) | |
7726 | ||
d14a1e28 RD |
7727 | # This has to be done before OnInit |
7728 | self.SetUseBestVisual(useBestVisual) | |
7729 | ||
7730 | # Set the default handler for SIGINT. This fixes a problem | |
7731 | # where if Ctrl-C is pressed in the console that started this | |
7732 | # app then it will not appear to do anything, (not even send | |
7733 | # KeyboardInterrupt???) but will later segfault on exit. By | |
7734 | # setting the default handler then the app will exit, as | |
7735 | # expected (depending on platform.) | |
03e37cd5 RD |
7736 | if clearSigInt: |
7737 | try: | |
7738 | import signal | |
7739 | signal.signal(signal.SIGINT, signal.SIG_DFL) | |
7740 | except: | |
7741 | pass | |
d14a1e28 RD |
7742 | |
7743 | # Save and redirect the stdio to a window? | |
7744 | self.stdioWin = None | |
7745 | self.saveStdio = (_sys.stdout, _sys.stderr) | |
7746 | if redirect: | |
7747 | self.RedirectStdio(filename) | |
7748 | ||
8fb0e70a RD |
7749 | # Use Python's install prefix as the default |
7750 | wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix) | |
7751 | ||
48a0c021 RD |
7752 | # Until the new native control for wxMac is up to par, still use the generic one. |
7753 | wx.SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1) | |
7754 | ||
d14a1e28 RD |
7755 | # This finishes the initialization of wxWindows and then calls |
7756 | # the OnInit that should be present in the derived class | |
7757 | self._BootstrapApp() | |
7758 | ||
7759 | ||
01f6b6d3 RD |
7760 | def OnPreInit(self): |
7761 | """ | |
7762 | Things that must be done after _BootstrapApp has done its | |
7763 | thing, but would be nice if they were already done by the time | |
7764 | that OnInit is called. | |
7765 | """ | |
7766 | wx.StockGDI._initStockObjects() | |
7767 | ||
7768 | ||
02b455f2 RD |
7769 | def __del__(self, destroy=wx.PyApp.__del__): |
7770 | self.RestoreStdio() # Just in case the MainLoop was overridden | |
7771 | destroy(self) | |
d14a1e28 | 7772 | |
70b7a5fe | 7773 | def Destroy(self): |
b39fe951 | 7774 | self.this.own(False) |
70b7a5fe | 7775 | wx.PyApp.Destroy(self) |
d14a1e28 RD |
7776 | |
7777 | def SetTopWindow(self, frame): | |
1e0c8722 | 7778 | """Set the \"main\" top level window""" |
d14a1e28 RD |
7779 | if self.stdioWin: |
7780 | self.stdioWin.SetParent(frame) | |
7781 | wx.PyApp.SetTopWindow(self, frame) | |
7782 | ||
7783 | ||
7784 | def MainLoop(self): | |
1e0c8722 | 7785 | """Execute the main GUI event loop""" |
d14a1e28 RD |
7786 | wx.PyApp.MainLoop(self) |
7787 | self.RestoreStdio() | |
7788 | ||
7789 | ||
7409c0c6 | 7790 | def RedirectStdio(self, filename=None): |
1e0c8722 | 7791 | """Redirect sys.stdout and sys.stderr to a file or a popup window.""" |
d14a1e28 RD |
7792 | if filename: |
7793 | _sys.stdout = _sys.stderr = open(filename, 'a') | |
7794 | else: | |
7795 | self.stdioWin = self.outputWindowClass() | |
7796 | _sys.stdout = _sys.stderr = self.stdioWin | |
7797 | ||
7798 | ||
7799 | def RestoreStdio(self): | |
02b455f2 RD |
7800 | try: |
7801 | _sys.stdout, _sys.stderr = self.saveStdio | |
7802 | except: | |
7803 | pass | |
d14a1e28 RD |
7804 | |
7805 | ||
412d302d RD |
7806 | def SetOutputWindowAttributes(self, title=None, pos=None, size=None): |
7807 | """ | |
7808 | Set the title, position and/or size of the output window if | |
f5b96ee1 RD |
7809 | the stdio has been redirected. This should be called before |
7810 | any output would cause the output window to be created. | |
412d302d RD |
7811 | """ |
7812 | if self.stdioWin: | |
7813 | if title is not None: | |
7814 | self.stdioWin.title = title | |
7815 | if pos is not None: | |
7816 | self.stdioWin.pos = pos | |
7817 | if size is not None: | |
7818 | self.stdioWin.size = size | |
7819 | ||
7820 | ||
7821 | ||
d14a1e28 | 7822 | |
66c033b4 | 7823 | # change from wx.PyApp_XX to wx.App_XX |
54f9ee45 RD |
7824 | App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts |
7825 | App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId | |
7826 | App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId | |
7827 | App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId | |
7828 | App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName | |
7829 | App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts | |
7830 | App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId | |
7831 | App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId | |
7832 | App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId | |
7833 | App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName | |
7834 | App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version | |
d14a1e28 RD |
7835 | |
7836 | #---------------------------------------------------------------------------- | |
7837 | ||
7838 | class PySimpleApp(wx.App): | |
6c3b4aae RD |
7839 | """ |
7840 | A simple application class. You can just create one of these and | |
7841 | then then make your top level windows later, and not have to worry | |
66c033b4 RD |
7842 | about OnInit. For example:: |
7843 | ||
7844 | app = wx.PySimpleApp() | |
7845 | frame = wx.Frame(None, title='Hello World') | |
7846 | frame.Show() | |
7847 | app.MainLoop() | |
7848 | ||
7849 | :see: `wx.App` | |
7850 | """ | |
6c3b4aae | 7851 | |
03e37cd5 RD |
7852 | def __init__(self, redirect=False, filename=None, |
7853 | useBestVisual=False, clearSigInt=True): | |
66c033b4 RD |
7854 | """ |
7855 | :see: `wx.App.__init__` | |
7856 | """ | |
03e37cd5 | 7857 | wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt) |
6c3b4aae | 7858 | |
d14a1e28 | 7859 | def OnInit(self): |
d14a1e28 RD |
7860 | return True |
7861 | ||
7862 | ||
66c033b4 | 7863 | |
6c3b4aae | 7864 | # Is anybody using this one? |
d14a1e28 RD |
7865 | class PyWidgetTester(wx.App): |
7866 | def __init__(self, size = (250, 100)): | |
7867 | self.size = size | |
7868 | wx.App.__init__(self, 0) | |
7869 | ||
7870 | def OnInit(self): | |
196addbf | 7871 | self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size) |
d14a1e28 RD |
7872 | self.SetTopWindow(self.frame) |
7873 | return True | |
7874 | ||
66c033b4 RD |
7875 | def SetWidget(self, widgetClass, *args, **kwargs): |
7876 | w = widgetClass(self.frame, *args, **kwargs) | |
d14a1e28 RD |
7877 | self.frame.Show(True) |
7878 | ||
7879 | #---------------------------------------------------------------------------- | |
7880 | # DO NOT hold any other references to this object. This is how we | |
66c033b4 | 7881 | # know when to cleanup system resources that wxWidgets is holding. When |
d14a1e28 | 7882 | # the sys module is unloaded, the refcount on sys.__wxPythonCleanup |
66c033b4 | 7883 | # goes to zero and it calls the wx.App_CleanUp function. |
d14a1e28 RD |
7884 | |
7885 | class __wxPyCleanup: | |
7886 | def __init__(self): | |
54f9ee45 | 7887 | self.cleanup = _core_.App_CleanUp |
d14a1e28 RD |
7888 | def __del__(self): |
7889 | self.cleanup() | |
7890 | ||
7891 | _sys.__wxPythonCleanup = __wxPyCleanup() | |
7892 | ||
7893 | ## # another possible solution, but it gets called too early... | |
66c033b4 RD |
7894 | ## import atexit |
7895 | ## atexit.register(_core_.wxApp_CleanUp) | |
d14a1e28 RD |
7896 | |
7897 | ||
7898 | #---------------------------------------------------------------------------- | |
7899 | ||
7900 | #--------------------------------------------------------------------------- | |
2ef75293 RD |
7901 | |
7902 | class EventLoop(object): | |
093d3ff1 | 7903 | """Proxy of C++ EventLoop class""" |
0085ce49 RD |
7904 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7905 | __repr__ = _swig_repr | |
7906 | def __init__(self, *args, **kwargs): | |
2ef75293 | 7907 | """__init__(self) -> EventLoop""" |
0085ce49 RD |
7908 | _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs)) |
7909 | __swig_destroy__ = _core_.delete_EventLoop | |
7910 | __del__ = lambda self : None; | |
2ef75293 RD |
7911 | def Run(*args, **kwargs): |
7912 | """Run(self) -> int""" | |
7913 | return _core_.EventLoop_Run(*args, **kwargs) | |
7914 | ||
7915 | def Exit(*args, **kwargs): | |
7916 | """Exit(self, int rc=0)""" | |
7917 | return _core_.EventLoop_Exit(*args, **kwargs) | |
7918 | ||
7919 | def Pending(*args, **kwargs): | |
7920 | """Pending(self) -> bool""" | |
7921 | return _core_.EventLoop_Pending(*args, **kwargs) | |
7922 | ||
7923 | def Dispatch(*args, **kwargs): | |
7924 | """Dispatch(self) -> bool""" | |
7925 | return _core_.EventLoop_Dispatch(*args, **kwargs) | |
7926 | ||
7927 | def IsRunning(*args, **kwargs): | |
7928 | """IsRunning(self) -> bool""" | |
7929 | return _core_.EventLoop_IsRunning(*args, **kwargs) | |
7930 | ||
7931 | def GetActive(*args, **kwargs): | |
7932 | """GetActive() -> EventLoop""" | |
7933 | return _core_.EventLoop_GetActive(*args, **kwargs) | |
7934 | ||
7935 | GetActive = staticmethod(GetActive) | |
7936 | def SetActive(*args, **kwargs): | |
7937 | """SetActive(EventLoop loop)""" | |
7938 | return _core_.EventLoop_SetActive(*args, **kwargs) | |
7939 | ||
7940 | SetActive = staticmethod(SetActive) | |
2131d850 | 7941 | _core_.EventLoop_swigregister(EventLoop) |
2ef75293 | 7942 | |
0085ce49 RD |
7943 | def EventLoop_GetActive(*args): |
7944 | """EventLoop_GetActive() -> EventLoop""" | |
7945 | return _core_.EventLoop_GetActive(*args) | |
2ef75293 RD |
7946 | |
7947 | def EventLoop_SetActive(*args, **kwargs): | |
0085ce49 RD |
7948 | """EventLoop_SetActive(EventLoop loop)""" |
7949 | return _core_.EventLoop_SetActive(*args, **kwargs) | |
2ef75293 | 7950 | |
091f5bed RD |
7951 | class EventLoopActivator(object): |
7952 | """Proxy of C++ EventLoopActivator class""" | |
0085ce49 RD |
7953 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7954 | __repr__ = _swig_repr | |
7955 | def __init__(self, *args, **kwargs): | |
091f5bed | 7956 | """__init__(self, EventLoop evtLoop) -> EventLoopActivator""" |
0085ce49 RD |
7957 | _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs)) |
7958 | __swig_destroy__ = _core_.delete_EventLoopActivator | |
7959 | __del__ = lambda self : None; | |
2131d850 | 7960 | _core_.EventLoopActivator_swigregister(EventLoopActivator) |
091f5bed | 7961 | |
2ef75293 | 7962 | #--------------------------------------------------------------------------- |
d14a1e28 | 7963 | |
eec1c382 RD |
7964 | ACCEL_ALT = _core_.ACCEL_ALT |
7965 | ACCEL_CTRL = _core_.ACCEL_CTRL | |
7966 | ACCEL_SHIFT = _core_.ACCEL_SHIFT | |
7967 | ACCEL_NORMAL = _core_.ACCEL_NORMAL | |
7968 | ACCEL_CMD = _core_.ACCEL_CMD | |
1e0c8722 | 7969 | class AcceleratorEntry(object): |
66c033b4 RD |
7970 | """ |
7971 | A class used to define items in an `wx.AcceleratorTable`. wxPython | |
7972 | programs can choose to use wx.AcceleratorEntry objects, but using a | |
7973 | list of 3-tuple of integers (flags, keyCode, cmdID) usually works just | |
41e2b43e | 7974 | as well. See `__init__` for of the tuple values. |
66c033b4 RD |
7975 | |
7976 | :see: `wx.AcceleratorTable` | |
7977 | """ | |
0085ce49 RD |
7978 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7979 | __repr__ = _swig_repr | |
7980 | def __init__(self, *args, **kwargs): | |
66c033b4 RD |
7981 | """ |
7982 | __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry | |
7983 | ||
7984 | Construct a wx.AcceleratorEntry. | |
66c033b4 | 7985 | """ |
0085ce49 RD |
7986 | _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs)) |
7987 | __swig_destroy__ = _core_.delete_AcceleratorEntry | |
7988 | __del__ = lambda self : None; | |
1e0c8722 | 7989 | def Set(*args, **kwargs): |
66c033b4 RD |
7990 | """ |
7991 | Set(self, int flags, int keyCode, int cmd) | |
1e0c8722 | 7992 | |
66c033b4 RD |
7993 | (Re)set the attributes of a wx.AcceleratorEntry. |
7994 | :see `__init__` | |
7995 | """ | |
7996 | return _core_.AcceleratorEntry_Set(*args, **kwargs) | |
1e0c8722 | 7997 | |
97ab0f6a RD |
7998 | def Create(*args, **kwargs): |
7999 | """ | |
8000 | Create(String str) -> AcceleratorEntry | |
8001 | ||
8002 | Create accelerator corresponding to the specified string, or None if | |
8003 | it coulnd't be parsed. | |
8004 | """ | |
8005 | return _core_.AcceleratorEntry_Create(*args, **kwargs) | |
8006 | ||
8007 | Create = staticmethod(Create) | |
1e0c8722 | 8008 | def GetFlags(*args, **kwargs): |
66c033b4 RD |
8009 | """ |
8010 | GetFlags(self) -> int | |
8011 | ||
8012 | Get the AcceleratorEntry's flags. | |
8013 | """ | |
54f9ee45 | 8014 | return _core_.AcceleratorEntry_GetFlags(*args, **kwargs) |
1e0c8722 RD |
8015 | |
8016 | def GetKeyCode(*args, **kwargs): | |
66c033b4 RD |
8017 | """ |
8018 | GetKeyCode(self) -> int | |
8019 | ||
8020 | Get the AcceleratorEntry's keycode. | |
8021 | """ | |
54f9ee45 | 8022 | return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs) |
1e0c8722 RD |
8023 | |
8024 | def GetCommand(*args, **kwargs): | |
66c033b4 RD |
8025 | """ |
8026 | GetCommand(self) -> int | |
8027 | ||
8028 | Get the AcceleratorEntry's command ID. | |
8029 | """ | |
54f9ee45 | 8030 | return _core_.AcceleratorEntry_GetCommand(*args, **kwargs) |
1e0c8722 | 8031 | |
97ab0f6a RD |
8032 | def IsOk(*args, **kwargs): |
8033 | """IsOk(self) -> bool""" | |
8034 | return _core_.AcceleratorEntry_IsOk(*args, **kwargs) | |
8035 | ||
8036 | def ToString(*args, **kwargs): | |
8037 | """ | |
8038 | ToString(self) -> String | |
8039 | ||
8040 | Returns a string representation for the this accelerator. The string | |
8041 | is formatted using the <flags>-<keycode> format where <flags> maybe a | |
8042 | hyphen-separed list of "shift|alt|ctrl" | |
8043 | ||
8044 | """ | |
8045 | return _core_.AcceleratorEntry_ToString(*args, **kwargs) | |
8046 | ||
8047 | def FromString(*args, **kwargs): | |
8048 | """ | |
8049 | FromString(self, String str) -> bool | |
8050 | ||
8051 | Returns true if the given string correctly initialized this object. | |
8052 | """ | |
8053 | return _core_.AcceleratorEntry_FromString(*args, **kwargs) | |
8054 | ||
2bf58437 RD |
8055 | Command = property(GetCommand,doc="See `GetCommand`") |
8056 | Flags = property(GetFlags,doc="See `GetFlags`") | |
8057 | KeyCode = property(GetKeyCode,doc="See `GetKeyCode`") | |
2131d850 | 8058 | _core_.AcceleratorEntry_swigregister(AcceleratorEntry) |
1e0c8722 | 8059 | |
97ab0f6a RD |
8060 | def AcceleratorEntry_Create(*args, **kwargs): |
8061 | """ | |
8062 | AcceleratorEntry_Create(String str) -> AcceleratorEntry | |
8063 | ||
8064 | Create accelerator corresponding to the specified string, or None if | |
8065 | it coulnd't be parsed. | |
8066 | """ | |
8067 | return _core_.AcceleratorEntry_Create(*args, **kwargs) | |
8068 | ||
1e0c8722 | 8069 | class AcceleratorTable(Object): |
66c033b4 RD |
8070 | """ |
8071 | An accelerator table allows the application to specify a table of | |
8072 | keyboard shortcuts for menus or other commands. On Windows, menu or | |
8073 | button commands are supported; on GTK, only menu commands are | |
8074 | supported. | |
66c033b4 | 8075 | """ |
0085ce49 RD |
8076 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
8077 | __repr__ = _swig_repr | |
8078 | def __init__(self, *args, **kwargs): | |
0df68c9f RD |
8079 | """ |
8080 | __init__(entries) -> AcceleratorTable | |
1e0c8722 | 8081 | |
66c033b4 RD |
8082 | Construct an AcceleratorTable from a list of `wx.AcceleratorEntry` |
8083 | items or or of 3-tuples (flags, keyCode, cmdID) | |
8084 | ||
8085 | :see: `wx.AcceleratorEntry` | |
0df68c9f | 8086 | """ |
0085ce49 RD |
8087 | _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs)) |
8088 | __swig_destroy__ = _core_.delete_AcceleratorTable | |
8089 | __del__ = lambda self : None; | |
b39fe951 RD |
8090 | def IsOk(*args, **kwargs): |
8091 | """IsOk(self) -> bool""" | |
8092 | return _core_.AcceleratorTable_IsOk(*args, **kwargs) | |
1e0c8722 | 8093 | |
b39fe951 | 8094 | Ok = IsOk |
2131d850 | 8095 | _core_.AcceleratorTable_swigregister(AcceleratorTable) |
1e0c8722 RD |
8096 | |
8097 | ||
8098 | def GetAccelFromString(*args, **kwargs): | |
0085ce49 RD |
8099 | """GetAccelFromString(String label) -> AcceleratorEntry""" |
8100 | return _core_.GetAccelFromString(*args, **kwargs) | |
1e0c8722 RD |
8101 | #--------------------------------------------------------------------------- |
8102 | ||
74a57fcd RD |
8103 | class VisualAttributes(object): |
8104 | """struct containing all the visual attributes of a control""" | |
0085ce49 RD |
8105 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
8106 | __repr__ = _swig_repr | |
8107 | def __init__(self, *args, **kwargs): | |
74a57fcd | 8108 | """ |
a95a7133 | 8109 | __init__(self) -> VisualAttributes |
74a57fcd RD |
8110 | |
8111 | struct containing all the visual attributes of a control | |
8112 | """ | |
0085ce49 RD |
8113 | _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs)) |
8114 | __swig_destroy__ = _core_.delete_VisualAttributes | |
8115 | __del__ = lambda self : None; | |
54f9ee45 RD |
8116 | font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set) |
8117 | colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set) | |
8118 | colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set) | |
2131d850 | 8119 | _core_.VisualAttributes_swigregister(VisualAttributes) |
74a57fcd RD |
8120 | NullAcceleratorTable = cvar.NullAcceleratorTable |
8121 | PanelNameStr = cvar.PanelNameStr | |
8122 | ||
54f9ee45 RD |
8123 | WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL |
8124 | WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL | |
8125 | WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI | |
8126 | WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE | |
8127 | WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX | |
d14a1e28 | 8128 | class Window(EvtHandler): |
15afbcd0 RD |
8129 | """ |
8130 | wx.Window is the base class for all windows and represents any visible | |
8131 | object on the screen. All controls, top level windows and so on are | |
8132 | wx.Windows. Sizers and device contexts are not however, as they don't | |
8133 | appear on screen themselves. | |
8134 | ||
8135 | """ | |
0085ce49 RD |
8136 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
8137 | __repr__ = _swig_repr | |
8138 | def __init__(self, *args, **kwargs): | |
0df68c9f | 8139 | """ |
a95a7133 | 8140 | __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
74a57fcd | 8141 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window |
15afbcd0 RD |
8142 | |
8143 | Construct and show a generic Window. | |
0df68c9f | 8144 | """ |
0085ce49 | 8145 | _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs)) |
d14a1e28 | 8146 | self._setOORInfo(self) |
d14a1e28 | 8147 | |
e811c8ce | 8148 | def Create(*args, **kwargs): |
0df68c9f | 8149 | """ |
a95a7133 | 8150 | Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
74a57fcd | 8151 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool |
15afbcd0 RD |
8152 | |
8153 | Create the GUI part of the Window for 2-phase creation mode. | |
0df68c9f | 8154 | """ |
54f9ee45 | 8155 | return _core_.Window_Create(*args, **kwargs) |
d14a1e28 | 8156 | |
e811c8ce | 8157 | def Close(*args, **kwargs): |
15afbcd0 | 8158 | """ |
a95a7133 | 8159 | Close(self, bool force=False) -> bool |
15afbcd0 RD |
8160 | |
8161 | This function simply generates a EVT_CLOSE event whose handler usually | |
8162 | tries to close the window. It doesn't close the window itself, | |
8163 | however. If force is False (the default) then the window's close | |
8164 | handler will be allowed to veto the destruction of the window. | |
15afbcd0 | 8165 | """ |
54f9ee45 | 8166 | return _core_.Window_Close(*args, **kwargs) |
d14a1e28 | 8167 | |
e811c8ce | 8168 | def Destroy(*args, **kwargs): |
0df68c9f | 8169 | """ |
a95a7133 | 8170 | Destroy(self) -> bool |
d14a1e28 | 8171 | |
15afbcd0 RD |
8172 | Destroys the window safely. Frames and dialogs are not destroyed |
8173 | immediately when this function is called -- they are added to a list | |
8174 | of windows to be deleted on idle time, when all the window's events | |
8175 | have been processed. This prevents problems with events being sent to | |
8176 | non-existent windows. | |
8177 | ||
8178 | Returns True if the window has either been successfully deleted, or it | |
8179 | has been added to the list of windows pending real deletion. | |
0df68c9f | 8180 | """ |
b39fe951 RD |
8181 | args[0].this.own(False) |
8182 | return _core_.Window_Destroy(*args, **kwargs) | |
d14a1e28 | 8183 | |
e811c8ce | 8184 | def DestroyChildren(*args, **kwargs): |
15afbcd0 | 8185 | """ |
a95a7133 | 8186 | DestroyChildren(self) -> bool |
15afbcd0 | 8187 | |
41e2b43e RD |
8188 | Destroys all children of a window. Called automatically by the |
8189 | destructor. | |
15afbcd0 | 8190 | """ |
54f9ee45 | 8191 | return _core_.Window_DestroyChildren(*args, **kwargs) |
d14a1e28 | 8192 | |
e811c8ce | 8193 | def IsBeingDeleted(*args, **kwargs): |
15afbcd0 | 8194 | """ |
a95a7133 | 8195 | IsBeingDeleted(self) -> bool |
15afbcd0 RD |
8196 | |
8197 | Is the window in the process of being deleted? | |
8198 | """ | |
54f9ee45 | 8199 | return _core_.Window_IsBeingDeleted(*args, **kwargs) |
d14a1e28 | 8200 | |
e811c8ce | 8201 | def SetLabel(*args, **kwargs): |
15afbcd0 | 8202 | """ |
a95a7133 | 8203 | SetLabel(self, String label) |
15afbcd0 RD |
8204 | |
8205 | Set the text which the window shows in its label if applicable. | |
8206 | """ | |
54f9ee45 | 8207 | return _core_.Window_SetLabel(*args, **kwargs) |
d14a1e28 | 8208 | |
e811c8ce | 8209 | def GetLabel(*args, **kwargs): |
15afbcd0 | 8210 | """ |
a95a7133 | 8211 | GetLabel(self) -> String |
15afbcd0 | 8212 | |
41e2b43e RD |
8213 | Generic way of getting a label from any window, for identification |
8214 | purposes. The interpretation of this function differs from class to | |
8215 | class. For frames and dialogs, the value returned is the title. For | |
8216 | buttons or static text controls, it is the button text. This function | |
8217 | can be useful for meta-programs such as testing tools or special-needs | |
8218 | access programs)which need to identify windows by name. | |
15afbcd0 | 8219 | """ |
54f9ee45 | 8220 | return _core_.Window_GetLabel(*args, **kwargs) |
d14a1e28 | 8221 | |
e811c8ce | 8222 | def SetName(*args, **kwargs): |
15afbcd0 | 8223 | """ |
a95a7133 | 8224 | SetName(self, String name) |
15afbcd0 | 8225 | |
41e2b43e RD |
8226 | Sets the window's name. The window name is used for ressource setting |
8227 | in X, it is not the same as the window title/label | |
15afbcd0 | 8228 | """ |
54f9ee45 | 8229 | return _core_.Window_SetName(*args, **kwargs) |
d14a1e28 | 8230 | |
e811c8ce | 8231 | def GetName(*args, **kwargs): |
15afbcd0 | 8232 | """ |
a95a7133 | 8233 | GetName(self) -> String |
15afbcd0 | 8234 | |
41e2b43e RD |
8235 | Returns the windows name. This name is not guaranteed to be unique; |
8236 | it is up to the programmer to supply an appropriate name in the window | |
8237 | constructor or via wx.Window.SetName. | |
15afbcd0 | 8238 | """ |
54f9ee45 | 8239 | return _core_.Window_GetName(*args, **kwargs) |
d14a1e28 | 8240 | |
4276dc52 RD |
8241 | def SetWindowVariant(*args, **kwargs): |
8242 | """ | |
a95a7133 | 8243 | SetWindowVariant(self, int variant) |
4276dc52 | 8244 | |
41e2b43e RD |
8245 | Sets the variant of the window/font size to use for this window, if |
8246 | the platform supports variants, for example, wxMac. | |
4276dc52 | 8247 | """ |
54f9ee45 | 8248 | return _core_.Window_SetWindowVariant(*args, **kwargs) |
4276dc52 RD |
8249 | |
8250 | def GetWindowVariant(*args, **kwargs): | |
a95a7133 | 8251 | """GetWindowVariant(self) -> int""" |
54f9ee45 | 8252 | return _core_.Window_GetWindowVariant(*args, **kwargs) |
4276dc52 | 8253 | |
e811c8ce | 8254 | def SetId(*args, **kwargs): |
15afbcd0 | 8255 | """ |
a95a7133 | 8256 | SetId(self, int winid) |
15afbcd0 RD |
8257 | |
8258 | Sets the identifier of the window. Each window has an integer | |
8259 | identifier. If the application has not provided one, an identifier | |
8260 | will be generated. Normally, the identifier should be provided on | |
8261 | creation and should not be modified subsequently. | |
8262 | """ | |
54f9ee45 | 8263 | return _core_.Window_SetId(*args, **kwargs) |
d14a1e28 | 8264 | |
e811c8ce | 8265 | def GetId(*args, **kwargs): |
15afbcd0 | 8266 | """ |
a95a7133 | 8267 | GetId(self) -> int |
15afbcd0 RD |
8268 | |
8269 | Returns the identifier of the window. Each window has an integer | |
8270 | identifier. If the application has not provided one (or the default Id | |
8271 | -1 is used) then an unique identifier with a negative value will be | |
8272 | generated. | |
8273 | """ | |
54f9ee45 | 8274 | return _core_.Window_GetId(*args, **kwargs) |
d14a1e28 | 8275 | |
e811c8ce | 8276 | def NewControlId(*args, **kwargs): |
15afbcd0 | 8277 | """ |
66c033b4 | 8278 | NewControlId() -> int |
15afbcd0 RD |
8279 | |
8280 | Generate a control id for the controls which were not given one. | |
8281 | """ | |
54f9ee45 | 8282 | return _core_.Window_NewControlId(*args, **kwargs) |
d14a1e28 | 8283 | |
e811c8ce RD |
8284 | NewControlId = staticmethod(NewControlId) |
8285 | def NextControlId(*args, **kwargs): | |
15afbcd0 | 8286 | """ |
66c033b4 | 8287 | NextControlId(int winid) -> int |
15afbcd0 RD |
8288 | |
8289 | Get the id of the control following the one with the given | |
41e2b43e | 8290 | autogenerated) id |
15afbcd0 | 8291 | """ |
54f9ee45 | 8292 | return _core_.Window_NextControlId(*args, **kwargs) |
d14a1e28 | 8293 | |
e811c8ce RD |
8294 | NextControlId = staticmethod(NextControlId) |
8295 | def PrevControlId(*args, **kwargs): | |
15afbcd0 | 8296 | """ |
66c033b4 | 8297 | PrevControlId(int winid) -> int |
15afbcd0 RD |
8298 | |
8299 | Get the id of the control preceding the one with the given | |
41e2b43e | 8300 | autogenerated) id |
15afbcd0 | 8301 | """ |
54f9ee45 | 8302 | return _core_.Window_PrevControlId(*args, **kwargs) |
d14a1e28 | 8303 | |
e811c8ce | 8304 | PrevControlId = staticmethod(PrevControlId) |
97ab0f6a RD |
8305 | def GetLayoutDirection(*args, **kwargs): |
8306 | """ | |
994453b8 | 8307 | GetLayoutDirection(self) -> int |
97ab0f6a RD |
8308 | |
8309 | Get the layout direction (LTR or RTL) for this window. Returns | |
8310 | ``wx.Layout_Default`` if layout direction is not supported. | |
8311 | """ | |
8312 | return _core_.Window_GetLayoutDirection(*args, **kwargs) | |
8313 | ||
8314 | def SetLayoutDirection(*args, **kwargs): | |
8315 | """ | |
994453b8 | 8316 | SetLayoutDirection(self, int dir) |
97ab0f6a RD |
8317 | |
8318 | Set the layout direction (LTR or RTL) for this window. | |
8319 | """ | |
8320 | return _core_.Window_SetLayoutDirection(*args, **kwargs) | |
8321 | ||
8322 | def AdjustForLayoutDirection(*args, **kwargs): | |
8323 | """ | |
8324 | AdjustForLayoutDirection(self, int x, int width, int widthTotal) -> int | |
8325 | ||
8326 | Mirror coordinates for RTL layout if this window uses it and if the | |
8327 | mirroring is not done automatically like Win32. | |
8328 | """ | |
8329 | return _core_.Window_AdjustForLayoutDirection(*args, **kwargs) | |
8330 | ||
e811c8ce | 8331 | def SetSize(*args, **kwargs): |
15afbcd0 | 8332 | """ |
a95a7133 | 8333 | SetSize(self, Size size) |
15afbcd0 RD |
8334 | |
8335 | Sets the size of the window in pixels. | |
8336 | """ | |
54f9ee45 | 8337 | return _core_.Window_SetSize(*args, **kwargs) |
d14a1e28 | 8338 | |
e811c8ce | 8339 | def SetDimensions(*args, **kwargs): |
15afbcd0 | 8340 | """ |
a95a7133 | 8341 | SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) |
15afbcd0 RD |
8342 | |
8343 | Sets the position and size of the window in pixels. The sizeFlags | |
8344 | parameter indicates the interpretation of the other params if they are | |
e505d15e RD |
8345 | equal to -1. |
8346 | ||
8347 | ======================== ====================================== | |
8348 | wx.SIZE_AUTO A -1 indicates that a class-specific | |
8349 | default should be used. | |
8350 | wx.SIZE_USE_EXISTING Axisting dimensions should be used if | |
8351 | -1 values are supplied. | |
8352 | wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be | |
8353 | interpreted as real dimensions, not | |
8354 | default values. | |
8355 | ======================== ====================================== | |
8356 | ||
15afbcd0 | 8357 | """ |
54f9ee45 | 8358 | return _core_.Window_SetDimensions(*args, **kwargs) |
d14a1e28 | 8359 | |
e811c8ce | 8360 | def SetRect(*args, **kwargs): |
15afbcd0 | 8361 | """ |
a95a7133 | 8362 | SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) |
15afbcd0 RD |
8363 | |
8364 | Sets the position and size of the window in pixels using a wx.Rect. | |
8365 | """ | |
54f9ee45 | 8366 | return _core_.Window_SetRect(*args, **kwargs) |
d14a1e28 | 8367 | |
e811c8ce | 8368 | def SetSizeWH(*args, **kwargs): |
15afbcd0 | 8369 | """ |
a95a7133 | 8370 | SetSizeWH(self, int width, int height) |
15afbcd0 RD |
8371 | |
8372 | Sets the size of the window in pixels. | |
8373 | """ | |
54f9ee45 | 8374 | return _core_.Window_SetSizeWH(*args, **kwargs) |
d14a1e28 | 8375 | |
e811c8ce | 8376 | def Move(*args, **kwargs): |
15afbcd0 | 8377 | """ |
a95a7133 | 8378 | Move(self, Point pt, int flags=SIZE_USE_EXISTING) |
15afbcd0 RD |
8379 | |
8380 | Moves the window to the given position. | |
8381 | """ | |
54f9ee45 | 8382 | return _core_.Window_Move(*args, **kwargs) |
d14a1e28 | 8383 | |
e811c8ce RD |
8384 | SetPosition = Move |
8385 | def MoveXY(*args, **kwargs): | |
15afbcd0 | 8386 | """ |
a95a7133 | 8387 | MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) |
15afbcd0 RD |
8388 | |
8389 | Moves the window to the given position. | |
8390 | """ | |
54f9ee45 | 8391 | return _core_.Window_MoveXY(*args, **kwargs) |
e811c8ce | 8392 | |
580080c5 | 8393 | def SetInitialSize(*args, **kwargs): |
f8167d6e | 8394 | """ |
580080c5 | 8395 | SetInitialSize(self, Size size=DefaultSize) |
f8167d6e RD |
8396 | |
8397 | A 'Smart' SetSize that will fill in default size components with the | |
8398 | window's *best size* values. Also set's the minsize for use with sizers. | |
8399 | """ | |
580080c5 | 8400 | return _core_.Window_SetInitialSize(*args, **kwargs) |
f8167d6e | 8401 | |
580080c5 | 8402 | SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`') |
e811c8ce | 8403 | def Raise(*args, **kwargs): |
15afbcd0 | 8404 | """ |
a95a7133 | 8405 | Raise(self) |
15afbcd0 | 8406 | |
943e8dfd | 8407 | Raises the window to the top of the window hierarchy. In current |
70b63a99 | 8408 | version of wxWidgets this works both for managed and child windows. |
15afbcd0 | 8409 | """ |
54f9ee45 | 8410 | return _core_.Window_Raise(*args, **kwargs) |
e811c8ce RD |
8411 | |
8412 | def Lower(*args, **kwargs): | |
15afbcd0 | 8413 | """ |
a95a7133 | 8414 | Lower(self) |
15afbcd0 | 8415 | |
943e8dfd | 8416 | Lowers the window to the bottom of the window hierarchy. In current |
70b63a99 | 8417 | version of wxWidgets this works both for managed and child windows. |
15afbcd0 | 8418 | """ |
54f9ee45 | 8419 | return _core_.Window_Lower(*args, **kwargs) |
e811c8ce RD |
8420 | |
8421 | def SetClientSize(*args, **kwargs): | |
15afbcd0 | 8422 | """ |
a95a7133 | 8423 | SetClientSize(self, Size size) |
15afbcd0 RD |
8424 | |
8425 | This sets the size of the window client area in pixels. Using this | |
8426 | function to size a window tends to be more device-independent than | |
8427 | wx.Window.SetSize, since the application need not worry about what | |
8428 | dimensions the border or title bar have when trying to fit the window | |
8429 | around panel items, for example. | |
8430 | """ | |
54f9ee45 | 8431 | return _core_.Window_SetClientSize(*args, **kwargs) |
e811c8ce RD |
8432 | |
8433 | def SetClientSizeWH(*args, **kwargs): | |
15afbcd0 | 8434 | """ |
a95a7133 | 8435 | SetClientSizeWH(self, int width, int height) |
15afbcd0 RD |
8436 | |
8437 | This sets the size of the window client area in pixels. Using this | |
8438 | function to size a window tends to be more device-independent than | |
8439 | wx.Window.SetSize, since the application need not worry about what | |
8440 | dimensions the border or title bar have when trying to fit the window | |
8441 | around panel items, for example. | |
8442 | """ | |
54f9ee45 | 8443 | return _core_.Window_SetClientSizeWH(*args, **kwargs) |
e811c8ce RD |
8444 | |
8445 | def SetClientRect(*args, **kwargs): | |
15afbcd0 | 8446 | """ |
a95a7133 | 8447 | SetClientRect(self, Rect rect) |
15afbcd0 RD |
8448 | |
8449 | This sets the size of the window client area in pixels. Using this | |
8450 | function to size a window tends to be more device-independent than | |
8451 | wx.Window.SetSize, since the application need not worry about what | |
8452 | dimensions the border or title bar have when trying to fit the window | |
8453 | around panel items, for example. | |
8454 | """ | |
54f9ee45 | 8455 | return _core_.Window_SetClientRect(*args, **kwargs) |
e811c8ce RD |
8456 | |
8457 | def GetPosition(*args, **kwargs): | |
0df68c9f | 8458 | """ |
a95a7133 | 8459 | GetPosition(self) -> Point |
e811c8ce | 8460 | |
75219dcb RD |
8461 | Get the window's position. Notice that the position is in client |
8462 | coordinates for child windows and screen coordinates for the top level | |
8463 | ones, use `GetScreenPosition` if you need screen coordinates for all | |
8464 | kinds of windows. | |
0df68c9f | 8465 | """ |
54f9ee45 | 8466 | return _core_.Window_GetPosition(*args, **kwargs) |
e811c8ce RD |
8467 | |
8468 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
8469 | """ |
8470 | GetPositionTuple() -> (x,y) | |
e811c8ce | 8471 | |
75219dcb RD |
8472 | Get the window's position. Notice that the position is in client |
8473 | coordinates for child windows and screen coordinates for the top level | |
8474 | ones, use `GetScreenPosition` if you need screen coordinates for all | |
8475 | kinds of windows. | |
0df68c9f | 8476 | """ |
54f9ee45 | 8477 | return _core_.Window_GetPositionTuple(*args, **kwargs) |
e811c8ce | 8478 | |
75219dcb RD |
8479 | def GetScreenPosition(*args, **kwargs): |
8480 | """ | |
8481 | GetScreenPosition(self) -> Point | |
8482 | ||
8483 | Get the position of the window in screen coordinantes. | |
8484 | """ | |
8485 | return _core_.Window_GetScreenPosition(*args, **kwargs) | |
8486 | ||
8487 | def GetScreenPositionTuple(*args, **kwargs): | |
8488 | """ | |
8489 | GetScreenPositionTuple() -> (x,y) | |
8490 | ||
8491 | Get the position of the window in screen coordinantes. | |
8492 | """ | |
8493 | return _core_.Window_GetScreenPositionTuple(*args, **kwargs) | |
8494 | ||
8495 | def GetScreenRect(*args, **kwargs): | |
8496 | """ | |
8497 | GetScreenRect(self) -> Rect | |
8498 | ||
8499 | Returns the size and position of the window in screen coordinantes as | |
8500 | a `wx.Rect` object. | |
8501 | """ | |
8502 | return _core_.Window_GetScreenRect(*args, **kwargs) | |
8503 | ||
e811c8ce | 8504 | def GetSize(*args, **kwargs): |
0df68c9f | 8505 | """ |
a95a7133 | 8506 | GetSize(self) -> Size |
e811c8ce | 8507 | |
0df68c9f RD |
8508 | Get the window size. |
8509 | """ | |
54f9ee45 | 8510 | return _core_.Window_GetSize(*args, **kwargs) |
e811c8ce RD |
8511 | |
8512 | def GetSizeTuple(*args, **kwargs): | |
0df68c9f RD |
8513 | """ |
8514 | GetSizeTuple() -> (width, height) | |
e811c8ce | 8515 | |
0df68c9f RD |
8516 | Get the window size. |
8517 | """ | |
54f9ee45 | 8518 | return _core_.Window_GetSizeTuple(*args, **kwargs) |
e811c8ce RD |
8519 | |
8520 | def GetRect(*args, **kwargs): | |
15afbcd0 | 8521 | """ |
a95a7133 | 8522 | GetRect(self) -> Rect |
15afbcd0 | 8523 | |
75219dcb | 8524 | Returns the size and position of the window as a `wx.Rect` object. |
15afbcd0 | 8525 | """ |
54f9ee45 | 8526 | return _core_.Window_GetRect(*args, **kwargs) |
e811c8ce RD |
8527 | |
8528 | def GetClientSize(*args, **kwargs): | |
0df68c9f | 8529 | """ |
a95a7133 | 8530 | GetClientSize(self) -> Size |
e811c8ce | 8531 | |
15afbcd0 RD |
8532 | This gets the size of the window's 'client area' in pixels. The client |
8533 | area is the area which may be drawn on by the programmer, excluding | |
8534 | title bar, border, scrollbars, etc. | |
0df68c9f | 8535 | """ |
54f9ee45 | 8536 | return _core_.Window_GetClientSize(*args, **kwargs) |
e811c8ce RD |
8537 | |
8538 | def GetClientSizeTuple(*args, **kwargs): | |
0df68c9f RD |
8539 | """ |
8540 | GetClientSizeTuple() -> (width, height) | |
e811c8ce | 8541 | |
15afbcd0 RD |
8542 | This gets the size of the window's 'client area' in pixels. The client |
8543 | area is the area which may be drawn on by the programmer, excluding | |
8544 | title bar, border, scrollbars, etc. | |
0df68c9f | 8545 | """ |
54f9ee45 | 8546 | return _core_.Window_GetClientSizeTuple(*args, **kwargs) |
e811c8ce RD |
8547 | |
8548 | def GetClientAreaOrigin(*args, **kwargs): | |
15afbcd0 | 8549 | """ |
a95a7133 | 8550 | GetClientAreaOrigin(self) -> Point |
15afbcd0 RD |
8551 | |
8552 | Get the origin of the client area of the window relative to the | |
8553 | window's top left corner (the client area may be shifted because of | |
8554 | the borders, scrollbars, other decorations...) | |
8555 | """ | |
54f9ee45 | 8556 | return _core_.Window_GetClientAreaOrigin(*args, **kwargs) |
e811c8ce RD |
8557 | |
8558 | def GetClientRect(*args, **kwargs): | |
15afbcd0 | 8559 | """ |
a95a7133 | 8560 | GetClientRect(self) -> Rect |
15afbcd0 | 8561 | |
61863841 | 8562 | Get the client area position and size as a `wx.Rect` object. |
15afbcd0 | 8563 | """ |
54f9ee45 | 8564 | return _core_.Window_GetClientRect(*args, **kwargs) |
e811c8ce RD |
8565 | |
8566 | def GetBestSize(*args, **kwargs): | |
0df68c9f | 8567 | """ |
a95a7133 | 8568 | GetBestSize(self) -> Size |
e811c8ce | 8569 | |
248ed943 | 8570 | This function returns the best acceptable minimal size for the |
41e2b43e RD |
8571 | window, if applicable. For example, for a static text control, it will |
8572 | be the minimal size such that the control label is not truncated. For | |
8573 | windows containing subwindows (suzh aswx.Panel), the size returned by | |
8574 | this function will be the same as the size the window would have had | |
8575 | after calling Fit. | |
0df68c9f | 8576 | """ |
54f9ee45 | 8577 | return _core_.Window_GetBestSize(*args, **kwargs) |
e811c8ce RD |
8578 | |
8579 | def GetBestSizeTuple(*args, **kwargs): | |
0df68c9f RD |
8580 | """ |
8581 | GetBestSizeTuple() -> (width, height) | |
e811c8ce | 8582 | |
248ed943 | 8583 | This function returns the best acceptable minimal size for the |
41e2b43e RD |
8584 | window, if applicable. For example, for a static text control, it will |
8585 | be the minimal size such that the control label is not truncated. For | |
8586 | windows containing subwindows (suzh aswx.Panel), the size returned by | |
8587 | this function will be the same as the size the window would have had | |
8588 | after calling Fit. | |
0df68c9f | 8589 | """ |
54f9ee45 | 8590 | return _core_.Window_GetBestSizeTuple(*args, **kwargs) |
e811c8ce | 8591 | |
dfbb5885 RD |
8592 | def InvalidateBestSize(*args, **kwargs): |
8593 | """ | |
8594 | InvalidateBestSize(self) | |
8595 | ||
8596 | Reset the cached best size value so it will be recalculated the next | |
8597 | time it is needed. | |
8598 | """ | |
8599 | return _core_.Window_InvalidateBestSize(*args, **kwargs) | |
8600 | ||
e2813725 RD |
8601 | def CacheBestSize(*args, **kwargs): |
8602 | """ | |
8603 | CacheBestSize(self, Size size) | |
8604 | ||
8605 | Cache the best size so it doesn't need to be calculated again, (at least until | |
8606 | some properties of the window change.) | |
8607 | """ | |
8608 | return _core_.Window_CacheBestSize(*args, **kwargs) | |
8609 | ||
580080c5 | 8610 | def GetEffectiveMinSize(*args, **kwargs): |
dfbb5885 | 8611 | """ |
580080c5 | 8612 | GetEffectiveMinSize(self) -> Size |
dfbb5885 RD |
8613 | |
8614 | This function will merge the window's best size into the window's | |
8615 | minimum size, giving priority to the min size components, and returns | |
8616 | the results. | |
8617 | ||
8618 | """ | |
580080c5 | 8619 | return _core_.Window_GetEffectiveMinSize(*args, **kwargs) |
dfbb5885 | 8620 | |
0d82d64e | 8621 | GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.') |
8f514ab4 RD |
8622 | def GetAdjustedBestSize(self): |
8623 | s = self.GetBestSize() | |
8624 | return wx.Size(max(s.width, self.GetMinWidth()), | |
8625 | max(s.height, self.GetMinHeight())) | |
580080c5 | 8626 | GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.') |
e811c8ce RD |
8627 | |
8628 | def Center(*args, **kwargs): | |
15afbcd0 | 8629 | """ |
a95a7133 | 8630 | Center(self, int direction=BOTH) |
15afbcd0 RD |
8631 | |
8632 | Centers the window. The parameter specifies the direction for | |
8633 | cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may | |
8634 | also include wx.CENTER_ON_SCREEN flag if you want to center the window | |
8635 | on the entire screen and not on its parent window. If it is a | |
8636 | top-level window and has no parent then it will always be centered | |
8637 | relative to the screen. | |
8638 | """ | |
54f9ee45 | 8639 | return _core_.Window_Center(*args, **kwargs) |
e811c8ce RD |
8640 | |
8641 | Centre = Center | |
e811c8ce | 8642 | def CenterOnParent(*args, **kwargs): |
15afbcd0 | 8643 | """ |
a95a7133 | 8644 | CenterOnParent(self, int dir=BOTH) |
15afbcd0 RD |
8645 | |
8646 | Center with respect to the the parent window | |
8647 | """ | |
54f9ee45 | 8648 | return _core_.Window_CenterOnParent(*args, **kwargs) |
e811c8ce RD |
8649 | |
8650 | CentreOnParent = CenterOnParent | |
8651 | def Fit(*args, **kwargs): | |
15afbcd0 | 8652 | """ |
a95a7133 | 8653 | Fit(self) |
15afbcd0 RD |
8654 | |
8655 | Sizes the window so that it fits around its subwindows. This function | |
8656 | won't do anything if there are no subwindows and will only really work | |
8657 | correctly if sizers are used for the subwindows layout. Also, if the | |
8658 | window has exactly one subwindow it is better (faster and the result | |
8659 | is more precise as Fit adds some margin to account for fuzziness of | |
8660 | its calculations) to call window.SetClientSize(child.GetSize()) | |
8661 | instead of calling Fit. | |
8662 | """ | |
54f9ee45 | 8663 | return _core_.Window_Fit(*args, **kwargs) |
e811c8ce RD |
8664 | |
8665 | def FitInside(*args, **kwargs): | |
15afbcd0 | 8666 | """ |
a95a7133 | 8667 | FitInside(self) |
15afbcd0 RD |
8668 | |
8669 | Similar to Fit, but sizes the interior (virtual) size of a | |
8670 | window. Mainly useful with scrolled windows to reset scrollbars after | |
8671 | sizing changes that do not trigger a size event, and/or scrolled | |
8672 | windows without an interior sizer. This function similarly won't do | |
8673 | anything if there are no subwindows. | |
8674 | """ | |
54f9ee45 | 8675 | return _core_.Window_FitInside(*args, **kwargs) |
e811c8ce | 8676 | |
f16ab95d | 8677 | def SetSizeHints(*args, **kwargs): |
0df68c9f | 8678 | """ |
a95a7133 | 8679 | SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, |
0df68c9f | 8680 | int incH=-1) |
15afbcd0 RD |
8681 | |
8682 | Allows specification of minimum and maximum window sizes, and window | |
8683 | size increments. If a pair of values is not set (or set to -1), the | |
8684 | default values will be used. If this function is called, the user | |
908b74cd RD |
8685 | will not be able to size the window outside the given bounds (if it is |
8686 | a top-level window.) Sizers will also inspect the minimum window size | |
8687 | and will use that value if set when calculating layout. | |
8688 | ||
8689 | The resizing increments are only significant under Motif or Xt. | |
0df68c9f | 8690 | """ |
f16ab95d | 8691 | return _core_.Window_SetSizeHints(*args, **kwargs) |
e811c8ce | 8692 | |
f16ab95d RD |
8693 | def SetSizeHintsSz(*args, **kwargs): |
8694 | """ | |
8695 | SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) | |
8696 | ||
8697 | Allows specification of minimum and maximum window sizes, and window | |
8698 | size increments. If a pair of values is not set (or set to -1), the | |
8699 | default values will be used. If this function is called, the user | |
8700 | will not be able to size the window outside the given bounds (if it is | |
8701 | a top-level window.) Sizers will also inspect the minimum window size | |
8702 | and will use that value if set when calculating layout. | |
8703 | ||
8704 | The resizing increments are only significant under Motif or Xt. | |
8705 | """ | |
8706 | return _core_.Window_SetSizeHintsSz(*args, **kwargs) | |
8707 | ||
8708 | def SetVirtualSizeHints(*args, **kwargs): | |
15afbcd0 | 8709 | """ |
908b74cd | 8710 | SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) |
15afbcd0 RD |
8711 | |
8712 | Allows specification of minimum and maximum virtual window sizes. If a | |
8713 | pair of values is not set (or set to -1), the default values will be | |
8714 | used. If this function is called, the user will not be able to size | |
8715 | the virtual area of the window outside the given bounds. | |
8716 | """ | |
f16ab95d RD |
8717 | return _core_.Window_SetVirtualSizeHints(*args, **kwargs) |
8718 | ||
8719 | def SetVirtualSizeHintsSz(*args, **kwargs): | |
8720 | """ | |
8721 | SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize) | |
8722 | ||
8723 | Allows specification of minimum and maximum virtual window sizes. If a | |
8724 | pair of values is not set (or set to -1), the default values will be | |
8725 | used. If this function is called, the user will not be able to size | |
8726 | the virtual area of the window outside the given bounds. | |
8727 | """ | |
8728 | return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs) | |
e811c8ce | 8729 | |
908b74cd RD |
8730 | def GetMaxSize(*args, **kwargs): |
8731 | """GetMaxSize(self) -> Size""" | |
8732 | return _core_.Window_GetMaxSize(*args, **kwargs) | |
8733 | ||
8734 | def GetMinSize(*args, **kwargs): | |
8735 | """GetMinSize(self) -> Size""" | |
8736 | return _core_.Window_GetMinSize(*args, **kwargs) | |
8737 | ||
8738 | def SetMinSize(*args, **kwargs): | |
8739 | """ | |
8740 | SetMinSize(self, Size minSize) | |
8741 | ||
8742 | A more convenient method than `SetSizeHints` for setting just the | |
8743 | min size. | |
8744 | """ | |
8745 | return _core_.Window_SetMinSize(*args, **kwargs) | |
8746 | ||
8747 | def SetMaxSize(*args, **kwargs): | |
8748 | """ | |
8749 | SetMaxSize(self, Size maxSize) | |
8750 | ||
8751 | A more convenient method than `SetSizeHints` for setting just the | |
8752 | max size. | |
8753 | """ | |
8754 | return _core_.Window_SetMaxSize(*args, **kwargs) | |
8755 | ||
e811c8ce | 8756 | def GetMinWidth(*args, **kwargs): |
a95a7133 | 8757 | """GetMinWidth(self) -> int""" |
54f9ee45 | 8758 | return _core_.Window_GetMinWidth(*args, **kwargs) |
e811c8ce RD |
8759 | |
8760 | def GetMinHeight(*args, **kwargs): | |
a95a7133 | 8761 | """GetMinHeight(self) -> int""" |
54f9ee45 | 8762 | return _core_.Window_GetMinHeight(*args, **kwargs) |
e811c8ce RD |
8763 | |
8764 | def GetMaxWidth(*args, **kwargs): | |
a95a7133 | 8765 | """GetMaxWidth(self) -> int""" |
54f9ee45 | 8766 | return _core_.Window_GetMaxWidth(*args, **kwargs) |
e811c8ce RD |
8767 | |
8768 | def GetMaxHeight(*args, **kwargs): | |
a95a7133 | 8769 | """GetMaxHeight(self) -> int""" |
54f9ee45 | 8770 | return _core_.Window_GetMaxHeight(*args, **kwargs) |
e811c8ce | 8771 | |
e811c8ce | 8772 | def SetVirtualSize(*args, **kwargs): |
0df68c9f | 8773 | """ |
a95a7133 | 8774 | SetVirtualSize(self, Size size) |
e811c8ce | 8775 | |
15afbcd0 RD |
8776 | Set the the virtual size of a window in pixels. For most windows this |
8777 | is just the client area of the window, but for some like scrolled | |
8778 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8779 | """ |
54f9ee45 | 8780 | return _core_.Window_SetVirtualSize(*args, **kwargs) |
e811c8ce RD |
8781 | |
8782 | def SetVirtualSizeWH(*args, **kwargs): | |
0df68c9f | 8783 | """ |
a95a7133 | 8784 | SetVirtualSizeWH(self, int w, int h) |
e811c8ce | 8785 | |
15afbcd0 RD |
8786 | Set the the virtual size of a window in pixels. For most windows this |
8787 | is just the client area of the window, but for some like scrolled | |
8788 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8789 | """ |
54f9ee45 | 8790 | return _core_.Window_SetVirtualSizeWH(*args, **kwargs) |
e811c8ce RD |
8791 | |
8792 | def GetVirtualSize(*args, **kwargs): | |
0df68c9f | 8793 | """ |
a95a7133 | 8794 | GetVirtualSize(self) -> Size |
e811c8ce | 8795 | |
15afbcd0 RD |
8796 | Get the the virtual size of the window in pixels. For most windows |
8797 | this is just the client area of the window, but for some like scrolled | |
8798 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8799 | """ |
54f9ee45 | 8800 | return _core_.Window_GetVirtualSize(*args, **kwargs) |
e811c8ce RD |
8801 | |
8802 | def GetVirtualSizeTuple(*args, **kwargs): | |
0df68c9f RD |
8803 | """ |
8804 | GetVirtualSizeTuple() -> (width, height) | |
e811c8ce | 8805 | |
15afbcd0 RD |
8806 | Get the the virtual size of the window in pixels. For most windows |
8807 | this is just the client area of the window, but for some like scrolled | |
8808 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8809 | """ |
54f9ee45 | 8810 | return _core_.Window_GetVirtualSizeTuple(*args, **kwargs) |
e811c8ce | 8811 | |
cbdf0fb0 RD |
8812 | def GetWindowBorderSize(*args, **kwargs): |
8813 | """ | |
8814 | GetWindowBorderSize(self) -> Size | |
8815 | ||
8816 | Return the size of the left/right and top/bottom borders. | |
8817 | """ | |
8818 | return _core_.Window_GetWindowBorderSize(*args, **kwargs) | |
8819 | ||
e811c8ce | 8820 | def GetBestVirtualSize(*args, **kwargs): |
15afbcd0 | 8821 | """ |
a95a7133 | 8822 | GetBestVirtualSize(self) -> Size |
15afbcd0 RD |
8823 | |
8824 | Return the largest of ClientSize and BestSize (as determined by a | |
8825 | sizer, interior children, or other means) | |
8826 | """ | |
54f9ee45 | 8827 | return _core_.Window_GetBestVirtualSize(*args, **kwargs) |
e811c8ce RD |
8828 | |
8829 | def Show(*args, **kwargs): | |
15afbcd0 | 8830 | """ |
a95a7133 | 8831 | Show(self, bool show=True) -> bool |
15afbcd0 RD |
8832 | |
8833 | Shows or hides the window. You may need to call Raise for a top level | |
8834 | window if you want to bring it to top, although this is not needed if | |
8835 | Show is called immediately after the frame creation. Returns True if | |
8836 | the window has been shown or hidden or False if nothing was done | |
8837 | because it already was in the requested state. | |
8838 | """ | |
54f9ee45 | 8839 | return _core_.Window_Show(*args, **kwargs) |
e811c8ce RD |
8840 | |
8841 | def Hide(*args, **kwargs): | |
15afbcd0 | 8842 | """ |
a95a7133 | 8843 | Hide(self) -> bool |
15afbcd0 RD |
8844 | |
8845 | Equivalent to calling Show(False). | |
8846 | """ | |
54f9ee45 | 8847 | return _core_.Window_Hide(*args, **kwargs) |
e811c8ce RD |
8848 | |
8849 | def Enable(*args, **kwargs): | |
15afbcd0 | 8850 | """ |
a95a7133 | 8851 | Enable(self, bool enable=True) -> bool |
15afbcd0 RD |
8852 | |
8853 | Enable or disable the window for user input. Note that when a parent | |
8854 | window is disabled, all of its children are disabled as well and they | |
8855 | are reenabled again when the parent is. Returns true if the window | |
8856 | has been enabled or disabled, false if nothing was done, i.e. if the | |
8857 | window had already been in the specified state. | |
8858 | """ | |
54f9ee45 | 8859 | return _core_.Window_Enable(*args, **kwargs) |
e811c8ce RD |
8860 | |
8861 | def Disable(*args, **kwargs): | |
15afbcd0 | 8862 | """ |
a95a7133 | 8863 | Disable(self) -> bool |
15afbcd0 RD |
8864 | |
8865 | Disables the window, same as Enable(false). | |
8866 | """ | |
54f9ee45 | 8867 | return _core_.Window_Disable(*args, **kwargs) |
e811c8ce RD |
8868 | |
8869 | def IsShown(*args, **kwargs): | |
15afbcd0 | 8870 | """ |
a95a7133 | 8871 | IsShown(self) -> bool |
15afbcd0 RD |
8872 | |
8873 | Returns true if the window is shown, false if it has been hidden. | |
8874 | """ | |
54f9ee45 | 8875 | return _core_.Window_IsShown(*args, **kwargs) |
e811c8ce RD |
8876 | |
8877 | def IsEnabled(*args, **kwargs): | |
15afbcd0 | 8878 | """ |
a95a7133 | 8879 | IsEnabled(self) -> bool |
15afbcd0 RD |
8880 | |
8881 | Returns true if the window is enabled for input, false otherwise. | |
8882 | """ | |
54f9ee45 | 8883 | return _core_.Window_IsEnabled(*args, **kwargs) |
e811c8ce | 8884 | |
33d6fd3b RD |
8885 | def IsShownOnScreen(*args, **kwargs): |
8886 | """ | |
8887 | IsShownOnScreen(self) -> bool | |
8888 | ||
8889 | Returns ``True`` if the window is physically visible on the screen, | |
8890 | i.e. it is shown and all its parents up to the toplevel window are | |
8891 | shown as well. | |
8892 | """ | |
8893 | return _core_.Window_IsShownOnScreen(*args, **kwargs) | |
8894 | ||
e811c8ce | 8895 | def SetWindowStyleFlag(*args, **kwargs): |
15afbcd0 | 8896 | """ |
a95a7133 | 8897 | SetWindowStyleFlag(self, long style) |
15afbcd0 | 8898 | |
41e2b43e RD |
8899 | Sets the style of the window. Please note that some styles cannot be |
8900 | changed after the window creation and that Refresh() might need to be | |
8901 | called after changing the others for the change to take place | |
8902 | immediately. | |
15afbcd0 | 8903 | """ |
54f9ee45 | 8904 | return _core_.Window_SetWindowStyleFlag(*args, **kwargs) |
e811c8ce RD |
8905 | |
8906 | def GetWindowStyleFlag(*args, **kwargs): | |
15afbcd0 | 8907 | """ |
a95a7133 | 8908 | GetWindowStyleFlag(self) -> long |
e811c8ce | 8909 | |
15afbcd0 RD |
8910 | Gets the window style that was passed to the constructor or Create |
8911 | method. | |
8912 | """ | |
54f9ee45 | 8913 | return _core_.Window_GetWindowStyleFlag(*args, **kwargs) |
e811c8ce | 8914 | |
15afbcd0 | 8915 | SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag |
e811c8ce | 8916 | def HasFlag(*args, **kwargs): |
15afbcd0 | 8917 | """ |
a95a7133 | 8918 | HasFlag(self, int flag) -> bool |
15afbcd0 RD |
8919 | |
8920 | Test if the given style is set for this window. | |
8921 | """ | |
54f9ee45 | 8922 | return _core_.Window_HasFlag(*args, **kwargs) |
e811c8ce RD |
8923 | |
8924 | def IsRetained(*args, **kwargs): | |
15afbcd0 | 8925 | """ |
a95a7133 | 8926 | IsRetained(self) -> bool |
15afbcd0 RD |
8927 | |
8928 | Returns true if the window is retained, false otherwise. Retained | |
8929 | windows are only available on X platforms. | |
8930 | """ | |
54f9ee45 | 8931 | return _core_.Window_IsRetained(*args, **kwargs) |
e811c8ce | 8932 | |
5917d041 RD |
8933 | def ToggleWindowStyle(*args, **kwargs): |
8934 | """ | |
8935 | ToggleWindowStyle(self, int flag) -> bool | |
8936 | ||
8937 | Turn the flag on if it had been turned off before and vice versa, | |
8938 | returns True if the flag is turned on by this function call. | |
8939 | """ | |
8940 | return _core_.Window_ToggleWindowStyle(*args, **kwargs) | |
8941 | ||
e811c8ce | 8942 | def SetExtraStyle(*args, **kwargs): |
15afbcd0 | 8943 | """ |
a95a7133 | 8944 | SetExtraStyle(self, long exStyle) |
15afbcd0 RD |
8945 | |
8946 | Sets the extra style bits for the window. Extra styles are the less | |
8947 | often used style bits which can't be set with the constructor or with | |
8948 | SetWindowStyleFlag() | |
8949 | """ | |
54f9ee45 | 8950 | return _core_.Window_SetExtraStyle(*args, **kwargs) |
e811c8ce RD |
8951 | |
8952 | def GetExtraStyle(*args, **kwargs): | |
15afbcd0 | 8953 | """ |
a95a7133 | 8954 | GetExtraStyle(self) -> long |
15afbcd0 RD |
8955 | |
8956 | Returns the extra style bits for the window. | |
8957 | """ | |
54f9ee45 | 8958 | return _core_.Window_GetExtraStyle(*args, **kwargs) |
e811c8ce RD |
8959 | |
8960 | def MakeModal(*args, **kwargs): | |
15afbcd0 | 8961 | """ |
a95a7133 | 8962 | MakeModal(self, bool modal=True) |
15afbcd0 RD |
8963 | |
8964 | Disables all other windows in the application so that the user can | |
8965 | only interact with this window. Passing False will reverse this | |
8966 | effect. | |
8967 | """ | |
54f9ee45 | 8968 | return _core_.Window_MakeModal(*args, **kwargs) |
e811c8ce RD |
8969 | |
8970 | def SetThemeEnabled(*args, **kwargs): | |
15afbcd0 | 8971 | """ |
a95a7133 | 8972 | SetThemeEnabled(self, bool enableTheme) |
15afbcd0 RD |
8973 | |
8974 | This function tells a window if it should use the system's "theme" | |
8975 | code to draw the windows' background instead if its own background | |
8976 | drawing code. This will only have an effect on platforms that support | |
8977 | the notion of themes in user defined windows. One such platform is | |
8978 | GTK+ where windows can have (very colourful) backgrounds defined by a | |
8979 | user's selected theme. | |
8980 | ||
8981 | Dialogs, notebook pages and the status bar have this flag set to true | |
8982 | by default so that the default look and feel is simulated best. | |
8983 | """ | |
54f9ee45 | 8984 | return _core_.Window_SetThemeEnabled(*args, **kwargs) |
e811c8ce RD |
8985 | |
8986 | def GetThemeEnabled(*args, **kwargs): | |
15afbcd0 | 8987 | """ |
a95a7133 | 8988 | GetThemeEnabled(self) -> bool |
e811c8ce | 8989 | |
15afbcd0 RD |
8990 | Return the themeEnabled flag. |
8991 | """ | |
54f9ee45 | 8992 | return _core_.Window_GetThemeEnabled(*args, **kwargs) |
e811c8ce RD |
8993 | |
8994 | def SetFocus(*args, **kwargs): | |
15afbcd0 | 8995 | """ |
a95a7133 | 8996 | SetFocus(self) |
15afbcd0 RD |
8997 | |
8998 | Set's the focus to this window, allowing it to receive keyboard input. | |
8999 | """ | |
54f9ee45 | 9000 | return _core_.Window_SetFocus(*args, **kwargs) |
e811c8ce RD |
9001 | |
9002 | def SetFocusFromKbd(*args, **kwargs): | |
15afbcd0 | 9003 | """ |
a95a7133 | 9004 | SetFocusFromKbd(self) |
15afbcd0 RD |
9005 | |
9006 | Set focus to this window as the result of a keyboard action. Normally | |
9007 | only called internally. | |
9008 | """ | |
54f9ee45 | 9009 | return _core_.Window_SetFocusFromKbd(*args, **kwargs) |
e811c8ce RD |
9010 | |
9011 | def FindFocus(*args, **kwargs): | |
15afbcd0 | 9012 | """ |
66c033b4 | 9013 | FindFocus() -> Window |
15afbcd0 RD |
9014 | |
9015 | Returns the window or control that currently has the keyboard focus, | |
9016 | or None. | |
9017 | """ | |
54f9ee45 | 9018 | return _core_.Window_FindFocus(*args, **kwargs) |
e811c8ce RD |
9019 | |
9020 | FindFocus = staticmethod(FindFocus) | |
9021 | def AcceptsFocus(*args, **kwargs): | |
15afbcd0 | 9022 | """ |
a95a7133 | 9023 | AcceptsFocus(self) -> bool |
15afbcd0 RD |
9024 | |
9025 | Can this window have focus? | |
9026 | """ | |
54f9ee45 | 9027 | return _core_.Window_AcceptsFocus(*args, **kwargs) |
e811c8ce RD |
9028 | |
9029 | def AcceptsFocusFromKeyboard(*args, **kwargs): | |
15afbcd0 | 9030 | """ |
a95a7133 | 9031 | AcceptsFocusFromKeyboard(self) -> bool |
15afbcd0 RD |
9032 | |
9033 | Can this window be given focus by keyboard navigation? if not, the | |
9034 | only way to give it focus (provided it accepts it at all) is to click | |
9035 | it. | |
9036 | """ | |
54f9ee45 | 9037 | return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs) |
e811c8ce | 9038 | |
908b74cd RD |
9039 | def Navigate(*args, **kwargs): |
9040 | """ | |
9041 | Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool | |
9042 | ||
fd2dc343 RD |
9043 | Does keyboard navigation from this window to another, by sending a |
9044 | `wx.NavigationKeyEvent`. | |
908b74cd RD |
9045 | """ |
9046 | return _core_.Window_Navigate(*args, **kwargs) | |
9047 | ||
7f98d120 RD |
9048 | def MoveAfterInTabOrder(*args, **kwargs): |
9049 | """ | |
9050 | MoveAfterInTabOrder(self, Window win) | |
9051 | ||
9052 | Moves this window in the tab navigation order after the specified | |
9053 | sibling window. This means that when the user presses the TAB key on | |
9054 | that other window, the focus switches to this window. | |
9055 | ||
9056 | The default tab order is the same as creation order. This function | |
9057 | and `MoveBeforeInTabOrder` allow to change it after creating all the | |
9058 | windows. | |
9059 | ||
9060 | """ | |
9061 | return _core_.Window_MoveAfterInTabOrder(*args, **kwargs) | |
9062 | ||
9063 | def MoveBeforeInTabOrder(*args, **kwargs): | |
9064 | """ | |
9065 | MoveBeforeInTabOrder(self, Window win) | |
9066 | ||
9067 | Same as `MoveAfterInTabOrder` except that it inserts this window just | |
9068 | before win instead of putting it right after it. | |
9069 | """ | |
9070 | return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs) | |
9071 | ||
e811c8ce | 9072 | def GetChildren(*args, **kwargs): |
15afbcd0 | 9073 | """ |
a95a7133 | 9074 | GetChildren(self) -> PyObject |
15afbcd0 RD |
9075 | |
9076 | Returns a list of the window's children. NOTE: Currently this is a | |
9077 | copy of the child window list maintained by the window, so the return | |
9078 | value of this function is only valid as long as the window's children | |
9079 | do not change. | |
9080 | """ | |
54f9ee45 | 9081 | return _core_.Window_GetChildren(*args, **kwargs) |
e811c8ce RD |
9082 | |
9083 | def GetParent(*args, **kwargs): | |
15afbcd0 | 9084 | """ |
a95a7133 | 9085 | GetParent(self) -> Window |
15afbcd0 RD |
9086 | |
9087 | Returns the parent window of this window, or None if there isn't one. | |
9088 | """ | |
54f9ee45 | 9089 | return _core_.Window_GetParent(*args, **kwargs) |
e811c8ce RD |
9090 | |
9091 | def GetGrandParent(*args, **kwargs): | |
15afbcd0 | 9092 | """ |
a95a7133 | 9093 | GetGrandParent(self) -> Window |
15afbcd0 | 9094 | |
41e2b43e RD |
9095 | Returns the parent of the parent of this window, or None if there |
9096 | isn't one. | |
15afbcd0 | 9097 | """ |
54f9ee45 | 9098 | return _core_.Window_GetGrandParent(*args, **kwargs) |
e811c8ce RD |
9099 | |
9100 | def IsTopLevel(*args, **kwargs): | |
15afbcd0 | 9101 | """ |
a95a7133 | 9102 | IsTopLevel(self) -> bool |
15afbcd0 RD |
9103 | |
9104 | Returns true if the given window is a top-level one. Currently all | |
9105 | frames and dialogs are always considered to be top-level windows (even | |
9106 | if they have a parent window). | |
9107 | """ | |
54f9ee45 | 9108 | return _core_.Window_IsTopLevel(*args, **kwargs) |
e811c8ce RD |
9109 | |
9110 | def Reparent(*args, **kwargs): | |
15afbcd0 | 9111 | """ |
a95a7133 | 9112 | Reparent(self, Window newParent) -> bool |
15afbcd0 RD |
9113 | |
9114 | Reparents the window, i.e the window will be removed from its current | |
9115 | parent window (e.g. a non-standard toolbar in a wxFrame) and then | |
9116 | re-inserted into another. Available on Windows and GTK. Returns True | |
9117 | if the parent was changed, False otherwise (error or newParent == | |
9118 | oldParent) | |
9119 | """ | |
54f9ee45 | 9120 | return _core_.Window_Reparent(*args, **kwargs) |
e811c8ce RD |
9121 | |
9122 | def AddChild(*args, **kwargs): | |
15afbcd0 | 9123 | """ |
a95a7133 | 9124 | AddChild(self, Window child) |
15afbcd0 RD |
9125 | |
9126 | Adds a child window. This is called automatically by window creation | |
9127 | functions so should not be required by the application programmer. | |
9128 | """ | |
54f9ee45 | 9129 | return _core_.Window_AddChild(*args, **kwargs) |
e811c8ce RD |
9130 | |
9131 | def RemoveChild(*args, **kwargs): | |
15afbcd0 | 9132 | """ |
a95a7133 | 9133 | RemoveChild(self, Window child) |
15afbcd0 RD |
9134 | |
9135 | Removes a child window. This is called automatically by window | |
9136 | deletion functions so should not be required by the application | |
9137 | programmer. | |
9138 | """ | |
54f9ee45 | 9139 | return _core_.Window_RemoveChild(*args, **kwargs) |
e811c8ce | 9140 | |
704eda0c RD |
9141 | def SetDoubleBuffered(*args, **kwargs): |
9142 | """ | |
9143 | SetDoubleBuffered(self, bool on) | |
9144 | ||
9145 | Currently wxGTK2 only. | |
9146 | """ | |
9147 | return _core_.Window_SetDoubleBuffered(*args, **kwargs) | |
9148 | ||
e811c8ce | 9149 | def FindWindowById(*args, **kwargs): |
15afbcd0 | 9150 | """ |
a95a7133 | 9151 | FindWindowById(self, long winid) -> Window |
15afbcd0 RD |
9152 | |
9153 | Find a chld of this window by window ID | |
9154 | """ | |
54f9ee45 | 9155 | return _core_.Window_FindWindowById(*args, **kwargs) |
e811c8ce RD |
9156 | |
9157 | def FindWindowByName(*args, **kwargs): | |
15afbcd0 | 9158 | """ |
a95a7133 | 9159 | FindWindowByName(self, String name) -> Window |
15afbcd0 RD |
9160 | |
9161 | Find a child of this window by name | |
9162 | """ | |
54f9ee45 | 9163 | return _core_.Window_FindWindowByName(*args, **kwargs) |
e811c8ce RD |
9164 | |
9165 | def GetEventHandler(*args, **kwargs): | |
15afbcd0 | 9166 | """ |
a95a7133 | 9167 | GetEventHandler(self) -> EvtHandler |
15afbcd0 RD |
9168 | |
9169 | Returns the event handler for this window. By default, the window is | |
9170 | its own event handler. | |
9171 | """ | |
54f9ee45 | 9172 | return _core_.Window_GetEventHandler(*args, **kwargs) |
e811c8ce RD |
9173 | |
9174 | def SetEventHandler(*args, **kwargs): | |
15afbcd0 | 9175 | """ |
a95a7133 | 9176 | SetEventHandler(self, EvtHandler handler) |
15afbcd0 RD |
9177 | |
9178 | Sets the event handler for this window. An event handler is an object | |
d49bdf34 RD |
9179 | that is capable of processing the events sent to a window. (In other |
9180 | words, is able to dispatch the events to handler function.) By | |
9181 | default, the window is its own event handler, but an application may | |
9182 | wish to substitute another, for example to allow central | |
9183 | implementation of event-handling for a variety of different window | |
9184 | classes. | |
15afbcd0 | 9185 | |
41e2b43e | 9186 | It is usually better to use `wx.Window.PushEventHandler` since this sets |
15afbcd0 | 9187 | up a chain of event handlers, where an event not handled by one event |
d49bdf34 | 9188 | handler is handed off to the next one in the chain. |
15afbcd0 | 9189 | """ |
54f9ee45 | 9190 | return _core_.Window_SetEventHandler(*args, **kwargs) |
e811c8ce RD |
9191 | |
9192 | def PushEventHandler(*args, **kwargs): | |
15afbcd0 | 9193 | """ |
a95a7133 | 9194 | PushEventHandler(self, EvtHandler handler) |
15afbcd0 RD |
9195 | |
9196 | Pushes this event handler onto the event handler stack for the window. | |
9197 | An event handler is an object that is capable of processing the events | |
d49bdf34 RD |
9198 | sent to a window. (In other words, is able to dispatch the events to |
9199 | handler function.) By default, the window is its own event handler, | |
9200 | but an application may wish to substitute another, for example to | |
9201 | allow central implementation of event-handling for a variety of | |
9202 | different window classes. | |
15afbcd0 RD |
9203 | |
9204 | wx.Window.PushEventHandler allows an application to set up a chain of | |
9205 | event handlers, where an event not handled by one event handler is | |
d49bdf34 RD |
9206 | handed to the next one in the chain. Use `wx.Window.PopEventHandler` |
9207 | to remove the event handler. Ownership of the handler is *not* given | |
9208 | to the window, so you should be sure to pop the handler before the | |
9209 | window is destroyed and either let PopEventHandler destroy it, or call | |
9210 | its Destroy method yourself. | |
15afbcd0 | 9211 | """ |
54f9ee45 | 9212 | return _core_.Window_PushEventHandler(*args, **kwargs) |
e811c8ce RD |
9213 | |
9214 | def PopEventHandler(*args, **kwargs): | |
15afbcd0 | 9215 | """ |
a95a7133 | 9216 | PopEventHandler(self, bool deleteHandler=False) -> EvtHandler |
15afbcd0 RD |
9217 | |
9218 | Removes and returns the top-most event handler on the event handler | |
9219 | stack. If deleteHandler is True then the wx.EvtHandler object will be | |
d49bdf34 | 9220 | destroyed after it is popped, and ``None`` will be returned instead. |
15afbcd0 | 9221 | """ |
54f9ee45 | 9222 | return _core_.Window_PopEventHandler(*args, **kwargs) |
e811c8ce RD |
9223 | |
9224 | def RemoveEventHandler(*args, **kwargs): | |
15afbcd0 | 9225 | """ |
a95a7133 | 9226 | RemoveEventHandler(self, EvtHandler handler) -> bool |
15afbcd0 | 9227 | |
41e2b43e | 9228 | Find the given handler in the event handler chain and remove (but not |
d49bdf34 | 9229 | delete) it from the event handler chain, returns True if it was found |
41e2b43e RD |
9230 | and False otherwise (this also results in an assert failure so this |
9231 | function should only be called when the handler is supposed to be | |
9232 | there.) | |
15afbcd0 | 9233 | """ |
54f9ee45 | 9234 | return _core_.Window_RemoveEventHandler(*args, **kwargs) |
e811c8ce RD |
9235 | |
9236 | def SetValidator(*args, **kwargs): | |
15afbcd0 | 9237 | """ |
a95a7133 | 9238 | SetValidator(self, Validator validator) |
15afbcd0 RD |
9239 | |
9240 | Deletes the current validator (if any) and sets the window validator, | |
9241 | having called wx.Validator.Clone to create a new validator of this | |
9242 | type. | |
9243 | """ | |
54f9ee45 | 9244 | return _core_.Window_SetValidator(*args, **kwargs) |
e811c8ce RD |
9245 | |
9246 | def GetValidator(*args, **kwargs): | |
15afbcd0 | 9247 | """ |
a95a7133 | 9248 | GetValidator(self) -> Validator |
15afbcd0 RD |
9249 | |
9250 | Returns a pointer to the current validator for the window, or None if | |
9251 | there is none. | |
9252 | """ | |
54f9ee45 | 9253 | return _core_.Window_GetValidator(*args, **kwargs) |
e811c8ce | 9254 | |
74a57fcd RD |
9255 | def Validate(*args, **kwargs): |
9256 | """ | |
a95a7133 | 9257 | Validate(self) -> bool |
74a57fcd RD |
9258 | |
9259 | Validates the current values of the child controls using their | |
41e2b43e RD |
9260 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra |
9261 | style flag set, the method will also call Validate() of all child | |
9262 | windows. Returns false if any of the validations failed. | |
74a57fcd | 9263 | """ |
54f9ee45 | 9264 | return _core_.Window_Validate(*args, **kwargs) |
74a57fcd RD |
9265 | |
9266 | def TransferDataToWindow(*args, **kwargs): | |
9267 | """ | |
a95a7133 | 9268 | TransferDataToWindow(self) -> bool |
74a57fcd | 9269 | |
41e2b43e RD |
9270 | Transfers values to child controls from data areas specified by their |
9271 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra | |
9272 | style flag set, the method will also call TransferDataToWindow() of | |
9273 | all child windows. | |
74a57fcd | 9274 | """ |
54f9ee45 | 9275 | return _core_.Window_TransferDataToWindow(*args, **kwargs) |
74a57fcd RD |
9276 | |
9277 | def TransferDataFromWindow(*args, **kwargs): | |
9278 | """ | |
a95a7133 | 9279 | TransferDataFromWindow(self) -> bool |
74a57fcd | 9280 | |
41e2b43e RD |
9281 | Transfers values from child controls to data areas specified by their |
9282 | validators. Returns false if a transfer failed. If the window has | |
9283 | wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will | |
9284 | also call TransferDataFromWindow() of all child windows. | |
74a57fcd | 9285 | """ |
54f9ee45 | 9286 | return _core_.Window_TransferDataFromWindow(*args, **kwargs) |
74a57fcd RD |
9287 | |
9288 | def InitDialog(*args, **kwargs): | |
9289 | """ | |
a95a7133 | 9290 | InitDialog(self) |
74a57fcd | 9291 | |
41e2b43e RD |
9292 | Sends an EVT_INIT_DIALOG event, whose handler usually transfers data |
9293 | to the dialog via validators. | |
74a57fcd | 9294 | """ |
54f9ee45 | 9295 | return _core_.Window_InitDialog(*args, **kwargs) |
74a57fcd | 9296 | |
e811c8ce | 9297 | def SetAcceleratorTable(*args, **kwargs): |
15afbcd0 | 9298 | """ |
a95a7133 | 9299 | SetAcceleratorTable(self, AcceleratorTable accel) |
15afbcd0 RD |
9300 | |
9301 | Sets the accelerator table for this window. | |
9302 | """ | |
54f9ee45 | 9303 | return _core_.Window_SetAcceleratorTable(*args, **kwargs) |
e811c8ce RD |
9304 | |
9305 | def GetAcceleratorTable(*args, **kwargs): | |
15afbcd0 | 9306 | """ |
a95a7133 | 9307 | GetAcceleratorTable(self) -> AcceleratorTable |
15afbcd0 RD |
9308 | |
9309 | Gets the accelerator table for this window. | |
9310 | """ | |
54f9ee45 | 9311 | return _core_.Window_GetAcceleratorTable(*args, **kwargs) |
e811c8ce RD |
9312 | |
9313 | def RegisterHotKey(*args, **kwargs): | |
15afbcd0 | 9314 | """ |
a95a7133 | 9315 | RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool |
15afbcd0 RD |
9316 | |
9317 | Registers a system wide hotkey. Every time the user presses the hotkey | |
9318 | registered here, this window will receive a hotkey event. It will | |
9319 | receive the event even if the application is in the background and | |
9320 | does not have the input focus because the user is working with some | |
9321 | other application. To bind an event handler function to this hotkey | |
9322 | use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the | |
9323 | hotkey was registered successfully. | |
9324 | """ | |
54f9ee45 | 9325 | return _core_.Window_RegisterHotKey(*args, **kwargs) |
e811c8ce RD |
9326 | |
9327 | def UnregisterHotKey(*args, **kwargs): | |
15afbcd0 | 9328 | """ |
a95a7133 | 9329 | UnregisterHotKey(self, int hotkeyId) -> bool |
15afbcd0 RD |
9330 | |
9331 | Unregisters a system wide hotkey. | |
9332 | """ | |
54f9ee45 | 9333 | return _core_.Window_UnregisterHotKey(*args, **kwargs) |
e811c8ce RD |
9334 | |
9335 | def ConvertDialogPointToPixels(*args, **kwargs): | |
15afbcd0 | 9336 | """ |
a95a7133 | 9337 | ConvertDialogPointToPixels(self, Point pt) -> Point |
15afbcd0 RD |
9338 | |
9339 | Converts a point or size from dialog units to pixels. Dialog units | |
9340 | are used for maintaining a dialog's proportions even if the font | |
9341 | changes. For the x dimension, the dialog units are multiplied by the | |
9342 | average character width and then divided by 4. For the y dimension, | |
9343 | the dialog units are multiplied by the average character height and | |
9344 | then divided by 8. | |
9345 | """ | |
54f9ee45 | 9346 | return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs) |
e811c8ce RD |
9347 | |
9348 | def ConvertDialogSizeToPixels(*args, **kwargs): | |
15afbcd0 | 9349 | """ |
a95a7133 | 9350 | ConvertDialogSizeToPixels(self, Size sz) -> Size |
15afbcd0 RD |
9351 | |
9352 | Converts a point or size from dialog units to pixels. Dialog units | |
9353 | are used for maintaining a dialog's proportions even if the font | |
9354 | changes. For the x dimension, the dialog units are multiplied by the | |
9355 | average character width and then divided by 4. For the y dimension, | |
9356 | the dialog units are multiplied by the average character height and | |
9357 | then divided by 8. | |
9358 | """ | |
54f9ee45 | 9359 | return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs) |
e811c8ce RD |
9360 | |
9361 | def DLG_PNT(*args, **kwargs): | |
15afbcd0 | 9362 | """ |
a95a7133 | 9363 | DLG_PNT(self, Point pt) -> Point |
15afbcd0 RD |
9364 | |
9365 | Converts a point or size from dialog units to pixels. Dialog units | |
9366 | are used for maintaining a dialog's proportions even if the font | |
9367 | changes. For the x dimension, the dialog units are multiplied by the | |
9368 | average character width and then divided by 4. For the y dimension, | |
9369 | the dialog units are multiplied by the average character height and | |
9370 | then divided by 8. | |
9371 | """ | |
54f9ee45 | 9372 | return _core_.Window_DLG_PNT(*args, **kwargs) |
e811c8ce RD |
9373 | |
9374 | def DLG_SZE(*args, **kwargs): | |
15afbcd0 | 9375 | """ |
a95a7133 | 9376 | DLG_SZE(self, Size sz) -> Size |
15afbcd0 RD |
9377 | |
9378 | Converts a point or size from dialog units to pixels. Dialog units | |
9379 | are used for maintaining a dialog's proportions even if the font | |
9380 | changes. For the x dimension, the dialog units are multiplied by the | |
9381 | average character width and then divided by 4. For the y dimension, | |
9382 | the dialog units are multiplied by the average character height and | |
9383 | then divided by 8. | |
9384 | """ | |
54f9ee45 | 9385 | return _core_.Window_DLG_SZE(*args, **kwargs) |
e811c8ce RD |
9386 | |
9387 | def ConvertPixelPointToDialog(*args, **kwargs): | |
a95a7133 | 9388 | """ConvertPixelPointToDialog(self, Point pt) -> Point""" |
54f9ee45 | 9389 | return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs) |
e811c8ce RD |
9390 | |
9391 | def ConvertPixelSizeToDialog(*args, **kwargs): | |
a95a7133 | 9392 | """ConvertPixelSizeToDialog(self, Size sz) -> Size""" |
54f9ee45 | 9393 | return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs) |
e811c8ce RD |
9394 | |
9395 | def WarpPointer(*args, **kwargs): | |
15afbcd0 | 9396 | """ |
a95a7133 | 9397 | WarpPointer(self, int x, int y) |
15afbcd0 RD |
9398 | |
9399 | Moves the pointer to the given position on the window. | |
9400 | ||
9401 | NOTE: This function is not supported under Mac because Apple Human | |
9402 | Interface Guidelines forbid moving the mouse cursor programmatically. | |
9403 | """ | |
54f9ee45 | 9404 | return _core_.Window_WarpPointer(*args, **kwargs) |
e811c8ce RD |
9405 | |
9406 | def CaptureMouse(*args, **kwargs): | |
15afbcd0 | 9407 | """ |
a95a7133 | 9408 | CaptureMouse(self) |
15afbcd0 RD |
9409 | |
9410 | Directs all mouse input to this window. Call wx.Window.ReleaseMouse to | |
9411 | release the capture. | |
9412 | ||
9413 | Note that wxWindows maintains the stack of windows having captured the | |
9414 | mouse and when the mouse is released the capture returns to the window | |
9415 | which had had captured it previously and it is only really released if | |
9416 | there were no previous window. In particular, this means that you must | |
34e0a3bb RD |
9417 | release the mouse as many times as you capture it, unless the window |
9418 | receives the `wx.MouseCaptureLostEvent` event. | |
9419 | ||
9420 | Any application which captures the mouse in the beginning of some | |
9421 | operation *must* handle `wx.MouseCaptureLostEvent` and cancel this | |
9422 | operation when it receives the event. The event handler must not | |
9423 | recapture mouse. | |
15afbcd0 | 9424 | """ |
54f9ee45 | 9425 | return _core_.Window_CaptureMouse(*args, **kwargs) |
e811c8ce RD |
9426 | |
9427 | def ReleaseMouse(*args, **kwargs): | |
15afbcd0 | 9428 | """ |
a95a7133 | 9429 | ReleaseMouse(self) |
15afbcd0 RD |
9430 | |
9431 | Releases mouse input captured with wx.Window.CaptureMouse. | |
9432 | """ | |
54f9ee45 | 9433 | return _core_.Window_ReleaseMouse(*args, **kwargs) |
e811c8ce RD |
9434 | |
9435 | def GetCapture(*args, **kwargs): | |
15afbcd0 | 9436 | """ |
66c033b4 | 9437 | GetCapture() -> Window |
15afbcd0 RD |
9438 | |
9439 | Returns the window which currently captures the mouse or None | |
9440 | """ | |
54f9ee45 | 9441 | return _core_.Window_GetCapture(*args, **kwargs) |
e811c8ce RD |
9442 | |
9443 | GetCapture = staticmethod(GetCapture) | |
9444 | def HasCapture(*args, **kwargs): | |
15afbcd0 | 9445 | """ |
a95a7133 | 9446 | HasCapture(self) -> bool |
15afbcd0 RD |
9447 | |
9448 | Returns true if this window has the current mouse capture. | |
9449 | """ | |
54f9ee45 | 9450 | return _core_.Window_HasCapture(*args, **kwargs) |
e811c8ce RD |
9451 | |
9452 | def Refresh(*args, **kwargs): | |
15afbcd0 | 9453 | """ |
a95a7133 | 9454 | Refresh(self, bool eraseBackground=True, Rect rect=None) |
15afbcd0 RD |
9455 | |
9456 | Mark the specified rectangle (or the whole window) as "dirty" so it | |
9457 | will be repainted. Causes an EVT_PAINT event to be generated and sent | |
9458 | to the window. | |
9459 | """ | |
54f9ee45 | 9460 | return _core_.Window_Refresh(*args, **kwargs) |
e811c8ce RD |
9461 | |
9462 | def RefreshRect(*args, **kwargs): | |
15afbcd0 | 9463 | """ |
fef4c27a | 9464 | RefreshRect(self, Rect rect, bool eraseBackground=True) |
15afbcd0 RD |
9465 | |
9466 | Redraws the contents of the given rectangle: the area inside it will | |
9467 | be repainted. This is the same as Refresh but has a nicer syntax. | |
9468 | """ | |
54f9ee45 | 9469 | return _core_.Window_RefreshRect(*args, **kwargs) |
e811c8ce RD |
9470 | |
9471 | def Update(*args, **kwargs): | |
15afbcd0 | 9472 | """ |
a95a7133 | 9473 | Update(self) |
15afbcd0 RD |
9474 | |
9475 | Calling this method immediately repaints the invalidated area of the | |
9476 | window instead of waiting for the EVT_PAINT event to happen, (normally | |
9477 | this would usually only happen when the flow of control returns to the | |
9478 | event loop.) Notice that this function doesn't refresh the window and | |
9b940138 | 9479 | does nothing if the window has been already repainted. Use `Refresh` |
15afbcd0 RD |
9480 | first if you want to immediately redraw the window (or some portion of |
9481 | it) unconditionally. | |
9482 | """ | |
54f9ee45 | 9483 | return _core_.Window_Update(*args, **kwargs) |
e811c8ce RD |
9484 | |
9485 | def ClearBackground(*args, **kwargs): | |
15afbcd0 | 9486 | """ |
a95a7133 | 9487 | ClearBackground(self) |
15afbcd0 RD |
9488 | |
9489 | Clears the window by filling it with the current background | |
9490 | colour. Does not cause an erase background event to be generated. | |
9491 | """ | |
54f9ee45 | 9492 | return _core_.Window_ClearBackground(*args, **kwargs) |
e811c8ce RD |
9493 | |
9494 | def Freeze(*args, **kwargs): | |
15afbcd0 | 9495 | """ |
a95a7133 | 9496 | Freeze(self) |
15afbcd0 | 9497 | |
41e2b43e RD |
9498 | Freezes the window or, in other words, prevents any updates from |
9499 | taking place on screen, the window is not redrawn at all. Thaw must be | |
9500 | called to reenable window redrawing. Calls to Freeze/Thaw may be | |
9501 | nested, with the actual Thaw being delayed until all the nesting has | |
9502 | been undone. | |
15afbcd0 RD |
9503 | |
9504 | This method is useful for visual appearance optimization (for example, | |
9505 | it is a good idea to use it before inserting large amount of text into | |
9506 | a wxTextCtrl under wxGTK) but is not implemented on all platforms nor | |
9507 | for all controls so it is mostly just a hint to wxWindows and not a | |
9508 | mandatory directive. | |
9509 | """ | |
54f9ee45 | 9510 | return _core_.Window_Freeze(*args, **kwargs) |
e811c8ce | 9511 | |
33d6fd3b RD |
9512 | def IsFrozen(*args, **kwargs): |
9513 | """ | |
9514 | IsFrozen(self) -> bool | |
9515 | ||
9516 | Returns ``True`` if the window has been frozen and not thawed yet. | |
9517 | ||
9518 | :see: `Freeze` and `Thaw` | |
9519 | """ | |
9520 | return _core_.Window_IsFrozen(*args, **kwargs) | |
9521 | ||
e811c8ce | 9522 | def Thaw(*args, **kwargs): |
15afbcd0 | 9523 | """ |
a95a7133 | 9524 | Thaw(self) |
15afbcd0 | 9525 | |
4276dc52 | 9526 | Reenables window updating after a previous call to Freeze. Calls to |
41e2b43e RD |
9527 | Freeze/Thaw may be nested, so Thaw must be called the same number of |
9528 | times that Freeze was before the window will be updated. | |
15afbcd0 | 9529 | """ |
54f9ee45 | 9530 | return _core_.Window_Thaw(*args, **kwargs) |
e811c8ce RD |
9531 | |
9532 | def PrepareDC(*args, **kwargs): | |
15afbcd0 | 9533 | """ |
a95a7133 | 9534 | PrepareDC(self, DC dc) |
15afbcd0 RD |
9535 | |
9536 | Call this function to prepare the device context for drawing a | |
9537 | scrolled image. It sets the device origin according to the current | |
9538 | scroll position. | |
9539 | """ | |
54f9ee45 | 9540 | return _core_.Window_PrepareDC(*args, **kwargs) |
e811c8ce | 9541 | |
b39fe951 RD |
9542 | def IsDoubleBuffered(*args, **kwargs): |
9543 | """ | |
9544 | IsDoubleBuffered(self) -> bool | |
9545 | ||
9546 | Returns ``True`` if the window contents is double-buffered by the | |
9547 | system, i.e. if any drawing done on the window is really done on a | |
9548 | temporary backing surface and transferred to the screen all at once | |
9549 | later. | |
9550 | """ | |
9551 | return _core_.Window_IsDoubleBuffered(*args, **kwargs) | |
9552 | ||
e811c8ce | 9553 | def GetUpdateRegion(*args, **kwargs): |
15afbcd0 | 9554 | """ |
a95a7133 | 9555 | GetUpdateRegion(self) -> Region |
15afbcd0 RD |
9556 | |
9557 | Returns the region specifying which parts of the window have been | |
9558 | damaged. Should only be called within an EVT_PAINT handler. | |
9559 | """ | |
54f9ee45 | 9560 | return _core_.Window_GetUpdateRegion(*args, **kwargs) |
e811c8ce RD |
9561 | |
9562 | def GetUpdateClientRect(*args, **kwargs): | |
15afbcd0 | 9563 | """ |
a95a7133 | 9564 | GetUpdateClientRect(self) -> Rect |
15afbcd0 RD |
9565 | |
9566 | Get the update rectangle region bounding box in client coords. | |
9567 | """ | |
54f9ee45 | 9568 | return _core_.Window_GetUpdateClientRect(*args, **kwargs) |
e811c8ce RD |
9569 | |
9570 | def IsExposed(*args, **kwargs): | |
15afbcd0 | 9571 | """ |
a95a7133 | 9572 | IsExposed(self, int x, int y, int w=1, int h=1) -> bool |
15afbcd0 RD |
9573 | |
9574 | Returns true if the given point or rectangle area has been exposed | |
9575 | since the last repaint. Call this in an paint event handler to | |
9576 | optimize redrawing by only redrawing those areas, which have been | |
9577 | exposed. | |
9578 | """ | |
54f9ee45 | 9579 | return _core_.Window_IsExposed(*args, **kwargs) |
e811c8ce RD |
9580 | |
9581 | def IsExposedPoint(*args, **kwargs): | |
15afbcd0 | 9582 | """ |
a95a7133 | 9583 | IsExposedPoint(self, Point pt) -> bool |
15afbcd0 RD |
9584 | |
9585 | Returns true if the given point or rectangle area has been exposed | |
9586 | since the last repaint. Call this in an paint event handler to | |
9587 | optimize redrawing by only redrawing those areas, which have been | |
9588 | exposed. | |
9589 | """ | |
54f9ee45 | 9590 | return _core_.Window_IsExposedPoint(*args, **kwargs) |
e811c8ce | 9591 | |
4276dc52 | 9592 | def IsExposedRect(*args, **kwargs): |
15afbcd0 | 9593 | """ |
a95a7133 | 9594 | IsExposedRect(self, Rect rect) -> bool |
15afbcd0 RD |
9595 | |
9596 | Returns true if the given point or rectangle area has been exposed | |
9597 | since the last repaint. Call this in an paint event handler to | |
9598 | optimize redrawing by only redrawing those areas, which have been | |
9599 | exposed. | |
9600 | """ | |
54f9ee45 | 9601 | return _core_.Window_IsExposedRect(*args, **kwargs) |
e811c8ce | 9602 | |
74a57fcd RD |
9603 | def GetDefaultAttributes(*args, **kwargs): |
9604 | """ | |
a95a7133 | 9605 | GetDefaultAttributes(self) -> VisualAttributes |
74a57fcd | 9606 | |
41e2b43e RD |
9607 | Get the default attributes for an instance of this class. This is |
9608 | useful if you want to use the same font or colour in your own control | |
9609 | as in a standard control -- which is a much better idea than hard | |
9610 | coding specific colours or fonts which might look completely out of | |
db3e571a | 9611 | place on the user's system, especially if it uses themes. |
74a57fcd | 9612 | """ |
54f9ee45 | 9613 | return _core_.Window_GetDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
9614 | |
9615 | def GetClassDefaultAttributes(*args, **kwargs): | |
9616 | """ | |
66c033b4 | 9617 | GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
74a57fcd | 9618 | |
41e2b43e RD |
9619 | Get the default attributes for this class. This is useful if you want |
9620 | to use the same font or colour in your own control as in a standard | |
9621 | control -- which is a much better idea than hard coding specific | |
db3e571a RD |
9622 | colours or fonts which might look completely out of place on the |
9623 | user's system, especially if it uses themes. | |
74a57fcd RD |
9624 | |
9625 | The variant parameter is only relevant under Mac currently and is | |
41e2b43e | 9626 | ignore under other platforms. Under Mac, it will change the size of |
db3e571a RD |
9627 | the returned font. See `wx.Window.SetWindowVariant` for more about |
9628 | this. | |
74a57fcd | 9629 | """ |
54f9ee45 | 9630 | return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
9631 | |
9632 | GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) | |
e811c8ce | 9633 | def SetBackgroundColour(*args, **kwargs): |
15afbcd0 | 9634 | """ |
a95a7133 | 9635 | SetBackgroundColour(self, Colour colour) -> bool |
15afbcd0 RD |
9636 | |
9637 | Sets the background colour of the window. Returns True if the colour | |
9638 | was changed. The background colour is usually painted by the default | |
9639 | EVT_ERASE_BACKGROUND event handler function under Windows and | |
f8167d6e RD |
9640 | automatically under GTK. Using `wx.NullColour` will reset the window |
9641 | to the default background colour. | |
15afbcd0 | 9642 | |
db3e571a | 9643 | Note that setting the background colour may not cause an immediate |
f8167d6e | 9644 | refresh, so you may wish to call `ClearBackground` or `Refresh` after |
15afbcd0 RD |
9645 | calling this function. |
9646 | ||
f8167d6e RD |
9647 | Using this function will disable attempts to use themes for this |
9648 | window, if the system supports them. Use with care since usually the | |
9649 | themes represent the appearance chosen by the user to be used for all | |
9650 | applications on the system. | |
15afbcd0 | 9651 | """ |
54f9ee45 | 9652 | return _core_.Window_SetBackgroundColour(*args, **kwargs) |
e811c8ce | 9653 | |
412d302d RD |
9654 | def SetOwnBackgroundColour(*args, **kwargs): |
9655 | """SetOwnBackgroundColour(self, Colour colour)""" | |
9656 | return _core_.Window_SetOwnBackgroundColour(*args, **kwargs) | |
b2df227b | 9657 | |
e811c8ce | 9658 | def SetForegroundColour(*args, **kwargs): |
15afbcd0 | 9659 | """ |
a95a7133 | 9660 | SetForegroundColour(self, Colour colour) -> bool |
15afbcd0 RD |
9661 | |
9662 | Sets the foreground colour of the window. Returns True is the colour | |
9663 | was changed. The interpretation of foreground colour is dependent on | |
9664 | the window class; it may be the text colour or other colour, or it may | |
9665 | not be used at all. | |
9666 | """ | |
54f9ee45 | 9667 | return _core_.Window_SetForegroundColour(*args, **kwargs) |
e811c8ce | 9668 | |
fa47d7a7 VS |
9669 | def SetOwnForegroundColour(*args, **kwargs): |
9670 | """SetOwnForegroundColour(self, Colour colour)""" | |
9671 | return _core_.Window_SetOwnForegroundColour(*args, **kwargs) | |
b2df227b | 9672 | |
e811c8ce | 9673 | def GetBackgroundColour(*args, **kwargs): |
15afbcd0 | 9674 | """ |
a95a7133 | 9675 | GetBackgroundColour(self) -> Colour |
15afbcd0 RD |
9676 | |
9677 | Returns the background colour of the window. | |
9678 | """ | |
54f9ee45 | 9679 | return _core_.Window_GetBackgroundColour(*args, **kwargs) |
e811c8ce RD |
9680 | |
9681 | def GetForegroundColour(*args, **kwargs): | |
15afbcd0 | 9682 | """ |
a95a7133 | 9683 | GetForegroundColour(self) -> Colour |
15afbcd0 RD |
9684 | |
9685 | Returns the foreground colour of the window. The interpretation of | |
9686 | foreground colour is dependent on the window class; it may be the text | |
9687 | colour or other colour, or it may not be used at all. | |
9688 | """ | |
54f9ee45 | 9689 | return _core_.Window_GetForegroundColour(*args, **kwargs) |
e811c8ce | 9690 | |
562ecc31 RD |
9691 | def InheritsBackgroundColour(*args, **kwargs): |
9692 | """InheritsBackgroundColour(self) -> bool""" | |
9693 | return _core_.Window_InheritsBackgroundColour(*args, **kwargs) | |
9694 | ||
9695 | def UseBgCol(*args, **kwargs): | |
9696 | """UseBgCol(self) -> bool""" | |
9697 | return _core_.Window_UseBgCol(*args, **kwargs) | |
9698 | ||
7bc1e663 RD |
9699 | def SetBackgroundStyle(*args, **kwargs): |
9700 | """ | |
9701 | SetBackgroundStyle(self, int style) -> bool | |
9702 | ||
9703 | Returns the background style of the window. The background style | |
9704 | indicates how the background of the window is drawn. | |
9705 | ||
9706 | ====================== ======================================== | |
9707 | wx.BG_STYLE_SYSTEM The background colour or pattern should | |
9708 | be determined by the system | |
9709 | wx.BG_STYLE_COLOUR The background should be a solid colour | |
9710 | wx.BG_STYLE_CUSTOM The background will be implemented by the | |
9711 | application. | |
9712 | ====================== ======================================== | |
9713 | ||
9714 | On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of | |
9715 | a custom background, such as a tiled bitmap. Currently the style has | |
9716 | no effect on other platforms. | |
9717 | ||
9718 | :see: `GetBackgroundStyle`, `SetBackgroundColour` | |
9719 | """ | |
9720 | return _core_.Window_SetBackgroundStyle(*args, **kwargs) | |
9721 | ||
9722 | def GetBackgroundStyle(*args, **kwargs): | |
9723 | """ | |
9724 | GetBackgroundStyle(self) -> int | |
9725 | ||
9726 | Returns the background style of the window. | |
9727 | ||
9728 | :see: `SetBackgroundStyle` | |
9729 | """ | |
9730 | return _core_.Window_GetBackgroundStyle(*args, **kwargs) | |
9731 | ||
51b83b37 RD |
9732 | def HasTransparentBackground(*args, **kwargs): |
9733 | """ | |
9734 | HasTransparentBackground(self) -> bool | |
9735 | ||
9736 | Returns True if this window's background is transparent (as, for | |
9737 | example, for `wx.StaticText`) and should show the parent window's | |
9738 | background. | |
9739 | ||
9740 | This method is mostly used internally by the library itself and you | |
9741 | normally shouldn't have to call it. You may, however, have to override | |
9742 | it in your custom control classes to ensure that background is painted | |
9743 | correctly. | |
9744 | """ | |
9745 | return _core_.Window_HasTransparentBackground(*args, **kwargs) | |
9746 | ||
e811c8ce | 9747 | def SetCursor(*args, **kwargs): |
15afbcd0 | 9748 | """ |
a95a7133 | 9749 | SetCursor(self, Cursor cursor) -> bool |
15afbcd0 RD |
9750 | |
9751 | Sets the window's cursor. Notice that the window cursor also sets it | |
9752 | for the children of the window implicitly. | |
9753 | ||
9754 | The cursor may be wx.NullCursor in which case the window cursor will | |
9755 | be reset back to default. | |
9756 | """ | |
54f9ee45 | 9757 | return _core_.Window_SetCursor(*args, **kwargs) |
e811c8ce RD |
9758 | |
9759 | def GetCursor(*args, **kwargs): | |
15afbcd0 | 9760 | """ |
a95a7133 | 9761 | GetCursor(self) -> Cursor |
15afbcd0 RD |
9762 | |
9763 | Return the cursor associated with this window. | |
9764 | """ | |
54f9ee45 | 9765 | return _core_.Window_GetCursor(*args, **kwargs) |
e811c8ce RD |
9766 | |
9767 | def SetFont(*args, **kwargs): | |
15afbcd0 | 9768 | """ |
a95a7133 | 9769 | SetFont(self, Font font) -> bool |
15afbcd0 RD |
9770 | |
9771 | Sets the font for this window. | |
9772 | """ | |
54f9ee45 | 9773 | return _core_.Window_SetFont(*args, **kwargs) |
e811c8ce | 9774 | |
fa47d7a7 VS |
9775 | def SetOwnFont(*args, **kwargs): |
9776 | """SetOwnFont(self, Font font)""" | |
9777 | return _core_.Window_SetOwnFont(*args, **kwargs) | |
b2df227b | 9778 | |
e811c8ce | 9779 | def GetFont(*args, **kwargs): |
15afbcd0 | 9780 | """ |
a95a7133 | 9781 | GetFont(self) -> Font |
15afbcd0 | 9782 | |
4276dc52 | 9783 | Returns the default font used for this window. |
15afbcd0 | 9784 | """ |
54f9ee45 | 9785 | return _core_.Window_GetFont(*args, **kwargs) |
e811c8ce RD |
9786 | |
9787 | def SetCaret(*args, **kwargs): | |
15afbcd0 | 9788 | """ |
a95a7133 | 9789 | SetCaret(self, Caret caret) |
15afbcd0 RD |
9790 | |
9791 | Sets the caret associated with the window. | |
9792 | """ | |
54f9ee45 | 9793 | return _core_.Window_SetCaret(*args, **kwargs) |
e811c8ce RD |
9794 | |
9795 | def GetCaret(*args, **kwargs): | |
15afbcd0 | 9796 | """ |
a95a7133 | 9797 | GetCaret(self) -> Caret |
15afbcd0 RD |
9798 | |
9799 | Returns the caret associated with the window. | |
9800 | """ | |
54f9ee45 | 9801 | return _core_.Window_GetCaret(*args, **kwargs) |
e811c8ce RD |
9802 | |
9803 | def GetCharHeight(*args, **kwargs): | |
15afbcd0 | 9804 | """ |
a95a7133 | 9805 | GetCharHeight(self) -> int |
15afbcd0 RD |
9806 | |
9807 | Get the (average) character size for the current font. | |
9808 | """ | |
54f9ee45 | 9809 | return _core_.Window_GetCharHeight(*args, **kwargs) |
e811c8ce RD |
9810 | |
9811 | def GetCharWidth(*args, **kwargs): | |
15afbcd0 | 9812 | """ |
a95a7133 | 9813 | GetCharWidth(self) -> int |
15afbcd0 RD |
9814 | |
9815 | Get the (average) character size for the current font. | |
9816 | """ | |
54f9ee45 | 9817 | return _core_.Window_GetCharWidth(*args, **kwargs) |
e811c8ce RD |
9818 | |
9819 | def GetTextExtent(*args, **kwargs): | |
fd2dc343 RD |
9820 | """ |
9821 | GetTextExtent(String string) -> (width, height) | |
9822 | ||
9823 | Get the width and height of the text using the current font. | |
9824 | """ | |
54f9ee45 | 9825 | return _core_.Window_GetTextExtent(*args, **kwargs) |
e811c8ce RD |
9826 | |
9827 | def GetFullTextExtent(*args, **kwargs): | |
0df68c9f | 9828 | """ |
196addbf | 9829 | GetFullTextExtent(String string, Font font=None) -> |
0df68c9f | 9830 | (width, height, descent, externalLeading) |
e811c8ce | 9831 | |
15afbcd0 RD |
9832 | Get the width, height, decent and leading of the text using the |
9833 | current or specified font. | |
0df68c9f | 9834 | """ |
54f9ee45 | 9835 | return _core_.Window_GetFullTextExtent(*args, **kwargs) |
e811c8ce RD |
9836 | |
9837 | def ClientToScreenXY(*args, **kwargs): | |
15afbcd0 RD |
9838 | """ |
9839 | ClientToScreenXY(int x, int y) -> (x,y) | |
9840 | ||
9841 | Converts to screen coordinates from coordinates relative to this window. | |
9842 | """ | |
54f9ee45 | 9843 | return _core_.Window_ClientToScreenXY(*args, **kwargs) |
e811c8ce RD |
9844 | |
9845 | def ScreenToClientXY(*args, **kwargs): | |
15afbcd0 RD |
9846 | """ |
9847 | ScreenToClientXY(int x, int y) -> (x,y) | |
9848 | ||
9849 | Converts from screen to client window coordinates. | |
9850 | """ | |
54f9ee45 | 9851 | return _core_.Window_ScreenToClientXY(*args, **kwargs) |
e811c8ce RD |
9852 | |
9853 | def ClientToScreen(*args, **kwargs): | |
15afbcd0 | 9854 | """ |
a95a7133 | 9855 | ClientToScreen(self, Point pt) -> Point |
15afbcd0 RD |
9856 | |
9857 | Converts to screen coordinates from coordinates relative to this window. | |
9858 | """ | |
54f9ee45 | 9859 | return _core_.Window_ClientToScreen(*args, **kwargs) |
e811c8ce RD |
9860 | |
9861 | def ScreenToClient(*args, **kwargs): | |
15afbcd0 | 9862 | """ |
a95a7133 | 9863 | ScreenToClient(self, Point pt) -> Point |
15afbcd0 RD |
9864 | |
9865 | Converts from screen to client window coordinates. | |
9866 | """ | |
54f9ee45 | 9867 | return _core_.Window_ScreenToClient(*args, **kwargs) |
e811c8ce RD |
9868 | |
9869 | def HitTestXY(*args, **kwargs): | |
15afbcd0 | 9870 | """ |
a95a7133 | 9871 | HitTestXY(self, int x, int y) -> int |
15afbcd0 RD |
9872 | |
9873 | Test where the given (in client coords) point lies | |
9874 | """ | |
54f9ee45 | 9875 | return _core_.Window_HitTestXY(*args, **kwargs) |
e811c8ce RD |
9876 | |
9877 | def HitTest(*args, **kwargs): | |
15afbcd0 | 9878 | """ |
a95a7133 | 9879 | HitTest(self, Point pt) -> int |
15afbcd0 RD |
9880 | |
9881 | Test where the given (in client coords) point lies | |
9882 | """ | |
54f9ee45 | 9883 | return _core_.Window_HitTest(*args, **kwargs) |
e811c8ce | 9884 | |
15afbcd0 RD |
9885 | def GetBorder(*args): |
9886 | """ | |
a95a7133 RD |
9887 | GetBorder(self, long flags) -> int |
9888 | GetBorder(self) -> int | |
e811c8ce | 9889 | |
15afbcd0 RD |
9890 | Get border for the flags of this window |
9891 | """ | |
54f9ee45 | 9892 | return _core_.Window_GetBorder(*args) |
e811c8ce RD |
9893 | |
9894 | def UpdateWindowUI(*args, **kwargs): | |
15afbcd0 | 9895 | """ |
a95a7133 | 9896 | UpdateWindowUI(self, long flags=UPDATE_UI_NONE) |
15afbcd0 RD |
9897 | |
9898 | This function sends EVT_UPDATE_UI events to the window. The particular | |
9899 | implementation depends on the window; for example a wx.ToolBar will | |
9900 | send an update UI event for each toolbar button, and a wx.Frame will | |
9901 | send an update UI event for each menubar menu item. You can call this | |
9902 | function from your application to ensure that your UI is up-to-date at | |
9903 | a particular point in time (as far as your EVT_UPDATE_UI handlers are | |
9904 | concerned). This may be necessary if you have called | |
5ba5649b | 9905 | `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to |
15afbcd0 RD |
9906 | limit the overhead that wxWindows incurs by sending update UI events |
9907 | in idle time. | |
15afbcd0 | 9908 | """ |
54f9ee45 | 9909 | return _core_.Window_UpdateWindowUI(*args, **kwargs) |
e811c8ce RD |
9910 | |
9911 | def PopupMenuXY(*args, **kwargs): | |
15afbcd0 | 9912 | """ |
b0503257 | 9913 | PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool |
15afbcd0 | 9914 | |
b0503257 RD |
9915 | Pops up the given menu at the specified coordinates, relative to this window, |
9916 | and returns control when the user has dismissed the menu. If a menu item is | |
9917 | selected, the corresponding menu event is generated and will be processed as | |
9918 | usual. If the default position is given then the current position of the | |
9919 | mouse cursor will be used. | |
15afbcd0 | 9920 | """ |
54f9ee45 | 9921 | return _core_.Window_PopupMenuXY(*args, **kwargs) |
e811c8ce | 9922 | |
15afbcd0 RD |
9923 | def PopupMenu(*args, **kwargs): |
9924 | """ | |
b0503257 | 9925 | PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool |
15afbcd0 | 9926 | |
b0503257 RD |
9927 | Pops up the given menu at the specified coordinates, relative to this window, |
9928 | and returns control when the user has dismissed the menu. If a menu item is | |
9929 | selected, the corresponding menu event is generated and will be processed as | |
9930 | usual. If the default position is given then the current position of the | |
9931 | mouse cursor will be used. | |
15afbcd0 | 9932 | """ |
54f9ee45 | 9933 | return _core_.Window_PopupMenu(*args, **kwargs) |
15afbcd0 | 9934 | |
10044bf1 RD |
9935 | def HasMultiplePages(*args, **kwargs): |
9936 | """HasMultiplePages(self) -> bool""" | |
9937 | return _core_.Window_HasMultiplePages(*args, **kwargs) | |
9938 | ||
15afbcd0 RD |
9939 | def GetHandle(*args, **kwargs): |
9940 | """ | |
a95a7133 | 9941 | GetHandle(self) -> long |
15afbcd0 RD |
9942 | |
9943 | Returns the platform-specific handle (as a long integer) of the | |
9944 | physical window. Currently on wxMac it returns the handle of the | |
9945 | toplevel parent of the window. | |
9946 | """ | |
54f9ee45 | 9947 | return _core_.Window_GetHandle(*args, **kwargs) |
15afbcd0 | 9948 | |
7e63a440 RD |
9949 | def AssociateHandle(*args, **kwargs): |
9950 | """ | |
9951 | AssociateHandle(self, long handle) | |
9952 | ||
9953 | Associate the window with a new native handle | |
9954 | """ | |
9955 | return _core_.Window_AssociateHandle(*args, **kwargs) | |
9956 | ||
9957 | def DissociateHandle(*args, **kwargs): | |
9958 | """ | |
9959 | DissociateHandle(self) | |
9960 | ||
9961 | Dissociate the current native handle from the window | |
9962 | """ | |
9963 | return _core_.Window_DissociateHandle(*args, **kwargs) | |
9964 | ||
15afbcd0 RD |
9965 | def HasScrollbar(*args, **kwargs): |
9966 | """ | |
a95a7133 | 9967 | HasScrollbar(self, int orient) -> bool |
15afbcd0 RD |
9968 | |
9969 | Does the window have the scrollbar for this orientation? | |
9970 | """ | |
54f9ee45 | 9971 | return _core_.Window_HasScrollbar(*args, **kwargs) |
15afbcd0 RD |
9972 | |
9973 | def SetScrollbar(*args, **kwargs): | |
9974 | """ | |
41e2b43e | 9975 | SetScrollbar(self, int orientation, int position, int thumbSize, int range, |
15afbcd0 RD |
9976 | bool refresh=True) |
9977 | ||
9978 | Sets the scrollbar properties of a built-in scrollbar. | |
15afbcd0 | 9979 | """ |
54f9ee45 | 9980 | return _core_.Window_SetScrollbar(*args, **kwargs) |
e811c8ce RD |
9981 | |
9982 | def SetScrollPos(*args, **kwargs): | |
15afbcd0 | 9983 | """ |
a95a7133 | 9984 | SetScrollPos(self, int orientation, int pos, bool refresh=True) |
15afbcd0 RD |
9985 | |
9986 | Sets the position of one of the built-in scrollbars. | |
9987 | """ | |
54f9ee45 | 9988 | return _core_.Window_SetScrollPos(*args, **kwargs) |
e811c8ce RD |
9989 | |
9990 | def GetScrollPos(*args, **kwargs): | |
15afbcd0 | 9991 | """ |
a95a7133 | 9992 | GetScrollPos(self, int orientation) -> int |
15afbcd0 RD |
9993 | |
9994 | Returns the built-in scrollbar position. | |
9995 | """ | |
54f9ee45 | 9996 | return _core_.Window_GetScrollPos(*args, **kwargs) |
e811c8ce RD |
9997 | |
9998 | def GetScrollThumb(*args, **kwargs): | |
15afbcd0 | 9999 | """ |
a95a7133 | 10000 | GetScrollThumb(self, int orientation) -> int |
15afbcd0 RD |
10001 | |
10002 | Returns the built-in scrollbar thumb size. | |
10003 | """ | |
54f9ee45 | 10004 | return _core_.Window_GetScrollThumb(*args, **kwargs) |
e811c8ce RD |
10005 | |
10006 | def GetScrollRange(*args, **kwargs): | |
15afbcd0 | 10007 | """ |
a95a7133 | 10008 | GetScrollRange(self, int orientation) -> int |
15afbcd0 RD |
10009 | |
10010 | Returns the built-in scrollbar range. | |
10011 | """ | |
54f9ee45 | 10012 | return _core_.Window_GetScrollRange(*args, **kwargs) |
e811c8ce RD |
10013 | |
10014 | def ScrollWindow(*args, **kwargs): | |
15afbcd0 | 10015 | """ |
a95a7133 | 10016 | ScrollWindow(self, int dx, int dy, Rect rect=None) |
15afbcd0 RD |
10017 | |
10018 | Physically scrolls the pixels in the window and move child windows | |
10019 | accordingly. Use this function to optimise your scrolling | |
10020 | implementations, to minimise the area that must be redrawn. Note that | |
10021 | it is rarely required to call this function from a user program. | |
15afbcd0 | 10022 | """ |
54f9ee45 | 10023 | return _core_.Window_ScrollWindow(*args, **kwargs) |
e811c8ce RD |
10024 | |
10025 | def ScrollLines(*args, **kwargs): | |
15afbcd0 | 10026 | """ |
a95a7133 | 10027 | ScrollLines(self, int lines) -> bool |
15afbcd0 RD |
10028 | |
10029 | If the platform and window class supports it, scrolls the window by | |
10030 | the given number of lines down, if lines is positive, or up if lines | |
10031 | is negative. Returns True if the window was scrolled, False if it was | |
10032 | already on top/bottom and nothing was done. | |
10033 | """ | |
54f9ee45 | 10034 | return _core_.Window_ScrollLines(*args, **kwargs) |
e811c8ce RD |
10035 | |
10036 | def ScrollPages(*args, **kwargs): | |
15afbcd0 | 10037 | """ |
a95a7133 | 10038 | ScrollPages(self, int pages) -> bool |
15afbcd0 | 10039 | |
41e2b43e | 10040 | If the platform and window class supports it, scrolls the window by |
15afbcd0 RD |
10041 | the given number of pages down, if pages is positive, or up if pages |
10042 | is negative. Returns True if the window was scrolled, False if it was | |
10043 | already on top/bottom and nothing was done. | |
10044 | """ | |
54f9ee45 | 10045 | return _core_.Window_ScrollPages(*args, **kwargs) |
e811c8ce RD |
10046 | |
10047 | def LineUp(*args, **kwargs): | |
15afbcd0 | 10048 | """ |
a95a7133 | 10049 | LineUp(self) -> bool |
15afbcd0 RD |
10050 | |
10051 | This is just a wrapper for ScrollLines(-1). | |
10052 | """ | |
54f9ee45 | 10053 | return _core_.Window_LineUp(*args, **kwargs) |
e811c8ce RD |
10054 | |
10055 | def LineDown(*args, **kwargs): | |
15afbcd0 | 10056 | """ |
a95a7133 | 10057 | LineDown(self) -> bool |
15afbcd0 RD |
10058 | |
10059 | This is just a wrapper for ScrollLines(1). | |
10060 | """ | |
54f9ee45 | 10061 | return _core_.Window_LineDown(*args, **kwargs) |
e811c8ce RD |
10062 | |
10063 | def PageUp(*args, **kwargs): | |
15afbcd0 | 10064 | """ |
a95a7133 | 10065 | PageUp(self) -> bool |
15afbcd0 RD |
10066 | |
10067 | This is just a wrapper for ScrollPages(-1). | |
10068 | """ | |
54f9ee45 | 10069 | return _core_.Window_PageUp(*args, **kwargs) |
e811c8ce RD |
10070 | |
10071 | def PageDown(*args, **kwargs): | |
15afbcd0 | 10072 | """ |
a95a7133 | 10073 | PageDown(self) -> bool |
15afbcd0 RD |
10074 | |
10075 | This is just a wrapper for ScrollPages(1). | |
10076 | """ | |
54f9ee45 | 10077 | return _core_.Window_PageDown(*args, **kwargs) |
e811c8ce RD |
10078 | |
10079 | def SetHelpText(*args, **kwargs): | |
15afbcd0 | 10080 | """ |
a95a7133 | 10081 | SetHelpText(self, String text) |
15afbcd0 RD |
10082 | |
10083 | Sets the help text to be used as context-sensitive help for this | |
10084 | window. Note that the text is actually stored by the current | |
f52cbe90 | 10085 | `wx.HelpProvider` implementation, and not in the window object itself. |
15afbcd0 | 10086 | """ |
54f9ee45 | 10087 | return _core_.Window_SetHelpText(*args, **kwargs) |
e811c8ce RD |
10088 | |
10089 | def SetHelpTextForId(*args, **kwargs): | |
15afbcd0 | 10090 | """ |
a95a7133 | 10091 | SetHelpTextForId(self, String text) |
15afbcd0 RD |
10092 | |
10093 | Associate this help text with all windows with the same id as this | |
10094 | one. | |
10095 | """ | |
54f9ee45 | 10096 | return _core_.Window_SetHelpTextForId(*args, **kwargs) |
e811c8ce | 10097 | |
b850e7f3 RD |
10098 | def GetHelpTextAtPoint(*args, **kwargs): |
10099 | """ | |
10100 | GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String | |
10101 | ||
10102 | Get the help string associated with the given position in this window. | |
10103 | ||
10104 | Notice that pt may be invalid if event origin is keyboard or unknown | |
10105 | and this method should return the global window help text then | |
10106 | ||
10107 | """ | |
10108 | return _core_.Window_GetHelpTextAtPoint(*args, **kwargs) | |
10109 | ||
e811c8ce | 10110 | def GetHelpText(*args, **kwargs): |
15afbcd0 | 10111 | """ |
a95a7133 | 10112 | GetHelpText(self) -> String |
15afbcd0 RD |
10113 | |
10114 | Gets the help text to be used as context-sensitive help for this | |
10115 | window. Note that the text is actually stored by the current | |
f52cbe90 | 10116 | `wx.HelpProvider` implementation, and not in the window object itself. |
15afbcd0 | 10117 | """ |
54f9ee45 | 10118 | return _core_.Window_GetHelpText(*args, **kwargs) |
e811c8ce RD |
10119 | |
10120 | def SetToolTipString(*args, **kwargs): | |
15afbcd0 | 10121 | """ |
a95a7133 | 10122 | SetToolTipString(self, String tip) |
15afbcd0 RD |
10123 | |
10124 | Attach a tooltip to the window. | |
10125 | """ | |
54f9ee45 | 10126 | return _core_.Window_SetToolTipString(*args, **kwargs) |
e811c8ce RD |
10127 | |
10128 | def SetToolTip(*args, **kwargs): | |
15afbcd0 | 10129 | """ |
a95a7133 | 10130 | SetToolTip(self, ToolTip tip) |
15afbcd0 RD |
10131 | |
10132 | Attach a tooltip to the window. | |
10133 | """ | |
54f9ee45 | 10134 | return _core_.Window_SetToolTip(*args, **kwargs) |
e811c8ce RD |
10135 | |
10136 | def GetToolTip(*args, **kwargs): | |
15afbcd0 | 10137 | """ |
a95a7133 | 10138 | GetToolTip(self) -> ToolTip |
15afbcd0 RD |
10139 | |
10140 | get the associated tooltip or None if none | |
10141 | """ | |
54f9ee45 | 10142 | return _core_.Window_GetToolTip(*args, **kwargs) |
e811c8ce RD |
10143 | |
10144 | def SetDropTarget(*args, **kwargs): | |
15afbcd0 | 10145 | """ |
a95a7133 | 10146 | SetDropTarget(self, DropTarget dropTarget) |
15afbcd0 RD |
10147 | |
10148 | Associates a drop target with this window. If the window already has | |
10149 | a drop target, it is deleted. | |
10150 | """ | |
54f9ee45 | 10151 | return _core_.Window_SetDropTarget(*args, **kwargs) |
e811c8ce RD |
10152 | |
10153 | def GetDropTarget(*args, **kwargs): | |
15afbcd0 | 10154 | """ |
a95a7133 | 10155 | GetDropTarget(self) -> DropTarget |
15afbcd0 RD |
10156 | |
10157 | Returns the associated drop target, which may be None. | |
10158 | """ | |
54f9ee45 | 10159 | return _core_.Window_GetDropTarget(*args, **kwargs) |
e811c8ce | 10160 | |
5ba5649b RD |
10161 | def DragAcceptFiles(*args, **kwargs): |
10162 | """ | |
10163 | DragAcceptFiles(self, bool accept) | |
10164 | ||
10165 | Enables or disables eligibility for drop file events, EVT_DROP_FILES. | |
10166 | Only functional on Windows. | |
10167 | """ | |
10168 | return _core_.Window_DragAcceptFiles(*args, **kwargs) | |
10169 | ||
e811c8ce | 10170 | def SetConstraints(*args, **kwargs): |
15afbcd0 | 10171 | """ |
a95a7133 | 10172 | SetConstraints(self, LayoutConstraints constraints) |
15afbcd0 RD |
10173 | |
10174 | Sets the window to have the given layout constraints. If an existing | |
10175 | layout constraints object is already owned by the window, it will be | |
10176 | deleted. Pass None to disassociate and delete the window's current | |
10177 | constraints. | |
10178 | ||
10179 | You must call SetAutoLayout to tell a window to use the constraints | |
10180 | automatically in its default EVT_SIZE handler; otherwise, you must | |
10181 | handle EVT_SIZE yourself and call Layout() explicitly. When setting | |
10182 | both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have | |
10183 | effect. | |
10184 | """ | |
54f9ee45 | 10185 | return _core_.Window_SetConstraints(*args, **kwargs) |
e811c8ce RD |
10186 | |
10187 | def GetConstraints(*args, **kwargs): | |
15afbcd0 | 10188 | """ |
a95a7133 | 10189 | GetConstraints(self) -> LayoutConstraints |
15afbcd0 RD |
10190 | |
10191 | Returns a pointer to the window's layout constraints, or None if there | |
10192 | are none. | |
10193 | """ | |
54f9ee45 | 10194 | return _core_.Window_GetConstraints(*args, **kwargs) |
e811c8ce RD |
10195 | |
10196 | def SetAutoLayout(*args, **kwargs): | |
15afbcd0 | 10197 | """ |
a95a7133 | 10198 | SetAutoLayout(self, bool autoLayout) |
15afbcd0 RD |
10199 | |
10200 | Determines whether the Layout function will be called automatically | |
b1fcee84 RD |
10201 | when the window is resized. lease note that this only happens for the |
10202 | windows usually used to contain children, namely `wx.Panel` and | |
10203 | `wx.TopLevelWindow` (and the classes deriving from them). | |
10204 | ||
10205 | This method is called implicitly by `SetSizer` but if you use | |
10206 | `SetConstraints` you should call it manually or otherwise the window | |
10207 | layout won't be correctly updated when its size changes. | |
15afbcd0 | 10208 | """ |
54f9ee45 | 10209 | return _core_.Window_SetAutoLayout(*args, **kwargs) |
e811c8ce RD |
10210 | |
10211 | def GetAutoLayout(*args, **kwargs): | |
15afbcd0 | 10212 | """ |
a95a7133 | 10213 | GetAutoLayout(self) -> bool |
15afbcd0 RD |
10214 | |
10215 | Returns the current autoLayout setting | |
10216 | """ | |
54f9ee45 | 10217 | return _core_.Window_GetAutoLayout(*args, **kwargs) |
e811c8ce RD |
10218 | |
10219 | def Layout(*args, **kwargs): | |
15afbcd0 | 10220 | """ |
a95a7133 | 10221 | Layout(self) -> bool |
15afbcd0 RD |
10222 | |
10223 | Invokes the constraint-based layout algorithm or the sizer-based | |
10224 | algorithm for this window. See SetAutoLayout: when auto layout is on, | |
10225 | this function gets called automatically by the default EVT_SIZE | |
10226 | handler when the window is resized. | |
10227 | """ | |
54f9ee45 | 10228 | return _core_.Window_Layout(*args, **kwargs) |
e811c8ce RD |
10229 | |
10230 | def SetSizer(*args, **kwargs): | |
15afbcd0 | 10231 | """ |
a95a7133 | 10232 | SetSizer(self, Sizer sizer, bool deleteOld=True) |
15afbcd0 RD |
10233 | |
10234 | Sets the window to have the given layout sizer. The window will then | |
10235 | own the object, and will take care of its deletion. If an existing | |
10236 | layout sizer object is already owned by the window, it will be deleted | |
10237 | if the deleteOld parameter is true. Note that this function will also | |
10238 | call SetAutoLayout implicitly with a True parameter if the sizer is | |
ae8162c8 | 10239 | non-None, and False otherwise. |
15afbcd0 | 10240 | """ |
54f9ee45 | 10241 | return _core_.Window_SetSizer(*args, **kwargs) |
e811c8ce RD |
10242 | |
10243 | def SetSizerAndFit(*args, **kwargs): | |
15afbcd0 | 10244 | """ |
a95a7133 | 10245 | SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) |
15afbcd0 RD |
10246 | |
10247 | The same as SetSizer, except it also sets the size hints for the | |
10248 | window based on the sizer's minimum size. | |
10249 | """ | |
54f9ee45 | 10250 | return _core_.Window_SetSizerAndFit(*args, **kwargs) |
e811c8ce RD |
10251 | |
10252 | def GetSizer(*args, **kwargs): | |
15afbcd0 | 10253 | """ |
a95a7133 | 10254 | GetSizer(self) -> Sizer |
15afbcd0 RD |
10255 | |
10256 | Return the sizer associated with the window by a previous call to | |
10257 | SetSizer or None if there isn't one. | |
10258 | """ | |
54f9ee45 | 10259 | return _core_.Window_GetSizer(*args, **kwargs) |
e811c8ce RD |
10260 | |
10261 | def SetContainingSizer(*args, **kwargs): | |
15afbcd0 | 10262 | """ |
a95a7133 | 10263 | SetContainingSizer(self, Sizer sizer) |
15afbcd0 RD |
10264 | |
10265 | This normally does not need to be called by application code. It is | |
10266 | called internally when a window is added to a sizer, and is used so | |
10267 | the window can remove itself from the sizer when it is destroyed. | |
10268 | """ | |
54f9ee45 | 10269 | return _core_.Window_SetContainingSizer(*args, **kwargs) |
e811c8ce RD |
10270 | |
10271 | def GetContainingSizer(*args, **kwargs): | |
15afbcd0 | 10272 | """ |
a95a7133 | 10273 | GetContainingSizer(self) -> Sizer |
15afbcd0 RD |
10274 | |
10275 | Return the sizer that this window is a member of, if any, otherwise None. | |
10276 | """ | |
54f9ee45 | 10277 | return _core_.Window_GetContainingSizer(*args, **kwargs) |
e811c8ce | 10278 | |
a95a7133 RD |
10279 | def InheritAttributes(*args, **kwargs): |
10280 | """ | |
10281 | InheritAttributes(self) | |
10282 | ||
41e2b43e RD |
10283 | This function is (or should be, in case of custom controls) called |
10284 | during window creation to intelligently set up the window visual | |
10285 | attributes, that is the font and the foreground and background | |
10286 | colours. | |
10287 | ||
10288 | By 'intelligently' the following is meant: by default, all windows use | |
10289 | their own default attributes. However if some of the parent's | |
10290 | attributes are explicitly changed (that is, using SetFont and not | |
fa47d7a7 | 10291 | SetOwnFont) and if the corresponding attribute hadn't been |
41e2b43e RD |
10292 | explicitly set for this window itself, then this window takes the same |
10293 | value as used by the parent. In addition, if the window overrides | |
10294 | ShouldInheritColours to return false, the colours will not be changed | |
10295 | no matter what and only the font might. | |
10296 | ||
34621cc5 | 10297 | This rather complicated logic is necessary in order to accommodate the |
ec9b55ca | 10298 | different usage scenarios. The most common one is when all default |
41e2b43e RD |
10299 | attributes are used and in this case, nothing should be inherited as |
10300 | in modern GUIs different controls use different fonts (and colours) | |
10301 | than their siblings so they can't inherit the same value from the | |
10302 | parent. However it was also deemed desirable to allow to simply change | |
10303 | the attributes of all children at once by just changing the font or | |
10304 | colour of their common parent, hence in this case we do inherit the | |
10305 | parents attributes. | |
10306 | ||
a95a7133 | 10307 | """ |
54f9ee45 | 10308 | return _core_.Window_InheritAttributes(*args, **kwargs) |
a95a7133 RD |
10309 | |
10310 | def ShouldInheritColours(*args, **kwargs): | |
10311 | """ | |
10312 | ShouldInheritColours(self) -> bool | |
10313 | ||
10314 | Return true from here to allow the colours of this window to be | |
41e2b43e RD |
10315 | changed by InheritAttributes, returning false forbids inheriting them |
10316 | from the parent window. | |
a95a7133 | 10317 | |
41e2b43e RD |
10318 | The base class version returns false, but this method is overridden in |
10319 | wxControl where it returns true. | |
a95a7133 | 10320 | """ |
54f9ee45 | 10321 | return _core_.Window_ShouldInheritColours(*args, **kwargs) |
a95a7133 | 10322 | |
fc46b7f3 RD |
10323 | def CanSetTransparent(*args, **kwargs): |
10324 | """ | |
10325 | CanSetTransparent(self) -> bool | |
10326 | ||
10327 | Returns ``True`` if the platform supports setting the transparency for | |
10328 | this window. Note that this method will err on the side of caution, | |
10329 | so it is possible that this will return ``False`` when it is in fact | |
10330 | possible to set the transparency. | |
10331 | ||
10332 | NOTE: On X-windows systems the X server must have the composite | |
10333 | extension loaded, and there must be a composite manager program (such | |
10334 | as xcompmgr) running. | |
10335 | """ | |
10336 | return _core_.Window_CanSetTransparent(*args, **kwargs) | |
10337 | ||
10338 | def SetTransparent(*args, **kwargs): | |
10339 | """ | |
10340 | SetTransparent(self, byte alpha) -> bool | |
10341 | ||
10342 | Attempt to set the transparency of this window to the ``alpha`` value, | |
10343 | returns True on success. The ``alpha`` value is an integer in the | |
10344 | range of 0 to 255, where 0 is fully transparent and 255 is fully | |
10345 | opaque. | |
10346 | """ | |
10347 | return _core_.Window_SetTransparent(*args, **kwargs) | |
10348 | ||
e811c8ce | 10349 | def PostCreate(self, pre): |
15afbcd0 RD |
10350 | """ |
10351 | Phase 3 of the 2-phase create <wink!> | |
10352 | Call this method after precreating the window with the 2-phase create method. | |
10353 | """ | |
e811c8ce RD |
10354 | self.this = pre.this |
10355 | self.thisown = pre.thisown | |
10356 | pre.thisown = 0 | |
10357 | if hasattr(self, '_setOORInfo'): | |
10358 | self._setOORInfo(self) | |
10359 | if hasattr(self, '_setCallbackInfo'): | |
c25f90f6 | 10360 | self._setCallbackInfo(self, pre.__class__) |
e811c8ce | 10361 | |
7e08d4ef | 10362 | def SendSizeEvent(self): |
453fb36b | 10363 | self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1))) |
7e08d4ef | 10364 | |
2bf58437 | 10365 | AcceleratorTable = property(GetAcceleratorTable,SetAcceleratorTable,doc="See `GetAcceleratorTable` and `SetAcceleratorTable`") |
2bf58437 RD |
10366 | AutoLayout = property(GetAutoLayout,SetAutoLayout,doc="See `GetAutoLayout` and `SetAutoLayout`") |
10367 | BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") | |
10368 | BackgroundStyle = property(GetBackgroundStyle,SetBackgroundStyle,doc="See `GetBackgroundStyle` and `SetBackgroundStyle`") | |
580080c5 | 10369 | EffectiveMinSize = property(GetEffectiveMinSize,doc="See `GetEffectiveMinSize`") |
2bf58437 RD |
10370 | BestSize = property(GetBestSize,doc="See `GetBestSize`") |
10371 | BestVirtualSize = property(GetBestVirtualSize,doc="See `GetBestVirtualSize`") | |
10372 | Border = property(GetBorder,doc="See `GetBorder`") | |
10373 | Caret = property(GetCaret,SetCaret,doc="See `GetCaret` and `SetCaret`") | |
10374 | CharHeight = property(GetCharHeight,doc="See `GetCharHeight`") | |
10375 | CharWidth = property(GetCharWidth,doc="See `GetCharWidth`") | |
10376 | Children = property(GetChildren,doc="See `GetChildren`") | |
10377 | ClientAreaOrigin = property(GetClientAreaOrigin,doc="See `GetClientAreaOrigin`") | |
10378 | ClientRect = property(GetClientRect,SetClientRect,doc="See `GetClientRect` and `SetClientRect`") | |
10379 | ClientSize = property(GetClientSize,SetClientSize,doc="See `GetClientSize` and `SetClientSize`") | |
10380 | Constraints = property(GetConstraints,SetConstraints,doc="See `GetConstraints` and `SetConstraints`") | |
10381 | ContainingSizer = property(GetContainingSizer,SetContainingSizer,doc="See `GetContainingSizer` and `SetContainingSizer`") | |
10382 | Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`") | |
10383 | DefaultAttributes = property(GetDefaultAttributes,doc="See `GetDefaultAttributes`") | |
10384 | DropTarget = property(GetDropTarget,SetDropTarget,doc="See `GetDropTarget` and `SetDropTarget`") | |
10385 | EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`") | |
10386 | ExtraStyle = property(GetExtraStyle,SetExtraStyle,doc="See `GetExtraStyle` and `SetExtraStyle`") | |
10387 | Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") | |
10388 | ForegroundColour = property(GetForegroundColour,SetForegroundColour,doc="See `GetForegroundColour` and `SetForegroundColour`") | |
2bf58437 RD |
10389 | GrandParent = property(GetGrandParent,doc="See `GetGrandParent`") |
10390 | Handle = property(GetHandle,doc="See `GetHandle`") | |
10391 | HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`") | |
2bf58437 RD |
10392 | Id = property(GetId,SetId,doc="See `GetId` and `SetId`") |
10393 | Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`") | |
994453b8 | 10394 | LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`") |
2bf58437 RD |
10395 | MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`") |
10396 | MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`") | |
10397 | MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`") | |
10398 | MinHeight = property(GetMinHeight,doc="See `GetMinHeight`") | |
10399 | MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`") | |
10400 | MinWidth = property(GetMinWidth,doc="See `GetMinWidth`") | |
10401 | Name = property(GetName,SetName,doc="See `GetName` and `SetName`") | |
10402 | Parent = property(GetParent,doc="See `GetParent`") | |
10403 | Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") | |
10404 | Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`") | |
10405 | ScreenPosition = property(GetScreenPosition,doc="See `GetScreenPosition`") | |
10406 | ScreenRect = property(GetScreenRect,doc="See `GetScreenRect`") | |
2bf58437 RD |
10407 | Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") |
10408 | Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`") | |
2bf58437 RD |
10409 | ThemeEnabled = property(GetThemeEnabled,SetThemeEnabled,doc="See `GetThemeEnabled` and `SetThemeEnabled`") |
10410 | ToolTip = property(GetToolTip,SetToolTip,doc="See `GetToolTip` and `SetToolTip`") | |
10411 | UpdateClientRect = property(GetUpdateClientRect,doc="See `GetUpdateClientRect`") | |
10412 | UpdateRegion = property(GetUpdateRegion,doc="See `GetUpdateRegion`") | |
10413 | Validator = property(GetValidator,SetValidator,doc="See `GetValidator` and `SetValidator`") | |
10414 | VirtualSize = property(GetVirtualSize,SetVirtualSize,doc="See `GetVirtualSize` and `SetVirtualSize`") | |
10415 | WindowStyle = property(GetWindowStyle,SetWindowStyle,doc="See `GetWindowStyle` and `SetWindowStyle`") | |
10416 | WindowStyleFlag = property(GetWindowStyleFlag,SetWindowStyleFlag,doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`") | |
10417 | WindowVariant = property(GetWindowVariant,SetWindowVariant,doc="See `GetWindowVariant` and `SetWindowVariant`") | |
97ab0f6a RD |
10418 | Shown = property(IsShown,Show,doc="See `IsShown` and `Show`") |
10419 | Enabled = property(IsEnabled,Enable,doc="See `IsEnabled` and `Enable`") | |
10420 | TopLevel = property(IsTopLevel,doc="See `IsTopLevel`") | |
2131d850 | 10421 | _core_.Window_swigregister(Window) |
e811c8ce RD |
10422 | |
10423 | def PreWindow(*args, **kwargs): | |
15afbcd0 RD |
10424 | """ |
10425 | PreWindow() -> Window | |
10426 | ||
10427 | Precreate a Window for 2-phase creation. | |
10428 | """ | |
54f9ee45 | 10429 | val = _core_.new_PreWindow(*args, **kwargs) |
e811c8ce RD |
10430 | return val |
10431 | ||
0085ce49 RD |
10432 | def Window_NewControlId(*args): |
10433 | """ | |
15afbcd0 RD |
10434 | Window_NewControlId() -> int |
10435 | ||
10436 | Generate a control id for the controls which were not given one. | |
10437 | """ | |
0085ce49 | 10438 | return _core_.Window_NewControlId(*args) |
e811c8ce RD |
10439 | |
10440 | def Window_NextControlId(*args, **kwargs): | |
0085ce49 | 10441 | """ |
15afbcd0 RD |
10442 | Window_NextControlId(int winid) -> int |
10443 | ||
10444 | Get the id of the control following the one with the given | |
41e2b43e | 10445 | autogenerated) id |
15afbcd0 | 10446 | """ |
0085ce49 | 10447 | return _core_.Window_NextControlId(*args, **kwargs) |
e811c8ce RD |
10448 | |
10449 | def Window_PrevControlId(*args, **kwargs): | |
0085ce49 | 10450 | """ |
15afbcd0 RD |
10451 | Window_PrevControlId(int winid) -> int |
10452 | ||
10453 | Get the id of the control preceding the one with the given | |
41e2b43e | 10454 | autogenerated) id |
15afbcd0 | 10455 | """ |
0085ce49 | 10456 | return _core_.Window_PrevControlId(*args, **kwargs) |
e811c8ce | 10457 | |
0085ce49 RD |
10458 | def Window_FindFocus(*args): |
10459 | """ | |
15afbcd0 RD |
10460 | Window_FindFocus() -> Window |
10461 | ||
10462 | Returns the window or control that currently has the keyboard focus, | |
10463 | or None. | |
10464 | """ | |
0085ce49 | 10465 | return _core_.Window_FindFocus(*args) |
e811c8ce | 10466 | |
0085ce49 RD |
10467 | def Window_GetCapture(*args): |
10468 | """ | |
15afbcd0 RD |
10469 | Window_GetCapture() -> Window |
10470 | ||
10471 | Returns the window which currently captures the mouse or None | |
10472 | """ | |
0085ce49 | 10473 | return _core_.Window_GetCapture(*args) |
e811c8ce | 10474 | |
74a57fcd | 10475 | def Window_GetClassDefaultAttributes(*args, **kwargs): |
0085ce49 | 10476 | """ |
74a57fcd RD |
10477 | Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
10478 | ||
41e2b43e RD |
10479 | Get the default attributes for this class. This is useful if you want |
10480 | to use the same font or colour in your own control as in a standard | |
10481 | control -- which is a much better idea than hard coding specific | |
db3e571a RD |
10482 | colours or fonts which might look completely out of place on the |
10483 | user's system, especially if it uses themes. | |
74a57fcd RD |
10484 | |
10485 | The variant parameter is only relevant under Mac currently and is | |
41e2b43e | 10486 | ignore under other platforms. Under Mac, it will change the size of |
db3e571a RD |
10487 | the returned font. See `wx.Window.SetWindowVariant` for more about |
10488 | this. | |
74a57fcd | 10489 | """ |
0085ce49 | 10490 | return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd | 10491 | |
e811c8ce | 10492 | def DLG_PNT(win, point_or_x, y=None): |
15afbcd0 RD |
10493 | """ |
10494 | Convenience function for converting a Point or (x,y) in | |
10495 | dialog units to pixel units. | |
10496 | """ | |
e811c8ce RD |
10497 | if y is None: |
10498 | return win.ConvertDialogPointToPixels(point_or_x) | |
10499 | else: | |
fd3f2efe | 10500 | return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) |
e811c8ce RD |
10501 | |
10502 | def DLG_SZE(win, size_width, height=None): | |
15afbcd0 RD |
10503 | """ |
10504 | Convenience function for converting a Size or (w,h) in | |
10505 | dialog units to pixel units. | |
10506 | """ | |
e811c8ce RD |
10507 | if height is None: |
10508 | return win.ConvertDialogSizeToPixels(size_width) | |
10509 | else: | |
fd3f2efe | 10510 | return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) |
e811c8ce RD |
10511 | |
10512 | ||
10513 | def FindWindowById(*args, **kwargs): | |
0085ce49 | 10514 | """ |
15afbcd0 RD |
10515 | FindWindowById(long id, Window parent=None) -> Window |
10516 | ||
10517 | Find the first window in the application with the given id. If parent | |
10518 | is None, the search will start from all top-level frames and dialog | |
10519 | boxes; if non-None, the search will be limited to the given window | |
10520 | hierarchy. The search is recursive in both cases. | |
10521 | """ | |
0085ce49 | 10522 | return _core_.FindWindowById(*args, **kwargs) |
e811c8ce RD |
10523 | |
10524 | def FindWindowByName(*args, **kwargs): | |
0085ce49 | 10525 | """ |
15afbcd0 RD |
10526 | FindWindowByName(String name, Window parent=None) -> Window |
10527 | ||
10528 | Find a window by its name (as given in a window constructor or Create | |
10529 | function call). If parent is None, the search will start from all | |
10530 | top-level frames and dialog boxes; if non-None, the search will be | |
10531 | limited to the given window hierarchy. The search is recursive in both | |
10532 | cases. | |
10533 | ||
10534 | If no window with such name is found, wx.FindWindowByLabel is called. | |
10535 | """ | |
0085ce49 | 10536 | return _core_.FindWindowByName(*args, **kwargs) |
e811c8ce RD |
10537 | |
10538 | def FindWindowByLabel(*args, **kwargs): | |
0085ce49 | 10539 | """ |
15afbcd0 RD |
10540 | FindWindowByLabel(String label, Window parent=None) -> Window |
10541 | ||
10542 | Find a window by its label. Depending on the type of window, the label | |
10543 | may be a window title or panel item label. If parent is None, the | |
10544 | search will start from all top-level frames and dialog boxes; if | |
10545 | non-None, the search will be limited to the given window | |
10546 | hierarchy. The search is recursive in both cases. | |
10547 | """ | |
0085ce49 | 10548 | return _core_.FindWindowByLabel(*args, **kwargs) |
e811c8ce RD |
10549 | |
10550 | def Window_FromHWND(*args, **kwargs): | |
0085ce49 RD |
10551 | """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window""" |
10552 | return _core_.Window_FromHWND(*args, **kwargs) | |
b6b0383e | 10553 | |
0085ce49 RD |
10554 | def GetTopLevelWindows(*args): |
10555 | """ | |
b6b0383e RD |
10556 | GetTopLevelWindows() -> PyObject |
10557 | ||
10558 | Returns a list of the the application's top-level windows, (frames, | |
10559 | dialogs, etc.) NOTE: Currently this is a copy of the list maintained | |
10560 | by wxWidgets, and so it is only valid as long as no top-level windows | |
10561 | are closed or new top-level windows are created. | |
10562 | ||
10563 | """ | |
0085ce49 | 10564 | return _core_.GetTopLevelWindows(*args) |
e811c8ce RD |
10565 | #--------------------------------------------------------------------------- |
10566 | ||
10567 | class Validator(EvtHandler): | |
093d3ff1 | 10568 | """Proxy of C++ Validator class""" |
0085ce49 RD |
10569 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10570 | __repr__ = _swig_repr | |
10571 | def __init__(self, *args, **kwargs): | |
a95a7133 | 10572 | """__init__(self) -> Validator""" |
0085ce49 | 10573 | _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs)) |
d14a1e28 | 10574 | self._setOORInfo(self) |
e811c8ce RD |
10575 | |
10576 | def Clone(*args, **kwargs): | |
a95a7133 | 10577 | """Clone(self) -> Validator""" |
54f9ee45 | 10578 | return _core_.Validator_Clone(*args, **kwargs) |
e811c8ce RD |
10579 | |
10580 | def Validate(*args, **kwargs): | |
a95a7133 | 10581 | """Validate(self, Window parent) -> bool""" |
54f9ee45 | 10582 | return _core_.Validator_Validate(*args, **kwargs) |
e811c8ce RD |
10583 | |
10584 | def TransferToWindow(*args, **kwargs): | |
a95a7133 | 10585 | """TransferToWindow(self) -> bool""" |
54f9ee45 | 10586 | return _core_.Validator_TransferToWindow(*args, **kwargs) |
e811c8ce RD |
10587 | |
10588 | def TransferFromWindow(*args, **kwargs): | |
a95a7133 | 10589 | """TransferFromWindow(self) -> bool""" |
54f9ee45 | 10590 | return _core_.Validator_TransferFromWindow(*args, **kwargs) |
e811c8ce RD |
10591 | |
10592 | def GetWindow(*args, **kwargs): | |
a95a7133 | 10593 | """GetWindow(self) -> Window""" |
54f9ee45 | 10594 | return _core_.Validator_GetWindow(*args, **kwargs) |
e811c8ce RD |
10595 | |
10596 | def SetWindow(*args, **kwargs): | |
a95a7133 | 10597 | """SetWindow(self, Window window)""" |
54f9ee45 | 10598 | return _core_.Validator_SetWindow(*args, **kwargs) |
e811c8ce RD |
10599 | |
10600 | def IsSilent(*args, **kwargs): | |
66c033b4 | 10601 | """IsSilent() -> bool""" |
54f9ee45 | 10602 | return _core_.Validator_IsSilent(*args, **kwargs) |
e811c8ce RD |
10603 | |
10604 | IsSilent = staticmethod(IsSilent) | |
10605 | def SetBellOnError(*args, **kwargs): | |
66c033b4 | 10606 | """SetBellOnError(int doIt=True)""" |
54f9ee45 | 10607 | return _core_.Validator_SetBellOnError(*args, **kwargs) |
e811c8ce RD |
10608 | |
10609 | SetBellOnError = staticmethod(SetBellOnError) | |
dba7934c | 10610 | Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`") |
2131d850 | 10611 | _core_.Validator_swigregister(Validator) |
e811c8ce | 10612 | |
0085ce49 RD |
10613 | def Validator_IsSilent(*args): |
10614 | """Validator_IsSilent() -> bool""" | |
10615 | return _core_.Validator_IsSilent(*args) | |
e811c8ce RD |
10616 | |
10617 | def Validator_SetBellOnError(*args, **kwargs): | |
0085ce49 RD |
10618 | """Validator_SetBellOnError(int doIt=True)""" |
10619 | return _core_.Validator_SetBellOnError(*args, **kwargs) | |
e811c8ce RD |
10620 | |
10621 | class PyValidator(Validator): | |
093d3ff1 | 10622 | """Proxy of C++ PyValidator class""" |
0085ce49 RD |
10623 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10624 | __repr__ = _swig_repr | |
10625 | def __init__(self, *args, **kwargs): | |
a95a7133 | 10626 | """__init__(self) -> PyValidator""" |
0085ce49 | 10627 | _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs)) |
c25f90f6 | 10628 | self._setOORInfo(self);PyValidator._setCallbackInfo(self, self, PyValidator) |
e811c8ce RD |
10629 | |
10630 | def _setCallbackInfo(*args, **kwargs): | |
c25f90f6 | 10631 | """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)""" |
54f9ee45 | 10632 | return _core_.PyValidator__setCallbackInfo(*args, **kwargs) |
e811c8ce | 10633 | |
2131d850 | 10634 | _core_.PyValidator_swigregister(PyValidator) |
e811c8ce RD |
10635 | |
10636 | #--------------------------------------------------------------------------- | |
10637 | ||
10638 | class Menu(EvtHandler): | |
093d3ff1 | 10639 | """Proxy of C++ Menu class""" |
0085ce49 RD |
10640 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10641 | __repr__ = _swig_repr | |
10642 | def __init__(self, *args, **kwargs): | |
a95a7133 | 10643 | """__init__(self, String title=EmptyString, long style=0) -> Menu""" |
0085ce49 | 10644 | _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs)) |
e811c8ce RD |
10645 | self._setOORInfo(self) |
10646 | ||
10647 | def Append(*args, **kwargs): | |
97ab0f6a RD |
10648 | """ |
10649 | Append(self, int id, String text=EmptyString, String help=EmptyString, | |
10650 | int kind=ITEM_NORMAL) -> MenuItem | |
10651 | """ | |
54f9ee45 | 10652 | return _core_.Menu_Append(*args, **kwargs) |
e811c8ce RD |
10653 | |
10654 | def AppendSeparator(*args, **kwargs): | |
a95a7133 | 10655 | """AppendSeparator(self) -> MenuItem""" |
54f9ee45 | 10656 | return _core_.Menu_AppendSeparator(*args, **kwargs) |
e811c8ce RD |
10657 | |
10658 | def AppendCheckItem(*args, **kwargs): | |
a95a7133 | 10659 | """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10660 | return _core_.Menu_AppendCheckItem(*args, **kwargs) |
e811c8ce RD |
10661 | |
10662 | def AppendRadioItem(*args, **kwargs): | |
a95a7133 | 10663 | """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10664 | return _core_.Menu_AppendRadioItem(*args, **kwargs) |
e811c8ce RD |
10665 | |
10666 | def AppendMenu(*args, **kwargs): | |
a95a7133 | 10667 | """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10668 | return _core_.Menu_AppendMenu(*args, **kwargs) |
e811c8ce | 10669 | |
50efceee RD |
10670 | def AppendSubMenu(*args, **kwargs): |
10671 | """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem""" | |
10672 | return _core_.Menu_AppendSubMenu(*args, **kwargs) | |
10673 | ||
e811c8ce | 10674 | def AppendItem(*args, **kwargs): |
a95a7133 | 10675 | """AppendItem(self, MenuItem item) -> MenuItem""" |
54f9ee45 | 10676 | return _core_.Menu_AppendItem(*args, **kwargs) |
e811c8ce | 10677 | |
e811c8ce | 10678 | def InsertItem(*args, **kwargs): |
a95a7133 | 10679 | """InsertItem(self, size_t pos, MenuItem item) -> MenuItem""" |
54f9ee45 | 10680 | return _core_.Menu_InsertItem(*args, **kwargs) |
e811c8ce | 10681 | |
0085ce49 RD |
10682 | def PrependItem(*args, **kwargs): |
10683 | """PrependItem(self, MenuItem item) -> MenuItem""" | |
10684 | return _core_.Menu_PrependItem(*args, **kwargs) | |
10685 | ||
10686 | def Break(*args, **kwargs): | |
10687 | """Break(self)""" | |
10688 | return _core_.Menu_Break(*args, **kwargs) | |
10689 | ||
e811c8ce | 10690 | def Insert(*args, **kwargs): |
0df68c9f | 10691 | """ |
97ab0f6a | 10692 | Insert(self, size_t pos, int id, String text=EmptyString, String help=EmptyString, |
a41e16b6 | 10693 | int kind=ITEM_NORMAL) -> MenuItem |
0df68c9f | 10694 | """ |
54f9ee45 | 10695 | return _core_.Menu_Insert(*args, **kwargs) |
e811c8ce RD |
10696 | |
10697 | def InsertSeparator(*args, **kwargs): | |
a95a7133 | 10698 | """InsertSeparator(self, size_t pos) -> MenuItem""" |
54f9ee45 | 10699 | return _core_.Menu_InsertSeparator(*args, **kwargs) |
e811c8ce RD |
10700 | |
10701 | def InsertCheckItem(*args, **kwargs): | |
a95a7133 | 10702 | """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10703 | return _core_.Menu_InsertCheckItem(*args, **kwargs) |
e811c8ce RD |
10704 | |
10705 | def InsertRadioItem(*args, **kwargs): | |
a95a7133 | 10706 | """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10707 | return _core_.Menu_InsertRadioItem(*args, **kwargs) |
e811c8ce RD |
10708 | |
10709 | def InsertMenu(*args, **kwargs): | |
a95a7133 | 10710 | """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10711 | return _core_.Menu_InsertMenu(*args, **kwargs) |
e811c8ce | 10712 | |
e811c8ce | 10713 | def Prepend(*args, **kwargs): |
97ab0f6a RD |
10714 | """ |
10715 | Prepend(self, int id, String text=EmptyString, String help=EmptyString, | |
10716 | int kind=ITEM_NORMAL) -> MenuItem | |
10717 | """ | |
54f9ee45 | 10718 | return _core_.Menu_Prepend(*args, **kwargs) |
e811c8ce RD |
10719 | |
10720 | def PrependSeparator(*args, **kwargs): | |
a95a7133 | 10721 | """PrependSeparator(self) -> MenuItem""" |
54f9ee45 | 10722 | return _core_.Menu_PrependSeparator(*args, **kwargs) |
e811c8ce RD |
10723 | |
10724 | def PrependCheckItem(*args, **kwargs): | |
a95a7133 | 10725 | """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10726 | return _core_.Menu_PrependCheckItem(*args, **kwargs) |
e811c8ce RD |
10727 | |
10728 | def PrependRadioItem(*args, **kwargs): | |
a95a7133 | 10729 | """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10730 | return _core_.Menu_PrependRadioItem(*args, **kwargs) |
e811c8ce RD |
10731 | |
10732 | def PrependMenu(*args, **kwargs): | |
a95a7133 | 10733 | """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 10734 | return _core_.Menu_PrependMenu(*args, **kwargs) |
e811c8ce RD |
10735 | |
10736 | def Remove(*args, **kwargs): | |
a95a7133 | 10737 | """Remove(self, int id) -> MenuItem""" |
54f9ee45 | 10738 | return _core_.Menu_Remove(*args, **kwargs) |
e811c8ce | 10739 | |
59ccbf7f | 10740 | def RemoveItem(self, item): |
a95a7133 | 10741 | """RemoveItem(self, MenuItem item) -> MenuItem""" |
59ccbf7f RD |
10742 | #// The return object is always the parameter, so return that |
10743 | #// proxy instead of the new one | |
10744 | val = _core_.Menu_RemoveItem(self, item) | |
10745 | item.this.own(val.this.own()) | |
10746 | val.this.disown() | |
10747 | return item | |
10748 | ||
e811c8ce RD |
10749 | |
10750 | def Delete(*args, **kwargs): | |
a95a7133 | 10751 | """Delete(self, int id) -> bool""" |
54f9ee45 | 10752 | return _core_.Menu_Delete(*args, **kwargs) |
e811c8ce RD |
10753 | |
10754 | def DeleteItem(*args, **kwargs): | |
a95a7133 | 10755 | """DeleteItem(self, MenuItem item) -> bool""" |
54f9ee45 | 10756 | return _core_.Menu_DeleteItem(*args, **kwargs) |
e811c8ce RD |
10757 | |
10758 | def Destroy(*args, **kwargs): | |
0df68c9f | 10759 | """ |
a95a7133 | 10760 | Destroy(self) |
e811c8ce | 10761 | |
0df68c9f RD |
10762 | Deletes the C++ object this Python object is a proxy for. |
10763 | """ | |
b39fe951 RD |
10764 | args[0].this.own(False) |
10765 | return _core_.Menu_Destroy(*args, **kwargs) | |
e811c8ce RD |
10766 | |
10767 | def DestroyId(*args, **kwargs): | |
b39fe951 RD |
10768 | """DestroyId(self, int id) -> bool""" |
10769 | return _core_.Menu_DestroyId(*args, **kwargs) | |
e811c8ce RD |
10770 | |
10771 | def DestroyItem(*args, **kwargs): | |
b39fe951 RD |
10772 | """DestroyItem(self, MenuItem item) -> bool""" |
10773 | return _core_.Menu_DestroyItem(*args, **kwargs) | |
e811c8ce RD |
10774 | |
10775 | def GetMenuItemCount(*args, **kwargs): | |
a95a7133 | 10776 | """GetMenuItemCount(self) -> size_t""" |
54f9ee45 | 10777 | return _core_.Menu_GetMenuItemCount(*args, **kwargs) |
e811c8ce RD |
10778 | |
10779 | def GetMenuItems(*args, **kwargs): | |
a95a7133 | 10780 | """GetMenuItems(self) -> PyObject""" |
54f9ee45 | 10781 | return _core_.Menu_GetMenuItems(*args, **kwargs) |
e811c8ce RD |
10782 | |
10783 | def FindItem(*args, **kwargs): | |
a95a7133 | 10784 | """FindItem(self, String item) -> int""" |
54f9ee45 | 10785 | return _core_.Menu_FindItem(*args, **kwargs) |
e811c8ce RD |
10786 | |
10787 | def FindItemById(*args, **kwargs): | |
a95a7133 | 10788 | """FindItemById(self, int id) -> MenuItem""" |
54f9ee45 | 10789 | return _core_.Menu_FindItemById(*args, **kwargs) |
e811c8ce RD |
10790 | |
10791 | def FindItemByPosition(*args, **kwargs): | |
a95a7133 | 10792 | """FindItemByPosition(self, size_t position) -> MenuItem""" |
54f9ee45 | 10793 | return _core_.Menu_FindItemByPosition(*args, **kwargs) |
e811c8ce RD |
10794 | |
10795 | def Enable(*args, **kwargs): | |
a95a7133 | 10796 | """Enable(self, int id, bool enable)""" |
54f9ee45 | 10797 | return _core_.Menu_Enable(*args, **kwargs) |
e811c8ce RD |
10798 | |
10799 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 10800 | """IsEnabled(self, int id) -> bool""" |
54f9ee45 | 10801 | return _core_.Menu_IsEnabled(*args, **kwargs) |
e811c8ce RD |
10802 | |
10803 | def Check(*args, **kwargs): | |
a95a7133 | 10804 | """Check(self, int id, bool check)""" |
54f9ee45 | 10805 | return _core_.Menu_Check(*args, **kwargs) |
e811c8ce RD |
10806 | |
10807 | def IsChecked(*args, **kwargs): | |
a95a7133 | 10808 | """IsChecked(self, int id) -> bool""" |
54f9ee45 | 10809 | return _core_.Menu_IsChecked(*args, **kwargs) |
e811c8ce RD |
10810 | |
10811 | def SetLabel(*args, **kwargs): | |
a95a7133 | 10812 | """SetLabel(self, int id, String label)""" |
54f9ee45 | 10813 | return _core_.Menu_SetLabel(*args, **kwargs) |
e811c8ce RD |
10814 | |
10815 | def GetLabel(*args, **kwargs): | |
a95a7133 | 10816 | """GetLabel(self, int id) -> String""" |
54f9ee45 | 10817 | return _core_.Menu_GetLabel(*args, **kwargs) |
e811c8ce RD |
10818 | |
10819 | def SetHelpString(*args, **kwargs): | |
a95a7133 | 10820 | """SetHelpString(self, int id, String helpString)""" |
54f9ee45 | 10821 | return _core_.Menu_SetHelpString(*args, **kwargs) |
e811c8ce RD |
10822 | |
10823 | def GetHelpString(*args, **kwargs): | |
a95a7133 | 10824 | """GetHelpString(self, int id) -> String""" |
54f9ee45 | 10825 | return _core_.Menu_GetHelpString(*args, **kwargs) |
e811c8ce RD |
10826 | |
10827 | def SetTitle(*args, **kwargs): | |
a95a7133 | 10828 | """SetTitle(self, String title)""" |
54f9ee45 | 10829 | return _core_.Menu_SetTitle(*args, **kwargs) |
e811c8ce RD |
10830 | |
10831 | def GetTitle(*args, **kwargs): | |
a95a7133 | 10832 | """GetTitle(self) -> String""" |
54f9ee45 | 10833 | return _core_.Menu_GetTitle(*args, **kwargs) |
e811c8ce RD |
10834 | |
10835 | def SetEventHandler(*args, **kwargs): | |
a95a7133 | 10836 | """SetEventHandler(self, EvtHandler handler)""" |
54f9ee45 | 10837 | return _core_.Menu_SetEventHandler(*args, **kwargs) |
e811c8ce RD |
10838 | |
10839 | def GetEventHandler(*args, **kwargs): | |
a95a7133 | 10840 | """GetEventHandler(self) -> EvtHandler""" |
54f9ee45 | 10841 | return _core_.Menu_GetEventHandler(*args, **kwargs) |
e811c8ce RD |
10842 | |
10843 | def SetInvokingWindow(*args, **kwargs): | |
a95a7133 | 10844 | """SetInvokingWindow(self, Window win)""" |
54f9ee45 | 10845 | return _core_.Menu_SetInvokingWindow(*args, **kwargs) |
e811c8ce RD |
10846 | |
10847 | def GetInvokingWindow(*args, **kwargs): | |
a95a7133 | 10848 | """GetInvokingWindow(self) -> Window""" |
54f9ee45 | 10849 | return _core_.Menu_GetInvokingWindow(*args, **kwargs) |
e811c8ce RD |
10850 | |
10851 | def GetStyle(*args, **kwargs): | |
a95a7133 | 10852 | """GetStyle(self) -> long""" |
54f9ee45 | 10853 | return _core_.Menu_GetStyle(*args, **kwargs) |
e811c8ce RD |
10854 | |
10855 | def UpdateUI(*args, **kwargs): | |
a95a7133 | 10856 | """UpdateUI(self, EvtHandler source=None)""" |
54f9ee45 | 10857 | return _core_.Menu_UpdateUI(*args, **kwargs) |
e811c8ce RD |
10858 | |
10859 | def GetMenuBar(*args, **kwargs): | |
a95a7133 | 10860 | """GetMenuBar(self) -> MenuBar""" |
54f9ee45 | 10861 | return _core_.Menu_GetMenuBar(*args, **kwargs) |
e811c8ce RD |
10862 | |
10863 | def Attach(*args, **kwargs): | |
a95a7133 | 10864 | """Attach(self, wxMenuBarBase menubar)""" |
54f9ee45 | 10865 | return _core_.Menu_Attach(*args, **kwargs) |
e811c8ce RD |
10866 | |
10867 | def Detach(*args, **kwargs): | |
a95a7133 | 10868 | """Detach(self)""" |
54f9ee45 | 10869 | return _core_.Menu_Detach(*args, **kwargs) |
e811c8ce RD |
10870 | |
10871 | def IsAttached(*args, **kwargs): | |
a95a7133 | 10872 | """IsAttached(self) -> bool""" |
54f9ee45 | 10873 | return _core_.Menu_IsAttached(*args, **kwargs) |
e811c8ce RD |
10874 | |
10875 | def SetParent(*args, **kwargs): | |
a95a7133 | 10876 | """SetParent(self, Menu parent)""" |
54f9ee45 | 10877 | return _core_.Menu_SetParent(*args, **kwargs) |
e811c8ce RD |
10878 | |
10879 | def GetParent(*args, **kwargs): | |
a95a7133 | 10880 | """GetParent(self) -> Menu""" |
54f9ee45 | 10881 | return _core_.Menu_GetParent(*args, **kwargs) |
e811c8ce | 10882 | |
57332a5a RD |
10883 | EventHandler = property(GetEventHandler,SetEventHandler,doc="See `GetEventHandler` and `SetEventHandler`") |
10884 | HelpString = property(GetHelpString,SetHelpString,doc="See `GetHelpString` and `SetHelpString`") | |
10885 | InvokingWindow = property(GetInvokingWindow,SetInvokingWindow,doc="See `GetInvokingWindow` and `SetInvokingWindow`") | |
10886 | MenuBar = property(GetMenuBar,doc="See `GetMenuBar`") | |
10887 | MenuItemCount = property(GetMenuItemCount,doc="See `GetMenuItemCount`") | |
10888 | MenuItems = property(GetMenuItems,doc="See `GetMenuItems`") | |
10889 | Parent = property(GetParent,SetParent,doc="See `GetParent` and `SetParent`") | |
10890 | Style = property(GetStyle,doc="See `GetStyle`") | |
10891 | Title = property(GetTitle,SetTitle,doc="See `GetTitle` and `SetTitle`") | |
2131d850 | 10892 | _core_.Menu_swigregister(Menu) |
d14a1e28 RD |
10893 | DefaultValidator = cvar.DefaultValidator |
10894 | ||
10895 | #--------------------------------------------------------------------------- | |
10896 | ||
10897 | class MenuBar(Window): | |
093d3ff1 | 10898 | """Proxy of C++ MenuBar class""" |
0085ce49 RD |
10899 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10900 | __repr__ = _swig_repr | |
10901 | def __init__(self, *args, **kwargs): | |
a95a7133 | 10902 | """__init__(self, long style=0) -> MenuBar""" |
0085ce49 | 10903 | _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs)) |
d14a1e28 | 10904 | self._setOORInfo(self) |
e811c8ce RD |
10905 | |
10906 | def Append(*args, **kwargs): | |
a95a7133 | 10907 | """Append(self, Menu menu, String title) -> bool""" |
54f9ee45 | 10908 | return _core_.MenuBar_Append(*args, **kwargs) |
e811c8ce RD |
10909 | |
10910 | def Insert(*args, **kwargs): | |
a95a7133 | 10911 | """Insert(self, size_t pos, Menu menu, String title) -> bool""" |
54f9ee45 | 10912 | return _core_.MenuBar_Insert(*args, **kwargs) |
e811c8ce RD |
10913 | |
10914 | def GetMenuCount(*args, **kwargs): | |
a95a7133 | 10915 | """GetMenuCount(self) -> size_t""" |
54f9ee45 | 10916 | return _core_.MenuBar_GetMenuCount(*args, **kwargs) |
e811c8ce RD |
10917 | |
10918 | def GetMenu(*args, **kwargs): | |
a95a7133 | 10919 | """GetMenu(self, size_t pos) -> Menu""" |
54f9ee45 | 10920 | return _core_.MenuBar_GetMenu(*args, **kwargs) |
e811c8ce RD |
10921 | |
10922 | def Replace(*args, **kwargs): | |
a95a7133 | 10923 | """Replace(self, size_t pos, Menu menu, String title) -> Menu""" |
54f9ee45 | 10924 | return _core_.MenuBar_Replace(*args, **kwargs) |
e811c8ce RD |
10925 | |
10926 | def Remove(*args, **kwargs): | |
a95a7133 | 10927 | """Remove(self, size_t pos) -> Menu""" |
54f9ee45 | 10928 | return _core_.MenuBar_Remove(*args, **kwargs) |
e811c8ce RD |
10929 | |
10930 | def EnableTop(*args, **kwargs): | |
a95a7133 | 10931 | """EnableTop(self, size_t pos, bool enable)""" |
54f9ee45 | 10932 | return _core_.MenuBar_EnableTop(*args, **kwargs) |
e811c8ce RD |
10933 | |
10934 | def IsEnabledTop(*args, **kwargs): | |
a95a7133 | 10935 | """IsEnabledTop(self, size_t pos) -> bool""" |
54f9ee45 | 10936 | return _core_.MenuBar_IsEnabledTop(*args, **kwargs) |
e811c8ce RD |
10937 | |
10938 | def SetLabelTop(*args, **kwargs): | |
a95a7133 | 10939 | """SetLabelTop(self, size_t pos, String label)""" |
54f9ee45 | 10940 | return _core_.MenuBar_SetLabelTop(*args, **kwargs) |
e811c8ce RD |
10941 | |
10942 | def GetLabelTop(*args, **kwargs): | |
a95a7133 | 10943 | """GetLabelTop(self, size_t pos) -> String""" |
54f9ee45 | 10944 | return _core_.MenuBar_GetLabelTop(*args, **kwargs) |
e811c8ce RD |
10945 | |
10946 | def FindMenuItem(*args, **kwargs): | |
a95a7133 | 10947 | """FindMenuItem(self, String menu, String item) -> int""" |
54f9ee45 | 10948 | return _core_.MenuBar_FindMenuItem(*args, **kwargs) |
e811c8ce RD |
10949 | |
10950 | def FindItemById(*args, **kwargs): | |
a95a7133 | 10951 | """FindItemById(self, int id) -> MenuItem""" |
54f9ee45 | 10952 | return _core_.MenuBar_FindItemById(*args, **kwargs) |
e811c8ce RD |
10953 | |
10954 | def FindMenu(*args, **kwargs): | |
a95a7133 | 10955 | """FindMenu(self, String title) -> int""" |
54f9ee45 | 10956 | return _core_.MenuBar_FindMenu(*args, **kwargs) |
e811c8ce RD |
10957 | |
10958 | def Enable(*args, **kwargs): | |
a95a7133 | 10959 | """Enable(self, int id, bool enable)""" |
54f9ee45 | 10960 | return _core_.MenuBar_Enable(*args, **kwargs) |
e811c8ce RD |
10961 | |
10962 | def Check(*args, **kwargs): | |
a95a7133 | 10963 | """Check(self, int id, bool check)""" |
54f9ee45 | 10964 | return _core_.MenuBar_Check(*args, **kwargs) |
e811c8ce RD |
10965 | |
10966 | def IsChecked(*args, **kwargs): | |
a95a7133 | 10967 | """IsChecked(self, int id) -> bool""" |
54f9ee45 | 10968 | return _core_.MenuBar_IsChecked(*args, **kwargs) |
e811c8ce RD |
10969 | |
10970 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 10971 | """IsEnabled(self, int id) -> bool""" |
54f9ee45 | 10972 | return _core_.MenuBar_IsEnabled(*args, **kwargs) |
e811c8ce RD |
10973 | |
10974 | def SetLabel(*args, **kwargs): | |
a95a7133 | 10975 | """SetLabel(self, int id, String label)""" |
54f9ee45 | 10976 | return _core_.MenuBar_SetLabel(*args, **kwargs) |
e811c8ce RD |
10977 | |
10978 | def GetLabel(*args, **kwargs): | |
a95a7133 | 10979 | """GetLabel(self, int id) -> String""" |
54f9ee45 | 10980 | return _core_.MenuBar_GetLabel(*args, **kwargs) |
e811c8ce RD |
10981 | |
10982 | def SetHelpString(*args, **kwargs): | |
a95a7133 | 10983 | """SetHelpString(self, int id, String helpString)""" |
54f9ee45 | 10984 | return _core_.MenuBar_SetHelpString(*args, **kwargs) |
e811c8ce RD |
10985 | |
10986 | def GetHelpString(*args, **kwargs): | |
a95a7133 | 10987 | """GetHelpString(self, int id) -> String""" |
54f9ee45 | 10988 | return _core_.MenuBar_GetHelpString(*args, **kwargs) |
e811c8ce RD |
10989 | |
10990 | def GetFrame(*args, **kwargs): | |
a95a7133 | 10991 | """GetFrame(self) -> wxFrame""" |
54f9ee45 | 10992 | return _core_.MenuBar_GetFrame(*args, **kwargs) |
e811c8ce RD |
10993 | |
10994 | def IsAttached(*args, **kwargs): | |
a95a7133 | 10995 | """IsAttached(self) -> bool""" |
54f9ee45 | 10996 | return _core_.MenuBar_IsAttached(*args, **kwargs) |
e811c8ce RD |
10997 | |
10998 | def Attach(*args, **kwargs): | |
a95a7133 | 10999 | """Attach(self, wxFrame frame)""" |
54f9ee45 | 11000 | return _core_.MenuBar_Attach(*args, **kwargs) |
e811c8ce RD |
11001 | |
11002 | def Detach(*args, **kwargs): | |
a95a7133 | 11003 | """Detach(self)""" |
54f9ee45 | 11004 | return _core_.MenuBar_Detach(*args, **kwargs) |
e811c8ce | 11005 | |
587d0f36 RD |
11006 | def UpdateMenus(*args, **kwargs): |
11007 | """UpdateMenus(self)""" | |
11008 | return _core_.MenuBar_UpdateMenus(*args, **kwargs) | |
11009 | ||
4f433fef RD |
11010 | def SetAutoWindowMenu(*args, **kwargs): |
11011 | """SetAutoWindowMenu(bool enable)""" | |
11012 | return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs) | |
11013 | ||
11014 | SetAutoWindowMenu = staticmethod(SetAutoWindowMenu) | |
11015 | def GetAutoWindowMenu(*args, **kwargs): | |
11016 | """GetAutoWindowMenu() -> bool""" | |
11017 | return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs) | |
11018 | ||
11019 | GetAutoWindowMenu = staticmethod(GetAutoWindowMenu) | |
97ab0f6a RD |
11020 | def GetMenus(self): |
11021 | """Return a list of (menu, label) items for the menus in the MenuBar. """ | |
11022 | return [(self.GetMenu(i), self.GetLabelTop(i)) | |
11023 | for i in range(self.GetMenuCount())] | |
11024 | ||
11025 | def SetMenus(self, items): | |
11026 | """Clear and add new menus to the MenuBar from a list of (menu, label) items. """ | |
11027 | for i in range(self.GetMenuCount()-1, -1, -1): | |
11028 | self.Remove(i) | |
11029 | for m, l in items: | |
11030 | self.Append(m, l) | |
11031 | ||
57332a5a RD |
11032 | Frame = property(GetFrame,doc="See `GetFrame`") |
11033 | Menu = property(GetMenu,doc="See `GetMenu`") | |
11034 | MenuCount = property(GetMenuCount,doc="See `GetMenuCount`") | |
11035 | Menus = property(GetMenus,SetMenus,doc="See `GetMenus` and `SetMenus`") | |
2131d850 | 11036 | _core_.MenuBar_swigregister(MenuBar) |
d14a1e28 | 11037 | |
4f433fef | 11038 | def MenuBar_SetAutoWindowMenu(*args, **kwargs): |
0085ce49 RD |
11039 | """MenuBar_SetAutoWindowMenu(bool enable)""" |
11040 | return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs) | |
4f433fef | 11041 | |
0085ce49 RD |
11042 | def MenuBar_GetAutoWindowMenu(*args): |
11043 | """MenuBar_GetAutoWindowMenu() -> bool""" | |
11044 | return _core_.MenuBar_GetAutoWindowMenu(*args) | |
4f433fef | 11045 | |
d14a1e28 RD |
11046 | #--------------------------------------------------------------------------- |
11047 | ||
11048 | class MenuItem(Object): | |
093d3ff1 | 11049 | """Proxy of C++ MenuItem class""" |
0085ce49 RD |
11050 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11051 | __repr__ = _swig_repr | |
11052 | def __init__(self, *args, **kwargs): | |
0df68c9f | 11053 | """ |
89d1e2ee | 11054 | __init__(self, Menu parentMenu=None, int id=ID_SEPARATOR, String text=EmptyString, |
196addbf RD |
11055 | String help=EmptyString, int kind=ITEM_NORMAL, |
11056 | Menu subMenu=None) -> MenuItem | |
0df68c9f | 11057 | """ |
0085ce49 RD |
11058 | _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs)) |
11059 | __swig_destroy__ = _core_.delete_MenuItem | |
11060 | __del__ = lambda self : None; | |
89d1e2ee | 11061 | def Destroy(self): pass |
e811c8ce | 11062 | def GetMenu(*args, **kwargs): |
a95a7133 | 11063 | """GetMenu(self) -> Menu""" |
54f9ee45 | 11064 | return _core_.MenuItem_GetMenu(*args, **kwargs) |
e811c8ce RD |
11065 | |
11066 | def SetMenu(*args, **kwargs): | |
a95a7133 | 11067 | """SetMenu(self, Menu menu)""" |
54f9ee45 | 11068 | return _core_.MenuItem_SetMenu(*args, **kwargs) |
e811c8ce RD |
11069 | |
11070 | def SetId(*args, **kwargs): | |
a95a7133 | 11071 | """SetId(self, int id)""" |
54f9ee45 | 11072 | return _core_.MenuItem_SetId(*args, **kwargs) |
e811c8ce RD |
11073 | |
11074 | def GetId(*args, **kwargs): | |
a95a7133 | 11075 | """GetId(self) -> int""" |
54f9ee45 | 11076 | return _core_.MenuItem_GetId(*args, **kwargs) |
e811c8ce RD |
11077 | |
11078 | def IsSeparator(*args, **kwargs): | |
a95a7133 | 11079 | """IsSeparator(self) -> bool""" |
54f9ee45 | 11080 | return _core_.MenuItem_IsSeparator(*args, **kwargs) |
e811c8ce RD |
11081 | |
11082 | def SetText(*args, **kwargs): | |
a95a7133 | 11083 | """SetText(self, String str)""" |
54f9ee45 | 11084 | return _core_.MenuItem_SetText(*args, **kwargs) |
e811c8ce RD |
11085 | |
11086 | def GetLabel(*args, **kwargs): | |
a95a7133 | 11087 | """GetLabel(self) -> String""" |
54f9ee45 | 11088 | return _core_.MenuItem_GetLabel(*args, **kwargs) |
e811c8ce RD |
11089 | |
11090 | def GetText(*args, **kwargs): | |
a95a7133 | 11091 | """GetText(self) -> String""" |
54f9ee45 | 11092 | return _core_.MenuItem_GetText(*args, **kwargs) |
e811c8ce RD |
11093 | |
11094 | def GetLabelFromText(*args, **kwargs): | |
66c033b4 | 11095 | """GetLabelFromText(String text) -> String""" |
54f9ee45 | 11096 | return _core_.MenuItem_GetLabelFromText(*args, **kwargs) |
e811c8ce RD |
11097 | |
11098 | GetLabelFromText = staticmethod(GetLabelFromText) | |
11099 | def GetKind(*args, **kwargs): | |
a95a7133 | 11100 | """GetKind(self) -> int""" |
54f9ee45 | 11101 | return _core_.MenuItem_GetKind(*args, **kwargs) |
e811c8ce | 11102 | |
a95a7133 RD |
11103 | def SetKind(*args, **kwargs): |
11104 | """SetKind(self, int kind)""" | |
54f9ee45 | 11105 | return _core_.MenuItem_SetKind(*args, **kwargs) |
a95a7133 | 11106 | |
e811c8ce | 11107 | def SetCheckable(*args, **kwargs): |
a95a7133 | 11108 | """SetCheckable(self, bool checkable)""" |
54f9ee45 | 11109 | return _core_.MenuItem_SetCheckable(*args, **kwargs) |
e811c8ce RD |
11110 | |
11111 | def IsCheckable(*args, **kwargs): | |
a95a7133 | 11112 | """IsCheckable(self) -> bool""" |
54f9ee45 | 11113 | return _core_.MenuItem_IsCheckable(*args, **kwargs) |
e811c8ce RD |
11114 | |
11115 | def IsSubMenu(*args, **kwargs): | |
a95a7133 | 11116 | """IsSubMenu(self) -> bool""" |
54f9ee45 | 11117 | return _core_.MenuItem_IsSubMenu(*args, **kwargs) |
e811c8ce RD |
11118 | |
11119 | def SetSubMenu(*args, **kwargs): | |
a95a7133 | 11120 | """SetSubMenu(self, Menu menu)""" |
54f9ee45 | 11121 | return _core_.MenuItem_SetSubMenu(*args, **kwargs) |
e811c8ce RD |
11122 | |
11123 | def GetSubMenu(*args, **kwargs): | |
a95a7133 | 11124 | """GetSubMenu(self) -> Menu""" |
54f9ee45 | 11125 | return _core_.MenuItem_GetSubMenu(*args, **kwargs) |
e811c8ce RD |
11126 | |
11127 | def Enable(*args, **kwargs): | |
a95a7133 | 11128 | """Enable(self, bool enable=True)""" |
54f9ee45 | 11129 | return _core_.MenuItem_Enable(*args, **kwargs) |
e811c8ce RD |
11130 | |
11131 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 11132 | """IsEnabled(self) -> bool""" |
54f9ee45 | 11133 | return _core_.MenuItem_IsEnabled(*args, **kwargs) |
e811c8ce RD |
11134 | |
11135 | def Check(*args, **kwargs): | |
a95a7133 | 11136 | """Check(self, bool check=True)""" |
54f9ee45 | 11137 | return _core_.MenuItem_Check(*args, **kwargs) |
e811c8ce RD |
11138 | |
11139 | def IsChecked(*args, **kwargs): | |
a95a7133 | 11140 | """IsChecked(self) -> bool""" |
54f9ee45 | 11141 | return _core_.MenuItem_IsChecked(*args, **kwargs) |
e811c8ce RD |
11142 | |
11143 | def Toggle(*args, **kwargs): | |
a95a7133 | 11144 | """Toggle(self)""" |
54f9ee45 | 11145 | return _core_.MenuItem_Toggle(*args, **kwargs) |
e811c8ce RD |
11146 | |
11147 | def SetHelp(*args, **kwargs): | |
a95a7133 | 11148 | """SetHelp(self, String str)""" |
54f9ee45 | 11149 | return _core_.MenuItem_SetHelp(*args, **kwargs) |
e811c8ce RD |
11150 | |
11151 | def GetHelp(*args, **kwargs): | |
a95a7133 | 11152 | """GetHelp(self) -> String""" |
54f9ee45 | 11153 | return _core_.MenuItem_GetHelp(*args, **kwargs) |
e811c8ce RD |
11154 | |
11155 | def GetAccel(*args, **kwargs): | |
a95a7133 | 11156 | """GetAccel(self) -> AcceleratorEntry""" |
54f9ee45 | 11157 | return _core_.MenuItem_GetAccel(*args, **kwargs) |
e811c8ce RD |
11158 | |
11159 | def SetAccel(*args, **kwargs): | |
a95a7133 | 11160 | """SetAccel(self, AcceleratorEntry accel)""" |
54f9ee45 | 11161 | return _core_.MenuItem_SetAccel(*args, **kwargs) |
e811c8ce | 11162 | |
091f5bed RD |
11163 | def SetBitmap(*args, **kwargs): |
11164 | """SetBitmap(self, Bitmap bitmap)""" | |
11165 | return _core_.MenuItem_SetBitmap(*args, **kwargs) | |
11166 | ||
11167 | def GetBitmap(*args, **kwargs): | |
11168 | """GetBitmap(self) -> Bitmap""" | |
11169 | return _core_.MenuItem_GetBitmap(*args, **kwargs) | |
11170 | ||
c1280d1e RD |
11171 | def SetFont(*args, **kwargs): |
11172 | """SetFont(self, Font font)""" | |
11173 | return _core_.MenuItem_SetFont(*args, **kwargs) | |
11174 | ||
11175 | def GetFont(*args, **kwargs): | |
11176 | """GetFont(self) -> Font""" | |
11177 | return _core_.MenuItem_GetFont(*args, **kwargs) | |
11178 | ||
11179 | def SetTextColour(*args, **kwargs): | |
11180 | """SetTextColour(self, Colour colText)""" | |
11181 | return _core_.MenuItem_SetTextColour(*args, **kwargs) | |
11182 | ||
11183 | def GetTextColour(*args, **kwargs): | |
11184 | """GetTextColour(self) -> Colour""" | |
11185 | return _core_.MenuItem_GetTextColour(*args, **kwargs) | |
11186 | ||
11187 | def SetBackgroundColour(*args, **kwargs): | |
11188 | """SetBackgroundColour(self, Colour colBack)""" | |
11189 | return _core_.MenuItem_SetBackgroundColour(*args, **kwargs) | |
11190 | ||
11191 | def GetBackgroundColour(*args, **kwargs): | |
11192 | """GetBackgroundColour(self) -> Colour""" | |
11193 | return _core_.MenuItem_GetBackgroundColour(*args, **kwargs) | |
11194 | ||
11195 | def SetBitmaps(*args, **kwargs): | |
11196 | """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)""" | |
11197 | return _core_.MenuItem_SetBitmaps(*args, **kwargs) | |
11198 | ||
11199 | def SetDisabledBitmap(*args, **kwargs): | |
11200 | """SetDisabledBitmap(self, Bitmap bmpDisabled)""" | |
11201 | return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs) | |
11202 | ||
11203 | def GetDisabledBitmap(*args, **kwargs): | |
11204 | """GetDisabledBitmap(self) -> Bitmap""" | |
11205 | return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs) | |
11206 | ||
11207 | def SetMarginWidth(*args, **kwargs): | |
11208 | """SetMarginWidth(self, int nWidth)""" | |
11209 | return _core_.MenuItem_SetMarginWidth(*args, **kwargs) | |
11210 | ||
11211 | def GetMarginWidth(*args, **kwargs): | |
11212 | """GetMarginWidth(self) -> int""" | |
11213 | return _core_.MenuItem_GetMarginWidth(*args, **kwargs) | |
11214 | ||
e811c8ce | 11215 | def GetDefaultMarginWidth(*args, **kwargs): |
66c033b4 | 11216 | """GetDefaultMarginWidth() -> int""" |
54f9ee45 | 11217 | return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs) |
e811c8ce RD |
11218 | |
11219 | GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth) | |
c1280d1e RD |
11220 | def IsOwnerDrawn(*args, **kwargs): |
11221 | """IsOwnerDrawn(self) -> bool""" | |
11222 | return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs) | |
11223 | ||
11224 | def SetOwnerDrawn(*args, **kwargs): | |
11225 | """SetOwnerDrawn(self, bool ownerDrawn=True)""" | |
11226 | return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs) | |
11227 | ||
11228 | def ResetOwnerDrawn(*args, **kwargs): | |
11229 | """ResetOwnerDrawn(self)""" | |
11230 | return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs) | |
11231 | ||
57332a5a RD |
11232 | Accel = property(GetAccel,SetAccel,doc="See `GetAccel` and `SetAccel`") |
11233 | BackgroundColour = property(GetBackgroundColour,SetBackgroundColour,doc="See `GetBackgroundColour` and `SetBackgroundColour`") | |
11234 | Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`") | |
11235 | DisabledBitmap = property(GetDisabledBitmap,SetDisabledBitmap,doc="See `GetDisabledBitmap` and `SetDisabledBitmap`") | |
11236 | Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") | |
11237 | Help = property(GetHelp,SetHelp,doc="See `GetHelp` and `SetHelp`") | |
11238 | Id = property(GetId,SetId,doc="See `GetId` and `SetId`") | |
11239 | Kind = property(GetKind,SetKind,doc="See `GetKind` and `SetKind`") | |
11240 | Label = property(GetLabel,doc="See `GetLabel`") | |
11241 | MarginWidth = property(GetMarginWidth,SetMarginWidth,doc="See `GetMarginWidth` and `SetMarginWidth`") | |
11242 | Menu = property(GetMenu,SetMenu,doc="See `GetMenu` and `SetMenu`") | |
11243 | SubMenu = property(GetSubMenu,SetSubMenu,doc="See `GetSubMenu` and `SetSubMenu`") | |
11244 | Text = property(GetText,SetText,doc="See `GetText` and `SetText`") | |
11245 | TextColour = property(GetTextColour,SetTextColour,doc="See `GetTextColour` and `SetTextColour`") | |
2131d850 | 11246 | _core_.MenuItem_swigregister(MenuItem) |
d14a1e28 | 11247 | |
e811c8ce | 11248 | def MenuItem_GetLabelFromText(*args, **kwargs): |
0085ce49 RD |
11249 | """MenuItem_GetLabelFromText(String text) -> String""" |
11250 | return _core_.MenuItem_GetLabelFromText(*args, **kwargs) | |
d14a1e28 | 11251 | |
0085ce49 RD |
11252 | def MenuItem_GetDefaultMarginWidth(*args): |
11253 | """MenuItem_GetDefaultMarginWidth() -> int""" | |
11254 | return _core_.MenuItem_GetDefaultMarginWidth(*args) | |
d14a1e28 RD |
11255 | |
11256 | #--------------------------------------------------------------------------- | |
11257 | ||
11258 | class Control(Window): | |
15afbcd0 RD |
11259 | """ |
11260 | This is the base class for a control or 'widget'. | |
11261 | ||
41e2b43e RD |
11262 | A control is generally a small window which processes user input |
11263 | and/or displays one or more item of data. | |
15afbcd0 | 11264 | """ |
0085ce49 RD |
11265 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11266 | __repr__ = _swig_repr | |
11267 | def __init__(self, *args, **kwargs): | |
0df68c9f | 11268 | """ |
248ed943 RD |
11269 | __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
11270 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
b2dc1044 | 11271 | String name=ControlNameStr) -> Control |
15afbcd0 | 11272 | |
41e2b43e RD |
11273 | Create a Control. Normally you should only call this from a subclass' |
11274 | __init__ as a plain old wx.Control is not very useful. | |
0df68c9f | 11275 | """ |
0085ce49 | 11276 | _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs)) |
d14a1e28 | 11277 | self._setOORInfo(self) |
e811c8ce RD |
11278 | |
11279 | def Create(*args, **kwargs): | |
0df68c9f | 11280 | """ |
248ed943 RD |
11281 | Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
11282 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
b2dc1044 | 11283 | String name=ControlNameStr) -> bool |
15afbcd0 RD |
11284 | |
11285 | Do the 2nd phase and create the GUI control. | |
0df68c9f | 11286 | """ |
54f9ee45 | 11287 | return _core_.Control_Create(*args, **kwargs) |
e811c8ce | 11288 | |
10044bf1 RD |
11289 | def GetAlignment(*args, **kwargs): |
11290 | """ | |
11291 | GetAlignment(self) -> int | |
11292 | ||
11293 | Get the control alignment (left/right/centre, top/bottom/centre) | |
11294 | """ | |
11295 | return _core_.Control_GetAlignment(*args, **kwargs) | |
11296 | ||
34e0a3bb | 11297 | def GetLabelText(*args, **kwargs): |
10044bf1 | 11298 | """ |
10044bf1 RD |
11299 | GetLabelText(self) -> String |
11300 | ||
11301 | Get just the text of the label, without mnemonic characters ('&') | |
11302 | """ | |
34e0a3bb | 11303 | return _core_.Control_GetLabelText(*args, **kwargs) |
10044bf1 | 11304 | |
e811c8ce | 11305 | def Command(*args, **kwargs): |
15afbcd0 | 11306 | """ |
a95a7133 | 11307 | Command(self, CommandEvent event) |
15afbcd0 | 11308 | |
41e2b43e RD |
11309 | Simulates the effect of the user issuing a command to the item. |
11310 | ||
11311 | :see: `wx.CommandEvent` | |
11312 | ||
15afbcd0 | 11313 | """ |
54f9ee45 | 11314 | return _core_.Control_Command(*args, **kwargs) |
e811c8ce | 11315 | |
74a57fcd | 11316 | def GetClassDefaultAttributes(*args, **kwargs): |
110da5b0 RD |
11317 | """ |
11318 | GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes | |
11319 | ||
11320 | Get the default attributes for this class. This is useful if you want | |
11321 | to use the same font or colour in your own control as in a standard | |
11322 | control -- which is a much better idea than hard coding specific | |
11323 | colours or fonts which might look completely out of place on the | |
11324 | user's system, especially if it uses themes. | |
11325 | ||
11326 | The variant parameter is only relevant under Mac currently and is | |
11327 | ignore under other platforms. Under Mac, it will change the size of | |
11328 | the returned font. See `wx.Window.SetWindowVariant` for more about | |
11329 | this. | |
11330 | """ | |
54f9ee45 | 11331 | return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
11332 | |
11333 | GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) | |
2bf58437 | 11334 | Alignment = property(GetAlignment,doc="See `GetAlignment`") |
2bf58437 | 11335 | LabelText = property(GetLabelText,doc="See `GetLabelText`") |
2131d850 | 11336 | _core_.Control_swigregister(Control) |
b2dc1044 | 11337 | ControlNameStr = cvar.ControlNameStr |
d14a1e28 RD |
11338 | |
11339 | def PreControl(*args, **kwargs): | |
15afbcd0 RD |
11340 | """ |
11341 | PreControl() -> Control | |
11342 | ||
11343 | Precreate a Control control for 2-phase creation | |
11344 | """ | |
54f9ee45 | 11345 | val = _core_.new_PreControl(*args, **kwargs) |
d14a1e28 RD |
11346 | return val |
11347 | ||
74a57fcd | 11348 | def Control_GetClassDefaultAttributes(*args, **kwargs): |
0085ce49 | 11349 | """ |
110da5b0 RD |
11350 | Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
11351 | ||
11352 | Get the default attributes for this class. This is useful if you want | |
11353 | to use the same font or colour in your own control as in a standard | |
11354 | control -- which is a much better idea than hard coding specific | |
11355 | colours or fonts which might look completely out of place on the | |
11356 | user's system, especially if it uses themes. | |
11357 | ||
11358 | The variant parameter is only relevant under Mac currently and is | |
11359 | ignore under other platforms. Under Mac, it will change the size of | |
11360 | the returned font. See `wx.Window.SetWindowVariant` for more about | |
11361 | this. | |
11362 | """ | |
0085ce49 | 11363 | return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd | 11364 | |
d14a1e28 RD |
11365 | #--------------------------------------------------------------------------- |
11366 | ||
11367 | class ItemContainer(object): | |
15afbcd0 | 11368 | """ |
53aa7709 RD |
11369 | The wx.ItemContainer class defines an interface which is implemented |
11370 | by all controls which have string subitems, each of which may be | |
11371 | selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well | |
11372 | as `wx.ComboBox` which implements an extended interface deriving from | |
41e2b43e | 11373 | this one. |
15afbcd0 | 11374 | |
41e2b43e RD |
11375 | It defines the methods for accessing the control's items and although |
11376 | each of the derived classes implements them differently, they still | |
11377 | all conform to the same interface. | |
15afbcd0 | 11378 | |
41e2b43e RD |
11379 | The items in a wx.ItemContainer have (non empty) string labels and, |
11380 | optionally, client data associated with them. | |
15afbcd0 RD |
11381 | |
11382 | """ | |
0085ce49 RD |
11383 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11384 | def __init__(self): raise AttributeError, "No constructor defined" | |
11385 | __repr__ = _swig_repr | |
e811c8ce | 11386 | def Append(*args, **kwargs): |
15afbcd0 | 11387 | """ |
a95a7133 | 11388 | Append(self, String item, PyObject clientData=None) -> int |
15afbcd0 | 11389 | |
41e2b43e RD |
11390 | Adds the item to the control, associating the given data with the item |
11391 | if not None. The return value is the index of the newly added item | |
11392 | which may be different from the last one if the control is sorted (e.g. | |
11393 | has wx.LB_SORT or wx.CB_SORT style). | |
15afbcd0 | 11394 | """ |
54f9ee45 | 11395 | return _core_.ItemContainer_Append(*args, **kwargs) |
e811c8ce RD |
11396 | |
11397 | def AppendItems(*args, **kwargs): | |
15afbcd0 | 11398 | """ |
f5b96ee1 | 11399 | AppendItems(self, List strings) |
15afbcd0 | 11400 | |
41e2b43e RD |
11401 | Apend several items at once to the control. Notice that calling this |
11402 | method may be much faster than appending the items one by one if you | |
11403 | need to add a lot of items. | |
15afbcd0 | 11404 | """ |
54f9ee45 | 11405 | return _core_.ItemContainer_AppendItems(*args, **kwargs) |
e811c8ce RD |
11406 | |
11407 | def Insert(*args, **kwargs): | |
15afbcd0 | 11408 | """ |
d359a380 | 11409 | Insert(self, String item, int pos, PyObject clientData=None) -> int |
15afbcd0 | 11410 | |
41e2b43e | 11411 | Insert an item into the control before the item at the ``pos`` index, |
15afbcd0 RD |
11412 | optionally associating some data object with the item. |
11413 | """ | |
54f9ee45 | 11414 | return _core_.ItemContainer_Insert(*args, **kwargs) |
e811c8ce RD |
11415 | |
11416 | def Clear(*args, **kwargs): | |
15afbcd0 | 11417 | """ |
a95a7133 | 11418 | Clear(self) |
15afbcd0 RD |
11419 | |
11420 | Removes all items from the control. | |
11421 | """ | |
54f9ee45 | 11422 | return _core_.ItemContainer_Clear(*args, **kwargs) |
e811c8ce RD |
11423 | |
11424 | def Delete(*args, **kwargs): | |
15afbcd0 | 11425 | """ |
d359a380 | 11426 | Delete(self, int n) |
15afbcd0 | 11427 | |
41e2b43e RD |
11428 | Deletes the item at the zero-based index 'n' from the control. Note |
11429 | that it is an error (signalled by a `wx.PyAssertionError` exception if | |
11430 | enabled) to remove an item with the index negative or greater or equal | |
11431 | than the number of items in the control. | |
15afbcd0 | 11432 | """ |
54f9ee45 | 11433 | return _core_.ItemContainer_Delete(*args, **kwargs) |
e811c8ce | 11434 | |
53aa7709 RD |
11435 | def GetClientData(*args, **kwargs): |
11436 | """ | |
d359a380 | 11437 | GetClientData(self, int n) -> PyObject |
53aa7709 RD |
11438 | |
11439 | Returns the client data associated with the given item, (if any.) | |
11440 | """ | |
11441 | return _core_.ItemContainer_GetClientData(*args, **kwargs) | |
11442 | ||
11443 | def SetClientData(*args, **kwargs): | |
11444 | """ | |
d359a380 | 11445 | SetClientData(self, int n, PyObject clientData) |
53aa7709 RD |
11446 | |
11447 | Associate the given client data with the item at position n. | |
11448 | """ | |
11449 | return _core_.ItemContainer_SetClientData(*args, **kwargs) | |
11450 | ||
e811c8ce | 11451 | def GetCount(*args, **kwargs): |
15afbcd0 | 11452 | """ |
d359a380 | 11453 | GetCount(self) -> int |
15afbcd0 RD |
11454 | |
11455 | Returns the number of items in the control. | |
11456 | """ | |
54f9ee45 | 11457 | return _core_.ItemContainer_GetCount(*args, **kwargs) |
e811c8ce RD |
11458 | |
11459 | def IsEmpty(*args, **kwargs): | |
15afbcd0 | 11460 | """ |
a95a7133 | 11461 | IsEmpty(self) -> bool |
15afbcd0 RD |
11462 | |
11463 | Returns True if the control is empty or False if it has some items. | |
11464 | """ | |
54f9ee45 | 11465 | return _core_.ItemContainer_IsEmpty(*args, **kwargs) |
e811c8ce RD |
11466 | |
11467 | def GetString(*args, **kwargs): | |
15afbcd0 | 11468 | """ |
d359a380 | 11469 | GetString(self, int n) -> String |
15afbcd0 RD |
11470 | |
11471 | Returns the label of the item with the given index. | |
11472 | """ | |
54f9ee45 | 11473 | return _core_.ItemContainer_GetString(*args, **kwargs) |
e811c8ce RD |
11474 | |
11475 | def GetStrings(*args, **kwargs): | |
a95a7133 | 11476 | """GetStrings(self) -> wxArrayString""" |
54f9ee45 | 11477 | return _core_.ItemContainer_GetStrings(*args, **kwargs) |
e811c8ce RD |
11478 | |
11479 | def SetString(*args, **kwargs): | |
15afbcd0 | 11480 | """ |
d359a380 | 11481 | SetString(self, int n, String s) |
15afbcd0 RD |
11482 | |
11483 | Sets the label for the given item. | |
11484 | """ | |
54f9ee45 | 11485 | return _core_.ItemContainer_SetString(*args, **kwargs) |
e811c8ce RD |
11486 | |
11487 | def FindString(*args, **kwargs): | |
15afbcd0 | 11488 | """ |
a95a7133 | 11489 | FindString(self, String s) -> int |
15afbcd0 RD |
11490 | |
11491 | Finds an item whose label matches the given string. Returns the | |
41e2b43e RD |
11492 | zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not |
11493 | found. | |
15afbcd0 | 11494 | """ |
54f9ee45 | 11495 | return _core_.ItemContainer_FindString(*args, **kwargs) |
e811c8ce | 11496 | |
53aa7709 | 11497 | def SetSelection(*args, **kwargs): |
15afbcd0 | 11498 | """ |
53aa7709 | 11499 | SetSelection(self, int n) |
15afbcd0 RD |
11500 | |
11501 | Sets the item at index 'n' to be the selected item. | |
11502 | """ | |
53aa7709 | 11503 | return _core_.ItemContainer_SetSelection(*args, **kwargs) |
e811c8ce RD |
11504 | |
11505 | def GetSelection(*args, **kwargs): | |
15afbcd0 | 11506 | """ |
a95a7133 | 11507 | GetSelection(self) -> int |
15afbcd0 | 11508 | |
41e2b43e RD |
11509 | Returns the index of the selected item or ``wx.NOT_FOUND`` if no item |
11510 | is selected. | |
15afbcd0 | 11511 | """ |
54f9ee45 | 11512 | return _core_.ItemContainer_GetSelection(*args, **kwargs) |
e811c8ce | 11513 | |
53aa7709 RD |
11514 | def SetStringSelection(*args, **kwargs): |
11515 | """SetStringSelection(self, String s) -> bool""" | |
11516 | return _core_.ItemContainer_SetStringSelection(*args, **kwargs) | |
11517 | ||
e811c8ce | 11518 | def GetStringSelection(*args, **kwargs): |
15afbcd0 | 11519 | """ |
a95a7133 | 11520 | GetStringSelection(self) -> String |
15afbcd0 | 11521 | |
41e2b43e RD |
11522 | Returns the label of the selected item or an empty string if no item |
11523 | is selected. | |
15afbcd0 | 11524 | """ |
54f9ee45 | 11525 | return _core_.ItemContainer_GetStringSelection(*args, **kwargs) |
e811c8ce | 11526 | |
53aa7709 | 11527 | def Select(*args, **kwargs): |
15afbcd0 | 11528 | """ |
53aa7709 | 11529 | Select(self, int n) |
15afbcd0 | 11530 | |
53aa7709 RD |
11531 | This is the same as `SetSelection` and exists only because it is |
11532 | slightly more natural for controls which support multiple selection. | |
15afbcd0 | 11533 | """ |
53aa7709 | 11534 | return _core_.ItemContainer_Select(*args, **kwargs) |
e811c8ce | 11535 | |
97ab0f6a RD |
11536 | def GetItems(self): |
11537 | """Return a list of the strings in the control""" | |
11538 | return [self.GetString(i) for i in xrange(self.GetCount())] | |
11539 | ||
11540 | def SetItems(self, items): | |
11541 | """Clear and set the strings in the control from a list""" | |
11542 | self.Clear() | |
11543 | for i in items: | |
11544 | self.Append(i) | |
11545 | ||
11546 | Count = property(GetCount,doc="See `GetCount`") | |
11547 | Items = property(GetItems,SetItems,doc="See `GetItems` and `SetItems`") | |
11548 | Selection = property(GetSelection,SetSelection,doc="See `GetSelection` and `SetSelection`") | |
11549 | StringSelection = property(GetStringSelection,SetStringSelection,doc="See `GetStringSelection` and `SetStringSelection`") | |
11550 | Strings = property(GetStrings,doc="See `GetStrings`") | |
2131d850 | 11551 | _core_.ItemContainer_swigregister(ItemContainer) |
d14a1e28 RD |
11552 | |
11553 | #--------------------------------------------------------------------------- | |
11554 | ||
11555 | class ControlWithItems(Control,ItemContainer): | |
15afbcd0 | 11556 | """ |
41e2b43e RD |
11557 | wx.ControlWithItems combines the ``wx.ItemContainer`` class with the |
11558 | wx.Control class, and is used for the base class of various controls | |
11559 | that have items. | |
15afbcd0 | 11560 | """ |
0085ce49 RD |
11561 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11562 | def __init__(self): raise AttributeError, "No constructor defined" | |
11563 | __repr__ = _swig_repr | |
2131d850 | 11564 | _core_.ControlWithItems_swigregister(ControlWithItems) |
d14a1e28 RD |
11565 | |
11566 | #--------------------------------------------------------------------------- | |
11567 | ||
11568 | class SizerItem(Object): | |
248ed943 RD |
11569 | """ |
11570 | The wx.SizerItem class is used to track the position, size and other | |
01f6b6d3 RD |
11571 | attributes of each item managed by a `wx.Sizer`. It is not usually |
11572 | necessary to use this class because the sizer elements can also be | |
11573 | identified by their positions or window or sizer references but | |
11574 | sometimes it may be more convenient to use wx.SizerItem directly. | |
11575 | Also, custom classes derived from `wx.PySizer` will probably need to | |
11576 | use the collection of wx.SizerItems held by wx.Sizer when calculating | |
11577 | layout. | |
248ed943 RD |
11578 | |
11579 | :see: `wx.Sizer`, `wx.GBSizerItem` | |
11580 | """ | |
0085ce49 RD |
11581 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11582 | __repr__ = _swig_repr | |
11583 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11584 | """ |
11585 | __init__(self) -> SizerItem | |
11586 | ||
11587 | Constructs an empty wx.SizerItem. Either a window, sizer or spacer | |
11588 | size will need to be set before this item can be used in a Sizer. | |
11589 | ||
11590 | You will probably never need to create a wx.SizerItem directly as they | |
11591 | are created automatically when the sizer's Add, Insert or Prepend | |
11592 | methods are called. | |
11593 | ||
11594 | :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer` | |
11595 | """ | |
0085ce49 RD |
11596 | _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs)) |
11597 | __swig_destroy__ = _core_.delete_SizerItem | |
11598 | __del__ = lambda self : None; | |
e811c8ce | 11599 | def DeleteWindows(*args, **kwargs): |
248ed943 RD |
11600 | """ |
11601 | DeleteWindows(self) | |
11602 | ||
11603 | Destroy the window or the windows in a subsizer, depending on the type | |
11604 | of item. | |
11605 | """ | |
54f9ee45 | 11606 | return _core_.SizerItem_DeleteWindows(*args, **kwargs) |
e811c8ce RD |
11607 | |
11608 | def DetachSizer(*args, **kwargs): | |
248ed943 RD |
11609 | """ |
11610 | DetachSizer(self) | |
11611 | ||
11612 | Enable deleting the SizerItem without destroying the contained sizer. | |
11613 | """ | |
54f9ee45 | 11614 | return _core_.SizerItem_DetachSizer(*args, **kwargs) |
e811c8ce RD |
11615 | |
11616 | def GetSize(*args, **kwargs): | |
248ed943 RD |
11617 | """ |
11618 | GetSize(self) -> Size | |
11619 | ||
11620 | Get the current size of the item, as set in the last Layout. | |
11621 | """ | |
54f9ee45 | 11622 | return _core_.SizerItem_GetSize(*args, **kwargs) |
e811c8ce RD |
11623 | |
11624 | def CalcMin(*args, **kwargs): | |
248ed943 RD |
11625 | """ |
11626 | CalcMin(self) -> Size | |
11627 | ||
11628 | Calculates the minimum desired size for the item, including any space | |
11629 | needed by borders. | |
11630 | """ | |
54f9ee45 | 11631 | return _core_.SizerItem_CalcMin(*args, **kwargs) |
e811c8ce RD |
11632 | |
11633 | def SetDimension(*args, **kwargs): | |
248ed943 RD |
11634 | """ |
11635 | SetDimension(self, Point pos, Size size) | |
11636 | ||
11637 | Set the position and size of the space allocated for this item by the | |
11638 | sizer, and adjust the position and size of the item (window or | |
11639 | subsizer) to be within that space taking alignment and borders into | |
11640 | account. | |
11641 | """ | |
54f9ee45 | 11642 | return _core_.SizerItem_SetDimension(*args, **kwargs) |
e811c8ce RD |
11643 | |
11644 | def GetMinSize(*args, **kwargs): | |
248ed943 RD |
11645 | """ |
11646 | GetMinSize(self) -> Size | |
11647 | ||
11648 | Get the minimum size needed for the item. | |
11649 | """ | |
54f9ee45 | 11650 | return _core_.SizerItem_GetMinSize(*args, **kwargs) |
e811c8ce | 11651 | |
dfbb5885 RD |
11652 | def GetMinSizeWithBorder(*args, **kwargs): |
11653 | """ | |
11654 | GetMinSizeWithBorder(self) -> Size | |
11655 | ||
11656 | Get the minimum size needed for the item with space for the borders | |
11657 | added, if needed. | |
11658 | """ | |
11659 | return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs) | |
11660 | ||
e811c8ce | 11661 | def SetInitSize(*args, **kwargs): |
a95a7133 | 11662 | """SetInitSize(self, int x, int y)""" |
54f9ee45 | 11663 | return _core_.SizerItem_SetInitSize(*args, **kwargs) |
e811c8ce RD |
11664 | |
11665 | def SetRatioWH(*args, **kwargs): | |
248ed943 RD |
11666 | """ |
11667 | SetRatioWH(self, int width, int height) | |
11668 | ||
11669 | Set the ratio item attribute. | |
11670 | """ | |
54f9ee45 | 11671 | return _core_.SizerItem_SetRatioWH(*args, **kwargs) |
e811c8ce RD |
11672 | |
11673 | def SetRatioSize(*args, **kwargs): | |
248ed943 RD |
11674 | """ |
11675 | SetRatioSize(self, Size size) | |
11676 | ||
11677 | Set the ratio item attribute. | |
11678 | """ | |
54f9ee45 | 11679 | return _core_.SizerItem_SetRatioSize(*args, **kwargs) |
e811c8ce RD |
11680 | |
11681 | def SetRatio(*args, **kwargs): | |
248ed943 RD |
11682 | """ |
11683 | SetRatio(self, float ratio) | |
11684 | ||
11685 | Set the ratio item attribute. | |
11686 | """ | |
54f9ee45 | 11687 | return _core_.SizerItem_SetRatio(*args, **kwargs) |
e811c8ce RD |
11688 | |
11689 | def GetRatio(*args, **kwargs): | |
248ed943 RD |
11690 | """ |
11691 | GetRatio(self) -> float | |
11692 | ||
11693 | Set the ratio item attribute. | |
11694 | """ | |
54f9ee45 | 11695 | return _core_.SizerItem_GetRatio(*args, **kwargs) |
e811c8ce | 11696 | |
d3b6e4ff RD |
11697 | def GetRect(*args, **kwargs): |
11698 | """ | |
11699 | GetRect(self) -> Rect | |
11700 | ||
11701 | Returns the rectangle that the sizer item should occupy | |
11702 | """ | |
11703 | return _core_.SizerItem_GetRect(*args, **kwargs) | |
11704 | ||
e811c8ce | 11705 | def IsWindow(*args, **kwargs): |
248ed943 RD |
11706 | """ |
11707 | IsWindow(self) -> bool | |
11708 | ||
11709 | Is this sizer item a window? | |
11710 | """ | |
54f9ee45 | 11711 | return _core_.SizerItem_IsWindow(*args, **kwargs) |
e811c8ce RD |
11712 | |
11713 | def IsSizer(*args, **kwargs): | |
248ed943 RD |
11714 | """ |
11715 | IsSizer(self) -> bool | |
11716 | ||
11717 | Is this sizer item a subsizer? | |
11718 | """ | |
54f9ee45 | 11719 | return _core_.SizerItem_IsSizer(*args, **kwargs) |
e811c8ce RD |
11720 | |
11721 | def IsSpacer(*args, **kwargs): | |
248ed943 RD |
11722 | """ |
11723 | IsSpacer(self) -> bool | |
11724 | ||
11725 | Is this sizer item a spacer? | |
11726 | """ | |
54f9ee45 | 11727 | return _core_.SizerItem_IsSpacer(*args, **kwargs) |
e811c8ce RD |
11728 | |
11729 | def SetProportion(*args, **kwargs): | |
248ed943 RD |
11730 | """ |
11731 | SetProportion(self, int proportion) | |
11732 | ||
11733 | Set the proportion value for this item. | |
11734 | """ | |
54f9ee45 | 11735 | return _core_.SizerItem_SetProportion(*args, **kwargs) |
e811c8ce RD |
11736 | |
11737 | def GetProportion(*args, **kwargs): | |
248ed943 RD |
11738 | """ |
11739 | GetProportion(self) -> int | |
11740 | ||
11741 | Get the proportion value for this item. | |
11742 | """ | |
54f9ee45 | 11743 | return _core_.SizerItem_GetProportion(*args, **kwargs) |
e811c8ce | 11744 | |
248ed943 RD |
11745 | SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.") |
11746 | GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.") | |
e811c8ce | 11747 | def SetFlag(*args, **kwargs): |
248ed943 RD |
11748 | """ |
11749 | SetFlag(self, int flag) | |
11750 | ||
11751 | Set the flag value for this item. | |
11752 | """ | |
54f9ee45 | 11753 | return _core_.SizerItem_SetFlag(*args, **kwargs) |
e811c8ce RD |
11754 | |
11755 | def GetFlag(*args, **kwargs): | |
248ed943 RD |
11756 | """ |
11757 | GetFlag(self) -> int | |
11758 | ||
11759 | Get the flag value for this item. | |
11760 | """ | |
54f9ee45 | 11761 | return _core_.SizerItem_GetFlag(*args, **kwargs) |
e811c8ce RD |
11762 | |
11763 | def SetBorder(*args, **kwargs): | |
248ed943 RD |
11764 | """ |
11765 | SetBorder(self, int border) | |
11766 | ||
11767 | Set the border value for this item. | |
11768 | """ | |
54f9ee45 | 11769 | return _core_.SizerItem_SetBorder(*args, **kwargs) |
e811c8ce RD |
11770 | |
11771 | def GetBorder(*args, **kwargs): | |
248ed943 RD |
11772 | """ |
11773 | GetBorder(self) -> int | |
11774 | ||
11775 | Get the border value for this item. | |
11776 | """ | |
54f9ee45 | 11777 | return _core_.SizerItem_GetBorder(*args, **kwargs) |
e811c8ce RD |
11778 | |
11779 | def GetWindow(*args, **kwargs): | |
248ed943 RD |
11780 | """ |
11781 | GetWindow(self) -> Window | |
11782 | ||
11783 | Get the window (if any) that is managed by this sizer item. | |
11784 | """ | |
54f9ee45 | 11785 | return _core_.SizerItem_GetWindow(*args, **kwargs) |
e811c8ce RD |
11786 | |
11787 | def SetWindow(*args, **kwargs): | |
248ed943 RD |
11788 | """ |
11789 | SetWindow(self, Window window) | |
11790 | ||
11791 | Set the window to be managed by this sizer item. | |
11792 | """ | |
54f9ee45 | 11793 | return _core_.SizerItem_SetWindow(*args, **kwargs) |
e811c8ce RD |
11794 | |
11795 | def GetSizer(*args, **kwargs): | |
248ed943 RD |
11796 | """ |
11797 | GetSizer(self) -> Sizer | |
11798 | ||
11799 | Get the subsizer (if any) that is managed by this sizer item. | |
11800 | """ | |
54f9ee45 | 11801 | return _core_.SizerItem_GetSizer(*args, **kwargs) |
e811c8ce RD |
11802 | |
11803 | def SetSizer(*args, **kwargs): | |
248ed943 RD |
11804 | """ |
11805 | SetSizer(self, Sizer sizer) | |
11806 | ||
11807 | Set the subsizer to be managed by this sizer item. | |
11808 | """ | |
54f9ee45 | 11809 | return _core_.SizerItem_SetSizer(*args, **kwargs) |
e811c8ce RD |
11810 | |
11811 | def GetSpacer(*args, **kwargs): | |
248ed943 RD |
11812 | """ |
11813 | GetSpacer(self) -> Size | |
11814 | ||
11815 | Get the size of the spacer managed by this sizer item. | |
11816 | """ | |
54f9ee45 | 11817 | return _core_.SizerItem_GetSpacer(*args, **kwargs) |
e811c8ce RD |
11818 | |
11819 | def SetSpacer(*args, **kwargs): | |
248ed943 RD |
11820 | """ |
11821 | SetSpacer(self, Size size) | |
11822 | ||
11823 | Set the size of the spacer to be managed by this sizer item. | |
11824 | """ | |
54f9ee45 | 11825 | return _core_.SizerItem_SetSpacer(*args, **kwargs) |
e811c8ce RD |
11826 | |
11827 | def Show(*args, **kwargs): | |
248ed943 RD |
11828 | """ |
11829 | Show(self, bool show) | |
11830 | ||
11831 | Set the show item attribute, which sizers use to determine if the item | |
11832 | is to be made part of the layout or not. If the item is tracking a | |
11833 | window then it is shown or hidden as needed. | |
11834 | """ | |
54f9ee45 | 11835 | return _core_.SizerItem_Show(*args, **kwargs) |
e811c8ce RD |
11836 | |
11837 | def IsShown(*args, **kwargs): | |
248ed943 RD |
11838 | """ |
11839 | IsShown(self) -> bool | |
11840 | ||
11841 | Is the item to be shown in the layout? | |
11842 | """ | |
54f9ee45 | 11843 | return _core_.SizerItem_IsShown(*args, **kwargs) |
e811c8ce RD |
11844 | |
11845 | def GetPosition(*args, **kwargs): | |
248ed943 RD |
11846 | """ |
11847 | GetPosition(self) -> Point | |
11848 | ||
11849 | Returns the current position of the item, as set in the last Layout. | |
11850 | """ | |
54f9ee45 | 11851 | return _core_.SizerItem_GetPosition(*args, **kwargs) |
e811c8ce RD |
11852 | |
11853 | def GetUserData(*args, **kwargs): | |
248ed943 RD |
11854 | """ |
11855 | GetUserData(self) -> PyObject | |
11856 | ||
11857 | Returns the userData associated with this sizer item, or None if there | |
11858 | isn't any. | |
11859 | """ | |
54f9ee45 | 11860 | return _core_.SizerItem_GetUserData(*args, **kwargs) |
e811c8ce | 11861 | |
091f5bed RD |
11862 | def SetUserData(*args, **kwargs): |
11863 | """ | |
11864 | SetUserData(self, PyObject userData) | |
11865 | ||
11866 | Associate a Python object with this sizer item. | |
11867 | """ | |
11868 | return _core_.SizerItem_SetUserData(*args, **kwargs) | |
11869 | ||
33d6fd3b RD |
11870 | Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`") |
11871 | Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`") | |
11872 | MinSize = property(GetMinSize,doc="See `GetMinSize`") | |
11873 | MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`") | |
11874 | Position = property(GetPosition,doc="See `GetPosition`") | |
11875 | Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`") | |
11876 | Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`") | |
11877 | Rect = property(GetRect,doc="See `GetRect`") | |
11878 | Size = property(GetSize,doc="See `GetSize`") | |
11879 | Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`") | |
11880 | Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`") | |
11881 | UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`") | |
11882 | Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`") | |
2131d850 | 11883 | _core_.SizerItem_swigregister(SizerItem) |
d14a1e28 | 11884 | |
248ed943 | 11885 | def SizerItemWindow(*args, **kwargs): |
0df68c9f | 11886 | """ |
248ed943 RD |
11887 | SizerItemWindow(Window window, int proportion, int flag, int border, |
11888 | PyObject userData=None) -> SizerItem | |
11889 | ||
11890 | Constructs a `wx.SizerItem` for tracking a window. | |
0df68c9f | 11891 | """ |
248ed943 | 11892 | val = _core_.new_SizerItemWindow(*args, **kwargs) |
d14a1e28 RD |
11893 | return val |
11894 | ||
248ed943 | 11895 | def SizerItemSpacer(*args, **kwargs): |
0df68c9f | 11896 | """ |
248ed943 RD |
11897 | SizerItemSpacer(int width, int height, int proportion, int flag, int border, |
11898 | PyObject userData=None) -> SizerItem | |
11899 | ||
11900 | Constructs a `wx.SizerItem` for tracking a spacer. | |
0df68c9f | 11901 | """ |
248ed943 | 11902 | val = _core_.new_SizerItemSpacer(*args, **kwargs) |
d14a1e28 RD |
11903 | return val |
11904 | ||
11905 | def SizerItemSizer(*args, **kwargs): | |
0df68c9f RD |
11906 | """ |
11907 | SizerItemSizer(Sizer sizer, int proportion, int flag, int border, | |
248ed943 RD |
11908 | PyObject userData=None) -> SizerItem |
11909 | ||
11910 | Constructs a `wx.SizerItem` for tracking a subsizer | |
0df68c9f | 11911 | """ |
54f9ee45 | 11912 | val = _core_.new_SizerItemSizer(*args, **kwargs) |
d14a1e28 RD |
11913 | return val |
11914 | ||
11915 | class Sizer(Object): | |
248ed943 RD |
11916 | """ |
11917 | wx.Sizer is the abstract base class used for laying out subwindows in | |
11918 | a window. You cannot use wx.Sizer directly; instead, you will have to | |
11919 | use one of the sizer classes derived from it such as `wx.BoxSizer`, | |
1d5ee749 RD |
11920 | `wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and |
11921 | `wx.GridBagSizer`. | |
248ed943 RD |
11922 | |
11923 | The concept implemented by sizers in wxWidgets is closely related to | |
11924 | layout tools in other GUI toolkits, such as Java's AWT, the GTK | |
11925 | toolkit or the Qt toolkit. It is based upon the idea of the individual | |
11926 | subwindows reporting their minimal required size and their ability to | |
11927 | get stretched if the size of the parent window has changed. This will | |
11928 | most often mean that the programmer does not set the original size of | |
11929 | a dialog in the beginning, rather the dialog will assigned a sizer and | |
11930 | this sizer will be queried about the recommended size. The sizer in | |
11931 | turn will query its children, which can be normal windows or contorls, | |
11932 | empty space or other sizers, so that a hierarchy of sizers can be | |
11933 | constructed. Note that wxSizer does not derive from wxWindow and thus | |
11934 | do not interfere with tab ordering and requires very little resources | |
11935 | compared to a real window on screen. | |
11936 | ||
11937 | What makes sizers so well fitted for use in wxWidgets is the fact that | |
11938 | every control reports its own minimal size and the algorithm can | |
11939 | handle differences in font sizes or different window (dialog item) | |
11940 | sizes on different platforms without problems. If for example the | |
11941 | standard font as well as the overall design of Mac widgets requires | |
11942 | more space than on Windows, then the initial size of a dialog using a | |
11943 | sizer will automatically be bigger on Mac than on Windows. | |
11944 | """ | |
0085ce49 RD |
11945 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11946 | def __init__(self): raise AttributeError, "No constructor defined" | |
11947 | __repr__ = _swig_repr | |
11948 | __swig_destroy__ = _core_.delete_Sizer | |
11949 | __del__ = lambda self : None; | |
e811c8ce | 11950 | def _setOORInfo(*args, **kwargs): |
a95a7133 | 11951 | """_setOORInfo(self, PyObject _self)""" |
54f9ee45 | 11952 | return _core_.Sizer__setOORInfo(*args, **kwargs) |
e811c8ce RD |
11953 | |
11954 | def Add(*args, **kwargs): | |
0df68c9f | 11955 | """ |
248ed943 | 11956 | Add(self, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11957 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11958 | |
11959 | Appends a child item to the sizer. | |
0df68c9f | 11960 | """ |
54f9ee45 | 11961 | return _core_.Sizer_Add(*args, **kwargs) |
e811c8ce RD |
11962 | |
11963 | def Insert(*args, **kwargs): | |
0df68c9f | 11964 | """ |
248ed943 | 11965 | Insert(self, int before, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11966 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11967 | |
11968 | Inserts a new item into the list of items managed by this sizer before | |
11969 | the item at index *before*. See `Add` for a description of the parameters. | |
0df68c9f | 11970 | """ |
54f9ee45 | 11971 | return _core_.Sizer_Insert(*args, **kwargs) |
e811c8ce RD |
11972 | |
11973 | def Prepend(*args, **kwargs): | |
0df68c9f | 11974 | """ |
248ed943 | 11975 | Prepend(self, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11976 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11977 | |
11978 | Adds a new item to the begining of the list of sizer items managed by | |
11979 | this sizer. See `Add` for a description of the parameters. | |
0df68c9f | 11980 | """ |
54f9ee45 | 11981 | return _core_.Sizer_Prepend(*args, **kwargs) |
e811c8ce RD |
11982 | |
11983 | def Remove(*args, **kwargs): | |
248ed943 RD |
11984 | """ |
11985 | Remove(self, item) -> bool | |
11986 | ||
11987 | Removes an item from the sizer and destroys it. This method does not | |
11988 | cause any layout or resizing to take place, call `Layout` to update | |
11989 | the layout on screen after removing a child from the sizer. The | |
11990 | *item* parameter can be either a window, a sizer, or the zero-based | |
11991 | index of an item to remove. Returns True if the child item was found | |
11992 | and removed. | |
11993 | """ | |
54f9ee45 | 11994 | return _core_.Sizer_Remove(*args, **kwargs) |
e811c8ce | 11995 | |
1c0f361b | 11996 | def Detach(*args, **kwargs): |
248ed943 RD |
11997 | """ |
11998 | Detach(self, item) -> bool | |
11999 | ||
12000 | Detaches an item from the sizer without destroying it. This method | |
12001 | does not cause any layout or resizing to take place, call `Layout` to | |
12002 | do so. The *item* parameter can be either a window, a sizer, or the | |
12003 | zero-based index of the item to be detached. Returns True if the child item | |
12004 | was found and detached. | |
12005 | """ | |
1c0f361b RD |
12006 | return _core_.Sizer_Detach(*args, **kwargs) |
12007 | ||
d3b6e4ff RD |
12008 | def GetItem(*args, **kwargs): |
12009 | """ | |
12010 | GetItem(self, item) -> wx.SizerItem | |
12011 | ||
12012 | Returns the `wx.SizerItem` which holds the *item* given. The *item* | |
12013 | parameter can be either a window, a sizer, or the zero-based index of | |
4d170c95 | 12014 | the item to be found. |
d3b6e4ff RD |
12015 | """ |
12016 | return _core_.Sizer_GetItem(*args, **kwargs) | |
12017 | ||
e811c8ce | 12018 | def _SetItemMinSize(*args, **kwargs): |
a95a7133 | 12019 | """_SetItemMinSize(self, PyObject item, Size size)""" |
54f9ee45 | 12020 | return _core_.Sizer__SetItemMinSize(*args, **kwargs) |
e811c8ce | 12021 | |
97ab0f6a RD |
12022 | def _ReplaceWin(*args, **kwargs): |
12023 | """_ReplaceWin(self, Window oldwin, Window newwin, bool recursive=False) -> bool""" | |
12024 | return _core_.Sizer__ReplaceWin(*args, **kwargs) | |
12025 | ||
12026 | def _ReplaceSizer(*args, **kwargs): | |
12027 | """_ReplaceSizer(self, Sizer oldsz, Sizer newsz, bool recursive=False) -> bool""" | |
12028 | return _core_.Sizer__ReplaceSizer(*args, **kwargs) | |
12029 | ||
12030 | def _ReplaceItem(*args, **kwargs): | |
12031 | """_ReplaceItem(self, size_t index, SizerItem newitem) -> bool""" | |
12032 | return _core_.Sizer__ReplaceItem(*args, **kwargs) | |
12033 | ||
12034 | def Replace(self, olditem, item, recursive=False): | |
12035 | """ | |
12036 | Detaches the given ``olditem`` from the sizer and replaces it with | |
12037 | ``item`` which can be a window, sizer, or `wx.SizerItem`. The | |
12038 | detached child is destroyed only if it is not a window, (because | |
12039 | windows are owned by their parent, not the sizer.) The | |
12040 | ``recursive`` parameter can be used to search for the given | |
12041 | element recursivly in subsizers. | |
12042 | ||
12043 | This method does not cause any layout or resizing to take place, | |
12044 | call `Layout` to do so. | |
12045 | ||
12046 | Returns ``True`` if the child item was found and removed. | |
12047 | """ | |
12048 | if isinstance(olditem, wx.Window): | |
12049 | return self._ReplaceWin(olditem, item, recursive) | |
12050 | elif isinstnace(olditem, wx.Sizer): | |
12051 | return self._ReplaceSizer(olditem, item, recursive) | |
12052 | elif isinstnace(olditem, int): | |
12053 | return self._ReplaceItem(olditem, item) | |
12054 | else: | |
12055 | raise TypeError("Expected Window, Sizer, or integer for first parameter.") | |
12056 | ||
12057 | def SetContainingWindow(*args, **kwargs): | |
12058 | """ | |
12059 | SetContainingWindow(self, Window window) | |
12060 | ||
12061 | Set (or unset) the window this sizer is used in. | |
12062 | """ | |
12063 | return _core_.Sizer_SetContainingWindow(*args, **kwargs) | |
12064 | ||
12065 | def GetContainingWindow(*args, **kwargs): | |
12066 | """ | |
12067 | GetContainingWindow(self) -> Window | |
12068 | ||
12069 | Get the window this sizer is used in. | |
12070 | """ | |
12071 | return _core_.Sizer_GetContainingWindow(*args, **kwargs) | |
12072 | ||
248ed943 RD |
12073 | def SetItemMinSize(self, item, *args): |
12074 | """ | |
12075 | SetItemMinSize(self, item, Size size) | |
12076 | ||
12077 | Sets the minimum size that will be allocated for an item in the sizer. | |
12078 | The *item* parameter can be either a window, a sizer, or the | |
12079 | zero-based index of the item. If a window or sizer is given then it | |
12080 | will be searched for recursivly in subsizers if neccessary. | |
12081 | """ | |
12082 | if len(args) == 2: | |
12083 | # for backward compatibility accept separate width,height args too | |
12084 | return self._SetItemMinSize(item, args) | |
12085 | else: | |
12086 | return self._SetItemMinSize(item, args[0]) | |
12087 | ||
e811c8ce | 12088 | def AddItem(*args, **kwargs): |
248ed943 RD |
12089 | """ |
12090 | AddItem(self, SizerItem item) | |
12091 | ||
12092 | Adds a `wx.SizerItem` to the sizer. | |
12093 | """ | |
54f9ee45 | 12094 | return _core_.Sizer_AddItem(*args, **kwargs) |
e811c8ce RD |
12095 | |
12096 | def InsertItem(*args, **kwargs): | |
248ed943 RD |
12097 | """ |
12098 | InsertItem(self, int index, SizerItem item) | |
12099 | ||
12100 | Inserts a `wx.SizerItem` to the sizer at the position given by *index*. | |
12101 | """ | |
54f9ee45 | 12102 | return _core_.Sizer_InsertItem(*args, **kwargs) |
e811c8ce RD |
12103 | |
12104 | def PrependItem(*args, **kwargs): | |
248ed943 RD |
12105 | """ |
12106 | PrependItem(self, SizerItem item) | |
12107 | ||
12108 | Prepends a `wx.SizerItem` to the sizer. | |
12109 | """ | |
54f9ee45 | 12110 | return _core_.Sizer_PrependItem(*args, **kwargs) |
e811c8ce | 12111 | |
248ed943 | 12112 | def AddMany(self, items): |
66c033b4 RD |
12113 | """ |
12114 | AddMany is a convenience method for adding several items | |
12115 | to a sizer at one time. Simply pass it a list of tuples, | |
12116 | where each tuple consists of the parameters that you | |
12117 | would normally pass to the `Add` method. | |
12118 | """ | |
248ed943 RD |
12119 | for item in items: |
12120 | if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)): | |
12121 | item = (item, ) | |
12122 | self.Add(*item) | |
d14a1e28 | 12123 | |
ae5bc7f3 RD |
12124 | def AddSpacer(self, *args, **kw): |
12125 | """AddSpacer(int size) --> SizerItem | |
12126 | ||
12127 | Add a spacer that is (size,size) pixels. | |
12128 | """ | |
12129 | if args and type(args[0]) == int: | |
12130 | return self.Add( (args[0],args[0] ), 0) | |
12131 | else: # otherwise stay compatible with old AddSpacer | |
12132 | return self.Add(*args, **kw) | |
12133 | def PrependSpacer(self, *args, **kw): | |
12134 | """PrependSpacer(int size) --> SizerItem | |
12135 | ||
12136 | Prepend a spacer that is (size, size) pixels.""" | |
12137 | if args and type(args[0]) == int: | |
12138 | return self.Prepend( (args[0],args[0] ), 0) | |
12139 | else: # otherwise stay compatible with old PrependSpacer | |
12140 | return self.Prepend(*args, **kw) | |
12141 | def InsertSpacer(self, index, *args, **kw): | |
12142 | """InsertSpacer(int index, int size) --> SizerItem | |
12143 | ||
12144 | Insert a spacer at position index that is (size, size) pixels.""" | |
12145 | if args and type(args[0]) == int: | |
12146 | return self.Insert( index, (args[0],args[0] ), 0) | |
12147 | else: # otherwise stay compatible with old InsertSpacer | |
12148 | return self.Insert(index, *args, **kw) | |
12149 | ||
12150 | ||
12151 | def AddStretchSpacer(self, prop=1): | |
12152 | """AddStretchSpacer(int prop=1) --> SizerItem | |
12153 | ||
12154 | Add a stretchable spacer.""" | |
12155 | return self.Add((0,0), prop) | |
12156 | def PrependStretchSpacer(self, prop=1): | |
12157 | """PrependStretchSpacer(int prop=1) --> SizerItem | |
12158 | ||
12159 | Prepend a stretchable spacer.""" | |
12160 | return self.Prepend((0,0), prop) | |
12161 | def InsertStretchSpacer(self, index, prop=1): | |
12162 | """InsertStretchSpacer(int index, int prop=1) --> SizerItem | |
12163 | ||
12164 | Insert a stretchable spacer.""" | |
12165 | return self.Insert(index, (0,0), prop) | |
12166 | ||
12167 | ||
74e96f3d | 12168 | # for backwards compatibility only, please do not use in new code |
b9d6a5f3 RD |
12169 | def AddWindow(self, *args, **kw): |
12170 | """Compatibility alias for `Add`.""" | |
12171 | return self.Add(*args, **kw) | |
12172 | def AddSizer(self, *args, **kw): | |
12173 | """Compatibility alias for `Add`.""" | |
12174 | return self.Add(*args, **kw) | |
b9d6a5f3 RD |
12175 | |
12176 | def PrependWindow(self, *args, **kw): | |
12177 | """Compatibility alias for `Prepend`.""" | |
12178 | return self.Prepend(*args, **kw) | |
12179 | def PrependSizer(self, *args, **kw): | |
12180 | """Compatibility alias for `Prepend`.""" | |
12181 | return self.Prepend(*args, **kw) | |
b9d6a5f3 RD |
12182 | |
12183 | def InsertWindow(self, *args, **kw): | |
12184 | """Compatibility alias for `Insert`.""" | |
12185 | return self.Insert(*args, **kw) | |
12186 | def InsertSizer(self, *args, **kw): | |
12187 | """Compatibility alias for `Insert`.""" | |
b9d6a5f3 RD |
12188 | return self.Insert(*args, **kw) |
12189 | ||
12190 | def RemoveWindow(self, *args, **kw): | |
12191 | """Compatibility alias for `Remove`.""" | |
12192 | return self.Remove(*args, **kw) | |
12193 | def RemoveSizer(self, *args, **kw): | |
12194 | """Compatibility alias for `Remove`.""" | |
12195 | return self.Remove(*args, **kw) | |
12196 | def RemovePos(self, *args, **kw): | |
12197 | """Compatibility alias for `Remove`.""" | |
12198 | return self.Remove(*args, **kw) | |
d14a1e28 RD |
12199 | |
12200 | ||
e811c8ce | 12201 | def SetDimension(*args, **kwargs): |
248ed943 RD |
12202 | """ |
12203 | SetDimension(self, int x, int y, int width, int height) | |
12204 | ||
12205 | Call this to force the sizer to take the given dimension and thus | |
12206 | force the items owned by the sizer to resize themselves according to | |
12207 | the rules defined by the parameter in the `Add`, `Insert` or `Prepend` | |
12208 | methods. | |
12209 | """ | |
54f9ee45 | 12210 | return _core_.Sizer_SetDimension(*args, **kwargs) |
e811c8ce RD |
12211 | |
12212 | def SetMinSize(*args, **kwargs): | |
248ed943 RD |
12213 | """ |
12214 | SetMinSize(self, Size size) | |
12215 | ||
12216 | Call this to give the sizer a minimal size. Normally, the sizer will | |
12217 | calculate its minimal size based purely on how much space its children | |
12218 | need. After calling this method `GetMinSize` will return either the | |
12219 | minimal size as requested by its children or the minimal size set | |
12220 | here, depending on which is bigger. | |
12221 | """ | |
54f9ee45 | 12222 | return _core_.Sizer_SetMinSize(*args, **kwargs) |
e811c8ce RD |
12223 | |
12224 | def GetSize(*args, **kwargs): | |
248ed943 RD |
12225 | """ |
12226 | GetSize(self) -> Size | |
12227 | ||
12228 | Returns the current size of the space managed by the sizer. | |
12229 | """ | |
54f9ee45 | 12230 | return _core_.Sizer_GetSize(*args, **kwargs) |
e811c8ce RD |
12231 | |
12232 | def GetPosition(*args, **kwargs): | |
248ed943 RD |
12233 | """ |
12234 | GetPosition(self) -> Point | |
12235 | ||
12236 | Returns the current position of the sizer's managed space. | |
12237 | """ | |
54f9ee45 | 12238 | return _core_.Sizer_GetPosition(*args, **kwargs) |
e811c8ce RD |
12239 | |
12240 | def GetMinSize(*args, **kwargs): | |
248ed943 RD |
12241 | """ |
12242 | GetMinSize(self) -> Size | |
12243 | ||
12244 | Returns the minimal size of the sizer. This is either the combined | |
12245 | minimal size of all the children and their borders or the minimal size | |
12246 | set by SetMinSize, depending on which is bigger. | |
12247 | """ | |
54f9ee45 | 12248 | return _core_.Sizer_GetMinSize(*args, **kwargs) |
e811c8ce | 12249 | |
d14a1e28 | 12250 | def GetSizeTuple(self): |
1c0f361b | 12251 | return self.GetSize().Get() |
d14a1e28 | 12252 | def GetPositionTuple(self): |
1c0f361b | 12253 | return self.GetPosition().Get() |
d14a1e28 | 12254 | def GetMinSizeTuple(self): |
1c0f361b | 12255 | return self.GetMinSize().Get() |
d14a1e28 | 12256 | |
e811c8ce | 12257 | def RecalcSizes(*args, **kwargs): |
248ed943 RD |
12258 | """ |
12259 | RecalcSizes(self) | |
12260 | ||
12261 | Using the sizes calculated by `CalcMin` reposition and resize all the | |
12262 | items managed by this sizer. You should not need to call this directly as | |
12263 | it is called by `Layout`. | |
12264 | """ | |
54f9ee45 | 12265 | return _core_.Sizer_RecalcSizes(*args, **kwargs) |
e811c8ce RD |
12266 | |
12267 | def CalcMin(*args, **kwargs): | |
248ed943 RD |
12268 | """ |
12269 | CalcMin(self) -> Size | |
12270 | ||
12271 | This method is where the sizer will do the actual calculation of its | |
12272 | children's minimal sizes. You should not need to call this directly as | |
12273 | it is called by `Layout`. | |
12274 | """ | |
54f9ee45 | 12275 | return _core_.Sizer_CalcMin(*args, **kwargs) |
e811c8ce RD |
12276 | |
12277 | def Layout(*args, **kwargs): | |
248ed943 RD |
12278 | """ |
12279 | Layout(self) | |
12280 | ||
12281 | This method will force the recalculation and layout of the items | |
12282 | controlled by the sizer using the current space allocated to the | |
12283 | sizer. Normally this is called automatically from the owning window's | |
12284 | EVT_SIZE handler, but it is also useful to call it from user code when | |
12285 | one of the items in a sizer change size, or items are added or | |
12286 | removed. | |
12287 | """ | |
54f9ee45 | 12288 | return _core_.Sizer_Layout(*args, **kwargs) |
e811c8ce RD |
12289 | |
12290 | def Fit(*args, **kwargs): | |
248ed943 RD |
12291 | """ |
12292 | Fit(self, Window window) -> Size | |
12293 | ||
12294 | Tell the sizer to resize the *window* to match the sizer's minimal | |
12295 | size. This is commonly done in the constructor of the window itself in | |
12296 | order to set its initial size to match the needs of the children as | |
12297 | determined by the sizer. Returns the new size. | |
12298 | ||
12299 | For a top level window this is the total window size, not the client size. | |
12300 | """ | |
54f9ee45 | 12301 | return _core_.Sizer_Fit(*args, **kwargs) |
e811c8ce RD |
12302 | |
12303 | def FitInside(*args, **kwargs): | |
248ed943 RD |
12304 | """ |
12305 | FitInside(self, Window window) | |
12306 | ||
12307 | Tell the sizer to resize the *virtual size* of the *window* to match the | |
12308 | sizer's minimal size. This will not alter the on screen size of the | |
12309 | window, but may cause the addition/removal/alteration of scrollbars | |
12310 | required to view the virtual area in windows which manage it. | |
12311 | ||
12312 | :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints` | |
12313 | ||
12314 | """ | |
54f9ee45 | 12315 | return _core_.Sizer_FitInside(*args, **kwargs) |
e811c8ce RD |
12316 | |
12317 | def SetSizeHints(*args, **kwargs): | |
248ed943 RD |
12318 | """ |
12319 | SetSizeHints(self, Window window) | |
12320 | ||
12321 | Tell the sizer to set (and `Fit`) the minimal size of the *window* to | |
12322 | match the sizer's minimal size. This is commonly done in the | |
12323 | constructor of the window itself if the window is resizable (as are | |
12324 | many dialogs under Unix and frames on probably all platforms) in order | |
12325 | to prevent the window from being sized smaller than the minimal size | |
12326 | required by the sizer. | |
12327 | """ | |
54f9ee45 | 12328 | return _core_.Sizer_SetSizeHints(*args, **kwargs) |
e811c8ce RD |
12329 | |
12330 | def SetVirtualSizeHints(*args, **kwargs): | |
248ed943 RD |
12331 | """ |
12332 | SetVirtualSizeHints(self, Window window) | |
12333 | ||
12334 | Tell the sizer to set the minimal size of the window virtual area to | |
12335 | match the sizer's minimal size. For windows with managed scrollbars | |
12336 | this will set them appropriately. | |
12337 | ||
12338 | :see: `wx.ScrolledWindow.SetScrollbars` | |
12339 | ||
12340 | """ | |
54f9ee45 | 12341 | return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs) |
e811c8ce RD |
12342 | |
12343 | def Clear(*args, **kwargs): | |
248ed943 RD |
12344 | """ |
12345 | Clear(self, bool deleteWindows=False) | |
12346 | ||
12347 | Clear all items from the sizer, optionally destroying the window items | |
12348 | as well. | |
12349 | """ | |
54f9ee45 | 12350 | return _core_.Sizer_Clear(*args, **kwargs) |
e811c8ce RD |
12351 | |
12352 | def DeleteWindows(*args, **kwargs): | |
248ed943 RD |
12353 | """ |
12354 | DeleteWindows(self) | |
12355 | ||
12356 | Destroy all windows managed by the sizer. | |
12357 | """ | |
54f9ee45 | 12358 | return _core_.Sizer_DeleteWindows(*args, **kwargs) |
e811c8ce RD |
12359 | |
12360 | def GetChildren(*args, **kwargs): | |
248ed943 | 12361 | """ |
51b83b37 | 12362 | GetChildren(self) -> list |
248ed943 RD |
12363 | |
12364 | Returns a list of all the `wx.SizerItem` objects managed by the sizer. | |
12365 | """ | |
54f9ee45 | 12366 | return _core_.Sizer_GetChildren(*args, **kwargs) |
e811c8ce RD |
12367 | |
12368 | def Show(*args, **kwargs): | |
248ed943 | 12369 | """ |
ae8162c8 | 12370 | Show(self, item, bool show=True, bool recursive=false) -> bool |
e811c8ce | 12371 | |
248ed943 RD |
12372 | Shows or hides an item managed by the sizer. To make a sizer item |
12373 | disappear or reappear, use Show followed by `Layout`. The *item* | |
12374 | parameter can be either a window, a sizer, or the zero-based index of | |
7e63a440 RD |
12375 | the item. Use the recursive parameter to show or hide an item in a |
12376 | subsizer. Returns True if the item was found. | |
248ed943 RD |
12377 | """ |
12378 | return _core_.Sizer_Show(*args, **kwargs) | |
e811c8ce RD |
12379 | |
12380 | def IsShown(*args, **kwargs): | |
248ed943 RD |
12381 | """ |
12382 | IsShown(self, item) | |
12383 | ||
b1fcee84 | 12384 | Determines if the item is currently shown. To make a sizer |
248ed943 RD |
12385 | item disappear or reappear, use Show followed by `Layout`. The *item* |
12386 | parameter can be either a window, a sizer, or the zero-based index of | |
12387 | the item. | |
12388 | """ | |
54f9ee45 | 12389 | return _core_.Sizer_IsShown(*args, **kwargs) |
e811c8ce | 12390 | |
7e63a440 | 12391 | def Hide(self, item, recursive=False): |
248ed943 | 12392 | """ |
27fb7603 | 12393 | A convenience method for `Show` (item, False, recursive). |
248ed943 | 12394 | """ |
06759a38 | 12395 | return self.Show(item, False, recursive) |
248ed943 | 12396 | |
e811c8ce | 12397 | def ShowItems(*args, **kwargs): |
248ed943 RD |
12398 | """ |
12399 | ShowItems(self, bool show) | |
12400 | ||
84f85550 | 12401 | Recursively call `wx.SizerItem.Show` on all sizer items. |
248ed943 | 12402 | """ |
54f9ee45 | 12403 | return _core_.Sizer_ShowItems(*args, **kwargs) |
e811c8ce | 12404 | |
33d6fd3b RD |
12405 | Children = property(GetChildren,doc="See `GetChildren`") |
12406 | ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`") | |
12407 | MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`") | |
12408 | Position = property(GetPosition,doc="See `GetPosition`") | |
12409 | Size = property(GetSize,doc="See `GetSize`") | |
2131d850 | 12410 | _core_.Sizer_swigregister(Sizer) |
d14a1e28 RD |
12411 | |
12412 | class PySizer(Sizer): | |
248ed943 RD |
12413 | """ |
12414 | wx.PySizer is a special version of `wx.Sizer` that has been | |
12415 | instrumented to allow the C++ virtual methods to be overloaded in | |
12416 | Python derived classes. You would derive from this class if you are | |
12417 | wanting to implement a custom sizer in Python code. Simply implement | |
12418 | `CalcMin` and `RecalcSizes` in the derived class and you're all set. | |
12419 | For example:: | |
12420 | ||
12421 | class MySizer(wx.PySizer): | |
12422 | def __init__(self): | |
12423 | wx.PySizer.__init__(self) | |
12424 | ||
12425 | def CalcMin(self): | |
12426 | for item in self.GetChildren(): | |
12427 | # calculate the total minimum width and height needed | |
12428 | # by all items in the sizer according to this sizer's | |
12429 | # layout algorithm. | |
12430 | ... | |
12431 | return wx.Size(width, height) | |
12432 | ||
12433 | def RecalcSizes(self): | |
12434 | # find the space allotted to this sizer | |
12435 | pos = self.GetPosition() | |
12436 | size = self.GetSize() | |
12437 | for item in self.GetChildren(): | |
12438 | # Recalculate (if necessary) the position and size of | |
12439 | # each item and then call item.SetDimension to do the | |
12440 | # actual positioning and sizing of the items within the | |
12441 | # space alloted to this sizer. | |
12442 | ... | |
12443 | item.SetDimension(itemPos, itemSize) | |
12444 | ||
12445 | ||
12446 | When `Layout` is called it first calls `CalcMin` followed by | |
12447 | `RecalcSizes` so you can optimize a bit by saving the results of | |
e505d15e | 12448 | `CalcMin` and reusing them in `RecalcSizes`. |
248ed943 RD |
12449 | |
12450 | :see: `wx.SizerItem`, `wx.Sizer.GetChildren` | |
12451 | ||
12452 | ||
12453 | """ | |
0085ce49 RD |
12454 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12455 | __repr__ = _swig_repr | |
12456 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12457 | """ |
12458 | __init__(self) -> PySizer | |
12459 | ||
12460 | Creates a wx.PySizer. Must be called from the __init__ in the derived | |
12461 | class. | |
12462 | """ | |
0085ce49 | 12463 | _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs)) |
c25f90f6 | 12464 | self._setOORInfo(self);PySizer._setCallbackInfo(self, self, PySizer) |
e811c8ce RD |
12465 | |
12466 | def _setCallbackInfo(*args, **kwargs): | |
a95a7133 | 12467 | """_setCallbackInfo(self, PyObject self, PyObject _class)""" |
54f9ee45 | 12468 | return _core_.PySizer__setCallbackInfo(*args, **kwargs) |
e811c8ce | 12469 | |
2131d850 | 12470 | _core_.PySizer_swigregister(PySizer) |
d14a1e28 RD |
12471 | |
12472 | #--------------------------------------------------------------------------- | |
12473 | ||
12474 | class BoxSizer(Sizer): | |
248ed943 RD |
12475 | """ |
12476 | The basic idea behind a box sizer is that windows will most often be | |
12477 | laid out in rather simple basic geometry, typically in a row or a | |
12478 | column or nested hierarchies of either. A wx.BoxSizer will lay out | |
12479 | its items in a simple row or column, depending on the orientation | |
12480 | parameter passed to the constructor. | |
12481 | """ | |
0085ce49 RD |
12482 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12483 | __repr__ = _swig_repr | |
12484 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12485 | """ |
12486 | __init__(self, int orient=HORIZONTAL) -> BoxSizer | |
12487 | ||
12488 | Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL`` | |
12489 | or ``wx.HORIZONTAL`` for creating either a column sizer or a row | |
12490 | sizer. | |
12491 | """ | |
0085ce49 | 12492 | _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs)) |
d14a1e28 | 12493 | self._setOORInfo(self) |
e811c8ce RD |
12494 | |
12495 | def GetOrientation(*args, **kwargs): | |
248ed943 RD |
12496 | """ |
12497 | GetOrientation(self) -> int | |
12498 | ||
12499 | Returns the current orientation of the sizer. | |
12500 | """ | |
54f9ee45 | 12501 | return _core_.BoxSizer_GetOrientation(*args, **kwargs) |
e811c8ce RD |
12502 | |
12503 | def SetOrientation(*args, **kwargs): | |
248ed943 RD |
12504 | """ |
12505 | SetOrientation(self, int orient) | |
e811c8ce | 12506 | |
248ed943 RD |
12507 | Resets the orientation of the sizer. |
12508 | """ | |
12509 | return _core_.BoxSizer_SetOrientation(*args, **kwargs) | |
e811c8ce | 12510 | |
2bf58437 | 12511 | Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`") |
2131d850 | 12512 | _core_.BoxSizer_swigregister(BoxSizer) |
d14a1e28 RD |
12513 | |
12514 | #--------------------------------------------------------------------------- | |
12515 | ||
12516 | class StaticBoxSizer(BoxSizer): | |
248ed943 RD |
12517 | """ |
12518 | wx.StaticBoxSizer derives from and functions identically to the | |
12519 | `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer | |
12520 | manages. Note that this static box must be created separately and | |
12521 | passed to the sizer constructor. | |
12522 | """ | |
0085ce49 RD |
12523 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12524 | __repr__ = _swig_repr | |
12525 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12526 | """ |
12527 | __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer | |
12528 | ||
12529 | Constructor. It takes an associated static box and the orientation | |
12530 | *orient* as parameters - orient can be either of ``wx.VERTICAL`` or | |
12531 | ``wx.HORIZONTAL``. | |
12532 | """ | |
0085ce49 | 12533 | _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs)) |
d14a1e28 | 12534 | self._setOORInfo(self) |
e811c8ce RD |
12535 | |
12536 | def GetStaticBox(*args, **kwargs): | |
248ed943 RD |
12537 | """ |
12538 | GetStaticBox(self) -> StaticBox | |
e811c8ce | 12539 | |
248ed943 RD |
12540 | Returns the static box associated with this sizer. |
12541 | """ | |
12542 | return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs) | |
e811c8ce | 12543 | |
33d6fd3b | 12544 | StaticBox = property(GetStaticBox,doc="See `GetStaticBox`") |
2131d850 | 12545 | _core_.StaticBoxSizer_swigregister(StaticBoxSizer) |
d14a1e28 RD |
12546 | |
12547 | #--------------------------------------------------------------------------- | |
12548 | ||
12549 | class GridSizer(Sizer): | |
248ed943 RD |
12550 | """ |
12551 | A grid sizer is a sizer which lays out its children in a | |
12552 | two-dimensional table with all cells having the same size. In other | |
12553 | words, the width of each cell within the grid is the width of the | |
12554 | widest item added to the sizer and the height of each grid cell is the | |
12555 | height of the tallest item. An optional vertical and/or horizontal | |
12556 | gap between items can also be specified (in pixels.) | |
12557 | ||
12558 | Items are placed in the cells of the grid in the order they are added, | |
12559 | in row-major order. In other words, the first row is filled first, | |
12560 | then the second, and so on until all items have been added. (If | |
12561 | neccessary, additional rows will be added as items are added.) If you | |
12562 | need to have greater control over the cells that items are placed in | |
12563 | then use the `wx.GridBagSizer`. | |
12564 | ||
12565 | """ | |
0085ce49 RD |
12566 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12567 | __repr__ = _swig_repr | |
12568 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12569 | """ |
12570 | __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer | |
12571 | ||
12572 | Constructor for a wx.GridSizer. *rows* and *cols* determine the number | |
12573 | of columns and rows in the sizer - if either of the parameters is | |
12574 | zero, it will be calculated to from the total number of children in | |
12575 | the sizer, thus making the sizer grow dynamically. *vgap* and *hgap* | |
12576 | define extra space between all children. | |
12577 | """ | |
0085ce49 | 12578 | _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs)) |
d14a1e28 | 12579 | self._setOORInfo(self) |
e811c8ce | 12580 | |
e811c8ce | 12581 | def SetCols(*args, **kwargs): |
248ed943 RD |
12582 | """ |
12583 | SetCols(self, int cols) | |
12584 | ||
12585 | Sets the number of columns in the sizer. | |
12586 | """ | |
54f9ee45 | 12587 | return _core_.GridSizer_SetCols(*args, **kwargs) |
e811c8ce RD |
12588 | |
12589 | def SetRows(*args, **kwargs): | |
248ed943 RD |
12590 | """ |
12591 | SetRows(self, int rows) | |
12592 | ||
12593 | Sets the number of rows in the sizer. | |
12594 | """ | |
54f9ee45 | 12595 | return _core_.GridSizer_SetRows(*args, **kwargs) |
e811c8ce RD |
12596 | |
12597 | def SetVGap(*args, **kwargs): | |
248ed943 RD |
12598 | """ |
12599 | SetVGap(self, int gap) | |
12600 | ||
12601 | Sets the vertical gap (in pixels) between the cells in the sizer. | |
12602 | """ | |
54f9ee45 | 12603 | return _core_.GridSizer_SetVGap(*args, **kwargs) |
e811c8ce RD |
12604 | |
12605 | def SetHGap(*args, **kwargs): | |
248ed943 RD |
12606 | """ |
12607 | SetHGap(self, int gap) | |
12608 | ||
12609 | Sets the horizontal gap (in pixels) between cells in the sizer | |
12610 | """ | |
54f9ee45 | 12611 | return _core_.GridSizer_SetHGap(*args, **kwargs) |
e811c8ce RD |
12612 | |
12613 | def GetCols(*args, **kwargs): | |
248ed943 RD |
12614 | """ |
12615 | GetCols(self) -> int | |
12616 | ||
12617 | Returns the number of columns in the sizer. | |
12618 | """ | |
54f9ee45 | 12619 | return _core_.GridSizer_GetCols(*args, **kwargs) |
e811c8ce RD |
12620 | |
12621 | def GetRows(*args, **kwargs): | |
248ed943 RD |
12622 | """ |
12623 | GetRows(self) -> int | |
12624 | ||
12625 | Returns the number of rows in the sizer. | |
12626 | """ | |
54f9ee45 | 12627 | return _core_.GridSizer_GetRows(*args, **kwargs) |
e811c8ce RD |
12628 | |
12629 | def GetVGap(*args, **kwargs): | |
248ed943 RD |
12630 | """ |
12631 | GetVGap(self) -> int | |
12632 | ||
12633 | Returns the vertical gap (in pixels) between the cells in the sizer. | |
12634 | """ | |
54f9ee45 | 12635 | return _core_.GridSizer_GetVGap(*args, **kwargs) |
e811c8ce RD |
12636 | |
12637 | def GetHGap(*args, **kwargs): | |
248ed943 RD |
12638 | """ |
12639 | GetHGap(self) -> int | |
12640 | ||
12641 | Returns the horizontal gap (in pixels) between cells in the sizer. | |
12642 | """ | |
54f9ee45 | 12643 | return _core_.GridSizer_GetHGap(*args, **kwargs) |
e811c8ce | 12644 | |
0085ce49 RD |
12645 | def CalcRowsCols(self): |
12646 | """ | |
12647 | CalcRowsCols() -> (rows, cols) | |
12648 | ||
12649 | Calculates how many rows and columns will be in the sizer based | |
12650 | on the current number of items and also the rows, cols specified | |
12651 | in the constructor. | |
12652 | """ | |
12653 | nitems = len(self.GetChildren()) | |
12654 | rows = self.GetRows() | |
12655 | cols = self.GetCols() | |
12656 | assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed" | |
12657 | if cols != 0: | |
12658 | rows = (nitems + cols - 1) / cols | |
12659 | elif rows != 0: | |
12660 | cols = (nitems + rows - 1) / rows | |
12661 | return (rows, cols) | |
d14a1e28 | 12662 | |
97ab0f6a RD |
12663 | Cols = property(GetCols,SetCols,doc="See `GetCols` and `SetCols`") |
12664 | HGap = property(GetHGap,SetHGap,doc="See `GetHGap` and `SetHGap`") | |
12665 | Rows = property(GetRows,SetRows,doc="See `GetRows` and `SetRows`") | |
12666 | VGap = property(GetVGap,SetVGap,doc="See `GetVGap` and `SetVGap`") | |
2131d850 | 12667 | _core_.GridSizer_swigregister(GridSizer) |
d14a1e28 RD |
12668 | |
12669 | #--------------------------------------------------------------------------- | |
12670 | ||
54f9ee45 RD |
12671 | FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE |
12672 | FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED | |
12673 | FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL | |
d14a1e28 | 12674 | class FlexGridSizer(GridSizer): |
248ed943 RD |
12675 | """ |
12676 | A flex grid sizer is a sizer which lays out its children in a | |
12677 | two-dimensional table with all table cells in one row having the same | |
12678 | height and all cells in one column having the same width, but all | |
12679 | rows or all columns are not necessarily the same height or width as in | |
12680 | the `wx.GridSizer`. | |
12681 | ||
12682 | wx.FlexGridSizer can also size items equally in one direction but | |
12683 | unequally ("flexibly") in the other. If the sizer is only flexible | |
12684 | in one direction (this can be changed using `SetFlexibleDirection`), it | |
12685 | needs to be decided how the sizer should grow in the other ("non | |
12686 | flexible") direction in order to fill the available space. The | |
12687 | `SetNonFlexibleGrowMode` method serves this purpose. | |
12688 | ||
12689 | ||
12690 | """ | |
0085ce49 RD |
12691 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12692 | __repr__ = _swig_repr | |
12693 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12694 | """ |
12695 | __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer | |
12696 | ||
12697 | Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the | |
12698 | number of columns and rows in the sizer - if either of the parameters | |
12699 | is zero, it will be calculated to from the total number of children in | |
12700 | the sizer, thus making the sizer grow dynamically. *vgap* and *hgap* | |
12701 | define extra space between all children. | |
12702 | """ | |
0085ce49 | 12703 | _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs)) |
d14a1e28 | 12704 | self._setOORInfo(self) |
e811c8ce | 12705 | |
248ed943 RD |
12706 | def AddGrowableRow(*args, **kwargs): |
12707 | """ | |
12708 | AddGrowableRow(self, size_t idx, int proportion=0) | |
e811c8ce | 12709 | |
248ed943 RD |
12710 | Specifies that row *idx* (starting from zero) should be grown if there |
12711 | is extra space available to the sizer. | |
e811c8ce | 12712 | |
248ed943 RD |
12713 | The *proportion* parameter has the same meaning as the stretch factor |
12714 | for the box sizers except that if all proportions are 0, then all | |
12715 | columns are resized equally (instead of not being resized at all). | |
12716 | """ | |
54f9ee45 | 12717 | return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs) |
e811c8ce RD |
12718 | |
12719 | def RemoveGrowableRow(*args, **kwargs): | |
248ed943 RD |
12720 | """ |
12721 | RemoveGrowableRow(self, size_t idx) | |
12722 | ||
12723 | Specifies that row *idx* is no longer growable. | |
12724 | """ | |
54f9ee45 | 12725 | return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs) |
e811c8ce RD |
12726 | |
12727 | def AddGrowableCol(*args, **kwargs): | |
248ed943 RD |
12728 | """ |
12729 | AddGrowableCol(self, size_t idx, int proportion=0) | |
12730 | ||
12731 | Specifies that column *idx* (starting from zero) should be grown if | |
12732 | there is extra space available to the sizer. | |
12733 | ||
12734 | The *proportion* parameter has the same meaning as the stretch factor | |
12735 | for the box sizers except that if all proportions are 0, then all | |
12736 | columns are resized equally (instead of not being resized at all). | |
12737 | """ | |
54f9ee45 | 12738 | return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs) |
e811c8ce RD |
12739 | |
12740 | def RemoveGrowableCol(*args, **kwargs): | |
248ed943 RD |
12741 | """ |
12742 | RemoveGrowableCol(self, size_t idx) | |
12743 | ||
12744 | Specifies that column *idx* is no longer growable. | |
12745 | """ | |
54f9ee45 | 12746 | return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs) |
e811c8ce RD |
12747 | |
12748 | def SetFlexibleDirection(*args, **kwargs): | |
248ed943 RD |
12749 | """ |
12750 | SetFlexibleDirection(self, int direction) | |
12751 | ||
12752 | Specifies whether the sizer should flexibly resize its columns, rows, | |
12753 | or both. Argument *direction* can be one of the following values. Any | |
12754 | other value is ignored. | |
12755 | ||
12756 | ============== ======================================= | |
12757 | wx.VERTICAL Rows are flexibly sized. | |
12758 | wx.HORIZONTAL Columns are flexibly sized. | |
12759 | wx.BOTH Both rows and columns are flexibly sized | |
12760 | (this is the default value). | |
12761 | ============== ======================================= | |
12762 | ||
12763 | Note that this method does not trigger relayout. | |
12764 | ||
12765 | """ | |
54f9ee45 | 12766 | return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs) |
e811c8ce RD |
12767 | |
12768 | def GetFlexibleDirection(*args, **kwargs): | |
248ed943 RD |
12769 | """ |
12770 | GetFlexibleDirection(self) -> int | |
12771 | ||
12772 | Returns a value that specifies whether the sizer | |
12773 | flexibly resizes its columns, rows, or both (default). | |
12774 | ||
12775 | :see: `SetFlexibleDirection` | |
12776 | """ | |
54f9ee45 | 12777 | return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs) |
e811c8ce RD |
12778 | |
12779 | def SetNonFlexibleGrowMode(*args, **kwargs): | |
248ed943 RD |
12780 | """ |
12781 | SetNonFlexibleGrowMode(self, int mode) | |
12782 | ||
12783 | Specifies how the sizer should grow in the non-flexible direction if | |
12784 | there is one (so `SetFlexibleDirection` must have been called | |
12785 | previously). Argument *mode* can be one of the following values: | |
12786 | ||
12787 | ========================== ================================================= | |
12788 | wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction. | |
12789 | wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with | |
12790 | `AddGrowableCol` and `AddGrowableRow`. In this | |
12791 | case equal sizing applies to minimum sizes of | |
12792 | columns or rows (this is the default value). | |
12793 | wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in | |
12794 | the non flexible direction, whether they are | |
12795 | growable or not in the flexbile direction. | |
12796 | ========================== ================================================= | |
12797 | ||
12798 | Note that this method does not trigger relayout. | |
248ed943 | 12799 | """ |
54f9ee45 | 12800 | return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs) |
e811c8ce RD |
12801 | |
12802 | def GetNonFlexibleGrowMode(*args, **kwargs): | |
248ed943 RD |
12803 | """ |
12804 | GetNonFlexibleGrowMode(self) -> int | |
12805 | ||
12806 | Returns the value that specifies how the sizer grows in the | |
12807 | non-flexible direction if there is one. | |
12808 | ||
12809 | :see: `SetNonFlexibleGrowMode` | |
12810 | """ | |
54f9ee45 | 12811 | return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs) |
e811c8ce RD |
12812 | |
12813 | def GetRowHeights(*args, **kwargs): | |
fd2dc343 RD |
12814 | """ |
12815 | GetRowHeights(self) -> list | |
12816 | ||
12817 | Returns a list of integers representing the heights of each of the | |
12818 | rows in the sizer. | |
12819 | """ | |
54f9ee45 | 12820 | return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs) |
e811c8ce RD |
12821 | |
12822 | def GetColWidths(*args, **kwargs): | |
fd2dc343 RD |
12823 | """ |
12824 | GetColWidths(self) -> list | |
12825 | ||
12826 | Returns a list of integers representing the widths of each of the | |
12827 | columns in the sizer. | |
12828 | """ | |
54f9ee45 | 12829 | return _core_.FlexGridSizer_GetColWidths(*args, **kwargs) |
e811c8ce | 12830 | |
97ab0f6a RD |
12831 | ColWidths = property(GetColWidths,doc="See `GetColWidths`") |
12832 | FlexibleDirection = property(GetFlexibleDirection,SetFlexibleDirection,doc="See `GetFlexibleDirection` and `SetFlexibleDirection`") | |
12833 | NonFlexibleGrowMode = property(GetNonFlexibleGrowMode,SetNonFlexibleGrowMode,doc="See `GetNonFlexibleGrowMode` and `SetNonFlexibleGrowMode`") | |
12834 | RowHeights = property(GetRowHeights,doc="See `GetRowHeights`") | |
2131d850 | 12835 | _core_.FlexGridSizer_swigregister(FlexGridSizer) |
d14a1e28 | 12836 | |
e505d15e RD |
12837 | class StdDialogButtonSizer(BoxSizer): |
12838 | """ | |
12839 | A special sizer that knows how to order and position standard buttons | |
12840 | in order to conform to the current platform's standards. You simply | |
12841 | need to add each `wx.Button` to the sizer, and be sure to create the | |
53aa7709 | 12842 | buttons using the standard ID's. Then call `Realize` and the sizer |
e505d15e RD |
12843 | will take care of the rest. |
12844 | ||
12845 | """ | |
0085ce49 RD |
12846 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12847 | __repr__ = _swig_repr | |
12848 | def __init__(self, *args, **kwargs): | |
e505d15e | 12849 | """__init__(self) -> StdDialogButtonSizer""" |
0085ce49 | 12850 | _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs)) |
e505d15e RD |
12851 | def AddButton(*args, **kwargs): |
12852 | """ | |
12853 | AddButton(self, wxButton button) | |
12854 | ||
12855 | Use this to add the buttons to this sizer. Do not use the `Add` | |
12856 | method in the base class. | |
12857 | """ | |
12858 | return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs) | |
12859 | ||
53aa7709 | 12860 | def Realize(*args, **kwargs): |
e505d15e | 12861 | """ |
53aa7709 | 12862 | Realize(self) |
e505d15e RD |
12863 | |
12864 | This funciton needs to be called after all the buttons have been added | |
12865 | to the sizer. It will reorder them and position them in a platform | |
12866 | specifc manner. | |
12867 | """ | |
53aa7709 | 12868 | return _core_.StdDialogButtonSizer_Realize(*args, **kwargs) |
51b83b37 RD |
12869 | |
12870 | def SetAffirmativeButton(*args, **kwargs): | |
12871 | """SetAffirmativeButton(self, wxButton button)""" | |
12872 | return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs) | |
12873 | ||
12874 | def SetNegativeButton(*args, **kwargs): | |
12875 | """SetNegativeButton(self, wxButton button)""" | |
12876 | return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs) | |
12877 | ||
12878 | def SetCancelButton(*args, **kwargs): | |
12879 | """SetCancelButton(self, wxButton button)""" | |
12880 | return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs) | |
e505d15e RD |
12881 | |
12882 | def GetAffirmativeButton(*args, **kwargs): | |
12883 | """GetAffirmativeButton(self) -> wxButton""" | |
12884 | return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs) | |
12885 | ||
12886 | def GetApplyButton(*args, **kwargs): | |
12887 | """GetApplyButton(self) -> wxButton""" | |
12888 | return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs) | |
12889 | ||
12890 | def GetNegativeButton(*args, **kwargs): | |
12891 | """GetNegativeButton(self) -> wxButton""" | |
12892 | return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs) | |
12893 | ||
12894 | def GetCancelButton(*args, **kwargs): | |
12895 | """GetCancelButton(self) -> wxButton""" | |
12896 | return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs) | |
12897 | ||
12898 | def GetHelpButton(*args, **kwargs): | |
12899 | """GetHelpButton(self) -> wxButton""" | |
12900 | return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs) | |
12901 | ||
33d6fd3b RD |
12902 | AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`") |
12903 | ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`") | |
12904 | CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`") | |
12905 | HelpButton = property(GetHelpButton,doc="See `GetHelpButton`") | |
12906 | NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`") | |
2131d850 | 12907 | _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer) |
e505d15e | 12908 | |
d14a1e28 RD |
12909 | #--------------------------------------------------------------------------- |
12910 | ||
12911 | class GBPosition(object): | |
248ed943 RD |
12912 | """ |
12913 | This class represents the position of an item in a virtual grid of | |
12914 | rows and columns managed by a `wx.GridBagSizer`. wxPython has | |
12915 | typemaps that will automatically convert from a 2-element sequence of | |
12916 | integers to a wx.GBPosition, so you can use the more pythonic | |
12917 | representation of the position nearly transparently in Python code. | |
12918 | """ | |
0085ce49 RD |
12919 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12920 | __repr__ = _swig_repr | |
12921 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12922 | """ |
12923 | __init__(self, int row=0, int col=0) -> GBPosition | |
12924 | ||
12925 | This class represents the position of an item in a virtual grid of | |
12926 | rows and columns managed by a `wx.GridBagSizer`. wxPython has | |
12927 | typemaps that will automatically convert from a 2-element sequence of | |
12928 | integers to a wx.GBPosition, so you can use the more pythonic | |
12929 | representation of the position nearly transparently in Python code. | |
12930 | """ | |
0085ce49 RD |
12931 | _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs)) |
12932 | __swig_destroy__ = _core_.delete_GBPosition | |
12933 | __del__ = lambda self : None; | |
e811c8ce | 12934 | def GetRow(*args, **kwargs): |
a95a7133 | 12935 | """GetRow(self) -> int""" |
54f9ee45 | 12936 | return _core_.GBPosition_GetRow(*args, **kwargs) |
e811c8ce RD |
12937 | |
12938 | def GetCol(*args, **kwargs): | |
a95a7133 | 12939 | """GetCol(self) -> int""" |
54f9ee45 | 12940 | return _core_.GBPosition_GetCol(*args, **kwargs) |
e811c8ce RD |
12941 | |
12942 | def SetRow(*args, **kwargs): | |
a95a7133 | 12943 | """SetRow(self, int row)""" |
54f9ee45 | 12944 | return _core_.GBPosition_SetRow(*args, **kwargs) |
e811c8ce RD |
12945 | |
12946 | def SetCol(*args, **kwargs): | |
a95a7133 | 12947 | """SetCol(self, int col)""" |
54f9ee45 | 12948 | return _core_.GBPosition_SetCol(*args, **kwargs) |
e811c8ce RD |
12949 | |
12950 | def __eq__(*args, **kwargs): | |
e9d6f3a4 RD |
12951 | """ |
12952 | __eq__(self, PyObject other) -> bool | |
12953 | ||
12954 | Compare GBPosition for equality. | |
12955 | """ | |
54f9ee45 | 12956 | return _core_.GBPosition___eq__(*args, **kwargs) |
e811c8ce RD |
12957 | |
12958 | def __ne__(*args, **kwargs): | |
e9d6f3a4 RD |
12959 | """ |
12960 | __ne__(self, PyObject other) -> bool | |
12961 | ||
12962 | Compare GBPosition for inequality. | |
12963 | """ | |
54f9ee45 | 12964 | return _core_.GBPosition___ne__(*args, **kwargs) |
e811c8ce RD |
12965 | |
12966 | def Set(*args, **kwargs): | |
a95a7133 | 12967 | """Set(self, int row=0, int col=0)""" |
54f9ee45 | 12968 | return _core_.GBPosition_Set(*args, **kwargs) |
e811c8ce RD |
12969 | |
12970 | def Get(*args, **kwargs): | |
a95a7133 | 12971 | """Get(self) -> PyObject""" |
54f9ee45 | 12972 | return _core_.GBPosition_Get(*args, **kwargs) |
e811c8ce | 12973 | |
41e2b43e | 12974 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
12975 | def __str__(self): return str(self.Get()) |
12976 | def __repr__(self): return 'wx.GBPosition'+str(self.Get()) | |
12977 | def __len__(self): return len(self.Get()) | |
12978 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
12979 | def __setitem__(self, index, val): |
12980 | if index == 0: self.SetRow(val) | |
12981 | elif index == 1: self.SetCol(val) | |
12982 | else: raise IndexError | |
e811c8ce | 12983 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
12984 | __safe_for_unpickling__ = True |
12985 | def __reduce__(self): return (wx.GBPosition, self.Get()) | |
d14a1e28 RD |
12986 | |
12987 | row = property(GetRow, SetRow) | |
12988 | col = property(GetCol, SetCol) | |
12989 | ||
2131d850 | 12990 | _core_.GBPosition_swigregister(GBPosition) |
d14a1e28 RD |
12991 | |
12992 | class GBSpan(object): | |
248ed943 RD |
12993 | """ |
12994 | This class is used to hold the row and column spanning attributes of | |
12995 | items in a `wx.GridBagSizer`. wxPython has typemaps that will | |
12996 | automatically convert from a 2-element sequence of integers to a | |
12997 | wx.GBSpan, so you can use the more pythonic representation of the span | |
12998 | nearly transparently in Python code. | |
12999 | ||
13000 | """ | |
0085ce49 RD |
13001 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
13002 | __repr__ = _swig_repr | |
13003 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
13004 | """ |
13005 | __init__(self, int rowspan=1, int colspan=1) -> GBSpan | |
13006 | ||
13007 | Construct a new wxGBSpan, optionally setting the rowspan and | |
13008 | colspan. The default is (1,1). (Meaning that the item occupies one | |
13009 | cell in each direction. | |
13010 | """ | |
0085ce49 RD |
13011 | _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs)) |
13012 | __swig_destroy__ = _core_.delete_GBSpan | |
13013 | __del__ = lambda self : None; | |
e811c8ce | 13014 | def GetRowspan(*args, **kwargs): |
a95a7133 | 13015 | """GetRowspan(self) -> int""" |
54f9ee45 | 13016 | return _core_.GBSpan_GetRowspan(*args, **kwargs) |
e811c8ce RD |
13017 | |
13018 | def GetColspan(*args, **kwargs): | |
a95a7133 | 13019 | """GetColspan(self) -> int""" |
54f9ee45 | 13020 | return _core_.GBSpan_GetColspan(*args, **kwargs) |
e811c8ce RD |
13021 | |
13022 | def SetRowspan(*args, **kwargs): | |
a95a7133 | 13023 | """SetRowspan(self, int rowspan)""" |
54f9ee45 | 13024 | return _core_.GBSpan_SetRowspan(*args, **kwargs) |
e811c8ce RD |
13025 | |
13026 | def SetColspan(*args, **kwargs): | |
a95a7133 | 13027 | """SetColspan(self, int colspan)""" |
54f9ee45 | 13028 | return _core_.GBSpan_SetColspan(*args, **kwargs) |
e811c8ce RD |
13029 | |
13030 | def __eq__(*args, **kwargs): | |
e9d6f3a4 RD |
13031 | """ |
13032 | __eq__(self, PyObject other) -> bool | |
13033 | ||
13034 | Compare wxGBSpan for equality. | |
13035 | """ | |
54f9ee45 | 13036 | return _core_.GBSpan___eq__(*args, **kwargs) |
e811c8ce RD |
13037 | |
13038 | def __ne__(*args, **kwargs): | |
e9d6f3a4 RD |
13039 | """ |
13040 | __ne__(self, PyObject other) -> bool | |
13041 | ||
13042 | Compare GBSpan for inequality. | |
13043 | """ | |
54f9ee45 | 13044 | return _core_.GBSpan___ne__(*args, **kwargs) |
e811c8ce RD |
13045 | |
13046 | def Set(*args, **kwargs): | |
a95a7133 | 13047 | """Set(self, int rowspan=1, int colspan=1)""" |
54f9ee45 | 13048 | return _core_.GBSpan_Set(*args, **kwargs) |
e811c8ce RD |
13049 | |
13050 | def Get(*args, **kwargs): | |
a95a7133 | 13051 | """Get(self) -> PyObject""" |
54f9ee45 | 13052 | return _core_.GBSpan_Get(*args, **kwargs) |
e811c8ce | 13053 | |
41e2b43e | 13054 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
13055 | def __str__(self): return str(self.Get()) |
13056 | def __repr__(self): return 'wx.GBSpan'+str(self.Get()) | |
13057 | def __len__(self): return len(self.Get()) | |
13058 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
13059 | def __setitem__(self, index, val): |
13060 | if index == 0: self.SetRowspan(val) | |
13061 | elif index == 1: self.SetColspan(val) | |
13062 | else: raise IndexError | |
e811c8ce | 13063 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
13064 | __safe_for_unpickling__ = True |
13065 | def __reduce__(self): return (wx.GBSpan, self.Get()) | |
d14a1e28 RD |
13066 | |
13067 | rowspan = property(GetRowspan, SetRowspan) | |
13068 | colspan = property(GetColspan, SetColspan) | |
13069 | ||
2131d850 | 13070 | _core_.GBSpan_swigregister(GBSpan) |
d14a1e28 RD |
13071 | |
13072 | class GBSizerItem(SizerItem): | |
248ed943 RD |
13073 | """ |
13074 | The wx.GBSizerItem class is used to track the additional data about | |
13075 | items in a `wx.GridBagSizer` such as the item's position in the grid | |
13076 | and how many rows or columns it spans. | |
13077 | ||
13078 | """ | |
0085ce49 RD |
13079 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
13080 | __repr__ = _swig_repr | |
13081 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
13082 | """ |
13083 | __init__(self) -> GBSizerItem | |
13084 | ||
13085 | Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer | |
13086 | size will need to be set, as well as a position and span before this | |
13087 | item can be used in a Sizer. | |
13088 | ||
13089 | You will probably never need to create a wx.GBSizerItem directly as they | |
13090 | are created automatically when the sizer's Add method is called. | |
13091 | """ | |
0085ce49 RD |
13092 | _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs)) |
13093 | __swig_destroy__ = _core_.delete_GBSizerItem | |
13094 | __del__ = lambda self : None; | |
e811c8ce | 13095 | def GetPos(*args, **kwargs): |
248ed943 RD |
13096 | """ |
13097 | GetPos(self) -> GBPosition | |
13098 | ||
13099 | Get the grid position of the item | |
13100 | """ | |
54f9ee45 | 13101 | return _core_.GBSizerItem_GetPos(*args, **kwargs) |
e811c8ce RD |
13102 | |
13103 | def GetPosTuple(self): return self.GetPos().Get() | |
13104 | def GetSpan(*args, **kwargs): | |
248ed943 RD |
13105 | """ |
13106 | GetSpan(self) -> GBSpan | |
13107 | ||
13108 | Get the row and column spanning of the item | |
13109 | """ | |
54f9ee45 | 13110 | return _core_.GBSizerItem_GetSpan(*args, **kwargs) |
e811c8ce RD |
13111 | |
13112 | def GetSpanTuple(self): return self.GetSpan().Get() | |
13113 | def SetPos(*args, **kwargs): | |
248ed943 RD |
13114 | """ |
13115 | SetPos(self, GBPosition pos) -> bool | |
13116 | ||
13117 | If the item is already a member of a sizer then first ensure that | |
13118 | there is no other item that would intersect with this one at the new | |
13119 | position, then set the new position. Returns True if the change is | |
13120 | successful and after the next Layout() the item will be moved. | |
13121 | """ | |
54f9ee45 | 13122 | return _core_.GBSizerItem_SetPos(*args, **kwargs) |
e811c8ce RD |
13123 | |
13124 | def SetSpan(*args, **kwargs): | |
248ed943 RD |
13125 | """ |
13126 | SetSpan(self, GBSpan span) -> bool | |
13127 | ||
13128 | If the item is already a member of a sizer then first ensure that | |
13129 | there is no other item that would intersect with this one with its new | |
13130 | spanning size, then set the new spanning. Returns True if the change | |
13131 | is successful and after the next Layout() the item will be resized. | |
13132 | ||
13133 | """ | |
54f9ee45 | 13134 | return _core_.GBSizerItem_SetSpan(*args, **kwargs) |
e811c8ce | 13135 | |
248ed943 | 13136 | def Intersects(*args, **kwargs): |
0df68c9f | 13137 | """ |
a95a7133 | 13138 | Intersects(self, GBSizerItem other) -> bool |
248ed943 RD |
13139 | |
13140 | Returns True if this item and the other item instersect. | |
0df68c9f | 13141 | """ |
248ed943 RD |
13142 | return _core_.GBSizerItem_Intersects(*args, **kwargs) |
13143 | ||
13144 | def IntersectsPos(*args, **kwargs): | |
13145 | """ | |
13146 | IntersectsPos(self, GBPosition pos, GBSpan span) -> bool | |
13147 | ||
13148 | Returns True if the given pos/span would intersect with this item. | |
13149 | """ | |
13150 | return _core_.GBSizerItem_IntersectsPos(*args, **kwargs) | |
e811c8ce RD |
13151 | |
13152 | def GetEndPos(*args, **kwargs): | |
248ed943 RD |
13153 | """ |
13154 | GetEndPos(self) -> GBPosition | |
13155 | ||
13156 | Get the row and column of the endpoint of this item. | |
13157 | """ | |
54f9ee45 | 13158 | return _core_.GBSizerItem_GetEndPos(*args, **kwargs) |
e811c8ce RD |
13159 | |
13160 | def GetGBSizer(*args, **kwargs): | |
248ed943 RD |
13161 | """ |
13162 | GetGBSizer(self) -> GridBagSizer | |
13163 | ||
13164 | Get the sizer this item is a member of. | |
13165 | """ | |
54f9ee45 | 13166 | return _core_.GBSizerItem_GetGBSizer(*args, **kwargs) |
e811c8ce RD |
13167 | |
13168 | def SetGBSizer(*args, **kwargs): | |
248ed943 RD |
13169 | """ |
13170 | SetGBSizer(self, GridBagSizer sizer) | |
13171 | ||
13172 | Set the sizer this item is a member of. | |
13173 | """ | |
54f9ee45 | 13174 | return _core_.GBSizerItem_SetGBSizer(*args, **kwargs) |
e811c8ce | 13175 | |
97ab0f6a RD |
13176 | EndPos = property(GetEndPos,doc="See `GetEndPos`") |
13177 | GBSizer = property(GetGBSizer,SetGBSizer,doc="See `GetGBSizer` and `SetGBSizer`") | |
13178 | Pos = property(GetPos,SetPos,doc="See `GetPos` and `SetPos`") | |
13179 | Span = property(GetSpan,SetSpan,doc="See `GetSpan` and `SetSpan`") | |
2131d850 | 13180 | _core_.GBSizerItem_swigregister(GBSizerItem) |
d14a1e28 RD |
13181 | DefaultSpan = cvar.DefaultSpan |
13182 | ||
13183 | def GBSizerItemWindow(*args, **kwargs): | |
0df68c9f RD |
13184 | """ |
13185 | GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag, | |
248ed943 RD |
13186 | int border, PyObject userData=None) -> GBSizerItem |
13187 | ||
13188 | Construct a `wx.GBSizerItem` for a window. | |
0df68c9f | 13189 | """ |
54f9ee45 | 13190 | val = _core_.new_GBSizerItemWindow(*args, **kwargs) |
d14a1e28 RD |
13191 | return val |
13192 | ||
13193 | def GBSizerItemSizer(*args, **kwargs): | |
0df68c9f RD |
13194 | """ |
13195 | GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, | |
248ed943 RD |
13196 | int border, PyObject userData=None) -> GBSizerItem |
13197 | ||
13198 | Construct a `wx.GBSizerItem` for a sizer | |
0df68c9f | 13199 | """ |
54f9ee45 | 13200 | val = _core_.new_GBSizerItemSizer(*args, **kwargs) |
d14a1e28 RD |
13201 | return val |
13202 | ||
13203 | def GBSizerItemSpacer(*args, **kwargs): | |
0df68c9f RD |
13204 | """ |
13205 | GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span, | |
248ed943 RD |
13206 | int flag, int border, PyObject userData=None) -> GBSizerItem |
13207 | ||
13208 | Construct a `wx.GBSizerItem` for a spacer. | |
0df68c9f | 13209 | """ |
54f9ee45 | 13210 | val = _core_.new_GBSizerItemSpacer(*args, **kwargs) |
d14a1e28 RD |
13211 | return val |
13212 | ||
13213 | class GridBagSizer(FlexGridSizer): | |
248ed943 RD |
13214 | """ |
13215 | A `wx.Sizer` that can lay out items in a virtual grid like a | |
13216 | `wx.FlexGridSizer` but in this case explicit positioning of the items | |
13217 | is allowed using `wx.GBPosition`, and items can optionally span more | |
13218 | than one row and/or column using `wx.GBSpan`. The total size of the | |
13219 | virtual grid is determined by the largest row and column that items are | |
13220 | positioned at, adjusted for spanning. | |
13221 | ||
13222 | """ | |
0085ce49 RD |
13223 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
13224 | __repr__ = _swig_repr | |
13225 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
13226 | """ |
13227 | __init__(self, int vgap=0, int hgap=0) -> GridBagSizer | |
13228 | ||
13229 | Constructor, with optional parameters to specify the gap between the | |
13230 | rows and columns. | |
13231 | """ | |
0085ce49 | 13232 | _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs)) |
1823fbb4 RD |
13233 | self._setOORInfo(self) |
13234 | ||
e811c8ce | 13235 | def Add(*args, **kwargs): |
0df68c9f | 13236 | """ |
248ed943 | 13237 | Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0, |
d3b6e4ff | 13238 | int border=0, userData=None) -> wx.GBSizerItem |
248ed943 RD |
13239 | |
13240 | Adds an item to the sizer at the grid cell *pos*, optionally spanning | |
13241 | more than one row or column as specified with *span*. The remaining | |
13242 | args behave similarly to `wx.Sizer.Add`. | |
13243 | ||
13244 | Returns True if the item was successfully placed at the given cell | |
13245 | position, False if something was already there. | |
13246 | ||
0df68c9f | 13247 | """ |
54f9ee45 | 13248 | return _core_.GridBagSizer_Add(*args, **kwargs) |
e811c8ce RD |
13249 | |
13250 | def AddItem(*args, **kwargs): | |
248ed943 | 13251 | """ |
d3b6e4ff | 13252 | Add(self, GBSizerItem item) -> wx.GBSizerItem |
248ed943 RD |
13253 | |
13254 | Add an item to the sizer using a `wx.GBSizerItem`. Returns True if | |
13255 | the item was successfully placed at its given cell position, False if | |
13256 | something was already there. | |
13257 | """ | |
54f9ee45 | 13258 | return _core_.GridBagSizer_AddItem(*args, **kwargs) |
e811c8ce | 13259 | |
84f85550 RD |
13260 | def GetCellSize(*args, **kwargs): |
13261 | """ | |
13262 | GetCellSize(self, int row, int col) -> Size | |
13263 | ||
13264 | Get the size of the specified cell, including hgap and | |
13265 | vgap. Only valid after a Layout. | |
13266 | """ | |
13267 | return _core_.GridBagSizer_GetCellSize(*args, **kwargs) | |
13268 | ||
e811c8ce | 13269 | def GetEmptyCellSize(*args, **kwargs): |
248ed943 RD |
13270 | """ |
13271 | GetEmptyCellSize(self) -> Size | |
13272 | ||
13273 | Get the size used for cells in the grid with no item. | |
13274 | """ | |
54f9ee45 | 13275 | return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs) |
e811c8ce RD |
13276 | |
13277 | def SetEmptyCellSize(*args, **kwargs): | |
248ed943 RD |
13278 | """ |
13279 | SetEmptyCellSize(self, Size sz) | |
13280 | ||
13281 | Set the size used for cells in the grid with no item. | |
13282 | """ | |
54f9ee45 | 13283 | return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs) |
e811c8ce RD |
13284 | |
13285 | def GetItemPosition(*args): | |
0df68c9f | 13286 | """ |
248ed943 RD |
13287 | GetItemPosition(self, item) -> GBPosition |
13288 | ||
13289 | Get the grid position of the specified *item* where *item* is either a | |
13290 | window or subsizer that is a member of this sizer, or a zero-based | |
13291 | index of an item. | |
0df68c9f | 13292 | """ |
54f9ee45 | 13293 | return _core_.GridBagSizer_GetItemPosition(*args) |
e811c8ce RD |
13294 | |
13295 | def SetItemPosition(*args): | |
0df68c9f | 13296 | """ |
248ed943 RD |
13297 | SetItemPosition(self, item, GBPosition pos) -> bool |
13298 | ||
13299 | Set the grid position of the specified *item* where *item* is either a | |
13300 | window or subsizer that is a member of this sizer, or a zero-based | |
13301 | index of an item. Returns True on success. If the move is not | |
13302 | allowed (because an item is already there) then False is returned. | |
13303 | ||
0df68c9f | 13304 | """ |
54f9ee45 | 13305 | return _core_.GridBagSizer_SetItemPosition(*args) |
e811c8ce RD |
13306 | |
13307 | def GetItemSpan(*args): | |
0df68c9f | 13308 | """ |
248ed943 RD |
13309 | GetItemSpan(self, item) -> GBSpan |
13310 | ||
13311 | Get the row/col spanning of the specified *item* where *item* is | |
13312 | either a window or subsizer that is a member of this sizer, or a | |
13313 | zero-based index of an item. | |
0df68c9f | 13314 | """ |
54f9ee45 | 13315 | return _core_.GridBagSizer_GetItemSpan(*args) |
e811c8ce RD |
13316 | |
13317 | def SetItemSpan(*args): | |
0df68c9f | 13318 | """ |
248ed943 RD |
13319 | SetItemSpan(self, item, GBSpan span) -> bool |
13320 | ||
13321 | Set the row/col spanning of the specified *item* where *item* is | |
13322 | either a window or subsizer that is a member of this sizer, or a | |
13323 | zero-based index of an item. Returns True on success. If the move is | |
13324 | not allowed (because an item is already there) then False is returned. | |
0df68c9f | 13325 | """ |
54f9ee45 | 13326 | return _core_.GridBagSizer_SetItemSpan(*args) |
e811c8ce RD |
13327 | |
13328 | def FindItem(*args): | |
0df68c9f | 13329 | """ |
248ed943 RD |
13330 | FindItem(self, item) -> GBSizerItem |
13331 | ||
13332 | Find the sizer item for the given window or subsizer, returns None if | |
13333 | not found. (non-recursive) | |
0df68c9f | 13334 | """ |
54f9ee45 | 13335 | return _core_.GridBagSizer_FindItem(*args) |
e811c8ce | 13336 | |
b08d67c2 RD |
13337 | def GetItem(self, item): |
13338 | gbsi = None | |
13339 | si = wx.FlexGridSizer.GetItem(self, item) | |
13340 | if not si: | |
13341 | return None | |
13342 | if type(item) is not int: | |
13343 | gbsi = self.FindItem(item) | |
13344 | if gbsi: return gbsi | |
13345 | return si | |
13346 | ||
e811c8ce | 13347 | def FindItemAtPosition(*args, **kwargs): |
248ed943 RD |
13348 | """ |
13349 | FindItemAtPosition(self, GBPosition pos) -> GBSizerItem | |
13350 | ||
13351 | Return the sizer item for the given grid cell, or None if there is no | |
13352 | item at that position. (non-recursive) | |
13353 | """ | |
54f9ee45 | 13354 | return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs) |
e811c8ce RD |
13355 | |
13356 | def FindItemAtPoint(*args, **kwargs): | |
248ed943 RD |
13357 | """ |
13358 | FindItemAtPoint(self, Point pt) -> GBSizerItem | |
13359 | ||
13360 | Return the sizer item located at the point given in *pt*, or None if | |
13361 | there is no item at that point. The (x,y) coordinates in pt correspond | |
13362 | to the client coordinates of the window using the sizer for | |
13363 | layout. (non-recursive) | |
13364 | """ | |
54f9ee45 | 13365 | return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs) |
e811c8ce | 13366 | |
248ed943 RD |
13367 | def CheckForIntersection(*args, **kwargs): |
13368 | """ | |
13369 | CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool | |
e811c8ce | 13370 | |
248ed943 RD |
13371 | Look at all items and see if any intersect (or would overlap) the |
13372 | given *item*. Returns True if so, False if there would be no overlap. | |
13373 | If an *excludeItem* is given then it will not be checked for | |
13374 | intersection, for example it may be the item we are checking the | |
13375 | position of. | |
e811c8ce | 13376 | |
248ed943 RD |
13377 | """ |
13378 | return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs) | |
e811c8ce | 13379 | |
248ed943 | 13380 | def CheckForIntersectionPos(*args, **kwargs): |
0df68c9f | 13381 | """ |
248ed943 RD |
13382 | CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool |
13383 | ||
13384 | Look at all items and see if any intersect (or would overlap) the | |
13385 | given position and span. Returns True if so, False if there would be | |
13386 | no overlap. If an *excludeItem* is given then it will not be checked | |
13387 | for intersection, for example it may be the item we are checking the | |
13388 | position of. | |
0df68c9f | 13389 | """ |
248ed943 | 13390 | return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs) |
e811c8ce | 13391 | |
2131d850 | 13392 | _core_.GridBagSizer_swigregister(GridBagSizer) |
d14a1e28 RD |
13393 | |
13394 | #--------------------------------------------------------------------------- | |
13395 | ||
54f9ee45 RD |
13396 | Left = _core_.Left |
13397 | Top = _core_.Top | |
13398 | Right = _core_.Right | |
13399 | Bottom = _core_.Bottom | |
13400 | Width = _core_.Width | |
13401 | Height = _core_.Height | |
13402 | Centre = _core_.Centre | |
13403 | Center = _core_.Center | |
13404 | CentreX = _core_.CentreX | |
13405 | CentreY = _core_.CentreY | |
13406 | Unconstrained = _core_.Unconstrained | |
13407 | AsIs = _core_.AsIs | |
13408 | PercentOf = _core_.PercentOf | |
13409 | Above = _core_.Above | |
13410 | Below = _core_.Below | |
13411 | LeftOf = _core_.LeftOf | |
13412 | RightOf = _core_.RightOf | |
13413 | SameAs = _core_.SameAs | |
13414 | Absolute = _core_.Absolute | |
d14a1e28 | 13415 | class IndividualLayoutConstraint(Object): |
15afbcd0 | 13416 | """ |
41e2b43e RD |
13417 | Objects of this class are stored in the `wx.LayoutConstraints` class as |
13418 | one of eight possible constraints that a window can be involved in. | |
13419 | You will never need to create an instance of | |
13420 | wx.IndividualLayoutConstraint, rather you should create a | |
13421 | `wx.LayoutConstraints` instance and use the individual contstraints | |
15afbcd0 | 13422 | that it contains. |
15afbcd0 | 13423 | """ |
0085ce49 RD |
13424 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
13425 | def __init__(self): raise AttributeError, "No constructor defined" | |
13426 | __repr__ = _swig_repr | |
e811c8ce | 13427 | def Set(*args, **kwargs): |
41e2b43e RD |
13428 | """ |
13429 | Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN) | |
13430 | ||
13431 | Sets the properties of the constraint. Normally called by one of the | |
13432 | convenience functions such as Above, RightOf, SameAs. | |
13433 | """ | |
54f9ee45 | 13434 | return _core_.IndividualLayoutConstraint_Set(*args, **kwargs) |
e811c8ce RD |
13435 | |
13436 | def LeftOf(*args, **kwargs): | |
15afbcd0 | 13437 | """ |
a95a7133 | 13438 | LeftOf(self, Window sibling, int marg=0) |
15afbcd0 | 13439 | |
41e2b43e RD |
13440 | Constrains this edge to be to the left of the given window, with an |
13441 | optional margin. Implicitly, this is relative to the left edge of the | |
13442 | other window. | |
15afbcd0 | 13443 | """ |
54f9ee45 | 13444 | return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs) |
e811c8ce RD |
13445 | |
13446 | def RightOf(*args, **kwargs): | |
15afbcd0 | 13447 | """ |
a95a7133 | 13448 | RightOf(self, Window sibling, int marg=0) |
15afbcd0 | 13449 | |
41e2b43e RD |
13450 | Constrains this edge to be to the right of the given window, with an |
13451 | optional margin. Implicitly, this is relative to the right edge of the | |
13452 | other window. | |
15afbcd0 | 13453 | """ |
54f9ee45 | 13454 | return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs) |
e811c8ce RD |
13455 | |
13456 | def Above(*args, **kwargs): | |
15afbcd0 | 13457 | """ |
a95a7133 | 13458 | Above(self, Window sibling, int marg=0) |
15afbcd0 | 13459 | |
41e2b43e RD |
13460 | Constrains this edge to be above the given window, with an optional |
13461 | margin. Implicitly, this is relative to the top edge of the other | |
13462 | window. | |
15afbcd0 | 13463 | """ |
54f9ee45 | 13464 | return _core_.IndividualLayoutConstraint_Above(*args, **kwargs) |
e811c8ce RD |
13465 | |
13466 | def Below(*args, **kwargs): | |
15afbcd0 | 13467 | """ |
a95a7133 | 13468 | Below(self, Window sibling, int marg=0) |
15afbcd0 | 13469 | |
41e2b43e RD |
13470 | Constrains this edge to be below the given window, with an optional |
13471 | margin. Implicitly, this is relative to the bottom edge of the other | |
13472 | window. | |
15afbcd0 | 13473 | """ |
54f9ee45 | 13474 | return _core_.IndividualLayoutConstraint_Below(*args, **kwargs) |
e811c8ce RD |
13475 | |
13476 | def SameAs(*args, **kwargs): | |
15afbcd0 | 13477 | """ |
a95a7133 | 13478 | SameAs(self, Window otherW, int edge, int marg=0) |
15afbcd0 | 13479 | |
41e2b43e RD |
13480 | Constrains this edge or dimension to be to the same as the edge of the |
13481 | given window, with an optional margin. | |
15afbcd0 | 13482 | """ |
54f9ee45 | 13483 | return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs) |
e811c8ce RD |
13484 | |
13485 | def PercentOf(*args, **kwargs): | |
15afbcd0 | 13486 | """ |
a95a7133 | 13487 | PercentOf(self, Window otherW, int wh, int per) |
15afbcd0 | 13488 | |
41e2b43e RD |
13489 | Constrains this edge or dimension to be to a percentage of the given |
13490 | window, with an optional margin. | |
15afbcd0 | 13491 | """ |
54f9ee45 | 13492 | return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs) |
e811c8ce RD |
13493 | |
13494 | def Absolute(*args, **kwargs): | |
15afbcd0 | 13495 | """ |
a95a7133 | 13496 | Absolute(self, int val) |
15afbcd0 | 13497 | |
41e2b43e | 13498 | Constrains this edge or dimension to be the given absolute value. |
15afbcd0 | 13499 | """ |
54f9ee45 | 13500 | return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs) |
e811c8ce RD |
13501 | |
13502 | def Unconstrained(*args, **kwargs): | |
15afbcd0 | 13503 | """ |
a95a7133 | 13504 | Unconstrained(self) |
15afbcd0 | 13505 | |
41e2b43e RD |
13506 | Sets this edge or dimension to be unconstrained, that is, dependent on |
13507 | other edges and dimensions from which this value can be deduced. | |
15afbcd0 | 13508 | """ |
54f9ee45 | 13509 | return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs) |
e811c8ce RD |
13510 | |
13511 | def AsIs(*args, **kwargs): | |
15afbcd0 | 13512 | """ |
a95a7133 | 13513 | AsIs(self) |
15afbcd0 | 13514 | |
41e2b43e RD |
13515 | Sets this edge or constraint to be whatever the window's value is at |
13516 | the moment. If either of the width and height constraints are *as is*, | |
13517 | the window will not be resized, but moved instead. This is important | |
13518 | when considering panel items which are intended to have a default | |
13519 | size, such as a button, which may take its size from the size of the | |
13520 | button label. | |
15afbcd0 | 13521 | """ |
54f9ee45 | 13522 | return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs) |
e811c8ce RD |
13523 | |
13524 | def GetOtherWindow(*args, **kwargs): | |
a95a7133 | 13525 | """GetOtherWindow(self) -> Window""" |
54f9ee45 | 13526 | return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs) |
e811c8ce RD |
13527 | |
13528 | def GetMyEdge(*args, **kwargs): | |
a95a7133 | 13529 | """GetMyEdge(self) -> int""" |
54f9ee45 | 13530 | return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs) |
e811c8ce RD |
13531 | |
13532 | def SetEdge(*args, **kwargs): | |
a95a7133 | 13533 | """SetEdge(self, int which)""" |
54f9ee45 | 13534 | return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs) |
e811c8ce RD |
13535 | |
13536 | def SetValue(*args, **kwargs): | |
a95a7133 | 13537 | """SetValue(self, int v)""" |
54f9ee45 | 13538 | return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs) |
e811c8ce RD |
13539 | |
13540 | def GetMargin(*args, **kwargs): | |
a95a7133 | 13541 | """GetMargin(self) -> int""" |
54f9ee45 | 13542 | return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs) |
e811c8ce RD |
13543 | |
13544 | def SetMargin(*args, **kwargs): | |
a95a7133 | 13545 | """SetMargin(self, int m)""" |
54f9ee45 | 13546 | return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs) |
e811c8ce RD |
13547 | |
13548 | def GetValue(*args, **kwargs): | |
a95a7133 | 13549 | """GetValue(self) -> int""" |
54f9ee45 | 13550 | return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs) |
e811c8ce RD |
13551 | |
13552 | def GetPercent(*args, **kwargs): | |
a95a7133 | 13553 | """GetPercent(self) -> int""" |
54f9ee45 | 13554 | return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs) |
e811c8ce RD |
13555 | |
13556 | def GetOtherEdge(*args, **kwargs): | |
a95a7133 | 13557 | """GetOtherEdge(self) -> int""" |
54f9ee45 | 13558 | return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs) |
e811c8ce RD |
13559 | |
13560 | def GetDone(*args, **kwargs): | |
a95a7133 | 13561 | """GetDone(self) -> bool""" |
54f9ee45 | 13562 | return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs) |
e811c8ce RD |
13563 | |
13564 | def SetDone(*args, **kwargs): | |
a95a7133 | 13565 | """SetDone(self, bool d)""" |
54f9ee45 | 13566 | return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs) |
e811c8ce RD |
13567 | |
13568 | def GetRelationship(*args, **kwargs): | |
a95a7133 | 13569 | """GetRelationship(self) -> int""" |
54f9ee45 | 13570 | return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs) |
e811c8ce RD |
13571 | |
13572 | def SetRelationship(*args, **kwargs): | |
a95a7133 | 13573 | """SetRelationship(self, int r)""" |
54f9ee45 | 13574 | return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs) |
e811c8ce RD |
13575 | |
13576 | def ResetIfWin(*args, **kwargs): | |
15afbcd0 | 13577 | """ |
a95a7133 | 13578 | ResetIfWin(self, Window otherW) -> bool |
15afbcd0 RD |
13579 | |
13580 | Reset constraint if it mentions otherWin | |
13581 | """ | |
54f9ee45 | 13582 | return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs) |
e811c8ce RD |
13583 | |
13584 | def SatisfyConstraint(*args, **kwargs): | |
15afbcd0 | 13585 | """ |
a95a7133 | 13586 | SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool |
15afbcd0 RD |
13587 | |
13588 | Try to satisfy constraint | |
13589 | """ | |
54f9ee45 | 13590 | return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs) |
e811c8ce RD |
13591 | |
13592 | def GetEdge(*args, **kwargs): | |
15afbcd0 | 13593 | """ |
a95a7133 | 13594 | GetEdge(self, int which, Window thisWin, Window other) -> int |
15afbcd0 RD |
13595 | |
13596 | Get the value of this edge or dimension, or if this | |
13597 | is not determinable, -1. | |
13598 | """ | |
54f9ee45 | 13599 | return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs) |
e811c8ce | 13600 | |
97ab0f6a RD |
13601 | Done = property(GetDone,SetDone,doc="See `GetDone` and `SetDone`") |
13602 | Margin = property(GetMargin,SetMargin,doc="See `GetMargin` and `SetMargin`") | |
13603 | MyEdge = property(GetMyEdge,doc="See `GetMyEdge`") | |
13604 | OtherEdge = property(GetOtherEdge,doc="See `GetOtherEdge`") | |
13605 | OtherWindow = property(GetOtherWindow,doc="See `GetOtherWindow`") | |
13606 | Percent = property(GetPercent,doc="See `GetPercent`") | |
13607 | Relationship = property(GetRelationship,SetRelationship,doc="See `GetRelationship` and `SetRelationship`") | |
13608 | Value = property(GetValue,SetValue,doc="See `GetValue` and `SetValue`") | |
2131d850 | 13609 | _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint) |
d14a1e28 RD |
13610 | |
13611 | class LayoutConstraints(Object): | |
15afbcd0 | 13612 | """ |
41e2b43e RD |
13613 | **Note:** constraints are now deprecated and you should use sizers |
13614 | instead. | |
15afbcd0 | 13615 | |
41e2b43e RD |
13616 | Objects of this class can be associated with a window to define its |
13617 | layout constraints, with respect to siblings or its parent. | |
15afbcd0 RD |
13618 | |
13619 | The class consists of the following eight constraints of class | |
13620 | wx.IndividualLayoutConstraint, some or all of which should be accessed | |
13621 | directly to set the appropriate constraints. | |
13622 | ||
13623 | * left: represents the left hand edge of the window | |
13624 | * right: represents the right hand edge of the window | |
13625 | * top: represents the top edge of the window | |
13626 | * bottom: represents the bottom edge of the window | |
13627 | * width: represents the width of the window | |
13628 | * height: represents the height of the window | |
13629 | * centreX: represents the horizontal centre point of the window | |
13630 | * centreY: represents the vertical centre point of the window | |
13631 | ||
41e2b43e RD |
13632 | Most constraints are initially set to have the relationship |
13633 | wxUnconstrained, which means that their values should be calculated by | |
13634 | looking at known constraints. The exceptions are width and height, | |
13635 | which are set to wxAsIs to ensure that if the user does not specify a | |
13636 | constraint, the existing width and height will be used, to be | |
13637 | compatible with panel items which often have take a default size. If | |
13638 | the constraint is ``wx.AsIs``, the dimension will not be changed. | |
13639 | ||
13640 | :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints` | |
15afbcd0 RD |
13641 | |
13642 | """ | |
0085ce49 RD |
13643 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
13644 | __repr__ = _swig_repr | |
54f9ee45 RD |
13645 | left = property(_core_.LayoutConstraints_left_get) |
13646 | top = property(_core_.LayoutConstraints_top_get) | |
13647 | right = property(_core_.LayoutConstraints_right_get) | |
13648 | bottom = property(_core_.LayoutConstraints_bottom_get) | |
13649 | width = property(_core_.LayoutConstraints_width_get) | |
13650 | height = property(_core_.LayoutConstraints_height_get) | |
13651 | centreX = property(_core_.LayoutConstraints_centreX_get) | |
13652 | centreY = property(_core_.LayoutConstraints_centreY_get) | |
0085ce49 | 13653 | def __init__(self, *args, **kwargs): |
a95a7133 | 13654 | """__init__(self) -> LayoutConstraints""" |
0085ce49 RD |
13655 | _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs)) |
13656 | __swig_destroy__ = _core_.delete_LayoutConstraints | |
13657 | __del__ = lambda self : None; | |
e811c8ce | 13658 | def SatisfyConstraints(*args, **kwargs): |
6c3b4aae | 13659 | """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)""" |
54f9ee45 | 13660 | return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs) |
e811c8ce RD |
13661 | |
13662 | def AreSatisfied(*args, **kwargs): | |
a95a7133 | 13663 | """AreSatisfied(self) -> bool""" |
54f9ee45 | 13664 | return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs) |
e811c8ce | 13665 | |
2131d850 | 13666 | _core_.LayoutConstraints_swigregister(LayoutConstraints) |
d14a1e28 RD |
13667 | |
13668 | #---------------------------------------------------------------------------- | |
13669 | ||
322913ce | 13670 | # Use Python's bool constants if available, make some if not |
d14a1e28 RD |
13671 | try: |
13672 | True | |
13673 | except NameError: | |
322913ce RD |
13674 | __builtins__.True = 1==1 |
13675 | __builtins__.False = 1==0 | |
4f89f6a3 RD |
13676 | def bool(value): return not not value |
13677 | __builtins__.bool = bool | |
d14a1e28 | 13678 | |
d14a1e28 RD |
13679 | |
13680 | ||
13681 | # workarounds for bad wxRTTI names | |
13682 | __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge' | |
13683 | __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider' | |
13684 | __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' | |
13685 | ||
13686 | ||
13687 | #---------------------------------------------------------------------------- | |
13688 | # Load version numbers from __version__... Ensure that major and minor | |
7bc1e663 | 13689 | # versions are the same for both wxPython and wxWidgets. |
d14a1e28 RD |
13690 | |
13691 | from __version__ import * | |
13692 | __version__ = VERSION_STRING | |
13693 | ||
7bc1e663 RD |
13694 | assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch" |
13695 | assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch" | |
54f9ee45 | 13696 | if RELEASE_VERSION != _core_.RELEASE_VERSION: |
d14a1e28 | 13697 | import warnings |
7bc1e663 | 13698 | warnings.warn("wxPython/wxWidgets release number mismatch") |
d14a1e28 | 13699 | |
f9bf356b RD |
13700 | |
13701 | def version(): | |
13702 | """Returns a string containing version and port info""" | |
13703 | ctype = wx.USE_UNICODE and 'unicode' or 'ansi' | |
13704 | if wx.Platform == '__WXMSW__': | |
13705 | port = 'msw' | |
13706 | elif wx.Platform == '__WXMAC__': | |
13707 | port = 'mac' | |
13708 | elif wx.Platform == '__WXGTK__': | |
13709 | port = 'gtk' | |
13710 | if 'gtk2' in wx.PlatformInfo: | |
13711 | port = 'gtk2' | |
13712 | else: | |
13713 | port = '?' | |
13714 | ||
13715 | return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype) | |
13716 | ||
13717 | ||
d14a1e28 RD |
13718 | #---------------------------------------------------------------------------- |
13719 | ||
70b7a5fe RD |
13720 | # Set wxPython's default string<-->unicode conversion encoding from |
13721 | # the locale, but only if Python's default hasn't been changed. (We | |
13722 | # assume that if the user has customized it already then that is the | |
13723 | # encoding we need to use as well.) | |
13724 | # | |
13725 | # The encoding selected here is used when string or unicode objects | |
13726 | # need to be converted in order to pass them to wxWidgets. Please be | |
13727 | # aware that the default encoding within the same locale may be | |
13728 | # slightly different on different platforms. For example, please see | |
e505d15e RD |
13729 | # http://www.alanwood.net/demos/charsetdiffs.html for differences |
13730 | # between the common latin/roman encodings. | |
396fb509 RD |
13731 | |
13732 | default = _sys.getdefaultencoding() | |
13733 | if default == 'ascii': | |
13734 | import locale | |
13735 | import codecs | |
13736 | try: | |
474e2ff2 RD |
13737 | if hasattr(locale, 'getpreferredencoding'): |
13738 | default = locale.getpreferredencoding() | |
13739 | else: | |
13740 | default = locale.getdefaultlocale()[1] | |
396fb509 | 13741 | codecs.lookup(default) |
70b7a5fe | 13742 | except (ValueError, LookupError, TypeError): |
396fb509 RD |
13743 | default = _sys.getdefaultencoding() |
13744 | del locale | |
13745 | del codecs | |
5cbf236d RD |
13746 | if default: |
13747 | wx.SetDefaultPyEncoding(default) | |
13748 | del default | |
5cbf236d RD |
13749 | |
13750 | #---------------------------------------------------------------------------- | |
13751 | ||
d14a1e28 RD |
13752 | class PyDeadObjectError(AttributeError): |
13753 | pass | |
13754 | ||
d14a1e28 RD |
13755 | class _wxPyDeadObject(object): |
13756 | """ | |
13757 | Instances of wx objects that are OOR capable will have their __class__ | |
13758 | changed to this class when the C++ object is deleted. This should help | |
13759 | prevent crashes due to referencing a bogus C++ pointer. | |
13760 | """ | |
13761 | reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)" | |
13762 | attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed." | |
13763 | ||
3a04f143 | 13764 | def __repr__(self): |
d14a1e28 RD |
13765 | if not hasattr(self, "_name"): |
13766 | self._name = "[unknown]" | |
13767 | return self.reprStr % self._name | |
13768 | ||
3a04f143 | 13769 | def __getattr__(self, *args): |
d14a1e28 RD |
13770 | if not hasattr(self, "_name"): |
13771 | self._name = "[unknown]" | |
3a04f143 RD |
13772 | raise PyDeadObjectError(self.attrStr % self._name) |
13773 | ||
13774 | def __nonzero__(self): | |
13775 | return 0 | |
13776 | ||
13777 | ||
13778 | ||
13779 | class PyUnbornObjectError(AttributeError): | |
13780 | pass | |
13781 | ||
13782 | class _wxPyUnbornObject(object): | |
13783 | """ | |
54f9ee45 | 13784 | Some stock objects are created when the wx._core module is |
3a04f143 RD |
13785 | imported, but their C++ instance is not created until the wx.App |
13786 | object is created and initialized. These object instances will | |
13787 | temporarily have their __class__ changed to this class so an | |
13788 | exception will be raised if they are used before the C++ instance | |
13789 | is ready. | |
13790 | """ | |
13791 | ||
13792 | reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)" | |
13793 | attrStr = "The C++ part of this object has not been initialized, attribute access not allowed." | |
13794 | ||
13795 | def __repr__(self): | |
13796 | #if not hasattr(self, "_name"): | |
13797 | # self._name = "[unknown]" | |
13798 | return self.reprStr #% self._name | |
13799 | ||
13800 | def __getattr__(self, *args): | |
13801 | #if not hasattr(self, "_name"): | |
13802 | # self._name = "[unknown]" | |
13803 | raise PyUnbornObjectError(self.attrStr) # % self._name ) | |
d14a1e28 RD |
13804 | |
13805 | def __nonzero__(self): | |
13806 | return 0 | |
13807 | ||
13808 | ||
13809 | #---------------------------------------------------------------------------- | |
d14a1e28 RD |
13810 | |
13811 | def CallAfter(callable, *args, **kw): | |
13812 | """ | |
13813 | Call the specified function after the current and pending event | |
13814 | handlers have been completed. This is also good for making GUI | |
61863841 RD |
13815 | method calls from non-GUI threads. Any extra positional or |
13816 | keyword args are passed on to the callable when it is called. | |
13817 | ||
846c181b | 13818 | :see: `wx.CallLater` |
d14a1e28 RD |
13819 | """ |
13820 | app = wx.GetApp() | |
dfbb5885 | 13821 | assert app is not None, 'No wx.App created yet' |
d14a1e28 | 13822 | |
148275d3 RD |
13823 | if not hasattr(app, "_CallAfterId"): |
13824 | app._CallAfterId = wx.NewEventType() | |
13825 | app.Connect(-1, -1, app._CallAfterId, | |
13826 | lambda event: event.callable(*event.args, **event.kw) ) | |
d14a1e28 | 13827 | evt = wx.PyEvent() |
148275d3 | 13828 | evt.SetEventType(app._CallAfterId) |
d14a1e28 RD |
13829 | evt.callable = callable |
13830 | evt.args = args | |
13831 | evt.kw = kw | |
13832 | wx.PostEvent(app, evt) | |
13833 | ||
d14a1e28 RD |
13834 | #---------------------------------------------------------------------------- |
13835 | ||
13836 | ||
846c181b | 13837 | class CallLater: |
d14a1e28 | 13838 | """ |
8ac8dba0 | 13839 | A convenience class for `wx.Timer`, that calls the given callable |
d14a1e28 RD |
13840 | object once after the given amount of milliseconds, passing any |
13841 | positional or keyword args. The return value of the callable is | |
61863841 | 13842 | availbale after it has been run with the `GetResult` method. |
d14a1e28 RD |
13843 | |
13844 | If you don't need to get the return value or restart the timer | |
13845 | then there is no need to hold a reference to this object. It will | |
13846 | hold a reference to itself while the timer is running (the timer | |
13847 | has a reference to self.Notify) but the cycle will be broken when | |
846c181b | 13848 | the timer completes, automatically cleaning up the wx.CallLater |
d14a1e28 | 13849 | object. |
61863841 RD |
13850 | |
13851 | :see: `wx.CallAfter` | |
d14a1e28 RD |
13852 | """ |
13853 | def __init__(self, millis, callable, *args, **kwargs): | |
13854 | self.millis = millis | |
13855 | self.callable = callable | |
13856 | self.SetArgs(*args, **kwargs) | |
13857 | self.runCount = 0 | |
4276dc52 | 13858 | self.running = False |
d14a1e28 RD |
13859 | self.hasRun = False |
13860 | self.result = None | |
13861 | self.timer = None | |
13862 | self.Start() | |
13863 | ||
13864 | def __del__(self): | |
13865 | self.Stop() | |
13866 | ||
13867 | ||
13868 | def Start(self, millis=None, *args, **kwargs): | |
13869 | """ | |
13870 | (Re)start the timer | |
13871 | """ | |
13872 | self.hasRun = False | |
13873 | if millis is not None: | |
13874 | self.millis = millis | |
13875 | if args or kwargs: | |
13876 | self.SetArgs(*args, **kwargs) | |
13877 | self.Stop() | |
13878 | self.timer = wx.PyTimer(self.Notify) | |
13879 | self.timer.Start(self.millis, wx.TIMER_ONE_SHOT) | |
4276dc52 | 13880 | self.running = True |
d14a1e28 RD |
13881 | Restart = Start |
13882 | ||
13883 | ||
13884 | def Stop(self): | |
13885 | """ | |
13886 | Stop and destroy the timer. | |
13887 | """ | |
13888 | if self.timer is not None: | |
13889 | self.timer.Stop() | |
13890 | self.timer = None | |
13891 | ||
13892 | ||
13893 | def GetInterval(self): | |
13894 | if self.timer is not None: | |
13895 | return self.timer.GetInterval() | |
13896 | else: | |
13897 | return 0 | |
13898 | ||
13899 | ||
13900 | def IsRunning(self): | |
13901 | return self.timer is not None and self.timer.IsRunning() | |
13902 | ||
13903 | ||
13904 | def SetArgs(self, *args, **kwargs): | |
13905 | """ | |
13906 | (Re)set the args passed to the callable object. This is | |
13907 | useful in conjunction with Restart if you want to schedule a | |
13908 | new call to the same callable object but with different | |
13909 | parameters. | |
13910 | """ | |
13911 | self.args = args | |
13912 | self.kwargs = kwargs | |
13913 | ||
13914 | ||
13915 | def HasRun(self): | |
13916 | return self.hasRun | |
13917 | ||
13918 | def GetResult(self): | |
13919 | return self.result | |
13920 | ||
13921 | def Notify(self): | |
13922 | """ | |
13923 | The timer has expired so call the callable. | |
13924 | """ | |
13925 | if self.callable and getattr(self.callable, 'im_self', True): | |
13926 | self.runCount += 1 | |
4276dc52 | 13927 | self.running = False |
d14a1e28 RD |
13928 | self.result = self.callable(*self.args, **self.kwargs) |
13929 | self.hasRun = True | |
4276dc52 RD |
13930 | if not self.running: |
13931 | # if it wasn't restarted, then cleanup | |
13932 | wx.CallAfter(self.Stop) | |
d14a1e28 | 13933 | |
97ab0f6a RD |
13934 | Interval = property(GetInterval) |
13935 | Result = property(GetResult) | |
d14a1e28 | 13936 | |
a95a7133 | 13937 | |
846c181b | 13938 | class FutureCall(CallLater): |
b39fe951 | 13939 | """A compatibility alias for `CallLater`.""" |
846c181b | 13940 | |
a95a7133 RD |
13941 | #---------------------------------------------------------------------------- |
13942 | # Control which items in this module should be documented by epydoc. | |
13943 | # We allow only classes and functions, which will help reduce the size | |
13944 | # of the docs by filtering out the zillions of constants, EVT objects, | |
13945 | # and etc that don't make much sense by themselves, but are instead | |
13946 | # documented (or will be) as part of the classes/functions/methods | |
13947 | # where they should be used. | |
13948 | ||
66c033b4 RD |
13949 | class __DocFilter: |
13950 | """ | |
13951 | A filter for epydoc that only allows non-Ptr classes and | |
34e0a3bb | 13952 | functions, in order to reduce the clutter in the API docs. |
66c033b4 RD |
13953 | """ |
13954 | def __init__(self, globals): | |
13955 | self._globals = globals | |
13956 | ||
13957 | def __call__(self, name): | |
13958 | import types | |
13959 | obj = self._globals.get(name, None) | |
34e0a3bb RD |
13960 | |
13961 | # only document classes and function | |
66c033b4 RD |
13962 | if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]: |
13963 | return False | |
34e0a3bb RD |
13964 | |
13965 | # skip other things that are private or will be documented as part of somethign else | |
0085ce49 | 13966 | if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') : |
66c033b4 | 13967 | return False |
34e0a3bb RD |
13968 | |
13969 | # skip functions that are duplicates of static functions in a class | |
13970 | if name.find('_') != -1: | |
13971 | cls = self._globals.get(name.split('_')[0], None) | |
13972 | methname = name.split('_')[1] | |
13973 | if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType: | |
13974 | return False | |
13975 | ||
66c033b4 | 13976 | return True |
a95a7133 | 13977 | |
d14a1e28 RD |
13978 | #---------------------------------------------------------------------------- |
13979 | #---------------------------------------------------------------------------- | |
13980 | ||
13981 | # Import other modules in this package that should show up in the | |
13982 | # "core" wx namespace | |
54f9ee45 RD |
13983 | from _gdi import * |
13984 | from _windows import * | |
13985 | from _controls import * | |
13986 | from _misc import * | |
d14a1e28 RD |
13987 | |
13988 | #---------------------------------------------------------------------------- | |
13989 | #---------------------------------------------------------------------------- | |
13990 | ||
13991 | ||
32fe5131 | 13992 |