]>
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 | |
197 | ID_PREVIEW = _core_.ID_PREVIEW | |
198 | ID_ABOUT = _core_.ID_ABOUT | |
199 | ID_HELP_CONTENTS = _core_.ID_HELP_CONTENTS | |
200 | ID_HELP_COMMANDS = _core_.ID_HELP_COMMANDS | |
201 | ID_HELP_PROCEDURES = _core_.ID_HELP_PROCEDURES | |
202 | ID_HELP_CONTEXT = _core_.ID_HELP_CONTEXT | |
203 | ID_CLOSE_ALL = _core_.ID_CLOSE_ALL | |
204 | ID_PREFERENCES = _core_.ID_PREFERENCES | |
205 | ID_CUT = _core_.ID_CUT | |
206 | ID_COPY = _core_.ID_COPY | |
207 | ID_PASTE = _core_.ID_PASTE | |
208 | ID_CLEAR = _core_.ID_CLEAR | |
209 | ID_FIND = _core_.ID_FIND | |
210 | ID_DUPLICATE = _core_.ID_DUPLICATE | |
211 | ID_SELECTALL = _core_.ID_SELECTALL | |
212 | ID_DELETE = _core_.ID_DELETE | |
213 | ID_REPLACE = _core_.ID_REPLACE | |
214 | ID_REPLACE_ALL = _core_.ID_REPLACE_ALL | |
215 | ID_PROPERTIES = _core_.ID_PROPERTIES | |
216 | ID_VIEW_DETAILS = _core_.ID_VIEW_DETAILS | |
217 | ID_VIEW_LARGEICONS = _core_.ID_VIEW_LARGEICONS | |
218 | ID_VIEW_SMALLICONS = _core_.ID_VIEW_SMALLICONS | |
219 | ID_VIEW_LIST = _core_.ID_VIEW_LIST | |
220 | ID_VIEW_SORTDATE = _core_.ID_VIEW_SORTDATE | |
221 | ID_VIEW_SORTNAME = _core_.ID_VIEW_SORTNAME | |
222 | ID_VIEW_SORTSIZE = _core_.ID_VIEW_SORTSIZE | |
223 | ID_VIEW_SORTTYPE = _core_.ID_VIEW_SORTTYPE | |
224 | ID_FILE1 = _core_.ID_FILE1 | |
225 | ID_FILE2 = _core_.ID_FILE2 | |
226 | ID_FILE3 = _core_.ID_FILE3 | |
227 | ID_FILE4 = _core_.ID_FILE4 | |
228 | ID_FILE5 = _core_.ID_FILE5 | |
229 | ID_FILE6 = _core_.ID_FILE6 | |
230 | ID_FILE7 = _core_.ID_FILE7 | |
231 | ID_FILE8 = _core_.ID_FILE8 | |
232 | ID_FILE9 = _core_.ID_FILE9 | |
233 | ID_OK = _core_.ID_OK | |
234 | ID_CANCEL = _core_.ID_CANCEL | |
235 | ID_APPLY = _core_.ID_APPLY | |
236 | ID_YES = _core_.ID_YES | |
237 | ID_NO = _core_.ID_NO | |
238 | ID_STATIC = _core_.ID_STATIC | |
239 | ID_FORWARD = _core_.ID_FORWARD | |
240 | ID_BACKWARD = _core_.ID_BACKWARD | |
241 | ID_DEFAULT = _core_.ID_DEFAULT | |
242 | ID_MORE = _core_.ID_MORE | |
243 | ID_SETUP = _core_.ID_SETUP | |
244 | ID_RESET = _core_.ID_RESET | |
245 | ID_CONTEXT_HELP = _core_.ID_CONTEXT_HELP | |
246 | ID_YESTOALL = _core_.ID_YESTOALL | |
247 | ID_NOTOALL = _core_.ID_NOTOALL | |
248 | ID_ABORT = _core_.ID_ABORT | |
249 | ID_RETRY = _core_.ID_RETRY | |
250 | ID_IGNORE = _core_.ID_IGNORE | |
7bc1e663 RD |
251 | ID_ADD = _core_.ID_ADD |
252 | ID_REMOVE = _core_.ID_REMOVE | |
253 | ID_UP = _core_.ID_UP | |
254 | ID_DOWN = _core_.ID_DOWN | |
255 | ID_HOME = _core_.ID_HOME | |
256 | ID_REFRESH = _core_.ID_REFRESH | |
257 | ID_STOP = _core_.ID_STOP | |
258 | ID_INDEX = _core_.ID_INDEX | |
259 | ID_BOLD = _core_.ID_BOLD | |
260 | ID_ITALIC = _core_.ID_ITALIC | |
261 | ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER | |
262 | ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL | |
263 | ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT | |
264 | ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT | |
265 | ID_UNDERLINE = _core_.ID_UNDERLINE | |
266 | ID_INDENT = _core_.ID_INDENT | |
267 | ID_UNINDENT = _core_.ID_UNINDENT | |
268 | ID_ZOOM_100 = _core_.ID_ZOOM_100 | |
269 | ID_ZOOM_FIT = _core_.ID_ZOOM_FIT | |
270 | ID_ZOOM_IN = _core_.ID_ZOOM_IN | |
271 | ID_ZOOM_OUT = _core_.ID_ZOOM_OUT | |
272 | ID_UNDELETE = _core_.ID_UNDELETE | |
273 | ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED | |
54f9ee45 | 274 | ID_HIGHEST = _core_.ID_HIGHEST |
54f9ee45 RD |
275 | ACCEL_ALT = _core_.ACCEL_ALT |
276 | ACCEL_CTRL = _core_.ACCEL_CTRL | |
277 | ACCEL_SHIFT = _core_.ACCEL_SHIFT | |
278 | ACCEL_NORMAL = _core_.ACCEL_NORMAL | |
279 | PD_AUTO_HIDE = _core_.PD_AUTO_HIDE | |
280 | PD_APP_MODAL = _core_.PD_APP_MODAL | |
281 | PD_CAN_ABORT = _core_.PD_CAN_ABORT | |
282 | PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME | |
283 | PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME | |
284 | PD_REMAINING_TIME = _core_.PD_REMAINING_TIME | |
e505d15e RD |
285 | PD_SMOOTH = _core_.PD_SMOOTH |
286 | PD_CAN_SKIP = _core_.PD_CAN_SKIP | |
54f9ee45 RD |
287 | MENU_TEAROFF = _core_.MENU_TEAROFF |
288 | MB_DOCKABLE = _core_.MB_DOCKABLE | |
289 | NO_FULL_REPAINT_ON_RESIZE = _core_.NO_FULL_REPAINT_ON_RESIZE | |
290 | FULL_REPAINT_ON_RESIZE = _core_.FULL_REPAINT_ON_RESIZE | |
291 | LI_HORIZONTAL = _core_.LI_HORIZONTAL | |
292 | LI_VERTICAL = _core_.LI_VERTICAL | |
293 | WS_EX_VALIDATE_RECURSIVELY = _core_.WS_EX_VALIDATE_RECURSIVELY | |
294 | WS_EX_BLOCK_EVENTS = _core_.WS_EX_BLOCK_EVENTS | |
295 | WS_EX_TRANSIENT = _core_.WS_EX_TRANSIENT | |
296 | WS_EX_THEMED_BACKGROUND = _core_.WS_EX_THEMED_BACKGROUND | |
297 | WS_EX_PROCESS_IDLE = _core_.WS_EX_PROCESS_IDLE | |
298 | WS_EX_PROCESS_UI_UPDATES = _core_.WS_EX_PROCESS_UI_UPDATES | |
299 | MM_TEXT = _core_.MM_TEXT | |
300 | MM_LOMETRIC = _core_.MM_LOMETRIC | |
301 | MM_HIMETRIC = _core_.MM_HIMETRIC | |
302 | MM_LOENGLISH = _core_.MM_LOENGLISH | |
303 | MM_HIENGLISH = _core_.MM_HIENGLISH | |
304 | MM_TWIPS = _core_.MM_TWIPS | |
305 | MM_ISOTROPIC = _core_.MM_ISOTROPIC | |
306 | MM_ANISOTROPIC = _core_.MM_ANISOTROPIC | |
307 | MM_POINTS = _core_.MM_POINTS | |
308 | MM_METRIC = _core_.MM_METRIC | |
309 | CENTRE = _core_.CENTRE | |
310 | CENTER = _core_.CENTER | |
311 | HORIZONTAL = _core_.HORIZONTAL | |
312 | VERTICAL = _core_.VERTICAL | |
313 | BOTH = _core_.BOTH | |
314 | LEFT = _core_.LEFT | |
315 | RIGHT = _core_.RIGHT | |
316 | UP = _core_.UP | |
317 | DOWN = _core_.DOWN | |
318 | TOP = _core_.TOP | |
319 | BOTTOM = _core_.BOTTOM | |
320 | NORTH = _core_.NORTH | |
321 | SOUTH = _core_.SOUTH | |
322 | WEST = _core_.WEST | |
323 | EAST = _core_.EAST | |
324 | ALL = _core_.ALL | |
325 | ALIGN_NOT = _core_.ALIGN_NOT | |
326 | ALIGN_CENTER_HORIZONTAL = _core_.ALIGN_CENTER_HORIZONTAL | |
327 | ALIGN_CENTRE_HORIZONTAL = _core_.ALIGN_CENTRE_HORIZONTAL | |
328 | ALIGN_LEFT = _core_.ALIGN_LEFT | |
329 | ALIGN_TOP = _core_.ALIGN_TOP | |
330 | ALIGN_RIGHT = _core_.ALIGN_RIGHT | |
331 | ALIGN_BOTTOM = _core_.ALIGN_BOTTOM | |
332 | ALIGN_CENTER_VERTICAL = _core_.ALIGN_CENTER_VERTICAL | |
333 | ALIGN_CENTRE_VERTICAL = _core_.ALIGN_CENTRE_VERTICAL | |
334 | ALIGN_CENTER = _core_.ALIGN_CENTER | |
335 | ALIGN_CENTRE = _core_.ALIGN_CENTRE | |
336 | ALIGN_MASK = _core_.ALIGN_MASK | |
337 | STRETCH_NOT = _core_.STRETCH_NOT | |
338 | SHRINK = _core_.SHRINK | |
339 | GROW = _core_.GROW | |
340 | EXPAND = _core_.EXPAND | |
341 | SHAPED = _core_.SHAPED | |
342 | FIXED_MINSIZE = _core_.FIXED_MINSIZE | |
343 | TILE = _core_.TILE | |
344 | ADJUST_MINSIZE = _core_.ADJUST_MINSIZE | |
345 | BORDER_DEFAULT = _core_.BORDER_DEFAULT | |
346 | BORDER_NONE = _core_.BORDER_NONE | |
347 | BORDER_STATIC = _core_.BORDER_STATIC | |
348 | BORDER_SIMPLE = _core_.BORDER_SIMPLE | |
349 | BORDER_RAISED = _core_.BORDER_RAISED | |
350 | BORDER_SUNKEN = _core_.BORDER_SUNKEN | |
351 | BORDER_DOUBLE = _core_.BORDER_DOUBLE | |
352 | BORDER_MASK = _core_.BORDER_MASK | |
7bc1e663 RD |
353 | BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM |
354 | BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR | |
355 | BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM | |
54f9ee45 RD |
356 | DEFAULT = _core_.DEFAULT |
357 | DECORATIVE = _core_.DECORATIVE | |
358 | ROMAN = _core_.ROMAN | |
359 | SCRIPT = _core_.SCRIPT | |
360 | SWISS = _core_.SWISS | |
361 | MODERN = _core_.MODERN | |
362 | TELETYPE = _core_.TELETYPE | |
363 | VARIABLE = _core_.VARIABLE | |
364 | FIXED = _core_.FIXED | |
365 | NORMAL = _core_.NORMAL | |
366 | LIGHT = _core_.LIGHT | |
367 | BOLD = _core_.BOLD | |
368 | ITALIC = _core_.ITALIC | |
369 | SLANT = _core_.SLANT | |
370 | SOLID = _core_.SOLID | |
371 | DOT = _core_.DOT | |
372 | LONG_DASH = _core_.LONG_DASH | |
373 | SHORT_DASH = _core_.SHORT_DASH | |
374 | DOT_DASH = _core_.DOT_DASH | |
375 | USER_DASH = _core_.USER_DASH | |
376 | TRANSPARENT = _core_.TRANSPARENT | |
377 | STIPPLE = _core_.STIPPLE | |
d04418a7 RD |
378 | STIPPLE_MASK = _core_.STIPPLE_MASK |
379 | STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE | |
54f9ee45 RD |
380 | BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH |
381 | CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH | |
382 | FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH | |
383 | CROSS_HATCH = _core_.CROSS_HATCH | |
384 | HORIZONTAL_HATCH = _core_.HORIZONTAL_HATCH | |
385 | VERTICAL_HATCH = _core_.VERTICAL_HATCH | |
386 | JOIN_BEVEL = _core_.JOIN_BEVEL | |
387 | JOIN_MITER = _core_.JOIN_MITER | |
388 | JOIN_ROUND = _core_.JOIN_ROUND | |
389 | CAP_ROUND = _core_.CAP_ROUND | |
390 | CAP_PROJECTING = _core_.CAP_PROJECTING | |
391 | CAP_BUTT = _core_.CAP_BUTT | |
392 | CLEAR = _core_.CLEAR | |
393 | XOR = _core_.XOR | |
394 | INVERT = _core_.INVERT | |
395 | OR_REVERSE = _core_.OR_REVERSE | |
396 | AND_REVERSE = _core_.AND_REVERSE | |
397 | COPY = _core_.COPY | |
398 | AND = _core_.AND | |
399 | AND_INVERT = _core_.AND_INVERT | |
400 | NO_OP = _core_.NO_OP | |
401 | NOR = _core_.NOR | |
402 | EQUIV = _core_.EQUIV | |
403 | SRC_INVERT = _core_.SRC_INVERT | |
404 | OR_INVERT = _core_.OR_INVERT | |
405 | NAND = _core_.NAND | |
406 | OR = _core_.OR | |
407 | SET = _core_.SET | |
408 | WXK_BACK = _core_.WXK_BACK | |
409 | WXK_TAB = _core_.WXK_TAB | |
410 | WXK_RETURN = _core_.WXK_RETURN | |
411 | WXK_ESCAPE = _core_.WXK_ESCAPE | |
412 | WXK_SPACE = _core_.WXK_SPACE | |
413 | WXK_DELETE = _core_.WXK_DELETE | |
414 | WXK_START = _core_.WXK_START | |
415 | WXK_LBUTTON = _core_.WXK_LBUTTON | |
416 | WXK_RBUTTON = _core_.WXK_RBUTTON | |
417 | WXK_CANCEL = _core_.WXK_CANCEL | |
418 | WXK_MBUTTON = _core_.WXK_MBUTTON | |
419 | WXK_CLEAR = _core_.WXK_CLEAR | |
420 | WXK_SHIFT = _core_.WXK_SHIFT | |
421 | WXK_ALT = _core_.WXK_ALT | |
422 | WXK_CONTROL = _core_.WXK_CONTROL | |
423 | WXK_MENU = _core_.WXK_MENU | |
424 | WXK_PAUSE = _core_.WXK_PAUSE | |
425 | WXK_CAPITAL = _core_.WXK_CAPITAL | |
426 | WXK_PRIOR = _core_.WXK_PRIOR | |
427 | WXK_NEXT = _core_.WXK_NEXT | |
428 | WXK_END = _core_.WXK_END | |
429 | WXK_HOME = _core_.WXK_HOME | |
430 | WXK_LEFT = _core_.WXK_LEFT | |
431 | WXK_UP = _core_.WXK_UP | |
432 | WXK_RIGHT = _core_.WXK_RIGHT | |
433 | WXK_DOWN = _core_.WXK_DOWN | |
434 | WXK_SELECT = _core_.WXK_SELECT | |
435 | WXK_PRINT = _core_.WXK_PRINT | |
436 | WXK_EXECUTE = _core_.WXK_EXECUTE | |
437 | WXK_SNAPSHOT = _core_.WXK_SNAPSHOT | |
438 | WXK_INSERT = _core_.WXK_INSERT | |
439 | WXK_HELP = _core_.WXK_HELP | |
440 | WXK_NUMPAD0 = _core_.WXK_NUMPAD0 | |
441 | WXK_NUMPAD1 = _core_.WXK_NUMPAD1 | |
442 | WXK_NUMPAD2 = _core_.WXK_NUMPAD2 | |
443 | WXK_NUMPAD3 = _core_.WXK_NUMPAD3 | |
444 | WXK_NUMPAD4 = _core_.WXK_NUMPAD4 | |
445 | WXK_NUMPAD5 = _core_.WXK_NUMPAD5 | |
446 | WXK_NUMPAD6 = _core_.WXK_NUMPAD6 | |
447 | WXK_NUMPAD7 = _core_.WXK_NUMPAD7 | |
448 | WXK_NUMPAD8 = _core_.WXK_NUMPAD8 | |
449 | WXK_NUMPAD9 = _core_.WXK_NUMPAD9 | |
450 | WXK_MULTIPLY = _core_.WXK_MULTIPLY | |
451 | WXK_ADD = _core_.WXK_ADD | |
452 | WXK_SEPARATOR = _core_.WXK_SEPARATOR | |
453 | WXK_SUBTRACT = _core_.WXK_SUBTRACT | |
454 | WXK_DECIMAL = _core_.WXK_DECIMAL | |
455 | WXK_DIVIDE = _core_.WXK_DIVIDE | |
456 | WXK_F1 = _core_.WXK_F1 | |
457 | WXK_F2 = _core_.WXK_F2 | |
458 | WXK_F3 = _core_.WXK_F3 | |
459 | WXK_F4 = _core_.WXK_F4 | |
460 | WXK_F5 = _core_.WXK_F5 | |
461 | WXK_F6 = _core_.WXK_F6 | |
462 | WXK_F7 = _core_.WXK_F7 | |
463 | WXK_F8 = _core_.WXK_F8 | |
464 | WXK_F9 = _core_.WXK_F9 | |
465 | WXK_F10 = _core_.WXK_F10 | |
466 | WXK_F11 = _core_.WXK_F11 | |
467 | WXK_F12 = _core_.WXK_F12 | |
468 | WXK_F13 = _core_.WXK_F13 | |
469 | WXK_F14 = _core_.WXK_F14 | |
470 | WXK_F15 = _core_.WXK_F15 | |
471 | WXK_F16 = _core_.WXK_F16 | |
472 | WXK_F17 = _core_.WXK_F17 | |
473 | WXK_F18 = _core_.WXK_F18 | |
474 | WXK_F19 = _core_.WXK_F19 | |
475 | WXK_F20 = _core_.WXK_F20 | |
476 | WXK_F21 = _core_.WXK_F21 | |
477 | WXK_F22 = _core_.WXK_F22 | |
478 | WXK_F23 = _core_.WXK_F23 | |
479 | WXK_F24 = _core_.WXK_F24 | |
480 | WXK_NUMLOCK = _core_.WXK_NUMLOCK | |
481 | WXK_SCROLL = _core_.WXK_SCROLL | |
482 | WXK_PAGEUP = _core_.WXK_PAGEUP | |
483 | WXK_PAGEDOWN = _core_.WXK_PAGEDOWN | |
484 | WXK_NUMPAD_SPACE = _core_.WXK_NUMPAD_SPACE | |
485 | WXK_NUMPAD_TAB = _core_.WXK_NUMPAD_TAB | |
486 | WXK_NUMPAD_ENTER = _core_.WXK_NUMPAD_ENTER | |
487 | WXK_NUMPAD_F1 = _core_.WXK_NUMPAD_F1 | |
488 | WXK_NUMPAD_F2 = _core_.WXK_NUMPAD_F2 | |
489 | WXK_NUMPAD_F3 = _core_.WXK_NUMPAD_F3 | |
490 | WXK_NUMPAD_F4 = _core_.WXK_NUMPAD_F4 | |
491 | WXK_NUMPAD_HOME = _core_.WXK_NUMPAD_HOME | |
492 | WXK_NUMPAD_LEFT = _core_.WXK_NUMPAD_LEFT | |
493 | WXK_NUMPAD_UP = _core_.WXK_NUMPAD_UP | |
494 | WXK_NUMPAD_RIGHT = _core_.WXK_NUMPAD_RIGHT | |
495 | WXK_NUMPAD_DOWN = _core_.WXK_NUMPAD_DOWN | |
496 | WXK_NUMPAD_PRIOR = _core_.WXK_NUMPAD_PRIOR | |
497 | WXK_NUMPAD_PAGEUP = _core_.WXK_NUMPAD_PAGEUP | |
498 | WXK_NUMPAD_NEXT = _core_.WXK_NUMPAD_NEXT | |
499 | WXK_NUMPAD_PAGEDOWN = _core_.WXK_NUMPAD_PAGEDOWN | |
500 | WXK_NUMPAD_END = _core_.WXK_NUMPAD_END | |
501 | WXK_NUMPAD_BEGIN = _core_.WXK_NUMPAD_BEGIN | |
502 | WXK_NUMPAD_INSERT = _core_.WXK_NUMPAD_INSERT | |
503 | WXK_NUMPAD_DELETE = _core_.WXK_NUMPAD_DELETE | |
504 | WXK_NUMPAD_EQUAL = _core_.WXK_NUMPAD_EQUAL | |
505 | WXK_NUMPAD_MULTIPLY = _core_.WXK_NUMPAD_MULTIPLY | |
506 | WXK_NUMPAD_ADD = _core_.WXK_NUMPAD_ADD | |
507 | WXK_NUMPAD_SEPARATOR = _core_.WXK_NUMPAD_SEPARATOR | |
508 | WXK_NUMPAD_SUBTRACT = _core_.WXK_NUMPAD_SUBTRACT | |
509 | WXK_NUMPAD_DECIMAL = _core_.WXK_NUMPAD_DECIMAL | |
510 | WXK_NUMPAD_DIVIDE = _core_.WXK_NUMPAD_DIVIDE | |
511 | WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT | |
512 | WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT | |
513 | WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU | |
88c6b281 RD |
514 | WXK_COMMAND = _core_.WXK_COMMAND |
515 | WXK_SPECIAL1 = _core_.WXK_SPECIAL1 | |
516 | WXK_SPECIAL2 = _core_.WXK_SPECIAL2 | |
517 | WXK_SPECIAL3 = _core_.WXK_SPECIAL3 | |
518 | WXK_SPECIAL4 = _core_.WXK_SPECIAL4 | |
519 | WXK_SPECIAL5 = _core_.WXK_SPECIAL5 | |
520 | WXK_SPECIAL6 = _core_.WXK_SPECIAL6 | |
521 | WXK_SPECIAL7 = _core_.WXK_SPECIAL7 | |
522 | WXK_SPECIAL8 = _core_.WXK_SPECIAL8 | |
523 | WXK_SPECIAL9 = _core_.WXK_SPECIAL9 | |
524 | WXK_SPECIAL10 = _core_.WXK_SPECIAL10 | |
525 | WXK_SPECIAL11 = _core_.WXK_SPECIAL11 | |
526 | WXK_SPECIAL12 = _core_.WXK_SPECIAL12 | |
527 | WXK_SPECIAL13 = _core_.WXK_SPECIAL13 | |
528 | WXK_SPECIAL14 = _core_.WXK_SPECIAL14 | |
529 | WXK_SPECIAL15 = _core_.WXK_SPECIAL15 | |
530 | WXK_SPECIAL16 = _core_.WXK_SPECIAL16 | |
531 | WXK_SPECIAL17 = _core_.WXK_SPECIAL17 | |
532 | WXK_SPECIAL18 = _core_.WXK_SPECIAL18 | |
533 | WXK_SPECIAL19 = _core_.WXK_SPECIAL19 | |
534 | WXK_SPECIAL20 = _core_.WXK_SPECIAL20 | |
54f9ee45 RD |
535 | PAPER_NONE = _core_.PAPER_NONE |
536 | PAPER_LETTER = _core_.PAPER_LETTER | |
537 | PAPER_LEGAL = _core_.PAPER_LEGAL | |
538 | PAPER_A4 = _core_.PAPER_A4 | |
539 | PAPER_CSHEET = _core_.PAPER_CSHEET | |
540 | PAPER_DSHEET = _core_.PAPER_DSHEET | |
541 | PAPER_ESHEET = _core_.PAPER_ESHEET | |
542 | PAPER_LETTERSMALL = _core_.PAPER_LETTERSMALL | |
543 | PAPER_TABLOID = _core_.PAPER_TABLOID | |
544 | PAPER_LEDGER = _core_.PAPER_LEDGER | |
545 | PAPER_STATEMENT = _core_.PAPER_STATEMENT | |
546 | PAPER_EXECUTIVE = _core_.PAPER_EXECUTIVE | |
547 | PAPER_A3 = _core_.PAPER_A3 | |
548 | PAPER_A4SMALL = _core_.PAPER_A4SMALL | |
549 | PAPER_A5 = _core_.PAPER_A5 | |
550 | PAPER_B4 = _core_.PAPER_B4 | |
551 | PAPER_B5 = _core_.PAPER_B5 | |
552 | PAPER_FOLIO = _core_.PAPER_FOLIO | |
553 | PAPER_QUARTO = _core_.PAPER_QUARTO | |
554 | PAPER_10X14 = _core_.PAPER_10X14 | |
555 | PAPER_11X17 = _core_.PAPER_11X17 | |
556 | PAPER_NOTE = _core_.PAPER_NOTE | |
557 | PAPER_ENV_9 = _core_.PAPER_ENV_9 | |
558 | PAPER_ENV_10 = _core_.PAPER_ENV_10 | |
559 | PAPER_ENV_11 = _core_.PAPER_ENV_11 | |
560 | PAPER_ENV_12 = _core_.PAPER_ENV_12 | |
561 | PAPER_ENV_14 = _core_.PAPER_ENV_14 | |
562 | PAPER_ENV_DL = _core_.PAPER_ENV_DL | |
563 | PAPER_ENV_C5 = _core_.PAPER_ENV_C5 | |
564 | PAPER_ENV_C3 = _core_.PAPER_ENV_C3 | |
565 | PAPER_ENV_C4 = _core_.PAPER_ENV_C4 | |
566 | PAPER_ENV_C6 = _core_.PAPER_ENV_C6 | |
567 | PAPER_ENV_C65 = _core_.PAPER_ENV_C65 | |
568 | PAPER_ENV_B4 = _core_.PAPER_ENV_B4 | |
569 | PAPER_ENV_B5 = _core_.PAPER_ENV_B5 | |
570 | PAPER_ENV_B6 = _core_.PAPER_ENV_B6 | |
571 | PAPER_ENV_ITALY = _core_.PAPER_ENV_ITALY | |
572 | PAPER_ENV_MONARCH = _core_.PAPER_ENV_MONARCH | |
573 | PAPER_ENV_PERSONAL = _core_.PAPER_ENV_PERSONAL | |
574 | PAPER_FANFOLD_US = _core_.PAPER_FANFOLD_US | |
575 | PAPER_FANFOLD_STD_GERMAN = _core_.PAPER_FANFOLD_STD_GERMAN | |
576 | PAPER_FANFOLD_LGL_GERMAN = _core_.PAPER_FANFOLD_LGL_GERMAN | |
577 | PAPER_ISO_B4 = _core_.PAPER_ISO_B4 | |
578 | PAPER_JAPANESE_POSTCARD = _core_.PAPER_JAPANESE_POSTCARD | |
579 | PAPER_9X11 = _core_.PAPER_9X11 | |
580 | PAPER_10X11 = _core_.PAPER_10X11 | |
581 | PAPER_15X11 = _core_.PAPER_15X11 | |
582 | PAPER_ENV_INVITE = _core_.PAPER_ENV_INVITE | |
583 | PAPER_LETTER_EXTRA = _core_.PAPER_LETTER_EXTRA | |
584 | PAPER_LEGAL_EXTRA = _core_.PAPER_LEGAL_EXTRA | |
585 | PAPER_TABLOID_EXTRA = _core_.PAPER_TABLOID_EXTRA | |
586 | PAPER_A4_EXTRA = _core_.PAPER_A4_EXTRA | |
587 | PAPER_LETTER_TRANSVERSE = _core_.PAPER_LETTER_TRANSVERSE | |
588 | PAPER_A4_TRANSVERSE = _core_.PAPER_A4_TRANSVERSE | |
589 | PAPER_LETTER_EXTRA_TRANSVERSE = _core_.PAPER_LETTER_EXTRA_TRANSVERSE | |
590 | PAPER_A_PLUS = _core_.PAPER_A_PLUS | |
591 | PAPER_B_PLUS = _core_.PAPER_B_PLUS | |
592 | PAPER_LETTER_PLUS = _core_.PAPER_LETTER_PLUS | |
593 | PAPER_A4_PLUS = _core_.PAPER_A4_PLUS | |
594 | PAPER_A5_TRANSVERSE = _core_.PAPER_A5_TRANSVERSE | |
595 | PAPER_B5_TRANSVERSE = _core_.PAPER_B5_TRANSVERSE | |
596 | PAPER_A3_EXTRA = _core_.PAPER_A3_EXTRA | |
597 | PAPER_A5_EXTRA = _core_.PAPER_A5_EXTRA | |
598 | PAPER_B5_EXTRA = _core_.PAPER_B5_EXTRA | |
599 | PAPER_A2 = _core_.PAPER_A2 | |
600 | PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE | |
601 | PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE | |
6c75a4cf RD |
602 | PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD |
603 | PAPER_A6 = _core_.PAPER_A6 | |
604 | PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2 | |
605 | PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3 | |
606 | PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3 | |
607 | PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4 | |
608 | PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED | |
609 | PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED | |
610 | PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED | |
611 | PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED | |
612 | PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED | |
613 | PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED | |
614 | PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED | |
615 | PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED | |
616 | PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED | |
617 | PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED | |
618 | PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED | |
619 | PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED | |
620 | PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED | |
621 | PAPER_B6_JIS = _core_.PAPER_B6_JIS | |
622 | PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED | |
623 | PAPER_12X11 = _core_.PAPER_12X11 | |
624 | PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4 | |
625 | PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED | |
626 | PAPER_P16K = _core_.PAPER_P16K | |
627 | PAPER_P32K = _core_.PAPER_P32K | |
628 | PAPER_P32KBIG = _core_.PAPER_P32KBIG | |
629 | PAPER_PENV_1 = _core_.PAPER_PENV_1 | |
630 | PAPER_PENV_2 = _core_.PAPER_PENV_2 | |
631 | PAPER_PENV_3 = _core_.PAPER_PENV_3 | |
632 | PAPER_PENV_4 = _core_.PAPER_PENV_4 | |
633 | PAPER_PENV_5 = _core_.PAPER_PENV_5 | |
634 | PAPER_PENV_6 = _core_.PAPER_PENV_6 | |
635 | PAPER_PENV_7 = _core_.PAPER_PENV_7 | |
636 | PAPER_PENV_8 = _core_.PAPER_PENV_8 | |
637 | PAPER_PENV_9 = _core_.PAPER_PENV_9 | |
638 | PAPER_PENV_10 = _core_.PAPER_PENV_10 | |
639 | PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED | |
640 | PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED | |
641 | PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED | |
642 | PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED | |
643 | PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED | |
644 | PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED | |
645 | PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED | |
646 | PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED | |
647 | PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED | |
648 | PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED | |
649 | PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED | |
650 | PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED | |
651 | PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED | |
54f9ee45 RD |
652 | DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX |
653 | DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL | |
654 | DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL | |
655 | ITEM_SEPARATOR = _core_.ITEM_SEPARATOR | |
656 | ITEM_NORMAL = _core_.ITEM_NORMAL | |
657 | ITEM_CHECK = _core_.ITEM_CHECK | |
658 | ITEM_RADIO = _core_.ITEM_RADIO | |
659 | ITEM_MAX = _core_.ITEM_MAX | |
660 | HT_NOWHERE = _core_.HT_NOWHERE | |
661 | HT_SCROLLBAR_FIRST = _core_.HT_SCROLLBAR_FIRST | |
662 | HT_SCROLLBAR_ARROW_LINE_1 = _core_.HT_SCROLLBAR_ARROW_LINE_1 | |
663 | HT_SCROLLBAR_ARROW_LINE_2 = _core_.HT_SCROLLBAR_ARROW_LINE_2 | |
664 | HT_SCROLLBAR_ARROW_PAGE_1 = _core_.HT_SCROLLBAR_ARROW_PAGE_1 | |
665 | HT_SCROLLBAR_ARROW_PAGE_2 = _core_.HT_SCROLLBAR_ARROW_PAGE_2 | |
666 | HT_SCROLLBAR_THUMB = _core_.HT_SCROLLBAR_THUMB | |
667 | HT_SCROLLBAR_BAR_1 = _core_.HT_SCROLLBAR_BAR_1 | |
668 | HT_SCROLLBAR_BAR_2 = _core_.HT_SCROLLBAR_BAR_2 | |
669 | HT_SCROLLBAR_LAST = _core_.HT_SCROLLBAR_LAST | |
670 | HT_WINDOW_OUTSIDE = _core_.HT_WINDOW_OUTSIDE | |
671 | HT_WINDOW_INSIDE = _core_.HT_WINDOW_INSIDE | |
672 | HT_WINDOW_VERT_SCROLLBAR = _core_.HT_WINDOW_VERT_SCROLLBAR | |
673 | HT_WINDOW_HORZ_SCROLLBAR = _core_.HT_WINDOW_HORZ_SCROLLBAR | |
674 | HT_WINDOW_CORNER = _core_.HT_WINDOW_CORNER | |
675 | HT_MAX = _core_.HT_MAX | |
676 | MOD_NONE = _core_.MOD_NONE | |
677 | MOD_ALT = _core_.MOD_ALT | |
678 | MOD_CONTROL = _core_.MOD_CONTROL | |
943e8dfd | 679 | MOD_ALTGR = _core_.MOD_ALTGR |
54f9ee45 | 680 | MOD_SHIFT = _core_.MOD_SHIFT |
943e8dfd | 681 | MOD_META = _core_.MOD_META |
54f9ee45 | 682 | MOD_WIN = _core_.MOD_WIN |
943e8dfd RD |
683 | MOD_CMD = _core_.MOD_CMD |
684 | MOD_ALL = _core_.MOD_ALL | |
54f9ee45 RD |
685 | UPDATE_UI_NONE = _core_.UPDATE_UI_NONE |
686 | UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE | |
687 | UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE | |
d14a1e28 RD |
688 | #--------------------------------------------------------------------------- |
689 | ||
690 | class Object(object): | |
0df68c9f RD |
691 | """ |
692 | The base class for most wx objects, although in wxPython not | |
693 | much functionality is needed nor exposed. | |
694 | """ | |
0085ce49 RD |
695 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
696 | def __init__(self): raise AttributeError, "No constructor defined" | |
697 | __repr__ = _swig_repr | |
e811c8ce | 698 | def GetClassName(*args, **kwargs): |
0df68c9f | 699 | """ |
a95a7133 | 700 | GetClassName(self) -> String |
e811c8ce | 701 | |
a95a7133 | 702 | Returns the class name of the C++ class using wxRTTI. |
0df68c9f | 703 | """ |
54f9ee45 | 704 | return _core_.Object_GetClassName(*args, **kwargs) |
e811c8ce RD |
705 | |
706 | def Destroy(*args, **kwargs): | |
0df68c9f | 707 | """ |
a95a7133 | 708 | Destroy(self) |
e811c8ce | 709 | |
0df68c9f RD |
710 | Deletes the C++ object this Python object is a proxy for. |
711 | """ | |
7e08d4ef RD |
712 | val = _core_.Object_Destroy(*args, **kwargs) |
713 | args[0].thisown = 0 | |
714 | return val | |
e811c8ce | 715 | |
2131d850 | 716 | _core_.Object_swigregister(Object) |
54f9ee45 | 717 | _wxPySetDictionary = _core_._wxPySetDictionary |
54f9ee45 | 718 | cvar = _core_.cvar |
196addbf | 719 | EmptyString = cvar.EmptyString |
d14a1e28 RD |
720 | |
721 | #--------------------------------------------------------------------------- | |
722 | ||
54f9ee45 RD |
723 | BITMAP_TYPE_INVALID = _core_.BITMAP_TYPE_INVALID |
724 | BITMAP_TYPE_BMP = _core_.BITMAP_TYPE_BMP | |
725 | BITMAP_TYPE_ICO = _core_.BITMAP_TYPE_ICO | |
726 | BITMAP_TYPE_CUR = _core_.BITMAP_TYPE_CUR | |
727 | BITMAP_TYPE_XBM = _core_.BITMAP_TYPE_XBM | |
728 | BITMAP_TYPE_XBM_DATA = _core_.BITMAP_TYPE_XBM_DATA | |
729 | BITMAP_TYPE_XPM = _core_.BITMAP_TYPE_XPM | |
730 | BITMAP_TYPE_XPM_DATA = _core_.BITMAP_TYPE_XPM_DATA | |
731 | BITMAP_TYPE_TIF = _core_.BITMAP_TYPE_TIF | |
732 | BITMAP_TYPE_GIF = _core_.BITMAP_TYPE_GIF | |
733 | BITMAP_TYPE_PNG = _core_.BITMAP_TYPE_PNG | |
734 | BITMAP_TYPE_JPEG = _core_.BITMAP_TYPE_JPEG | |
735 | BITMAP_TYPE_PNM = _core_.BITMAP_TYPE_PNM | |
736 | BITMAP_TYPE_PCX = _core_.BITMAP_TYPE_PCX | |
737 | BITMAP_TYPE_PICT = _core_.BITMAP_TYPE_PICT | |
738 | BITMAP_TYPE_ICON = _core_.BITMAP_TYPE_ICON | |
739 | BITMAP_TYPE_ANI = _core_.BITMAP_TYPE_ANI | |
740 | BITMAP_TYPE_IFF = _core_.BITMAP_TYPE_IFF | |
741 | BITMAP_TYPE_MACCURSOR = _core_.BITMAP_TYPE_MACCURSOR | |
742 | BITMAP_TYPE_ANY = _core_.BITMAP_TYPE_ANY | |
743 | CURSOR_NONE = _core_.CURSOR_NONE | |
744 | CURSOR_ARROW = _core_.CURSOR_ARROW | |
745 | CURSOR_RIGHT_ARROW = _core_.CURSOR_RIGHT_ARROW | |
746 | CURSOR_BULLSEYE = _core_.CURSOR_BULLSEYE | |
747 | CURSOR_CHAR = _core_.CURSOR_CHAR | |
748 | CURSOR_CROSS = _core_.CURSOR_CROSS | |
749 | CURSOR_HAND = _core_.CURSOR_HAND | |
750 | CURSOR_IBEAM = _core_.CURSOR_IBEAM | |
751 | CURSOR_LEFT_BUTTON = _core_.CURSOR_LEFT_BUTTON | |
752 | CURSOR_MAGNIFIER = _core_.CURSOR_MAGNIFIER | |
753 | CURSOR_MIDDLE_BUTTON = _core_.CURSOR_MIDDLE_BUTTON | |
754 | CURSOR_NO_ENTRY = _core_.CURSOR_NO_ENTRY | |
755 | CURSOR_PAINT_BRUSH = _core_.CURSOR_PAINT_BRUSH | |
756 | CURSOR_PENCIL = _core_.CURSOR_PENCIL | |
757 | CURSOR_POINT_LEFT = _core_.CURSOR_POINT_LEFT | |
758 | CURSOR_POINT_RIGHT = _core_.CURSOR_POINT_RIGHT | |
759 | CURSOR_QUESTION_ARROW = _core_.CURSOR_QUESTION_ARROW | |
760 | CURSOR_RIGHT_BUTTON = _core_.CURSOR_RIGHT_BUTTON | |
761 | CURSOR_SIZENESW = _core_.CURSOR_SIZENESW | |
762 | CURSOR_SIZENS = _core_.CURSOR_SIZENS | |
763 | CURSOR_SIZENWSE = _core_.CURSOR_SIZENWSE | |
764 | CURSOR_SIZEWE = _core_.CURSOR_SIZEWE | |
765 | CURSOR_SIZING = _core_.CURSOR_SIZING | |
766 | CURSOR_SPRAYCAN = _core_.CURSOR_SPRAYCAN | |
767 | CURSOR_WAIT = _core_.CURSOR_WAIT | |
768 | CURSOR_WATCH = _core_.CURSOR_WATCH | |
769 | CURSOR_BLANK = _core_.CURSOR_BLANK | |
770 | CURSOR_DEFAULT = _core_.CURSOR_DEFAULT | |
771 | CURSOR_COPY_ARROW = _core_.CURSOR_COPY_ARROW | |
772 | CURSOR_ARROWWAIT = _core_.CURSOR_ARROWWAIT | |
773 | CURSOR_MAX = _core_.CURSOR_MAX | |
d14a1e28 RD |
774 | #--------------------------------------------------------------------------- |
775 | ||
776 | class Size(object): | |
0df68c9f | 777 | """ |
41e2b43e | 778 | wx.Size is a useful data structure used to represent the size of |
0085ce49 RD |
779 | something. It simply contains integer width and height |
780 | properties. In most places in wxPython where a wx.Size is | |
093d3ff1 | 781 | expected a (width, height) tuple can be used instead. |
0df68c9f | 782 | """ |
0085ce49 RD |
783 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
784 | __repr__ = _swig_repr | |
54f9ee45 RD |
785 | width = property(_core_.Size_width_get, _core_.Size_width_set) |
786 | height = property(_core_.Size_height_get, _core_.Size_height_set) | |
242b7b46 | 787 | x = width; y = height |
0085ce49 | 788 | def __init__(self, *args, **kwargs): |
0df68c9f | 789 | """ |
a95a7133 | 790 | __init__(self, int w=0, int h=0) -> Size |
e811c8ce | 791 | |
0df68c9f RD |
792 | Creates a size object. |
793 | """ | |
0085ce49 RD |
794 | _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs)) |
795 | __swig_destroy__ = _core_.delete_Size | |
796 | __del__ = lambda self : None; | |
e811c8ce | 797 | def __eq__(*args, **kwargs): |
0df68c9f | 798 | """ |
e9d6f3a4 | 799 | __eq__(self, PyObject other) -> bool |
e811c8ce | 800 | |
0df68c9f RD |
801 | Test for equality of wx.Size objects. |
802 | """ | |
54f9ee45 | 803 | return _core_.Size___eq__(*args, **kwargs) |
e811c8ce RD |
804 | |
805 | def __ne__(*args, **kwargs): | |
0df68c9f | 806 | """ |
e9d6f3a4 | 807 | __ne__(self, PyObject other) -> bool |
e811c8ce | 808 | |
e9d6f3a4 | 809 | Test for inequality of wx.Size objects. |
0df68c9f | 810 | """ |
54f9ee45 | 811 | return _core_.Size___ne__(*args, **kwargs) |
e811c8ce RD |
812 | |
813 | def __add__(*args, **kwargs): | |
0df68c9f | 814 | """ |
a95a7133 | 815 | __add__(self, Size sz) -> Size |
e811c8ce | 816 | |
0df68c9f RD |
817 | Add sz's proprties to this and return the result. |
818 | """ | |
54f9ee45 | 819 | return _core_.Size___add__(*args, **kwargs) |
e811c8ce RD |
820 | |
821 | def __sub__(*args, **kwargs): | |
0df68c9f | 822 | """ |
a95a7133 | 823 | __sub__(self, Size sz) -> Size |
e811c8ce | 824 | |
0df68c9f RD |
825 | Subtract sz's properties from this and return the result. |
826 | """ | |
54f9ee45 | 827 | return _core_.Size___sub__(*args, **kwargs) |
e811c8ce RD |
828 | |
829 | def IncTo(*args, **kwargs): | |
0df68c9f | 830 | """ |
a95a7133 | 831 | IncTo(self, Size sz) |
e811c8ce | 832 | |
0df68c9f RD |
833 | Increments this object so that both of its dimensions are not less |
834 | than the corresponding dimensions of the size. | |
835 | """ | |
54f9ee45 | 836 | return _core_.Size_IncTo(*args, **kwargs) |
e811c8ce RD |
837 | |
838 | def DecTo(*args, **kwargs): | |
0df68c9f | 839 | """ |
a95a7133 | 840 | DecTo(self, Size sz) |
e811c8ce | 841 | |
0df68c9f RD |
842 | Decrements this object so that both of its dimensions are not greater |
843 | than the corresponding dimensions of the size. | |
844 | """ | |
54f9ee45 | 845 | return _core_.Size_DecTo(*args, **kwargs) |
e811c8ce RD |
846 | |
847 | def Set(*args, **kwargs): | |
0df68c9f | 848 | """ |
a95a7133 | 849 | Set(self, int w, int h) |
e811c8ce | 850 | |
0df68c9f RD |
851 | Set both width and height. |
852 | """ | |
54f9ee45 | 853 | return _core_.Size_Set(*args, **kwargs) |
e811c8ce RD |
854 | |
855 | def SetWidth(*args, **kwargs): | |
a95a7133 | 856 | """SetWidth(self, int w)""" |
54f9ee45 | 857 | return _core_.Size_SetWidth(*args, **kwargs) |
e811c8ce RD |
858 | |
859 | def SetHeight(*args, **kwargs): | |
a95a7133 | 860 | """SetHeight(self, int h)""" |
54f9ee45 | 861 | return _core_.Size_SetHeight(*args, **kwargs) |
e811c8ce RD |
862 | |
863 | def GetWidth(*args, **kwargs): | |
a95a7133 | 864 | """GetWidth(self) -> int""" |
54f9ee45 | 865 | return _core_.Size_GetWidth(*args, **kwargs) |
e811c8ce RD |
866 | |
867 | def GetHeight(*args, **kwargs): | |
a95a7133 | 868 | """GetHeight(self) -> int""" |
54f9ee45 | 869 | return _core_.Size_GetHeight(*args, **kwargs) |
e811c8ce | 870 | |
74a57fcd RD |
871 | def IsFullySpecified(*args, **kwargs): |
872 | """ | |
a95a7133 | 873 | IsFullySpecified(self) -> bool |
74a57fcd RD |
874 | |
875 | Returns True if both components of the size are non-default values. | |
876 | """ | |
54f9ee45 | 877 | return _core_.Size_IsFullySpecified(*args, **kwargs) |
74a57fcd RD |
878 | |
879 | def SetDefaults(*args, **kwargs): | |
880 | """ | |
a95a7133 | 881 | SetDefaults(self, Size size) |
74a57fcd | 882 | |
41e2b43e RD |
883 | Combine this size with the other one replacing the default components |
884 | of this object (i.e. equal to -1) with those of the other. | |
74a57fcd | 885 | """ |
54f9ee45 | 886 | return _core_.Size_SetDefaults(*args, **kwargs) |
74a57fcd | 887 | |
e811c8ce | 888 | def Get(*args, **kwargs): |
0df68c9f RD |
889 | """ |
890 | Get() -> (width,height) | |
e811c8ce | 891 | |
0df68c9f RD |
892 | Returns the width and height properties as a tuple. |
893 | """ | |
54f9ee45 | 894 | return _core_.Size_Get(*args, **kwargs) |
e811c8ce | 895 | |
41e2b43e | 896 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
897 | def __str__(self): return str(self.Get()) |
898 | def __repr__(self): return 'wx.Size'+str(self.Get()) | |
899 | def __len__(self): return len(self.Get()) | |
900 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
901 | def __setitem__(self, index, val): |
902 | if index == 0: self.width = val | |
903 | elif index == 1: self.height = val | |
904 | else: raise IndexError | |
e811c8ce | 905 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
906 | __safe_for_unpickling__ = True |
907 | def __reduce__(self): return (wx.Size, self.Get()) | |
d14a1e28 | 908 | |
2131d850 | 909 | _core_.Size_swigregister(Size) |
d14a1e28 RD |
910 | |
911 | #--------------------------------------------------------------------------- | |
912 | ||
913 | class RealPoint(object): | |
0df68c9f | 914 | """ |
41e2b43e RD |
915 | A data structure for representing a point or position with floating |
916 | point x and y properties. In wxPython most places that expect a | |
917 | wx.RealPoint can also accept a (x,y) tuple. | |
0df68c9f | 918 | """ |
0085ce49 RD |
919 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
920 | __repr__ = _swig_repr | |
54f9ee45 RD |
921 | x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set) |
922 | y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set) | |
0085ce49 | 923 | def __init__(self, *args, **kwargs): |
0df68c9f | 924 | """ |
a95a7133 | 925 | __init__(self, double x=0.0, double y=0.0) -> RealPoint |
e811c8ce | 926 | |
0df68c9f RD |
927 | Create a wx.RealPoint object |
928 | """ | |
0085ce49 RD |
929 | _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs)) |
930 | __swig_destroy__ = _core_.delete_RealPoint | |
931 | __del__ = lambda self : None; | |
e811c8ce | 932 | def __eq__(*args, **kwargs): |
0df68c9f | 933 | """ |
e9d6f3a4 | 934 | __eq__(self, PyObject other) -> bool |
e811c8ce | 935 | |
0df68c9f RD |
936 | Test for equality of wx.RealPoint objects. |
937 | """ | |
54f9ee45 | 938 | return _core_.RealPoint___eq__(*args, **kwargs) |
e811c8ce RD |
939 | |
940 | def __ne__(*args, **kwargs): | |
0df68c9f | 941 | """ |
e9d6f3a4 | 942 | __ne__(self, PyObject other) -> bool |
e811c8ce | 943 | |
0df68c9f RD |
944 | Test for inequality of wx.RealPoint objects. |
945 | """ | |
54f9ee45 | 946 | return _core_.RealPoint___ne__(*args, **kwargs) |
e811c8ce RD |
947 | |
948 | def __add__(*args, **kwargs): | |
0df68c9f | 949 | """ |
a95a7133 | 950 | __add__(self, RealPoint pt) -> RealPoint |
e811c8ce | 951 | |
0df68c9f RD |
952 | Add pt's proprties to this and return the result. |
953 | """ | |
54f9ee45 | 954 | return _core_.RealPoint___add__(*args, **kwargs) |
e811c8ce RD |
955 | |
956 | def __sub__(*args, **kwargs): | |
0df68c9f | 957 | """ |
a95a7133 | 958 | __sub__(self, RealPoint pt) -> RealPoint |
e811c8ce | 959 | |
0df68c9f RD |
960 | Subtract pt's proprties from this and return the result |
961 | """ | |
54f9ee45 | 962 | return _core_.RealPoint___sub__(*args, **kwargs) |
e811c8ce RD |
963 | |
964 | def Set(*args, **kwargs): | |
0df68c9f | 965 | """ |
a95a7133 | 966 | Set(self, double x, double y) |
e811c8ce | 967 | |
0df68c9f RD |
968 | Set both the x and y properties |
969 | """ | |
54f9ee45 | 970 | return _core_.RealPoint_Set(*args, **kwargs) |
e811c8ce RD |
971 | |
972 | def Get(*args, **kwargs): | |
0df68c9f RD |
973 | """ |
974 | Get() -> (x,y) | |
e811c8ce | 975 | |
0df68c9f RD |
976 | Return the x and y properties as a tuple. |
977 | """ | |
54f9ee45 | 978 | return _core_.RealPoint_Get(*args, **kwargs) |
e811c8ce | 979 | |
41e2b43e | 980 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
981 | def __str__(self): return str(self.Get()) |
982 | def __repr__(self): return 'wx.RealPoint'+str(self.Get()) | |
983 | def __len__(self): return len(self.Get()) | |
984 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 | 985 | def __setitem__(self, index, val): |
e811c8ce RD |
986 | if index == 0: self.x = val |
987 | elif index == 1: self.y = val | |
d14a1e28 | 988 | else: raise IndexError |
e811c8ce | 989 | def __nonzero__(self): return self.Get() != (0.0, 0.0) |
74e96f3d RD |
990 | __safe_for_unpickling__ = True |
991 | def __reduce__(self): return (wx.RealPoint, self.Get()) | |
d14a1e28 | 992 | |
2131d850 | 993 | _core_.RealPoint_swigregister(RealPoint) |
d14a1e28 RD |
994 | |
995 | #--------------------------------------------------------------------------- | |
996 | ||
997 | class Point(object): | |
0df68c9f | 998 | """ |
41e2b43e RD |
999 | A data structure for representing a point or position with integer x |
1000 | and y properties. Most places in wxPython that expect a wx.Point can | |
1001 | also accept a (x,y) tuple. | |
0df68c9f | 1002 | """ |
0085ce49 RD |
1003 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1004 | __repr__ = _swig_repr | |
54f9ee45 RD |
1005 | x = property(_core_.Point_x_get, _core_.Point_x_set) |
1006 | y = property(_core_.Point_y_get, _core_.Point_y_set) | |
0085ce49 | 1007 | def __init__(self, *args, **kwargs): |
0df68c9f | 1008 | """ |
a95a7133 | 1009 | __init__(self, int x=0, int y=0) -> Point |
e811c8ce | 1010 | |
0df68c9f RD |
1011 | Create a wx.Point object |
1012 | """ | |
0085ce49 RD |
1013 | _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs)) |
1014 | __swig_destroy__ = _core_.delete_Point | |
1015 | __del__ = lambda self : None; | |
e811c8ce | 1016 | def __eq__(*args, **kwargs): |
0df68c9f | 1017 | """ |
e9d6f3a4 | 1018 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1019 | |
0df68c9f RD |
1020 | Test for equality of wx.Point objects. |
1021 | """ | |
54f9ee45 | 1022 | return _core_.Point___eq__(*args, **kwargs) |
e811c8ce RD |
1023 | |
1024 | def __ne__(*args, **kwargs): | |
0df68c9f | 1025 | """ |
e9d6f3a4 | 1026 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1027 | |
0df68c9f RD |
1028 | Test for inequality of wx.Point objects. |
1029 | """ | |
54f9ee45 | 1030 | return _core_.Point___ne__(*args, **kwargs) |
e811c8ce RD |
1031 | |
1032 | def __add__(*args, **kwargs): | |
0df68c9f | 1033 | """ |
a95a7133 | 1034 | __add__(self, Point pt) -> Point |
e811c8ce | 1035 | |
0df68c9f RD |
1036 | Add pt's proprties to this and return the result. |
1037 | """ | |
54f9ee45 | 1038 | return _core_.Point___add__(*args, **kwargs) |
e811c8ce RD |
1039 | |
1040 | def __sub__(*args, **kwargs): | |
0df68c9f | 1041 | """ |
a95a7133 | 1042 | __sub__(self, Point pt) -> Point |
e811c8ce | 1043 | |
0df68c9f RD |
1044 | Subtract pt's proprties from this and return the result |
1045 | """ | |
54f9ee45 | 1046 | return _core_.Point___sub__(*args, **kwargs) |
e811c8ce RD |
1047 | |
1048 | def __iadd__(*args, **kwargs): | |
0df68c9f | 1049 | """ |
a95a7133 | 1050 | __iadd__(self, Point pt) -> Point |
e811c8ce | 1051 | |
0df68c9f RD |
1052 | Add pt to this object. |
1053 | """ | |
54f9ee45 | 1054 | return _core_.Point___iadd__(*args, **kwargs) |
e811c8ce RD |
1055 | |
1056 | def __isub__(*args, **kwargs): | |
0df68c9f | 1057 | """ |
a95a7133 | 1058 | __isub__(self, Point pt) -> Point |
e811c8ce | 1059 | |
0df68c9f RD |
1060 | Subtract pt from this object. |
1061 | """ | |
54f9ee45 | 1062 | return _core_.Point___isub__(*args, **kwargs) |
e811c8ce RD |
1063 | |
1064 | def Set(*args, **kwargs): | |
0df68c9f | 1065 | """ |
a95a7133 | 1066 | Set(self, long x, long y) |
e811c8ce | 1067 | |
0df68c9f RD |
1068 | Set both the x and y properties |
1069 | """ | |
54f9ee45 | 1070 | return _core_.Point_Set(*args, **kwargs) |
e811c8ce RD |
1071 | |
1072 | def Get(*args, **kwargs): | |
0df68c9f RD |
1073 | """ |
1074 | Get() -> (x,y) | |
e811c8ce | 1075 | |
0df68c9f RD |
1076 | Return the x and y properties as a tuple. |
1077 | """ | |
54f9ee45 | 1078 | return _core_.Point_Get(*args, **kwargs) |
e811c8ce | 1079 | |
41e2b43e | 1080 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1081 | def __str__(self): return str(self.Get()) |
1082 | def __repr__(self): return 'wx.Point'+str(self.Get()) | |
1083 | def __len__(self): return len(self.Get()) | |
1084 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
1085 | def __setitem__(self, index, val): |
1086 | if index == 0: self.x = val | |
1087 | elif index == 1: self.y = val | |
1088 | else: raise IndexError | |
e811c8ce | 1089 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
1090 | __safe_for_unpickling__ = True |
1091 | def __reduce__(self): return (wx.Point, self.Get()) | |
d14a1e28 | 1092 | |
2131d850 | 1093 | _core_.Point_swigregister(Point) |
d14a1e28 RD |
1094 | |
1095 | #--------------------------------------------------------------------------- | |
1096 | ||
1097 | class Rect(object): | |
0df68c9f | 1098 | """ |
41e2b43e RD |
1099 | A class for representing and manipulating rectangles. It has x, y, |
1100 | width and height properties. In wxPython most palces that expect a | |
1101 | wx.Rect can also accept a (x,y,width,height) tuple. | |
0df68c9f | 1102 | """ |
0085ce49 RD |
1103 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1104 | __repr__ = _swig_repr | |
1105 | def __init__(self, *args, **kwargs): | |
0df68c9f | 1106 | """ |
a95a7133 | 1107 | __init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect |
e811c8ce | 1108 | |
0df68c9f RD |
1109 | Create a new Rect object. |
1110 | """ | |
0085ce49 RD |
1111 | _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs)) |
1112 | __swig_destroy__ = _core_.delete_Rect | |
1113 | __del__ = lambda self : None; | |
e811c8ce | 1114 | def GetX(*args, **kwargs): |
a95a7133 | 1115 | """GetX(self) -> int""" |
54f9ee45 | 1116 | return _core_.Rect_GetX(*args, **kwargs) |
e811c8ce RD |
1117 | |
1118 | def SetX(*args, **kwargs): | |
a95a7133 | 1119 | """SetX(self, int x)""" |
54f9ee45 | 1120 | return _core_.Rect_SetX(*args, **kwargs) |
e811c8ce RD |
1121 | |
1122 | def GetY(*args, **kwargs): | |
a95a7133 | 1123 | """GetY(self) -> int""" |
54f9ee45 | 1124 | return _core_.Rect_GetY(*args, **kwargs) |
e811c8ce RD |
1125 | |
1126 | def SetY(*args, **kwargs): | |
a95a7133 | 1127 | """SetY(self, int y)""" |
54f9ee45 | 1128 | return _core_.Rect_SetY(*args, **kwargs) |
e811c8ce RD |
1129 | |
1130 | def GetWidth(*args, **kwargs): | |
a95a7133 | 1131 | """GetWidth(self) -> int""" |
54f9ee45 | 1132 | return _core_.Rect_GetWidth(*args, **kwargs) |
e811c8ce RD |
1133 | |
1134 | def SetWidth(*args, **kwargs): | |
a95a7133 | 1135 | """SetWidth(self, int w)""" |
54f9ee45 | 1136 | return _core_.Rect_SetWidth(*args, **kwargs) |
e811c8ce RD |
1137 | |
1138 | def GetHeight(*args, **kwargs): | |
a95a7133 | 1139 | """GetHeight(self) -> int""" |
54f9ee45 | 1140 | return _core_.Rect_GetHeight(*args, **kwargs) |
e811c8ce RD |
1141 | |
1142 | def SetHeight(*args, **kwargs): | |
a95a7133 | 1143 | """SetHeight(self, int h)""" |
54f9ee45 | 1144 | return _core_.Rect_SetHeight(*args, **kwargs) |
e811c8ce RD |
1145 | |
1146 | def GetPosition(*args, **kwargs): | |
a95a7133 | 1147 | """GetPosition(self) -> Point""" |
54f9ee45 | 1148 | return _core_.Rect_GetPosition(*args, **kwargs) |
e811c8ce RD |
1149 | |
1150 | def SetPosition(*args, **kwargs): | |
a95a7133 | 1151 | """SetPosition(self, Point p)""" |
54f9ee45 | 1152 | return _core_.Rect_SetPosition(*args, **kwargs) |
e811c8ce RD |
1153 | |
1154 | def GetSize(*args, **kwargs): | |
a95a7133 | 1155 | """GetSize(self) -> Size""" |
54f9ee45 | 1156 | return _core_.Rect_GetSize(*args, **kwargs) |
e811c8ce RD |
1157 | |
1158 | def SetSize(*args, **kwargs): | |
a95a7133 | 1159 | """SetSize(self, Size s)""" |
54f9ee45 | 1160 | return _core_.Rect_SetSize(*args, **kwargs) |
e811c8ce | 1161 | |
aff4cc5c RD |
1162 | def IsEmpty(*args, **kwargs): |
1163 | """IsEmpty(self) -> bool""" | |
1164 | return _core_.Rect_IsEmpty(*args, **kwargs) | |
1165 | ||
c9c7117a | 1166 | def GetTopLeft(*args, **kwargs): |
a95a7133 | 1167 | """GetTopLeft(self) -> Point""" |
54f9ee45 | 1168 | return _core_.Rect_GetTopLeft(*args, **kwargs) |
c9c7117a RD |
1169 | |
1170 | def SetTopLeft(*args, **kwargs): | |
a95a7133 | 1171 | """SetTopLeft(self, Point p)""" |
54f9ee45 | 1172 | return _core_.Rect_SetTopLeft(*args, **kwargs) |
c9c7117a RD |
1173 | |
1174 | def GetBottomRight(*args, **kwargs): | |
a95a7133 | 1175 | """GetBottomRight(self) -> Point""" |
54f9ee45 | 1176 | return _core_.Rect_GetBottomRight(*args, **kwargs) |
c9c7117a RD |
1177 | |
1178 | def SetBottomRight(*args, **kwargs): | |
a95a7133 | 1179 | """SetBottomRight(self, Point p)""" |
54f9ee45 | 1180 | return _core_.Rect_SetBottomRight(*args, **kwargs) |
c9c7117a | 1181 | |
e811c8ce | 1182 | def GetLeft(*args, **kwargs): |
a95a7133 | 1183 | """GetLeft(self) -> int""" |
54f9ee45 | 1184 | return _core_.Rect_GetLeft(*args, **kwargs) |
e811c8ce RD |
1185 | |
1186 | def GetTop(*args, **kwargs): | |
a95a7133 | 1187 | """GetTop(self) -> int""" |
54f9ee45 | 1188 | return _core_.Rect_GetTop(*args, **kwargs) |
e811c8ce RD |
1189 | |
1190 | def GetBottom(*args, **kwargs): | |
a95a7133 | 1191 | """GetBottom(self) -> int""" |
54f9ee45 | 1192 | return _core_.Rect_GetBottom(*args, **kwargs) |
e811c8ce RD |
1193 | |
1194 | def GetRight(*args, **kwargs): | |
a95a7133 | 1195 | """GetRight(self) -> int""" |
54f9ee45 | 1196 | return _core_.Rect_GetRight(*args, **kwargs) |
e811c8ce RD |
1197 | |
1198 | def SetLeft(*args, **kwargs): | |
a95a7133 | 1199 | """SetLeft(self, int left)""" |
54f9ee45 | 1200 | return _core_.Rect_SetLeft(*args, **kwargs) |
e811c8ce RD |
1201 | |
1202 | def SetRight(*args, **kwargs): | |
a95a7133 | 1203 | """SetRight(self, int right)""" |
54f9ee45 | 1204 | return _core_.Rect_SetRight(*args, **kwargs) |
e811c8ce RD |
1205 | |
1206 | def SetTop(*args, **kwargs): | |
a95a7133 | 1207 | """SetTop(self, int top)""" |
54f9ee45 | 1208 | return _core_.Rect_SetTop(*args, **kwargs) |
e811c8ce RD |
1209 | |
1210 | def SetBottom(*args, **kwargs): | |
a95a7133 | 1211 | """SetBottom(self, int bottom)""" |
54f9ee45 | 1212 | return _core_.Rect_SetBottom(*args, **kwargs) |
e811c8ce RD |
1213 | |
1214 | position = property(GetPosition, SetPosition) | |
1215 | size = property(GetSize, SetSize) | |
1216 | left = property(GetLeft, SetLeft) | |
1217 | right = property(GetRight, SetRight) | |
1218 | top = property(GetTop, SetTop) | |
1219 | bottom = property(GetBottom, SetBottom) | |
1220 | ||
1221 | def Inflate(*args, **kwargs): | |
0df68c9f | 1222 | """ |
a95a7133 | 1223 | Inflate(self, int dx, int dy) -> Rect |
e811c8ce | 1224 | |
8e738329 RD |
1225 | Increases the size of the rectangle. |
1226 | ||
1227 | The left border is moved farther left and the right border is moved | |
1228 | farther right by ``dx``. The upper border is moved farther up and the | |
1229 | bottom border is moved farther down by ``dy``. (Note the the width and | |
1230 | height of the rectangle thus change by ``2*dx`` and ``2*dy``, | |
1231 | respectively.) If one or both of ``dx`` and ``dy`` are negative, the | |
1232 | opposite happens: the rectangle size decreases in the respective | |
1233 | direction. | |
1234 | ||
1235 | The change is made to the rectangle inplace, if instead you need a | |
1236 | copy that is inflated, preserving the original then make the copy | |
1237 | first:: | |
1238 | ||
1239 | copy = wx.Rect(*original) | |
1240 | copy.Inflate(10,15) | |
1241 | ||
1242 | ||
0df68c9f | 1243 | """ |
54f9ee45 | 1244 | return _core_.Rect_Inflate(*args, **kwargs) |
e811c8ce RD |
1245 | |
1246 | def Deflate(*args, **kwargs): | |
0df68c9f | 1247 | """ |
a95a7133 | 1248 | Deflate(self, int dx, int dy) -> Rect |
e811c8ce | 1249 | |
8e738329 RD |
1250 | Decrease the rectangle size. This method is the opposite of `Inflate` |
1251 | in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to | |
1252 | `Inflate` for a full description. | |
0df68c9f | 1253 | """ |
54f9ee45 | 1254 | return _core_.Rect_Deflate(*args, **kwargs) |
e811c8ce RD |
1255 | |
1256 | def OffsetXY(*args, **kwargs): | |
0df68c9f | 1257 | """ |
a95a7133 | 1258 | OffsetXY(self, int dx, int dy) |
e811c8ce | 1259 | |
41e2b43e RD |
1260 | Moves the rectangle by the specified offset. If dx is positive, the |
1261 | rectangle is moved to the right, if dy is positive, it is moved to the | |
1262 | bottom, otherwise it is moved to the left or top respectively. | |
0df68c9f | 1263 | """ |
54f9ee45 | 1264 | return _core_.Rect_OffsetXY(*args, **kwargs) |
e811c8ce RD |
1265 | |
1266 | def Offset(*args, **kwargs): | |
0df68c9f | 1267 | """ |
a95a7133 | 1268 | Offset(self, Point pt) |
e811c8ce | 1269 | |
b1fcee84 | 1270 | Same as `OffsetXY` but uses dx,dy from Point |
0df68c9f | 1271 | """ |
54f9ee45 | 1272 | return _core_.Rect_Offset(*args, **kwargs) |
e811c8ce RD |
1273 | |
1274 | def Intersect(*args, **kwargs): | |
0df68c9f | 1275 | """ |
a95a7133 | 1276 | Intersect(self, Rect rect) -> Rect |
e811c8ce | 1277 | |
5cbf236d | 1278 | Returns the intersectsion of this rectangle and rect. |
0df68c9f | 1279 | """ |
54f9ee45 | 1280 | return _core_.Rect_Intersect(*args, **kwargs) |
e811c8ce | 1281 | |
5cbf236d RD |
1282 | def Union(*args, **kwargs): |
1283 | """ | |
1284 | Union(self, Rect rect) -> Rect | |
1285 | ||
1286 | Returns the union of this rectangle and rect. | |
1287 | """ | |
1288 | return _core_.Rect_Union(*args, **kwargs) | |
1289 | ||
e811c8ce | 1290 | def __add__(*args, **kwargs): |
0df68c9f | 1291 | """ |
a95a7133 | 1292 | __add__(self, Rect rect) -> Rect |
e811c8ce | 1293 | |
0df68c9f RD |
1294 | Add the properties of rect to this rectangle and return the result. |
1295 | """ | |
54f9ee45 | 1296 | return _core_.Rect___add__(*args, **kwargs) |
e811c8ce RD |
1297 | |
1298 | def __iadd__(*args, **kwargs): | |
0df68c9f | 1299 | """ |
a95a7133 | 1300 | __iadd__(self, Rect rect) -> Rect |
e811c8ce | 1301 | |
0df68c9f RD |
1302 | Add the properties of rect to this rectangle, updating this rectangle. |
1303 | """ | |
54f9ee45 | 1304 | return _core_.Rect___iadd__(*args, **kwargs) |
e811c8ce RD |
1305 | |
1306 | def __eq__(*args, **kwargs): | |
0df68c9f | 1307 | """ |
e9d6f3a4 | 1308 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1309 | |
e9d6f3a4 | 1310 | Test for equality of wx.Rect objects. |
0df68c9f | 1311 | """ |
54f9ee45 | 1312 | return _core_.Rect___eq__(*args, **kwargs) |
e811c8ce RD |
1313 | |
1314 | def __ne__(*args, **kwargs): | |
0df68c9f | 1315 | """ |
e9d6f3a4 | 1316 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1317 | |
e9d6f3a4 | 1318 | Test for inequality of wx.Rect objects. |
0df68c9f | 1319 | """ |
54f9ee45 | 1320 | return _core_.Rect___ne__(*args, **kwargs) |
e811c8ce RD |
1321 | |
1322 | def InsideXY(*args, **kwargs): | |
0df68c9f | 1323 | """ |
a95a7133 | 1324 | InsideXY(self, int x, int y) -> bool |
e811c8ce | 1325 | |
0df68c9f RD |
1326 | Return True if the point is (not strcitly) inside the rect. |
1327 | """ | |
54f9ee45 | 1328 | return _core_.Rect_InsideXY(*args, **kwargs) |
e811c8ce RD |
1329 | |
1330 | def Inside(*args, **kwargs): | |
0df68c9f | 1331 | """ |
a95a7133 | 1332 | Inside(self, Point pt) -> bool |
e811c8ce | 1333 | |
0df68c9f RD |
1334 | Return True if the point is (not strcitly) inside the rect. |
1335 | """ | |
54f9ee45 | 1336 | return _core_.Rect_Inside(*args, **kwargs) |
e811c8ce RD |
1337 | |
1338 | def Intersects(*args, **kwargs): | |
0df68c9f | 1339 | """ |
a95a7133 | 1340 | Intersects(self, Rect rect) -> bool |
e811c8ce | 1341 | |
0df68c9f RD |
1342 | Returns True if the rectangles have a non empty intersection. |
1343 | """ | |
54f9ee45 | 1344 | return _core_.Rect_Intersects(*args, **kwargs) |
e811c8ce | 1345 | |
b1fcee84 RD |
1346 | def CenterIn(*args, **kwargs): |
1347 | """ | |
1348 | CenterIn(self, Rect r, int dir=BOTH) -> Rect | |
1349 | ||
1350 | Center this rectangle within the one passed to the method, which is | |
1351 | usually, but not necessarily, the larger one. | |
1352 | """ | |
1353 | return _core_.Rect_CenterIn(*args, **kwargs) | |
1354 | ||
1355 | CentreIn = CenterIn | |
54f9ee45 RD |
1356 | x = property(_core_.Rect_x_get, _core_.Rect_x_set) |
1357 | y = property(_core_.Rect_y_get, _core_.Rect_y_set) | |
1358 | width = property(_core_.Rect_width_get, _core_.Rect_width_set) | |
1359 | height = property(_core_.Rect_height_get, _core_.Rect_height_set) | |
e811c8ce | 1360 | def Set(*args, **kwargs): |
0df68c9f | 1361 | """ |
a95a7133 | 1362 | Set(self, int x=0, int y=0, int width=0, int height=0) |
e811c8ce | 1363 | |
0df68c9f RD |
1364 | Set all rectangle properties. |
1365 | """ | |
54f9ee45 | 1366 | return _core_.Rect_Set(*args, **kwargs) |
e811c8ce RD |
1367 | |
1368 | def Get(*args, **kwargs): | |
0df68c9f RD |
1369 | """ |
1370 | Get() -> (x,y,width,height) | |
e811c8ce | 1371 | |
0df68c9f RD |
1372 | Return the rectangle properties as a tuple. |
1373 | """ | |
54f9ee45 | 1374 | return _core_.Rect_Get(*args, **kwargs) |
e811c8ce | 1375 | |
41e2b43e | 1376 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1377 | def __str__(self): return str(self.Get()) |
1378 | def __repr__(self): return 'wx.Rect'+str(self.Get()) | |
1379 | def __len__(self): return len(self.Get()) | |
1380 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
1381 | def __setitem__(self, index, val): |
1382 | if index == 0: self.x = val | |
1383 | elif index == 1: self.y = val | |
1384 | elif index == 2: self.width = val | |
1385 | elif index == 3: self.height = val | |
1386 | else: raise IndexError | |
e811c8ce | 1387 | def __nonzero__(self): return self.Get() != (0,0,0,0) |
74e96f3d RD |
1388 | __safe_for_unpickling__ = True |
1389 | def __reduce__(self): return (wx.Rect, self.Get()) | |
d14a1e28 | 1390 | |
2131d850 | 1391 | _core_.Rect_swigregister(Rect) |
d14a1e28 RD |
1392 | |
1393 | def RectPP(*args, **kwargs): | |
0df68c9f RD |
1394 | """ |
1395 | RectPP(Point topLeft, Point bottomRight) -> Rect | |
e811c8ce | 1396 | |
0df68c9f RD |
1397 | Create a new Rect object from Points representing two corners. |
1398 | """ | |
54f9ee45 | 1399 | val = _core_.new_RectPP(*args, **kwargs) |
d14a1e28 RD |
1400 | return val |
1401 | ||
1402 | def RectPS(*args, **kwargs): | |
0df68c9f RD |
1403 | """ |
1404 | RectPS(Point pos, Size size) -> Rect | |
e811c8ce | 1405 | |
0df68c9f RD |
1406 | Create a new Rect from a position and size. |
1407 | """ | |
54f9ee45 | 1408 | val = _core_.new_RectPS(*args, **kwargs) |
d14a1e28 RD |
1409 | return val |
1410 | ||
d3b6e4ff RD |
1411 | def RectS(*args, **kwargs): |
1412 | """ | |
1413 | RectS(Size size) -> Rect | |
1414 | ||
1415 | Create a new Rect from a size only. | |
1416 | """ | |
1417 | val = _core_.new_RectS(*args, **kwargs) | |
d3b6e4ff RD |
1418 | return val |
1419 | ||
d14a1e28 | 1420 | |
e811c8ce | 1421 | def IntersectRect(*args, **kwargs): |
0085ce49 | 1422 | """ |
0df68c9f | 1423 | IntersectRect(Rect r1, Rect r2) -> Rect |
e811c8ce | 1424 | |
0df68c9f RD |
1425 | Calculate and return the intersection of r1 and r2. |
1426 | """ | |
0085ce49 | 1427 | return _core_.IntersectRect(*args, **kwargs) |
d14a1e28 RD |
1428 | #--------------------------------------------------------------------------- |
1429 | ||
1430 | class Point2D(object): | |
41e2b43e RD |
1431 | """ |
1432 | wx.Point2Ds represent a point or a vector in a 2d coordinate system | |
1433 | with floating point values. | |
1434 | """ | |
0085ce49 RD |
1435 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1436 | __repr__ = _swig_repr | |
1437 | def __init__(self, *args, **kwargs): | |
0df68c9f | 1438 | """ |
a95a7133 | 1439 | __init__(self, double x=0.0, double y=0.0) -> Point2D |
e811c8ce | 1440 | |
0df68c9f RD |
1441 | Create a w.Point2D object. |
1442 | """ | |
0085ce49 | 1443 | _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs)) |
e811c8ce | 1444 | def GetFloor(*args, **kwargs): |
fd2dc343 RD |
1445 | """ |
1446 | GetFloor() -> (x,y) | |
1447 | ||
1448 | Convert to integer | |
1449 | """ | |
54f9ee45 | 1450 | return _core_.Point2D_GetFloor(*args, **kwargs) |
e811c8ce RD |
1451 | |
1452 | def GetRounded(*args, **kwargs): | |
fd2dc343 RD |
1453 | """ |
1454 | GetRounded() -> (x,y) | |
1455 | ||
1456 | Convert to integer | |
1457 | """ | |
54f9ee45 | 1458 | return _core_.Point2D_GetRounded(*args, **kwargs) |
e811c8ce RD |
1459 | |
1460 | def GetVectorLength(*args, **kwargs): | |
a95a7133 | 1461 | """GetVectorLength(self) -> double""" |
54f9ee45 | 1462 | return _core_.Point2D_GetVectorLength(*args, **kwargs) |
e811c8ce RD |
1463 | |
1464 | def GetVectorAngle(*args, **kwargs): | |
a95a7133 | 1465 | """GetVectorAngle(self) -> double""" |
54f9ee45 | 1466 | return _core_.Point2D_GetVectorAngle(*args, **kwargs) |
e811c8ce RD |
1467 | |
1468 | def SetVectorLength(*args, **kwargs): | |
a95a7133 | 1469 | """SetVectorLength(self, double length)""" |
54f9ee45 | 1470 | return _core_.Point2D_SetVectorLength(*args, **kwargs) |
e811c8ce RD |
1471 | |
1472 | def SetVectorAngle(*args, **kwargs): | |
a95a7133 | 1473 | """SetVectorAngle(self, double degrees)""" |
54f9ee45 | 1474 | return _core_.Point2D_SetVectorAngle(*args, **kwargs) |
e811c8ce | 1475 | |
d14a1e28 RD |
1476 | def SetPolarCoordinates(self, angle, length): |
1477 | self.SetVectorLength(length) | |
1478 | self.SetVectorAngle(angle) | |
1479 | def Normalize(self): | |
1480 | self.SetVectorLength(1.0) | |
1481 | ||
e811c8ce | 1482 | def GetDistance(*args, **kwargs): |
a95a7133 | 1483 | """GetDistance(self, Point2D pt) -> double""" |
54f9ee45 | 1484 | return _core_.Point2D_GetDistance(*args, **kwargs) |
e811c8ce RD |
1485 | |
1486 | def GetDistanceSquare(*args, **kwargs): | |
a95a7133 | 1487 | """GetDistanceSquare(self, Point2D pt) -> double""" |
54f9ee45 | 1488 | return _core_.Point2D_GetDistanceSquare(*args, **kwargs) |
e811c8ce RD |
1489 | |
1490 | def GetDotProduct(*args, **kwargs): | |
a95a7133 | 1491 | """GetDotProduct(self, Point2D vec) -> double""" |
54f9ee45 | 1492 | return _core_.Point2D_GetDotProduct(*args, **kwargs) |
e811c8ce RD |
1493 | |
1494 | def GetCrossProduct(*args, **kwargs): | |
a95a7133 | 1495 | """GetCrossProduct(self, Point2D vec) -> double""" |
54f9ee45 | 1496 | return _core_.Point2D_GetCrossProduct(*args, **kwargs) |
e811c8ce RD |
1497 | |
1498 | def __neg__(*args, **kwargs): | |
0df68c9f | 1499 | """ |
a95a7133 | 1500 | __neg__(self) -> Point2D |
e811c8ce | 1501 | |
0df68c9f RD |
1502 | the reflection of this point |
1503 | """ | |
54f9ee45 | 1504 | return _core_.Point2D___neg__(*args, **kwargs) |
e811c8ce RD |
1505 | |
1506 | def __iadd__(*args, **kwargs): | |
a95a7133 | 1507 | """__iadd__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1508 | return _core_.Point2D___iadd__(*args, **kwargs) |
e811c8ce RD |
1509 | |
1510 | def __isub__(*args, **kwargs): | |
a95a7133 | 1511 | """__isub__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1512 | return _core_.Point2D___isub__(*args, **kwargs) |
e811c8ce RD |
1513 | |
1514 | def __imul__(*args, **kwargs): | |
a95a7133 | 1515 | """__imul__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1516 | return _core_.Point2D___imul__(*args, **kwargs) |
e811c8ce RD |
1517 | |
1518 | def __idiv__(*args, **kwargs): | |
a95a7133 | 1519 | """__idiv__(self, Point2D pt) -> Point2D""" |
54f9ee45 | 1520 | return _core_.Point2D___idiv__(*args, **kwargs) |
e811c8ce RD |
1521 | |
1522 | def __eq__(*args, **kwargs): | |
0df68c9f | 1523 | """ |
e9d6f3a4 | 1524 | __eq__(self, PyObject other) -> bool |
e811c8ce | 1525 | |
e9d6f3a4 | 1526 | Test for equality of wx.Point2D objects. |
0df68c9f | 1527 | """ |
54f9ee45 | 1528 | return _core_.Point2D___eq__(*args, **kwargs) |
e811c8ce RD |
1529 | |
1530 | def __ne__(*args, **kwargs): | |
0df68c9f | 1531 | """ |
e9d6f3a4 | 1532 | __ne__(self, PyObject other) -> bool |
e811c8ce | 1533 | |
e9d6f3a4 | 1534 | Test for inequality of wx.Point2D objects. |
0df68c9f | 1535 | """ |
54f9ee45 | 1536 | return _core_.Point2D___ne__(*args, **kwargs) |
e811c8ce | 1537 | |
54f9ee45 RD |
1538 | x = property(_core_.Point2D_x_get, _core_.Point2D_x_set) |
1539 | y = property(_core_.Point2D_y_get, _core_.Point2D_y_set) | |
e811c8ce | 1540 | def Set(*args, **kwargs): |
a95a7133 | 1541 | """Set(self, double x=0, double y=0)""" |
54f9ee45 | 1542 | return _core_.Point2D_Set(*args, **kwargs) |
e811c8ce RD |
1543 | |
1544 | def Get(*args, **kwargs): | |
0df68c9f RD |
1545 | """ |
1546 | Get() -> (x,y) | |
e811c8ce | 1547 | |
0df68c9f RD |
1548 | Return x and y properties as a tuple. |
1549 | """ | |
54f9ee45 | 1550 | return _core_.Point2D_Get(*args, **kwargs) |
e811c8ce | 1551 | |
41e2b43e | 1552 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
1553 | def __str__(self): return str(self.Get()) |
1554 | def __repr__(self): return 'wx.Point2D'+str(self.Get()) | |
1555 | def __len__(self): return len(self.Get()) | |
1556 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 | 1557 | def __setitem__(self, index, val): |
e811c8ce RD |
1558 | if index == 0: self.x = val |
1559 | elif index == 1: self.y = val | |
d14a1e28 | 1560 | else: raise IndexError |
e811c8ce | 1561 | def __nonzero__(self): return self.Get() != (0.0, 0.0) |
74e96f3d RD |
1562 | __safe_for_unpickling__ = True |
1563 | def __reduce__(self): return (wx.Point2D, self.Get()) | |
d14a1e28 | 1564 | |
2131d850 | 1565 | _core_.Point2D_swigregister(Point2D) |
d14a1e28 RD |
1566 | |
1567 | def Point2DCopy(*args, **kwargs): | |
0df68c9f RD |
1568 | """ |
1569 | Point2DCopy(Point2D pt) -> Point2D | |
e811c8ce | 1570 | |
0df68c9f RD |
1571 | Create a w.Point2D object. |
1572 | """ | |
54f9ee45 | 1573 | val = _core_.new_Point2DCopy(*args, **kwargs) |
d14a1e28 RD |
1574 | return val |
1575 | ||
1576 | def Point2DFromPoint(*args, **kwargs): | |
0df68c9f RD |
1577 | """ |
1578 | Point2DFromPoint(Point pt) -> Point2D | |
e811c8ce | 1579 | |
0df68c9f RD |
1580 | Create a w.Point2D object. |
1581 | """ | |
54f9ee45 | 1582 | val = _core_.new_Point2DFromPoint(*args, **kwargs) |
d14a1e28 RD |
1583 | return val |
1584 | ||
1585 | #--------------------------------------------------------------------------- | |
1586 | ||
54f9ee45 RD |
1587 | FromStart = _core_.FromStart |
1588 | FromCurrent = _core_.FromCurrent | |
1589 | FromEnd = _core_.FromEnd | |
d14a1e28 | 1590 | class InputStream(object): |
093d3ff1 | 1591 | """Proxy of C++ InputStream class""" |
0085ce49 RD |
1592 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1593 | __repr__ = _swig_repr | |
1594 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1595 | """__init__(self, PyObject p) -> InputStream""" |
0085ce49 RD |
1596 | _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs)) |
1597 | __swig_destroy__ = _core_.delete_InputStream | |
1598 | __del__ = lambda self : None; | |
e811c8ce | 1599 | def close(*args, **kwargs): |
a95a7133 | 1600 | """close(self)""" |
54f9ee45 | 1601 | return _core_.InputStream_close(*args, **kwargs) |
e811c8ce RD |
1602 | |
1603 | def flush(*args, **kwargs): | |
a95a7133 | 1604 | """flush(self)""" |
54f9ee45 | 1605 | return _core_.InputStream_flush(*args, **kwargs) |
e811c8ce RD |
1606 | |
1607 | def eof(*args, **kwargs): | |
a95a7133 | 1608 | """eof(self) -> bool""" |
54f9ee45 | 1609 | return _core_.InputStream_eof(*args, **kwargs) |
e811c8ce RD |
1610 | |
1611 | def read(*args, **kwargs): | |
a95a7133 | 1612 | """read(self, int size=-1) -> PyObject""" |
54f9ee45 | 1613 | return _core_.InputStream_read(*args, **kwargs) |
e811c8ce RD |
1614 | |
1615 | def readline(*args, **kwargs): | |
a95a7133 | 1616 | """readline(self, int size=-1) -> PyObject""" |
54f9ee45 | 1617 | return _core_.InputStream_readline(*args, **kwargs) |
e811c8ce RD |
1618 | |
1619 | def readlines(*args, **kwargs): | |
a95a7133 | 1620 | """readlines(self, int sizehint=-1) -> PyObject""" |
54f9ee45 | 1621 | return _core_.InputStream_readlines(*args, **kwargs) |
e811c8ce RD |
1622 | |
1623 | def seek(*args, **kwargs): | |
a95a7133 | 1624 | """seek(self, int offset, int whence=0)""" |
54f9ee45 | 1625 | return _core_.InputStream_seek(*args, **kwargs) |
e811c8ce RD |
1626 | |
1627 | def tell(*args, **kwargs): | |
a95a7133 | 1628 | """tell(self) -> int""" |
54f9ee45 | 1629 | return _core_.InputStream_tell(*args, **kwargs) |
e811c8ce RD |
1630 | |
1631 | def Peek(*args, **kwargs): | |
a95a7133 | 1632 | """Peek(self) -> char""" |
54f9ee45 | 1633 | return _core_.InputStream_Peek(*args, **kwargs) |
e811c8ce RD |
1634 | |
1635 | def GetC(*args, **kwargs): | |
a95a7133 | 1636 | """GetC(self) -> char""" |
54f9ee45 | 1637 | return _core_.InputStream_GetC(*args, **kwargs) |
e811c8ce RD |
1638 | |
1639 | def LastRead(*args, **kwargs): | |
a95a7133 | 1640 | """LastRead(self) -> size_t""" |
54f9ee45 | 1641 | return _core_.InputStream_LastRead(*args, **kwargs) |
e811c8ce RD |
1642 | |
1643 | def CanRead(*args, **kwargs): | |
a95a7133 | 1644 | """CanRead(self) -> bool""" |
54f9ee45 | 1645 | return _core_.InputStream_CanRead(*args, **kwargs) |
e811c8ce RD |
1646 | |
1647 | def Eof(*args, **kwargs): | |
a95a7133 | 1648 | """Eof(self) -> bool""" |
54f9ee45 | 1649 | return _core_.InputStream_Eof(*args, **kwargs) |
e811c8ce RD |
1650 | |
1651 | def Ungetch(*args, **kwargs): | |
a95a7133 | 1652 | """Ungetch(self, char c) -> bool""" |
54f9ee45 | 1653 | return _core_.InputStream_Ungetch(*args, **kwargs) |
e811c8ce RD |
1654 | |
1655 | def SeekI(*args, **kwargs): | |
a95a7133 | 1656 | """SeekI(self, long pos, int mode=FromStart) -> long""" |
54f9ee45 | 1657 | return _core_.InputStream_SeekI(*args, **kwargs) |
e811c8ce RD |
1658 | |
1659 | def TellI(*args, **kwargs): | |
a95a7133 | 1660 | """TellI(self) -> long""" |
54f9ee45 | 1661 | return _core_.InputStream_TellI(*args, **kwargs) |
e811c8ce | 1662 | |
2131d850 | 1663 | _core_.InputStream_swigregister(InputStream) |
d14a1e28 RD |
1664 | DefaultPosition = cvar.DefaultPosition |
1665 | DefaultSize = cvar.DefaultSize | |
1666 | ||
1667 | class OutputStream(object): | |
093d3ff1 | 1668 | """Proxy of C++ OutputStream class""" |
0085ce49 RD |
1669 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1670 | def __init__(self): raise AttributeError, "No constructor defined" | |
1671 | __repr__ = _swig_repr | |
e811c8ce | 1672 | def write(*args, **kwargs): |
a95a7133 | 1673 | """write(self, PyObject obj)""" |
54f9ee45 | 1674 | return _core_.OutputStream_write(*args, **kwargs) |
e811c8ce | 1675 | |
0085ce49 RD |
1676 | def LastWrite(*args, **kwargs): |
1677 | """LastWrite(self) -> size_t""" | |
1678 | return _core_.OutputStream_LastWrite(*args, **kwargs) | |
d14a1e28 | 1679 | |
2131d850 | 1680 | _core_.OutputStream_swigregister(OutputStream) |
d14a1e28 RD |
1681 | |
1682 | #--------------------------------------------------------------------------- | |
1683 | ||
1684 | class FSFile(Object): | |
093d3ff1 | 1685 | """Proxy of C++ FSFile class""" |
0085ce49 RD |
1686 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1687 | __repr__ = _swig_repr | |
1688 | def __init__(self, *args, **kwargs): | |
0df68c9f | 1689 | """ |
a95a7133 | 1690 | __init__(self, InputStream stream, String loc, String mimetype, String anchor, |
196addbf | 1691 | DateTime modif) -> FSFile |
0df68c9f | 1692 | """ |
0085ce49 | 1693 | _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs)) |
0085ce49 RD |
1694 | __swig_destroy__ = _core_.delete_FSFile |
1695 | __del__ = lambda self : None; | |
e811c8ce | 1696 | def GetStream(*args, **kwargs): |
a95a7133 | 1697 | """GetStream(self) -> InputStream""" |
54f9ee45 | 1698 | return _core_.FSFile_GetStream(*args, **kwargs) |
e811c8ce RD |
1699 | |
1700 | def GetMimeType(*args, **kwargs): | |
a95a7133 | 1701 | """GetMimeType(self) -> String""" |
54f9ee45 | 1702 | return _core_.FSFile_GetMimeType(*args, **kwargs) |
e811c8ce RD |
1703 | |
1704 | def GetLocation(*args, **kwargs): | |
a95a7133 | 1705 | """GetLocation(self) -> String""" |
54f9ee45 | 1706 | return _core_.FSFile_GetLocation(*args, **kwargs) |
e811c8ce RD |
1707 | |
1708 | def GetAnchor(*args, **kwargs): | |
a95a7133 | 1709 | """GetAnchor(self) -> String""" |
54f9ee45 | 1710 | return _core_.FSFile_GetAnchor(*args, **kwargs) |
e811c8ce RD |
1711 | |
1712 | def GetModificationTime(*args, **kwargs): | |
a95a7133 | 1713 | """GetModificationTime(self) -> DateTime""" |
54f9ee45 | 1714 | return _core_.FSFile_GetModificationTime(*args, **kwargs) |
e811c8ce | 1715 | |
2131d850 | 1716 | _core_.FSFile_swigregister(FSFile) |
d14a1e28 RD |
1717 | |
1718 | class CPPFileSystemHandler(object): | |
093d3ff1 | 1719 | """Proxy of C++ CPPFileSystemHandler class""" |
0085ce49 RD |
1720 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1721 | def __init__(self): raise AttributeError, "No constructor defined" | |
1722 | __repr__ = _swig_repr | |
50f151d7 RD |
1723 | __swig_destroy__ = _core_.delete_CPPFileSystemHandler |
1724 | __del__ = lambda self : None; | |
2131d850 | 1725 | _core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandler) |
d14a1e28 RD |
1726 | |
1727 | class FileSystemHandler(CPPFileSystemHandler): | |
093d3ff1 | 1728 | """Proxy of C++ FileSystemHandler class""" |
0085ce49 RD |
1729 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1730 | __repr__ = _swig_repr | |
1731 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1732 | """__init__(self) -> FileSystemHandler""" |
0085ce49 | 1733 | _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs)) |
d14a1e28 | 1734 | self._setCallbackInfo(self, FileSystemHandler) |
e811c8ce RD |
1735 | |
1736 | def _setCallbackInfo(*args, **kwargs): | |
a95a7133 | 1737 | """_setCallbackInfo(self, PyObject self, PyObject _class)""" |
54f9ee45 | 1738 | return _core_.FileSystemHandler__setCallbackInfo(*args, **kwargs) |
e811c8ce RD |
1739 | |
1740 | def CanOpen(*args, **kwargs): | |
a95a7133 | 1741 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 1742 | return _core_.FileSystemHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
1743 | |
1744 | def OpenFile(*args, **kwargs): | |
a95a7133 | 1745 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 1746 | return _core_.FileSystemHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
1747 | |
1748 | def FindFirst(*args, **kwargs): | |
a95a7133 | 1749 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 1750 | return _core_.FileSystemHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
1751 | |
1752 | def FindNext(*args, **kwargs): | |
a95a7133 | 1753 | """FindNext(self) -> String""" |
54f9ee45 | 1754 | return _core_.FileSystemHandler_FindNext(*args, **kwargs) |
e811c8ce RD |
1755 | |
1756 | def GetProtocol(*args, **kwargs): | |
a95a7133 | 1757 | """GetProtocol(self, String location) -> String""" |
54f9ee45 | 1758 | return _core_.FileSystemHandler_GetProtocol(*args, **kwargs) |
e811c8ce RD |
1759 | |
1760 | def GetLeftLocation(*args, **kwargs): | |
a95a7133 | 1761 | """GetLeftLocation(self, String location) -> String""" |
54f9ee45 | 1762 | return _core_.FileSystemHandler_GetLeftLocation(*args, **kwargs) |
e811c8ce RD |
1763 | |
1764 | def GetAnchor(*args, **kwargs): | |
a95a7133 | 1765 | """GetAnchor(self, String location) -> String""" |
54f9ee45 | 1766 | return _core_.FileSystemHandler_GetAnchor(*args, **kwargs) |
e811c8ce RD |
1767 | |
1768 | def GetRightLocation(*args, **kwargs): | |
a95a7133 | 1769 | """GetRightLocation(self, String location) -> String""" |
54f9ee45 | 1770 | return _core_.FileSystemHandler_GetRightLocation(*args, **kwargs) |
e811c8ce RD |
1771 | |
1772 | def GetMimeTypeFromExt(*args, **kwargs): | |
a95a7133 | 1773 | """GetMimeTypeFromExt(self, String location) -> String""" |
54f9ee45 | 1774 | return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs) |
e811c8ce | 1775 | |
2131d850 | 1776 | _core_.FileSystemHandler_swigregister(FileSystemHandler) |
d14a1e28 RD |
1777 | |
1778 | class FileSystem(Object): | |
093d3ff1 | 1779 | """Proxy of C++ FileSystem class""" |
0085ce49 RD |
1780 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1781 | __repr__ = _swig_repr | |
1782 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1783 | """__init__(self) -> FileSystem""" |
0085ce49 RD |
1784 | _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs)) |
1785 | __swig_destroy__ = _core_.delete_FileSystem | |
1786 | __del__ = lambda self : None; | |
e811c8ce | 1787 | def ChangePathTo(*args, **kwargs): |
a95a7133 | 1788 | """ChangePathTo(self, String location, bool is_dir=False)""" |
54f9ee45 | 1789 | return _core_.FileSystem_ChangePathTo(*args, **kwargs) |
e811c8ce RD |
1790 | |
1791 | def GetPath(*args, **kwargs): | |
a95a7133 | 1792 | """GetPath(self) -> String""" |
54f9ee45 | 1793 | return _core_.FileSystem_GetPath(*args, **kwargs) |
e811c8ce RD |
1794 | |
1795 | def OpenFile(*args, **kwargs): | |
a95a7133 | 1796 | """OpenFile(self, String location) -> FSFile""" |
54f9ee45 | 1797 | return _core_.FileSystem_OpenFile(*args, **kwargs) |
e811c8ce RD |
1798 | |
1799 | def FindFirst(*args, **kwargs): | |
a95a7133 | 1800 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 1801 | return _core_.FileSystem_FindFirst(*args, **kwargs) |
e811c8ce RD |
1802 | |
1803 | def FindNext(*args, **kwargs): | |
a95a7133 | 1804 | """FindNext(self) -> String""" |
54f9ee45 | 1805 | return _core_.FileSystem_FindNext(*args, **kwargs) |
e811c8ce RD |
1806 | |
1807 | def AddHandler(*args, **kwargs): | |
66c033b4 | 1808 | """AddHandler(CPPFileSystemHandler handler)""" |
54f9ee45 | 1809 | return _core_.FileSystem_AddHandler(*args, **kwargs) |
e811c8ce RD |
1810 | |
1811 | AddHandler = staticmethod(AddHandler) | |
1812 | def CleanUpHandlers(*args, **kwargs): | |
66c033b4 | 1813 | """CleanUpHandlers()""" |
54f9ee45 | 1814 | return _core_.FileSystem_CleanUpHandlers(*args, **kwargs) |
e811c8ce RD |
1815 | |
1816 | CleanUpHandlers = staticmethod(CleanUpHandlers) | |
1817 | def FileNameToURL(*args, **kwargs): | |
66c033b4 | 1818 | """FileNameToURL(String filename) -> String""" |
54f9ee45 | 1819 | return _core_.FileSystem_FileNameToURL(*args, **kwargs) |
e811c8ce RD |
1820 | |
1821 | FileNameToURL = staticmethod(FileNameToURL) | |
2ef75293 RD |
1822 | def URLToFileName(*args, **kwargs): |
1823 | """URLToFileName(String url) -> String""" | |
1824 | return _core_.FileSystem_URLToFileName(*args, **kwargs) | |
1825 | ||
1826 | URLToFileName = staticmethod(URLToFileName) | |
2131d850 | 1827 | _core_.FileSystem_swigregister(FileSystem) |
d14a1e28 | 1828 | |
e811c8ce | 1829 | def FileSystem_AddHandler(*args, **kwargs): |
0085ce49 RD |
1830 | """FileSystem_AddHandler(CPPFileSystemHandler handler)""" |
1831 | return _core_.FileSystem_AddHandler(*args, **kwargs) | |
d14a1e28 | 1832 | |
0085ce49 RD |
1833 | def FileSystem_CleanUpHandlers(*args): |
1834 | """FileSystem_CleanUpHandlers()""" | |
1835 | return _core_.FileSystem_CleanUpHandlers(*args) | |
d14a1e28 | 1836 | |
e811c8ce | 1837 | def FileSystem_FileNameToURL(*args, **kwargs): |
0085ce49 RD |
1838 | """FileSystem_FileNameToURL(String filename) -> String""" |
1839 | return _core_.FileSystem_FileNameToURL(*args, **kwargs) | |
d14a1e28 | 1840 | |
e811c8ce | 1841 | def FileSystem_URLToFileName(*args, **kwargs): |
0085ce49 RD |
1842 | """FileSystem_URLToFileName(String url) -> String""" |
1843 | return _core_.FileSystem_URLToFileName(*args, **kwargs) | |
2ef75293 | 1844 | |
d14a1e28 | 1845 | class InternetFSHandler(CPPFileSystemHandler): |
093d3ff1 | 1846 | """Proxy of C++ InternetFSHandler class""" |
0085ce49 RD |
1847 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1848 | __repr__ = _swig_repr | |
1849 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1850 | """__init__(self) -> InternetFSHandler""" |
0085ce49 | 1851 | _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs)) |
e811c8ce | 1852 | def CanOpen(*args, **kwargs): |
a95a7133 | 1853 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 1854 | return _core_.InternetFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
1855 | |
1856 | def OpenFile(*args, **kwargs): | |
a95a7133 | 1857 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 1858 | return _core_.InternetFSHandler_OpenFile(*args, **kwargs) |
e811c8ce | 1859 | |
2131d850 | 1860 | _core_.InternetFSHandler_swigregister(InternetFSHandler) |
d14a1e28 RD |
1861 | |
1862 | class ZipFSHandler(CPPFileSystemHandler): | |
093d3ff1 | 1863 | """Proxy of C++ ZipFSHandler class""" |
0085ce49 RD |
1864 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1865 | __repr__ = _swig_repr | |
1866 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1867 | """__init__(self) -> ZipFSHandler""" |
0085ce49 | 1868 | _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs)) |
e811c8ce | 1869 | def CanOpen(*args, **kwargs): |
a95a7133 | 1870 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 1871 | return _core_.ZipFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
1872 | |
1873 | def OpenFile(*args, **kwargs): | |
a95a7133 | 1874 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 1875 | return _core_.ZipFSHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
1876 | |
1877 | def FindFirst(*args, **kwargs): | |
a95a7133 | 1878 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 1879 | return _core_.ZipFSHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
1880 | |
1881 | def FindNext(*args, **kwargs): | |
a95a7133 | 1882 | """FindNext(self) -> String""" |
54f9ee45 | 1883 | return _core_.ZipFSHandler_FindNext(*args, **kwargs) |
e811c8ce | 1884 | |
2131d850 | 1885 | _core_.ZipFSHandler_swigregister(ZipFSHandler) |
d14a1e28 RD |
1886 | |
1887 | ||
e811c8ce | 1888 | def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs): |
0085ce49 RD |
1889 | """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)""" |
1890 | return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs) | |
d14a1e28 | 1891 | |
e811c8ce | 1892 | def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs): |
0085ce49 RD |
1893 | """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)""" |
1894 | return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs) | |
d14a1e28 | 1895 | |
e811c8ce | 1896 | def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs): |
0085ce49 RD |
1897 | """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)""" |
1898 | return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs) | |
2ef75293 RD |
1899 | def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1): |
1900 | """ | |
1901 | Add 'file' to the memory filesystem. The dataItem parameter can | |
1902 | either be a `wx.Bitmap`, `wx.Image` or a string that can contain | |
1903 | arbitrary data. If a bitmap or image is used then the imgType | |
1904 | parameter should specify what kind of image file it should be | |
1905 | written as, wx.BITMAP_TYPE_PNG, etc. | |
1906 | """ | |
1907 | if isinstance(dataItem, wx.Image): | |
1908 | __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType) | |
1909 | elif isinstance(dataItem, wx.Bitmap): | |
1910 | __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType) | |
1911 | elif type(dataItem) == str: | |
1912 | __wxMemoryFSHandler_AddFile_Data(filename, dataItem) | |
1913 | else: | |
1914 | raise TypeError, 'wx.Image, wx.Bitmap or string expected' | |
d14a1e28 RD |
1915 | |
1916 | class MemoryFSHandler(CPPFileSystemHandler): | |
093d3ff1 | 1917 | """Proxy of C++ MemoryFSHandler class""" |
0085ce49 RD |
1918 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1919 | __repr__ = _swig_repr | |
1920 | def __init__(self, *args, **kwargs): | |
a95a7133 | 1921 | """__init__(self) -> MemoryFSHandler""" |
0085ce49 | 1922 | _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs)) |
e811c8ce | 1923 | def RemoveFile(*args, **kwargs): |
66c033b4 | 1924 | """RemoveFile(String filename)""" |
54f9ee45 | 1925 | return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs) |
e811c8ce RD |
1926 | |
1927 | RemoveFile = staticmethod(RemoveFile) | |
d14a1e28 | 1928 | AddFile = staticmethod(MemoryFSHandler_AddFile) |
e811c8ce | 1929 | def CanOpen(*args, **kwargs): |
a95a7133 | 1930 | """CanOpen(self, String location) -> bool""" |
54f9ee45 | 1931 | return _core_.MemoryFSHandler_CanOpen(*args, **kwargs) |
e811c8ce RD |
1932 | |
1933 | def OpenFile(*args, **kwargs): | |
a95a7133 | 1934 | """OpenFile(self, FileSystem fs, String location) -> FSFile""" |
54f9ee45 | 1935 | return _core_.MemoryFSHandler_OpenFile(*args, **kwargs) |
e811c8ce RD |
1936 | |
1937 | def FindFirst(*args, **kwargs): | |
a95a7133 | 1938 | """FindFirst(self, String spec, int flags=0) -> String""" |
54f9ee45 | 1939 | return _core_.MemoryFSHandler_FindFirst(*args, **kwargs) |
e811c8ce RD |
1940 | |
1941 | def FindNext(*args, **kwargs): | |
a95a7133 | 1942 | """FindNext(self) -> String""" |
54f9ee45 | 1943 | return _core_.MemoryFSHandler_FindNext(*args, **kwargs) |
e811c8ce | 1944 | |
2131d850 | 1945 | _core_.MemoryFSHandler_swigregister(MemoryFSHandler) |
d14a1e28 | 1946 | |
e811c8ce | 1947 | def MemoryFSHandler_RemoveFile(*args, **kwargs): |
0085ce49 RD |
1948 | """MemoryFSHandler_RemoveFile(String filename)""" |
1949 | return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs) | |
d14a1e28 | 1950 | |
bcd0d7b6 RD |
1951 | IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT |
1952 | IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD | |
1953 | IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE | |
d14a1e28 RD |
1954 | #--------------------------------------------------------------------------- |
1955 | ||
1956 | class ImageHandler(Object): | |
27fb7603 RD |
1957 | """ |
1958 | This is the base class for implementing image file loading/saving, and | |
1959 | image creation from data. It is used within `wx.Image` and is not | |
1960 | normally seen by the application. | |
1961 | """ | |
0085ce49 RD |
1962 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
1963 | def __init__(self): raise AttributeError, "No constructor defined" | |
1964 | __repr__ = _swig_repr | |
e811c8ce | 1965 | def GetName(*args, **kwargs): |
a95a7133 | 1966 | """GetName(self) -> String""" |
54f9ee45 | 1967 | return _core_.ImageHandler_GetName(*args, **kwargs) |
e811c8ce RD |
1968 | |
1969 | def GetExtension(*args, **kwargs): | |
a95a7133 | 1970 | """GetExtension(self) -> String""" |
54f9ee45 | 1971 | return _core_.ImageHandler_GetExtension(*args, **kwargs) |
e811c8ce RD |
1972 | |
1973 | def GetType(*args, **kwargs): | |
a95a7133 | 1974 | """GetType(self) -> long""" |
54f9ee45 | 1975 | return _core_.ImageHandler_GetType(*args, **kwargs) |
e811c8ce RD |
1976 | |
1977 | def GetMimeType(*args, **kwargs): | |
a95a7133 | 1978 | """GetMimeType(self) -> String""" |
54f9ee45 | 1979 | return _core_.ImageHandler_GetMimeType(*args, **kwargs) |
e811c8ce RD |
1980 | |
1981 | def CanRead(*args, **kwargs): | |
a95a7133 | 1982 | """CanRead(self, String name) -> bool""" |
54f9ee45 | 1983 | return _core_.ImageHandler_CanRead(*args, **kwargs) |
e811c8ce | 1984 | |
b02396e8 RD |
1985 | def CanReadStream(*args, **kwargs): |
1986 | """CanReadStream(self, InputStream stream) -> bool""" | |
1987 | return _core_.ImageHandler_CanReadStream(*args, **kwargs) | |
1988 | ||
e811c8ce | 1989 | def SetName(*args, **kwargs): |
a95a7133 | 1990 | """SetName(self, String name)""" |
54f9ee45 | 1991 | return _core_.ImageHandler_SetName(*args, **kwargs) |
e811c8ce RD |
1992 | |
1993 | def SetExtension(*args, **kwargs): | |
a95a7133 | 1994 | """SetExtension(self, String extension)""" |
54f9ee45 | 1995 | return _core_.ImageHandler_SetExtension(*args, **kwargs) |
e811c8ce RD |
1996 | |
1997 | def SetType(*args, **kwargs): | |
a95a7133 | 1998 | """SetType(self, long type)""" |
54f9ee45 | 1999 | return _core_.ImageHandler_SetType(*args, **kwargs) |
e811c8ce RD |
2000 | |
2001 | def SetMimeType(*args, **kwargs): | |
a95a7133 | 2002 | """SetMimeType(self, String mimetype)""" |
54f9ee45 | 2003 | return _core_.ImageHandler_SetMimeType(*args, **kwargs) |
e811c8ce | 2004 | |
2131d850 | 2005 | _core_.ImageHandler_swigregister(ImageHandler) |
d14a1e28 | 2006 | |
943e8dfd RD |
2007 | class PyImageHandler(ImageHandler): |
2008 | """ | |
2009 | This is the base class for implementing image file loading/saving, and | |
2010 | image creation from data, all written in Python. To create a custom | |
2011 | image handler derive a new class from wx.PyImageHandler and provide | |
2012 | the following methods:: | |
2013 | ||
2014 | def DoCanRead(self, stream) --> bool | |
2015 | '''Check if this handler can read the image on the stream''' | |
2016 | ||
2017 | def LoadFile(self, image, stream, verbose, index) --> bool | |
2018 | '''Load image data from the stream and load it into image.''' | |
2019 | ||
2020 | def SaveFile(self, image, stream, verbose) --> bool | |
2021 | '''Save the iamge data in image to the stream using | |
2022 | this handler's image file format.''' | |
2023 | ||
2024 | def GetImageCount(self, stream) --> int | |
2025 | '''If this image format can hold more than one image, | |
2026 | how many does the image on the stream have?''' | |
2027 | ||
2028 | To activate your handler create an instance of it and pass it to | |
2029 | `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and | |
2030 | `SetExtension` from your constructor. | |
2031 | ||
2032 | """ | |
0085ce49 RD |
2033 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2034 | __repr__ = _swig_repr | |
2035 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2036 | """ |
2037 | __init__(self) -> PyImageHandler | |
2038 | ||
2039 | This is the base class for implementing image file loading/saving, and | |
2040 | image creation from data, all written in Python. To create a custom | |
2041 | image handler derive a new class from wx.PyImageHandler and provide | |
2042 | the following methods:: | |
2043 | ||
2044 | def DoCanRead(self, stream) --> bool | |
2045 | '''Check if this handler can read the image on the stream''' | |
2046 | ||
2047 | def LoadFile(self, image, stream, verbose, index) --> bool | |
2048 | '''Load image data from the stream and load it into image.''' | |
2049 | ||
2050 | def SaveFile(self, image, stream, verbose) --> bool | |
2051 | '''Save the iamge data in image to the stream using | |
2052 | this handler's image file format.''' | |
2053 | ||
2054 | def GetImageCount(self, stream) --> int | |
2055 | '''If this image format can hold more than one image, | |
2056 | how many does the image on the stream have?''' | |
2057 | ||
2058 | To activate your handler create an instance of it and pass it to | |
2059 | `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and | |
2060 | `SetExtension` from your constructor. | |
2061 | ||
2062 | """ | |
0085ce49 | 2063 | _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs)) |
943e8dfd RD |
2064 | self._SetSelf(self) |
2065 | ||
2066 | def _SetSelf(*args, **kwargs): | |
2067 | """_SetSelf(self, PyObject self)""" | |
2068 | return _core_.PyImageHandler__SetSelf(*args, **kwargs) | |
2069 | ||
2131d850 | 2070 | _core_.PyImageHandler_swigregister(PyImageHandler) |
943e8dfd | 2071 | |
d14a1e28 | 2072 | class ImageHistogram(object): |
093d3ff1 | 2073 | """Proxy of C++ ImageHistogram class""" |
0085ce49 RD |
2074 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2075 | __repr__ = _swig_repr | |
2076 | def __init__(self, *args, **kwargs): | |
a95a7133 | 2077 | """__init__(self) -> ImageHistogram""" |
0085ce49 | 2078 | _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs)) |
e811c8ce | 2079 | def MakeKey(*args, **kwargs): |
0df68c9f | 2080 | """ |
7a27cf7c | 2081 | MakeKey(byte r, byte g, byte b) -> unsigned long |
e811c8ce | 2082 | |
0df68c9f RD |
2083 | Get the key in the histogram for the given RGB values |
2084 | """ | |
54f9ee45 | 2085 | return _core_.ImageHistogram_MakeKey(*args, **kwargs) |
e811c8ce RD |
2086 | |
2087 | MakeKey = staticmethod(MakeKey) | |
2088 | def FindFirstUnusedColour(*args, **kwargs): | |
fd2dc343 RD |
2089 | """ |
2090 | FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) | |
2091 | ||
2092 | Find first colour that is not used in the image and has higher RGB | |
2093 | values than startR, startG, startB. Returns a tuple consisting of a | |
2094 | success flag and rgb values. | |
2095 | """ | |
54f9ee45 | 2096 | return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs) |
e811c8ce | 2097 | |
f1cbd8fa RD |
2098 | def GetCount(*args, **kwargs): |
2099 | """ | |
2100 | GetCount(self, unsigned long key) -> unsigned long | |
2101 | ||
2102 | Returns the pixel count for the given key. Use `MakeKey` to create a | |
2103 | key value from a RGB tripple. | |
2104 | """ | |
2105 | return _core_.ImageHistogram_GetCount(*args, **kwargs) | |
2106 | ||
2107 | def GetCountRGB(*args, **kwargs): | |
2108 | """ | |
7a27cf7c | 2109 | GetCountRGB(self, byte r, byte g, byte b) -> unsigned long |
f1cbd8fa RD |
2110 | |
2111 | Returns the pixel count for the given RGB values. | |
2112 | """ | |
2113 | return _core_.ImageHistogram_GetCountRGB(*args, **kwargs) | |
2114 | ||
2115 | def GetCountColour(*args, **kwargs): | |
2116 | """ | |
2117 | GetCountColour(self, Colour colour) -> unsigned long | |
2118 | ||
2119 | Returns the pixel count for the given `wx.Colour` value. | |
2120 | """ | |
2121 | return _core_.ImageHistogram_GetCountColour(*args, **kwargs) | |
2122 | ||
2131d850 | 2123 | _core_.ImageHistogram_swigregister(ImageHistogram) |
d14a1e28 | 2124 | |
e811c8ce | 2125 | def ImageHistogram_MakeKey(*args, **kwargs): |
0085ce49 | 2126 | """ |
7a27cf7c | 2127 | ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long |
e811c8ce | 2128 | |
0df68c9f RD |
2129 | Get the key in the histogram for the given RGB values |
2130 | """ | |
0085ce49 | 2131 | return _core_.ImageHistogram_MakeKey(*args, **kwargs) |
d14a1e28 | 2132 | |
943e8dfd RD |
2133 | class Image_RGBValue(object): |
2134 | """ | |
2135 | An object that contains values for red, green and blue which represent | |
2136 | the value of a color. It is used by `wx.Image.HSVtoRGB` and | |
2137 | `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB | |
2138 | color space. | |
2139 | """ | |
0085ce49 RD |
2140 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2141 | __repr__ = _swig_repr | |
2142 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2143 | """ |
2144 | __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue | |
2145 | ||
2146 | Constructor. | |
2147 | """ | |
0085ce49 | 2148 | _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs)) |
943e8dfd RD |
2149 | red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set) |
2150 | green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set) | |
2151 | blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set) | |
2131d850 | 2152 | _core_.Image_RGBValue_swigregister(Image_RGBValue) |
943e8dfd RD |
2153 | |
2154 | class Image_HSVValue(object): | |
2155 | """ | |
2156 | An object that contains values for hue, saturation and value which | |
2157 | represent the value of a color. It is used by `wx.Image.HSVtoRGB` and | |
2158 | `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB | |
2159 | color space. | |
2160 | """ | |
0085ce49 RD |
2161 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2162 | __repr__ = _swig_repr | |
2163 | def __init__(self, *args, **kwargs): | |
943e8dfd RD |
2164 | """ |
2165 | __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue | |
2166 | ||
2167 | Constructor. | |
2168 | """ | |
0085ce49 | 2169 | _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs)) |
943e8dfd RD |
2170 | hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set) |
2171 | saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set) | |
2172 | value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set) | |
2131d850 | 2173 | _core_.Image_HSVValue_swigregister(Image_HSVValue) |
943e8dfd | 2174 | |
d14a1e28 | 2175 | class Image(Object): |
7a27cf7c RD |
2176 | """ |
2177 | A platform-independent image class. An image can be created from | |
2178 | data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a | |
2179 | variety of formats. Functions are available to set and get image | |
2180 | bits, so it can be used for basic image manipulation. | |
2181 | ||
2182 | A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a | |
2183 | platform-specific `wx.Bitmap` object must be created from it using the | |
2184 | `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a | |
2185 | device context, using `wx.DC.DrawBitmap`. | |
2186 | ||
2187 | One colour value of the image may be used as a mask colour which will | |
2188 | lead to the automatic creation of a `wx.Mask` object associated to the | |
2189 | bitmap object. | |
2190 | ||
2191 | wx.Image supports alpha channel data, that is in addition to a byte | |
2192 | for the red, green and blue colour components for each pixel it also | |
2193 | stores a byte representing the pixel opacity. An alpha value of 0 | |
2194 | corresponds to a transparent pixel (null opacity) while a value of 255 | |
2195 | means that the pixel is 100% opaque. | |
2196 | ||
2197 | Unlike RGB data, not all images have an alpha channel and before using | |
2198 | `GetAlpha` you should check if this image contains an alpha channel | |
2199 | with `HasAlpha`. Note that currently only images loaded from PNG files | |
2200 | with transparency information will have an alpha channel. | |
2201 | """ | |
0085ce49 RD |
2202 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
2203 | __repr__ = _swig_repr | |
2204 | def __init__(self, *args, **kwargs): | |
7a27cf7c RD |
2205 | """ |
2206 | __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image | |
2207 | ||
2208 | Loads an image from a file. | |
2209 | """ | |
0085ce49 RD |
2210 | _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs)) |
2211 | __swig_destroy__ = _core_.delete_Image | |
2212 | __del__ = lambda self : None; | |
e811c8ce | 2213 | def Create(*args, **kwargs): |
7a27cf7c RD |
2214 | """ |
2215 | Create(self, int width, int height, bool clear=True) | |
2216 | ||
2217 | Creates a fresh image. If clear is ``True``, the new image will be | |
2218 | initialized to black. Otherwise, the image data will be uninitialized. | |
2219 | """ | |
54f9ee45 | 2220 | return _core_.Image_Create(*args, **kwargs) |
e811c8ce RD |
2221 | |
2222 | def Destroy(*args, **kwargs): | |
0df68c9f | 2223 | """ |
a95a7133 | 2224 | Destroy(self) |
e811c8ce | 2225 | |
7a27cf7c | 2226 | Destroys the image data. |
0df68c9f | 2227 | """ |
7e08d4ef RD |
2228 | val = _core_.Image_Destroy(*args, **kwargs) |
2229 | args[0].thisown = 0 | |
2230 | return val | |
e811c8ce RD |
2231 | |
2232 | def Scale(*args, **kwargs): | |
7a27cf7c RD |
2233 | """ |
2234 | Scale(self, int width, int height) -> Image | |
2235 | ||
2236 | Returns a scaled version of the image. This is also useful for scaling | |
2237 | bitmaps in general as the only other way to scale bitmaps is to blit a | |
2238 | `wx.MemoryDC` into another `wx.MemoryDC`. | |
2239 | """ | |
54f9ee45 | 2240 | return _core_.Image_Scale(*args, **kwargs) |
e811c8ce RD |
2241 | |
2242 | def ShrinkBy(*args, **kwargs): | |
7a27cf7c RD |
2243 | """ |
2244 | ShrinkBy(self, int xFactor, int yFactor) -> Image | |
2245 | ||
2246 | Return a version of the image scaled smaller by the given factors. | |
2247 | """ | |
54f9ee45 | 2248 | return _core_.Image_ShrinkBy(*args, **kwargs) |
e811c8ce RD |
2249 | |
2250 | def Rescale(*args, **kwargs): | |
7a27cf7c RD |
2251 | """ |
2252 | Rescale(self, int width, int height) -> Image | |
2253 | ||
2254 | Changes the size of the image in-place by scaling it: after a call to | |
2255 | this function, the image will have the given width and height. | |
2256 | ||
2257 | Returns the (modified) image itself. | |
2258 | """ | |
54f9ee45 | 2259 | return _core_.Image_Rescale(*args, **kwargs) |
e811c8ce | 2260 | |
aff4cc5c | 2261 | def Resize(*args, **kwargs): |
7a27cf7c RD |
2262 | """ |
2263 | Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image | |
2264 | ||
2265 | Changes the size of the image in-place without scaling it, by adding | |
2266 | either a border with the given colour or cropping as necessary. The | |
2267 | image is pasted into a new image with the given size and background | |
2268 | colour at the position pos relative to the upper left of the new | |
2269 | image. If red = green = blue = -1 then use either the current mask | |
2270 | colour if set or find, use, and set a suitable mask colour for any | |
2271 | newly exposed areas. | |
2272 | ||
2273 | Returns the (modified) image itself. | |
2274 | """ | |
aff4cc5c RD |
2275 | return _core_.Image_Resize(*args, **kwargs) |
2276 | ||
e811c8ce | 2277 | def SetRGB(*args, **kwargs): |
7a27cf7c RD |
2278 | """ |
2279 | SetRGB(self, int x, int y, byte r, byte g, byte b) | |
2280 | ||
2281 | Sets the pixel at the given coordinate. This routine performs | |
2282 | bounds-checks for the coordinate so it can be considered a safe way to | |
2283 | manipulate the data, but in some cases this might be too slow so that | |
2284 | the data will have to be set directly. In that case you will have to | |
2285 | get access to the image data using the `GetData` method. | |
2286 | """ | |
54f9ee45 | 2287 | return _core_.Image_SetRGB(*args, **kwargs) |
e811c8ce | 2288 | |
aff4cc5c | 2289 | def SetRGBRect(*args, **kwargs): |
7a27cf7c RD |
2290 | """ |
2291 | SetRGBRect(self, Rect rect, byte r, byte g, byte b) | |
2292 | ||
2293 | Sets the colour of the pixels within the given rectangle. This routine | |
2294 | performs bounds-checks for the rectangle so it can be considered a | |
2295 | safe way to manipulate the data. | |
2296 | """ | |
aff4cc5c RD |
2297 | return _core_.Image_SetRGBRect(*args, **kwargs) |
2298 | ||
e811c8ce | 2299 | def GetRed(*args, **kwargs): |
7a27cf7c RD |
2300 | """ |
2301 | GetRed(self, int x, int y) -> byte | |
2302 | ||
2303 | Returns the red intensity at the given coordinate. | |
2304 | """ | |
54f9ee45 | 2305 | return _core_.Image_GetRed(*args, **kwargs) |
e811c8ce RD |
2306 | |
2307 | def GetGreen(*args, **kwargs): | |
7a27cf7c RD |
2308 | """ |
2309 | GetGreen(self, int x, int y) -> byte | |
2310 | ||
2311 | Returns the green intensity at the given coordinate. | |
2312 | """ | |
54f9ee45 | 2313 | return _core_.Image_GetGreen(*args, **kwargs) |
e811c8ce RD |
2314 | |
2315 | def GetBlue(*args, **kwargs): | |
7a27cf7c RD |
2316 | """ |
2317 | GetBlue(self, int x, int y) -> byte | |
2318 | ||
2319 | Returns the blue intensity at the given coordinate. | |
2320 | """ | |
54f9ee45 | 2321 | return _core_.Image_GetBlue(*args, **kwargs) |
e811c8ce RD |
2322 | |
2323 | def SetAlpha(*args, **kwargs): | |
7a27cf7c RD |
2324 | """ |
2325 | SetAlpha(self, int x, int y, byte alpha) | |
2326 | ||
2327 | Sets the alpha value for the given pixel. This function should only be | |
2328 | called if the image has alpha channel data, use `HasAlpha` to check | |
2329 | for this. | |
2330 | """ | |
54f9ee45 | 2331 | return _core_.Image_SetAlpha(*args, **kwargs) |
e811c8ce RD |
2332 | |
2333 | def GetAlpha(*args, **kwargs): | |
7a27cf7c RD |
2334 | """ |
2335 | GetAlpha(self, int x, int y) -> byte | |
2336 | ||
2337 | Returns the alpha value for the given pixel. This function may only be | |
2338 | called for the images with alpha channel, use `HasAlpha` to check for | |
2339 | this. | |
2340 | ||
2341 | The returned value is the *opacity* of the image, i.e. the value of 0 | |
2342 | corresponds to the fully transparent pixels while the value of 255 to | |
2343 | the fully opaque pixels. | |
2344 | """ | |
54f9ee45 | 2345 | return _core_.Image_GetAlpha(*args, **kwargs) |
e811c8ce RD |
2346 | |
2347 | def HasAlpha(*args, **kwargs): | |
7a27cf7c RD |
2348 | """ |
2349 | HasAlpha(self) -> bool | |
2350 | ||
2351 | Returns true if this image has alpha channel, false otherwise. | |
2352 | """ | |
54f9ee45 | 2353 | return _core_.Image_HasAlpha(*args, **kwargs) |
e811c8ce | 2354 | |
68350608 RD |
2355 | def InitAlpha(*args, **kwargs): |
2356 | """ | |
2357 | InitAlpha(self) | |
2358 | ||
2359 | Initializes the image alpha channel data. It is an error to call it if | |
2360 | the image already has alpha data. If it doesn't, alpha data will be by | |
2361 | default initialized to all pixels being fully opaque. But if the image | |
2362 | has a a mask colour, all mask pixels will be completely transparent. | |
2363 | """ | |
2364 | return _core_.Image_InitAlpha(*args, **kwargs) | |
2365 | ||
bcd0d7b6 RD |
2366 | def IsTransparent(*args, **kwargs): |
2367 | """ | |
7a27cf7c | 2368 | IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool |
bcd0d7b6 | 2369 | |
7a27cf7c RD |
2370 | Returns ``True`` if this pixel is masked or has an alpha value less |
2371 | than the spcified threshold. | |
bcd0d7b6 RD |
2372 | """ |
2373 | return _core_.Image_IsTransparent(*args, **kwargs) | |
2374 | ||
e811c8ce | 2375 | def FindFirstUnusedColour(*args, **kwargs): |
fd2dc343 RD |
2376 | """ |
2377 | FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b) | |
2378 | ||
2379 | Find first colour that is not used in the image and has higher RGB | |
2380 | values than startR, startG, startB. Returns a tuple consisting of a | |
2381 | success flag and rgb values. | |
2382 | """ | |
54f9ee45 | 2383 | return _core_.Image_FindFirstUnusedColour(*args, **kwargs) |
e811c8ce | 2384 | |
4cf4100f RD |
2385 | def ConvertAlphaToMask(*args, **kwargs): |
2386 | """ | |
bcd0d7b6 | 2387 | ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool |
4cf4100f | 2388 | |
7a27cf7c RD |
2389 | If the image has alpha channel, this method converts it to mask. All |
2390 | pixels with alpha value less than ``threshold`` are replaced with the | |
2391 | mask colour and the alpha channel is removed. The mask colour is | |
2392 | chosen automatically using `FindFirstUnusedColour`. | |
4cf4100f RD |
2393 | |
2394 | If the image image doesn't have alpha channel, ConvertAlphaToMask does | |
2395 | nothing. | |
2396 | """ | |
2397 | return _core_.Image_ConvertAlphaToMask(*args, **kwargs) | |
2398 | ||
8fb0e70a RD |
2399 | def ConvertColourToAlpha(*args, **kwargs): |
2400 | """ | |
7a27cf7c | 2401 | ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool |
8fb0e70a RD |
2402 | |
2403 | This method converts an image where the original alpha information is | |
2404 | only available as a shades of a colour (actually shades of grey) | |
2405 | typically when you draw anti-aliased text into a bitmap. The DC | |
2406 | drawing routines draw grey values on the black background although | |
2407 | they actually mean to draw white with differnt alpha values. This | |
2408 | method reverses it, assuming a black (!) background and white text. | |
2409 | The method will then fill up the whole image with the colour given. | |
2410 | """ | |
2411 | return _core_.Image_ConvertColourToAlpha(*args, **kwargs) | |
2412 | ||
e811c8ce | 2413 | def SetMaskFromImage(*args, **kwargs): |
7a27cf7c RD |
2414 | """ |
2415 | SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool | |
2416 | ||
2417 | Sets the image's mask so that the pixels that have RGB value of | |
2418 | ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done | |
2419 | by first finding an unused colour in the image, setting this colour as | |
2420 | the mask colour and then using this colour to draw all pixels in the | |
2421 | image who corresponding pixel in mask has given RGB value. | |
2422 | ||
2423 | Returns ``False`` if ``mask`` does not have same dimensions as the | |
2424 | image or if there is no unused colour left. Returns ``True`` if the | |
2425 | mask was successfully applied. | |
2426 | ||
2427 | Note that this method involves computing the histogram, which is | |
2428 | computationally intensive operation. | |
2429 | """ | |
54f9ee45 | 2430 | return _core_.Image_SetMaskFromImage(*args, **kwargs) |
e811c8ce RD |
2431 | |
2432 | def CanRead(*args, **kwargs): | |
7a27cf7c RD |
2433 | """ |
2434 | CanRead(String filename) -> bool | |
2435 | ||
2436 | Returns True if the image handlers can read this file. | |
2437 | """ | |
54f9ee45 | 2438 | return _core_.Image_CanRead(*args, **kwargs) |
e811c8ce RD |
2439 | |
2440 | CanRead = staticmethod(CanRead) | |
2441 | def GetImageCount(*args, **kwargs): | |
7a27cf7c RD |
2442 | """ |
2443 | GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int | |
2444 | ||
2445 | If the image file contains more than one image and the image handler | |
2446 | is capable of retrieving these individually, this function will return | |
2447 | the number of available images. | |
2448 | """ | |
54f9ee45 | 2449 | return _core_.Image_GetImageCount(*args, **kwargs) |
e811c8ce RD |
2450 | |
2451 | GetImageCount = staticmethod(GetImageCount) | |
2452 | def LoadFile(*args, **kwargs): | |
7a27cf7c RD |
2453 | """ |
2454 | LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool | |
2455 | ||
2456 | Loads an image from a file. If no handler type is provided, the | |
2457 | library will try to autodetect the format. | |
2458 | """ | |
54f9ee45 | 2459 | return _core_.Image_LoadFile(*args, **kwargs) |
e811c8ce RD |
2460 | |
2461 | def LoadMimeFile(*args, **kwargs): | |
7a27cf7c RD |
2462 | """ |
2463 | LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool | |
2464 | ||
2465 | Loads an image from a file, specifying the image type with a MIME type | |
2466 | string. | |
2467 | """ | |
54f9ee45 | 2468 | return _core_.Image_LoadMimeFile(*args, **kwargs) |
e811c8ce RD |
2469 | |
2470 | def SaveFile(*args, **kwargs): | |
7a27cf7c RD |
2471 | """ |
2472 | SaveFile(self, String name, int type) -> bool | |
2473 | ||
2474 | Saves an image in the named file. | |
2475 | """ | |
54f9ee45 | 2476 | return _core_.Image_SaveFile(*args, **kwargs) |
e811c8ce RD |
2477 | |
2478 | def SaveMimeFile(*args, **kwargs): | |
7a27cf7c RD |
2479 | """ |
2480 | SaveMimeFile(self, String name, String mimetype) -> bool | |
2481 | ||
2482 | Saves an image in the named file. | |
2483 | """ | |
54f9ee45 | 2484 | return _core_.Image_SaveMimeFile(*args, **kwargs) |
e811c8ce RD |
2485 | |
2486 | def CanReadStream(*args, **kwargs): | |
7a27cf7c RD |
2487 | """ |
2488 | CanReadStream(InputStream stream) -> bool | |
2489 | ||
2490 | Returns True if the image handlers can read an image file from the | |
2491 | data currently on the input stream, or a readable Python file-like | |
2492 | object. | |
2493 | """ | |
54f9ee45 | 2494 | return _core_.Image_CanReadStream(*args, **kwargs) |
e811c8ce RD |
2495 | |
2496 | CanReadStream = staticmethod(CanReadStream) | |
2497 | def LoadStream(*args, **kwargs): | |
7a27cf7c RD |
2498 | """ |
2499 | LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool | |
2500 | ||
2501 | Loads an image from an input stream or a readable Python file-like | |
2502 | object. If no handler type is provided, the library will try to | |
2503 | autodetect the format. | |
2504 | """ | |
54f9ee45 | 2505 | return _core_.Image_LoadStream(*args, **kwargs) |
e811c8ce RD |
2506 | |
2507 | def LoadMimeStream(*args, **kwargs): | |
7a27cf7c RD |
2508 | """ |
2509 | LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool | |
2510 | ||
2511 | Loads an image from an input stream or a readable Python file-like | |
2512 | object, using a MIME type string to specify the image file format. | |
2513 | """ | |
54f9ee45 | 2514 | return _core_.Image_LoadMimeStream(*args, **kwargs) |
e811c8ce RD |
2515 | |
2516 | def Ok(*args, **kwargs): | |
7a27cf7c RD |
2517 | """ |
2518 | Ok(self) -> bool | |
2519 | ||
2520 | Returns true if image data is present. | |
2521 | """ | |
54f9ee45 | 2522 | return _core_.Image_Ok(*args, **kwargs) |
e811c8ce RD |
2523 | |
2524 | def GetWidth(*args, **kwargs): | |
7a27cf7c RD |
2525 | """ |
2526 | GetWidth(self) -> int | |
2527 | ||
2528 | Gets the width of the image in pixels. | |
2529 | """ | |
54f9ee45 | 2530 | return _core_.Image_GetWidth(*args, **kwargs) |
e811c8ce RD |
2531 | |
2532 | def GetHeight(*args, **kwargs): | |
7a27cf7c RD |
2533 | """ |
2534 | GetHeight(self) -> int | |
2535 | ||
2536 | Gets the height of the image in pixels. | |
2537 | """ | |
54f9ee45 | 2538 | return _core_.Image_GetHeight(*args, **kwargs) |
e811c8ce | 2539 | |
b2df227b | 2540 | def GetSize(*args, **kwargs): |
7a27cf7c RD |
2541 | """ |
2542 | GetSize(self) -> Size | |
2543 | ||
2544 | Returns the size of the image in pixels. | |
2545 | """ | |
54f9ee45 | 2546 | return _core_.Image_GetSize(*args, **kwargs) |
b2df227b | 2547 | |
e811c8ce | 2548 | def GetSubImage(*args, **kwargs): |
7a27cf7c RD |
2549 | """ |
2550 | GetSubImage(self, Rect rect) -> Image | |
2551 | ||
2552 | Returns a sub image of the current one as long as the rect belongs | |
2553 | entirely to the image. | |
2554 | """ | |
54f9ee45 | 2555 | return _core_.Image_GetSubImage(*args, **kwargs) |
e811c8ce | 2556 | |
aff4cc5c | 2557 | def Size(*args, **kwargs): |
7a27cf7c RD |
2558 | """ |
2559 | Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image | |
2560 | ||
2561 | Returns a resized version of this image without scaling it by adding | |
2562 | either a border with the given colour or cropping as necessary. The | |
2563 | image is pasted into a new image with the given size and background | |
2564 | colour at the position ``pos`` relative to the upper left of the new | |
2565 | image. If red = green = blue = -1 then use either the current mask | |
2566 | colour if set or find, use, and set a suitable mask colour for any | |
2567 | newly exposed areas. | |
2568 | """ | |
aff4cc5c RD |
2569 | return _core_.Image_Size(*args, **kwargs) |
2570 | ||
e811c8ce | 2571 | def Copy(*args, **kwargs): |
7a27cf7c RD |
2572 | """ |
2573 | Copy(self) -> Image | |
2574 | ||
2575 | Returns an identical copy of the image. | |
2576 | """ | |
54f9ee45 | 2577 | return _core_.Image_Copy(*args, **kwargs) |
e811c8ce RD |
2578 | |
2579 | def Paste(*args, **kwargs): | |
7a27cf7c RD |
2580 | """ |
2581 | Paste(self, Image image, int x, int y) | |
2582 | ||
2583 | Pastes ``image`` into this instance and takes care of the mask colour | |
2584 | and any out of bounds problems. | |
2585 | """ | |
54f9ee45 | 2586 | return _core_.Image_Paste(*args, **kwargs) |
e811c8ce RD |
2587 | |
2588 | def GetData(*args, **kwargs): | |
61d07ac7 RD |
2589 | """ |
2590 | GetData(self) -> PyObject | |
2591 | ||
2592 | Returns a string containing a copy of the RGB bytes of the image. | |
2593 | """ | |
54f9ee45 | 2594 | return _core_.Image_GetData(*args, **kwargs) |
e811c8ce RD |
2595 | |
2596 | def SetData(*args, **kwargs): | |
61d07ac7 RD |
2597 | """ |
2598 | SetData(self, buffer data) | |
2599 | ||
2600 | Resets the Image's RGB data from a buffer of RGB bytes. Accepts | |
2601 | either a string or a buffer object holding the data and the length of | |
2602 | the data must be width*height*3. | |
2603 | """ | |
54f9ee45 | 2604 | return _core_.Image_SetData(*args, **kwargs) |
e811c8ce RD |
2605 | |
2606 | def GetDataBuffer(*args, **kwargs): | |
61d07ac7 RD |
2607 | """ |
2608 | GetDataBuffer(self) -> PyObject | |
2609 | ||
2610 | Returns a writable Python buffer object that is pointing at the RGB | |
7a27cf7c RD |
2611 | image data buffer inside the wx.Image. You need to ensure that you do |
2612 | not use this buffer object after the image has been destroyed. | |
61d07ac7 | 2613 | """ |
54f9ee45 | 2614 | return _core_.Image_GetDataBuffer(*args, **kwargs) |
e811c8ce RD |
2615 | |
2616 | def SetDataBuffer(*args, **kwargs): | |
61d07ac7 RD |
2617 | """ |
2618 | SetDataBuffer(self, buffer data) | |
2619 | ||
2620 | Sets the internal image data pointer to point at a Python buffer | |
7a27cf7c RD |
2621 | object. This can save making an extra copy of the data but you must |
2622 | ensure that the buffer object lives longer than the wx.Image does. | |
61d07ac7 | 2623 | """ |
54f9ee45 | 2624 | return _core_.Image_SetDataBuffer(*args, **kwargs) |
e811c8ce RD |
2625 | |
2626 | def GetAlphaData(*args, **kwargs): | |
61d07ac7 RD |
2627 | """ |
2628 | GetAlphaData(self) -> PyObject | |
2629 | ||
2630 | Returns a string containing a copy of the alpha bytes of the image. | |
2631 | """ | |
54f9ee45 | 2632 | return _core_.Image_GetAlphaData(*args, **kwargs) |
e811c8ce RD |
2633 | |
2634 | def SetAlphaData(*args, **kwargs): | |
61d07ac7 RD |
2635 | """ |
2636 | SetAlphaData(self, buffer alpha) | |
2637 | ||
2638 | Resets the Image's alpha data from a buffer of bytes. Accepts either | |
2639 | a string or a buffer object holding the data and the length of the | |
2640 | data must be width*height. | |
2641 | """ | |
54f9ee45 | 2642 | return _core_.Image_SetAlphaData(*args, **kwargs) |
e811c8ce RD |
2643 | |
2644 | def GetAlphaBuffer(*args, **kwargs): | |
a95a7133 | 2645 | """GetAlphaBuffer(self) -> PyObject""" |
54f9ee45 | 2646 | return _core_.Image_GetAlphaBuffer(*args, **kwargs) |
e811c8ce RD |
2647 | |
2648 | def SetAlphaBuffer(*args, **kwargs): | |
61d07ac7 | 2649 | """SetAlphaBuffer(self, buffer alpha)""" |
54f9ee45 | 2650 | return _core_.Image_SetAlphaBuffer(*args, **kwargs) |
e811c8ce RD |
2651 | |
2652 | def SetMaskColour(*args, **kwargs): | |
7a27cf7c RD |
2653 | """ |
2654 | SetMaskColour(self, byte r, byte g, byte b) | |
2655 | ||
2656 | Sets the mask colour for this image (and tells the image to use the | |
2657 | mask). | |
2658 | """ | |
54f9ee45 | 2659 | return _core_.Image_SetMaskColour(*args, **kwargs) |
e811c8ce | 2660 | |
aff4cc5c RD |
2661 | def GetOrFindMaskColour(*args, **kwargs): |
2662 | """ | |
2663 | GetOrFindMaskColour() -> (r,g,b) | |
2664 | ||
2665 | Get the current mask colour or find a suitable colour. | |
2666 | """ | |
2667 | return _core_.Image_GetOrFindMaskColour(*args, **kwargs) | |
2668 | ||
e811c8ce | 2669 | def GetMaskRed(*args, **kwargs): |
7a27cf7c RD |
2670 | """ |
2671 | GetMaskRed(self) -> byte | |
2672 | ||
2673 | Gets the red component of the mask colour. | |
2674 | """ | |
54f9ee45 | 2675 | return _core_.Image_GetMaskRed(*args, **kwargs) |
e811c8ce RD |
2676 | |
2677 | def GetMaskGreen(*args, **kwargs): | |
7a27cf7c RD |
2678 | """ |
2679 | GetMaskGreen(self) -> byte | |
2680 | ||
2681 | Gets the green component of the mask colour. | |
2682 | """ | |
54f9ee45 | 2683 | return _core_.Image_GetMaskGreen(*args, **kwargs) |
e811c8ce RD |
2684 | |
2685 | def GetMaskBlue(*args, **kwargs): | |
7a27cf7c RD |
2686 | """ |
2687 | GetMaskBlue(self) -> byte | |
2688 | ||
2689 | Gets the blue component of the mask colour. | |
2690 | """ | |
54f9ee45 | 2691 | return _core_.Image_GetMaskBlue(*args, **kwargs) |
e811c8ce RD |
2692 | |
2693 | def SetMask(*args, **kwargs): | |
7a27cf7c RD |
2694 | """ |
2695 | SetMask(self, bool mask=True) | |
2696 | ||
2697 | Specifies whether there is a mask or not. The area of the mask is | |
2698 | determined by the current mask colour. | |
2699 | """ | |
54f9ee45 | 2700 | return _core_.Image_SetMask(*args, **kwargs) |
e811c8ce RD |
2701 | |
2702 | def HasMask(*args, **kwargs): | |
7a27cf7c RD |
2703 | """ |
2704 | HasMask(self) -> bool | |
2705 | ||
2706 | Returns ``True`` if there is a mask active, ``False`` otherwise. | |
2707 | """ | |
54f9ee45 | 2708 | return _core_.Image_HasMask(*args, **kwargs) |
e811c8ce RD |
2709 | |
2710 | def Rotate(*args, **kwargs): | |
0df68c9f | 2711 | """ |
a95a7133 | 2712 | Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True, |
0df68c9f | 2713 | Point offset_after_rotation=None) -> Image |
7a27cf7c RD |
2714 | |
2715 | Rotates the image about the given point, by ``angle`` radians. Passing | |
2716 | ``True`` to ``interpolating`` results in better image quality, but is | |
2717 | slower. If the image has a mask, then the mask colour is used for the | |
2718 | uncovered pixels in the rotated image background. Otherwise, black | |
2719 | will be used as the fill colour. | |
2720 | ||
2721 | Returns the rotated image, leaving this image intact. | |
0df68c9f | 2722 | """ |
54f9ee45 | 2723 | return _core_.Image_Rotate(*args, **kwargs) |
e811c8ce RD |
2724 | |
2725 | def Rotate90(*args, **kwargs): | |
7a27cf7c RD |
2726 | """ |
2727 | Rotate90(self, bool clockwise=True) -> Image | |
2728 | ||
2729 | Returns a copy of the image rotated 90 degrees in the direction | |
2730 | indicated by ``clockwise``. | |
2731 | """ | |
54f9ee45 | 2732 | return _core_.Image_Rotate90(*args, **kwargs) |
e811c8ce RD |
2733 | |
2734 | def Mirror(*args, **kwargs): | |
7a27cf7c RD |
2735 | """ |
2736 | Mirror(self, bool horizontally=True) -> Image | |
2737 | ||
2738 | Returns a mirrored copy of the image. The parameter ``horizontally`` | |
2739 | indicates the orientation. | |
2740 | """ | |
54f9ee45 | 2741 | return _core_.Image_Mirror(*args, **kwargs) |
e811c8ce RD |
2742 | |
2743 | def Replace(*args, **kwargs): | |
0df68c9f | 2744 | """ |
7a27cf7c RD |
2745 | Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2) |
2746 | ||
2747 | Replaces the colour specified by ``(r1,g1,b1)`` by the colour | |
2748 | ``(r2,g2,b2)``. | |
0df68c9f | 2749 | """ |
54f9ee45 | 2750 | return _core_.Image_Replace(*args, **kwargs) |
e811c8ce | 2751 | |
32fe5131 RD |
2752 | def ConvertToGreyscale(*args, **kwargs): |
2753 | """ | |
2754 | ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image | |
2755 | ||
2756 | Convert to greyscale image. Uses the luminance component (Y) of the | |
2757 | image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb), | |
2758 | defaults to ITU-T BT.601 | |
2759 | """ | |
2760 | return _core_.Image_ConvertToGreyscale(*args, **kwargs) | |
2761 | ||
e811c8ce | 2762 | def ConvertToMono(*args, **kwargs): |
7a27cf7c RD |
2763 | """ |
2764 | ConvertToMono(self, byte r, byte g, byte b) -> Image | |
2765 | ||
2766 | Returns monochromatic version of the image. The returned image has | |
2767 | white colour where the original has ``(r,g,b)`` colour and black | |
2768 | colour everywhere else. | |
2769 | """ | |
54f9ee45 | 2770 | return _core_.Image_ConvertToMono(*args, **kwargs) |
e811c8ce RD |
2771 | |
2772 | def SetOption(*args, **kwargs): | |
7a27cf7c RD |
2773 | """ |
2774 | SetOption(self, String name, String value) | |
2775 | ||
2776 | Sets an image handler defined option. For example, when saving as a | |
2777 | JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a | |
2778 | number between 0 and 100 (0 is terrible, 100 is very good). | |
2779 | """ | |
54f9ee45 | 2780 | return _core_.Image_SetOption(*args, **kwargs) |
e811c8ce RD |
2781 | |
2782 | def SetOptionInt(*args, **kwargs): | |
7a27cf7c RD |
2783 | """ |
2784 | SetOptionInt(self, String name, int value) | |
2785 | ||
2786 | Sets an image option as an integer. | |
2787 | """ | |
54f9ee45 | 2788 | return _core_.Image_SetOptionInt(*args, **kwargs) |
e811c8ce RD |
2789 | |
2790 | def GetOption(*args, **kwargs): | |
7a27cf7c RD |
2791 | """ |
2792 | GetOption(self, String name) -> String | |
2793 | ||
2794 | Gets the value of an image handler option. | |
2795 | """ | |
54f9ee45 | 2796 | return _core_.Image_GetOption(*args, **kwargs) |
e811c8ce RD |
2797 | |
2798 | def GetOptionInt(*args, **kwargs): | |
7a27cf7c RD |
2799 | """ |
2800 | GetOptionInt(self, String name) -> int | |
2801 | ||
2802 | Gets the value of an image handler option as an integer. If the given | |
2803 | option is not present, the function returns 0. | |
2804 | """ | |
54f9ee45 | 2805 | return _core_.Image_GetOptionInt(*args, **kwargs) |
e811c8ce RD |
2806 | |
2807 | def HasOption(*args, **kwargs): | |
7a27cf7c RD |
2808 | """ |
2809 | HasOption(self, String name) -> bool | |
2810 | ||
2811 | Returns true if the given option is present. | |
2812 | """ | |
54f9ee45 | 2813 | return _core_.Image_HasOption(*args, **kwargs) |
e811c8ce RD |
2814 | |
2815 | def CountColours(*args, **kwargs): | |
a95a7133 | 2816 | """CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long""" |
54f9ee45 | 2817 | return _core_.Image_CountColours(*args, **kwargs) |
e811c8ce RD |
2818 | |
2819 | def ComputeHistogram(*args, **kwargs): | |
a95a7133 | 2820 | """ComputeHistogram(self, ImageHistogram h) -> unsigned long""" |
54f9ee45 | 2821 | return _core_.Image_ComputeHistogram(*args, **kwargs) |
e811c8ce RD |
2822 | |
2823 | def AddHandler(*args, **kwargs): | |
66c033b4 | 2824 | """AddHandler(ImageHandler handler)""" |
54f9ee45 | 2825 | return _core_.Image_AddHandler(*args, **kwargs) |
e811c8ce RD |
2826 | |
2827 | AddHandler = staticmethod(AddHandler) | |
2828 | def InsertHandler(*args, **kwargs): | |
66c033b4 | 2829 | """InsertHandler(ImageHandler handler)""" |
54f9ee45 | 2830 | return _core_.Image_InsertHandler(*args, **kwargs) |
e811c8ce RD |
2831 | |
2832 | InsertHandler = staticmethod(InsertHandler) | |
2833 | def RemoveHandler(*args, **kwargs): | |
66c033b4 | 2834 | """RemoveHandler(String name) -> bool""" |
54f9ee45 | 2835 | return _core_.Image_RemoveHandler(*args, **kwargs) |
e811c8ce RD |
2836 | |
2837 | RemoveHandler = staticmethod(RemoveHandler) | |
0085ce49 RD |
2838 | def GetHandlers(*args, **kwargs): |
2839 | """GetHandlers() -> PyObject""" | |
2840 | return _core_.Image_GetHandlers(*args, **kwargs) | |
2841 | ||
2842 | GetHandlers = staticmethod(GetHandlers) | |
e811c8ce | 2843 | def GetImageExtWildcard(*args, **kwargs): |
7a27cf7c RD |
2844 | """ |
2845 | GetImageExtWildcard() -> String | |
2846 | ||
2847 | Iterates all registered wxImageHandler objects, and returns a string | |
2848 | containing file extension masks suitable for passing to file open/save | |
2849 | dialog boxes. | |
2850 | """ | |
54f9ee45 | 2851 | return _core_.Image_GetImageExtWildcard(*args, **kwargs) |
e811c8ce RD |
2852 | |
2853 | GetImageExtWildcard = staticmethod(GetImageExtWildcard) | |
2854 | def ConvertToBitmap(*args, **kwargs): | |
1fbf26be | 2855 | """ConvertToBitmap(self, int depth=-1) -> Bitmap""" |
54f9ee45 | 2856 | return _core_.Image_ConvertToBitmap(*args, **kwargs) |
e811c8ce RD |
2857 | |
2858 | def ConvertToMonoBitmap(*args, **kwargs): | |
7a27cf7c | 2859 | """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap""" |
54f9ee45 | 2860 | return _core_.Image_ConvertToMonoBitmap(*args, **kwargs) |
e811c8ce | 2861 | |
943e8dfd RD |
2862 | def RotateHue(*args, **kwargs): |
2863 | """ | |
2864 | RotateHue(self, double angle) | |
2865 | ||
2866 | Rotates the hue of each pixel of the image. Hue is a double in the | |
2867 | range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees | |
2868 | """ | |
2869 | return _core_.Image_RotateHue(*args, **kwargs) | |
2870 | ||
2871 | def RGBtoHSV(*args, **kwargs): | |
2872 | """ | |
2873 | RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue | |
2874 | ||
2875 | Converts a color in RGB color space to HSV color space. | |
2876 | """ | |
2877 | return _core_.Image_RGBtoHSV(*args, **kwargs) | |
2878 | ||
2879 | RGBtoHSV = staticmethod(RGBtoHSV) | |
2880 | def HSVtoRGB(*args, **kwargs): | |
2881 | """ | |
2882 | HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue | |
2883 | ||
2884 | Converts a color in HSV color space to RGB color space. | |
2885 | """ | |
2886 | return _core_.Image_HSVtoRGB(*args, **kwargs) | |
2887 | ||
2888 | HSVtoRGB = staticmethod(HSVtoRGB) | |
e811c8ce | 2889 | def __nonzero__(self): return self.Ok() |
2131d850 | 2890 | _core_.Image_swigregister(Image) |
d14a1e28 RD |
2891 | |
2892 | def ImageFromMime(*args, **kwargs): | |
7a27cf7c RD |
2893 | """ |
2894 | ImageFromMime(String name, String mimetype, int index=-1) -> Image | |
2895 | ||
2896 | Loads an image from a file, using a MIME type string (such as | |
2897 | 'image/jpeg') to specify image type. | |
2898 | """ | |
54f9ee45 | 2899 | val = _core_.new_ImageFromMime(*args, **kwargs) |
d14a1e28 RD |
2900 | return val |
2901 | ||
2902 | def ImageFromStream(*args, **kwargs): | |
7a27cf7c RD |
2903 | """ |
2904 | ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image | |
2905 | ||
2906 | Loads an image from an input stream, or any readable Python file-like | |
2907 | object. | |
2908 | """ | |
54f9ee45 | 2909 | val = _core_.new_ImageFromStream(*args, **kwargs) |
d14a1e28 RD |
2910 | return val |
2911 | ||
2912 | def ImageFromStreamMime(*args, **kwargs): | |
7a27cf7c RD |
2913 | """ |
2914 | ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image | |
2915 | ||
2916 | Loads an image from an input stream, or any readable Python file-like | |
2917 | object, specifying the image format with a MIME type string. | |
2918 | """ | |
54f9ee45 | 2919 | val = _core_.new_ImageFromStreamMime(*args, **kwargs) |
d14a1e28 RD |
2920 | return val |
2921 | ||
66c033b4 | 2922 | def EmptyImage(*args, **kwargs): |
61d07ac7 RD |
2923 | """ |
2924 | EmptyImage(int width=0, int height=0, bool clear=True) -> Image | |
2925 | ||
2926 | Construct an empty image of a given size, optionally setting all | |
2927 | pixels to black. | |
2928 | """ | |
66c033b4 | 2929 | val = _core_.new_EmptyImage(*args, **kwargs) |
d14a1e28 RD |
2930 | return val |
2931 | ||
2932 | def ImageFromBitmap(*args, **kwargs): | |
61d07ac7 RD |
2933 | """ |
2934 | ImageFromBitmap(Bitmap bitmap) -> Image | |
2935 | ||
2936 | Construct an Image from a `wx.Bitmap`. | |
2937 | """ | |
54f9ee45 | 2938 | val = _core_.new_ImageFromBitmap(*args, **kwargs) |
d14a1e28 RD |
2939 | return val |
2940 | ||
2941 | def ImageFromData(*args, **kwargs): | |
61d07ac7 RD |
2942 | """ |
2943 | ImageFromData(int width, int height, buffer data) -> Image | |
2944 | ||
2945 | Construct an Image from a buffer of RGB bytes. Accepts either a | |
2946 | string or a buffer object holding the data and the length of the data | |
2947 | must be width*height*3. | |
2948 | """ | |
54f9ee45 | 2949 | val = _core_.new_ImageFromData(*args, **kwargs) |
d14a1e28 RD |
2950 | return val |
2951 | ||
1823fbb4 | 2952 | def ImageFromDataWithAlpha(*args, **kwargs): |
61d07ac7 RD |
2953 | """ |
2954 | ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image | |
2955 | ||
2956 | Construct an Image from a buffer of RGB bytes with an Alpha channel. | |
2957 | Accepts either a string or a buffer object holding the data and the | |
7a27cf7c RD |
2958 | length of the data must be width*height*3 bytes, and the length of the |
2959 | alpha data must be width*height bytes. | |
61d07ac7 | 2960 | """ |
1823fbb4 | 2961 | val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs) |
1823fbb4 RD |
2962 | return val |
2963 | ||
e811c8ce | 2964 | def Image_CanRead(*args, **kwargs): |
0085ce49 | 2965 | """ |
7a27cf7c RD |
2966 | Image_CanRead(String filename) -> bool |
2967 | ||
2968 | Returns True if the image handlers can read this file. | |
2969 | """ | |
0085ce49 | 2970 | return _core_.Image_CanRead(*args, **kwargs) |
d14a1e28 | 2971 | |
e811c8ce | 2972 | def Image_GetImageCount(*args, **kwargs): |
0085ce49 | 2973 | """ |
7a27cf7c RD |
2974 | Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int |
2975 | ||
2976 | If the image file contains more than one image and the image handler | |
2977 | is capable of retrieving these individually, this function will return | |
2978 | the number of available images. | |
2979 | """ | |
0085ce49 | 2980 | return _core_.Image_GetImageCount(*args, **kwargs) |
d14a1e28 | 2981 | |
e811c8ce | 2982 | def Image_CanReadStream(*args, **kwargs): |
0085ce49 | 2983 | """ |
7a27cf7c RD |
2984 | Image_CanReadStream(InputStream stream) -> bool |
2985 | ||
2986 | Returns True if the image handlers can read an image file from the | |
2987 | data currently on the input stream, or a readable Python file-like | |
2988 | object. | |
2989 | """ | |
0085ce49 | 2990 | return _core_.Image_CanReadStream(*args, **kwargs) |
d14a1e28 | 2991 | |
e811c8ce | 2992 | def Image_AddHandler(*args, **kwargs): |
0085ce49 RD |
2993 | """Image_AddHandler(ImageHandler handler)""" |
2994 | return _core_.Image_AddHandler(*args, **kwargs) | |
d14a1e28 | 2995 | |
e811c8ce | 2996 | def Image_InsertHandler(*args, **kwargs): |
0085ce49 RD |
2997 | """Image_InsertHandler(ImageHandler handler)""" |
2998 | return _core_.Image_InsertHandler(*args, **kwargs) | |
d14a1e28 | 2999 | |
e811c8ce | 3000 | def Image_RemoveHandler(*args, **kwargs): |
0085ce49 RD |
3001 | """Image_RemoveHandler(String name) -> bool""" |
3002 | return _core_.Image_RemoveHandler(*args, **kwargs) | |
d14a1e28 | 3003 | |
0085ce49 RD |
3004 | def Image_GetHandlers(*args): |
3005 | """Image_GetHandlers() -> PyObject""" | |
3006 | return _core_.Image_GetHandlers(*args) | |
3007 | ||
3008 | def Image_GetImageExtWildcard(*args): | |
3009 | """ | |
7a27cf7c RD |
3010 | Image_GetImageExtWildcard() -> String |
3011 | ||
3012 | Iterates all registered wxImageHandler objects, and returns a string | |
3013 | containing file extension masks suitable for passing to file open/save | |
3014 | dialog boxes. | |
3015 | """ | |
0085ce49 | 3016 | return _core_.Image_GetImageExtWildcard(*args) |
d14a1e28 | 3017 | |
943e8dfd | 3018 | def Image_RGBtoHSV(*args, **kwargs): |
0085ce49 | 3019 | """ |
943e8dfd RD |
3020 | Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue |
3021 | ||
3022 | Converts a color in RGB color space to HSV color space. | |
3023 | """ | |
0085ce49 | 3024 | return _core_.Image_RGBtoHSV(*args, **kwargs) |
943e8dfd RD |
3025 | |
3026 | def Image_HSVtoRGB(*args, **kwargs): | |
0085ce49 | 3027 | """ |
943e8dfd RD |
3028 | Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue |
3029 | ||
3030 | Converts a color in HSV color space to RGB color space. | |
3031 | """ | |
0085ce49 | 3032 | return _core_.Image_HSVtoRGB(*args, **kwargs) |
943e8dfd | 3033 | |
5e4ca4a8 RD |
3034 | def InitAllImageHandlers(): |
3035 | """ | |
3036 | The former functionality of InitAllImageHanders is now done internal to | |
3037 | the _core_ extension module and so this function has become a simple NOP. | |
3038 | """ | |
3039 | pass | |
d14a1e28 | 3040 | |
54f9ee45 RD |
3041 | IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES |
3042 | IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM | |
b9d6a5f3 RD |
3043 | PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR |
3044 | PNG_TYPE_GREY = _core_.PNG_TYPE_GREY | |
3045 | PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED | |
54f9ee45 RD |
3046 | BMP_24BPP = _core_.BMP_24BPP |
3047 | BMP_8BPP = _core_.BMP_8BPP | |
3048 | BMP_8BPP_GREY = _core_.BMP_8BPP_GREY | |
3049 | BMP_8BPP_GRAY = _core_.BMP_8BPP_GRAY | |
3050 | BMP_8BPP_RED = _core_.BMP_8BPP_RED | |
3051 | BMP_8BPP_PALETTE = _core_.BMP_8BPP_PALETTE | |
3052 | BMP_4BPP = _core_.BMP_4BPP | |
3053 | BMP_1BPP = _core_.BMP_1BPP | |
3054 | BMP_1BPP_BW = _core_.BMP_1BPP_BW | |
d14a1e28 | 3055 | class BMPHandler(ImageHandler): |
27fb7603 | 3056 | """A `wx.ImageHandler` for \*.bmp bitmap files.""" |
0085ce49 RD |
3057 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3058 | __repr__ = _swig_repr | |
3059 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3060 | """ |
3061 | __init__(self) -> BMPHandler | |
3062 | ||
3063 | A `wx.ImageHandler` for \*.bmp bitmap files. | |
3064 | """ | |
0085ce49 | 3065 | _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs)) |
2131d850 | 3066 | _core_.BMPHandler_swigregister(BMPHandler) |
d14a1e28 | 3067 | NullImage = cvar.NullImage |
0c243d93 | 3068 | IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME |
d14a1e28 RD |
3069 | IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT |
3070 | IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X | |
3071 | IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y | |
3072 | IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION | |
0c243d93 RD |
3073 | IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX |
3074 | IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY | |
d14a1e28 | 3075 | IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT |
24d7cbea | 3076 | IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY |
0c243d93 RD |
3077 | IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE |
3078 | IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL | |
3079 | IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION | |
3080 | IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR | |
b9d6a5f3 RD |
3081 | IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT |
3082 | IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH | |
d14a1e28 RD |
3083 | |
3084 | class ICOHandler(BMPHandler): | |
27fb7603 | 3085 | """A `wx.ImageHandler` for \*.ico icon files.""" |
0085ce49 RD |
3086 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3087 | __repr__ = _swig_repr | |
3088 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3089 | """ |
3090 | __init__(self) -> ICOHandler | |
3091 | ||
3092 | A `wx.ImageHandler` for \*.ico icon files. | |
3093 | """ | |
0085ce49 | 3094 | _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs)) |
2131d850 | 3095 | _core_.ICOHandler_swigregister(ICOHandler) |
d14a1e28 RD |
3096 | |
3097 | class CURHandler(ICOHandler): | |
27fb7603 | 3098 | """A `wx.ImageHandler` for \*.cur cursor files.""" |
0085ce49 RD |
3099 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3100 | __repr__ = _swig_repr | |
3101 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3102 | """ |
3103 | __init__(self) -> CURHandler | |
3104 | ||
3105 | A `wx.ImageHandler` for \*.cur cursor files. | |
3106 | """ | |
0085ce49 | 3107 | _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs)) |
2131d850 | 3108 | _core_.CURHandler_swigregister(CURHandler) |
d14a1e28 RD |
3109 | |
3110 | class ANIHandler(CURHandler): | |
27fb7603 | 3111 | """A `wx.ImageHandler` for \*.ani animated cursor files.""" |
0085ce49 RD |
3112 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3113 | __repr__ = _swig_repr | |
3114 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3115 | """ |
3116 | __init__(self) -> ANIHandler | |
3117 | ||
3118 | A `wx.ImageHandler` for \*.ani animated cursor files. | |
3119 | """ | |
0085ce49 | 3120 | _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs)) |
2131d850 | 3121 | _core_.ANIHandler_swigregister(ANIHandler) |
d14a1e28 RD |
3122 | |
3123 | class PNGHandler(ImageHandler): | |
27fb7603 | 3124 | """A `wx.ImageHandler` for PNG image files.""" |
0085ce49 RD |
3125 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3126 | __repr__ = _swig_repr | |
3127 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3128 | """ |
3129 | __init__(self) -> PNGHandler | |
3130 | ||
3131 | A `wx.ImageHandler` for PNG image files. | |
3132 | """ | |
0085ce49 | 3133 | _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs)) |
2131d850 | 3134 | _core_.PNGHandler_swigregister(PNGHandler) |
d14a1e28 RD |
3135 | |
3136 | class GIFHandler(ImageHandler): | |
27fb7603 | 3137 | """A `wx.ImageHandler` for GIF image files.""" |
0085ce49 RD |
3138 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3139 | __repr__ = _swig_repr | |
3140 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3141 | """ |
3142 | __init__(self) -> GIFHandler | |
3143 | ||
3144 | A `wx.ImageHandler` for GIF image files. | |
3145 | """ | |
0085ce49 | 3146 | _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs)) |
2131d850 | 3147 | _core_.GIFHandler_swigregister(GIFHandler) |
d14a1e28 RD |
3148 | |
3149 | class PCXHandler(ImageHandler): | |
27fb7603 | 3150 | """A `wx.ImageHandler` for PCX imager files.""" |
0085ce49 RD |
3151 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3152 | __repr__ = _swig_repr | |
3153 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3154 | """ |
3155 | __init__(self) -> PCXHandler | |
3156 | ||
3157 | A `wx.ImageHandler` for PCX imager files. | |
3158 | """ | |
0085ce49 | 3159 | _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs)) |
2131d850 | 3160 | _core_.PCXHandler_swigregister(PCXHandler) |
d14a1e28 RD |
3161 | |
3162 | class JPEGHandler(ImageHandler): | |
27fb7603 | 3163 | """A `wx.ImageHandler` for JPEG/JPG image files.""" |
0085ce49 RD |
3164 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3165 | __repr__ = _swig_repr | |
3166 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3167 | """ |
3168 | __init__(self) -> JPEGHandler | |
3169 | ||
3170 | A `wx.ImageHandler` for JPEG/JPG image files. | |
3171 | """ | |
0085ce49 | 3172 | _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs)) |
2131d850 | 3173 | _core_.JPEGHandler_swigregister(JPEGHandler) |
d14a1e28 RD |
3174 | |
3175 | class PNMHandler(ImageHandler): | |
27fb7603 | 3176 | """A `wx.ImageHandler` for PNM image files.""" |
0085ce49 RD |
3177 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3178 | __repr__ = _swig_repr | |
3179 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3180 | """ |
3181 | __init__(self) -> PNMHandler | |
3182 | ||
3183 | A `wx.ImageHandler` for PNM image files. | |
3184 | """ | |
0085ce49 | 3185 | _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs)) |
2131d850 | 3186 | _core_.PNMHandler_swigregister(PNMHandler) |
d14a1e28 RD |
3187 | |
3188 | class XPMHandler(ImageHandler): | |
27fb7603 | 3189 | """A `wx.ImageHandler` for XPM image.""" |
0085ce49 RD |
3190 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3191 | __repr__ = _swig_repr | |
3192 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3193 | """ |
3194 | __init__(self) -> XPMHandler | |
3195 | ||
3196 | A `wx.ImageHandler` for XPM image. | |
3197 | """ | |
0085ce49 | 3198 | _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs)) |
2131d850 | 3199 | _core_.XPMHandler_swigregister(XPMHandler) |
d14a1e28 RD |
3200 | |
3201 | class TIFFHandler(ImageHandler): | |
27fb7603 | 3202 | """A `wx.ImageHandler` for TIFF image files.""" |
0085ce49 RD |
3203 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3204 | __repr__ = _swig_repr | |
3205 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3206 | """ |
3207 | __init__(self) -> TIFFHandler | |
3208 | ||
3209 | A `wx.ImageHandler` for TIFF image files. | |
3210 | """ | |
0085ce49 | 3211 | _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs)) |
2131d850 | 3212 | _core_.TIFFHandler_swigregister(TIFFHandler) |
d14a1e28 | 3213 | |
c0de73ae RD |
3214 | QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS |
3215 | QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE | |
3216 | class Quantize(object): | |
3217 | """Performs quantization, or colour reduction, on a wxImage.""" | |
0085ce49 RD |
3218 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3219 | def __init__(self): raise AttributeError, "No constructor defined" | |
3220 | __repr__ = _swig_repr | |
c0de73ae RD |
3221 | def Quantize(*args, **kwargs): |
3222 | """ | |
3223 | Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool | |
3224 | ||
3225 | Reduce the colours in the source image and put the result into the | |
3226 | destination image, setting the palette in the destination if | |
3227 | needed. Both images may be the same, to overwrite the source image. | |
3228 | """ | |
3229 | return _core_.Quantize_Quantize(*args, **kwargs) | |
3230 | ||
3231 | Quantize = staticmethod(Quantize) | |
2131d850 | 3232 | _core_.Quantize_swigregister(Quantize) |
c0de73ae RD |
3233 | |
3234 | def Quantize_Quantize(*args, **kwargs): | |
0085ce49 | 3235 | """ |
c0de73ae RD |
3236 | Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool |
3237 | ||
3238 | Reduce the colours in the source image and put the result into the | |
3239 | destination image, setting the palette in the destination if | |
3240 | needed. Both images may be the same, to overwrite the source image. | |
3241 | """ | |
0085ce49 | 3242 | return _core_.Quantize_Quantize(*args, **kwargs) |
c0de73ae | 3243 | |
d14a1e28 RD |
3244 | #--------------------------------------------------------------------------- |
3245 | ||
3246 | class EvtHandler(Object): | |
093d3ff1 | 3247 | """Proxy of C++ EvtHandler class""" |
0085ce49 RD |
3248 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3249 | __repr__ = _swig_repr | |
3250 | def __init__(self, *args, **kwargs): | |
a95a7133 | 3251 | """__init__(self) -> EvtHandler""" |
0085ce49 | 3252 | _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs)) |
e811c8ce | 3253 | def GetNextHandler(*args, **kwargs): |
a95a7133 | 3254 | """GetNextHandler(self) -> EvtHandler""" |
54f9ee45 | 3255 | return _core_.EvtHandler_GetNextHandler(*args, **kwargs) |
e811c8ce RD |
3256 | |
3257 | def GetPreviousHandler(*args, **kwargs): | |
a95a7133 | 3258 | """GetPreviousHandler(self) -> EvtHandler""" |
54f9ee45 | 3259 | return _core_.EvtHandler_GetPreviousHandler(*args, **kwargs) |
e811c8ce RD |
3260 | |
3261 | def SetNextHandler(*args, **kwargs): | |
a95a7133 | 3262 | """SetNextHandler(self, EvtHandler handler)""" |
54f9ee45 | 3263 | return _core_.EvtHandler_SetNextHandler(*args, **kwargs) |
e811c8ce RD |
3264 | |
3265 | def SetPreviousHandler(*args, **kwargs): | |
a95a7133 | 3266 | """SetPreviousHandler(self, EvtHandler handler)""" |
54f9ee45 | 3267 | return _core_.EvtHandler_SetPreviousHandler(*args, **kwargs) |
e811c8ce RD |
3268 | |
3269 | def GetEvtHandlerEnabled(*args, **kwargs): | |
a95a7133 | 3270 | """GetEvtHandlerEnabled(self) -> bool""" |
54f9ee45 | 3271 | return _core_.EvtHandler_GetEvtHandlerEnabled(*args, **kwargs) |
e811c8ce RD |
3272 | |
3273 | def SetEvtHandlerEnabled(*args, **kwargs): | |
a95a7133 | 3274 | """SetEvtHandlerEnabled(self, bool enabled)""" |
54f9ee45 | 3275 | return _core_.EvtHandler_SetEvtHandlerEnabled(*args, **kwargs) |
e811c8ce RD |
3276 | |
3277 | def ProcessEvent(*args, **kwargs): | |
a95a7133 | 3278 | """ProcessEvent(self, Event event) -> bool""" |
54f9ee45 | 3279 | return _core_.EvtHandler_ProcessEvent(*args, **kwargs) |
e811c8ce RD |
3280 | |
3281 | def AddPendingEvent(*args, **kwargs): | |
a95a7133 | 3282 | """AddPendingEvent(self, Event event)""" |
54f9ee45 | 3283 | return _core_.EvtHandler_AddPendingEvent(*args, **kwargs) |
e811c8ce RD |
3284 | |
3285 | def ProcessPendingEvents(*args, **kwargs): | |
a95a7133 | 3286 | """ProcessPendingEvents(self)""" |
54f9ee45 | 3287 | return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs) |
e811c8ce RD |
3288 | |
3289 | def Connect(*args, **kwargs): | |
a95a7133 | 3290 | """Connect(self, int id, int lastId, int eventType, PyObject func)""" |
54f9ee45 | 3291 | return _core_.EvtHandler_Connect(*args, **kwargs) |
e811c8ce RD |
3292 | |
3293 | def Disconnect(*args, **kwargs): | |
2131d850 | 3294 | """Disconnect(self, int id, int lastId=-1, EventType eventType=wxEVT_NULL) -> bool""" |
54f9ee45 | 3295 | return _core_.EvtHandler_Disconnect(*args, **kwargs) |
e811c8ce RD |
3296 | |
3297 | def _setOORInfo(*args, **kwargs): | |
689b42ee | 3298 | """_setOORInfo(self, PyObject _self, bool incref=True)""" |
7e08d4ef RD |
3299 | val = _core_.EvtHandler__setOORInfo(*args, **kwargs) |
3300 | args[0].thisown = 0 | |
3301 | return val | |
e811c8ce | 3302 | |
d14a1e28 RD |
3303 | def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): |
3304 | """ | |
3305 | Bind an event to an event handler. | |
3306 | ||
db3e571a RD |
3307 | :param event: One of the EVT_* objects that specifies the |
3308 | type of event to bind, | |
d14a1e28 | 3309 | |
db3e571a RD |
3310 | :param handler: A callable object to be invoked when the |
3311 | event is delivered to self. Pass None to | |
3312 | disconnect an event handler. | |
d14a1e28 | 3313 | |
db3e571a RD |
3314 | :param source: Sometimes the event originates from a |
3315 | different window than self, but you still | |
3316 | want to catch it in self. (For example, a | |
3317 | button event delivered to a frame.) By | |
3318 | passing the source of the event, the event | |
3319 | handling system is able to differentiate | |
3320 | between the same event type from different | |
3321 | controls. | |
d14a1e28 | 3322 | |
db3e571a RD |
3323 | :param id: Used to spcify the event source by ID instead |
3324 | of instance. | |
3325 | ||
3326 | :param id2: Used when it is desirable to bind a handler | |
3327 | to a range of IDs, such as with EVT_MENU_RANGE. | |
d14a1e28 RD |
3328 | """ |
3329 | if source is not None: | |
3330 | id = source.GetId() | |
3331 | event.Bind(self, id, id2, handler) | |
3332 | ||
66c033b4 RD |
3333 | def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): |
3334 | """ | |
3335 | Disconencts the event handler binding for event from self. | |
3336 | Returns True if successful. | |
3337 | """ | |
3338 | if source is not None: | |
3339 | id = source.GetId() | |
3340 | return event.Unbind(self, id, id2) | |
d14a1e28 | 3341 | |
2131d850 | 3342 | _core_.EvtHandler_swigregister(EvtHandler) |
d14a1e28 RD |
3343 | |
3344 | #--------------------------------------------------------------------------- | |
3345 | ||
3346 | class PyEventBinder(object): | |
3347 | """ | |
3348 | Instances of this class are used to bind specific events to event | |
3349 | handlers. | |
3350 | """ | |
3351 | def __init__(self, evtType, expectedIDs=0): | |
3352 | if expectedIDs not in [0, 1, 2]: | |
3353 | raise ValueError, "Invalid number of expectedIDs" | |
3354 | self.expectedIDs = expectedIDs | |
3355 | ||
3356 | if type(evtType) == list or type(evtType) == tuple: | |
3357 | self.evtType = evtType | |
3358 | else: | |
3359 | self.evtType = [evtType] | |
3360 | ||
3361 | ||
3362 | def Bind(self, target, id1, id2, function): | |
3363 | """Bind this set of event types to target.""" | |
3364 | for et in self.evtType: | |
3365 | target.Connect(id1, id2, et, function) | |
3366 | ||
66c033b4 RD |
3367 | |
3368 | def Unbind(self, target, id1, id2): | |
3369 | """Remove an event binding.""" | |
3370 | success = 0 | |
3371 | for et in self.evtType: | |
3372 | success += target.Disconnect(id1, id2, et) | |
3373 | return success != 0 | |
3374 | ||
d14a1e28 RD |
3375 | |
3376 | def __call__(self, *args): | |
3377 | """ | |
3378 | For backwards compatibility with the old EVT_* functions. | |
3379 | Should be called with either (window, func), (window, ID, | |
3380 | func) or (window, ID1, ID2, func) parameters depending on the | |
3381 | type of the event. | |
3382 | """ | |
3383 | assert len(args) == 2 + self.expectedIDs | |
3384 | id1 = wx.ID_ANY | |
3385 | id2 = wx.ID_ANY | |
3386 | target = args[0] | |
3387 | if self.expectedIDs == 0: | |
3388 | func = args[1] | |
3389 | elif self.expectedIDs == 1: | |
3390 | id1 = args[1] | |
3391 | func = args[2] | |
3392 | elif self.expectedIDs == 2: | |
3393 | id1 = args[1] | |
3394 | id2 = args[2] | |
3395 | func = args[3] | |
3396 | else: | |
3397 | raise ValueError, "Unexpected number of IDs" | |
3398 | ||
3399 | self.Bind(target, id1, id2, func) | |
3400 | ||
3401 | ||
3402 | # These two are square pegs that don't fit the PyEventBinder hole... | |
3403 | def EVT_COMMAND(win, id, cmd, func): | |
3404 | win.Connect(id, -1, cmd, func) | |
3405 | def EVT_COMMAND_RANGE(win, id1, id2, cmd, func): | |
3406 | win.Connect(id1, id2, cmd, func) | |
3407 | ||
3408 | ||
3409 | #--------------------------------------------------------------------------- | |
3410 | ||
3411 | #--------------------------------------------------------------------------- | |
3412 | ||
54f9ee45 RD |
3413 | EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE |
3414 | EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX | |
d14a1e28 | 3415 | |
0085ce49 | 3416 | def NewEventType(*args): |
2131d850 | 3417 | """NewEventType() -> EventType""" |
0085ce49 | 3418 | return _core_.NewEventType(*args) |
54f9ee45 RD |
3419 | wxEVT_NULL = _core_.wxEVT_NULL |
3420 | wxEVT_FIRST = _core_.wxEVT_FIRST | |
3421 | wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST | |
3422 | wxEVT_COMMAND_BUTTON_CLICKED = _core_.wxEVT_COMMAND_BUTTON_CLICKED | |
3423 | wxEVT_COMMAND_CHECKBOX_CLICKED = _core_.wxEVT_COMMAND_CHECKBOX_CLICKED | |
3424 | wxEVT_COMMAND_CHOICE_SELECTED = _core_.wxEVT_COMMAND_CHOICE_SELECTED | |
3425 | wxEVT_COMMAND_LISTBOX_SELECTED = _core_.wxEVT_COMMAND_LISTBOX_SELECTED | |
3426 | wxEVT_COMMAND_LISTBOX_DOUBLECLICKED = _core_.wxEVT_COMMAND_LISTBOX_DOUBLECLICKED | |
3427 | wxEVT_COMMAND_CHECKLISTBOX_TOGGLED = _core_.wxEVT_COMMAND_CHECKLISTBOX_TOGGLED | |
3428 | wxEVT_COMMAND_MENU_SELECTED = _core_.wxEVT_COMMAND_MENU_SELECTED | |
3429 | wxEVT_COMMAND_TOOL_CLICKED = _core_.wxEVT_COMMAND_TOOL_CLICKED | |
3430 | wxEVT_COMMAND_SLIDER_UPDATED = _core_.wxEVT_COMMAND_SLIDER_UPDATED | |
3431 | wxEVT_COMMAND_RADIOBOX_SELECTED = _core_.wxEVT_COMMAND_RADIOBOX_SELECTED | |
3432 | wxEVT_COMMAND_RADIOBUTTON_SELECTED = _core_.wxEVT_COMMAND_RADIOBUTTON_SELECTED | |
3433 | wxEVT_COMMAND_SCROLLBAR_UPDATED = _core_.wxEVT_COMMAND_SCROLLBAR_UPDATED | |
3434 | wxEVT_COMMAND_VLBOX_SELECTED = _core_.wxEVT_COMMAND_VLBOX_SELECTED | |
3435 | wxEVT_COMMAND_COMBOBOX_SELECTED = _core_.wxEVT_COMMAND_COMBOBOX_SELECTED | |
3436 | wxEVT_COMMAND_TOOL_RCLICKED = _core_.wxEVT_COMMAND_TOOL_RCLICKED | |
3437 | wxEVT_COMMAND_TOOL_ENTER = _core_.wxEVT_COMMAND_TOOL_ENTER | |
3438 | wxEVT_LEFT_DOWN = _core_.wxEVT_LEFT_DOWN | |
3439 | wxEVT_LEFT_UP = _core_.wxEVT_LEFT_UP | |
3440 | wxEVT_MIDDLE_DOWN = _core_.wxEVT_MIDDLE_DOWN | |
3441 | wxEVT_MIDDLE_UP = _core_.wxEVT_MIDDLE_UP | |
3442 | wxEVT_RIGHT_DOWN = _core_.wxEVT_RIGHT_DOWN | |
3443 | wxEVT_RIGHT_UP = _core_.wxEVT_RIGHT_UP | |
3444 | wxEVT_MOTION = _core_.wxEVT_MOTION | |
3445 | wxEVT_ENTER_WINDOW = _core_.wxEVT_ENTER_WINDOW | |
3446 | wxEVT_LEAVE_WINDOW = _core_.wxEVT_LEAVE_WINDOW | |
3447 | wxEVT_LEFT_DCLICK = _core_.wxEVT_LEFT_DCLICK | |
3448 | wxEVT_MIDDLE_DCLICK = _core_.wxEVT_MIDDLE_DCLICK | |
3449 | wxEVT_RIGHT_DCLICK = _core_.wxEVT_RIGHT_DCLICK | |
3450 | wxEVT_SET_FOCUS = _core_.wxEVT_SET_FOCUS | |
3451 | wxEVT_KILL_FOCUS = _core_.wxEVT_KILL_FOCUS | |
3452 | wxEVT_CHILD_FOCUS = _core_.wxEVT_CHILD_FOCUS | |
3453 | wxEVT_MOUSEWHEEL = _core_.wxEVT_MOUSEWHEEL | |
3454 | wxEVT_NC_LEFT_DOWN = _core_.wxEVT_NC_LEFT_DOWN | |
3455 | wxEVT_NC_LEFT_UP = _core_.wxEVT_NC_LEFT_UP | |
3456 | wxEVT_NC_MIDDLE_DOWN = _core_.wxEVT_NC_MIDDLE_DOWN | |
3457 | wxEVT_NC_MIDDLE_UP = _core_.wxEVT_NC_MIDDLE_UP | |
3458 | wxEVT_NC_RIGHT_DOWN = _core_.wxEVT_NC_RIGHT_DOWN | |
3459 | wxEVT_NC_RIGHT_UP = _core_.wxEVT_NC_RIGHT_UP | |
3460 | wxEVT_NC_MOTION = _core_.wxEVT_NC_MOTION | |
3461 | wxEVT_NC_ENTER_WINDOW = _core_.wxEVT_NC_ENTER_WINDOW | |
3462 | wxEVT_NC_LEAVE_WINDOW = _core_.wxEVT_NC_LEAVE_WINDOW | |
3463 | wxEVT_NC_LEFT_DCLICK = _core_.wxEVT_NC_LEFT_DCLICK | |
3464 | wxEVT_NC_MIDDLE_DCLICK = _core_.wxEVT_NC_MIDDLE_DCLICK | |
3465 | wxEVT_NC_RIGHT_DCLICK = _core_.wxEVT_NC_RIGHT_DCLICK | |
3466 | wxEVT_CHAR = _core_.wxEVT_CHAR | |
3467 | wxEVT_CHAR_HOOK = _core_.wxEVT_CHAR_HOOK | |
3468 | wxEVT_NAVIGATION_KEY = _core_.wxEVT_NAVIGATION_KEY | |
3469 | wxEVT_KEY_DOWN = _core_.wxEVT_KEY_DOWN | |
3470 | wxEVT_KEY_UP = _core_.wxEVT_KEY_UP | |
3471 | wxEVT_HOTKEY = _core_.wxEVT_HOTKEY | |
3472 | wxEVT_SET_CURSOR = _core_.wxEVT_SET_CURSOR | |
3473 | wxEVT_SCROLL_TOP = _core_.wxEVT_SCROLL_TOP | |
3474 | wxEVT_SCROLL_BOTTOM = _core_.wxEVT_SCROLL_BOTTOM | |
3475 | wxEVT_SCROLL_LINEUP = _core_.wxEVT_SCROLL_LINEUP | |
3476 | wxEVT_SCROLL_LINEDOWN = _core_.wxEVT_SCROLL_LINEDOWN | |
3477 | wxEVT_SCROLL_PAGEUP = _core_.wxEVT_SCROLL_PAGEUP | |
3478 | wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN | |
3479 | wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK | |
3480 | wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE | |
4f433fef RD |
3481 | wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED |
3482 | wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED | |
54f9ee45 RD |
3483 | wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP |
3484 | wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM | |
3485 | wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP | |
3486 | wxEVT_SCROLLWIN_LINEDOWN = _core_.wxEVT_SCROLLWIN_LINEDOWN | |
3487 | wxEVT_SCROLLWIN_PAGEUP = _core_.wxEVT_SCROLLWIN_PAGEUP | |
3488 | wxEVT_SCROLLWIN_PAGEDOWN = _core_.wxEVT_SCROLLWIN_PAGEDOWN | |
3489 | wxEVT_SCROLLWIN_THUMBTRACK = _core_.wxEVT_SCROLLWIN_THUMBTRACK | |
3490 | wxEVT_SCROLLWIN_THUMBRELEASE = _core_.wxEVT_SCROLLWIN_THUMBRELEASE | |
3491 | wxEVT_SIZE = _core_.wxEVT_SIZE | |
3492 | wxEVT_MOVE = _core_.wxEVT_MOVE | |
3493 | wxEVT_CLOSE_WINDOW = _core_.wxEVT_CLOSE_WINDOW | |
3494 | wxEVT_END_SESSION = _core_.wxEVT_END_SESSION | |
3495 | wxEVT_QUERY_END_SESSION = _core_.wxEVT_QUERY_END_SESSION | |
3496 | wxEVT_ACTIVATE_APP = _core_.wxEVT_ACTIVATE_APP | |
54f9ee45 RD |
3497 | wxEVT_ACTIVATE = _core_.wxEVT_ACTIVATE |
3498 | wxEVT_CREATE = _core_.wxEVT_CREATE | |
3499 | wxEVT_DESTROY = _core_.wxEVT_DESTROY | |
3500 | wxEVT_SHOW = _core_.wxEVT_SHOW | |
3501 | wxEVT_ICONIZE = _core_.wxEVT_ICONIZE | |
3502 | wxEVT_MAXIMIZE = _core_.wxEVT_MAXIMIZE | |
3503 | wxEVT_MOUSE_CAPTURE_CHANGED = _core_.wxEVT_MOUSE_CAPTURE_CHANGED | |
3504 | wxEVT_PAINT = _core_.wxEVT_PAINT | |
3505 | wxEVT_ERASE_BACKGROUND = _core_.wxEVT_ERASE_BACKGROUND | |
3506 | wxEVT_NC_PAINT = _core_.wxEVT_NC_PAINT | |
3507 | wxEVT_PAINT_ICON = _core_.wxEVT_PAINT_ICON | |
3508 | wxEVT_MENU_OPEN = _core_.wxEVT_MENU_OPEN | |
3509 | wxEVT_MENU_CLOSE = _core_.wxEVT_MENU_CLOSE | |
3510 | wxEVT_MENU_HIGHLIGHT = _core_.wxEVT_MENU_HIGHLIGHT | |
3511 | wxEVT_CONTEXT_MENU = _core_.wxEVT_CONTEXT_MENU | |
3512 | wxEVT_SYS_COLOUR_CHANGED = _core_.wxEVT_SYS_COLOUR_CHANGED | |
3513 | wxEVT_DISPLAY_CHANGED = _core_.wxEVT_DISPLAY_CHANGED | |
3514 | wxEVT_SETTING_CHANGED = _core_.wxEVT_SETTING_CHANGED | |
3515 | wxEVT_QUERY_NEW_PALETTE = _core_.wxEVT_QUERY_NEW_PALETTE | |
3516 | wxEVT_PALETTE_CHANGED = _core_.wxEVT_PALETTE_CHANGED | |
3517 | wxEVT_DROP_FILES = _core_.wxEVT_DROP_FILES | |
3518 | wxEVT_DRAW_ITEM = _core_.wxEVT_DRAW_ITEM | |
3519 | wxEVT_MEASURE_ITEM = _core_.wxEVT_MEASURE_ITEM | |
3520 | wxEVT_COMPARE_ITEM = _core_.wxEVT_COMPARE_ITEM | |
3521 | wxEVT_INIT_DIALOG = _core_.wxEVT_INIT_DIALOG | |
3522 | wxEVT_IDLE = _core_.wxEVT_IDLE | |
3523 | wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI | |
3524 | wxEVT_SIZING = _core_.wxEVT_SIZING | |
3525 | wxEVT_MOVING = _core_.wxEVT_MOVING | |
88c6b281 | 3526 | wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE |
2131d850 RD |
3527 | wxEVT_COMMAND_TEXT_COPY = _core_.wxEVT_COMMAND_TEXT_COPY |
3528 | wxEVT_COMMAND_TEXT_CUT = _core_.wxEVT_COMMAND_TEXT_CUT | |
3529 | wxEVT_COMMAND_TEXT_PASTE = _core_.wxEVT_COMMAND_TEXT_PASTE | |
54f9ee45 RD |
3530 | wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK |
3531 | wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK | |
3532 | wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK | |
3533 | wxEVT_COMMAND_RIGHT_DCLICK = _core_.wxEVT_COMMAND_RIGHT_DCLICK | |
3534 | wxEVT_COMMAND_SET_FOCUS = _core_.wxEVT_COMMAND_SET_FOCUS | |
3535 | wxEVT_COMMAND_KILL_FOCUS = _core_.wxEVT_COMMAND_KILL_FOCUS | |
3536 | wxEVT_COMMAND_ENTER = _core_.wxEVT_COMMAND_ENTER | |
d14a1e28 RD |
3537 | # |
3538 | # Create some event binders | |
3539 | EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE ) | |
3540 | EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING ) | |
3541 | EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE ) | |
3542 | EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING ) | |
3543 | EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW ) | |
3544 | EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION ) | |
3545 | EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION ) | |
3546 | EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT ) | |
3547 | EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT ) | |
3548 | EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND ) | |
3549 | EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR ) | |
3550 | EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN ) | |
3551 | EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP ) | |
704eda0c | 3552 | EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY, 1) |
d14a1e28 RD |
3553 | EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK ) |
3554 | EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN ) | |
3555 | EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE ) | |
3556 | EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT, 1) | |
3557 | EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT ) | |
3558 | EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS ) | |
3559 | EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS ) | |
3560 | EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS ) | |
3561 | EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE ) | |
3562 | EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP ) | |
704eda0c | 3563 | EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE ) |
d14a1e28 RD |
3564 | EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION ) |
3565 | EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION ) | |
3566 | EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES ) | |
3567 | EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG ) | |
3568 | EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED ) | |
3569 | EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED ) | |
3570 | EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW ) | |
3571 | EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE ) | |
3572 | EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE ) | |
3573 | EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY ) | |
3574 | EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED ) | |
3575 | EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE ) | |
3576 | EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE ) | |
3577 | EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY ) | |
3578 | EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR ) | |
3579 | EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED ) | |
3580 | ||
3581 | EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN ) | |
3582 | EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP ) | |
3583 | EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN ) | |
3584 | EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP ) | |
3585 | EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN ) | |
3586 | EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP ) | |
3587 | EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION ) | |
3588 | EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK ) | |
3589 | EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK ) | |
3590 | EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK ) | |
3591 | EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW ) | |
3592 | EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW ) | |
3593 | EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL ) | |
3594 | ||
3595 | EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN, | |
3596 | wxEVT_LEFT_UP, | |
3597 | wxEVT_MIDDLE_DOWN, | |
3598 | wxEVT_MIDDLE_UP, | |
3599 | wxEVT_RIGHT_DOWN, | |
3600 | wxEVT_RIGHT_UP, | |
3601 | wxEVT_MOTION, | |
3602 | wxEVT_LEFT_DCLICK, | |
3603 | wxEVT_MIDDLE_DCLICK, | |
3604 | wxEVT_RIGHT_DCLICK, | |
3605 | wxEVT_ENTER_WINDOW, | |
3606 | wxEVT_LEAVE_WINDOW, | |
3607 | wxEVT_MOUSEWHEEL | |
3608 | ]) | |
3609 | ||
3610 | ||
3611 | # Scrolling from wxWindow (sent to wxScrolledWindow) | |
704eda0c | 3612 | EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP, |
d14a1e28 RD |
3613 | wxEVT_SCROLLWIN_BOTTOM, |
3614 | wxEVT_SCROLLWIN_LINEUP, | |
3615 | wxEVT_SCROLLWIN_LINEDOWN, | |
704eda0c | 3616 | wxEVT_SCROLLWIN_PAGEUP, |
d14a1e28 RD |
3617 | wxEVT_SCROLLWIN_PAGEDOWN, |
3618 | wxEVT_SCROLLWIN_THUMBTRACK, | |
3619 | wxEVT_SCROLLWIN_THUMBRELEASE, | |
3620 | ]) | |
3621 | ||
3622 | EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP ) | |
3623 | EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM ) | |
3624 | EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP ) | |
3625 | EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN ) | |
3626 | EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP ) | |
3627 | EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN ) | |
3628 | EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK ) | |
3629 | EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE ) | |
3630 | ||
27fb7603 | 3631 | # Scrolling from wx.Slider and wx.ScrollBar |
704eda0c RD |
3632 | EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, |
3633 | wxEVT_SCROLL_BOTTOM, | |
3634 | wxEVT_SCROLL_LINEUP, | |
3635 | wxEVT_SCROLL_LINEDOWN, | |
3636 | wxEVT_SCROLL_PAGEUP, | |
3637 | wxEVT_SCROLL_PAGEDOWN, | |
3638 | wxEVT_SCROLL_THUMBTRACK, | |
3639 | wxEVT_SCROLL_THUMBRELEASE, | |
4f433fef | 3640 | wxEVT_SCROLL_CHANGED, |
d14a1e28 RD |
3641 | ]) |
3642 | ||
3643 | EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP ) | |
3644 | EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM ) | |
3645 | EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP ) | |
3646 | EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN ) | |
3647 | EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP ) | |
3648 | EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN ) | |
3649 | EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK ) | |
3650 | EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE ) | |
4f433fef RD |
3651 | EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED ) |
3652 | EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED | |
704eda0c | 3653 | |
27fb7603 | 3654 | # Scrolling from wx.Slider and wx.ScrollBar, with an id |
704eda0c RD |
3655 | EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP, |
3656 | wxEVT_SCROLL_BOTTOM, | |
3657 | wxEVT_SCROLL_LINEUP, | |
3658 | wxEVT_SCROLL_LINEDOWN, | |
3659 | wxEVT_SCROLL_PAGEUP, | |
3660 | wxEVT_SCROLL_PAGEDOWN, | |
3661 | wxEVT_SCROLL_THUMBTRACK, | |
d14a1e28 | 3662 | wxEVT_SCROLL_THUMBRELEASE, |
4f433fef | 3663 | wxEVT_SCROLL_CHANGED, |
d14a1e28 RD |
3664 | ], 1) |
3665 | ||
3666 | EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1) | |
3667 | EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM, 1) | |
3668 | EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1) | |
3669 | EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1) | |
3670 | EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP, 1) | |
3671 | EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1) | |
3672 | EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1) | |
3673 | EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1) | |
4f433fef RD |
3674 | EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1) |
3675 | EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED | |
d14a1e28 | 3676 | |
d14a1e28 RD |
3677 | EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1) |
3678 | EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1) | |
3679 | EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1) | |
3680 | EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED, 1) | |
3681 | EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, 1) | |
3682 | EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 1) | |
3683 | EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED, 2) | |
3684 | EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED, 1) | |
3685 | EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED, 1) | |
3686 | EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED, 1) | |
3687 | ||
3688 | EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED, 1) | |
3689 | EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED, 1) | |
3690 | EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED, 1) | |
3691 | EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 1) | |
3692 | EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED, 2) | |
3693 | EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 1) | |
3694 | EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED, 2) | |
3695 | EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER, 1) | |
3696 | EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, 1) | |
3697 | ||
3698 | ||
3699 | EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK, 1) | |
3700 | EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK, 1) | |
3701 | EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK, 1) | |
3702 | EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK, 1) | |
3703 | EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS, 1) | |
3704 | EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS, 1) | |
3705 | EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER, 1) | |
3706 | ||
3707 | EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE ) | |
3708 | ||
3709 | EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1) | |
3710 | EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2) | |
3711 | ||
3712 | EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) | |
3713 | ||
2131d850 RD |
3714 | EVT_TEXT_CUT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_CUT ) |
3715 | EVT_TEXT_COPY = wx.PyEventBinder( wxEVT_COMMAND_TEXT_COPY ) | |
3716 | EVT_TEXT_PASTE = wx.PyEventBinder( wxEVT_COMMAND_TEXT_PASTE ) | |
d14a1e28 RD |
3717 | |
3718 | ||
3719 | #--------------------------------------------------------------------------- | |
3720 | ||
3721 | class Event(Object): | |
27fb7603 RD |
3722 | """ |
3723 | An event is a structure holding information about an event passed to a | |
3724 | callback or member function. wx.Event is an abstract base class for | |
3725 | other event classes | |
3726 | """ | |
0085ce49 RD |
3727 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3728 | def __init__(self): raise AttributeError, "No constructor defined" | |
3729 | __repr__ = _swig_repr | |
3730 | __swig_destroy__ = _core_.delete_Event | |
3731 | __del__ = lambda self : None; | |
e811c8ce | 3732 | def SetEventType(*args, **kwargs): |
27fb7603 | 3733 | """ |
2131d850 | 3734 | SetEventType(self, EventType typ) |
27fb7603 RD |
3735 | |
3736 | Sets the specific type of the event. | |
3737 | """ | |
54f9ee45 | 3738 | return _core_.Event_SetEventType(*args, **kwargs) |
e811c8ce RD |
3739 | |
3740 | def GetEventType(*args, **kwargs): | |
27fb7603 | 3741 | """ |
2131d850 | 3742 | GetEventType(self) -> EventType |
27fb7603 RD |
3743 | |
3744 | Returns the identifier of the given event type, such as | |
3745 | ``wxEVT_COMMAND_BUTTON_CLICKED``. | |
3746 | """ | |
54f9ee45 | 3747 | return _core_.Event_GetEventType(*args, **kwargs) |
e811c8ce RD |
3748 | |
3749 | def GetEventObject(*args, **kwargs): | |
27fb7603 RD |
3750 | """ |
3751 | GetEventObject(self) -> Object | |
3752 | ||
3753 | Returns the object (usually a window) associated with the event, if | |
3754 | any. | |
3755 | """ | |
54f9ee45 | 3756 | return _core_.Event_GetEventObject(*args, **kwargs) |
e811c8ce RD |
3757 | |
3758 | def SetEventObject(*args, **kwargs): | |
27fb7603 RD |
3759 | """ |
3760 | SetEventObject(self, Object obj) | |
3761 | ||
3762 | Sets the originating object, or in other words, obj is normally the | |
3763 | object that is sending the event. | |
3764 | """ | |
54f9ee45 | 3765 | return _core_.Event_SetEventObject(*args, **kwargs) |
e811c8ce RD |
3766 | |
3767 | def GetTimestamp(*args, **kwargs): | |
a95a7133 | 3768 | """GetTimestamp(self) -> long""" |
54f9ee45 | 3769 | return _core_.Event_GetTimestamp(*args, **kwargs) |
e811c8ce RD |
3770 | |
3771 | def SetTimestamp(*args, **kwargs): | |
a95a7133 | 3772 | """SetTimestamp(self, long ts=0)""" |
54f9ee45 | 3773 | return _core_.Event_SetTimestamp(*args, **kwargs) |
e811c8ce RD |
3774 | |
3775 | def GetId(*args, **kwargs): | |
27fb7603 RD |
3776 | """ |
3777 | GetId(self) -> int | |
3778 | ||
3779 | Returns the identifier associated with this event, such as a button | |
3780 | command id. | |
3781 | """ | |
54f9ee45 | 3782 | return _core_.Event_GetId(*args, **kwargs) |
e811c8ce RD |
3783 | |
3784 | def SetId(*args, **kwargs): | |
27fb7603 RD |
3785 | """ |
3786 | SetId(self, int Id) | |
3787 | ||
3788 | Set's the ID for the event. This is usually the ID of the window that | |
3789 | is sending the event, but it can also be a command id from a menu | |
3790 | item, etc. | |
3791 | """ | |
54f9ee45 | 3792 | return _core_.Event_SetId(*args, **kwargs) |
e811c8ce RD |
3793 | |
3794 | def IsCommandEvent(*args, **kwargs): | |
27fb7603 RD |
3795 | """ |
3796 | IsCommandEvent(self) -> bool | |
3797 | ||
3798 | Returns true if the event is or is derived from `wx.CommandEvent` else | |
3799 | it returns false. Note: Exists only for optimization purposes. | |
3800 | """ | |
54f9ee45 | 3801 | return _core_.Event_IsCommandEvent(*args, **kwargs) |
e811c8ce RD |
3802 | |
3803 | def Skip(*args, **kwargs): | |
51b83b37 RD |
3804 | """ |
3805 | Skip(self, bool skip=True) | |
3806 | ||
3807 | Called by an event handler, it controls whether additional event | |
3808 | handlers bound to this event will be called after the current event | |
3809 | handler returns. Skip(false) (the default setting) will prevent | |
3810 | additional event handlers from being called and control will be | |
3811 | returned to the sender of the event immediately after the current | |
3812 | handler has finished. Skip(True) will cause the event processing | |
3813 | system to continue searching for a handler function for this event. | |
3814 | ||
3815 | """ | |
54f9ee45 | 3816 | return _core_.Event_Skip(*args, **kwargs) |
e811c8ce RD |
3817 | |
3818 | def GetSkipped(*args, **kwargs): | |
27fb7603 RD |
3819 | """ |
3820 | GetSkipped(self) -> bool | |
3821 | ||
3822 | Returns true if the event handler should be skipped, false otherwise. | |
3823 | :see: `Skip` | |
3824 | """ | |
54f9ee45 | 3825 | return _core_.Event_GetSkipped(*args, **kwargs) |
e811c8ce RD |
3826 | |
3827 | def ShouldPropagate(*args, **kwargs): | |
27fb7603 RD |
3828 | """ |
3829 | ShouldPropagate(self) -> bool | |
3830 | ||
3831 | Test if this event should be propagated to the parent window or not, | |
3832 | i.e. if the propagation level is currently greater than 0. | |
3833 | """ | |
54f9ee45 | 3834 | return _core_.Event_ShouldPropagate(*args, **kwargs) |
e811c8ce RD |
3835 | |
3836 | def StopPropagation(*args, **kwargs): | |
27fb7603 RD |
3837 | """ |
3838 | StopPropagation(self) -> int | |
3839 | ||
3840 | Stop the event from propagating to its parent window. Returns the old | |
3841 | propagation level value which may be later passed to | |
3842 | `ResumePropagation` to allow propagating the event again. | |
3843 | """ | |
54f9ee45 | 3844 | return _core_.Event_StopPropagation(*args, **kwargs) |
e811c8ce RD |
3845 | |
3846 | def ResumePropagation(*args, **kwargs): | |
27fb7603 RD |
3847 | """ |
3848 | ResumePropagation(self, int propagationLevel) | |
3849 | ||
3850 | Resume the event propagation by restoring the propagation level. (For | |
3851 | example, you can use the value returned by an earlier call to | |
3852 | `StopPropagation`.) | |
3853 | ||
3854 | """ | |
54f9ee45 | 3855 | return _core_.Event_ResumePropagation(*args, **kwargs) |
e811c8ce RD |
3856 | |
3857 | def Clone(*args, **kwargs): | |
a95a7133 | 3858 | """Clone(self) -> Event""" |
54f9ee45 | 3859 | return _core_.Event_Clone(*args, **kwargs) |
e811c8ce | 3860 | |
2131d850 | 3861 | _core_.Event_swigregister(Event) |
d14a1e28 RD |
3862 | |
3863 | #--------------------------------------------------------------------------- | |
3864 | ||
3865 | class PropagationDisabler(object): | |
27fb7603 RD |
3866 | """ |
3867 | Helper class to temporarily change an event not to propagate. Simply | |
3868 | create an instance of this class and then whe it is destroyed the | |
3869 | propogation of the event will be restored. | |
3870 | """ | |
0085ce49 RD |
3871 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3872 | __repr__ = _swig_repr | |
3873 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3874 | """ |
3875 | __init__(self, Event event) -> PropagationDisabler | |
3876 | ||
3877 | Helper class to temporarily change an event not to propagate. Simply | |
3878 | create an instance of this class and then whe it is destroyed the | |
3879 | propogation of the event will be restored. | |
3880 | """ | |
0085ce49 RD |
3881 | _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs)) |
3882 | __swig_destroy__ = _core_.delete_PropagationDisabler | |
3883 | __del__ = lambda self : None; | |
2131d850 | 3884 | _core_.PropagationDisabler_swigregister(PropagationDisabler) |
d14a1e28 RD |
3885 | |
3886 | class PropagateOnce(object): | |
27fb7603 RD |
3887 | """ |
3888 | A helper class that will temporarily lower propagation level of an | |
3889 | event. Simply create an instance of this class and then whe it is | |
3890 | destroyed the propogation of the event will be restored. | |
3891 | """ | |
0085ce49 RD |
3892 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3893 | __repr__ = _swig_repr | |
3894 | def __init__(self, *args, **kwargs): | |
27fb7603 RD |
3895 | """ |
3896 | __init__(self, Event event) -> PropagateOnce | |
3897 | ||
3898 | A helper class that will temporarily lower propagation level of an | |
3899 | event. Simply create an instance of this class and then whe it is | |
3900 | destroyed the propogation of the event will be restored. | |
3901 | """ | |
0085ce49 RD |
3902 | _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs)) |
3903 | __swig_destroy__ = _core_.delete_PropagateOnce | |
3904 | __del__ = lambda self : None; | |
2131d850 | 3905 | _core_.PropagateOnce_swigregister(PropagateOnce) |
d14a1e28 RD |
3906 | |
3907 | #--------------------------------------------------------------------------- | |
3908 | ||
3909 | class CommandEvent(Event): | |
27fb7603 RD |
3910 | """ |
3911 | This event class contains information about command events, which | |
3912 | originate from a variety of simple controls, as well as menus and | |
3913 | toolbars. | |
3914 | """ | |
0085ce49 RD |
3915 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
3916 | __repr__ = _swig_repr | |
3917 | def __init__(self, *args, **kwargs): | |
27fb7603 | 3918 | """ |
2131d850 | 3919 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent |
27fb7603 RD |
3920 | |
3921 | This event class contains information about command events, which | |
3922 | originate from a variety of simple controls, as well as menus and | |
3923 | toolbars. | |
3924 | """ | |
0085ce49 | 3925 | _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs)) |
e811c8ce | 3926 | def GetSelection(*args, **kwargs): |
27fb7603 RD |
3927 | """ |
3928 | GetSelection(self) -> int | |
3929 | ||
3930 | Returns item index for a listbox or choice selection event (not valid | |
3931 | for a deselection). | |
3932 | """ | |
54f9ee45 | 3933 | return _core_.CommandEvent_GetSelection(*args, **kwargs) |
e811c8ce RD |
3934 | |
3935 | def SetString(*args, **kwargs): | |
a95a7133 | 3936 | """SetString(self, String s)""" |
54f9ee45 | 3937 | return _core_.CommandEvent_SetString(*args, **kwargs) |
e811c8ce RD |
3938 | |
3939 | def GetString(*args, **kwargs): | |
27fb7603 RD |
3940 | """ |
3941 | GetString(self) -> String | |
3942 | ||
3943 | Returns item string for a listbox or choice selection event (not valid | |
3944 | for a deselection). | |
3945 | """ | |
54f9ee45 | 3946 | return _core_.CommandEvent_GetString(*args, **kwargs) |
e811c8ce RD |
3947 | |
3948 | def IsChecked(*args, **kwargs): | |
27fb7603 RD |
3949 | """ |
3950 | IsChecked(self) -> bool | |
3951 | ||
3952 | This method can be used with checkbox and menu events: for the | |
3953 | checkboxes, the method returns true for a selection event and false | |
3954 | for a deselection one. For the menu events, this method indicates if | |
3955 | the menu item just has become checked or unchecked (and thus only | |
3956 | makes sense for checkable menu items). | |
3957 | """ | |
54f9ee45 | 3958 | return _core_.CommandEvent_IsChecked(*args, **kwargs) |
e811c8ce | 3959 | |
242b7b46 | 3960 | Checked = IsChecked |
e811c8ce | 3961 | def IsSelection(*args, **kwargs): |
27fb7603 RD |
3962 | """ |
3963 | IsSelection(self) -> bool | |
3964 | ||
3965 | For a listbox or similar event, returns true if it is a selection, | |
3966 | false if it is a deselection. | |
3967 | """ | |
54f9ee45 | 3968 | return _core_.CommandEvent_IsSelection(*args, **kwargs) |
e811c8ce RD |
3969 | |
3970 | def SetExtraLong(*args, **kwargs): | |
a95a7133 | 3971 | """SetExtraLong(self, long extraLong)""" |
54f9ee45 | 3972 | return _core_.CommandEvent_SetExtraLong(*args, **kwargs) |
e811c8ce RD |
3973 | |
3974 | def GetExtraLong(*args, **kwargs): | |
27fb7603 RD |
3975 | """ |
3976 | GetExtraLong(self) -> long | |
3977 | ||
5ba5649b RD |
3978 | Returns extra information dependant on the event objects type. If the |
3979 | event comes from a listbox selection, it is a boolean determining | |
3980 | whether the event was a selection (true) or a deselection (false). A | |
3981 | listbox deselection only occurs for multiple-selection boxes, and in | |
3982 | this case the index and string values are indeterminate and the | |
3983 | listbox must be examined by the application. | |
27fb7603 | 3984 | """ |
54f9ee45 | 3985 | return _core_.CommandEvent_GetExtraLong(*args, **kwargs) |
e811c8ce RD |
3986 | |
3987 | def SetInt(*args, **kwargs): | |
a95a7133 | 3988 | """SetInt(self, int i)""" |
54f9ee45 | 3989 | return _core_.CommandEvent_SetInt(*args, **kwargs) |
e811c8ce RD |
3990 | |
3991 | def GetInt(*args, **kwargs): | |
27fb7603 | 3992 | """ |
01f6b6d3 | 3993 | GetInt(self) -> int |
27fb7603 | 3994 | |
5ba5649b RD |
3995 | Returns the integer identifier corresponding to a listbox, choice or |
3996 | radiobox selection (only if the event was a selection, not a | |
3997 | deselection), or a boolean value representing the value of a checkbox. | |
27fb7603 | 3998 | """ |
54f9ee45 | 3999 | return _core_.CommandEvent_GetInt(*args, **kwargs) |
e811c8ce | 4000 | |
0085ce49 RD |
4001 | def GetClientData(*args, **kwargs): |
4002 | """ | |
4003 | GetClientData(self) -> PyObject | |
4004 | ||
4005 | Returns the client data object for a listbox or choice selection event, (if any.) | |
4006 | """ | |
4007 | return _core_.CommandEvent_GetClientData(*args, **kwargs) | |
4008 | ||
4009 | def SetClientData(*args, **kwargs): | |
4010 | """ | |
4011 | SetClientData(self, PyObject clientData) | |
4012 | ||
4013 | Associate the given client data with the item at position n. | |
4014 | """ | |
4015 | return _core_.CommandEvent_SetClientData(*args, **kwargs) | |
4016 | ||
4017 | GetClientObject = GetClientData | |
4018 | SetClientObject = SetClientData | |
4019 | ||
e811c8ce | 4020 | def Clone(*args, **kwargs): |
a95a7133 | 4021 | """Clone(self) -> Event""" |
54f9ee45 | 4022 | return _core_.CommandEvent_Clone(*args, **kwargs) |
e811c8ce | 4023 | |
2131d850 | 4024 | _core_.CommandEvent_swigregister(CommandEvent) |
d14a1e28 RD |
4025 | |
4026 | #--------------------------------------------------------------------------- | |
4027 | ||
4028 | class NotifyEvent(CommandEvent): | |
27fb7603 RD |
4029 | """ |
4030 | An instance of this class (or one of its derived classes) is sent from | |
4031 | a control when the control's state is being changed and the control | |
4032 | allows that change to be prevented from happening. The event handler | |
4033 | can call `Veto` or `Allow` to tell the control what to do. | |
4034 | """ | |
0085ce49 RD |
4035 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4036 | __repr__ = _swig_repr | |
4037 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4038 | """ |
2131d850 | 4039 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent |
27fb7603 RD |
4040 | |
4041 | An instance of this class (or one of its derived classes) is sent from | |
4042 | a control when the control's state is being changed and the control | |
4043 | allows that change to be prevented from happening. The event handler | |
4044 | can call `Veto` or `Allow` to tell the control what to do. | |
4045 | """ | |
0085ce49 | 4046 | _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs)) |
e811c8ce | 4047 | def Veto(*args, **kwargs): |
27fb7603 RD |
4048 | """ |
4049 | Veto(self) | |
4050 | ||
4051 | Prevents the change announced by this event from happening. | |
4052 | ||
4053 | It is in general a good idea to notify the user about the reasons for | |
4054 | vetoing the change because otherwise the applications behaviour (which | |
4055 | just refuses to do what the user wants) might be quite surprising. | |
4056 | """ | |
54f9ee45 | 4057 | return _core_.NotifyEvent_Veto(*args, **kwargs) |
e811c8ce RD |
4058 | |
4059 | def Allow(*args, **kwargs): | |
27fb7603 RD |
4060 | """ |
4061 | Allow(self) | |
4062 | ||
4063 | This is the opposite of `Veto`: it explicitly allows the event to be | |
4064 | processed. For most events it is not necessary to call this method as | |
4065 | the events are allowed anyhow but some are forbidden by default (this | |
4066 | will be mentioned in the corresponding event description). | |
4067 | """ | |
54f9ee45 | 4068 | return _core_.NotifyEvent_Allow(*args, **kwargs) |
e811c8ce RD |
4069 | |
4070 | def IsAllowed(*args, **kwargs): | |
27fb7603 RD |
4071 | """ |
4072 | IsAllowed(self) -> bool | |
4073 | ||
4074 | Returns true if the change is allowed (`Veto` hasn't been called) or | |
4075 | false otherwise (if it was). | |
4076 | """ | |
54f9ee45 | 4077 | return _core_.NotifyEvent_IsAllowed(*args, **kwargs) |
e811c8ce | 4078 | |
2131d850 | 4079 | _core_.NotifyEvent_swigregister(NotifyEvent) |
d14a1e28 RD |
4080 | |
4081 | #--------------------------------------------------------------------------- | |
4082 | ||
4083 | class ScrollEvent(CommandEvent): | |
27fb7603 RD |
4084 | """ |
4085 | A scroll event holds information about events sent from stand-alone | |
4086 | scrollbars and sliders. Note that scrolled windows do not send | |
4087 | instnaces of this event class, but send the `wx.ScrollWinEvent` | |
4088 | instead. | |
4089 | """ | |
0085ce49 RD |
4090 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4091 | __repr__ = _swig_repr | |
4092 | def __init__(self, *args, **kwargs): | |
0df68c9f | 4093 | """ |
2131d850 | 4094 | __init__(self, EventType commandType=wxEVT_NULL, int winid=0, int pos=0, |
0df68c9f RD |
4095 | int orient=0) -> ScrollEvent |
4096 | """ | |
0085ce49 | 4097 | _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs)) |
e811c8ce | 4098 | def GetOrientation(*args, **kwargs): |
27fb7603 RD |
4099 | """ |
4100 | GetOrientation(self) -> int | |
4101 | ||
4102 | Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of | |
4103 | the scrollbar. | |
4104 | """ | |
54f9ee45 | 4105 | return _core_.ScrollEvent_GetOrientation(*args, **kwargs) |
e811c8ce RD |
4106 | |
4107 | def GetPosition(*args, **kwargs): | |
27fb7603 RD |
4108 | """ |
4109 | GetPosition(self) -> int | |
4110 | ||
4111 | Returns the position of the scrollbar. | |
4112 | """ | |
54f9ee45 | 4113 | return _core_.ScrollEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4114 | |
4115 | def SetOrientation(*args, **kwargs): | |
a95a7133 | 4116 | """SetOrientation(self, int orient)""" |
54f9ee45 | 4117 | return _core_.ScrollEvent_SetOrientation(*args, **kwargs) |
e811c8ce RD |
4118 | |
4119 | def SetPosition(*args, **kwargs): | |
a95a7133 | 4120 | """SetPosition(self, int pos)""" |
54f9ee45 | 4121 | return _core_.ScrollEvent_SetPosition(*args, **kwargs) |
e811c8ce | 4122 | |
2131d850 | 4123 | _core_.ScrollEvent_swigregister(ScrollEvent) |
d14a1e28 RD |
4124 | |
4125 | #--------------------------------------------------------------------------- | |
4126 | ||
4127 | class ScrollWinEvent(Event): | |
27fb7603 RD |
4128 | """ |
4129 | A wx.ScrollWinEvent holds information about scrolling and is sent from | |
4130 | scrolling windows. | |
4131 | """ | |
0085ce49 RD |
4132 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4133 | __repr__ = _swig_repr | |
4134 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4135 | """ |
2131d850 | 4136 | __init__(self, EventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent |
27fb7603 RD |
4137 | |
4138 | A wx.ScrollWinEvent holds information about scrolling and is sent from | |
4139 | scrolling windows. | |
4140 | """ | |
0085ce49 | 4141 | _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs)) |
e811c8ce | 4142 | def GetOrientation(*args, **kwargs): |
27fb7603 RD |
4143 | """ |
4144 | GetOrientation(self) -> int | |
4145 | ||
4146 | Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of | |
4147 | the scrollbar. | |
4148 | """ | |
54f9ee45 | 4149 | return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs) |
e811c8ce RD |
4150 | |
4151 | def GetPosition(*args, **kwargs): | |
27fb7603 RD |
4152 | """ |
4153 | GetPosition(self) -> int | |
4154 | ||
4155 | Returns the position of the scrollbar for the thumb track and release | |
4156 | events. Note that this field can't be used for the other events, you | |
4157 | need to query the window itself for the current position in that case. | |
4158 | """ | |
54f9ee45 | 4159 | return _core_.ScrollWinEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4160 | |
4161 | def SetOrientation(*args, **kwargs): | |
a95a7133 | 4162 | """SetOrientation(self, int orient)""" |
54f9ee45 | 4163 | return _core_.ScrollWinEvent_SetOrientation(*args, **kwargs) |
e811c8ce RD |
4164 | |
4165 | def SetPosition(*args, **kwargs): | |
a95a7133 | 4166 | """SetPosition(self, int pos)""" |
54f9ee45 | 4167 | return _core_.ScrollWinEvent_SetPosition(*args, **kwargs) |
e811c8ce | 4168 | |
2131d850 | 4169 | _core_.ScrollWinEvent_swigregister(ScrollWinEvent) |
d14a1e28 RD |
4170 | |
4171 | #--------------------------------------------------------------------------- | |
4172 | ||
54f9ee45 RD |
4173 | MOUSE_BTN_ANY = _core_.MOUSE_BTN_ANY |
4174 | MOUSE_BTN_NONE = _core_.MOUSE_BTN_NONE | |
4175 | MOUSE_BTN_LEFT = _core_.MOUSE_BTN_LEFT | |
4176 | MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE | |
4177 | MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT | |
d14a1e28 | 4178 | class MouseEvent(Event): |
27fb7603 RD |
4179 | """ |
4180 | This event class contains information about the events generated by | |
4181 | the mouse: they include mouse buttons press and release events and | |
4182 | mouse move events. | |
4183 | ||
4184 | All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for | |
4185 | the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and | |
4186 | ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have | |
4187 | a middle button so a portable application should avoid relying on the | |
4188 | events from it. | |
4189 | ||
4190 | Note the difference between methods like `LeftDown` and `LeftIsDown`: | |
4191 | the former returns true when the event corresponds to the left mouse | |
4192 | button click while the latter returns true if the left mouse button is | |
4193 | currently being pressed. For example, when the user is dragging the | |
4194 | mouse you can use `LeftIsDown` to test whether the left mouse button | |
4195 | is (still) depressed. Also, by convention, if `LeftDown` returns true, | |
4196 | `LeftIsDown` will also return true in wxWidgets whatever the | |
4197 | underlying GUI behaviour is (which is platform-dependent). The same | |
4198 | applies, of course, to other mouse buttons as well. | |
4199 | """ | |
0085ce49 RD |
4200 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4201 | __repr__ = _swig_repr | |
4202 | def __init__(self, *args, **kwargs): | |
27fb7603 | 4203 | """ |
2131d850 | 4204 | __init__(self, EventType mouseType=wxEVT_NULL) -> MouseEvent |
27fb7603 RD |
4205 | |
4206 | Constructs a wx.MouseEvent. Valid event types are: | |
4207 | ||
4208 | * wxEVT_ENTER_WINDOW | |
4209 | * wxEVT_LEAVE_WINDOW | |
4210 | * wxEVT_LEFT_DOWN | |
4211 | * wxEVT_LEFT_UP | |
4212 | * wxEVT_LEFT_DCLICK | |
4213 | * wxEVT_MIDDLE_DOWN | |
4214 | * wxEVT_MIDDLE_UP | |
4215 | * wxEVT_MIDDLE_DCLICK | |
4216 | * wxEVT_RIGHT_DOWN | |
4217 | * wxEVT_RIGHT_UP | |
4218 | * wxEVT_RIGHT_DCLICK | |
4219 | * wxEVT_MOTION | |
4220 | * wxEVT_MOUSEWHEEL | |
4221 | """ | |
0085ce49 | 4222 | _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs)) |
e811c8ce | 4223 | def IsButton(*args, **kwargs): |
27fb7603 RD |
4224 | """ |
4225 | IsButton(self) -> bool | |
4226 | ||
4227 | Returns true if the event was a mouse button event (not necessarily a | |
4228 | button down event - that may be tested using `ButtonDown`). | |
4229 | """ | |
54f9ee45 | 4230 | return _core_.MouseEvent_IsButton(*args, **kwargs) |
e811c8ce RD |
4231 | |
4232 | def ButtonDown(*args, **kwargs): | |
27fb7603 RD |
4233 | """ |
4234 | ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool | |
4235 | ||
5ba5649b RD |
4236 | If the argument is omitted, this returns true if the event was any |
4237 | mouse button down event. Otherwise the argument specifies which | |
4238 | button-down event shold be checked for (see `Button` for the possible | |
4239 | values). | |
27fb7603 | 4240 | """ |
54f9ee45 | 4241 | return _core_.MouseEvent_ButtonDown(*args, **kwargs) |
e811c8ce RD |
4242 | |
4243 | def ButtonDClick(*args, **kwargs): | |
27fb7603 RD |
4244 | """ |
4245 | ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool | |
4246 | ||
4247 | If the argument is omitted, this returns true if the event was any | |
4248 | mouse double click event. Otherwise the argument specifies which | |
4249 | double click event to check for (see `Button` for the possible | |
4250 | values). | |
4251 | """ | |
54f9ee45 | 4252 | return _core_.MouseEvent_ButtonDClick(*args, **kwargs) |
e811c8ce RD |
4253 | |
4254 | def ButtonUp(*args, **kwargs): | |
27fb7603 RD |
4255 | """ |
4256 | ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool | |
4257 | ||
4258 | If the argument is omitted, this returns true if the event was any | |
5ba5649b RD |
4259 | mouse button up event. Otherwise the argument specifies which button |
4260 | up event to check for (see `Button` for the possible values). | |
27fb7603 | 4261 | """ |
54f9ee45 | 4262 | return _core_.MouseEvent_ButtonUp(*args, **kwargs) |
e811c8ce RD |
4263 | |
4264 | def Button(*args, **kwargs): | |
27fb7603 RD |
4265 | """ |
4266 | Button(self, int button) -> bool | |
4267 | ||
4268 | Returns true if the identified mouse button is changing state. Valid | |
4269 | values of button are: | |
4270 | ||
4271 | ==================== ===================================== | |
4272 | wx.MOUSE_BTN_LEFT check if left button was pressed | |
4273 | wx.MOUSE_BTN_MIDDLE check if middle button was pressed | |
4274 | wx.MOUSE_BTN_RIGHT check if right button was pressed | |
4275 | wx.MOUSE_BTN_ANY check if any button was pressed | |
4276 | ==================== ===================================== | |
4277 | ||
4278 | """ | |
54f9ee45 | 4279 | return _core_.MouseEvent_Button(*args, **kwargs) |
e811c8ce RD |
4280 | |
4281 | def ButtonIsDown(*args, **kwargs): | |
a95a7133 | 4282 | """ButtonIsDown(self, int but) -> bool""" |
54f9ee45 | 4283 | return _core_.MouseEvent_ButtonIsDown(*args, **kwargs) |
e811c8ce RD |
4284 | |
4285 | def GetButton(*args, **kwargs): | |
27fb7603 RD |
4286 | """ |
4287 | GetButton(self) -> int | |
4288 | ||
4289 | Returns the mouse button which generated this event or | |
4290 | wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or | |
4291 | leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for | |
4292 | the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE | |
4293 | and wx.MOUSE_BTN_RIGHT for the same events for the middle and the | |
4294 | right buttons respectively. | |
4295 | """ | |
54f9ee45 | 4296 | return _core_.MouseEvent_GetButton(*args, **kwargs) |
e811c8ce RD |
4297 | |
4298 | def ControlDown(*args, **kwargs): | |
27fb7603 RD |
4299 | """ |
4300 | ControlDown(self) -> bool | |
4301 | ||
4302 | Returns true if the control key was down at the time of the event. | |
4303 | """ | |
54f9ee45 | 4304 | return _core_.MouseEvent_ControlDown(*args, **kwargs) |
e811c8ce RD |
4305 | |
4306 | def MetaDown(*args, **kwargs): | |
27fb7603 RD |
4307 | """ |
4308 | MetaDown(self) -> bool | |
4309 | ||
4310 | Returns true if the Meta key was down at the time of the event. | |
4311 | """ | |
54f9ee45 | 4312 | return _core_.MouseEvent_MetaDown(*args, **kwargs) |
e811c8ce RD |
4313 | |
4314 | def AltDown(*args, **kwargs): | |
27fb7603 RD |
4315 | """ |
4316 | AltDown(self) -> bool | |
4317 | ||
4318 | Returns true if the Alt key was down at the time of the event. | |
4319 | """ | |
54f9ee45 | 4320 | return _core_.MouseEvent_AltDown(*args, **kwargs) |
e811c8ce RD |
4321 | |
4322 | def ShiftDown(*args, **kwargs): | |
27fb7603 RD |
4323 | """ |
4324 | ShiftDown(self) -> bool | |
4325 | ||
4326 | Returns true if the Shift key was down at the time of the event. | |
4327 | """ | |
54f9ee45 | 4328 | return _core_.MouseEvent_ShiftDown(*args, **kwargs) |
e811c8ce | 4329 | |
412d302d RD |
4330 | def CmdDown(*args, **kwargs): |
4331 | """ | |
4332 | CmdDown(self) -> bool | |
4333 | ||
4334 | "Cmd" is a pseudo key which is the same as Control for PC and Unix | |
4335 | platforms but the special "Apple" (a.k.a as "Command") key on | |
5ba5649b | 4336 | Macs. It often makes sense to use it instead of, say, `ControlDown` |
412d302d | 4337 | because Cmd key is used for the same thing under Mac as Ctrl |
27fb7603 | 4338 | elsewhere. The Ctrl key still exists, it's just not used for this |
412d302d RD |
4339 | purpose. So for non-Mac platforms this is the same as `ControlDown` |
4340 | and Macs this is the same as `MetaDown`. | |
4341 | """ | |
4342 | return _core_.MouseEvent_CmdDown(*args, **kwargs) | |
4343 | ||
e811c8ce | 4344 | def LeftDown(*args, **kwargs): |
27fb7603 RD |
4345 | """ |
4346 | LeftDown(self) -> bool | |
4347 | ||
4348 | Returns true if the left mouse button state changed to down. | |
4349 | """ | |
54f9ee45 | 4350 | return _core_.MouseEvent_LeftDown(*args, **kwargs) |
e811c8ce RD |
4351 | |
4352 | def MiddleDown(*args, **kwargs): | |
27fb7603 RD |
4353 | """ |
4354 | MiddleDown(self) -> bool | |
4355 | ||
4356 | Returns true if the middle mouse button state changed to down. | |
4357 | """ | |
54f9ee45 | 4358 | return _core_.MouseEvent_MiddleDown(*args, **kwargs) |
e811c8ce RD |
4359 | |
4360 | def RightDown(*args, **kwargs): | |
27fb7603 RD |
4361 | """ |
4362 | RightDown(self) -> bool | |
4363 | ||
4364 | Returns true if the right mouse button state changed to down. | |
4365 | """ | |
54f9ee45 | 4366 | return _core_.MouseEvent_RightDown(*args, **kwargs) |
e811c8ce RD |
4367 | |
4368 | def LeftUp(*args, **kwargs): | |
27fb7603 RD |
4369 | """ |
4370 | LeftUp(self) -> bool | |
4371 | ||
4372 | Returns true if the left mouse button state changed to up. | |
4373 | """ | |
54f9ee45 | 4374 | return _core_.MouseEvent_LeftUp(*args, **kwargs) |
e811c8ce RD |
4375 | |
4376 | def MiddleUp(*args, **kwargs): | |
27fb7603 RD |
4377 | """ |
4378 | MiddleUp(self) -> bool | |
4379 | ||
4380 | Returns true if the middle mouse button state changed to up. | |
4381 | """ | |
54f9ee45 | 4382 | return _core_.MouseEvent_MiddleUp(*args, **kwargs) |
e811c8ce RD |
4383 | |
4384 | def RightUp(*args, **kwargs): | |
27fb7603 RD |
4385 | """ |
4386 | RightUp(self) -> bool | |
4387 | ||
4388 | Returns true if the right mouse button state changed to up. | |
4389 | """ | |
54f9ee45 | 4390 | return _core_.MouseEvent_RightUp(*args, **kwargs) |
e811c8ce RD |
4391 | |
4392 | def LeftDClick(*args, **kwargs): | |
27fb7603 RD |
4393 | """ |
4394 | LeftDClick(self) -> bool | |
4395 | ||
4396 | Returns true if the event was a left button double click. | |
4397 | """ | |
54f9ee45 | 4398 | return _core_.MouseEvent_LeftDClick(*args, **kwargs) |
e811c8ce RD |
4399 | |
4400 | def MiddleDClick(*args, **kwargs): | |
27fb7603 RD |
4401 | """ |
4402 | MiddleDClick(self) -> bool | |
4403 | ||
4404 | Returns true if the event was a middle button double click. | |
4405 | """ | |
54f9ee45 | 4406 | return _core_.MouseEvent_MiddleDClick(*args, **kwargs) |
e811c8ce RD |
4407 | |
4408 | def RightDClick(*args, **kwargs): | |
27fb7603 RD |
4409 | """ |
4410 | RightDClick(self) -> bool | |
4411 | ||
4412 | Returns true if the event was a right button double click. | |
4413 | """ | |
54f9ee45 | 4414 | return _core_.MouseEvent_RightDClick(*args, **kwargs) |
e811c8ce RD |
4415 | |
4416 | def LeftIsDown(*args, **kwargs): | |
27fb7603 RD |
4417 | """ |
4418 | LeftIsDown(self) -> bool | |
4419 | ||
4420 | Returns true if the left mouse button is currently down, independent | |
4421 | of the current event type. | |
4422 | ||
4423 | Please notice that it is not the same as LeftDown which returns true | |
4424 | if the left mouse button was just pressed. Rather, it describes the | |
4425 | state of the mouse button before the event happened. | |
4426 | ||
4427 | This event is usually used in the mouse event handlers which process | |
4428 | "move mouse" messages to determine whether the user is (still) | |
4429 | dragging the mouse. | |
4430 | """ | |
54f9ee45 | 4431 | return _core_.MouseEvent_LeftIsDown(*args, **kwargs) |
e811c8ce RD |
4432 | |
4433 | def MiddleIsDown(*args, **kwargs): | |
27fb7603 RD |
4434 | """ |
4435 | MiddleIsDown(self) -> bool | |
4436 | ||
4437 | Returns true if the middle mouse button is currently down, independent | |
4438 | of the current event type. | |
4439 | """ | |
54f9ee45 | 4440 | return _core_.MouseEvent_MiddleIsDown(*args, **kwargs) |
e811c8ce RD |
4441 | |
4442 | def RightIsDown(*args, **kwargs): | |
27fb7603 RD |
4443 | """ |
4444 | RightIsDown(self) -> bool | |
4445 | ||
4446 | Returns true if the right mouse button is currently down, independent | |
4447 | of the current event type. | |
4448 | """ | |
54f9ee45 | 4449 | return _core_.MouseEvent_RightIsDown(*args, **kwargs) |
e811c8ce RD |
4450 | |
4451 | def Dragging(*args, **kwargs): | |
27fb7603 RD |
4452 | """ |
4453 | Dragging(self) -> bool | |
4454 | ||
4455 | Returns true if this was a dragging event (motion while a button is | |
4456 | depressed). | |
4457 | """ | |
54f9ee45 | 4458 | return _core_.MouseEvent_Dragging(*args, **kwargs) |
e811c8ce RD |
4459 | |
4460 | def Moving(*args, **kwargs): | |
27fb7603 RD |
4461 | """ |
4462 | Moving(self) -> bool | |
4463 | ||
4464 | Returns true if this was a motion event and no mouse buttons were | |
4465 | pressed. If any mouse button is held pressed, then this method returns | |
4466 | false and Dragging returns true. | |
4467 | """ | |
54f9ee45 | 4468 | return _core_.MouseEvent_Moving(*args, **kwargs) |
e811c8ce RD |
4469 | |
4470 | def Entering(*args, **kwargs): | |
27fb7603 RD |
4471 | """ |
4472 | Entering(self) -> bool | |
4473 | ||
4474 | Returns true if the mouse was entering the window. | |
4475 | """ | |
54f9ee45 | 4476 | return _core_.MouseEvent_Entering(*args, **kwargs) |
e811c8ce RD |
4477 | |
4478 | def Leaving(*args, **kwargs): | |
27fb7603 RD |
4479 | """ |
4480 | Leaving(self) -> bool | |
4481 | ||
4482 | Returns true if the mouse was leaving the window. | |
4483 | """ | |
54f9ee45 | 4484 | return _core_.MouseEvent_Leaving(*args, **kwargs) |
e811c8ce RD |
4485 | |
4486 | def GetPosition(*args, **kwargs): | |
0df68c9f | 4487 | """ |
a95a7133 | 4488 | GetPosition(self) -> Point |
e811c8ce | 4489 | |
27fb7603 RD |
4490 | Returns the pixel position of the mouse in window coordinates when the |
4491 | event happened. | |
0df68c9f | 4492 | """ |
54f9ee45 | 4493 | return _core_.MouseEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4494 | |
4495 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
4496 | """ |
4497 | GetPositionTuple() -> (x,y) | |
e811c8ce | 4498 | |
27fb7603 RD |
4499 | Returns the pixel position of the mouse in window coordinates when the |
4500 | event happened. | |
0df68c9f | 4501 | """ |
54f9ee45 | 4502 | return _core_.MouseEvent_GetPositionTuple(*args, **kwargs) |
e811c8ce RD |
4503 | |
4504 | def GetLogicalPosition(*args, **kwargs): | |
27fb7603 RD |
4505 | """ |
4506 | GetLogicalPosition(self, DC dc) -> Point | |
4507 | ||
4508 | Returns the logical mouse position in pixels (i.e. translated | |
4509 | according to the translation set for the DC, which usually indicates | |
4510 | that the window has been scrolled). | |
4511 | """ | |
54f9ee45 | 4512 | return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs) |
e811c8ce RD |
4513 | |
4514 | def GetX(*args, **kwargs): | |
27fb7603 RD |
4515 | """ |
4516 | GetX(self) -> int | |
4517 | ||
4518 | Returns X coordinate of the physical mouse event position. | |
4519 | """ | |
54f9ee45 | 4520 | return _core_.MouseEvent_GetX(*args, **kwargs) |
e811c8ce RD |
4521 | |
4522 | def GetY(*args, **kwargs): | |
27fb7603 RD |
4523 | """ |
4524 | GetY(self) -> int | |
4525 | ||
4526 | Returns Y coordinate of the physical mouse event position. | |
4527 | """ | |
54f9ee45 | 4528 | return _core_.MouseEvent_GetY(*args, **kwargs) |
e811c8ce RD |
4529 | |
4530 | def GetWheelRotation(*args, **kwargs): | |
27fb7603 RD |
4531 | """ |
4532 | GetWheelRotation(self) -> int | |
4533 | ||
4534 | Get wheel rotation, positive or negative indicates direction of | |
4535 | rotation. Current devices all send an event when rotation is equal to | |
4536 | +/-WheelDelta, but this allows for finer resolution devices to be | |
4537 | created in the future. Because of this you shouldn't assume that one | |
4538 | event is equal to 1 line or whatever, but you should be able to either | |
4539 | do partial line scrolling or wait until +/-WheelDelta rotation values | |
4540 | have been accumulated before scrolling. | |
4541 | """ | |
54f9ee45 | 4542 | return _core_.MouseEvent_GetWheelRotation(*args, **kwargs) |
e811c8ce RD |
4543 | |
4544 | def GetWheelDelta(*args, **kwargs): | |
27fb7603 RD |
4545 | """ |
4546 | GetWheelDelta(self) -> int | |
4547 | ||
4548 | Get wheel delta, normally 120. This is the threshold for action to be | |
4549 | taken, and one such action (for example, scrolling one increment) | |
4550 | should occur for each delta. | |
4551 | """ | |
54f9ee45 | 4552 | return _core_.MouseEvent_GetWheelDelta(*args, **kwargs) |
e811c8ce RD |
4553 | |
4554 | def GetLinesPerAction(*args, **kwargs): | |
27fb7603 RD |
4555 | """ |
4556 | GetLinesPerAction(self) -> int | |
4557 | ||
4558 | Returns the configured number of lines (or whatever) to be scrolled | |
4559 | per wheel action. Defaults to three. | |
4560 | """ | |
54f9ee45 | 4561 | return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs) |
e811c8ce RD |
4562 | |
4563 | def IsPageScroll(*args, **kwargs): | |
27fb7603 RD |
4564 | """ |
4565 | IsPageScroll(self) -> bool | |
4566 | ||
4567 | Returns true if the system has been setup to do page scrolling with | |
4568 | the mouse wheel instead of line scrolling. | |
4569 | """ | |
54f9ee45 RD |
4570 | return _core_.MouseEvent_IsPageScroll(*args, **kwargs) |
4571 | ||
4572 | m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set) | |
4573 | m_y = property(_core_.MouseEvent_m_y_get, _core_.MouseEvent_m_y_set) | |
4574 | m_leftDown = property(_core_.MouseEvent_m_leftDown_get, _core_.MouseEvent_m_leftDown_set) | |
4575 | m_middleDown = property(_core_.MouseEvent_m_middleDown_get, _core_.MouseEvent_m_middleDown_set) | |
4576 | m_rightDown = property(_core_.MouseEvent_m_rightDown_get, _core_.MouseEvent_m_rightDown_set) | |
4577 | m_controlDown = property(_core_.MouseEvent_m_controlDown_get, _core_.MouseEvent_m_controlDown_set) | |
4578 | m_shiftDown = property(_core_.MouseEvent_m_shiftDown_get, _core_.MouseEvent_m_shiftDown_set) | |
4579 | m_altDown = property(_core_.MouseEvent_m_altDown_get, _core_.MouseEvent_m_altDown_set) | |
4580 | m_metaDown = property(_core_.MouseEvent_m_metaDown_get, _core_.MouseEvent_m_metaDown_set) | |
4581 | m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set) | |
4582 | m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set) | |
4583 | m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set) | |
2131d850 | 4584 | _core_.MouseEvent_swigregister(MouseEvent) |
d14a1e28 RD |
4585 | |
4586 | #--------------------------------------------------------------------------- | |
4587 | ||
4588 | class SetCursorEvent(Event): | |
5ba5649b RD |
4589 | """ |
4590 | A SetCursorEvent is generated when the mouse cursor is about to be set | |
4591 | as a result of mouse motion. This event gives the application the | |
4592 | chance to perform specific mouse cursor processing based on the | |
4593 | current position of the mouse within the window. Use the `SetCursor` | |
4594 | method to specify the cursor you want to be displayed. | |
4595 | """ | |
0085ce49 RD |
4596 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4597 | __repr__ = _swig_repr | |
4598 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
4599 | """ |
4600 | __init__(self, int x=0, int y=0) -> SetCursorEvent | |
4601 | ||
4602 | Construct a new `wx.SetCursorEvent`. | |
4603 | """ | |
0085ce49 | 4604 | _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs)) |
e811c8ce | 4605 | def GetX(*args, **kwargs): |
5ba5649b RD |
4606 | """ |
4607 | GetX(self) -> int | |
4608 | ||
4609 | Returns the X coordinate of the mouse in client coordinates. | |
4610 | """ | |
54f9ee45 | 4611 | return _core_.SetCursorEvent_GetX(*args, **kwargs) |
e811c8ce RD |
4612 | |
4613 | def GetY(*args, **kwargs): | |
5ba5649b RD |
4614 | """ |
4615 | GetY(self) -> int | |
4616 | ||
4617 | Returns the Y coordinate of the mouse in client coordinates. | |
4618 | """ | |
54f9ee45 | 4619 | return _core_.SetCursorEvent_GetY(*args, **kwargs) |
e811c8ce RD |
4620 | |
4621 | def SetCursor(*args, **kwargs): | |
5ba5649b RD |
4622 | """ |
4623 | SetCursor(self, Cursor cursor) | |
4624 | ||
4625 | Sets the cursor associated with this event. | |
4626 | """ | |
54f9ee45 | 4627 | return _core_.SetCursorEvent_SetCursor(*args, **kwargs) |
e811c8ce RD |
4628 | |
4629 | def GetCursor(*args, **kwargs): | |
5ba5649b RD |
4630 | """ |
4631 | GetCursor(self) -> Cursor | |
4632 | ||
4633 | Returns a reference to the cursor specified by this event. | |
4634 | """ | |
54f9ee45 | 4635 | return _core_.SetCursorEvent_GetCursor(*args, **kwargs) |
e811c8ce RD |
4636 | |
4637 | def HasCursor(*args, **kwargs): | |
5ba5649b RD |
4638 | """ |
4639 | HasCursor(self) -> bool | |
4640 | ||
4641 | Returns true if the cursor specified by this event is a valid cursor. | |
4642 | """ | |
54f9ee45 | 4643 | return _core_.SetCursorEvent_HasCursor(*args, **kwargs) |
e811c8ce | 4644 | |
2131d850 | 4645 | _core_.SetCursorEvent_swigregister(SetCursorEvent) |
d14a1e28 RD |
4646 | |
4647 | #--------------------------------------------------------------------------- | |
4648 | ||
4649 | class KeyEvent(Event): | |
5ba5649b RD |
4650 | """ |
4651 | This event class contains information about keypress and character | |
4652 | events. These events are only sent to the widget that currently has | |
4653 | the keyboard focus. | |
4654 | ||
4655 | Notice that there are three different kinds of keyboard events in | |
4656 | wxWidgets: key down and up events and char events. The difference | |
4657 | between the first two is clear - the first corresponds to a key press | |
4658 | and the second to a key release - otherwise they are identical. Just | |
4659 | note that if the key is maintained in a pressed state you will | |
4660 | typically get a lot of (automatically generated) down events but only | |
4661 | one up so it is wrong to assume that there is one up event | |
4662 | corresponding to each down one. | |
4663 | ||
4664 | Both key events provide untranslated key codes while the char event | |
4665 | carries the translated one. The untranslated code for alphanumeric | |
4666 | keys is always an upper case value. For the other keys it is one of | |
4667 | WXK_XXX values from the keycodes table. The translated key is, in | |
4668 | general, the character the user expects to appear as the result of the | |
4669 | key combination when typing the text into a text entry zone, for | |
4670 | example. | |
4671 | ||
4672 | A few examples to clarify this (all assume that CAPS LOCK is unpressed | |
4673 | and the standard US keyboard): when the 'A' key is pressed, the key | |
4674 | down event key code is equal to ASCII A == 65. But the char event key | |
4675 | code is ASCII a == 97. On the other hand, if you press both SHIFT and | |
4676 | 'A' keys simultaneously , the key code in key down event will still be | |
4677 | just 'A' while the char event key code parameter will now be 'A' as | |
4678 | well. | |
4679 | ||
4680 | Although in this simple case it is clear that the correct key code | |
4681 | could be found in the key down event handler by checking the value | |
4682 | returned by `ShiftDown`, in general you should use EVT_CHAR for this | |
4683 | as for non alphanumeric keys or non-US keyboard layouts the | |
4684 | translation is keyboard-layout dependent and can only be done properly | |
4685 | by the system itself. | |
4686 | ||
4687 | Another kind of translation is done when the control key is pressed: | |
4688 | for example, for CTRL-A key press the key down event still carries the | |
4689 | same key code 'A' as usual but the char event will have key code of 1, | |
4690 | the ASCII value of this key combination. | |
4691 | ||
4692 | You may discover how the other keys on your system behave | |
4693 | interactively by running the KeyEvents sample in the wxPython demo and | |
4694 | pressing some keys while the blue box at the top has the keyboard | |
4695 | focus. | |
4696 | ||
4697 | **Note**: If a key down event is caught and the event handler does not | |
4698 | call event.Skip() then the coresponding char event will not | |
4699 | happen. This is by design and enables the programs that handle both | |
4700 | types of events to be a bit simpler. | |
4701 | ||
4702 | **Note for Windows programmers**: The key and char events in wxWidgets | |
4703 | are similar to but slightly different from Windows WM_KEYDOWN and | |
4704 | WM_CHAR events. In particular, Alt-x combination will generate a char | |
4705 | event in wxWidgets (unless it is used as an accelerator). | |
4706 | ||
4707 | **Tip**: be sure to call event.Skip() for events that you don't | |
4708 | process in key event function, otherwise menu shortcuts may cease to | |
4709 | work under Windows. | |
4710 | ||
4711 | """ | |
0085ce49 RD |
4712 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4713 | __repr__ = _swig_repr | |
4714 | def __init__(self, *args, **kwargs): | |
5ba5649b | 4715 | """ |
2131d850 | 4716 | __init__(self, EventType eventType=wxEVT_NULL) -> KeyEvent |
5ba5649b RD |
4717 | |
4718 | Construct a new `wx.KeyEvent`. Valid event types are: | |
4719 | * | |
4720 | """ | |
0085ce49 | 4721 | _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs)) |
b1fcee84 RD |
4722 | def GetModifiers(*args, **kwargs): |
4723 | """ | |
4724 | GetModifiers(self) -> int | |
4725 | ||
4726 | Returns a bitmask of the current modifier settings. Can be used to | |
4727 | check if the key event has exactly the given modifiers without having | |
4728 | to explicitly check that the other modifiers are not down. For | |
4729 | example:: | |
4730 | ||
4731 | if event.GetModifers() == wx.MOD_CONTROL: | |
4732 | DoSomething() | |
4733 | ||
4734 | """ | |
4735 | return _core_.KeyEvent_GetModifiers(*args, **kwargs) | |
4736 | ||
e811c8ce | 4737 | def ControlDown(*args, **kwargs): |
5ba5649b RD |
4738 | """ |
4739 | ControlDown(self) -> bool | |
4740 | ||
4741 | Returns ``True`` if the Control key was down at the time of the event. | |
4742 | """ | |
54f9ee45 | 4743 | return _core_.KeyEvent_ControlDown(*args, **kwargs) |
e811c8ce RD |
4744 | |
4745 | def MetaDown(*args, **kwargs): | |
5ba5649b RD |
4746 | """ |
4747 | MetaDown(self) -> bool | |
4748 | ||
4749 | Returns ``True`` if the Meta key was down at the time of the event. | |
4750 | """ | |
54f9ee45 | 4751 | return _core_.KeyEvent_MetaDown(*args, **kwargs) |
e811c8ce RD |
4752 | |
4753 | def AltDown(*args, **kwargs): | |
5ba5649b RD |
4754 | """ |
4755 | AltDown(self) -> bool | |
4756 | ||
4757 | Returns ``True`` if the Alt key was down at the time of the event. | |
4758 | """ | |
54f9ee45 | 4759 | return _core_.KeyEvent_AltDown(*args, **kwargs) |
e811c8ce RD |
4760 | |
4761 | def ShiftDown(*args, **kwargs): | |
5ba5649b RD |
4762 | """ |
4763 | ShiftDown(self) -> bool | |
4764 | ||
4765 | Returns ``True`` if the Shift key was down at the time of the event. | |
4766 | """ | |
54f9ee45 | 4767 | return _core_.KeyEvent_ShiftDown(*args, **kwargs) |
e811c8ce | 4768 | |
412d302d RD |
4769 | def CmdDown(*args, **kwargs): |
4770 | """ | |
4771 | CmdDown(self) -> bool | |
4772 | ||
4773 | "Cmd" is a pseudo key which is the same as Control for PC and Unix | |
4774 | platforms but the special "Apple" (a.k.a as "Command") key on | |
5ba5649b | 4775 | Macs. It makes often sense to use it instead of, say, `ControlDown` |
412d302d RD |
4776 | because Cmd key is used for the same thing under Mac as Ctrl |
4777 | elsewhere. The Ctrl still exists, it's just not used for this | |
4778 | purpose. So for non-Mac platforms this is the same as `ControlDown` | |
4779 | and Macs this is the same as `MetaDown`. | |
4780 | """ | |
4781 | return _core_.KeyEvent_CmdDown(*args, **kwargs) | |
4782 | ||
e811c8ce | 4783 | def HasModifiers(*args, **kwargs): |
5ba5649b RD |
4784 | """ |
4785 | HasModifiers(self) -> bool | |
4786 | ||
4787 | Returns true if either CTRL or ALT keys was down at the time of the | |
4788 | key event. Note that this function does not take into account neither | |
4789 | SHIFT nor META key states (the reason for ignoring the latter is that | |
4790 | it is common for NUMLOCK key to be configured as META under X but the | |
4791 | key presses even while NUMLOCK is on should be still processed | |
4792 | normally). | |
4793 | """ | |
54f9ee45 | 4794 | return _core_.KeyEvent_HasModifiers(*args, **kwargs) |
e811c8ce RD |
4795 | |
4796 | def GetKeyCode(*args, **kwargs): | |
5ba5649b RD |
4797 | """ |
4798 | GetKeyCode(self) -> int | |
4799 | ||
4800 | Returns the virtual key code. ASCII events return normal ASCII values, | |
4801 | while non-ASCII events return values such as WXK_LEFT for the left | |
4802 | cursor key. See `wx.KeyEvent` for a full list of the virtual key | |
4803 | codes. | |
4804 | ||
4805 | Note that in Unicode build, the returned value is meaningful only if | |
4806 | the user entered a character that can be represented in current | |
4807 | locale's default charset. You can obtain the corresponding Unicode | |
4808 | character using `GetUnicodeKey`. | |
4809 | """ | |
54f9ee45 | 4810 | return _core_.KeyEvent_GetKeyCode(*args, **kwargs) |
e811c8ce | 4811 | |
d14a1e28 | 4812 | KeyCode = GetKeyCode |
19272049 | 4813 | def GetUnicodeKey(*args, **kwargs): |
5ba5649b RD |
4814 | """ |
4815 | GetUnicodeKey(self) -> int | |
4816 | ||
4817 | Returns the Unicode character corresponding to this key event. This | |
4818 | function is only meaningfule in a Unicode build of wxPython. | |
4819 | """ | |
19272049 | 4820 | return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs) |
e811c8ce | 4821 | |
19272049 | 4822 | GetUniChar = GetUnicodeKey |
b850e7f3 RD |
4823 | def SetUnicodeKey(*args, **kwargs): |
4824 | """ | |
4825 | SetUnicodeKey(self, int uniChar) | |
4826 | ||
4827 | Set the Unicode value of the key event, but only if this is a Unicode | |
4828 | build of wxPython. | |
4829 | """ | |
4830 | return _core_.KeyEvent_SetUnicodeKey(*args, **kwargs) | |
4831 | ||
e811c8ce | 4832 | def GetRawKeyCode(*args, **kwargs): |
5ba5649b RD |
4833 | """ |
4834 | GetRawKeyCode(self) -> unsigned int | |
4835 | ||
4836 | Returns the raw key code for this event. This is a platform-dependent | |
4837 | scan code which should only be used in advanced | |
4838 | applications. Currently the raw key codes are not supported by all | |
4839 | ports. | |
4840 | """ | |
54f9ee45 | 4841 | return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs) |
e811c8ce RD |
4842 | |
4843 | def GetRawKeyFlags(*args, **kwargs): | |
5ba5649b RD |
4844 | """ |
4845 | GetRawKeyFlags(self) -> unsigned int | |
4846 | ||
4847 | Returns the low level key flags for this event. The flags are | |
4848 | platform-dependent and should only be used in advanced applications. | |
4849 | Currently the raw key flags are not supported by all ports. | |
4850 | """ | |
54f9ee45 | 4851 | return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs) |
e811c8ce RD |
4852 | |
4853 | def GetPosition(*args, **kwargs): | |
0df68c9f | 4854 | """ |
a95a7133 | 4855 | GetPosition(self) -> Point |
e811c8ce | 4856 | |
5ba5649b | 4857 | Find the position of the event, if applicable. |
0df68c9f | 4858 | """ |
54f9ee45 | 4859 | return _core_.KeyEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4860 | |
4861 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
4862 | """ |
4863 | GetPositionTuple() -> (x,y) | |
e811c8ce | 4864 | |
5ba5649b | 4865 | Find the position of the event, if applicable. |
0df68c9f | 4866 | """ |
54f9ee45 | 4867 | return _core_.KeyEvent_GetPositionTuple(*args, **kwargs) |
e811c8ce RD |
4868 | |
4869 | def GetX(*args, **kwargs): | |
5ba5649b RD |
4870 | """ |
4871 | GetX(self) -> int | |
4872 | ||
4873 | Returns the X position (in client coordinates) of the event, if | |
4874 | applicable. | |
4875 | """ | |
54f9ee45 | 4876 | return _core_.KeyEvent_GetX(*args, **kwargs) |
e811c8ce RD |
4877 | |
4878 | def GetY(*args, **kwargs): | |
5ba5649b RD |
4879 | """ |
4880 | GetY(self) -> int | |
4881 | ||
4882 | Returns the Y position (in client coordinates) of the event, if | |
4883 | applicable. | |
4884 | """ | |
54f9ee45 RD |
4885 | return _core_.KeyEvent_GetY(*args, **kwargs) |
4886 | ||
4887 | m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set) | |
4888 | m_y = property(_core_.KeyEvent_m_y_get, _core_.KeyEvent_m_y_set) | |
4889 | m_keyCode = property(_core_.KeyEvent_m_keyCode_get, _core_.KeyEvent_m_keyCode_set) | |
4890 | m_controlDown = property(_core_.KeyEvent_m_controlDown_get, _core_.KeyEvent_m_controlDown_set) | |
4891 | m_shiftDown = property(_core_.KeyEvent_m_shiftDown_get, _core_.KeyEvent_m_shiftDown_set) | |
4892 | m_altDown = property(_core_.KeyEvent_m_altDown_get, _core_.KeyEvent_m_altDown_set) | |
4893 | m_metaDown = property(_core_.KeyEvent_m_metaDown_get, _core_.KeyEvent_m_metaDown_set) | |
4894 | m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set) | |
4895 | m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set) | |
4896 | m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set) | |
2131d850 | 4897 | _core_.KeyEvent_swigregister(KeyEvent) |
d14a1e28 RD |
4898 | |
4899 | #--------------------------------------------------------------------------- | |
4900 | ||
4901 | class SizeEvent(Event): | |
5ba5649b RD |
4902 | """ |
4903 | A size event holds information about size change events. The EVT_SIZE | |
4904 | handler function will be called when the window it is bound to has | |
4905 | been resized. | |
4906 | ||
4907 | Note that the size passed is of the whole window: call | |
4908 | `wx.Window.GetClientSize` for the area which may be used by the | |
4909 | application. | |
4910 | ||
4911 | When a window is resized, usually only a small part of the window is | |
4912 | damaged and and that area is all that is in the update region for the | |
4913 | next paint event. However, if your drawing depends on the size of the | |
4914 | window, you may need to clear the DC explicitly and repaint the whole | |
4915 | window. In which case, you may need to call `wx.Window.Refresh` to | |
4916 | invalidate the entire window. | |
4917 | ||
4918 | """ | |
0085ce49 RD |
4919 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4920 | __repr__ = _swig_repr | |
4921 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
4922 | """ |
4923 | __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent | |
4924 | ||
4925 | Construct a new ``wx.SizeEvent``. | |
4926 | """ | |
0085ce49 | 4927 | _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs)) |
e811c8ce | 4928 | def GetSize(*args, **kwargs): |
5ba5649b RD |
4929 | """ |
4930 | GetSize(self) -> Size | |
4931 | ||
4932 | Returns the entire size of the window generating the size change | |
4933 | event. | |
4934 | """ | |
54f9ee45 | 4935 | return _core_.SizeEvent_GetSize(*args, **kwargs) |
e811c8ce RD |
4936 | |
4937 | def GetRect(*args, **kwargs): | |
a95a7133 | 4938 | """GetRect(self) -> Rect""" |
54f9ee45 | 4939 | return _core_.SizeEvent_GetRect(*args, **kwargs) |
e811c8ce RD |
4940 | |
4941 | def SetRect(*args, **kwargs): | |
a95a7133 | 4942 | """SetRect(self, Rect rect)""" |
54f9ee45 | 4943 | return _core_.SizeEvent_SetRect(*args, **kwargs) |
e811c8ce RD |
4944 | |
4945 | def SetSize(*args, **kwargs): | |
a95a7133 | 4946 | """SetSize(self, Size size)""" |
54f9ee45 | 4947 | return _core_.SizeEvent_SetSize(*args, **kwargs) |
e811c8ce | 4948 | |
54f9ee45 RD |
4949 | m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set) |
4950 | m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set) | |
2131d850 | 4951 | _core_.SizeEvent_swigregister(SizeEvent) |
d14a1e28 RD |
4952 | |
4953 | #--------------------------------------------------------------------------- | |
4954 | ||
4955 | class MoveEvent(Event): | |
5ba5649b RD |
4956 | """ |
4957 | This event object is sent for EVT_MOVE event bindings when a window is | |
4958 | moved to a new position. | |
4959 | """ | |
0085ce49 RD |
4960 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
4961 | __repr__ = _swig_repr | |
4962 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
4963 | """ |
4964 | __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent | |
4965 | ||
4966 | Constructor. | |
4967 | """ | |
0085ce49 | 4968 | _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs)) |
e811c8ce | 4969 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
4970 | """ |
4971 | GetPosition(self) -> Point | |
4972 | ||
4973 | Returns the position of the window generating the move change event. | |
4974 | """ | |
54f9ee45 | 4975 | return _core_.MoveEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
4976 | |
4977 | def GetRect(*args, **kwargs): | |
a95a7133 | 4978 | """GetRect(self) -> Rect""" |
54f9ee45 | 4979 | return _core_.MoveEvent_GetRect(*args, **kwargs) |
e811c8ce RD |
4980 | |
4981 | def SetRect(*args, **kwargs): | |
a95a7133 | 4982 | """SetRect(self, Rect rect)""" |
54f9ee45 | 4983 | return _core_.MoveEvent_SetRect(*args, **kwargs) |
e811c8ce RD |
4984 | |
4985 | def SetPosition(*args, **kwargs): | |
a95a7133 | 4986 | """SetPosition(self, Point pos)""" |
54f9ee45 | 4987 | return _core_.MoveEvent_SetPosition(*args, **kwargs) |
e811c8ce | 4988 | |
7557b9b5 RD |
4989 | m_pos = property(GetPosition, SetPosition) |
4990 | m_rect = property(GetRect, SetRect) | |
4991 | ||
2131d850 | 4992 | _core_.MoveEvent_swigregister(MoveEvent) |
d14a1e28 RD |
4993 | |
4994 | #--------------------------------------------------------------------------- | |
4995 | ||
4996 | class PaintEvent(Event): | |
5ba5649b RD |
4997 | """ |
4998 | A paint event is sent when a window's contents needs to be repainted. | |
4999 | Note that in an EVT_PAINT handler the application must *always* create | |
5000 | a `wx.PaintDC` object, even if you do not use it. Otherwise MS | |
5001 | Windows assumes that the window has not been painted yet and will send | |
5002 | the event again, causing endless refreshes. | |
5003 | ||
5004 | You can optimize painting by retrieving the rectangles that have been | |
5005 | damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`, | |
5006 | and only repainting these rectangles. The rectangles are in terms of | |
5007 | the client area, and are unscrolled, so you will need to do some | |
5008 | calculations using the current view position to obtain logical, | |
5009 | scrolled units. | |
5010 | ||
5011 | """ | |
0085ce49 RD |
5012 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5013 | __repr__ = _swig_repr | |
5014 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5015 | """__init__(self, int Id=0) -> PaintEvent""" |
0085ce49 | 5016 | _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs)) |
2131d850 | 5017 | _core_.PaintEvent_swigregister(PaintEvent) |
d14a1e28 RD |
5018 | |
5019 | class NcPaintEvent(Event): | |
093d3ff1 | 5020 | """Proxy of C++ NcPaintEvent class""" |
0085ce49 RD |
5021 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5022 | __repr__ = _swig_repr | |
5023 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5024 | """__init__(self, int winid=0) -> NcPaintEvent""" |
0085ce49 | 5025 | _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs)) |
2131d850 | 5026 | _core_.NcPaintEvent_swigregister(NcPaintEvent) |
d14a1e28 RD |
5027 | |
5028 | #--------------------------------------------------------------------------- | |
5029 | ||
5030 | class EraseEvent(Event): | |
5ba5649b RD |
5031 | """ |
5032 | An erase event is sent whenever the background of a window needs to be | |
5033 | repainted. To intercept this event use the EVT_ERASE_BACKGROUND event | |
5034 | binder. On some platforms, such as GTK+, this event is simulated | |
5035 | (simply generated just before the paint event) and may cause flicker. | |
5036 | ||
5037 | To paint a custom background use the `GetDC` method and use the returned | |
5038 | device context if it is not ``None``, otherwise create a temporary | |
5039 | `wx.ClientDC` and draw on that. | |
5040 | ||
5041 | """ | |
0085ce49 RD |
5042 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5043 | __repr__ = _swig_repr | |
5044 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5045 | """ |
5046 | __init__(self, int Id=0, DC dc=None) -> EraseEvent | |
5047 | ||
5048 | Constructor | |
5049 | """ | |
0085ce49 | 5050 | _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs)) |
e811c8ce | 5051 | def GetDC(*args, **kwargs): |
5ba5649b RD |
5052 | """ |
5053 | GetDC(self) -> DC | |
5054 | ||
5055 | Returns the device context the event handler should draw upon. If | |
5056 | ``None`` is returned then create a temporary `wx.ClientDC` and use | |
5057 | that instead. | |
5058 | """ | |
54f9ee45 | 5059 | return _core_.EraseEvent_GetDC(*args, **kwargs) |
e811c8ce | 5060 | |
2131d850 | 5061 | _core_.EraseEvent_swigregister(EraseEvent) |
d14a1e28 RD |
5062 | |
5063 | #--------------------------------------------------------------------------- | |
5064 | ||
5065 | class FocusEvent(Event): | |
5ba5649b RD |
5066 | """ |
5067 | A focus event is sent when a window's focus changes. The window losing | |
5068 | focus receives an EVT_KILL_FOCUS event while the window gaining it | |
5069 | gets an EVT_SET_FOCUS event. | |
5070 | ||
5071 | Notice that the set focus event happens both when the user gives focus | |
5072 | to the window (whether using the mouse or keyboard) and when it is | |
5073 | done from the program itself using `wx.Window.SetFocus`. | |
5074 | ||
5075 | """ | |
0085ce49 RD |
5076 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5077 | __repr__ = _swig_repr | |
5078 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5079 | """ |
2131d850 | 5080 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> FocusEvent |
5ba5649b RD |
5081 | |
5082 | Constructor | |
5083 | """ | |
0085ce49 | 5084 | _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs)) |
e811c8ce | 5085 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
5086 | """ |
5087 | GetWindow(self) -> Window | |
5088 | ||
5089 | Returns the other window associated with this event, that is the | |
5090 | window which had the focus before for the EVT_SET_FOCUS event and the | |
5091 | window which is going to receive focus for the wxEVT_KILL_FOCUS event. | |
5092 | ||
5093 | Warning: the window returned may be None! | |
5094 | """ | |
54f9ee45 | 5095 | return _core_.FocusEvent_GetWindow(*args, **kwargs) |
e811c8ce RD |
5096 | |
5097 | def SetWindow(*args, **kwargs): | |
a95a7133 | 5098 | """SetWindow(self, Window win)""" |
54f9ee45 | 5099 | return _core_.FocusEvent_SetWindow(*args, **kwargs) |
e811c8ce | 5100 | |
2131d850 | 5101 | _core_.FocusEvent_swigregister(FocusEvent) |
d14a1e28 RD |
5102 | |
5103 | #--------------------------------------------------------------------------- | |
5104 | ||
5105 | class ChildFocusEvent(CommandEvent): | |
5ba5649b RD |
5106 | """ |
5107 | wx.ChildFocusEvent notifies the parent that a child has received the | |
5108 | focus. Unlike `wx.FocusEvent` it is propagated up the window | |
5109 | heirarchy. | |
5110 | """ | |
0085ce49 RD |
5111 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5112 | __repr__ = _swig_repr | |
5113 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5114 | """ |
5115 | __init__(self, Window win=None) -> ChildFocusEvent | |
5116 | ||
5117 | Constructor | |
5118 | """ | |
0085ce49 | 5119 | _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs)) |
e811c8ce | 5120 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
5121 | """ |
5122 | GetWindow(self) -> Window | |
5123 | ||
5124 | The window which has just received the focus. | |
5125 | """ | |
54f9ee45 | 5126 | return _core_.ChildFocusEvent_GetWindow(*args, **kwargs) |
e811c8ce | 5127 | |
2131d850 | 5128 | _core_.ChildFocusEvent_swigregister(ChildFocusEvent) |
d14a1e28 RD |
5129 | |
5130 | #--------------------------------------------------------------------------- | |
5131 | ||
5132 | class ActivateEvent(Event): | |
5ba5649b RD |
5133 | """ |
5134 | An activate event is sent when a top-level window or the entire | |
5135 | application is being activated or deactivated. | |
5136 | ||
5137 | A top-level window (a dialog or frame) receives an activate event when | |
5138 | is being activated or deactivated. This is indicated visually by the | |
5139 | title bar changing colour, and a subwindow gaining the keyboard focus. | |
5140 | An application is activated or deactivated when one of its frames | |
5141 | becomes activated, or a frame becomes inactivate resulting in all | |
5142 | application frames being inactive. | |
5143 | ||
5144 | Please note that usually you should call event.Skip() in your handlers | |
5145 | for these events so the default handlers will still be called, as not | |
5146 | doing so can result in strange effects. | |
5147 | ||
5148 | """ | |
0085ce49 RD |
5149 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5150 | __repr__ = _swig_repr | |
5151 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5152 | """ |
2131d850 | 5153 | __init__(self, EventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent |
5ba5649b RD |
5154 | |
5155 | Constructor | |
5156 | """ | |
0085ce49 | 5157 | _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs)) |
e811c8ce | 5158 | def GetActive(*args, **kwargs): |
5ba5649b RD |
5159 | """ |
5160 | GetActive(self) -> bool | |
5161 | ||
5162 | Returns true if the application or window is being activated, false | |
5163 | otherwise. | |
5164 | """ | |
54f9ee45 | 5165 | return _core_.ActivateEvent_GetActive(*args, **kwargs) |
e811c8ce | 5166 | |
2131d850 | 5167 | _core_.ActivateEvent_swigregister(ActivateEvent) |
d14a1e28 RD |
5168 | |
5169 | #--------------------------------------------------------------------------- | |
5170 | ||
5171 | class InitDialogEvent(Event): | |
5ba5649b RD |
5172 | """ |
5173 | A wx.InitDialogEvent is sent as a dialog is being initialised, or for | |
5174 | any window when `wx.Window.InitDialog` is called. Handlers for this | |
5175 | event can transfer data to the window, or anything else that should be | |
5176 | done before the user begins editing the form. The default handler | |
5177 | calls `wx.Window.TransferDataToWindow`. | |
5178 | """ | |
0085ce49 RD |
5179 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5180 | __repr__ = _swig_repr | |
5181 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5182 | """ |
5183 | __init__(self, int Id=0) -> InitDialogEvent | |
5184 | ||
5185 | Constructor | |
5186 | """ | |
0085ce49 | 5187 | _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs)) |
2131d850 | 5188 | _core_.InitDialogEvent_swigregister(InitDialogEvent) |
d14a1e28 RD |
5189 | |
5190 | #--------------------------------------------------------------------------- | |
5191 | ||
5192 | class MenuEvent(Event): | |
5ba5649b RD |
5193 | """ |
5194 | This class is used for a variety of menu-related events. Note that | |
5195 | these do not include menu command events, which are handled by sending | |
5196 | `wx.CommandEvent` objects. | |
5197 | ||
5198 | The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help | |
5199 | text in the first field of the status bar. | |
5200 | """ | |
0085ce49 RD |
5201 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5202 | __repr__ = _swig_repr | |
5203 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5204 | """ |
2131d850 | 5205 | __init__(self, EventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent |
5ba5649b RD |
5206 | |
5207 | Constructor | |
5208 | """ | |
0085ce49 | 5209 | _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs)) |
e811c8ce | 5210 | def GetMenuId(*args, **kwargs): |
5ba5649b RD |
5211 | """ |
5212 | GetMenuId(self) -> int | |
5213 | ||
5214 | Returns the menu identifier associated with the event. This method | |
5215 | should be only used with the HIGHLIGHT events. | |
5216 | """ | |
54f9ee45 | 5217 | return _core_.MenuEvent_GetMenuId(*args, **kwargs) |
e811c8ce RD |
5218 | |
5219 | def IsPopup(*args, **kwargs): | |
5ba5649b RD |
5220 | """ |
5221 | IsPopup(self) -> bool | |
5222 | ||
5223 | Returns ``True`` if the menu which is being opened or closed is a | |
5224 | popup menu, ``False`` if it is a normal one. This method should only | |
5225 | be used with the OPEN and CLOSE events. | |
5226 | """ | |
54f9ee45 | 5227 | return _core_.MenuEvent_IsPopup(*args, **kwargs) |
e811c8ce RD |
5228 | |
5229 | def GetMenu(*args, **kwargs): | |
5ba5649b RD |
5230 | """ |
5231 | GetMenu(self) -> Menu | |
5232 | ||
5233 | Returns the menu which is being opened or closed. This method should | |
5234 | only be used with the OPEN and CLOSE events. | |
5235 | """ | |
54f9ee45 | 5236 | return _core_.MenuEvent_GetMenu(*args, **kwargs) |
e811c8ce | 5237 | |
2131d850 | 5238 | _core_.MenuEvent_swigregister(MenuEvent) |
d14a1e28 RD |
5239 | |
5240 | #--------------------------------------------------------------------------- | |
5241 | ||
5242 | class CloseEvent(Event): | |
5ba5649b RD |
5243 | """ |
5244 | This event class contains information about window and session close | |
5245 | events. | |
5246 | ||
5247 | The handler function for EVT_CLOSE is called when the user has tried | |
5248 | to close a a frame or dialog box using the window manager controls or | |
5249 | the system menu. It can also be invoked by the application itself | |
5250 | programmatically, for example by calling the `wx.Window.Close` | |
5251 | function. | |
5252 | ||
5253 | You should check whether the application is forcing the deletion of | |
5254 | the window using `CanVeto`. If it returns ``False``, you must destroy | |
5255 | the window using `wx.Window.Destroy`. If the return value is ``True``, | |
5256 | it is up to you whether you respond by destroying the window or not. | |
5257 | For example you may wish to display a message dialog prompting to save | |
5258 | files or to cancel the close. | |
5259 | ||
5260 | If you don't destroy the window, you should call `Veto` to let the | |
5261 | calling code know that you did not destroy the window. This allows the | |
5262 | `wx.Window.Close` function to return ``True`` or ``False`` depending | |
5263 | on whether the close instruction was honored or not. | |
5264 | """ | |
0085ce49 RD |
5265 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5266 | __repr__ = _swig_repr | |
5267 | def __init__(self, *args, **kwargs): | |
5ba5649b | 5268 | """ |
2131d850 | 5269 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> CloseEvent |
5ba5649b RD |
5270 | |
5271 | Constructor. | |
5272 | """ | |
0085ce49 | 5273 | _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs)) |
e811c8ce | 5274 | def SetLoggingOff(*args, **kwargs): |
5ba5649b RD |
5275 | """ |
5276 | SetLoggingOff(self, bool logOff) | |
5277 | ||
5278 | Sets the 'logging off' flag. | |
5279 | """ | |
54f9ee45 | 5280 | return _core_.CloseEvent_SetLoggingOff(*args, **kwargs) |
e811c8ce RD |
5281 | |
5282 | def GetLoggingOff(*args, **kwargs): | |
5ba5649b RD |
5283 | """ |
5284 | GetLoggingOff(self) -> bool | |
5285 | ||
6c75a4cf RD |
5286 | Returns ``True`` if the user is logging off or ``False`` if the |
5287 | system is shutting down. This method can only be called for end | |
5288 | session and query end session events, it doesn't make sense for close | |
5289 | window event. | |
5ba5649b | 5290 | """ |
54f9ee45 | 5291 | return _core_.CloseEvent_GetLoggingOff(*args, **kwargs) |
e811c8ce RD |
5292 | |
5293 | def Veto(*args, **kwargs): | |
5ba5649b RD |
5294 | """ |
5295 | Veto(self, bool veto=True) | |
5296 | ||
5297 | Call this from your event handler to veto a system shutdown or to | |
5298 | signal to the calling application that a window close did not happen. | |
5299 | ||
5300 | You can only veto a shutdown or close if `CanVeto` returns true. | |
5301 | """ | |
54f9ee45 | 5302 | return _core_.CloseEvent_Veto(*args, **kwargs) |
e811c8ce | 5303 | |
5ba5649b RD |
5304 | def GetVeto(*args, **kwargs): |
5305 | """GetVeto(self) -> bool""" | |
5306 | return _core_.CloseEvent_GetVeto(*args, **kwargs) | |
5307 | ||
e811c8ce | 5308 | def SetCanVeto(*args, **kwargs): |
5ba5649b RD |
5309 | """ |
5310 | SetCanVeto(self, bool canVeto) | |
5311 | ||
5312 | Sets the 'can veto' flag. | |
5313 | """ | |
54f9ee45 | 5314 | return _core_.CloseEvent_SetCanVeto(*args, **kwargs) |
e811c8ce RD |
5315 | |
5316 | def CanVeto(*args, **kwargs): | |
5ba5649b RD |
5317 | """ |
5318 | CanVeto(self) -> bool | |
e811c8ce | 5319 | |
5ba5649b RD |
5320 | Returns true if you can veto a system shutdown or a window close |
5321 | event. Vetoing a window close event is not possible if the calling | |
5322 | code wishes to force the application to exit, and so this function | |
5323 | must be called to check this. | |
5324 | """ | |
5325 | return _core_.CloseEvent_CanVeto(*args, **kwargs) | |
e811c8ce | 5326 | |
2131d850 | 5327 | _core_.CloseEvent_swigregister(CloseEvent) |
d14a1e28 RD |
5328 | |
5329 | #--------------------------------------------------------------------------- | |
5330 | ||
5331 | class ShowEvent(Event): | |
5ba5649b | 5332 | """An EVT_SHOW event is sent when a window is shown or hidden.""" |
0085ce49 RD |
5333 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5334 | __repr__ = _swig_repr | |
5335 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5336 | """ |
5337 | __init__(self, int winid=0, bool show=False) -> ShowEvent | |
5338 | ||
5339 | An EVT_SHOW event is sent when a window is shown or hidden. | |
5340 | """ | |
0085ce49 | 5341 | _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs)) |
e811c8ce | 5342 | def SetShow(*args, **kwargs): |
a95a7133 | 5343 | """SetShow(self, bool show)""" |
54f9ee45 | 5344 | return _core_.ShowEvent_SetShow(*args, **kwargs) |
e811c8ce RD |
5345 | |
5346 | def GetShow(*args, **kwargs): | |
a95a7133 | 5347 | """GetShow(self) -> bool""" |
54f9ee45 | 5348 | return _core_.ShowEvent_GetShow(*args, **kwargs) |
e811c8ce | 5349 | |
2131d850 | 5350 | _core_.ShowEvent_swigregister(ShowEvent) |
d14a1e28 RD |
5351 | |
5352 | #--------------------------------------------------------------------------- | |
5353 | ||
5354 | class IconizeEvent(Event): | |
5ba5649b RD |
5355 | """ |
5356 | An EVT_ICONIZE event is sent when a frame is iconized (minimized) or | |
5357 | restored. | |
5358 | """ | |
0085ce49 RD |
5359 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5360 | __repr__ = _swig_repr | |
5361 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5362 | """ |
5363 | __init__(self, int id=0, bool iconized=True) -> IconizeEvent | |
5364 | ||
5365 | An EVT_ICONIZE event is sent when a frame is iconized (minimized) or | |
5366 | restored. | |
5367 | """ | |
0085ce49 | 5368 | _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs)) |
e811c8ce | 5369 | def Iconized(*args, **kwargs): |
5ba5649b RD |
5370 | """ |
5371 | Iconized(self) -> bool | |
5372 | ||
5373 | Returns ``True`` if the frame has been iconized, ``False`` if it has | |
5374 | been restored. | |
5375 | """ | |
54f9ee45 | 5376 | return _core_.IconizeEvent_Iconized(*args, **kwargs) |
e811c8ce | 5377 | |
2131d850 | 5378 | _core_.IconizeEvent_swigregister(IconizeEvent) |
d14a1e28 RD |
5379 | |
5380 | #--------------------------------------------------------------------------- | |
5381 | ||
5382 | class MaximizeEvent(Event): | |
5ba5649b | 5383 | """An EVT_MAXIMIZE event is sent when a frame is maximized or restored.""" |
0085ce49 RD |
5384 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5385 | __repr__ = _swig_repr | |
5386 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5387 | """ |
5388 | __init__(self, int id=0) -> MaximizeEvent | |
5389 | ||
5390 | An EVT_MAXIMIZE event is sent when a frame is maximized or restored. | |
5391 | """ | |
0085ce49 | 5392 | _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs)) |
2131d850 | 5393 | _core_.MaximizeEvent_swigregister(MaximizeEvent) |
d14a1e28 RD |
5394 | |
5395 | #--------------------------------------------------------------------------- | |
5396 | ||
5397 | class DropFilesEvent(Event): | |
5ba5649b RD |
5398 | """ |
5399 | This class is used for drop files events, that is, when files have | |
5400 | been dropped onto the window. This functionality is only available | |
5401 | under Windows. The window must have previously been enabled for | |
5402 | dropping by calling `wx.Window.DragAcceptFiles`. | |
5403 | ||
5404 | Important note: this is a separate implementation to the more general | |
5405 | drag and drop implementation using `wx.FileDropTarget`, and etc. This | |
5406 | implementation uses the older, Windows message-based approach of | |
5407 | dropping files. | |
5408 | ||
5409 | Use wx.EVT_DROP_FILES to bind an event handler to receive file drop | |
5410 | events. | |
5411 | ||
5412 | """ | |
0085ce49 RD |
5413 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5414 | def __init__(self): raise AttributeError, "No constructor defined" | |
5415 | __repr__ = _swig_repr | |
e811c8ce | 5416 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
5417 | """ |
5418 | GetPosition(self) -> Point | |
5419 | ||
5420 | Returns the position at which the files were dropped. | |
5421 | """ | |
54f9ee45 | 5422 | return _core_.DropFilesEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
5423 | |
5424 | def GetNumberOfFiles(*args, **kwargs): | |
5ba5649b RD |
5425 | """ |
5426 | GetNumberOfFiles(self) -> int | |
5427 | ||
5428 | Returns the number of files dropped. | |
5429 | """ | |
54f9ee45 | 5430 | return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs) |
e811c8ce RD |
5431 | |
5432 | def GetFiles(*args, **kwargs): | |
5ba5649b RD |
5433 | """ |
5434 | GetFiles(self) -> PyObject | |
5435 | ||
5436 | Returns a list of the filenames that were dropped. | |
5437 | """ | |
54f9ee45 | 5438 | return _core_.DropFilesEvent_GetFiles(*args, **kwargs) |
e811c8ce | 5439 | |
2131d850 | 5440 | _core_.DropFilesEvent_swigregister(DropFilesEvent) |
d14a1e28 RD |
5441 | |
5442 | #--------------------------------------------------------------------------- | |
5443 | ||
54f9ee45 RD |
5444 | UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL |
5445 | UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED | |
d14a1e28 | 5446 | class UpdateUIEvent(CommandEvent): |
5ba5649b RD |
5447 | """ |
5448 | This class is used for EVT_UPDATE_UI pseudo-events which are sent by | |
5449 | wxWidgets to give an application the chance to update various user | |
5450 | interface elements. | |
5451 | ||
5452 | Without update UI events, an application has to work hard to | |
5453 | check/uncheck, enable/disable, and set the text for elements such as | |
5454 | menu items and toolbar buttons. The code for doing this has to be | |
5455 | mixed up with the code that is invoked when an action is invoked for a | |
5456 | menu item or button. | |
5457 | ||
5458 | With update UI events, you define an event handler to look at the | |
5459 | state of the application and change UI elements accordingly. wxWidgets | |
5460 | will call your handler functions in idle time, so you don't have to | |
5461 | worry where to call this code. In addition to being a clearer and more | |
5462 | declarative method, it also means you don't have to worry whether | |
5463 | you're updating a toolbar or menubar identifier. The same handler can | |
5464 | update a menu item and toolbar button, if the ID values are the same. | |
5465 | ||
5466 | Instead of directly manipulating the menu or button, you call | |
5467 | functions in the event object, such as `Check`. wxWidgets will | |
5468 | determine whether such a call has been made, and which UI element to | |
5469 | update. | |
5470 | ||
5471 | These events will work for popup menus as well as menubars. Just | |
5472 | before a menu is popped up, `wx.Menu.UpdateUI` is called to process | |
5473 | any UI events for the window that owns the menu. | |
5474 | ||
5475 | If you find that the overhead of UI update processing is affecting | |
5476 | your application, you can do one or both of the following: | |
5477 | ||
5478 | 1. Call `wx.UpdateUIEvent.SetMode` with a value of | |
5479 | wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style | |
5480 | wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should | |
5481 | receive update events. No other windows will receive update | |
5482 | events. | |
5483 | ||
5484 | 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond | |
5485 | value to set the delay between updates. You may need to call | |
5486 | `wx.Window.UpdateWindowUI` at critical points, for example when | |
5487 | a dialog is about to be shown, in case the user sees a slight | |
5488 | delay before windows are updated. | |
5489 | ||
5490 | Note that although events are sent in idle time, defining a EVT_IDLE | |
5491 | handler for a window does not affect this because the events are sent | |
5492 | from an internal idle handler. | |
5493 | ||
5494 | wxWidgets tries to optimize update events on some platforms. On | |
5495 | Windows and GTK+, events for menubar items are only sent when the menu | |
5496 | is about to be shown, and not in idle time. | |
5497 | ||
5498 | """ | |
0085ce49 RD |
5499 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5500 | __repr__ = _swig_repr | |
5501 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5502 | """ |
5503 | __init__(self, int commandId=0) -> UpdateUIEvent | |
5504 | ||
5505 | Constructor | |
5506 | """ | |
0085ce49 | 5507 | _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs)) |
e811c8ce | 5508 | def GetChecked(*args, **kwargs): |
5ba5649b RD |
5509 | """ |
5510 | GetChecked(self) -> bool | |
5511 | ||
5512 | Returns ``True`` if the UI element should be checked. | |
5513 | """ | |
54f9ee45 | 5514 | return _core_.UpdateUIEvent_GetChecked(*args, **kwargs) |
e811c8ce RD |
5515 | |
5516 | def GetEnabled(*args, **kwargs): | |
5ba5649b RD |
5517 | """ |
5518 | GetEnabled(self) -> bool | |
5519 | ||
5520 | Returns ``True`` if the UI element should be enabled. | |
5521 | """ | |
54f9ee45 | 5522 | return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs) |
e811c8ce | 5523 | |
b1fcee84 RD |
5524 | def GetShown(*args, **kwargs): |
5525 | """ | |
5526 | GetShown(self) -> bool | |
5527 | ||
5528 | Returns ``True`` if the UI element should be shown. | |
5529 | """ | |
5530 | return _core_.UpdateUIEvent_GetShown(*args, **kwargs) | |
5531 | ||
e811c8ce | 5532 | def GetText(*args, **kwargs): |
5ba5649b RD |
5533 | """ |
5534 | GetText(self) -> String | |
5535 | ||
5536 | Returns the text that should be set for the UI element. | |
5537 | """ | |
54f9ee45 | 5538 | return _core_.UpdateUIEvent_GetText(*args, **kwargs) |
e811c8ce RD |
5539 | |
5540 | def GetSetText(*args, **kwargs): | |
5ba5649b RD |
5541 | """ |
5542 | GetSetText(self) -> bool | |
5543 | ||
5544 | Returns ``True`` if the application has called `SetText`. For | |
5545 | wxWidgets internal use only. | |
5546 | """ | |
54f9ee45 | 5547 | return _core_.UpdateUIEvent_GetSetText(*args, **kwargs) |
e811c8ce RD |
5548 | |
5549 | def GetSetChecked(*args, **kwargs): | |
5ba5649b RD |
5550 | """ |
5551 | GetSetChecked(self) -> bool | |
5552 | ||
5553 | Returns ``True`` if the application has called `Check`. For wxWidgets | |
5554 | internal use only. | |
5555 | """ | |
54f9ee45 | 5556 | return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs) |
e811c8ce RD |
5557 | |
5558 | def GetSetEnabled(*args, **kwargs): | |
5ba5649b RD |
5559 | """ |
5560 | GetSetEnabled(self) -> bool | |
5561 | ||
5562 | Returns ``True`` if the application has called `Enable`. For wxWidgets | |
5563 | internal use only. | |
5564 | """ | |
54f9ee45 | 5565 | return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs) |
e811c8ce | 5566 | |
b1fcee84 RD |
5567 | def GetSetShown(*args, **kwargs): |
5568 | """ | |
5569 | GetSetShown(self) -> bool | |
5570 | ||
5571 | Returns ``True`` if the application has called `Show`. For wxWidgets | |
5572 | internal use only. | |
5573 | """ | |
5574 | return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs) | |
5575 | ||
e811c8ce | 5576 | def Check(*args, **kwargs): |
5ba5649b RD |
5577 | """ |
5578 | Check(self, bool check) | |
5579 | ||
5580 | Check or uncheck the UI element. | |
5581 | """ | |
54f9ee45 | 5582 | return _core_.UpdateUIEvent_Check(*args, **kwargs) |
e811c8ce RD |
5583 | |
5584 | def Enable(*args, **kwargs): | |
5ba5649b RD |
5585 | """ |
5586 | Enable(self, bool enable) | |
5587 | ||
5588 | Enable or disable the UI element. | |
5589 | """ | |
54f9ee45 | 5590 | return _core_.UpdateUIEvent_Enable(*args, **kwargs) |
e811c8ce | 5591 | |
b1fcee84 RD |
5592 | def Show(*args, **kwargs): |
5593 | """ | |
5594 | Show(self, bool show) | |
5595 | ||
5596 | Show or hide the UI element. | |
5597 | """ | |
5598 | return _core_.UpdateUIEvent_Show(*args, **kwargs) | |
5599 | ||
e811c8ce | 5600 | def SetText(*args, **kwargs): |
5ba5649b RD |
5601 | """ |
5602 | SetText(self, String text) | |
5603 | ||
5604 | Sets the text for this UI element. | |
5605 | """ | |
54f9ee45 | 5606 | return _core_.UpdateUIEvent_SetText(*args, **kwargs) |
e811c8ce RD |
5607 | |
5608 | def SetUpdateInterval(*args, **kwargs): | |
5ba5649b RD |
5609 | """ |
5610 | SetUpdateInterval(long updateInterval) | |
5611 | ||
5612 | Sets the interval between updates in milliseconds. Set to -1 to | |
5613 | disable updates, or to 0 to update as frequently as possible. The | |
5614 | default is 0. | |
5615 | ||
5616 | Use this to reduce the overhead of UI update events if your | |
5617 | application has a lot of windows. If you set the value to -1 or | |
5618 | greater than 0, you may also need to call `wx.Window.UpdateWindowUI` | |
5619 | at appropriate points in your application, such as when a dialog is | |
5620 | about to be shown. | |
5621 | """ | |
54f9ee45 | 5622 | return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs) |
e811c8ce RD |
5623 | |
5624 | SetUpdateInterval = staticmethod(SetUpdateInterval) | |
5625 | def GetUpdateInterval(*args, **kwargs): | |
5ba5649b RD |
5626 | """ |
5627 | GetUpdateInterval() -> long | |
5628 | ||
5629 | Returns the current interval between updates in milliseconds. -1 | |
5630 | disables updates, 0 updates as frequently as possible. | |
5631 | """ | |
54f9ee45 | 5632 | return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs) |
e811c8ce RD |
5633 | |
5634 | GetUpdateInterval = staticmethod(GetUpdateInterval) | |
5635 | def CanUpdate(*args, **kwargs): | |
5ba5649b RD |
5636 | """ |
5637 | CanUpdate(Window win) -> bool | |
5638 | ||
5639 | Returns ``True`` if it is appropriate to update (send UI update events | |
5640 | to) this window. | |
5641 | ||
5642 | This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`), | |
5643 | the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update | |
5644 | events were last sent in idle time, and the update interval, to | |
5645 | determine whether events should be sent to this window now. By default | |
5646 | this will always return true because the update mode is initially | |
5647 | wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update | |
5648 | events will be sent as often as possible. You can reduce the frequency | |
5649 | that events are sent by changing the mode and/or setting an update | |
5650 | interval. | |
5651 | ||
5652 | """ | |
54f9ee45 | 5653 | return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs) |
e811c8ce RD |
5654 | |
5655 | CanUpdate = staticmethod(CanUpdate) | |
5656 | def ResetUpdateTime(*args, **kwargs): | |
5ba5649b RD |
5657 | """ |
5658 | ResetUpdateTime() | |
5659 | ||
5660 | Used internally to reset the last-updated time to the current time. It | |
5661 | is assumed that update events are normally sent in idle time, so this | |
5662 | is called at the end of idle processing. | |
5663 | """ | |
54f9ee45 | 5664 | return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs) |
e811c8ce RD |
5665 | |
5666 | ResetUpdateTime = staticmethod(ResetUpdateTime) | |
5667 | def SetMode(*args, **kwargs): | |
5ba5649b RD |
5668 | """ |
5669 | SetMode(int mode) | |
5670 | ||
5671 | Specify how wxWidgets will send update events: to all windows, or only | |
5672 | to those which specify that they will process the events. | |
5673 | ||
5674 | The mode may be one of the following values: | |
5675 | ||
5676 | ============================= ========================================== | |
5677 | wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This | |
5678 | is the default setting. | |
5679 | wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that | |
5680 | have the wx.WS_EX_PROCESS_UI_UPDATES extra | |
5681 | style set. | |
5682 | ============================= ========================================== | |
5683 | ||
5684 | """ | |
54f9ee45 | 5685 | return _core_.UpdateUIEvent_SetMode(*args, **kwargs) |
e811c8ce RD |
5686 | |
5687 | SetMode = staticmethod(SetMode) | |
5688 | def GetMode(*args, **kwargs): | |
5ba5649b RD |
5689 | """ |
5690 | GetMode() -> int | |
5691 | ||
5692 | Returns a value specifying how wxWidgets will send update events: to | |
5693 | all windows, or only to those which specify that they will process the | |
5694 | events. | |
5695 | """ | |
54f9ee45 | 5696 | return _core_.UpdateUIEvent_GetMode(*args, **kwargs) |
e811c8ce RD |
5697 | |
5698 | GetMode = staticmethod(GetMode) | |
2131d850 | 5699 | _core_.UpdateUIEvent_swigregister(UpdateUIEvent) |
d14a1e28 | 5700 | |
e811c8ce | 5701 | def UpdateUIEvent_SetUpdateInterval(*args, **kwargs): |
0085ce49 | 5702 | """ |
5ba5649b RD |
5703 | UpdateUIEvent_SetUpdateInterval(long updateInterval) |
5704 | ||
5705 | Sets the interval between updates in milliseconds. Set to -1 to | |
5706 | disable updates, or to 0 to update as frequently as possible. The | |
5707 | default is 0. | |
5708 | ||
5709 | Use this to reduce the overhead of UI update events if your | |
5710 | application has a lot of windows. If you set the value to -1 or | |
5711 | greater than 0, you may also need to call `wx.Window.UpdateWindowUI` | |
5712 | at appropriate points in your application, such as when a dialog is | |
5713 | about to be shown. | |
5714 | """ | |
0085ce49 | 5715 | return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs) |
d14a1e28 | 5716 | |
0085ce49 RD |
5717 | def UpdateUIEvent_GetUpdateInterval(*args): |
5718 | """ | |
5ba5649b RD |
5719 | UpdateUIEvent_GetUpdateInterval() -> long |
5720 | ||
5721 | Returns the current interval between updates in milliseconds. -1 | |
5722 | disables updates, 0 updates as frequently as possible. | |
5723 | """ | |
0085ce49 | 5724 | return _core_.UpdateUIEvent_GetUpdateInterval(*args) |
d14a1e28 | 5725 | |
e811c8ce | 5726 | def UpdateUIEvent_CanUpdate(*args, **kwargs): |
0085ce49 | 5727 | """ |
5ba5649b RD |
5728 | UpdateUIEvent_CanUpdate(Window win) -> bool |
5729 | ||
5730 | Returns ``True`` if it is appropriate to update (send UI update events | |
5731 | to) this window. | |
5732 | ||
5733 | This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`), | |
5734 | the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update | |
5735 | events were last sent in idle time, and the update interval, to | |
5736 | determine whether events should be sent to this window now. By default | |
5737 | this will always return true because the update mode is initially | |
5738 | wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update | |
5739 | events will be sent as often as possible. You can reduce the frequency | |
5740 | that events are sent by changing the mode and/or setting an update | |
5741 | interval. | |
5742 | ||
5743 | """ | |
0085ce49 | 5744 | return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs) |
d14a1e28 | 5745 | |
0085ce49 RD |
5746 | def UpdateUIEvent_ResetUpdateTime(*args): |
5747 | """ | |
5ba5649b RD |
5748 | UpdateUIEvent_ResetUpdateTime() |
5749 | ||
5750 | Used internally to reset the last-updated time to the current time. It | |
5751 | is assumed that update events are normally sent in idle time, so this | |
5752 | is called at the end of idle processing. | |
5753 | """ | |
0085ce49 | 5754 | return _core_.UpdateUIEvent_ResetUpdateTime(*args) |
d14a1e28 | 5755 | |
e811c8ce | 5756 | def UpdateUIEvent_SetMode(*args, **kwargs): |
0085ce49 | 5757 | """ |
5ba5649b RD |
5758 | UpdateUIEvent_SetMode(int mode) |
5759 | ||
5760 | Specify how wxWidgets will send update events: to all windows, or only | |
5761 | to those which specify that they will process the events. | |
5762 | ||
5763 | The mode may be one of the following values: | |
5764 | ||
5765 | ============================= ========================================== | |
5766 | wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This | |
5767 | is the default setting. | |
5768 | wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that | |
5769 | have the wx.WS_EX_PROCESS_UI_UPDATES extra | |
5770 | style set. | |
5771 | ============================= ========================================== | |
5772 | ||
5773 | """ | |
0085ce49 | 5774 | return _core_.UpdateUIEvent_SetMode(*args, **kwargs) |
d14a1e28 | 5775 | |
0085ce49 RD |
5776 | def UpdateUIEvent_GetMode(*args): |
5777 | """ | |
5ba5649b RD |
5778 | UpdateUIEvent_GetMode() -> int |
5779 | ||
5780 | Returns a value specifying how wxWidgets will send update events: to | |
5781 | all windows, or only to those which specify that they will process the | |
5782 | events. | |
5783 | """ | |
0085ce49 | 5784 | return _core_.UpdateUIEvent_GetMode(*args) |
d14a1e28 RD |
5785 | |
5786 | #--------------------------------------------------------------------------- | |
5787 | ||
5788 | class SysColourChangedEvent(Event): | |
5ba5649b RD |
5789 | """ |
5790 | This class is used for EVT_SYS_COLOUR_CHANGED, which are generated | |
5791 | when the user changes the colour settings using the control | |
5792 | panel. This is only applicable under Windows. | |
5793 | ||
5794 | The default event handler for this event propagates the event to child | |
5795 | windows, since Windows only sends the events to top-level windows. If | |
5796 | intercepting this event for a top-level window, remember to call | |
5797 | `Skip` so the the base class handler will still be executed, or to | |
5798 | pass the event on to the window's children explicitly. | |
5799 | ||
5800 | """ | |
0085ce49 RD |
5801 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5802 | __repr__ = _swig_repr | |
5803 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5804 | """ |
5805 | __init__(self) -> SysColourChangedEvent | |
5806 | ||
5807 | Constructor | |
5808 | """ | |
0085ce49 | 5809 | _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs)) |
2131d850 | 5810 | _core_.SysColourChangedEvent_swigregister(SysColourChangedEvent) |
d14a1e28 RD |
5811 | |
5812 | #--------------------------------------------------------------------------- | |
5813 | ||
5814 | class MouseCaptureChangedEvent(Event): | |
5ba5649b RD |
5815 | """ |
5816 | An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to | |
5817 | a window that loses its mouse capture. This is called even if | |
5818 | `wx.Window.ReleaseMouse` was called by the application code. Handling | |
5819 | this event allows an application to cater for unexpected capture | |
5820 | releases which might otherwise confuse mouse handling code. | |
5821 | ||
5822 | This event is implemented under Windows only. | |
5823 | """ | |
0085ce49 RD |
5824 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5825 | __repr__ = _swig_repr | |
5826 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5827 | """ |
5828 | __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent | |
5829 | ||
5830 | Constructor | |
5831 | """ | |
0085ce49 | 5832 | _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs)) |
e811c8ce | 5833 | def GetCapturedWindow(*args, **kwargs): |
5ba5649b RD |
5834 | """ |
5835 | GetCapturedWindow(self) -> Window | |
5836 | ||
5837 | Returns the window that gained the capture, or ``None`` if it was a | |
5838 | non-wxWidgets window. | |
5839 | """ | |
54f9ee45 | 5840 | return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs) |
e811c8ce | 5841 | |
2131d850 | 5842 | _core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent) |
d14a1e28 RD |
5843 | |
5844 | #--------------------------------------------------------------------------- | |
5845 | ||
5846 | class DisplayChangedEvent(Event): | |
5ba5649b RD |
5847 | """ |
5848 | An EVT_DISPLAY_CHANGED event is sent to all windows when the display | |
5849 | resolution has changed. | |
5850 | ||
5851 | This event is implemented under Windows only. | |
5852 | """ | |
0085ce49 RD |
5853 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5854 | __repr__ = _swig_repr | |
5855 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5856 | """__init__(self) -> DisplayChangedEvent""" |
0085ce49 | 5857 | _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs)) |
2131d850 | 5858 | _core_.DisplayChangedEvent_swigregister(DisplayChangedEvent) |
d14a1e28 RD |
5859 | |
5860 | #--------------------------------------------------------------------------- | |
5861 | ||
5862 | class PaletteChangedEvent(Event): | |
5ba5649b RD |
5863 | """ |
5864 | An EVT_PALETTE_CHANGED event is sent when the system palette has | |
5865 | changed, thereby giving each window a chance to redo their own to | |
5866 | match. | |
5867 | ||
5868 | This event is implemented under Windows only. | |
5869 | """ | |
0085ce49 RD |
5870 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5871 | __repr__ = _swig_repr | |
5872 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5873 | """ |
5874 | __init__(self, int id=0) -> PaletteChangedEvent | |
5875 | ||
5876 | An EVT_PALETTE_CHANGED event is sent when the system palette has | |
5877 | changed, thereby giving each window a chance to redo their own to | |
5878 | match. | |
5879 | ||
5880 | This event is implemented under Windows only. | |
5881 | """ | |
0085ce49 | 5882 | _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs)) |
e811c8ce | 5883 | def SetChangedWindow(*args, **kwargs): |
a95a7133 | 5884 | """SetChangedWindow(self, Window win)""" |
54f9ee45 | 5885 | return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs) |
e811c8ce RD |
5886 | |
5887 | def GetChangedWindow(*args, **kwargs): | |
a95a7133 | 5888 | """GetChangedWindow(self) -> Window""" |
54f9ee45 | 5889 | return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs) |
e811c8ce | 5890 | |
2131d850 | 5891 | _core_.PaletteChangedEvent_swigregister(PaletteChangedEvent) |
d14a1e28 RD |
5892 | |
5893 | #--------------------------------------------------------------------------- | |
5894 | ||
5895 | class QueryNewPaletteEvent(Event): | |
5ba5649b RD |
5896 | """ |
5897 | An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard | |
5898 | focus and should re-do its palette. | |
5899 | ||
5900 | This event is implemented under Windows only. | |
5901 | """ | |
0085ce49 RD |
5902 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5903 | __repr__ = _swig_repr | |
5904 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
5905 | """ |
5906 | __init__(self, int winid=0) -> QueryNewPaletteEvent | |
5907 | ||
5908 | Constructor. | |
5909 | """ | |
0085ce49 | 5910 | _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs)) |
e811c8ce | 5911 | def SetPaletteRealized(*args, **kwargs): |
5ba5649b RD |
5912 | """ |
5913 | SetPaletteRealized(self, bool realized) | |
5914 | ||
5915 | App should set this if it changes the palette. | |
5916 | """ | |
54f9ee45 | 5917 | return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs) |
e811c8ce RD |
5918 | |
5919 | def GetPaletteRealized(*args, **kwargs): | |
a95a7133 | 5920 | """GetPaletteRealized(self) -> bool""" |
54f9ee45 | 5921 | return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs) |
e811c8ce | 5922 | |
2131d850 | 5923 | _core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent) |
d14a1e28 RD |
5924 | |
5925 | #--------------------------------------------------------------------------- | |
5926 | ||
5927 | class NavigationKeyEvent(Event): | |
5ba5649b RD |
5928 | """ |
5929 | EVT_NAVIGATION_KEY events are used to control moving the focus between | |
5930 | widgets, otherwise known as tab-traversal. You woudl normally not | |
5931 | catch navigation events in applications as there are already | |
5932 | appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find | |
5933 | it useful to send navigation events in certain situations to change | |
5934 | the focus in certain ways, although it's probably easier to just call | |
5935 | `wx.Window.Navigate`. | |
5936 | """ | |
0085ce49 RD |
5937 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
5938 | __repr__ = _swig_repr | |
5939 | def __init__(self, *args, **kwargs): | |
a95a7133 | 5940 | """__init__(self) -> NavigationKeyEvent""" |
0085ce49 | 5941 | _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs)) |
e811c8ce | 5942 | def GetDirection(*args, **kwargs): |
5ba5649b RD |
5943 | """ |
5944 | GetDirection(self) -> bool | |
5945 | ||
5946 | Returns ``True`` if the direction is forward, ``False`` otherwise. | |
5947 | """ | |
54f9ee45 | 5948 | return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs) |
e811c8ce RD |
5949 | |
5950 | def SetDirection(*args, **kwargs): | |
5ba5649b RD |
5951 | """ |
5952 | SetDirection(self, bool forward) | |
5953 | ||
5954 | Specify the direction that the navigation should take. Usually the | |
5955 | difference between using Tab and Shift-Tab. | |
5956 | """ | |
54f9ee45 | 5957 | return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs) |
e811c8ce RD |
5958 | |
5959 | def IsWindowChange(*args, **kwargs): | |
5ba5649b RD |
5960 | """ |
5961 | IsWindowChange(self) -> bool | |
5962 | ||
5963 | Returns ``True`` if window change is allowed. | |
5964 | """ | |
54f9ee45 | 5965 | return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs) |
e811c8ce RD |
5966 | |
5967 | def SetWindowChange(*args, **kwargs): | |
5ba5649b RD |
5968 | """ |
5969 | SetWindowChange(self, bool ischange) | |
5970 | ||
5971 | Specify if the navigation should be able to change parent windows. | |
5972 | For example, changing notebook pages, etc. This is usually implemented | |
5973 | by using Control-Tab. | |
5974 | """ | |
54f9ee45 | 5975 | return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs) |
e811c8ce | 5976 | |
68350608 | 5977 | def IsFromTab(*args, **kwargs): |
5ba5649b RD |
5978 | """ |
5979 | IsFromTab(self) -> bool | |
5980 | ||
5981 | Returns ``True`` if the navigation event is originated from the Tab | |
5982 | key. | |
5983 | """ | |
68350608 RD |
5984 | return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs) |
5985 | ||
5986 | def SetFromTab(*args, **kwargs): | |
5ba5649b RD |
5987 | """ |
5988 | SetFromTab(self, bool bIs) | |
5989 | ||
5990 | Set to true under MSW if the event was generated using the tab key. | |
5991 | This is required for proper navogation over radio buttons. | |
5992 | """ | |
68350608 RD |
5993 | return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs) |
5994 | ||
908b74cd | 5995 | def SetFlags(*args, **kwargs): |
5ba5649b RD |
5996 | """ |
5997 | SetFlags(self, long flags) | |
5998 | ||
5999 | Set the navigation flags to a combination of the following: | |
6000 | ||
6001 | * wx.NavigationKeyEvent.IsBackward | |
6002 | * wx.NavigationKeyEvent.IsForward | |
6003 | * wx.NavigationKeyEvent.WinChange | |
6004 | * wx.NavigationKeyEvent.FromTab | |
6005 | ||
6006 | """ | |
908b74cd RD |
6007 | return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs) |
6008 | ||
e811c8ce | 6009 | def GetCurrentFocus(*args, **kwargs): |
5ba5649b RD |
6010 | """ |
6011 | GetCurrentFocus(self) -> Window | |
6012 | ||
6013 | Returns the child window which currenty has the focus. May be | |
6014 | ``None``. | |
6015 | """ | |
54f9ee45 | 6016 | return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs) |
e811c8ce RD |
6017 | |
6018 | def SetCurrentFocus(*args, **kwargs): | |
5ba5649b RD |
6019 | """ |
6020 | SetCurrentFocus(self, Window win) | |
6021 | ||
6022 | Set the window that has the focus. | |
6023 | """ | |
54f9ee45 | 6024 | return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs) |
e811c8ce | 6025 | |
b0f7404b | 6026 | IsBackward = _core_.NavigationKeyEvent_IsBackward |
908b74cd RD |
6027 | IsForward = _core_.NavigationKeyEvent_IsForward |
6028 | WinChange = _core_.NavigationKeyEvent_WinChange | |
68350608 | 6029 | FromTab = _core_.NavigationKeyEvent_FromTab |
2131d850 | 6030 | _core_.NavigationKeyEvent_swigregister(NavigationKeyEvent) |
d14a1e28 RD |
6031 | |
6032 | #--------------------------------------------------------------------------- | |
6033 | ||
6034 | class WindowCreateEvent(CommandEvent): | |
5ba5649b RD |
6035 | """ |
6036 | The EVT_WINDOW_CREATE event is sent as soon as the window object (the | |
6037 | underlying GUI object) exists. | |
6038 | """ | |
0085ce49 RD |
6039 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6040 | __repr__ = _swig_repr | |
6041 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6042 | """ |
6043 | __init__(self, Window win=None) -> WindowCreateEvent | |
6044 | ||
6045 | The EVT_WINDOW_CREATE event is sent as soon as the window object (the | |
6046 | underlying GUI object) exists. | |
6047 | """ | |
0085ce49 | 6048 | _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs)) |
e811c8ce | 6049 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
6050 | """ |
6051 | GetWindow(self) -> Window | |
6052 | ||
6053 | Returns the window that this event refers to. | |
6054 | """ | |
54f9ee45 | 6055 | return _core_.WindowCreateEvent_GetWindow(*args, **kwargs) |
e811c8ce | 6056 | |
2131d850 | 6057 | _core_.WindowCreateEvent_swigregister(WindowCreateEvent) |
d14a1e28 RD |
6058 | |
6059 | class WindowDestroyEvent(CommandEvent): | |
5ba5649b | 6060 | """ |
943e8dfd RD |
6061 | The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor |
6062 | when the GUI window is destroyed. | |
6063 | ||
6064 | When a class derived from `wx.Window` is destroyed its destructor will | |
6065 | have already run by the time this event is sent. Therefore this event | |
6066 | will not usually be received at all by the window itself. Since it is | |
6067 | received after the destructor has run, an object should not try to | |
6068 | handle its own wx.WindowDestroyEvent, but it can be used to get | |
6069 | notification of the destruction of another window. | |
5ba5649b | 6070 | """ |
0085ce49 RD |
6071 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6072 | __repr__ = _swig_repr | |
6073 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6074 | """ |
6075 | __init__(self, Window win=None) -> WindowDestroyEvent | |
6076 | ||
943e8dfd RD |
6077 | The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor |
6078 | when the GUI window is destroyed. | |
6079 | ||
6080 | When a class derived from `wx.Window` is destroyed its destructor will | |
6081 | have already run by the time this event is sent. Therefore this event | |
6082 | will not usually be received at all by the window itself. Since it is | |
6083 | received after the destructor has run, an object should not try to | |
6084 | handle its own wx.WindowDestroyEvent, but it can be used to get | |
6085 | notification of the destruction of another window. | |
5ba5649b | 6086 | """ |
0085ce49 | 6087 | _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs)) |
e811c8ce | 6088 | def GetWindow(*args, **kwargs): |
5ba5649b RD |
6089 | """ |
6090 | GetWindow(self) -> Window | |
6091 | ||
6092 | Returns the window that this event refers to. | |
6093 | """ | |
54f9ee45 | 6094 | return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs) |
e811c8ce | 6095 | |
2131d850 | 6096 | _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent) |
d14a1e28 RD |
6097 | |
6098 | #--------------------------------------------------------------------------- | |
6099 | ||
6100 | class ContextMenuEvent(CommandEvent): | |
5ba5649b RD |
6101 | """ |
6102 | This class is used for context menu events (EVT_CONTECT_MENU,) sent to | |
6103 | give the application a chance to show a context (popup) menu. | |
6104 | """ | |
0085ce49 RD |
6105 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6106 | __repr__ = _swig_repr | |
6107 | def __init__(self, *args, **kwargs): | |
5ba5649b | 6108 | """ |
2131d850 | 6109 | __init__(self, EventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent |
5ba5649b RD |
6110 | |
6111 | Constructor. | |
6112 | """ | |
0085ce49 | 6113 | _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs)) |
e811c8ce | 6114 | def GetPosition(*args, **kwargs): |
5ba5649b RD |
6115 | """ |
6116 | GetPosition(self) -> Point | |
6117 | ||
6118 | Returns the position (in screen coordinants) at which the menu should | |
6119 | be shown. | |
6120 | """ | |
54f9ee45 | 6121 | return _core_.ContextMenuEvent_GetPosition(*args, **kwargs) |
e811c8ce RD |
6122 | |
6123 | def SetPosition(*args, **kwargs): | |
5ba5649b RD |
6124 | """ |
6125 | SetPosition(self, Point pos) | |
6126 | ||
6127 | Sets the position at which the menu should be shown. | |
6128 | """ | |
54f9ee45 | 6129 | return _core_.ContextMenuEvent_SetPosition(*args, **kwargs) |
e811c8ce | 6130 | |
2131d850 | 6131 | _core_.ContextMenuEvent_swigregister(ContextMenuEvent) |
d14a1e28 RD |
6132 | |
6133 | #--------------------------------------------------------------------------- | |
6134 | ||
54f9ee45 RD |
6135 | IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL |
6136 | IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED | |
d14a1e28 | 6137 | class IdleEvent(Event): |
5ba5649b RD |
6138 | """ |
6139 | This class is used for EVT_IDLE events, which are generated and sent | |
6140 | when the application *becomes* idle. In other words, the when the | |
6141 | event queue becomes empty then idle events are sent to all windows (by | |
6142 | default) and as long as none of them call `RequestMore` then there are | |
6143 | no more idle events until after the system event queue has some normal | |
6144 | events and then becomes empty again. | |
6145 | ||
6146 | By default, idle events are sent to all windows. If this is causing a | |
6147 | significant overhead in your application, you can call | |
6148 | `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and | |
6149 | set the wx.WS_EX_PROCESS_IDLE extra window style for every window | |
6150 | which should receive idle events. Then idle events will only be sent | |
6151 | to those windows and not to any others. | |
6152 | """ | |
0085ce49 RD |
6153 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6154 | __repr__ = _swig_repr | |
6155 | def __init__(self, *args, **kwargs): | |
5ba5649b RD |
6156 | """ |
6157 | __init__(self) -> IdleEvent | |
6158 | ||
6159 | Constructor | |
6160 | """ | |
0085ce49 | 6161 | _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs)) |
e811c8ce | 6162 | def RequestMore(*args, **kwargs): |
5ba5649b RD |
6163 | """ |
6164 | RequestMore(self, bool needMore=True) | |
6165 | ||
6166 | Tells wxWidgets that more processing is required. This function can be | |
6167 | called by an EVT_IDLE handler for a window to indicate that the | |
6168 | application should forward the EVT_IDLE event once more to the | |
6169 | application windows. If no window calls this function during its | |
6170 | EVT_IDLE handler, then the application will remain in a passive event | |
6171 | loop until a new event is posted to the application by the windowing | |
6172 | system. | |
6173 | """ | |
54f9ee45 | 6174 | return _core_.IdleEvent_RequestMore(*args, **kwargs) |
e811c8ce RD |
6175 | |
6176 | def MoreRequested(*args, **kwargs): | |
5ba5649b RD |
6177 | """ |
6178 | MoreRequested(self) -> bool | |
6179 | ||
6180 | Returns ``True`` if the OnIdle function processing this event | |
6181 | requested more processing time. | |
6182 | """ | |
54f9ee45 | 6183 | return _core_.IdleEvent_MoreRequested(*args, **kwargs) |
e811c8ce RD |
6184 | |
6185 | def SetMode(*args, **kwargs): | |
5ba5649b RD |
6186 | """ |
6187 | SetMode(int mode) | |
6188 | ||
6189 | Static method for specifying how wxWidgets will send idle events: to | |
6190 | all windows, or only to those which specify that they will process the | |
6191 | events. | |
6192 | ||
6193 | The mode can be one of the following values: | |
6194 | ||
6195 | ========================= ======================================== | |
6196 | wx.IDLE_PROCESS_ALL Send idle events to all windows | |
6197 | wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have | |
6198 | the wx.WS_EX_PROCESS_IDLE extra style | |
6199 | flag set. | |
6200 | ========================= ======================================== | |
6201 | ||
6202 | """ | |
54f9ee45 | 6203 | return _core_.IdleEvent_SetMode(*args, **kwargs) |
e811c8ce RD |
6204 | |
6205 | SetMode = staticmethod(SetMode) | |
6206 | def GetMode(*args, **kwargs): | |
5ba5649b RD |
6207 | """ |
6208 | GetMode() -> int | |
6209 | ||
6210 | Static method returning a value specifying how wxWidgets will send | |
6211 | idle events: to all windows, or only to those which specify that they | |
6212 | will process the events. | |
6213 | """ | |
54f9ee45 | 6214 | return _core_.IdleEvent_GetMode(*args, **kwargs) |
e811c8ce RD |
6215 | |
6216 | GetMode = staticmethod(GetMode) | |
6217 | def CanSend(*args, **kwargs): | |
5ba5649b RD |
6218 | """ |
6219 | CanSend(Window win) -> bool | |
6220 | ||
6221 | Returns ``True`` if it is appropriate to send idle events to this | |
6222 | window. | |
6223 | ||
6224 | This function looks at the mode used (see `wx.IdleEvent.SetMode`), and | |
6225 | the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle | |
6226 | events should be sent to this window now. By default this will always | |
6227 | return ``True`` because the update mode is initially | |
6228 | wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events | |
6229 | to windows with the wx.WS_EX_PROCESS_IDLE extra window style set. | |
6230 | """ | |
54f9ee45 | 6231 | return _core_.IdleEvent_CanSend(*args, **kwargs) |
e811c8ce RD |
6232 | |
6233 | CanSend = staticmethod(CanSend) | |
2131d850 | 6234 | _core_.IdleEvent_swigregister(IdleEvent) |
d14a1e28 | 6235 | |
e811c8ce | 6236 | def IdleEvent_SetMode(*args, **kwargs): |
0085ce49 | 6237 | """ |
5ba5649b RD |
6238 | IdleEvent_SetMode(int mode) |
6239 | ||
6240 | Static method for specifying how wxWidgets will send idle events: to | |
6241 | all windows, or only to those which specify that they will process the | |
6242 | events. | |
6243 | ||
6244 | The mode can be one of the following values: | |
6245 | ||
6246 | ========================= ======================================== | |
6247 | wx.IDLE_PROCESS_ALL Send idle events to all windows | |
6248 | wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have | |
6249 | the wx.WS_EX_PROCESS_IDLE extra style | |
6250 | flag set. | |
6251 | ========================= ======================================== | |
6252 | ||
6253 | """ | |
0085ce49 | 6254 | return _core_.IdleEvent_SetMode(*args, **kwargs) |
d14a1e28 | 6255 | |
0085ce49 RD |
6256 | def IdleEvent_GetMode(*args): |
6257 | """ | |
5ba5649b RD |
6258 | IdleEvent_GetMode() -> int |
6259 | ||
6260 | Static method returning a value specifying how wxWidgets will send | |
6261 | idle events: to all windows, or only to those which specify that they | |
6262 | will process the events. | |
6263 | """ | |
0085ce49 | 6264 | return _core_.IdleEvent_GetMode(*args) |
d14a1e28 | 6265 | |
e811c8ce | 6266 | def IdleEvent_CanSend(*args, **kwargs): |
0085ce49 | 6267 | """ |
5ba5649b RD |
6268 | IdleEvent_CanSend(Window win) -> bool |
6269 | ||
6270 | Returns ``True`` if it is appropriate to send idle events to this | |
6271 | window. | |
6272 | ||
6273 | This function looks at the mode used (see `wx.IdleEvent.SetMode`), and | |
6274 | the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle | |
6275 | events should be sent to this window now. By default this will always | |
6276 | return ``True`` because the update mode is initially | |
6277 | wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events | |
6278 | to windows with the wx.WS_EX_PROCESS_IDLE extra window style set. | |
6279 | """ | |
0085ce49 | 6280 | return _core_.IdleEvent_CanSend(*args, **kwargs) |
d14a1e28 RD |
6281 | |
6282 | #--------------------------------------------------------------------------- | |
6283 | ||
2131d850 RD |
6284 | class ClipboardTextEvent(CommandEvent): |
6285 | """ | |
6286 | A Clipboard Text event is sent when a window intercepts a text | |
6287 | copy/cut/paste message, i.e. the user has cut/copied/pasted data | |
6288 | from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a | |
6289 | popup menu command, etc. NOTE : under windows these events are *NOT* | |
6290 | generated automatically for a Rich Edit text control. | |
6291 | """ | |
6292 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') | |
6293 | __repr__ = _swig_repr | |
6294 | def __init__(self, *args, **kwargs): | |
6295 | """ | |
6296 | __init__(self, EventType type=wxEVT_NULL, int winid=0) -> ClipboardTextEvent | |
6297 | ||
6298 | A Clipboard Text event is sent when a window intercepts a text | |
6299 | copy/cut/paste message, i.e. the user has cut/copied/pasted data | |
6300 | from/into a text control via ctrl-C/X/V, ctrl/shift-del/insert, a | |
6301 | popup menu command, etc. NOTE : under windows these events are *NOT* | |
6302 | generated automatically for a Rich Edit text control. | |
6303 | """ | |
6304 | _core_.ClipboardTextEvent_swiginit(self,_core_.new_ClipboardTextEvent(*args, **kwargs)) | |
6305 | _core_.ClipboardTextEvent_swigregister(ClipboardTextEvent) | |
6306 | ||
6307 | #--------------------------------------------------------------------------- | |
6308 | ||
d14a1e28 | 6309 | class PyEvent(Event): |
5ba5649b RD |
6310 | """ |
6311 | wx.PyEvent can be used as a base class for implementing custom event | |
6312 | types in Python. You should derived from this class instead of | |
6313 | `wx.Event` because this class is Python-aware and is able to transport | |
6314 | its Python bits safely through the wxWidgets event system and have | |
6315 | them still be there when the event handler is invoked. | |
6316 | ||
6317 | :see: `wx.PyCommandEvent` | |
6318 | ||
6319 | """ | |
0085ce49 RD |
6320 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6321 | __repr__ = _swig_repr | |
6322 | def __init__(self, *args, **kwargs): | |
2131d850 | 6323 | """__init__(self, int winid=0, EventType eventType=wxEVT_NULL) -> PyEvent""" |
0085ce49 | 6324 | _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs)) |
5ba5649b | 6325 | self._SetSelf(self) |
e811c8ce | 6326 | |
0085ce49 RD |
6327 | __swig_destroy__ = _core_.delete_PyEvent |
6328 | __del__ = lambda self : None; | |
5ba5649b RD |
6329 | def _SetSelf(*args, **kwargs): |
6330 | """_SetSelf(self, PyObject self)""" | |
6331 | return _core_.PyEvent__SetSelf(*args, **kwargs) | |
e811c8ce | 6332 | |
5ba5649b RD |
6333 | def _GetSelf(*args, **kwargs): |
6334 | """_GetSelf(self) -> PyObject""" | |
6335 | return _core_.PyEvent__GetSelf(*args, **kwargs) | |
e811c8ce | 6336 | |
2131d850 | 6337 | _core_.PyEvent_swigregister(PyEvent) |
d14a1e28 RD |
6338 | |
6339 | class PyCommandEvent(CommandEvent): | |
5ba5649b RD |
6340 | """ |
6341 | wx.PyCommandEvent can be used as a base class for implementing custom | |
6342 | event types in Python, where the event shoudl travel up to parent | |
6343 | windows looking for a handler. You should derived from this class | |
6344 | instead of `wx.CommandEvent` because this class is Python-aware and is | |
6345 | able to transport its Python bits safely through the wxWidgets event | |
6346 | system and have them still be there when the event handler is invoked. | |
6347 | ||
6348 | :see: `wx.PyEvent` | |
6349 | ||
6350 | """ | |
0085ce49 RD |
6351 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6352 | __repr__ = _swig_repr | |
6353 | def __init__(self, *args, **kwargs): | |
2131d850 | 6354 | """__init__(self, EventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent""" |
0085ce49 | 6355 | _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs)) |
5ba5649b | 6356 | self._SetSelf(self) |
e811c8ce | 6357 | |
0085ce49 RD |
6358 | __swig_destroy__ = _core_.delete_PyCommandEvent |
6359 | __del__ = lambda self : None; | |
5ba5649b RD |
6360 | def _SetSelf(*args, **kwargs): |
6361 | """_SetSelf(self, PyObject self)""" | |
6362 | return _core_.PyCommandEvent__SetSelf(*args, **kwargs) | |
e811c8ce | 6363 | |
5ba5649b RD |
6364 | def _GetSelf(*args, **kwargs): |
6365 | """_GetSelf(self) -> PyObject""" | |
6366 | return _core_.PyCommandEvent__GetSelf(*args, **kwargs) | |
e811c8ce | 6367 | |
2131d850 | 6368 | _core_.PyCommandEvent_swigregister(PyCommandEvent) |
d14a1e28 | 6369 | |
53aa7709 | 6370 | class DateEvent(CommandEvent): |
5ba5649b RD |
6371 | """ |
6372 | This event class holds information about a date change event and is | |
6373 | used together with `wx.DatePickerCtrl`. It also serves as a base class | |
6374 | for `wx.calendar.CalendarEvent`. Bind these event types with | |
6375 | EVT_DATE_CHANGED. | |
6376 | """ | |
0085ce49 RD |
6377 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6378 | __repr__ = _swig_repr | |
6379 | def __init__(self, *args, **kwargs): | |
2131d850 | 6380 | """__init__(self, Window win, DateTime dt, EventType type) -> DateEvent""" |
0085ce49 | 6381 | _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs)) |
53aa7709 | 6382 | def GetDate(*args, **kwargs): |
5ba5649b RD |
6383 | """ |
6384 | GetDate(self) -> DateTime | |
6385 | ||
6386 | Returns the date. | |
6387 | """ | |
53aa7709 RD |
6388 | return _core_.DateEvent_GetDate(*args, **kwargs) |
6389 | ||
6390 | def SetDate(*args, **kwargs): | |
5ba5649b RD |
6391 | """ |
6392 | SetDate(self, DateTime date) | |
6393 | ||
6394 | Sets the date carried by the event, normally only used by the library | |
6395 | internally. | |
6396 | """ | |
53aa7709 RD |
6397 | return _core_.DateEvent_SetDate(*args, **kwargs) |
6398 | ||
2131d850 | 6399 | _core_.DateEvent_swigregister(DateEvent) |
53aa7709 RD |
6400 | |
6401 | wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED | |
6402 | EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 ) | |
6403 | ||
d14a1e28 RD |
6404 | #--------------------------------------------------------------------------- |
6405 | ||
54f9ee45 RD |
6406 | PYAPP_ASSERT_SUPPRESS = _core_.PYAPP_ASSERT_SUPPRESS |
6407 | PYAPP_ASSERT_EXCEPTION = _core_.PYAPP_ASSERT_EXCEPTION | |
6408 | PYAPP_ASSERT_DIALOG = _core_.PYAPP_ASSERT_DIALOG | |
6409 | PYAPP_ASSERT_LOG = _core_.PYAPP_ASSERT_LOG | |
6410 | PRINT_WINDOWS = _core_.PRINT_WINDOWS | |
6411 | PRINT_POSTSCRIPT = _core_.PRINT_POSTSCRIPT | |
d14a1e28 | 6412 | class PyApp(EvtHandler): |
66c033b4 RD |
6413 | """ |
6414 | The ``wx.PyApp`` class is an *implementation detail*, please use the | |
6415 | `wx.App` class (or some other derived class) instead. | |
6416 | """ | |
0085ce49 RD |
6417 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
6418 | __repr__ = _swig_repr | |
6419 | def __init__(self, *args, **kwargs): | |
98e665d3 | 6420 | """ |
a95a7133 | 6421 | __init__(self) -> PyApp |
98e665d3 RD |
6422 | |
6423 | Create a new application object, starting the bootstrap process. | |
6424 | """ | |
0085ce49 | 6425 | _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs)) |
70b7a5fe RD |
6426 | self._setCallbackInfo(self, PyApp, False) |
6427 | self._setOORInfo(self, False) | |
e811c8ce | 6428 | |
0085ce49 RD |
6429 | __swig_destroy__ = _core_.delete_PyApp |
6430 | __del__ = lambda self : None; | |
e811c8ce | 6431 | def _setCallbackInfo(*args, **kwargs): |
70b7a5fe | 6432 | """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)""" |
54f9ee45 | 6433 | return _core_.PyApp__setCallbackInfo(*args, **kwargs) |
e811c8ce RD |
6434 | |
6435 | def GetAppName(*args, **kwargs): | |
0df68c9f | 6436 | """ |
a95a7133 | 6437 | GetAppName(self) -> String |
6c3b4aae | 6438 | |
0df68c9f RD |
6439 | Get the application name. |
6440 | """ | |
54f9ee45 | 6441 | return _core_.PyApp_GetAppName(*args, **kwargs) |
e811c8ce RD |
6442 | |
6443 | def SetAppName(*args, **kwargs): | |
0df68c9f | 6444 | """ |
a95a7133 | 6445 | SetAppName(self, String name) |
6c3b4aae | 6446 | |
66c033b4 RD |
6447 | Set the application name. This value may be used automatically by |
6448 | `wx.Config` and such. | |
0df68c9f | 6449 | """ |
54f9ee45 | 6450 | return _core_.PyApp_SetAppName(*args, **kwargs) |
e811c8ce RD |
6451 | |
6452 | def GetClassName(*args, **kwargs): | |
0df68c9f | 6453 | """ |
a95a7133 | 6454 | GetClassName(self) -> String |
e811c8ce | 6455 | |
0df68c9f RD |
6456 | Get the application's class name. |
6457 | """ | |
54f9ee45 | 6458 | return _core_.PyApp_GetClassName(*args, **kwargs) |
e811c8ce RD |
6459 | |
6460 | def SetClassName(*args, **kwargs): | |
0df68c9f | 6461 | """ |
a95a7133 | 6462 | SetClassName(self, String name) |
6c3b4aae | 6463 | |
66c033b4 RD |
6464 | Set the application's class name. This value may be used for |
6465 | X-resources if applicable for the platform | |
0df68c9f | 6466 | """ |
54f9ee45 | 6467 | return _core_.PyApp_SetClassName(*args, **kwargs) |
e811c8ce RD |
6468 | |
6469 | def GetVendorName(*args, **kwargs): | |
0df68c9f | 6470 | """ |
a95a7133 | 6471 | GetVendorName(self) -> String |
6c3b4aae | 6472 | |
0df68c9f RD |
6473 | Get the application's vendor name. |
6474 | """ | |
54f9ee45 | 6475 | return _core_.PyApp_GetVendorName(*args, **kwargs) |
e811c8ce RD |
6476 | |
6477 | def SetVendorName(*args, **kwargs): | |
0df68c9f | 6478 | """ |
a95a7133 | 6479 | SetVendorName(self, String name) |
6c3b4aae | 6480 | |
66c033b4 RD |
6481 | Set the application's vendor name. This value may be used |
6482 | automatically by `wx.Config` and such. | |
0df68c9f | 6483 | """ |
54f9ee45 | 6484 | return _core_.PyApp_SetVendorName(*args, **kwargs) |
e811c8ce RD |
6485 | |
6486 | def GetTraits(*args, **kwargs): | |
0df68c9f | 6487 | """ |
a95a7133 | 6488 | GetTraits(self) -> wxAppTraits |
6c3b4aae | 6489 | |
66c033b4 RD |
6490 | Return (and create if necessary) the app traits object to which we |
6491 | delegate for everything which either should be configurable by the | |
6492 | user (then he can change the default behaviour simply by overriding | |
6493 | CreateTraits() and returning his own traits object) or which is | |
6494 | GUI/console dependent as then wx.AppTraits allows us to abstract the | |
6495 | differences behind the common facade. | |
6496 | ||
6497 | :todo: Add support for overriding CreateAppTraits in wxPython. | |
0df68c9f | 6498 | """ |
54f9ee45 | 6499 | return _core_.PyApp_GetTraits(*args, **kwargs) |
e811c8ce RD |
6500 | |
6501 | def ProcessPendingEvents(*args, **kwargs): | |
0df68c9f | 6502 | """ |
a95a7133 | 6503 | ProcessPendingEvents(self) |
6c3b4aae | 6504 | |
66c033b4 RD |
6505 | Process all events in the Pending Events list -- it is necessary to |
6506 | call this function to process posted events. This normally happens | |
6507 | during each event loop iteration. | |
0df68c9f | 6508 | """ |
54f9ee45 | 6509 | return _core_.PyApp_ProcessPendingEvents(*args, **kwargs) |
e811c8ce RD |
6510 | |
6511 | def Yield(*args, **kwargs): | |
0df68c9f | 6512 | """ |
a95a7133 | 6513 | Yield(self, bool onlyIfNeeded=False) -> bool |
6c3b4aae | 6514 | |
66c033b4 RD |
6515 | Process all currently pending events right now, instead of waiting |
6516 | until return to the event loop. It is an error to call ``Yield`` | |
6517 | recursively unless the value of ``onlyIfNeeded`` is True. | |
6c3b4aae | 6518 | |
66c033b4 | 6519 | :warning: This function is dangerous as it can lead to unexpected |
41e2b43e RD |
6520 | reentrancies (i.e. when called from an event handler it may |
6521 | result in calling the same event handler again), use with | |
6522 | extreme care or, better, don't use at all! | |
0df68c9f | 6523 | |
66c033b4 | 6524 | :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield` |
41e2b43e | 6525 | |
0df68c9f | 6526 | """ |
54f9ee45 | 6527 | return _core_.PyApp_Yield(*args, **kwargs) |
e811c8ce RD |
6528 | |
6529 | def WakeUpIdle(*args, **kwargs): | |
0df68c9f | 6530 | """ |
a95a7133 | 6531 | WakeUpIdle(self) |
6c3b4aae | 6532 | |
66c033b4 RD |
6533 | Make sure that idle events are sent again. |
6534 | :see: `wx.WakeUpIdle` | |
0df68c9f | 6535 | """ |
54f9ee45 | 6536 | return _core_.PyApp_WakeUpIdle(*args, **kwargs) |
e811c8ce | 6537 | |
1fc3b23a RD |
6538 | def IsMainLoopRunning(*args, **kwargs): |
6539 | """ | |
6540 | IsMainLoopRunning() -> bool | |
6541 | ||
6542 | Returns True if we're running the main loop, i.e. if the events can | |
6543 | currently be dispatched. | |
6544 | """ | |
6545 | return _core_.PyApp_IsMainLoopRunning(*args, **kwargs) | |
6546 | ||
6547 | IsMainLoopRunning = staticmethod(IsMainLoopRunning) | |
e811c8ce | 6548 | def MainLoop(*args, **kwargs): |
0df68c9f | 6549 | """ |
a95a7133 | 6550 | MainLoop(self) -> int |
6c3b4aae | 6551 | |
66c033b4 RD |
6552 | Execute the main GUI loop, the function doesn't normally return until |
6553 | all top level windows have been closed and destroyed. | |
0df68c9f | 6554 | """ |
54f9ee45 | 6555 | return _core_.PyApp_MainLoop(*args, **kwargs) |
e811c8ce RD |
6556 | |
6557 | def Exit(*args, **kwargs): | |
0df68c9f | 6558 | """ |
a95a7133 | 6559 | Exit(self) |
6c3b4aae | 6560 | |
0df68c9f | 6561 | Exit the main loop thus terminating the application. |
66c033b4 | 6562 | :see: `wx.Exit` |
0df68c9f | 6563 | """ |
54f9ee45 | 6564 | return _core_.PyApp_Exit(*args, **kwargs) |
e811c8ce RD |
6565 | |
6566 | def ExitMainLoop(*args, **kwargs): | |
0df68c9f | 6567 | """ |
a95a7133 | 6568 | ExitMainLoop(self) |
6c3b4aae | 6569 | |
66c033b4 RD |
6570 | Exit the main GUI loop during the next iteration of the main |
6571 | loop, (i.e. it does not stop the program immediately!) | |
0df68c9f | 6572 | """ |
54f9ee45 | 6573 | return _core_.PyApp_ExitMainLoop(*args, **kwargs) |
e811c8ce RD |
6574 | |
6575 | def Pending(*args, **kwargs): | |
0df68c9f | 6576 | """ |
a95a7133 | 6577 | Pending(self) -> bool |
6c3b4aae | 6578 | |
0df68c9f RD |
6579 | Returns True if there are unprocessed events in the event queue. |
6580 | """ | |
54f9ee45 | 6581 | return _core_.PyApp_Pending(*args, **kwargs) |
e811c8ce RD |
6582 | |
6583 | def Dispatch(*args, **kwargs): | |
0df68c9f | 6584 | """ |
a95a7133 | 6585 | Dispatch(self) -> bool |
6c3b4aae | 6586 | |
0df68c9f RD |
6587 | Process the first event in the event queue (blocks until an event |
6588 | appears if there are none currently) | |
6589 | """ | |
54f9ee45 | 6590 | return _core_.PyApp_Dispatch(*args, **kwargs) |
e811c8ce RD |
6591 | |
6592 | def ProcessIdle(*args, **kwargs): | |
0df68c9f | 6593 | """ |
a95a7133 | 6594 | ProcessIdle(self) -> bool |
6c3b4aae | 6595 | |
66c033b4 RD |
6596 | Called from the MainLoop when the application becomes idle (there are |
6597 | no pending events) and sends a `wx.IdleEvent` to all interested | |
6598 | parties. Returns True if more idle events are needed, False if not. | |
0df68c9f | 6599 | """ |
54f9ee45 | 6600 | return _core_.PyApp_ProcessIdle(*args, **kwargs) |
e811c8ce RD |
6601 | |
6602 | def SendIdleEvents(*args, **kwargs): | |
0df68c9f | 6603 | """ |
a95a7133 | 6604 | SendIdleEvents(self, Window win, IdleEvent event) -> bool |
e811c8ce | 6605 | |
66c033b4 RD |
6606 | Send idle event to window and all subwindows. Returns True if more |
6607 | idle time is requested. | |
0df68c9f | 6608 | """ |
54f9ee45 | 6609 | return _core_.PyApp_SendIdleEvents(*args, **kwargs) |
e811c8ce RD |
6610 | |
6611 | def IsActive(*args, **kwargs): | |
0df68c9f | 6612 | """ |
a95a7133 | 6613 | IsActive(self) -> bool |
6c3b4aae | 6614 | |
0df68c9f RD |
6615 | Return True if our app has focus. |
6616 | """ | |
54f9ee45 | 6617 | return _core_.PyApp_IsActive(*args, **kwargs) |
e811c8ce RD |
6618 | |
6619 | def SetTopWindow(*args, **kwargs): | |
0df68c9f | 6620 | """ |
a95a7133 | 6621 | SetTopWindow(self, Window win) |
6c3b4aae | 6622 | |
66c033b4 | 6623 | Set the *main* top level window |
0df68c9f | 6624 | """ |
54f9ee45 | 6625 | return _core_.PyApp_SetTopWindow(*args, **kwargs) |
e811c8ce RD |
6626 | |
6627 | def GetTopWindow(*args, **kwargs): | |
0df68c9f | 6628 | """ |
a95a7133 | 6629 | GetTopWindow(self) -> Window |
6c3b4aae | 6630 | |
66c033b4 RD |
6631 | Return the *main* top level window (if it hadn't been set previously |
6632 | with SetTopWindow(), will return just some top level window and, if | |
6633 | there not any, will return None) | |
0df68c9f | 6634 | """ |
54f9ee45 | 6635 | return _core_.PyApp_GetTopWindow(*args, **kwargs) |
e811c8ce RD |
6636 | |
6637 | def SetExitOnFrameDelete(*args, **kwargs): | |
0df68c9f | 6638 | """ |
a95a7133 | 6639 | SetExitOnFrameDelete(self, bool flag) |
0df68c9f | 6640 | |
66c033b4 RD |
6641 | Control the exit behaviour: by default, the program will exit the main |
6642 | loop (and so, usually, terminate) when the last top-level program | |
6643 | window is deleted. Beware that if you disable this behaviour (with | |
6644 | SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop() | |
6645 | explicitly from somewhere. | |
0df68c9f | 6646 | """ |
54f9ee45 | 6647 | return _core_.PyApp_SetExitOnFrameDelete(*args, **kwargs) |
e811c8ce RD |
6648 | |
6649 | def GetExitOnFrameDelete(*args, **kwargs): | |
0df68c9f | 6650 | """ |
a95a7133 | 6651 | GetExitOnFrameDelete(self) -> bool |
6c3b4aae | 6652 | |
0df68c9f RD |
6653 | Get the current exit behaviour setting. |
6654 | """ | |
54f9ee45 | 6655 | return _core_.PyApp_GetExitOnFrameDelete(*args, **kwargs) |
e811c8ce RD |
6656 | |
6657 | def SetUseBestVisual(*args, **kwargs): | |
0df68c9f | 6658 | """ |
a95a7133 | 6659 | SetUseBestVisual(self, bool flag) |
6c3b4aae | 6660 | |
66c033b4 RD |
6661 | Set whether the app should try to use the best available visual on |
6662 | systems where more than one is available, (Sun, SGI, XFree86 4, etc.) | |
0df68c9f | 6663 | """ |
54f9ee45 | 6664 | return _core_.PyApp_SetUseBestVisual(*args, **kwargs) |
e811c8ce RD |
6665 | |
6666 | def GetUseBestVisual(*args, **kwargs): | |
0df68c9f | 6667 | """ |
a95a7133 | 6668 | GetUseBestVisual(self) -> bool |
6c3b4aae | 6669 | |
0df68c9f RD |
6670 | Get current UseBestVisual setting. |
6671 | """ | |
54f9ee45 | 6672 | return _core_.PyApp_GetUseBestVisual(*args, **kwargs) |
e811c8ce RD |
6673 | |
6674 | def SetPrintMode(*args, **kwargs): | |
a95a7133 | 6675 | """SetPrintMode(self, int mode)""" |
54f9ee45 | 6676 | return _core_.PyApp_SetPrintMode(*args, **kwargs) |
e811c8ce RD |
6677 | |
6678 | def GetPrintMode(*args, **kwargs): | |
a95a7133 | 6679 | """GetPrintMode(self) -> int""" |
54f9ee45 | 6680 | return _core_.PyApp_GetPrintMode(*args, **kwargs) |
e811c8ce | 6681 | |
e811c8ce | 6682 | def SetAssertMode(*args, **kwargs): |
0df68c9f | 6683 | """ |
a95a7133 | 6684 | SetAssertMode(self, int mode) |
6c3b4aae | 6685 | |
41e2b43e | 6686 | Set the OnAssert behaviour for debug and hybrid builds. |
0df68c9f | 6687 | """ |
54f9ee45 | 6688 | return _core_.PyApp_SetAssertMode(*args, **kwargs) |
e811c8ce | 6689 | |
6c3b4aae | 6690 | def GetAssertMode(*args, **kwargs): |
0df68c9f | 6691 | """ |
a95a7133 | 6692 | GetAssertMode(self) -> int |
6c3b4aae | 6693 | |
0df68c9f RD |
6694 | Get the current OnAssert behaviour setting. |
6695 | """ | |
54f9ee45 | 6696 | return _core_.PyApp_GetAssertMode(*args, **kwargs) |
6c3b4aae | 6697 | |
e811c8ce | 6698 | def GetMacSupportPCMenuShortcuts(*args, **kwargs): |
66c033b4 | 6699 | """GetMacSupportPCMenuShortcuts() -> bool""" |
54f9ee45 | 6700 | return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs) |
e811c8ce RD |
6701 | |
6702 | GetMacSupportPCMenuShortcuts = staticmethod(GetMacSupportPCMenuShortcuts) | |
6703 | def GetMacAboutMenuItemId(*args, **kwargs): | |
66c033b4 | 6704 | """GetMacAboutMenuItemId() -> long""" |
54f9ee45 | 6705 | return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs) |
e811c8ce RD |
6706 | |
6707 | GetMacAboutMenuItemId = staticmethod(GetMacAboutMenuItemId) | |
6708 | def GetMacPreferencesMenuItemId(*args, **kwargs): | |
66c033b4 | 6709 | """GetMacPreferencesMenuItemId() -> long""" |
54f9ee45 | 6710 | return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs) |
e811c8ce RD |
6711 | |
6712 | GetMacPreferencesMenuItemId = staticmethod(GetMacPreferencesMenuItemId) | |
6713 | def GetMacExitMenuItemId(*args, **kwargs): | |
66c033b4 | 6714 | """GetMacExitMenuItemId() -> long""" |
54f9ee45 | 6715 | return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs) |
e811c8ce RD |
6716 | |
6717 | GetMacExitMenuItemId = staticmethod(GetMacExitMenuItemId) | |
6718 | def GetMacHelpMenuTitleName(*args, **kwargs): | |
66c033b4 | 6719 | """GetMacHelpMenuTitleName() -> String""" |
54f9ee45 | 6720 | return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs) |
e811c8ce RD |
6721 | |
6722 | GetMacHelpMenuTitleName = staticmethod(GetMacHelpMenuTitleName) | |
6723 | def SetMacSupportPCMenuShortcuts(*args, **kwargs): | |
66c033b4 | 6724 | """SetMacSupportPCMenuShortcuts(bool val)""" |
54f9ee45 | 6725 | return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs) |
e811c8ce RD |
6726 | |
6727 | SetMacSupportPCMenuShortcuts = staticmethod(SetMacSupportPCMenuShortcuts) | |
6728 | def SetMacAboutMenuItemId(*args, **kwargs): | |
66c033b4 | 6729 | """SetMacAboutMenuItemId(long val)""" |
54f9ee45 | 6730 | return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs) |
e811c8ce RD |
6731 | |
6732 | SetMacAboutMenuItemId = staticmethod(SetMacAboutMenuItemId) | |
6733 | def SetMacPreferencesMenuItemId(*args, **kwargs): | |
66c033b4 | 6734 | """SetMacPreferencesMenuItemId(long val)""" |
54f9ee45 | 6735 | return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs) |
e811c8ce RD |
6736 | |
6737 | SetMacPreferencesMenuItemId = staticmethod(SetMacPreferencesMenuItemId) | |
6738 | def SetMacExitMenuItemId(*args, **kwargs): | |
66c033b4 | 6739 | """SetMacExitMenuItemId(long val)""" |
54f9ee45 | 6740 | return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs) |
e811c8ce RD |
6741 | |
6742 | SetMacExitMenuItemId = staticmethod(SetMacExitMenuItemId) | |
6743 | def SetMacHelpMenuTitleName(*args, **kwargs): | |
66c033b4 | 6744 | """SetMacHelpMenuTitleName(String val)""" |
54f9ee45 | 6745 | return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs) |
e811c8ce RD |
6746 | |
6747 | SetMacHelpMenuTitleName = staticmethod(SetMacHelpMenuTitleName) | |
6748 | def _BootstrapApp(*args, **kwargs): | |
0df68c9f | 6749 | """ |
a95a7133 | 6750 | _BootstrapApp(self) |
6c3b4aae | 6751 | |
0df68c9f RD |
6752 | For internal use only |
6753 | """ | |
54f9ee45 | 6754 | return _core_.PyApp__BootstrapApp(*args, **kwargs) |
e811c8ce RD |
6755 | |
6756 | def GetComCtl32Version(*args, **kwargs): | |
0df68c9f | 6757 | """ |
66c033b4 | 6758 | GetComCtl32Version() -> int |
6c3b4aae | 6759 | |
66c033b4 RD |
6760 | Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if |
6761 | it wasn't found at all. Raises an exception on non-Windows platforms. | |
0df68c9f | 6762 | """ |
54f9ee45 | 6763 | return _core_.PyApp_GetComCtl32Version(*args, **kwargs) |
e811c8ce RD |
6764 | |
6765 | GetComCtl32Version = staticmethod(GetComCtl32Version) | |
2131d850 | 6766 | _core_.PyApp_swigregister(PyApp) |
d14a1e28 | 6767 | |
0085ce49 RD |
6768 | def PyApp_IsMainLoopRunning(*args): |
6769 | """ | |
1fc3b23a RD |
6770 | PyApp_IsMainLoopRunning() -> bool |
6771 | ||
6772 | Returns True if we're running the main loop, i.e. if the events can | |
6773 | currently be dispatched. | |
6774 | """ | |
0085ce49 | 6775 | return _core_.PyApp_IsMainLoopRunning(*args) |
1fc3b23a | 6776 | |
0085ce49 RD |
6777 | def PyApp_GetMacSupportPCMenuShortcuts(*args): |
6778 | """PyApp_GetMacSupportPCMenuShortcuts() -> bool""" | |
6779 | return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args) | |
d14a1e28 | 6780 | |
0085ce49 RD |
6781 | def PyApp_GetMacAboutMenuItemId(*args): |
6782 | """PyApp_GetMacAboutMenuItemId() -> long""" | |
6783 | return _core_.PyApp_GetMacAboutMenuItemId(*args) | |
d14a1e28 | 6784 | |
0085ce49 RD |
6785 | def PyApp_GetMacPreferencesMenuItemId(*args): |
6786 | """PyApp_GetMacPreferencesMenuItemId() -> long""" | |
6787 | return _core_.PyApp_GetMacPreferencesMenuItemId(*args) | |
d14a1e28 | 6788 | |
0085ce49 RD |
6789 | def PyApp_GetMacExitMenuItemId(*args): |
6790 | """PyApp_GetMacExitMenuItemId() -> long""" | |
6791 | return _core_.PyApp_GetMacExitMenuItemId(*args) | |
d14a1e28 | 6792 | |
0085ce49 RD |
6793 | def PyApp_GetMacHelpMenuTitleName(*args): |
6794 | """PyApp_GetMacHelpMenuTitleName() -> String""" | |
6795 | return _core_.PyApp_GetMacHelpMenuTitleName(*args) | |
d14a1e28 | 6796 | |
e811c8ce | 6797 | def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs): |
0085ce49 RD |
6798 | """PyApp_SetMacSupportPCMenuShortcuts(bool val)""" |
6799 | return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs) | |
d14a1e28 | 6800 | |
e811c8ce | 6801 | def PyApp_SetMacAboutMenuItemId(*args, **kwargs): |
0085ce49 RD |
6802 | """PyApp_SetMacAboutMenuItemId(long val)""" |
6803 | return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs) | |
d14a1e28 | 6804 | |
e811c8ce | 6805 | def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs): |
0085ce49 RD |
6806 | """PyApp_SetMacPreferencesMenuItemId(long val)""" |
6807 | return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs) | |
d14a1e28 | 6808 | |
e811c8ce | 6809 | def PyApp_SetMacExitMenuItemId(*args, **kwargs): |
0085ce49 RD |
6810 | """PyApp_SetMacExitMenuItemId(long val)""" |
6811 | return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs) | |
d14a1e28 | 6812 | |
e811c8ce | 6813 | def PyApp_SetMacHelpMenuTitleName(*args, **kwargs): |
0085ce49 RD |
6814 | """PyApp_SetMacHelpMenuTitleName(String val)""" |
6815 | return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs) | |
d14a1e28 | 6816 | |
0085ce49 RD |
6817 | def PyApp_GetComCtl32Version(*args): |
6818 | """ | |
0df68c9f | 6819 | PyApp_GetComCtl32Version() -> int |
6c3b4aae | 6820 | |
66c033b4 RD |
6821 | Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if |
6822 | it wasn't found at all. Raises an exception on non-Windows platforms. | |
0df68c9f | 6823 | """ |
0085ce49 | 6824 | return _core_.PyApp_GetComCtl32Version(*args) |
d14a1e28 RD |
6825 | |
6826 | #--------------------------------------------------------------------------- | |
6827 | ||
6828 | ||
0085ce49 RD |
6829 | def Exit(*args): |
6830 | """ | |
0df68c9f | 6831 | Exit() |
6c3b4aae | 6832 | |
0df68c9f RD |
6833 | Force an exit of the application. Convenience for wx.GetApp().Exit() |
6834 | """ | |
0085ce49 | 6835 | return _core_.Exit(*args) |
d14a1e28 | 6836 | |
0085ce49 RD |
6837 | def Yield(*args): |
6838 | """ | |
0df68c9f | 6839 | Yield() -> bool |
6c3b4aae | 6840 | |
0df68c9f RD |
6841 | Yield to other apps/messages. Convenience for wx.GetApp().Yield() |
6842 | """ | |
0085ce49 | 6843 | return _core_.Yield(*args) |
d14a1e28 | 6844 | |
0085ce49 RD |
6845 | def YieldIfNeeded(*args): |
6846 | """ | |
0df68c9f | 6847 | YieldIfNeeded() -> bool |
6c3b4aae | 6848 | |
0df68c9f RD |
6849 | Yield to other apps/messages. Convenience for wx.GetApp().Yield(True) |
6850 | """ | |
0085ce49 | 6851 | return _core_.YieldIfNeeded(*args) |
d14a1e28 | 6852 | |
e811c8ce | 6853 | def SafeYield(*args, **kwargs): |
0085ce49 | 6854 | """ |
0df68c9f | 6855 | SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool |
6c3b4aae | 6856 | |
66c033b4 RD |
6857 | This function is similar to `wx.Yield`, except that it disables the |
6858 | user input to all program windows before calling `wx.Yield` and | |
6859 | re-enables it again afterwards. If ``win`` is not None, this window | |
6860 | will remain enabled, allowing the implementation of some limited user | |
6861 | interaction. | |
6c3b4aae | 6862 | |
66c033b4 | 6863 | :Returns: the result of the call to `wx.Yield`. |
0df68c9f | 6864 | """ |
0085ce49 | 6865 | return _core_.SafeYield(*args, **kwargs) |
d14a1e28 | 6866 | |
0085ce49 RD |
6867 | def WakeUpIdle(*args): |
6868 | """ | |
0df68c9f | 6869 | WakeUpIdle() |
6c3b4aae | 6870 | |
66c033b4 RD |
6871 | Cause the message queue to become empty again, so idle events will be |
6872 | sent. | |
0df68c9f | 6873 | """ |
0085ce49 | 6874 | return _core_.WakeUpIdle(*args) |
d14a1e28 | 6875 | |
e811c8ce | 6876 | def PostEvent(*args, **kwargs): |
0085ce49 | 6877 | """ |
0df68c9f | 6878 | PostEvent(EvtHandler dest, Event event) |
6c3b4aae | 6879 | |
66c033b4 RD |
6880 | Send an event to a window or other wx.EvtHandler to be processed |
6881 | later. | |
0df68c9f | 6882 | """ |
0085ce49 | 6883 | return _core_.PostEvent(*args, **kwargs) |
d14a1e28 | 6884 | |
0085ce49 RD |
6885 | def App_CleanUp(*args): |
6886 | """ | |
0df68c9f | 6887 | App_CleanUp() |
6c3b4aae | 6888 | |
41e2b43e | 6889 | For internal use only, it is used to cleanup after wxWidgets when |
66c033b4 | 6890 | Python shuts down. |
0df68c9f | 6891 | """ |
0085ce49 | 6892 | return _core_.App_CleanUp(*args) |
d14a1e28 | 6893 | |
0085ce49 RD |
6894 | def GetApp(*args): |
6895 | """ | |
0df68c9f | 6896 | GetApp() -> PyApp |
6c3b4aae | 6897 | |
196addbf | 6898 | Return a reference to the current wx.App object. |
0df68c9f | 6899 | """ |
0085ce49 | 6900 | return _core_.GetApp(*args) |
5cbf236d RD |
6901 | |
6902 | def SetDefaultPyEncoding(*args, **kwargs): | |
0085ce49 | 6903 | """ |
5cbf236d RD |
6904 | SetDefaultPyEncoding(string encoding) |
6905 | ||
6906 | Sets the encoding that wxPython will use when it needs to convert a | |
6907 | Python string or unicode object to or from a wxString. | |
e505d15e RD |
6908 | |
6909 | The default encoding is the value of ``locale.getdefaultlocale()[1]`` | |
6910 | but please be aware that the default encoding within the same locale | |
6911 | may be slightly different on different platforms. For example, please | |
6912 | see http://www.alanwood.net/demos/charsetdiffs.html for differences | |
6913 | between the common latin/roman encodings. | |
5cbf236d | 6914 | """ |
0085ce49 | 6915 | return _core_.SetDefaultPyEncoding(*args, **kwargs) |
5cbf236d | 6916 | |
0085ce49 RD |
6917 | def GetDefaultPyEncoding(*args): |
6918 | """ | |
5cbf236d RD |
6919 | GetDefaultPyEncoding() -> string |
6920 | ||
6921 | Gets the current encoding that wxPython will use when it needs to | |
6922 | convert a Python string or unicode object to or from a wxString. | |
6923 | """ | |
0085ce49 | 6924 | return _core_.GetDefaultPyEncoding(*args) |
d14a1e28 RD |
6925 | #---------------------------------------------------------------------- |
6926 | ||
6927 | class PyOnDemandOutputWindow: | |
6c3b4aae RD |
6928 | """ |
6929 | A class that can be used for redirecting Python's stdout and | |
6930 | stderr streams. It will do nothing until something is wrriten to | |
6931 | the stream at which point it will create a Frame with a text area | |
6932 | and write the text there. | |
6933 | """ | |
d14a1e28 RD |
6934 | def __init__(self, title = "wxPython: stdout/stderr"): |
6935 | self.frame = None | |
6936 | self.title = title | |
412d302d RD |
6937 | self.pos = wx.DefaultPosition |
6938 | self.size = (450, 300) | |
d14a1e28 RD |
6939 | self.parent = None |
6940 | ||
6941 | def SetParent(self, parent): | |
6c3b4aae | 6942 | """Set the window to be used as the popup Frame's parent.""" |
d14a1e28 RD |
6943 | self.parent = parent |
6944 | ||
6c3b4aae RD |
6945 | |
6946 | def CreateOutputWindow(self, st): | |
412d302d RD |
6947 | self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size, |
6948 | style=wx.DEFAULT_FRAME_STYLE) | |
196addbf | 6949 | self.text = wx.TextCtrl(self.frame, -1, "", |
412d302d | 6950 | style=wx.TE_MULTILINE|wx.TE_READONLY) |
d1e20054 | 6951 | self.text.AppendText(st) |
6c3b4aae | 6952 | self.frame.Show(True) |
2131d850 | 6953 | self.frame.Bind(wx.EVT_CLOSE, self.OnCloseWindow) |
6c3b4aae | 6954 | |
d14a1e28 | 6955 | |
7409c0c6 RD |
6956 | def OnCloseWindow(self, event): |
6957 | if self.frame is not None: | |
6958 | self.frame.Destroy() | |
6959 | self.frame = None | |
6960 | self.text = None | |
6961 | ||
6962 | ||
d14a1e28 | 6963 | # These methods provide the file-like output behaviour. |
6c3b4aae RD |
6964 | def write(self, text): |
6965 | """ | |
6966 | Create the output window if needed and write the string to it. | |
6967 | If not called in the context of the gui thread then uses | |
6968 | CallAfter to do the work there. | |
6969 | """ | |
6970 | if self.frame is None: | |
6971 | if not wx.Thread_IsMain(): | |
6972 | wx.CallAfter(self.CreateOutputWindow, text) | |
6973 | else: | |
6974 | self.CreateOutputWindow(text) | |
6975 | else: | |
6976 | if not wx.Thread_IsMain(): | |
6977 | wx.CallAfter(self.text.AppendText, text) | |
6978 | else: | |
6979 | self.text.AppendText(text) | |
6980 | ||
d14a1e28 RD |
6981 | |
6982 | def close(self): | |
6c3b4aae RD |
6983 | if self.frame is not None: |
6984 | wx.CallAfter(self.frame.Close) | |
6985 | ||
d14a1e28 | 6986 | |
19272049 RD |
6987 | def flush(self): |
6988 | pass | |
6989 | ||
6990 | ||
d14a1e28 RD |
6991 | |
6992 | #---------------------------------------------------------------------- | |
d14a1e28 RD |
6993 | |
6994 | _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__') | |
6995 | ||
6996 | class App(wx.PyApp): | |
6c3b4aae | 6997 | """ |
66c033b4 RD |
6998 | The ``wx.App`` class represents the application and is used to: |
6999 | ||
7000 | * bootstrap the wxPython system and initialize the underlying | |
7001 | gui toolkit | |
7002 | * set and get application-wide properties | |
7003 | * implement the windowing system main message or event loop, | |
7004 | and to dispatch events to window instances | |
7005 | * etc. | |
7006 | ||
7007 | Every application must have a ``wx.App`` instance, and all | |
7008 | creation of UI objects should be delayed until after the | |
03e37cd5 RD |
7009 | ``wx.App`` object has been created in order to ensure that the gui |
7010 | platform and wxWidgets have been fully initialized. | |
66c033b4 RD |
7011 | |
7012 | Normally you would derive from this class and implement an | |
7013 | ``OnInit`` method that creates a frame and then calls | |
7014 | ``self.SetTopWindow(frame)``. | |
7015 | ||
03e37cd5 | 7016 | :see: `wx.PySimpleApp` for a simpler app class that can be used |
1c0f361b | 7017 | directly. |
6c3b4aae | 7018 | """ |
66c033b4 | 7019 | |
d14a1e28 RD |
7020 | outputWindowClass = PyOnDemandOutputWindow |
7021 | ||
03e37cd5 RD |
7022 | def __init__(self, redirect=_defRedirect, filename=None, |
7023 | useBestVisual=False, clearSigInt=True): | |
66c033b4 RD |
7024 | """ |
7025 | Construct a ``wx.App`` object. | |
7026 | ||
03e37cd5 RD |
7027 | :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be |
7028 | redirected? Defaults to True on Windows and Mac, False | |
7029 | otherwise. If `filename` is None then output will be | |
7030 | redirected to a window that pops up as needed. (You can | |
7031 | control what kind of window is created for the output by | |
7032 | resetting the class variable ``outputWindowClass`` to a | |
7033 | class of your choosing.) | |
66c033b4 | 7034 | |
03e37cd5 RD |
7035 | :param filename: The name of a file to redirect output to, if |
7036 | redirect is True. | |
66c033b4 RD |
7037 | |
7038 | :param useBestVisual: Should the app try to use the best | |
03e37cd5 RD |
7039 | available visual provided by the system (only relevant on |
7040 | systems that have more than one visual.) This parameter | |
7041 | must be used instead of calling `SetUseBestVisual` later | |
7042 | on because it must be set before the underlying GUI | |
7043 | toolkit is initialized. | |
7044 | ||
7045 | :param clearSigInt: Should SIGINT be cleared? This allows the | |
7046 | app to terminate upon a Ctrl-C in the console like other | |
7047 | GUI apps will. | |
66c033b4 RD |
7048 | |
7049 | :note: You should override OnInit to do applicaition | |
7050 | initialization to ensure that the system, toolkit and | |
7051 | wxWidgets are fully initialized. | |
7052 | """ | |
d14a1e28 RD |
7053 | wx.PyApp.__init__(self) |
7054 | ||
7055 | if wx.Platform == "__WXMAC__": | |
7056 | try: | |
7057 | import MacOS | |
7058 | if not MacOS.WMAvailable(): | |
7059 | print """\ | |
7060 | This program needs access to the screen. Please run with 'pythonw', | |
7061 | not 'python', and only when you are logged in on the main display of | |
7062 | your Mac.""" | |
7063 | _sys.exit(1) | |
36cadbf7 RD |
7064 | except SystemExit: |
7065 | raise | |
d14a1e28 RD |
7066 | except: |
7067 | pass | |
7068 | ||
7069 | # This has to be done before OnInit | |
7070 | self.SetUseBestVisual(useBestVisual) | |
7071 | ||
7072 | # Set the default handler for SIGINT. This fixes a problem | |
7073 | # where if Ctrl-C is pressed in the console that started this | |
7074 | # app then it will not appear to do anything, (not even send | |
7075 | # KeyboardInterrupt???) but will later segfault on exit. By | |
7076 | # setting the default handler then the app will exit, as | |
7077 | # expected (depending on platform.) | |
03e37cd5 RD |
7078 | if clearSigInt: |
7079 | try: | |
7080 | import signal | |
7081 | signal.signal(signal.SIGINT, signal.SIG_DFL) | |
7082 | except: | |
7083 | pass | |
d14a1e28 RD |
7084 | |
7085 | # Save and redirect the stdio to a window? | |
7086 | self.stdioWin = None | |
7087 | self.saveStdio = (_sys.stdout, _sys.stderr) | |
7088 | if redirect: | |
7089 | self.RedirectStdio(filename) | |
7090 | ||
8fb0e70a RD |
7091 | # Use Python's install prefix as the default |
7092 | wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix) | |
7093 | ||
d14a1e28 RD |
7094 | # This finishes the initialization of wxWindows and then calls |
7095 | # the OnInit that should be present in the derived class | |
7096 | self._BootstrapApp() | |
7097 | ||
7098 | ||
01f6b6d3 RD |
7099 | def OnPreInit(self): |
7100 | """ | |
7101 | Things that must be done after _BootstrapApp has done its | |
7102 | thing, but would be nice if they were already done by the time | |
7103 | that OnInit is called. | |
7104 | """ | |
7105 | wx.StockGDI._initStockObjects() | |
7106 | ||
7107 | ||
02b455f2 RD |
7108 | def __del__(self, destroy=wx.PyApp.__del__): |
7109 | self.RestoreStdio() # Just in case the MainLoop was overridden | |
7110 | destroy(self) | |
d14a1e28 | 7111 | |
70b7a5fe RD |
7112 | def Destroy(self): |
7113 | wx.PyApp.Destroy(self) | |
7114 | self.thisown = 0 | |
d14a1e28 RD |
7115 | |
7116 | def SetTopWindow(self, frame): | |
1e0c8722 | 7117 | """Set the \"main\" top level window""" |
d14a1e28 RD |
7118 | if self.stdioWin: |
7119 | self.stdioWin.SetParent(frame) | |
7120 | wx.PyApp.SetTopWindow(self, frame) | |
7121 | ||
7122 | ||
7123 | def MainLoop(self): | |
1e0c8722 | 7124 | """Execute the main GUI event loop""" |
d14a1e28 RD |
7125 | wx.PyApp.MainLoop(self) |
7126 | self.RestoreStdio() | |
7127 | ||
7128 | ||
7409c0c6 | 7129 | def RedirectStdio(self, filename=None): |
1e0c8722 | 7130 | """Redirect sys.stdout and sys.stderr to a file or a popup window.""" |
d14a1e28 RD |
7131 | if filename: |
7132 | _sys.stdout = _sys.stderr = open(filename, 'a') | |
7133 | else: | |
7134 | self.stdioWin = self.outputWindowClass() | |
7135 | _sys.stdout = _sys.stderr = self.stdioWin | |
7136 | ||
7137 | ||
7138 | def RestoreStdio(self): | |
02b455f2 RD |
7139 | try: |
7140 | _sys.stdout, _sys.stderr = self.saveStdio | |
7141 | except: | |
7142 | pass | |
d14a1e28 RD |
7143 | |
7144 | ||
412d302d RD |
7145 | def SetOutputWindowAttributes(self, title=None, pos=None, size=None): |
7146 | """ | |
7147 | Set the title, position and/or size of the output window if | |
f5b96ee1 RD |
7148 | the stdio has been redirected. This should be called before |
7149 | any output would cause the output window to be created. | |
412d302d RD |
7150 | """ |
7151 | if self.stdioWin: | |
7152 | if title is not None: | |
7153 | self.stdioWin.title = title | |
7154 | if pos is not None: | |
7155 | self.stdioWin.pos = pos | |
7156 | if size is not None: | |
7157 | self.stdioWin.size = size | |
7158 | ||
7159 | ||
7160 | ||
d14a1e28 | 7161 | |
66c033b4 | 7162 | # change from wx.PyApp_XX to wx.App_XX |
54f9ee45 RD |
7163 | App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts |
7164 | App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId | |
7165 | App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId | |
7166 | App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId | |
7167 | App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName | |
7168 | App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts | |
7169 | App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId | |
7170 | App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId | |
7171 | App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId | |
7172 | App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName | |
7173 | App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version | |
d14a1e28 RD |
7174 | |
7175 | #---------------------------------------------------------------------------- | |
7176 | ||
7177 | class PySimpleApp(wx.App): | |
6c3b4aae RD |
7178 | """ |
7179 | A simple application class. You can just create one of these and | |
7180 | then then make your top level windows later, and not have to worry | |
66c033b4 RD |
7181 | about OnInit. For example:: |
7182 | ||
7183 | app = wx.PySimpleApp() | |
7184 | frame = wx.Frame(None, title='Hello World') | |
7185 | frame.Show() | |
7186 | app.MainLoop() | |
7187 | ||
7188 | :see: `wx.App` | |
7189 | """ | |
6c3b4aae | 7190 | |
03e37cd5 RD |
7191 | def __init__(self, redirect=False, filename=None, |
7192 | useBestVisual=False, clearSigInt=True): | |
66c033b4 RD |
7193 | """ |
7194 | :see: `wx.App.__init__` | |
7195 | """ | |
03e37cd5 | 7196 | wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt) |
6c3b4aae | 7197 | |
d14a1e28 | 7198 | def OnInit(self): |
d14a1e28 RD |
7199 | return True |
7200 | ||
7201 | ||
66c033b4 | 7202 | |
6c3b4aae | 7203 | # Is anybody using this one? |
d14a1e28 RD |
7204 | class PyWidgetTester(wx.App): |
7205 | def __init__(self, size = (250, 100)): | |
7206 | self.size = size | |
7207 | wx.App.__init__(self, 0) | |
7208 | ||
7209 | def OnInit(self): | |
196addbf | 7210 | self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size) |
d14a1e28 RD |
7211 | self.SetTopWindow(self.frame) |
7212 | return True | |
7213 | ||
66c033b4 RD |
7214 | def SetWidget(self, widgetClass, *args, **kwargs): |
7215 | w = widgetClass(self.frame, *args, **kwargs) | |
d14a1e28 RD |
7216 | self.frame.Show(True) |
7217 | ||
7218 | #---------------------------------------------------------------------------- | |
7219 | # DO NOT hold any other references to this object. This is how we | |
66c033b4 | 7220 | # know when to cleanup system resources that wxWidgets is holding. When |
d14a1e28 | 7221 | # the sys module is unloaded, the refcount on sys.__wxPythonCleanup |
66c033b4 | 7222 | # goes to zero and it calls the wx.App_CleanUp function. |
d14a1e28 RD |
7223 | |
7224 | class __wxPyCleanup: | |
7225 | def __init__(self): | |
54f9ee45 | 7226 | self.cleanup = _core_.App_CleanUp |
d14a1e28 RD |
7227 | def __del__(self): |
7228 | self.cleanup() | |
7229 | ||
7230 | _sys.__wxPythonCleanup = __wxPyCleanup() | |
7231 | ||
7232 | ## # another possible solution, but it gets called too early... | |
66c033b4 RD |
7233 | ## import atexit |
7234 | ## atexit.register(_core_.wxApp_CleanUp) | |
d14a1e28 RD |
7235 | |
7236 | ||
7237 | #---------------------------------------------------------------------------- | |
7238 | ||
7239 | #--------------------------------------------------------------------------- | |
2ef75293 RD |
7240 | |
7241 | class EventLoop(object): | |
093d3ff1 | 7242 | """Proxy of C++ EventLoop class""" |
0085ce49 RD |
7243 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7244 | __repr__ = _swig_repr | |
7245 | def __init__(self, *args, **kwargs): | |
2ef75293 | 7246 | """__init__(self) -> EventLoop""" |
0085ce49 RD |
7247 | _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs)) |
7248 | __swig_destroy__ = _core_.delete_EventLoop | |
7249 | __del__ = lambda self : None; | |
2ef75293 RD |
7250 | def Run(*args, **kwargs): |
7251 | """Run(self) -> int""" | |
7252 | return _core_.EventLoop_Run(*args, **kwargs) | |
7253 | ||
7254 | def Exit(*args, **kwargs): | |
7255 | """Exit(self, int rc=0)""" | |
7256 | return _core_.EventLoop_Exit(*args, **kwargs) | |
7257 | ||
7258 | def Pending(*args, **kwargs): | |
7259 | """Pending(self) -> bool""" | |
7260 | return _core_.EventLoop_Pending(*args, **kwargs) | |
7261 | ||
7262 | def Dispatch(*args, **kwargs): | |
7263 | """Dispatch(self) -> bool""" | |
7264 | return _core_.EventLoop_Dispatch(*args, **kwargs) | |
7265 | ||
7266 | def IsRunning(*args, **kwargs): | |
7267 | """IsRunning(self) -> bool""" | |
7268 | return _core_.EventLoop_IsRunning(*args, **kwargs) | |
7269 | ||
7270 | def GetActive(*args, **kwargs): | |
7271 | """GetActive() -> EventLoop""" | |
7272 | return _core_.EventLoop_GetActive(*args, **kwargs) | |
7273 | ||
7274 | GetActive = staticmethod(GetActive) | |
7275 | def SetActive(*args, **kwargs): | |
7276 | """SetActive(EventLoop loop)""" | |
7277 | return _core_.EventLoop_SetActive(*args, **kwargs) | |
7278 | ||
7279 | SetActive = staticmethod(SetActive) | |
2131d850 | 7280 | _core_.EventLoop_swigregister(EventLoop) |
2ef75293 | 7281 | |
0085ce49 RD |
7282 | def EventLoop_GetActive(*args): |
7283 | """EventLoop_GetActive() -> EventLoop""" | |
7284 | return _core_.EventLoop_GetActive(*args) | |
2ef75293 RD |
7285 | |
7286 | def EventLoop_SetActive(*args, **kwargs): | |
0085ce49 RD |
7287 | """EventLoop_SetActive(EventLoop loop)""" |
7288 | return _core_.EventLoop_SetActive(*args, **kwargs) | |
2ef75293 | 7289 | |
091f5bed RD |
7290 | class EventLoopActivator(object): |
7291 | """Proxy of C++ EventLoopActivator class""" | |
0085ce49 RD |
7292 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7293 | __repr__ = _swig_repr | |
7294 | def __init__(self, *args, **kwargs): | |
091f5bed | 7295 | """__init__(self, EventLoop evtLoop) -> EventLoopActivator""" |
0085ce49 RD |
7296 | _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs)) |
7297 | __swig_destroy__ = _core_.delete_EventLoopActivator | |
7298 | __del__ = lambda self : None; | |
2131d850 | 7299 | _core_.EventLoopActivator_swigregister(EventLoopActivator) |
091f5bed | 7300 | |
2ef75293 | 7301 | #--------------------------------------------------------------------------- |
d14a1e28 | 7302 | |
1e0c8722 | 7303 | class AcceleratorEntry(object): |
66c033b4 RD |
7304 | """ |
7305 | A class used to define items in an `wx.AcceleratorTable`. wxPython | |
7306 | programs can choose to use wx.AcceleratorEntry objects, but using a | |
7307 | list of 3-tuple of integers (flags, keyCode, cmdID) usually works just | |
41e2b43e | 7308 | as well. See `__init__` for of the tuple values. |
66c033b4 RD |
7309 | |
7310 | :see: `wx.AcceleratorTable` | |
7311 | """ | |
0085ce49 RD |
7312 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7313 | __repr__ = _swig_repr | |
7314 | def __init__(self, *args, **kwargs): | |
66c033b4 RD |
7315 | """ |
7316 | __init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry | |
7317 | ||
7318 | Construct a wx.AcceleratorEntry. | |
66c033b4 | 7319 | """ |
0085ce49 RD |
7320 | _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs)) |
7321 | __swig_destroy__ = _core_.delete_AcceleratorEntry | |
7322 | __del__ = lambda self : None; | |
1e0c8722 | 7323 | def Set(*args, **kwargs): |
66c033b4 RD |
7324 | """ |
7325 | Set(self, int flags, int keyCode, int cmd) | |
1e0c8722 | 7326 | |
66c033b4 RD |
7327 | (Re)set the attributes of a wx.AcceleratorEntry. |
7328 | :see `__init__` | |
7329 | """ | |
7330 | return _core_.AcceleratorEntry_Set(*args, **kwargs) | |
1e0c8722 RD |
7331 | |
7332 | def GetFlags(*args, **kwargs): | |
66c033b4 RD |
7333 | """ |
7334 | GetFlags(self) -> int | |
7335 | ||
7336 | Get the AcceleratorEntry's flags. | |
7337 | """ | |
54f9ee45 | 7338 | return _core_.AcceleratorEntry_GetFlags(*args, **kwargs) |
1e0c8722 RD |
7339 | |
7340 | def GetKeyCode(*args, **kwargs): | |
66c033b4 RD |
7341 | """ |
7342 | GetKeyCode(self) -> int | |
7343 | ||
7344 | Get the AcceleratorEntry's keycode. | |
7345 | """ | |
54f9ee45 | 7346 | return _core_.AcceleratorEntry_GetKeyCode(*args, **kwargs) |
1e0c8722 RD |
7347 | |
7348 | def GetCommand(*args, **kwargs): | |
66c033b4 RD |
7349 | """ |
7350 | GetCommand(self) -> int | |
7351 | ||
7352 | Get the AcceleratorEntry's command ID. | |
7353 | """ | |
54f9ee45 | 7354 | return _core_.AcceleratorEntry_GetCommand(*args, **kwargs) |
1e0c8722 | 7355 | |
2131d850 | 7356 | _core_.AcceleratorEntry_swigregister(AcceleratorEntry) |
1e0c8722 RD |
7357 | |
7358 | class AcceleratorTable(Object): | |
66c033b4 RD |
7359 | """ |
7360 | An accelerator table allows the application to specify a table of | |
7361 | keyboard shortcuts for menus or other commands. On Windows, menu or | |
7362 | button commands are supported; on GTK, only menu commands are | |
7363 | supported. | |
66c033b4 | 7364 | """ |
0085ce49 RD |
7365 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7366 | __repr__ = _swig_repr | |
7367 | def __init__(self, *args, **kwargs): | |
0df68c9f RD |
7368 | """ |
7369 | __init__(entries) -> AcceleratorTable | |
1e0c8722 | 7370 | |
66c033b4 RD |
7371 | Construct an AcceleratorTable from a list of `wx.AcceleratorEntry` |
7372 | items or or of 3-tuples (flags, keyCode, cmdID) | |
7373 | ||
7374 | :see: `wx.AcceleratorEntry` | |
0df68c9f | 7375 | """ |
0085ce49 RD |
7376 | _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs)) |
7377 | __swig_destroy__ = _core_.delete_AcceleratorTable | |
7378 | __del__ = lambda self : None; | |
1e0c8722 | 7379 | def Ok(*args, **kwargs): |
a95a7133 | 7380 | """Ok(self) -> bool""" |
54f9ee45 | 7381 | return _core_.AcceleratorTable_Ok(*args, **kwargs) |
1e0c8722 | 7382 | |
2131d850 | 7383 | _core_.AcceleratorTable_swigregister(AcceleratorTable) |
1e0c8722 RD |
7384 | |
7385 | ||
7386 | def GetAccelFromString(*args, **kwargs): | |
0085ce49 RD |
7387 | """GetAccelFromString(String label) -> AcceleratorEntry""" |
7388 | return _core_.GetAccelFromString(*args, **kwargs) | |
1e0c8722 RD |
7389 | #--------------------------------------------------------------------------- |
7390 | ||
74a57fcd RD |
7391 | class VisualAttributes(object): |
7392 | """struct containing all the visual attributes of a control""" | |
0085ce49 RD |
7393 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7394 | __repr__ = _swig_repr | |
7395 | def __init__(self, *args, **kwargs): | |
74a57fcd | 7396 | """ |
a95a7133 | 7397 | __init__(self) -> VisualAttributes |
74a57fcd RD |
7398 | |
7399 | struct containing all the visual attributes of a control | |
7400 | """ | |
0085ce49 RD |
7401 | _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs)) |
7402 | __swig_destroy__ = _core_.delete_VisualAttributes | |
7403 | __del__ = lambda self : None; | |
54f9ee45 RD |
7404 | font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set) |
7405 | colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set) | |
7406 | colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set) | |
2131d850 | 7407 | _core_.VisualAttributes_swigregister(VisualAttributes) |
74a57fcd RD |
7408 | NullAcceleratorTable = cvar.NullAcceleratorTable |
7409 | PanelNameStr = cvar.PanelNameStr | |
7410 | ||
54f9ee45 RD |
7411 | WINDOW_VARIANT_NORMAL = _core_.WINDOW_VARIANT_NORMAL |
7412 | WINDOW_VARIANT_SMALL = _core_.WINDOW_VARIANT_SMALL | |
7413 | WINDOW_VARIANT_MINI = _core_.WINDOW_VARIANT_MINI | |
7414 | WINDOW_VARIANT_LARGE = _core_.WINDOW_VARIANT_LARGE | |
7415 | WINDOW_VARIANT_MAX = _core_.WINDOW_VARIANT_MAX | |
d14a1e28 | 7416 | class Window(EvtHandler): |
15afbcd0 RD |
7417 | """ |
7418 | wx.Window is the base class for all windows and represents any visible | |
7419 | object on the screen. All controls, top level windows and so on are | |
7420 | wx.Windows. Sizers and device contexts are not however, as they don't | |
7421 | appear on screen themselves. | |
7422 | ||
7423 | """ | |
0085ce49 RD |
7424 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
7425 | __repr__ = _swig_repr | |
7426 | def __init__(self, *args, **kwargs): | |
0df68c9f | 7427 | """ |
a95a7133 | 7428 | __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
74a57fcd | 7429 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window |
15afbcd0 RD |
7430 | |
7431 | Construct and show a generic Window. | |
0df68c9f | 7432 | """ |
0085ce49 | 7433 | _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs)) |
d14a1e28 | 7434 | self._setOORInfo(self) |
d14a1e28 | 7435 | |
e811c8ce | 7436 | def Create(*args, **kwargs): |
0df68c9f | 7437 | """ |
a95a7133 | 7438 | Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
74a57fcd | 7439 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool |
15afbcd0 RD |
7440 | |
7441 | Create the GUI part of the Window for 2-phase creation mode. | |
0df68c9f | 7442 | """ |
54f9ee45 | 7443 | return _core_.Window_Create(*args, **kwargs) |
d14a1e28 | 7444 | |
e811c8ce | 7445 | def Close(*args, **kwargs): |
15afbcd0 | 7446 | """ |
a95a7133 | 7447 | Close(self, bool force=False) -> bool |
15afbcd0 RD |
7448 | |
7449 | This function simply generates a EVT_CLOSE event whose handler usually | |
7450 | tries to close the window. It doesn't close the window itself, | |
7451 | however. If force is False (the default) then the window's close | |
7452 | handler will be allowed to veto the destruction of the window. | |
15afbcd0 | 7453 | """ |
54f9ee45 | 7454 | return _core_.Window_Close(*args, **kwargs) |
d14a1e28 | 7455 | |
e811c8ce | 7456 | def Destroy(*args, **kwargs): |
0df68c9f | 7457 | """ |
a95a7133 | 7458 | Destroy(self) -> bool |
d14a1e28 | 7459 | |
15afbcd0 RD |
7460 | Destroys the window safely. Frames and dialogs are not destroyed |
7461 | immediately when this function is called -- they are added to a list | |
7462 | of windows to be deleted on idle time, when all the window's events | |
7463 | have been processed. This prevents problems with events being sent to | |
7464 | non-existent windows. | |
7465 | ||
7466 | Returns True if the window has either been successfully deleted, or it | |
7467 | has been added to the list of windows pending real deletion. | |
0df68c9f | 7468 | """ |
7e08d4ef RD |
7469 | val = _core_.Window_Destroy(*args, **kwargs) |
7470 | args[0].thisown = 0 | |
7471 | return val | |
d14a1e28 | 7472 | |
e811c8ce | 7473 | def DestroyChildren(*args, **kwargs): |
15afbcd0 | 7474 | """ |
a95a7133 | 7475 | DestroyChildren(self) -> bool |
15afbcd0 | 7476 | |
41e2b43e RD |
7477 | Destroys all children of a window. Called automatically by the |
7478 | destructor. | |
15afbcd0 | 7479 | """ |
54f9ee45 | 7480 | return _core_.Window_DestroyChildren(*args, **kwargs) |
d14a1e28 | 7481 | |
e811c8ce | 7482 | def IsBeingDeleted(*args, **kwargs): |
15afbcd0 | 7483 | """ |
a95a7133 | 7484 | IsBeingDeleted(self) -> bool |
15afbcd0 RD |
7485 | |
7486 | Is the window in the process of being deleted? | |
7487 | """ | |
54f9ee45 | 7488 | return _core_.Window_IsBeingDeleted(*args, **kwargs) |
d14a1e28 | 7489 | |
e811c8ce | 7490 | def SetLabel(*args, **kwargs): |
15afbcd0 | 7491 | """ |
a95a7133 | 7492 | SetLabel(self, String label) |
15afbcd0 RD |
7493 | |
7494 | Set the text which the window shows in its label if applicable. | |
7495 | """ | |
54f9ee45 | 7496 | return _core_.Window_SetLabel(*args, **kwargs) |
d14a1e28 | 7497 | |
e811c8ce | 7498 | def GetLabel(*args, **kwargs): |
15afbcd0 | 7499 | """ |
a95a7133 | 7500 | GetLabel(self) -> String |
15afbcd0 | 7501 | |
41e2b43e RD |
7502 | Generic way of getting a label from any window, for identification |
7503 | purposes. The interpretation of this function differs from class to | |
7504 | class. For frames and dialogs, the value returned is the title. For | |
7505 | buttons or static text controls, it is the button text. This function | |
7506 | can be useful for meta-programs such as testing tools or special-needs | |
7507 | access programs)which need to identify windows by name. | |
15afbcd0 | 7508 | """ |
54f9ee45 | 7509 | return _core_.Window_GetLabel(*args, **kwargs) |
d14a1e28 | 7510 | |
e811c8ce | 7511 | def SetName(*args, **kwargs): |
15afbcd0 | 7512 | """ |
a95a7133 | 7513 | SetName(self, String name) |
15afbcd0 | 7514 | |
41e2b43e RD |
7515 | Sets the window's name. The window name is used for ressource setting |
7516 | in X, it is not the same as the window title/label | |
15afbcd0 | 7517 | """ |
54f9ee45 | 7518 | return _core_.Window_SetName(*args, **kwargs) |
d14a1e28 | 7519 | |
e811c8ce | 7520 | def GetName(*args, **kwargs): |
15afbcd0 | 7521 | """ |
a95a7133 | 7522 | GetName(self) -> String |
15afbcd0 | 7523 | |
41e2b43e RD |
7524 | Returns the windows name. This name is not guaranteed to be unique; |
7525 | it is up to the programmer to supply an appropriate name in the window | |
7526 | constructor or via wx.Window.SetName. | |
15afbcd0 | 7527 | """ |
54f9ee45 | 7528 | return _core_.Window_GetName(*args, **kwargs) |
d14a1e28 | 7529 | |
4276dc52 RD |
7530 | def SetWindowVariant(*args, **kwargs): |
7531 | """ | |
a95a7133 | 7532 | SetWindowVariant(self, int variant) |
4276dc52 | 7533 | |
41e2b43e RD |
7534 | Sets the variant of the window/font size to use for this window, if |
7535 | the platform supports variants, for example, wxMac. | |
4276dc52 | 7536 | """ |
54f9ee45 | 7537 | return _core_.Window_SetWindowVariant(*args, **kwargs) |
4276dc52 RD |
7538 | |
7539 | def GetWindowVariant(*args, **kwargs): | |
a95a7133 | 7540 | """GetWindowVariant(self) -> int""" |
54f9ee45 | 7541 | return _core_.Window_GetWindowVariant(*args, **kwargs) |
4276dc52 | 7542 | |
e811c8ce | 7543 | def SetId(*args, **kwargs): |
15afbcd0 | 7544 | """ |
a95a7133 | 7545 | SetId(self, int winid) |
15afbcd0 RD |
7546 | |
7547 | Sets the identifier of the window. Each window has an integer | |
7548 | identifier. If the application has not provided one, an identifier | |
7549 | will be generated. Normally, the identifier should be provided on | |
7550 | creation and should not be modified subsequently. | |
7551 | """ | |
54f9ee45 | 7552 | return _core_.Window_SetId(*args, **kwargs) |
d14a1e28 | 7553 | |
e811c8ce | 7554 | def GetId(*args, **kwargs): |
15afbcd0 | 7555 | """ |
a95a7133 | 7556 | GetId(self) -> int |
15afbcd0 RD |
7557 | |
7558 | Returns the identifier of the window. Each window has an integer | |
7559 | identifier. If the application has not provided one (or the default Id | |
7560 | -1 is used) then an unique identifier with a negative value will be | |
7561 | generated. | |
7562 | """ | |
54f9ee45 | 7563 | return _core_.Window_GetId(*args, **kwargs) |
d14a1e28 | 7564 | |
e811c8ce | 7565 | def NewControlId(*args, **kwargs): |
15afbcd0 | 7566 | """ |
66c033b4 | 7567 | NewControlId() -> int |
15afbcd0 RD |
7568 | |
7569 | Generate a control id for the controls which were not given one. | |
7570 | """ | |
54f9ee45 | 7571 | return _core_.Window_NewControlId(*args, **kwargs) |
d14a1e28 | 7572 | |
e811c8ce RD |
7573 | NewControlId = staticmethod(NewControlId) |
7574 | def NextControlId(*args, **kwargs): | |
15afbcd0 | 7575 | """ |
66c033b4 | 7576 | NextControlId(int winid) -> int |
15afbcd0 RD |
7577 | |
7578 | Get the id of the control following the one with the given | |
41e2b43e | 7579 | autogenerated) id |
15afbcd0 | 7580 | """ |
54f9ee45 | 7581 | return _core_.Window_NextControlId(*args, **kwargs) |
d14a1e28 | 7582 | |
e811c8ce RD |
7583 | NextControlId = staticmethod(NextControlId) |
7584 | def PrevControlId(*args, **kwargs): | |
15afbcd0 | 7585 | """ |
66c033b4 | 7586 | PrevControlId(int winid) -> int |
15afbcd0 RD |
7587 | |
7588 | Get the id of the control preceding the one with the given | |
41e2b43e | 7589 | autogenerated) id |
15afbcd0 | 7590 | """ |
54f9ee45 | 7591 | return _core_.Window_PrevControlId(*args, **kwargs) |
d14a1e28 | 7592 | |
e811c8ce RD |
7593 | PrevControlId = staticmethod(PrevControlId) |
7594 | def SetSize(*args, **kwargs): | |
15afbcd0 | 7595 | """ |
a95a7133 | 7596 | SetSize(self, Size size) |
15afbcd0 RD |
7597 | |
7598 | Sets the size of the window in pixels. | |
7599 | """ | |
54f9ee45 | 7600 | return _core_.Window_SetSize(*args, **kwargs) |
d14a1e28 | 7601 | |
e811c8ce | 7602 | def SetDimensions(*args, **kwargs): |
15afbcd0 | 7603 | """ |
a95a7133 | 7604 | SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) |
15afbcd0 RD |
7605 | |
7606 | Sets the position and size of the window in pixels. The sizeFlags | |
7607 | parameter indicates the interpretation of the other params if they are | |
e505d15e RD |
7608 | equal to -1. |
7609 | ||
7610 | ======================== ====================================== | |
7611 | wx.SIZE_AUTO A -1 indicates that a class-specific | |
7612 | default should be used. | |
7613 | wx.SIZE_USE_EXISTING Axisting dimensions should be used if | |
7614 | -1 values are supplied. | |
7615 | wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be | |
7616 | interpreted as real dimensions, not | |
7617 | default values. | |
7618 | ======================== ====================================== | |
7619 | ||
15afbcd0 | 7620 | """ |
54f9ee45 | 7621 | return _core_.Window_SetDimensions(*args, **kwargs) |
d14a1e28 | 7622 | |
e811c8ce | 7623 | def SetRect(*args, **kwargs): |
15afbcd0 | 7624 | """ |
a95a7133 | 7625 | SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO) |
15afbcd0 RD |
7626 | |
7627 | Sets the position and size of the window in pixels using a wx.Rect. | |
7628 | """ | |
54f9ee45 | 7629 | return _core_.Window_SetRect(*args, **kwargs) |
d14a1e28 | 7630 | |
e811c8ce | 7631 | def SetSizeWH(*args, **kwargs): |
15afbcd0 | 7632 | """ |
a95a7133 | 7633 | SetSizeWH(self, int width, int height) |
15afbcd0 RD |
7634 | |
7635 | Sets the size of the window in pixels. | |
7636 | """ | |
54f9ee45 | 7637 | return _core_.Window_SetSizeWH(*args, **kwargs) |
d14a1e28 | 7638 | |
e811c8ce | 7639 | def Move(*args, **kwargs): |
15afbcd0 | 7640 | """ |
a95a7133 | 7641 | Move(self, Point pt, int flags=SIZE_USE_EXISTING) |
15afbcd0 RD |
7642 | |
7643 | Moves the window to the given position. | |
7644 | """ | |
54f9ee45 | 7645 | return _core_.Window_Move(*args, **kwargs) |
d14a1e28 | 7646 | |
e811c8ce RD |
7647 | SetPosition = Move |
7648 | def MoveXY(*args, **kwargs): | |
15afbcd0 | 7649 | """ |
a95a7133 | 7650 | MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING) |
15afbcd0 RD |
7651 | |
7652 | Moves the window to the given position. | |
7653 | """ | |
54f9ee45 | 7654 | return _core_.Window_MoveXY(*args, **kwargs) |
e811c8ce | 7655 | |
f8167d6e RD |
7656 | def SetBestFittingSize(*args, **kwargs): |
7657 | """ | |
7658 | SetBestFittingSize(self, Size size=DefaultSize) | |
7659 | ||
7660 | A 'Smart' SetSize that will fill in default size components with the | |
7661 | window's *best size* values. Also set's the minsize for use with sizers. | |
7662 | """ | |
7663 | return _core_.Window_SetBestFittingSize(*args, **kwargs) | |
7664 | ||
e811c8ce | 7665 | def Raise(*args, **kwargs): |
15afbcd0 | 7666 | """ |
a95a7133 | 7667 | Raise(self) |
15afbcd0 | 7668 | |
943e8dfd RD |
7669 | Raises the window to the top of the window hierarchy. In current |
7670 | version of wxWidgets this works both for manage and child windows. | |
15afbcd0 | 7671 | """ |
54f9ee45 | 7672 | return _core_.Window_Raise(*args, **kwargs) |
e811c8ce RD |
7673 | |
7674 | def Lower(*args, **kwargs): | |
15afbcd0 | 7675 | """ |
a95a7133 | 7676 | Lower(self) |
15afbcd0 | 7677 | |
943e8dfd RD |
7678 | Lowers the window to the bottom of the window hierarchy. In current |
7679 | version of wxWidgets this works both for manage and child windows. | |
15afbcd0 | 7680 | """ |
54f9ee45 | 7681 | return _core_.Window_Lower(*args, **kwargs) |
e811c8ce RD |
7682 | |
7683 | def SetClientSize(*args, **kwargs): | |
15afbcd0 | 7684 | """ |
a95a7133 | 7685 | SetClientSize(self, Size size) |
15afbcd0 RD |
7686 | |
7687 | This sets the size of the window client area in pixels. Using this | |
7688 | function to size a window tends to be more device-independent than | |
7689 | wx.Window.SetSize, since the application need not worry about what | |
7690 | dimensions the border or title bar have when trying to fit the window | |
7691 | around panel items, for example. | |
7692 | """ | |
54f9ee45 | 7693 | return _core_.Window_SetClientSize(*args, **kwargs) |
e811c8ce RD |
7694 | |
7695 | def SetClientSizeWH(*args, **kwargs): | |
15afbcd0 | 7696 | """ |
a95a7133 | 7697 | SetClientSizeWH(self, int width, int height) |
15afbcd0 RD |
7698 | |
7699 | This sets the size of the window client area in pixels. Using this | |
7700 | function to size a window tends to be more device-independent than | |
7701 | wx.Window.SetSize, since the application need not worry about what | |
7702 | dimensions the border or title bar have when trying to fit the window | |
7703 | around panel items, for example. | |
7704 | """ | |
54f9ee45 | 7705 | return _core_.Window_SetClientSizeWH(*args, **kwargs) |
e811c8ce RD |
7706 | |
7707 | def SetClientRect(*args, **kwargs): | |
15afbcd0 | 7708 | """ |
a95a7133 | 7709 | SetClientRect(self, Rect rect) |
15afbcd0 RD |
7710 | |
7711 | This sets the size of the window client area in pixels. Using this | |
7712 | function to size a window tends to be more device-independent than | |
7713 | wx.Window.SetSize, since the application need not worry about what | |
7714 | dimensions the border or title bar have when trying to fit the window | |
7715 | around panel items, for example. | |
7716 | """ | |
54f9ee45 | 7717 | return _core_.Window_SetClientRect(*args, **kwargs) |
e811c8ce RD |
7718 | |
7719 | def GetPosition(*args, **kwargs): | |
0df68c9f | 7720 | """ |
a95a7133 | 7721 | GetPosition(self) -> Point |
e811c8ce | 7722 | |
75219dcb RD |
7723 | Get the window's position. Notice that the position is in client |
7724 | coordinates for child windows and screen coordinates for the top level | |
7725 | ones, use `GetScreenPosition` if you need screen coordinates for all | |
7726 | kinds of windows. | |
0df68c9f | 7727 | """ |
54f9ee45 | 7728 | return _core_.Window_GetPosition(*args, **kwargs) |
e811c8ce RD |
7729 | |
7730 | def GetPositionTuple(*args, **kwargs): | |
0df68c9f RD |
7731 | """ |
7732 | GetPositionTuple() -> (x,y) | |
e811c8ce | 7733 | |
75219dcb RD |
7734 | Get the window's position. Notice that the position is in client |
7735 | coordinates for child windows and screen coordinates for the top level | |
7736 | ones, use `GetScreenPosition` if you need screen coordinates for all | |
7737 | kinds of windows. | |
0df68c9f | 7738 | """ |
54f9ee45 | 7739 | return _core_.Window_GetPositionTuple(*args, **kwargs) |
e811c8ce | 7740 | |
75219dcb RD |
7741 | def GetScreenPosition(*args, **kwargs): |
7742 | """ | |
7743 | GetScreenPosition(self) -> Point | |
7744 | ||
7745 | Get the position of the window in screen coordinantes. | |
7746 | """ | |
7747 | return _core_.Window_GetScreenPosition(*args, **kwargs) | |
7748 | ||
7749 | def GetScreenPositionTuple(*args, **kwargs): | |
7750 | """ | |
7751 | GetScreenPositionTuple() -> (x,y) | |
7752 | ||
7753 | Get the position of the window in screen coordinantes. | |
7754 | """ | |
7755 | return _core_.Window_GetScreenPositionTuple(*args, **kwargs) | |
7756 | ||
7757 | def GetScreenRect(*args, **kwargs): | |
7758 | """ | |
7759 | GetScreenRect(self) -> Rect | |
7760 | ||
7761 | Returns the size and position of the window in screen coordinantes as | |
7762 | a `wx.Rect` object. | |
7763 | """ | |
7764 | return _core_.Window_GetScreenRect(*args, **kwargs) | |
7765 | ||
e811c8ce | 7766 | def GetSize(*args, **kwargs): |
0df68c9f | 7767 | """ |
a95a7133 | 7768 | GetSize(self) -> Size |
e811c8ce | 7769 | |
0df68c9f RD |
7770 | Get the window size. |
7771 | """ | |
54f9ee45 | 7772 | return _core_.Window_GetSize(*args, **kwargs) |
e811c8ce RD |
7773 | |
7774 | def GetSizeTuple(*args, **kwargs): | |
0df68c9f RD |
7775 | """ |
7776 | GetSizeTuple() -> (width, height) | |
e811c8ce | 7777 | |
0df68c9f RD |
7778 | Get the window size. |
7779 | """ | |
54f9ee45 | 7780 | return _core_.Window_GetSizeTuple(*args, **kwargs) |
e811c8ce RD |
7781 | |
7782 | def GetRect(*args, **kwargs): | |
15afbcd0 | 7783 | """ |
a95a7133 | 7784 | GetRect(self) -> Rect |
15afbcd0 | 7785 | |
75219dcb | 7786 | Returns the size and position of the window as a `wx.Rect` object. |
15afbcd0 | 7787 | """ |
54f9ee45 | 7788 | return _core_.Window_GetRect(*args, **kwargs) |
e811c8ce RD |
7789 | |
7790 | def GetClientSize(*args, **kwargs): | |
0df68c9f | 7791 | """ |
a95a7133 | 7792 | GetClientSize(self) -> Size |
e811c8ce | 7793 | |
15afbcd0 RD |
7794 | This gets the size of the window's 'client area' in pixels. The client |
7795 | area is the area which may be drawn on by the programmer, excluding | |
7796 | title bar, border, scrollbars, etc. | |
0df68c9f | 7797 | """ |
54f9ee45 | 7798 | return _core_.Window_GetClientSize(*args, **kwargs) |
e811c8ce RD |
7799 | |
7800 | def GetClientSizeTuple(*args, **kwargs): | |
0df68c9f RD |
7801 | """ |
7802 | GetClientSizeTuple() -> (width, height) | |
e811c8ce | 7803 | |
15afbcd0 RD |
7804 | This gets the size of the window's 'client area' in pixels. The client |
7805 | area is the area which may be drawn on by the programmer, excluding | |
7806 | title bar, border, scrollbars, etc. | |
0df68c9f | 7807 | """ |
54f9ee45 | 7808 | return _core_.Window_GetClientSizeTuple(*args, **kwargs) |
e811c8ce RD |
7809 | |
7810 | def GetClientAreaOrigin(*args, **kwargs): | |
15afbcd0 | 7811 | """ |
a95a7133 | 7812 | GetClientAreaOrigin(self) -> Point |
15afbcd0 RD |
7813 | |
7814 | Get the origin of the client area of the window relative to the | |
7815 | window's top left corner (the client area may be shifted because of | |
7816 | the borders, scrollbars, other decorations...) | |
7817 | """ | |
54f9ee45 | 7818 | return _core_.Window_GetClientAreaOrigin(*args, **kwargs) |
e811c8ce RD |
7819 | |
7820 | def GetClientRect(*args, **kwargs): | |
15afbcd0 | 7821 | """ |
a95a7133 | 7822 | GetClientRect(self) -> Rect |
15afbcd0 | 7823 | |
61863841 | 7824 | Get the client area position and size as a `wx.Rect` object. |
15afbcd0 | 7825 | """ |
54f9ee45 | 7826 | return _core_.Window_GetClientRect(*args, **kwargs) |
e811c8ce RD |
7827 | |
7828 | def GetBestSize(*args, **kwargs): | |
0df68c9f | 7829 | """ |
a95a7133 | 7830 | GetBestSize(self) -> Size |
e811c8ce | 7831 | |
248ed943 | 7832 | This function returns the best acceptable minimal size for the |
41e2b43e RD |
7833 | window, if applicable. For example, for a static text control, it will |
7834 | be the minimal size such that the control label is not truncated. For | |
7835 | windows containing subwindows (suzh aswx.Panel), the size returned by | |
7836 | this function will be the same as the size the window would have had | |
7837 | after calling Fit. | |
0df68c9f | 7838 | """ |
54f9ee45 | 7839 | return _core_.Window_GetBestSize(*args, **kwargs) |
e811c8ce RD |
7840 | |
7841 | def GetBestSizeTuple(*args, **kwargs): | |
0df68c9f RD |
7842 | """ |
7843 | GetBestSizeTuple() -> (width, height) | |
e811c8ce | 7844 | |
248ed943 | 7845 | This function returns the best acceptable minimal size for the |
41e2b43e RD |
7846 | window, if applicable. For example, for a static text control, it will |
7847 | be the minimal size such that the control label is not truncated. For | |
7848 | windows containing subwindows (suzh aswx.Panel), the size returned by | |
7849 | this function will be the same as the size the window would have had | |
7850 | after calling Fit. | |
0df68c9f | 7851 | """ |
54f9ee45 | 7852 | return _core_.Window_GetBestSizeTuple(*args, **kwargs) |
e811c8ce | 7853 | |
dfbb5885 RD |
7854 | def InvalidateBestSize(*args, **kwargs): |
7855 | """ | |
7856 | InvalidateBestSize(self) | |
7857 | ||
7858 | Reset the cached best size value so it will be recalculated the next | |
7859 | time it is needed. | |
7860 | """ | |
7861 | return _core_.Window_InvalidateBestSize(*args, **kwargs) | |
7862 | ||
e2813725 RD |
7863 | def CacheBestSize(*args, **kwargs): |
7864 | """ | |
7865 | CacheBestSize(self, Size size) | |
7866 | ||
7867 | Cache the best size so it doesn't need to be calculated again, (at least until | |
7868 | some properties of the window change.) | |
7869 | """ | |
7870 | return _core_.Window_CacheBestSize(*args, **kwargs) | |
7871 | ||
dfbb5885 RD |
7872 | def GetBestFittingSize(*args, **kwargs): |
7873 | """ | |
7874 | GetBestFittingSize(self) -> Size | |
7875 | ||
7876 | This function will merge the window's best size into the window's | |
7877 | minimum size, giving priority to the min size components, and returns | |
7878 | the results. | |
7879 | ||
7880 | """ | |
7881 | return _core_.Window_GetBestFittingSize(*args, **kwargs) | |
7882 | ||
e811c8ce | 7883 | def GetAdjustedBestSize(*args, **kwargs): |
15afbcd0 | 7884 | """ |
a95a7133 | 7885 | GetAdjustedBestSize(self) -> Size |
15afbcd0 RD |
7886 | |
7887 | This method is similar to GetBestSize, except in one | |
7888 | thing. GetBestSize should return the minimum untruncated size of the | |
7889 | window, while this method will return the largest of BestSize and any | |
7890 | user specified minimum size. ie. it is the minimum size the window | |
7891 | should currently be drawn at, not the minimal size it can possibly | |
7892 | tolerate. | |
7893 | """ | |
54f9ee45 | 7894 | return _core_.Window_GetAdjustedBestSize(*args, **kwargs) |
e811c8ce RD |
7895 | |
7896 | def Center(*args, **kwargs): | |
15afbcd0 | 7897 | """ |
a95a7133 | 7898 | Center(self, int direction=BOTH) |
15afbcd0 RD |
7899 | |
7900 | Centers the window. The parameter specifies the direction for | |
7901 | cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may | |
7902 | also include wx.CENTER_ON_SCREEN flag if you want to center the window | |
7903 | on the entire screen and not on its parent window. If it is a | |
7904 | top-level window and has no parent then it will always be centered | |
7905 | relative to the screen. | |
7906 | """ | |
54f9ee45 | 7907 | return _core_.Window_Center(*args, **kwargs) |
e811c8ce RD |
7908 | |
7909 | Centre = Center | |
e811c8ce | 7910 | def CenterOnParent(*args, **kwargs): |
15afbcd0 | 7911 | """ |
a95a7133 | 7912 | CenterOnParent(self, int dir=BOTH) |
15afbcd0 RD |
7913 | |
7914 | Center with respect to the the parent window | |
7915 | """ | |
54f9ee45 | 7916 | return _core_.Window_CenterOnParent(*args, **kwargs) |
e811c8ce RD |
7917 | |
7918 | CentreOnParent = CenterOnParent | |
7919 | def Fit(*args, **kwargs): | |
15afbcd0 | 7920 | """ |
a95a7133 | 7921 | Fit(self) |
15afbcd0 RD |
7922 | |
7923 | Sizes the window so that it fits around its subwindows. This function | |
7924 | won't do anything if there are no subwindows and will only really work | |
7925 | correctly if sizers are used for the subwindows layout. Also, if the | |
7926 | window has exactly one subwindow it is better (faster and the result | |
7927 | is more precise as Fit adds some margin to account for fuzziness of | |
7928 | its calculations) to call window.SetClientSize(child.GetSize()) | |
7929 | instead of calling Fit. | |
7930 | """ | |
54f9ee45 | 7931 | return _core_.Window_Fit(*args, **kwargs) |
e811c8ce RD |
7932 | |
7933 | def FitInside(*args, **kwargs): | |
15afbcd0 | 7934 | """ |
a95a7133 | 7935 | FitInside(self) |
15afbcd0 RD |
7936 | |
7937 | Similar to Fit, but sizes the interior (virtual) size of a | |
7938 | window. Mainly useful with scrolled windows to reset scrollbars after | |
7939 | sizing changes that do not trigger a size event, and/or scrolled | |
7940 | windows without an interior sizer. This function similarly won't do | |
7941 | anything if there are no subwindows. | |
7942 | """ | |
54f9ee45 | 7943 | return _core_.Window_FitInside(*args, **kwargs) |
e811c8ce | 7944 | |
f16ab95d | 7945 | def SetSizeHints(*args, **kwargs): |
0df68c9f | 7946 | """ |
a95a7133 | 7947 | SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, |
0df68c9f | 7948 | int incH=-1) |
15afbcd0 RD |
7949 | |
7950 | Allows specification of minimum and maximum window sizes, and window | |
7951 | size increments. If a pair of values is not set (or set to -1), the | |
7952 | default values will be used. If this function is called, the user | |
908b74cd RD |
7953 | will not be able to size the window outside the given bounds (if it is |
7954 | a top-level window.) Sizers will also inspect the minimum window size | |
7955 | and will use that value if set when calculating layout. | |
7956 | ||
7957 | The resizing increments are only significant under Motif or Xt. | |
0df68c9f | 7958 | """ |
f16ab95d | 7959 | return _core_.Window_SetSizeHints(*args, **kwargs) |
e811c8ce | 7960 | |
f16ab95d RD |
7961 | def SetSizeHintsSz(*args, **kwargs): |
7962 | """ | |
7963 | SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize) | |
7964 | ||
7965 | Allows specification of minimum and maximum window sizes, and window | |
7966 | size increments. If a pair of values is not set (or set to -1), the | |
7967 | default values will be used. If this function is called, the user | |
7968 | will not be able to size the window outside the given bounds (if it is | |
7969 | a top-level window.) Sizers will also inspect the minimum window size | |
7970 | and will use that value if set when calculating layout. | |
7971 | ||
7972 | The resizing increments are only significant under Motif or Xt. | |
7973 | """ | |
7974 | return _core_.Window_SetSizeHintsSz(*args, **kwargs) | |
7975 | ||
7976 | def SetVirtualSizeHints(*args, **kwargs): | |
15afbcd0 | 7977 | """ |
908b74cd | 7978 | SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1) |
15afbcd0 RD |
7979 | |
7980 | Allows specification of minimum and maximum virtual window sizes. If a | |
7981 | pair of values is not set (or set to -1), the default values will be | |
7982 | used. If this function is called, the user will not be able to size | |
7983 | the virtual area of the window outside the given bounds. | |
7984 | """ | |
f16ab95d RD |
7985 | return _core_.Window_SetVirtualSizeHints(*args, **kwargs) |
7986 | ||
7987 | def SetVirtualSizeHintsSz(*args, **kwargs): | |
7988 | """ | |
7989 | SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize) | |
7990 | ||
7991 | Allows specification of minimum and maximum virtual window sizes. If a | |
7992 | pair of values is not set (or set to -1), the default values will be | |
7993 | used. If this function is called, the user will not be able to size | |
7994 | the virtual area of the window outside the given bounds. | |
7995 | """ | |
7996 | return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs) | |
e811c8ce | 7997 | |
908b74cd RD |
7998 | def GetMaxSize(*args, **kwargs): |
7999 | """GetMaxSize(self) -> Size""" | |
8000 | return _core_.Window_GetMaxSize(*args, **kwargs) | |
8001 | ||
8002 | def GetMinSize(*args, **kwargs): | |
8003 | """GetMinSize(self) -> Size""" | |
8004 | return _core_.Window_GetMinSize(*args, **kwargs) | |
8005 | ||
8006 | def SetMinSize(*args, **kwargs): | |
8007 | """ | |
8008 | SetMinSize(self, Size minSize) | |
8009 | ||
8010 | A more convenient method than `SetSizeHints` for setting just the | |
8011 | min size. | |
8012 | """ | |
8013 | return _core_.Window_SetMinSize(*args, **kwargs) | |
8014 | ||
8015 | def SetMaxSize(*args, **kwargs): | |
8016 | """ | |
8017 | SetMaxSize(self, Size maxSize) | |
8018 | ||
8019 | A more convenient method than `SetSizeHints` for setting just the | |
8020 | max size. | |
8021 | """ | |
8022 | return _core_.Window_SetMaxSize(*args, **kwargs) | |
8023 | ||
e811c8ce | 8024 | def GetMinWidth(*args, **kwargs): |
a95a7133 | 8025 | """GetMinWidth(self) -> int""" |
54f9ee45 | 8026 | return _core_.Window_GetMinWidth(*args, **kwargs) |
e811c8ce RD |
8027 | |
8028 | def GetMinHeight(*args, **kwargs): | |
a95a7133 | 8029 | """GetMinHeight(self) -> int""" |
54f9ee45 | 8030 | return _core_.Window_GetMinHeight(*args, **kwargs) |
e811c8ce RD |
8031 | |
8032 | def GetMaxWidth(*args, **kwargs): | |
a95a7133 | 8033 | """GetMaxWidth(self) -> int""" |
54f9ee45 | 8034 | return _core_.Window_GetMaxWidth(*args, **kwargs) |
e811c8ce RD |
8035 | |
8036 | def GetMaxHeight(*args, **kwargs): | |
a95a7133 | 8037 | """GetMaxHeight(self) -> int""" |
54f9ee45 | 8038 | return _core_.Window_GetMaxHeight(*args, **kwargs) |
e811c8ce | 8039 | |
e811c8ce | 8040 | def SetVirtualSize(*args, **kwargs): |
0df68c9f | 8041 | """ |
a95a7133 | 8042 | SetVirtualSize(self, Size size) |
e811c8ce | 8043 | |
15afbcd0 RD |
8044 | Set the the virtual size of a window in pixels. For most windows this |
8045 | is just the client area of the window, but for some like scrolled | |
8046 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8047 | """ |
54f9ee45 | 8048 | return _core_.Window_SetVirtualSize(*args, **kwargs) |
e811c8ce RD |
8049 | |
8050 | def SetVirtualSizeWH(*args, **kwargs): | |
0df68c9f | 8051 | """ |
a95a7133 | 8052 | SetVirtualSizeWH(self, int w, int h) |
e811c8ce | 8053 | |
15afbcd0 RD |
8054 | Set the the virtual size of a window in pixels. For most windows this |
8055 | is just the client area of the window, but for some like scrolled | |
8056 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8057 | """ |
54f9ee45 | 8058 | return _core_.Window_SetVirtualSizeWH(*args, **kwargs) |
e811c8ce RD |
8059 | |
8060 | def GetVirtualSize(*args, **kwargs): | |
0df68c9f | 8061 | """ |
a95a7133 | 8062 | GetVirtualSize(self) -> Size |
e811c8ce | 8063 | |
15afbcd0 RD |
8064 | Get the the virtual size of the window in pixels. For most windows |
8065 | this is just the client area of the window, but for some like scrolled | |
8066 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8067 | """ |
54f9ee45 | 8068 | return _core_.Window_GetVirtualSize(*args, **kwargs) |
e811c8ce RD |
8069 | |
8070 | def GetVirtualSizeTuple(*args, **kwargs): | |
0df68c9f RD |
8071 | """ |
8072 | GetVirtualSizeTuple() -> (width, height) | |
e811c8ce | 8073 | |
15afbcd0 RD |
8074 | Get the the virtual size of the window in pixels. For most windows |
8075 | this is just the client area of the window, but for some like scrolled | |
8076 | windows it is more or less independent of the screen window size. | |
0df68c9f | 8077 | """ |
54f9ee45 | 8078 | return _core_.Window_GetVirtualSizeTuple(*args, **kwargs) |
e811c8ce RD |
8079 | |
8080 | def GetBestVirtualSize(*args, **kwargs): | |
15afbcd0 | 8081 | """ |
a95a7133 | 8082 | GetBestVirtualSize(self) -> Size |
15afbcd0 RD |
8083 | |
8084 | Return the largest of ClientSize and BestSize (as determined by a | |
8085 | sizer, interior children, or other means) | |
8086 | """ | |
54f9ee45 | 8087 | return _core_.Window_GetBestVirtualSize(*args, **kwargs) |
e811c8ce RD |
8088 | |
8089 | def Show(*args, **kwargs): | |
15afbcd0 | 8090 | """ |
a95a7133 | 8091 | Show(self, bool show=True) -> bool |
15afbcd0 RD |
8092 | |
8093 | Shows or hides the window. You may need to call Raise for a top level | |
8094 | window if you want to bring it to top, although this is not needed if | |
8095 | Show is called immediately after the frame creation. Returns True if | |
8096 | the window has been shown or hidden or False if nothing was done | |
8097 | because it already was in the requested state. | |
8098 | """ | |
54f9ee45 | 8099 | return _core_.Window_Show(*args, **kwargs) |
e811c8ce RD |
8100 | |
8101 | def Hide(*args, **kwargs): | |
15afbcd0 | 8102 | """ |
a95a7133 | 8103 | Hide(self) -> bool |
15afbcd0 RD |
8104 | |
8105 | Equivalent to calling Show(False). | |
8106 | """ | |
54f9ee45 | 8107 | return _core_.Window_Hide(*args, **kwargs) |
e811c8ce RD |
8108 | |
8109 | def Enable(*args, **kwargs): | |
15afbcd0 | 8110 | """ |
a95a7133 | 8111 | Enable(self, bool enable=True) -> bool |
15afbcd0 RD |
8112 | |
8113 | Enable or disable the window for user input. Note that when a parent | |
8114 | window is disabled, all of its children are disabled as well and they | |
8115 | are reenabled again when the parent is. Returns true if the window | |
8116 | has been enabled or disabled, false if nothing was done, i.e. if the | |
8117 | window had already been in the specified state. | |
8118 | """ | |
54f9ee45 | 8119 | return _core_.Window_Enable(*args, **kwargs) |
e811c8ce RD |
8120 | |
8121 | def Disable(*args, **kwargs): | |
15afbcd0 | 8122 | """ |
a95a7133 | 8123 | Disable(self) -> bool |
15afbcd0 RD |
8124 | |
8125 | Disables the window, same as Enable(false). | |
8126 | """ | |
54f9ee45 | 8127 | return _core_.Window_Disable(*args, **kwargs) |
e811c8ce RD |
8128 | |
8129 | def IsShown(*args, **kwargs): | |
15afbcd0 | 8130 | """ |
a95a7133 | 8131 | IsShown(self) -> bool |
15afbcd0 RD |
8132 | |
8133 | Returns true if the window is shown, false if it has been hidden. | |
8134 | """ | |
54f9ee45 | 8135 | return _core_.Window_IsShown(*args, **kwargs) |
e811c8ce RD |
8136 | |
8137 | def IsEnabled(*args, **kwargs): | |
15afbcd0 | 8138 | """ |
a95a7133 | 8139 | IsEnabled(self) -> bool |
15afbcd0 RD |
8140 | |
8141 | Returns true if the window is enabled for input, false otherwise. | |
8142 | """ | |
54f9ee45 | 8143 | return _core_.Window_IsEnabled(*args, **kwargs) |
e811c8ce RD |
8144 | |
8145 | def SetWindowStyleFlag(*args, **kwargs): | |
15afbcd0 | 8146 | """ |
a95a7133 | 8147 | SetWindowStyleFlag(self, long style) |
15afbcd0 | 8148 | |
41e2b43e RD |
8149 | Sets the style of the window. Please note that some styles cannot be |
8150 | changed after the window creation and that Refresh() might need to be | |
8151 | called after changing the others for the change to take place | |
8152 | immediately. | |
15afbcd0 | 8153 | """ |
54f9ee45 | 8154 | return _core_.Window_SetWindowStyleFlag(*args, **kwargs) |
e811c8ce RD |
8155 | |
8156 | def GetWindowStyleFlag(*args, **kwargs): | |
15afbcd0 | 8157 | """ |
a95a7133 | 8158 | GetWindowStyleFlag(self) -> long |
e811c8ce | 8159 | |
15afbcd0 RD |
8160 | Gets the window style that was passed to the constructor or Create |
8161 | method. | |
8162 | """ | |
54f9ee45 | 8163 | return _core_.Window_GetWindowStyleFlag(*args, **kwargs) |
e811c8ce | 8164 | |
15afbcd0 | 8165 | SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag |
e811c8ce | 8166 | def HasFlag(*args, **kwargs): |
15afbcd0 | 8167 | """ |
a95a7133 | 8168 | HasFlag(self, int flag) -> bool |
15afbcd0 RD |
8169 | |
8170 | Test if the given style is set for this window. | |
8171 | """ | |
54f9ee45 | 8172 | return _core_.Window_HasFlag(*args, **kwargs) |
e811c8ce RD |
8173 | |
8174 | def IsRetained(*args, **kwargs): | |
15afbcd0 | 8175 | """ |
a95a7133 | 8176 | IsRetained(self) -> bool |
15afbcd0 RD |
8177 | |
8178 | Returns true if the window is retained, false otherwise. Retained | |
8179 | windows are only available on X platforms. | |
8180 | """ | |
54f9ee45 | 8181 | return _core_.Window_IsRetained(*args, **kwargs) |
e811c8ce RD |
8182 | |
8183 | def SetExtraStyle(*args, **kwargs): | |
15afbcd0 | 8184 | """ |
a95a7133 | 8185 | SetExtraStyle(self, long exStyle) |
15afbcd0 RD |
8186 | |
8187 | Sets the extra style bits for the window. Extra styles are the less | |
8188 | often used style bits which can't be set with the constructor or with | |
8189 | SetWindowStyleFlag() | |
8190 | """ | |
54f9ee45 | 8191 | return _core_.Window_SetExtraStyle(*args, **kwargs) |
e811c8ce RD |
8192 | |
8193 | def GetExtraStyle(*args, **kwargs): | |
15afbcd0 | 8194 | """ |
a95a7133 | 8195 | GetExtraStyle(self) -> long |
15afbcd0 RD |
8196 | |
8197 | Returns the extra style bits for the window. | |
8198 | """ | |
54f9ee45 | 8199 | return _core_.Window_GetExtraStyle(*args, **kwargs) |
e811c8ce RD |
8200 | |
8201 | def MakeModal(*args, **kwargs): | |
15afbcd0 | 8202 | """ |
a95a7133 | 8203 | MakeModal(self, bool modal=True) |
15afbcd0 RD |
8204 | |
8205 | Disables all other windows in the application so that the user can | |
8206 | only interact with this window. Passing False will reverse this | |
8207 | effect. | |
8208 | """ | |
54f9ee45 | 8209 | return _core_.Window_MakeModal(*args, **kwargs) |
e811c8ce RD |
8210 | |
8211 | def SetThemeEnabled(*args, **kwargs): | |
15afbcd0 | 8212 | """ |
a95a7133 | 8213 | SetThemeEnabled(self, bool enableTheme) |
15afbcd0 RD |
8214 | |
8215 | This function tells a window if it should use the system's "theme" | |
8216 | code to draw the windows' background instead if its own background | |
8217 | drawing code. This will only have an effect on platforms that support | |
8218 | the notion of themes in user defined windows. One such platform is | |
8219 | GTK+ where windows can have (very colourful) backgrounds defined by a | |
8220 | user's selected theme. | |
8221 | ||
8222 | Dialogs, notebook pages and the status bar have this flag set to true | |
8223 | by default so that the default look and feel is simulated best. | |
8224 | """ | |
54f9ee45 | 8225 | return _core_.Window_SetThemeEnabled(*args, **kwargs) |
e811c8ce RD |
8226 | |
8227 | def GetThemeEnabled(*args, **kwargs): | |
15afbcd0 | 8228 | """ |
a95a7133 | 8229 | GetThemeEnabled(self) -> bool |
e811c8ce | 8230 | |
15afbcd0 RD |
8231 | Return the themeEnabled flag. |
8232 | """ | |
54f9ee45 | 8233 | return _core_.Window_GetThemeEnabled(*args, **kwargs) |
e811c8ce RD |
8234 | |
8235 | def SetFocus(*args, **kwargs): | |
15afbcd0 | 8236 | """ |
a95a7133 | 8237 | SetFocus(self) |
15afbcd0 RD |
8238 | |
8239 | Set's the focus to this window, allowing it to receive keyboard input. | |
8240 | """ | |
54f9ee45 | 8241 | return _core_.Window_SetFocus(*args, **kwargs) |
e811c8ce RD |
8242 | |
8243 | def SetFocusFromKbd(*args, **kwargs): | |
15afbcd0 | 8244 | """ |
a95a7133 | 8245 | SetFocusFromKbd(self) |
15afbcd0 RD |
8246 | |
8247 | Set focus to this window as the result of a keyboard action. Normally | |
8248 | only called internally. | |
8249 | """ | |
54f9ee45 | 8250 | return _core_.Window_SetFocusFromKbd(*args, **kwargs) |
e811c8ce RD |
8251 | |
8252 | def FindFocus(*args, **kwargs): | |
15afbcd0 | 8253 | """ |
66c033b4 | 8254 | FindFocus() -> Window |
15afbcd0 RD |
8255 | |
8256 | Returns the window or control that currently has the keyboard focus, | |
8257 | or None. | |
8258 | """ | |
54f9ee45 | 8259 | return _core_.Window_FindFocus(*args, **kwargs) |
e811c8ce RD |
8260 | |
8261 | FindFocus = staticmethod(FindFocus) | |
8262 | def AcceptsFocus(*args, **kwargs): | |
15afbcd0 | 8263 | """ |
a95a7133 | 8264 | AcceptsFocus(self) -> bool |
15afbcd0 RD |
8265 | |
8266 | Can this window have focus? | |
8267 | """ | |
54f9ee45 | 8268 | return _core_.Window_AcceptsFocus(*args, **kwargs) |
e811c8ce RD |
8269 | |
8270 | def AcceptsFocusFromKeyboard(*args, **kwargs): | |
15afbcd0 | 8271 | """ |
a95a7133 | 8272 | AcceptsFocusFromKeyboard(self) -> bool |
15afbcd0 RD |
8273 | |
8274 | Can this window be given focus by keyboard navigation? if not, the | |
8275 | only way to give it focus (provided it accepts it at all) is to click | |
8276 | it. | |
8277 | """ | |
54f9ee45 | 8278 | return _core_.Window_AcceptsFocusFromKeyboard(*args, **kwargs) |
e811c8ce RD |
8279 | |
8280 | def GetDefaultItem(*args, **kwargs): | |
15afbcd0 | 8281 | """ |
a95a7133 | 8282 | GetDefaultItem(self) -> Window |
15afbcd0 RD |
8283 | |
8284 | Get the default child of this parent, i.e. the one which is activated | |
8285 | by pressing <Enter> such as the OK button on a wx.Dialog. | |
8286 | """ | |
54f9ee45 | 8287 | return _core_.Window_GetDefaultItem(*args, **kwargs) |
e811c8ce RD |
8288 | |
8289 | def SetDefaultItem(*args, **kwargs): | |
15afbcd0 | 8290 | """ |
a95a7133 | 8291 | SetDefaultItem(self, Window child) -> Window |
15afbcd0 RD |
8292 | |
8293 | Set this child as default, return the old default. | |
8294 | """ | |
54f9ee45 | 8295 | return _core_.Window_SetDefaultItem(*args, **kwargs) |
e811c8ce RD |
8296 | |
8297 | def SetTmpDefaultItem(*args, **kwargs): | |
15afbcd0 | 8298 | """ |
a95a7133 | 8299 | SetTmpDefaultItem(self, Window win) |
15afbcd0 RD |
8300 | |
8301 | Set this child as temporary default | |
8302 | """ | |
54f9ee45 | 8303 | return _core_.Window_SetTmpDefaultItem(*args, **kwargs) |
e811c8ce | 8304 | |
908b74cd RD |
8305 | def Navigate(*args, **kwargs): |
8306 | """ | |
8307 | Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool | |
8308 | ||
fd2dc343 RD |
8309 | Does keyboard navigation from this window to another, by sending a |
8310 | `wx.NavigationKeyEvent`. | |
908b74cd RD |
8311 | """ |
8312 | return _core_.Window_Navigate(*args, **kwargs) | |
8313 | ||
7f98d120 RD |
8314 | def MoveAfterInTabOrder(*args, **kwargs): |
8315 | """ | |
8316 | MoveAfterInTabOrder(self, Window win) | |
8317 | ||
8318 | Moves this window in the tab navigation order after the specified | |
8319 | sibling window. This means that when the user presses the TAB key on | |
8320 | that other window, the focus switches to this window. | |
8321 | ||
8322 | The default tab order is the same as creation order. This function | |
8323 | and `MoveBeforeInTabOrder` allow to change it after creating all the | |
8324 | windows. | |
8325 | ||
8326 | """ | |
8327 | return _core_.Window_MoveAfterInTabOrder(*args, **kwargs) | |
8328 | ||
8329 | def MoveBeforeInTabOrder(*args, **kwargs): | |
8330 | """ | |
8331 | MoveBeforeInTabOrder(self, Window win) | |
8332 | ||
8333 | Same as `MoveAfterInTabOrder` except that it inserts this window just | |
8334 | before win instead of putting it right after it. | |
8335 | """ | |
8336 | return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs) | |
8337 | ||
e811c8ce | 8338 | def GetChildren(*args, **kwargs): |
15afbcd0 | 8339 | """ |
a95a7133 | 8340 | GetChildren(self) -> PyObject |
15afbcd0 RD |
8341 | |
8342 | Returns a list of the window's children. NOTE: Currently this is a | |
8343 | copy of the child window list maintained by the window, so the return | |
8344 | value of this function is only valid as long as the window's children | |
8345 | do not change. | |
8346 | """ | |
54f9ee45 | 8347 | return _core_.Window_GetChildren(*args, **kwargs) |
e811c8ce RD |
8348 | |
8349 | def GetParent(*args, **kwargs): | |
15afbcd0 | 8350 | """ |
a95a7133 | 8351 | GetParent(self) -> Window |
15afbcd0 RD |
8352 | |
8353 | Returns the parent window of this window, or None if there isn't one. | |
8354 | """ | |
54f9ee45 | 8355 | return _core_.Window_GetParent(*args, **kwargs) |
e811c8ce RD |
8356 | |
8357 | def GetGrandParent(*args, **kwargs): | |
15afbcd0 | 8358 | """ |
a95a7133 | 8359 | GetGrandParent(self) -> Window |
15afbcd0 | 8360 | |
41e2b43e RD |
8361 | Returns the parent of the parent of this window, or None if there |
8362 | isn't one. | |
15afbcd0 | 8363 | """ |
54f9ee45 | 8364 | return _core_.Window_GetGrandParent(*args, **kwargs) |
e811c8ce RD |
8365 | |
8366 | def IsTopLevel(*args, **kwargs): | |
15afbcd0 | 8367 | """ |
a95a7133 | 8368 | IsTopLevel(self) -> bool |
15afbcd0 RD |
8369 | |
8370 | Returns true if the given window is a top-level one. Currently all | |
8371 | frames and dialogs are always considered to be top-level windows (even | |
8372 | if they have a parent window). | |
8373 | """ | |
54f9ee45 | 8374 | return _core_.Window_IsTopLevel(*args, **kwargs) |
e811c8ce RD |
8375 | |
8376 | def Reparent(*args, **kwargs): | |
15afbcd0 | 8377 | """ |
a95a7133 | 8378 | Reparent(self, Window newParent) -> bool |
15afbcd0 RD |
8379 | |
8380 | Reparents the window, i.e the window will be removed from its current | |
8381 | parent window (e.g. a non-standard toolbar in a wxFrame) and then | |
8382 | re-inserted into another. Available on Windows and GTK. Returns True | |
8383 | if the parent was changed, False otherwise (error or newParent == | |
8384 | oldParent) | |
8385 | """ | |
54f9ee45 | 8386 | return _core_.Window_Reparent(*args, **kwargs) |
e811c8ce RD |
8387 | |
8388 | def AddChild(*args, **kwargs): | |
15afbcd0 | 8389 | """ |
a95a7133 | 8390 | AddChild(self, Window child) |
15afbcd0 RD |
8391 | |
8392 | Adds a child window. This is called automatically by window creation | |
8393 | functions so should not be required by the application programmer. | |
8394 | """ | |
54f9ee45 | 8395 | return _core_.Window_AddChild(*args, **kwargs) |
e811c8ce RD |
8396 | |
8397 | def RemoveChild(*args, **kwargs): | |
15afbcd0 | 8398 | """ |
a95a7133 | 8399 | RemoveChild(self, Window child) |
15afbcd0 RD |
8400 | |
8401 | Removes a child window. This is called automatically by window | |
8402 | deletion functions so should not be required by the application | |
8403 | programmer. | |
8404 | """ | |
54f9ee45 | 8405 | return _core_.Window_RemoveChild(*args, **kwargs) |
e811c8ce | 8406 | |
704eda0c RD |
8407 | def SetDoubleBuffered(*args, **kwargs): |
8408 | """ | |
8409 | SetDoubleBuffered(self, bool on) | |
8410 | ||
8411 | Currently wxGTK2 only. | |
8412 | """ | |
8413 | return _core_.Window_SetDoubleBuffered(*args, **kwargs) | |
8414 | ||
e811c8ce | 8415 | def FindWindowById(*args, **kwargs): |
15afbcd0 | 8416 | """ |
a95a7133 | 8417 | FindWindowById(self, long winid) -> Window |
15afbcd0 RD |
8418 | |
8419 | Find a chld of this window by window ID | |
8420 | """ | |
54f9ee45 | 8421 | return _core_.Window_FindWindowById(*args, **kwargs) |
e811c8ce RD |
8422 | |
8423 | def FindWindowByName(*args, **kwargs): | |
15afbcd0 | 8424 | """ |
a95a7133 | 8425 | FindWindowByName(self, String name) -> Window |
15afbcd0 RD |
8426 | |
8427 | Find a child of this window by name | |
8428 | """ | |
54f9ee45 | 8429 | return _core_.Window_FindWindowByName(*args, **kwargs) |
e811c8ce RD |
8430 | |
8431 | def GetEventHandler(*args, **kwargs): | |
15afbcd0 | 8432 | """ |
a95a7133 | 8433 | GetEventHandler(self) -> EvtHandler |
15afbcd0 RD |
8434 | |
8435 | Returns the event handler for this window. By default, the window is | |
8436 | its own event handler. | |
8437 | """ | |
54f9ee45 | 8438 | return _core_.Window_GetEventHandler(*args, **kwargs) |
e811c8ce RD |
8439 | |
8440 | def SetEventHandler(*args, **kwargs): | |
15afbcd0 | 8441 | """ |
a95a7133 | 8442 | SetEventHandler(self, EvtHandler handler) |
15afbcd0 RD |
8443 | |
8444 | Sets the event handler for this window. An event handler is an object | |
8445 | that is capable of processing the events sent to a window. By default, | |
8446 | the window is its own event handler, but an application may wish to | |
8447 | substitute another, for example to allow central implementation of | |
8448 | event-handling for a variety of different window classes. | |
8449 | ||
41e2b43e | 8450 | It is usually better to use `wx.Window.PushEventHandler` since this sets |
15afbcd0 RD |
8451 | up a chain of event handlers, where an event not handled by one event |
8452 | handler is handed to the next one in the chain. | |
8453 | """ | |
54f9ee45 | 8454 | return _core_.Window_SetEventHandler(*args, **kwargs) |
e811c8ce RD |
8455 | |
8456 | def PushEventHandler(*args, **kwargs): | |
15afbcd0 | 8457 | """ |
a95a7133 | 8458 | PushEventHandler(self, EvtHandler handler) |
15afbcd0 RD |
8459 | |
8460 | Pushes this event handler onto the event handler stack for the window. | |
8461 | An event handler is an object that is capable of processing the events | |
8462 | sent to a window. By default, the window is its own event handler, but | |
8463 | an application may wish to substitute another, for example to allow | |
8464 | central implementation of event-handling for a variety of different | |
8465 | window classes. | |
8466 | ||
8467 | wx.Window.PushEventHandler allows an application to set up a chain of | |
8468 | event handlers, where an event not handled by one event handler is | |
41e2b43e | 8469 | handed to the next one in the chain. Use `wx.Window.PopEventHandler` to |
15afbcd0 RD |
8470 | remove the event handler. |
8471 | """ | |
54f9ee45 | 8472 | return _core_.Window_PushEventHandler(*args, **kwargs) |
e811c8ce RD |
8473 | |
8474 | def PopEventHandler(*args, **kwargs): | |
15afbcd0 | 8475 | """ |
a95a7133 | 8476 | PopEventHandler(self, bool deleteHandler=False) -> EvtHandler |
15afbcd0 RD |
8477 | |
8478 | Removes and returns the top-most event handler on the event handler | |
8479 | stack. If deleteHandler is True then the wx.EvtHandler object will be | |
8480 | destroyed after it is popped. | |
8481 | """ | |
54f9ee45 | 8482 | return _core_.Window_PopEventHandler(*args, **kwargs) |
e811c8ce RD |
8483 | |
8484 | def RemoveEventHandler(*args, **kwargs): | |
15afbcd0 | 8485 | """ |
a95a7133 | 8486 | RemoveEventHandler(self, EvtHandler handler) -> bool |
15afbcd0 | 8487 | |
41e2b43e RD |
8488 | Find the given handler in the event handler chain and remove (but not |
8489 | delete) it from the event handler chain, return True if it was found | |
8490 | and False otherwise (this also results in an assert failure so this | |
8491 | function should only be called when the handler is supposed to be | |
8492 | there.) | |
15afbcd0 | 8493 | """ |
54f9ee45 | 8494 | return _core_.Window_RemoveEventHandler(*args, **kwargs) |
e811c8ce RD |
8495 | |
8496 | def SetValidator(*args, **kwargs): | |
15afbcd0 | 8497 | """ |
a95a7133 | 8498 | SetValidator(self, Validator validator) |
15afbcd0 RD |
8499 | |
8500 | Deletes the current validator (if any) and sets the window validator, | |
8501 | having called wx.Validator.Clone to create a new validator of this | |
8502 | type. | |
8503 | """ | |
54f9ee45 | 8504 | return _core_.Window_SetValidator(*args, **kwargs) |
e811c8ce RD |
8505 | |
8506 | def GetValidator(*args, **kwargs): | |
15afbcd0 | 8507 | """ |
a95a7133 | 8508 | GetValidator(self) -> Validator |
15afbcd0 RD |
8509 | |
8510 | Returns a pointer to the current validator for the window, or None if | |
8511 | there is none. | |
8512 | """ | |
54f9ee45 | 8513 | return _core_.Window_GetValidator(*args, **kwargs) |
e811c8ce | 8514 | |
74a57fcd RD |
8515 | def Validate(*args, **kwargs): |
8516 | """ | |
a95a7133 | 8517 | Validate(self) -> bool |
74a57fcd RD |
8518 | |
8519 | Validates the current values of the child controls using their | |
41e2b43e RD |
8520 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra |
8521 | style flag set, the method will also call Validate() of all child | |
8522 | windows. Returns false if any of the validations failed. | |
74a57fcd | 8523 | """ |
54f9ee45 | 8524 | return _core_.Window_Validate(*args, **kwargs) |
74a57fcd RD |
8525 | |
8526 | def TransferDataToWindow(*args, **kwargs): | |
8527 | """ | |
a95a7133 | 8528 | TransferDataToWindow(self) -> bool |
74a57fcd | 8529 | |
41e2b43e RD |
8530 | Transfers values to child controls from data areas specified by their |
8531 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra | |
8532 | style flag set, the method will also call TransferDataToWindow() of | |
8533 | all child windows. | |
74a57fcd | 8534 | """ |
54f9ee45 | 8535 | return _core_.Window_TransferDataToWindow(*args, **kwargs) |
74a57fcd RD |
8536 | |
8537 | def TransferDataFromWindow(*args, **kwargs): | |
8538 | """ | |
a95a7133 | 8539 | TransferDataFromWindow(self) -> bool |
74a57fcd | 8540 | |
41e2b43e RD |
8541 | Transfers values from child controls to data areas specified by their |
8542 | validators. Returns false if a transfer failed. If the window has | |
8543 | wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will | |
8544 | also call TransferDataFromWindow() of all child windows. | |
74a57fcd | 8545 | """ |
54f9ee45 | 8546 | return _core_.Window_TransferDataFromWindow(*args, **kwargs) |
74a57fcd RD |
8547 | |
8548 | def InitDialog(*args, **kwargs): | |
8549 | """ | |
a95a7133 | 8550 | InitDialog(self) |
74a57fcd | 8551 | |
41e2b43e RD |
8552 | Sends an EVT_INIT_DIALOG event, whose handler usually transfers data |
8553 | to the dialog via validators. | |
74a57fcd | 8554 | """ |
54f9ee45 | 8555 | return _core_.Window_InitDialog(*args, **kwargs) |
74a57fcd | 8556 | |
e811c8ce | 8557 | def SetAcceleratorTable(*args, **kwargs): |
15afbcd0 | 8558 | """ |
a95a7133 | 8559 | SetAcceleratorTable(self, AcceleratorTable accel) |
15afbcd0 RD |
8560 | |
8561 | Sets the accelerator table for this window. | |
8562 | """ | |
54f9ee45 | 8563 | return _core_.Window_SetAcceleratorTable(*args, **kwargs) |
e811c8ce RD |
8564 | |
8565 | def GetAcceleratorTable(*args, **kwargs): | |
15afbcd0 | 8566 | """ |
a95a7133 | 8567 | GetAcceleratorTable(self) -> AcceleratorTable |
15afbcd0 RD |
8568 | |
8569 | Gets the accelerator table for this window. | |
8570 | """ | |
54f9ee45 | 8571 | return _core_.Window_GetAcceleratorTable(*args, **kwargs) |
e811c8ce RD |
8572 | |
8573 | def RegisterHotKey(*args, **kwargs): | |
15afbcd0 | 8574 | """ |
a95a7133 | 8575 | RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool |
15afbcd0 RD |
8576 | |
8577 | Registers a system wide hotkey. Every time the user presses the hotkey | |
8578 | registered here, this window will receive a hotkey event. It will | |
8579 | receive the event even if the application is in the background and | |
8580 | does not have the input focus because the user is working with some | |
8581 | other application. To bind an event handler function to this hotkey | |
8582 | use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the | |
8583 | hotkey was registered successfully. | |
8584 | """ | |
54f9ee45 | 8585 | return _core_.Window_RegisterHotKey(*args, **kwargs) |
e811c8ce RD |
8586 | |
8587 | def UnregisterHotKey(*args, **kwargs): | |
15afbcd0 | 8588 | """ |
a95a7133 | 8589 | UnregisterHotKey(self, int hotkeyId) -> bool |
15afbcd0 RD |
8590 | |
8591 | Unregisters a system wide hotkey. | |
8592 | """ | |
54f9ee45 | 8593 | return _core_.Window_UnregisterHotKey(*args, **kwargs) |
e811c8ce RD |
8594 | |
8595 | def ConvertDialogPointToPixels(*args, **kwargs): | |
15afbcd0 | 8596 | """ |
a95a7133 | 8597 | ConvertDialogPointToPixels(self, Point pt) -> Point |
15afbcd0 RD |
8598 | |
8599 | Converts a point or size from dialog units to pixels. Dialog units | |
8600 | are used for maintaining a dialog's proportions even if the font | |
8601 | changes. For the x dimension, the dialog units are multiplied by the | |
8602 | average character width and then divided by 4. For the y dimension, | |
8603 | the dialog units are multiplied by the average character height and | |
8604 | then divided by 8. | |
8605 | """ | |
54f9ee45 | 8606 | return _core_.Window_ConvertDialogPointToPixels(*args, **kwargs) |
e811c8ce RD |
8607 | |
8608 | def ConvertDialogSizeToPixels(*args, **kwargs): | |
15afbcd0 | 8609 | """ |
a95a7133 | 8610 | ConvertDialogSizeToPixels(self, Size sz) -> Size |
15afbcd0 RD |
8611 | |
8612 | Converts a point or size from dialog units to pixels. Dialog units | |
8613 | are used for maintaining a dialog's proportions even if the font | |
8614 | changes. For the x dimension, the dialog units are multiplied by the | |
8615 | average character width and then divided by 4. For the y dimension, | |
8616 | the dialog units are multiplied by the average character height and | |
8617 | then divided by 8. | |
8618 | """ | |
54f9ee45 | 8619 | return _core_.Window_ConvertDialogSizeToPixels(*args, **kwargs) |
e811c8ce RD |
8620 | |
8621 | def DLG_PNT(*args, **kwargs): | |
15afbcd0 | 8622 | """ |
a95a7133 | 8623 | DLG_PNT(self, Point pt) -> Point |
15afbcd0 RD |
8624 | |
8625 | Converts a point or size from dialog units to pixels. Dialog units | |
8626 | are used for maintaining a dialog's proportions even if the font | |
8627 | changes. For the x dimension, the dialog units are multiplied by the | |
8628 | average character width and then divided by 4. For the y dimension, | |
8629 | the dialog units are multiplied by the average character height and | |
8630 | then divided by 8. | |
8631 | """ | |
54f9ee45 | 8632 | return _core_.Window_DLG_PNT(*args, **kwargs) |
e811c8ce RD |
8633 | |
8634 | def DLG_SZE(*args, **kwargs): | |
15afbcd0 | 8635 | """ |
a95a7133 | 8636 | DLG_SZE(self, Size sz) -> Size |
15afbcd0 RD |
8637 | |
8638 | Converts a point or size from dialog units to pixels. Dialog units | |
8639 | are used for maintaining a dialog's proportions even if the font | |
8640 | changes. For the x dimension, the dialog units are multiplied by the | |
8641 | average character width and then divided by 4. For the y dimension, | |
8642 | the dialog units are multiplied by the average character height and | |
8643 | then divided by 8. | |
8644 | """ | |
54f9ee45 | 8645 | return _core_.Window_DLG_SZE(*args, **kwargs) |
e811c8ce RD |
8646 | |
8647 | def ConvertPixelPointToDialog(*args, **kwargs): | |
a95a7133 | 8648 | """ConvertPixelPointToDialog(self, Point pt) -> Point""" |
54f9ee45 | 8649 | return _core_.Window_ConvertPixelPointToDialog(*args, **kwargs) |
e811c8ce RD |
8650 | |
8651 | def ConvertPixelSizeToDialog(*args, **kwargs): | |
a95a7133 | 8652 | """ConvertPixelSizeToDialog(self, Size sz) -> Size""" |
54f9ee45 | 8653 | return _core_.Window_ConvertPixelSizeToDialog(*args, **kwargs) |
e811c8ce RD |
8654 | |
8655 | def WarpPointer(*args, **kwargs): | |
15afbcd0 | 8656 | """ |
a95a7133 | 8657 | WarpPointer(self, int x, int y) |
15afbcd0 RD |
8658 | |
8659 | Moves the pointer to the given position on the window. | |
8660 | ||
8661 | NOTE: This function is not supported under Mac because Apple Human | |
8662 | Interface Guidelines forbid moving the mouse cursor programmatically. | |
8663 | """ | |
54f9ee45 | 8664 | return _core_.Window_WarpPointer(*args, **kwargs) |
e811c8ce RD |
8665 | |
8666 | def CaptureMouse(*args, **kwargs): | |
15afbcd0 | 8667 | """ |
a95a7133 | 8668 | CaptureMouse(self) |
15afbcd0 RD |
8669 | |
8670 | Directs all mouse input to this window. Call wx.Window.ReleaseMouse to | |
8671 | release the capture. | |
8672 | ||
8673 | Note that wxWindows maintains the stack of windows having captured the | |
8674 | mouse and when the mouse is released the capture returns to the window | |
8675 | which had had captured it previously and it is only really released if | |
8676 | there were no previous window. In particular, this means that you must | |
8677 | release the mouse as many times as you capture it. | |
8678 | """ | |
54f9ee45 | 8679 | return _core_.Window_CaptureMouse(*args, **kwargs) |
e811c8ce RD |
8680 | |
8681 | def ReleaseMouse(*args, **kwargs): | |
15afbcd0 | 8682 | """ |
a95a7133 | 8683 | ReleaseMouse(self) |
15afbcd0 RD |
8684 | |
8685 | Releases mouse input captured with wx.Window.CaptureMouse. | |
8686 | """ | |
54f9ee45 | 8687 | return _core_.Window_ReleaseMouse(*args, **kwargs) |
e811c8ce RD |
8688 | |
8689 | def GetCapture(*args, **kwargs): | |
15afbcd0 | 8690 | """ |
66c033b4 | 8691 | GetCapture() -> Window |
15afbcd0 RD |
8692 | |
8693 | Returns the window which currently captures the mouse or None | |
8694 | """ | |
54f9ee45 | 8695 | return _core_.Window_GetCapture(*args, **kwargs) |
e811c8ce RD |
8696 | |
8697 | GetCapture = staticmethod(GetCapture) | |
8698 | def HasCapture(*args, **kwargs): | |
15afbcd0 | 8699 | """ |
a95a7133 | 8700 | HasCapture(self) -> bool |
15afbcd0 RD |
8701 | |
8702 | Returns true if this window has the current mouse capture. | |
8703 | """ | |
54f9ee45 | 8704 | return _core_.Window_HasCapture(*args, **kwargs) |
e811c8ce RD |
8705 | |
8706 | def Refresh(*args, **kwargs): | |
15afbcd0 | 8707 | """ |
a95a7133 | 8708 | Refresh(self, bool eraseBackground=True, Rect rect=None) |
15afbcd0 RD |
8709 | |
8710 | Mark the specified rectangle (or the whole window) as "dirty" so it | |
8711 | will be repainted. Causes an EVT_PAINT event to be generated and sent | |
8712 | to the window. | |
8713 | """ | |
54f9ee45 | 8714 | return _core_.Window_Refresh(*args, **kwargs) |
e811c8ce RD |
8715 | |
8716 | def RefreshRect(*args, **kwargs): | |
15afbcd0 | 8717 | """ |
fef4c27a | 8718 | RefreshRect(self, Rect rect, bool eraseBackground=True) |
15afbcd0 RD |
8719 | |
8720 | Redraws the contents of the given rectangle: the area inside it will | |
8721 | be repainted. This is the same as Refresh but has a nicer syntax. | |
8722 | """ | |
54f9ee45 | 8723 | return _core_.Window_RefreshRect(*args, **kwargs) |
e811c8ce RD |
8724 | |
8725 | def Update(*args, **kwargs): | |
15afbcd0 | 8726 | """ |
a95a7133 | 8727 | Update(self) |
15afbcd0 RD |
8728 | |
8729 | Calling this method immediately repaints the invalidated area of the | |
8730 | window instead of waiting for the EVT_PAINT event to happen, (normally | |
8731 | this would usually only happen when the flow of control returns to the | |
8732 | event loop.) Notice that this function doesn't refresh the window and | |
8733 | does nothing if the window has been already repainted. Use Refresh | |
8734 | first if you want to immediately redraw the window (or some portion of | |
8735 | it) unconditionally. | |
8736 | """ | |
54f9ee45 | 8737 | return _core_.Window_Update(*args, **kwargs) |
e811c8ce RD |
8738 | |
8739 | def ClearBackground(*args, **kwargs): | |
15afbcd0 | 8740 | """ |
a95a7133 | 8741 | ClearBackground(self) |
15afbcd0 RD |
8742 | |
8743 | Clears the window by filling it with the current background | |
8744 | colour. Does not cause an erase background event to be generated. | |
8745 | """ | |
54f9ee45 | 8746 | return _core_.Window_ClearBackground(*args, **kwargs) |
e811c8ce RD |
8747 | |
8748 | def Freeze(*args, **kwargs): | |
15afbcd0 | 8749 | """ |
a95a7133 | 8750 | Freeze(self) |
15afbcd0 | 8751 | |
41e2b43e RD |
8752 | Freezes the window or, in other words, prevents any updates from |
8753 | taking place on screen, the window is not redrawn at all. Thaw must be | |
8754 | called to reenable window redrawing. Calls to Freeze/Thaw may be | |
8755 | nested, with the actual Thaw being delayed until all the nesting has | |
8756 | been undone. | |
15afbcd0 RD |
8757 | |
8758 | This method is useful for visual appearance optimization (for example, | |
8759 | it is a good idea to use it before inserting large amount of text into | |
8760 | a wxTextCtrl under wxGTK) but is not implemented on all platforms nor | |
8761 | for all controls so it is mostly just a hint to wxWindows and not a | |
8762 | mandatory directive. | |
8763 | """ | |
54f9ee45 | 8764 | return _core_.Window_Freeze(*args, **kwargs) |
e811c8ce RD |
8765 | |
8766 | def Thaw(*args, **kwargs): | |
15afbcd0 | 8767 | """ |
a95a7133 | 8768 | Thaw(self) |
15afbcd0 | 8769 | |
4276dc52 | 8770 | Reenables window updating after a previous call to Freeze. Calls to |
41e2b43e RD |
8771 | Freeze/Thaw may be nested, so Thaw must be called the same number of |
8772 | times that Freeze was before the window will be updated. | |
15afbcd0 | 8773 | """ |
54f9ee45 | 8774 | return _core_.Window_Thaw(*args, **kwargs) |
e811c8ce RD |
8775 | |
8776 | def PrepareDC(*args, **kwargs): | |
15afbcd0 | 8777 | """ |
a95a7133 | 8778 | PrepareDC(self, DC dc) |
15afbcd0 RD |
8779 | |
8780 | Call this function to prepare the device context for drawing a | |
8781 | scrolled image. It sets the device origin according to the current | |
8782 | scroll position. | |
8783 | """ | |
54f9ee45 | 8784 | return _core_.Window_PrepareDC(*args, **kwargs) |
e811c8ce RD |
8785 | |
8786 | def GetUpdateRegion(*args, **kwargs): | |
15afbcd0 | 8787 | """ |
a95a7133 | 8788 | GetUpdateRegion(self) -> Region |
15afbcd0 RD |
8789 | |
8790 | Returns the region specifying which parts of the window have been | |
8791 | damaged. Should only be called within an EVT_PAINT handler. | |
8792 | """ | |
54f9ee45 | 8793 | return _core_.Window_GetUpdateRegion(*args, **kwargs) |
e811c8ce RD |
8794 | |
8795 | def GetUpdateClientRect(*args, **kwargs): | |
15afbcd0 | 8796 | """ |
a95a7133 | 8797 | GetUpdateClientRect(self) -> Rect |
15afbcd0 RD |
8798 | |
8799 | Get the update rectangle region bounding box in client coords. | |
8800 | """ | |
54f9ee45 | 8801 | return _core_.Window_GetUpdateClientRect(*args, **kwargs) |
e811c8ce RD |
8802 | |
8803 | def IsExposed(*args, **kwargs): | |
15afbcd0 | 8804 | """ |
a95a7133 | 8805 | IsExposed(self, int x, int y, int w=1, int h=1) -> bool |
15afbcd0 RD |
8806 | |
8807 | Returns true if the given point or rectangle area has been exposed | |
8808 | since the last repaint. Call this in an paint event handler to | |
8809 | optimize redrawing by only redrawing those areas, which have been | |
8810 | exposed. | |
8811 | """ | |
54f9ee45 | 8812 | return _core_.Window_IsExposed(*args, **kwargs) |
e811c8ce RD |
8813 | |
8814 | def IsExposedPoint(*args, **kwargs): | |
15afbcd0 | 8815 | """ |
a95a7133 | 8816 | IsExposedPoint(self, Point pt) -> bool |
15afbcd0 RD |
8817 | |
8818 | Returns true if the given point or rectangle area has been exposed | |
8819 | since the last repaint. Call this in an paint event handler to | |
8820 | optimize redrawing by only redrawing those areas, which have been | |
8821 | exposed. | |
8822 | """ | |
54f9ee45 | 8823 | return _core_.Window_IsExposedPoint(*args, **kwargs) |
e811c8ce | 8824 | |
4276dc52 | 8825 | def IsExposedRect(*args, **kwargs): |
15afbcd0 | 8826 | """ |
a95a7133 | 8827 | IsExposedRect(self, Rect rect) -> bool |
15afbcd0 RD |
8828 | |
8829 | Returns true if the given point or rectangle area has been exposed | |
8830 | since the last repaint. Call this in an paint event handler to | |
8831 | optimize redrawing by only redrawing those areas, which have been | |
8832 | exposed. | |
8833 | """ | |
54f9ee45 | 8834 | return _core_.Window_IsExposedRect(*args, **kwargs) |
e811c8ce | 8835 | |
74a57fcd RD |
8836 | def GetDefaultAttributes(*args, **kwargs): |
8837 | """ | |
a95a7133 | 8838 | GetDefaultAttributes(self) -> VisualAttributes |
74a57fcd | 8839 | |
41e2b43e RD |
8840 | Get the default attributes for an instance of this class. This is |
8841 | useful if you want to use the same font or colour in your own control | |
8842 | as in a standard control -- which is a much better idea than hard | |
8843 | coding specific colours or fonts which might look completely out of | |
db3e571a | 8844 | place on the user's system, especially if it uses themes. |
74a57fcd | 8845 | """ |
54f9ee45 | 8846 | return _core_.Window_GetDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
8847 | |
8848 | def GetClassDefaultAttributes(*args, **kwargs): | |
8849 | """ | |
66c033b4 | 8850 | GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
74a57fcd | 8851 | |
41e2b43e RD |
8852 | Get the default attributes for this class. This is useful if you want |
8853 | to use the same font or colour in your own control as in a standard | |
8854 | control -- which is a much better idea than hard coding specific | |
db3e571a RD |
8855 | colours or fonts which might look completely out of place on the |
8856 | user's system, especially if it uses themes. | |
74a57fcd RD |
8857 | |
8858 | The variant parameter is only relevant under Mac currently and is | |
41e2b43e | 8859 | ignore under other platforms. Under Mac, it will change the size of |
db3e571a RD |
8860 | the returned font. See `wx.Window.SetWindowVariant` for more about |
8861 | this. | |
74a57fcd | 8862 | """ |
54f9ee45 | 8863 | return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
8864 | |
8865 | GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) | |
e811c8ce | 8866 | def SetBackgroundColour(*args, **kwargs): |
15afbcd0 | 8867 | """ |
a95a7133 | 8868 | SetBackgroundColour(self, Colour colour) -> bool |
15afbcd0 RD |
8869 | |
8870 | Sets the background colour of the window. Returns True if the colour | |
8871 | was changed. The background colour is usually painted by the default | |
8872 | EVT_ERASE_BACKGROUND event handler function under Windows and | |
f8167d6e RD |
8873 | automatically under GTK. Using `wx.NullColour` will reset the window |
8874 | to the default background colour. | |
15afbcd0 | 8875 | |
db3e571a | 8876 | Note that setting the background colour may not cause an immediate |
f8167d6e | 8877 | refresh, so you may wish to call `ClearBackground` or `Refresh` after |
15afbcd0 RD |
8878 | calling this function. |
8879 | ||
f8167d6e RD |
8880 | Using this function will disable attempts to use themes for this |
8881 | window, if the system supports them. Use with care since usually the | |
8882 | themes represent the appearance chosen by the user to be used for all | |
8883 | applications on the system. | |
15afbcd0 | 8884 | """ |
54f9ee45 | 8885 | return _core_.Window_SetBackgroundColour(*args, **kwargs) |
e811c8ce | 8886 | |
412d302d RD |
8887 | def SetOwnBackgroundColour(*args, **kwargs): |
8888 | """SetOwnBackgroundColour(self, Colour colour)""" | |
8889 | return _core_.Window_SetOwnBackgroundColour(*args, **kwargs) | |
b2df227b | 8890 | |
e811c8ce | 8891 | def SetForegroundColour(*args, **kwargs): |
15afbcd0 | 8892 | """ |
a95a7133 | 8893 | SetForegroundColour(self, Colour colour) -> bool |
15afbcd0 RD |
8894 | |
8895 | Sets the foreground colour of the window. Returns True is the colour | |
8896 | was changed. The interpretation of foreground colour is dependent on | |
8897 | the window class; it may be the text colour or other colour, or it may | |
8898 | not be used at all. | |
8899 | """ | |
54f9ee45 | 8900 | return _core_.Window_SetForegroundColour(*args, **kwargs) |
e811c8ce | 8901 | |
fa47d7a7 VS |
8902 | def SetOwnForegroundColour(*args, **kwargs): |
8903 | """SetOwnForegroundColour(self, Colour colour)""" | |
8904 | return _core_.Window_SetOwnForegroundColour(*args, **kwargs) | |
b2df227b | 8905 | |
e811c8ce | 8906 | def GetBackgroundColour(*args, **kwargs): |
15afbcd0 | 8907 | """ |
a95a7133 | 8908 | GetBackgroundColour(self) -> Colour |
15afbcd0 RD |
8909 | |
8910 | Returns the background colour of the window. | |
8911 | """ | |
54f9ee45 | 8912 | return _core_.Window_GetBackgroundColour(*args, **kwargs) |
e811c8ce RD |
8913 | |
8914 | def GetForegroundColour(*args, **kwargs): | |
15afbcd0 | 8915 | """ |
a95a7133 | 8916 | GetForegroundColour(self) -> Colour |
15afbcd0 RD |
8917 | |
8918 | Returns the foreground colour of the window. The interpretation of | |
8919 | foreground colour is dependent on the window class; it may be the text | |
8920 | colour or other colour, or it may not be used at all. | |
8921 | """ | |
54f9ee45 | 8922 | return _core_.Window_GetForegroundColour(*args, **kwargs) |
e811c8ce | 8923 | |
562ecc31 RD |
8924 | def InheritsBackgroundColour(*args, **kwargs): |
8925 | """InheritsBackgroundColour(self) -> bool""" | |
8926 | return _core_.Window_InheritsBackgroundColour(*args, **kwargs) | |
8927 | ||
8928 | def UseBgCol(*args, **kwargs): | |
8929 | """UseBgCol(self) -> bool""" | |
8930 | return _core_.Window_UseBgCol(*args, **kwargs) | |
8931 | ||
7bc1e663 RD |
8932 | def SetBackgroundStyle(*args, **kwargs): |
8933 | """ | |
8934 | SetBackgroundStyle(self, int style) -> bool | |
8935 | ||
8936 | Returns the background style of the window. The background style | |
8937 | indicates how the background of the window is drawn. | |
8938 | ||
8939 | ====================== ======================================== | |
8940 | wx.BG_STYLE_SYSTEM The background colour or pattern should | |
8941 | be determined by the system | |
8942 | wx.BG_STYLE_COLOUR The background should be a solid colour | |
8943 | wx.BG_STYLE_CUSTOM The background will be implemented by the | |
8944 | application. | |
8945 | ====================== ======================================== | |
8946 | ||
8947 | On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of | |
8948 | a custom background, such as a tiled bitmap. Currently the style has | |
8949 | no effect on other platforms. | |
8950 | ||
8951 | :see: `GetBackgroundStyle`, `SetBackgroundColour` | |
8952 | """ | |
8953 | return _core_.Window_SetBackgroundStyle(*args, **kwargs) | |
8954 | ||
8955 | def GetBackgroundStyle(*args, **kwargs): | |
8956 | """ | |
8957 | GetBackgroundStyle(self) -> int | |
8958 | ||
8959 | Returns the background style of the window. | |
8960 | ||
8961 | :see: `SetBackgroundStyle` | |
8962 | """ | |
8963 | return _core_.Window_GetBackgroundStyle(*args, **kwargs) | |
8964 | ||
51b83b37 RD |
8965 | def HasTransparentBackground(*args, **kwargs): |
8966 | """ | |
8967 | HasTransparentBackground(self) -> bool | |
8968 | ||
8969 | Returns True if this window's background is transparent (as, for | |
8970 | example, for `wx.StaticText`) and should show the parent window's | |
8971 | background. | |
8972 | ||
8973 | This method is mostly used internally by the library itself and you | |
8974 | normally shouldn't have to call it. You may, however, have to override | |
8975 | it in your custom control classes to ensure that background is painted | |
8976 | correctly. | |
8977 | """ | |
8978 | return _core_.Window_HasTransparentBackground(*args, **kwargs) | |
8979 | ||
e811c8ce | 8980 | def SetCursor(*args, **kwargs): |
15afbcd0 | 8981 | """ |
a95a7133 | 8982 | SetCursor(self, Cursor cursor) -> bool |
15afbcd0 RD |
8983 | |
8984 | Sets the window's cursor. Notice that the window cursor also sets it | |
8985 | for the children of the window implicitly. | |
8986 | ||
8987 | The cursor may be wx.NullCursor in which case the window cursor will | |
8988 | be reset back to default. | |
8989 | """ | |
54f9ee45 | 8990 | return _core_.Window_SetCursor(*args, **kwargs) |
e811c8ce RD |
8991 | |
8992 | def GetCursor(*args, **kwargs): | |
15afbcd0 | 8993 | """ |
a95a7133 | 8994 | GetCursor(self) -> Cursor |
15afbcd0 RD |
8995 | |
8996 | Return the cursor associated with this window. | |
8997 | """ | |
54f9ee45 | 8998 | return _core_.Window_GetCursor(*args, **kwargs) |
e811c8ce RD |
8999 | |
9000 | def SetFont(*args, **kwargs): | |
15afbcd0 | 9001 | """ |
a95a7133 | 9002 | SetFont(self, Font font) -> bool |
15afbcd0 RD |
9003 | |
9004 | Sets the font for this window. | |
9005 | """ | |
54f9ee45 | 9006 | return _core_.Window_SetFont(*args, **kwargs) |
e811c8ce | 9007 | |
fa47d7a7 VS |
9008 | def SetOwnFont(*args, **kwargs): |
9009 | """SetOwnFont(self, Font font)""" | |
9010 | return _core_.Window_SetOwnFont(*args, **kwargs) | |
b2df227b | 9011 | |
e811c8ce | 9012 | def GetFont(*args, **kwargs): |
15afbcd0 | 9013 | """ |
a95a7133 | 9014 | GetFont(self) -> Font |
15afbcd0 | 9015 | |
4276dc52 | 9016 | Returns the default font used for this window. |
15afbcd0 | 9017 | """ |
54f9ee45 | 9018 | return _core_.Window_GetFont(*args, **kwargs) |
e811c8ce RD |
9019 | |
9020 | def SetCaret(*args, **kwargs): | |
15afbcd0 | 9021 | """ |
a95a7133 | 9022 | SetCaret(self, Caret caret) |
15afbcd0 RD |
9023 | |
9024 | Sets the caret associated with the window. | |
9025 | """ | |
54f9ee45 | 9026 | return _core_.Window_SetCaret(*args, **kwargs) |
e811c8ce RD |
9027 | |
9028 | def GetCaret(*args, **kwargs): | |
15afbcd0 | 9029 | """ |
a95a7133 | 9030 | GetCaret(self) -> Caret |
15afbcd0 RD |
9031 | |
9032 | Returns the caret associated with the window. | |
9033 | """ | |
54f9ee45 | 9034 | return _core_.Window_GetCaret(*args, **kwargs) |
e811c8ce RD |
9035 | |
9036 | def GetCharHeight(*args, **kwargs): | |
15afbcd0 | 9037 | """ |
a95a7133 | 9038 | GetCharHeight(self) -> int |
15afbcd0 RD |
9039 | |
9040 | Get the (average) character size for the current font. | |
9041 | """ | |
54f9ee45 | 9042 | return _core_.Window_GetCharHeight(*args, **kwargs) |
e811c8ce RD |
9043 | |
9044 | def GetCharWidth(*args, **kwargs): | |
15afbcd0 | 9045 | """ |
a95a7133 | 9046 | GetCharWidth(self) -> int |
15afbcd0 RD |
9047 | |
9048 | Get the (average) character size for the current font. | |
9049 | """ | |
54f9ee45 | 9050 | return _core_.Window_GetCharWidth(*args, **kwargs) |
e811c8ce RD |
9051 | |
9052 | def GetTextExtent(*args, **kwargs): | |
fd2dc343 RD |
9053 | """ |
9054 | GetTextExtent(String string) -> (width, height) | |
9055 | ||
9056 | Get the width and height of the text using the current font. | |
9057 | """ | |
54f9ee45 | 9058 | return _core_.Window_GetTextExtent(*args, **kwargs) |
e811c8ce RD |
9059 | |
9060 | def GetFullTextExtent(*args, **kwargs): | |
0df68c9f | 9061 | """ |
196addbf | 9062 | GetFullTextExtent(String string, Font font=None) -> |
0df68c9f | 9063 | (width, height, descent, externalLeading) |
e811c8ce | 9064 | |
15afbcd0 RD |
9065 | Get the width, height, decent and leading of the text using the |
9066 | current or specified font. | |
0df68c9f | 9067 | """ |
54f9ee45 | 9068 | return _core_.Window_GetFullTextExtent(*args, **kwargs) |
e811c8ce RD |
9069 | |
9070 | def ClientToScreenXY(*args, **kwargs): | |
15afbcd0 RD |
9071 | """ |
9072 | ClientToScreenXY(int x, int y) -> (x,y) | |
9073 | ||
9074 | Converts to screen coordinates from coordinates relative to this window. | |
9075 | """ | |
54f9ee45 | 9076 | return _core_.Window_ClientToScreenXY(*args, **kwargs) |
e811c8ce RD |
9077 | |
9078 | def ScreenToClientXY(*args, **kwargs): | |
15afbcd0 RD |
9079 | """ |
9080 | ScreenToClientXY(int x, int y) -> (x,y) | |
9081 | ||
9082 | Converts from screen to client window coordinates. | |
9083 | """ | |
54f9ee45 | 9084 | return _core_.Window_ScreenToClientXY(*args, **kwargs) |
e811c8ce RD |
9085 | |
9086 | def ClientToScreen(*args, **kwargs): | |
15afbcd0 | 9087 | """ |
a95a7133 | 9088 | ClientToScreen(self, Point pt) -> Point |
15afbcd0 RD |
9089 | |
9090 | Converts to screen coordinates from coordinates relative to this window. | |
9091 | """ | |
54f9ee45 | 9092 | return _core_.Window_ClientToScreen(*args, **kwargs) |
e811c8ce RD |
9093 | |
9094 | def ScreenToClient(*args, **kwargs): | |
15afbcd0 | 9095 | """ |
a95a7133 | 9096 | ScreenToClient(self, Point pt) -> Point |
15afbcd0 RD |
9097 | |
9098 | Converts from screen to client window coordinates. | |
9099 | """ | |
54f9ee45 | 9100 | return _core_.Window_ScreenToClient(*args, **kwargs) |
e811c8ce RD |
9101 | |
9102 | def HitTestXY(*args, **kwargs): | |
15afbcd0 | 9103 | """ |
a95a7133 | 9104 | HitTestXY(self, int x, int y) -> int |
15afbcd0 RD |
9105 | |
9106 | Test where the given (in client coords) point lies | |
9107 | """ | |
54f9ee45 | 9108 | return _core_.Window_HitTestXY(*args, **kwargs) |
e811c8ce RD |
9109 | |
9110 | def HitTest(*args, **kwargs): | |
15afbcd0 | 9111 | """ |
a95a7133 | 9112 | HitTest(self, Point pt) -> int |
15afbcd0 RD |
9113 | |
9114 | Test where the given (in client coords) point lies | |
9115 | """ | |
54f9ee45 | 9116 | return _core_.Window_HitTest(*args, **kwargs) |
e811c8ce | 9117 | |
15afbcd0 RD |
9118 | def GetBorder(*args): |
9119 | """ | |
a95a7133 RD |
9120 | GetBorder(self, long flags) -> int |
9121 | GetBorder(self) -> int | |
e811c8ce | 9122 | |
15afbcd0 RD |
9123 | Get border for the flags of this window |
9124 | """ | |
54f9ee45 | 9125 | return _core_.Window_GetBorder(*args) |
e811c8ce RD |
9126 | |
9127 | def UpdateWindowUI(*args, **kwargs): | |
15afbcd0 | 9128 | """ |
a95a7133 | 9129 | UpdateWindowUI(self, long flags=UPDATE_UI_NONE) |
15afbcd0 RD |
9130 | |
9131 | This function sends EVT_UPDATE_UI events to the window. The particular | |
9132 | implementation depends on the window; for example a wx.ToolBar will | |
9133 | send an update UI event for each toolbar button, and a wx.Frame will | |
9134 | send an update UI event for each menubar menu item. You can call this | |
9135 | function from your application to ensure that your UI is up-to-date at | |
9136 | a particular point in time (as far as your EVT_UPDATE_UI handlers are | |
9137 | concerned). This may be necessary if you have called | |
5ba5649b | 9138 | `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to |
15afbcd0 RD |
9139 | limit the overhead that wxWindows incurs by sending update UI events |
9140 | in idle time. | |
15afbcd0 | 9141 | """ |
54f9ee45 | 9142 | return _core_.Window_UpdateWindowUI(*args, **kwargs) |
e811c8ce RD |
9143 | |
9144 | def PopupMenuXY(*args, **kwargs): | |
15afbcd0 | 9145 | """ |
b0503257 | 9146 | PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool |
15afbcd0 | 9147 | |
b0503257 RD |
9148 | Pops up the given menu at the specified coordinates, relative to this window, |
9149 | and returns control when the user has dismissed the menu. If a menu item is | |
9150 | selected, the corresponding menu event is generated and will be processed as | |
9151 | usual. If the default position is given then the current position of the | |
9152 | mouse cursor will be used. | |
15afbcd0 | 9153 | """ |
54f9ee45 | 9154 | return _core_.Window_PopupMenuXY(*args, **kwargs) |
e811c8ce | 9155 | |
15afbcd0 RD |
9156 | def PopupMenu(*args, **kwargs): |
9157 | """ | |
b0503257 | 9158 | PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool |
15afbcd0 | 9159 | |
b0503257 RD |
9160 | Pops up the given menu at the specified coordinates, relative to this window, |
9161 | and returns control when the user has dismissed the menu. If a menu item is | |
9162 | selected, the corresponding menu event is generated and will be processed as | |
9163 | usual. If the default position is given then the current position of the | |
9164 | mouse cursor will be used. | |
15afbcd0 | 9165 | """ |
54f9ee45 | 9166 | return _core_.Window_PopupMenu(*args, **kwargs) |
15afbcd0 RD |
9167 | |
9168 | def GetHandle(*args, **kwargs): | |
9169 | """ | |
a95a7133 | 9170 | GetHandle(self) -> long |
15afbcd0 RD |
9171 | |
9172 | Returns the platform-specific handle (as a long integer) of the | |
9173 | physical window. Currently on wxMac it returns the handle of the | |
9174 | toplevel parent of the window. | |
9175 | """ | |
54f9ee45 | 9176 | return _core_.Window_GetHandle(*args, **kwargs) |
15afbcd0 | 9177 | |
7e63a440 RD |
9178 | def AssociateHandle(*args, **kwargs): |
9179 | """ | |
9180 | AssociateHandle(self, long handle) | |
9181 | ||
9182 | Associate the window with a new native handle | |
9183 | """ | |
9184 | return _core_.Window_AssociateHandle(*args, **kwargs) | |
9185 | ||
9186 | def DissociateHandle(*args, **kwargs): | |
9187 | """ | |
9188 | DissociateHandle(self) | |
9189 | ||
9190 | Dissociate the current native handle from the window | |
9191 | """ | |
9192 | return _core_.Window_DissociateHandle(*args, **kwargs) | |
9193 | ||
15afbcd0 RD |
9194 | def HasScrollbar(*args, **kwargs): |
9195 | """ | |
a95a7133 | 9196 | HasScrollbar(self, int orient) -> bool |
15afbcd0 RD |
9197 | |
9198 | Does the window have the scrollbar for this orientation? | |
9199 | """ | |
54f9ee45 | 9200 | return _core_.Window_HasScrollbar(*args, **kwargs) |
15afbcd0 RD |
9201 | |
9202 | def SetScrollbar(*args, **kwargs): | |
9203 | """ | |
41e2b43e | 9204 | SetScrollbar(self, int orientation, int position, int thumbSize, int range, |
15afbcd0 RD |
9205 | bool refresh=True) |
9206 | ||
9207 | Sets the scrollbar properties of a built-in scrollbar. | |
15afbcd0 | 9208 | """ |
54f9ee45 | 9209 | return _core_.Window_SetScrollbar(*args, **kwargs) |
e811c8ce RD |
9210 | |
9211 | def SetScrollPos(*args, **kwargs): | |
15afbcd0 | 9212 | """ |
a95a7133 | 9213 | SetScrollPos(self, int orientation, int pos, bool refresh=True) |
15afbcd0 RD |
9214 | |
9215 | Sets the position of one of the built-in scrollbars. | |
9216 | """ | |
54f9ee45 | 9217 | return _core_.Window_SetScrollPos(*args, **kwargs) |
e811c8ce RD |
9218 | |
9219 | def GetScrollPos(*args, **kwargs): | |
15afbcd0 | 9220 | """ |
a95a7133 | 9221 | GetScrollPos(self, int orientation) -> int |
15afbcd0 RD |
9222 | |
9223 | Returns the built-in scrollbar position. | |
9224 | """ | |
54f9ee45 | 9225 | return _core_.Window_GetScrollPos(*args, **kwargs) |
e811c8ce RD |
9226 | |
9227 | def GetScrollThumb(*args, **kwargs): | |
15afbcd0 | 9228 | """ |
a95a7133 | 9229 | GetScrollThumb(self, int orientation) -> int |
15afbcd0 RD |
9230 | |
9231 | Returns the built-in scrollbar thumb size. | |
9232 | """ | |
54f9ee45 | 9233 | return _core_.Window_GetScrollThumb(*args, **kwargs) |
e811c8ce RD |
9234 | |
9235 | def GetScrollRange(*args, **kwargs): | |
15afbcd0 | 9236 | """ |
a95a7133 | 9237 | GetScrollRange(self, int orientation) -> int |
15afbcd0 RD |
9238 | |
9239 | Returns the built-in scrollbar range. | |
9240 | """ | |
54f9ee45 | 9241 | return _core_.Window_GetScrollRange(*args, **kwargs) |
e811c8ce RD |
9242 | |
9243 | def ScrollWindow(*args, **kwargs): | |
15afbcd0 | 9244 | """ |
a95a7133 | 9245 | ScrollWindow(self, int dx, int dy, Rect rect=None) |
15afbcd0 RD |
9246 | |
9247 | Physically scrolls the pixels in the window and move child windows | |
9248 | accordingly. Use this function to optimise your scrolling | |
9249 | implementations, to minimise the area that must be redrawn. Note that | |
9250 | it is rarely required to call this function from a user program. | |
15afbcd0 | 9251 | """ |
54f9ee45 | 9252 | return _core_.Window_ScrollWindow(*args, **kwargs) |
e811c8ce RD |
9253 | |
9254 | def ScrollLines(*args, **kwargs): | |
15afbcd0 | 9255 | """ |
a95a7133 | 9256 | ScrollLines(self, int lines) -> bool |
15afbcd0 RD |
9257 | |
9258 | If the platform and window class supports it, scrolls the window by | |
9259 | the given number of lines down, if lines is positive, or up if lines | |
9260 | is negative. Returns True if the window was scrolled, False if it was | |
9261 | already on top/bottom and nothing was done. | |
9262 | """ | |
54f9ee45 | 9263 | return _core_.Window_ScrollLines(*args, **kwargs) |
e811c8ce RD |
9264 | |
9265 | def ScrollPages(*args, **kwargs): | |
15afbcd0 | 9266 | """ |
a95a7133 | 9267 | ScrollPages(self, int pages) -> bool |
15afbcd0 | 9268 | |
41e2b43e | 9269 | If the platform and window class supports it, scrolls the window by |
15afbcd0 RD |
9270 | the given number of pages down, if pages is positive, or up if pages |
9271 | is negative. Returns True if the window was scrolled, False if it was | |
9272 | already on top/bottom and nothing was done. | |
9273 | """ | |
54f9ee45 | 9274 | return _core_.Window_ScrollPages(*args, **kwargs) |
e811c8ce RD |
9275 | |
9276 | def LineUp(*args, **kwargs): | |
15afbcd0 | 9277 | """ |
a95a7133 | 9278 | LineUp(self) -> bool |
15afbcd0 RD |
9279 | |
9280 | This is just a wrapper for ScrollLines(-1). | |
9281 | """ | |
54f9ee45 | 9282 | return _core_.Window_LineUp(*args, **kwargs) |
e811c8ce RD |
9283 | |
9284 | def LineDown(*args, **kwargs): | |
15afbcd0 | 9285 | """ |
a95a7133 | 9286 | LineDown(self) -> bool |
15afbcd0 RD |
9287 | |
9288 | This is just a wrapper for ScrollLines(1). | |
9289 | """ | |
54f9ee45 | 9290 | return _core_.Window_LineDown(*args, **kwargs) |
e811c8ce RD |
9291 | |
9292 | def PageUp(*args, **kwargs): | |
15afbcd0 | 9293 | """ |
a95a7133 | 9294 | PageUp(self) -> bool |
15afbcd0 RD |
9295 | |
9296 | This is just a wrapper for ScrollPages(-1). | |
9297 | """ | |
54f9ee45 | 9298 | return _core_.Window_PageUp(*args, **kwargs) |
e811c8ce RD |
9299 | |
9300 | def PageDown(*args, **kwargs): | |
15afbcd0 | 9301 | """ |
a95a7133 | 9302 | PageDown(self) -> bool |
15afbcd0 RD |
9303 | |
9304 | This is just a wrapper for ScrollPages(1). | |
9305 | """ | |
54f9ee45 | 9306 | return _core_.Window_PageDown(*args, **kwargs) |
e811c8ce RD |
9307 | |
9308 | def SetHelpText(*args, **kwargs): | |
15afbcd0 | 9309 | """ |
a95a7133 | 9310 | SetHelpText(self, String text) |
15afbcd0 RD |
9311 | |
9312 | Sets the help text to be used as context-sensitive help for this | |
9313 | window. Note that the text is actually stored by the current | |
f52cbe90 | 9314 | `wx.HelpProvider` implementation, and not in the window object itself. |
15afbcd0 | 9315 | """ |
54f9ee45 | 9316 | return _core_.Window_SetHelpText(*args, **kwargs) |
e811c8ce RD |
9317 | |
9318 | def SetHelpTextForId(*args, **kwargs): | |
15afbcd0 | 9319 | """ |
a95a7133 | 9320 | SetHelpTextForId(self, String text) |
15afbcd0 RD |
9321 | |
9322 | Associate this help text with all windows with the same id as this | |
9323 | one. | |
9324 | """ | |
54f9ee45 | 9325 | return _core_.Window_SetHelpTextForId(*args, **kwargs) |
e811c8ce | 9326 | |
b850e7f3 RD |
9327 | def GetHelpTextAtPoint(*args, **kwargs): |
9328 | """ | |
9329 | GetHelpTextAtPoint(self, Point pt, wxHelpEvent::Origin origin) -> String | |
9330 | ||
9331 | Get the help string associated with the given position in this window. | |
9332 | ||
9333 | Notice that pt may be invalid if event origin is keyboard or unknown | |
9334 | and this method should return the global window help text then | |
9335 | ||
9336 | """ | |
9337 | return _core_.Window_GetHelpTextAtPoint(*args, **kwargs) | |
9338 | ||
e811c8ce | 9339 | def GetHelpText(*args, **kwargs): |
15afbcd0 | 9340 | """ |
a95a7133 | 9341 | GetHelpText(self) -> String |
15afbcd0 RD |
9342 | |
9343 | Gets the help text to be used as context-sensitive help for this | |
9344 | window. Note that the text is actually stored by the current | |
f52cbe90 | 9345 | `wx.HelpProvider` implementation, and not in the window object itself. |
15afbcd0 | 9346 | """ |
54f9ee45 | 9347 | return _core_.Window_GetHelpText(*args, **kwargs) |
e811c8ce RD |
9348 | |
9349 | def SetToolTipString(*args, **kwargs): | |
15afbcd0 | 9350 | """ |
a95a7133 | 9351 | SetToolTipString(self, String tip) |
15afbcd0 RD |
9352 | |
9353 | Attach a tooltip to the window. | |
9354 | """ | |
54f9ee45 | 9355 | return _core_.Window_SetToolTipString(*args, **kwargs) |
e811c8ce RD |
9356 | |
9357 | def SetToolTip(*args, **kwargs): | |
15afbcd0 | 9358 | """ |
a95a7133 | 9359 | SetToolTip(self, ToolTip tip) |
15afbcd0 RD |
9360 | |
9361 | Attach a tooltip to the window. | |
9362 | """ | |
54f9ee45 | 9363 | return _core_.Window_SetToolTip(*args, **kwargs) |
e811c8ce RD |
9364 | |
9365 | def GetToolTip(*args, **kwargs): | |
15afbcd0 | 9366 | """ |
a95a7133 | 9367 | GetToolTip(self) -> ToolTip |
15afbcd0 RD |
9368 | |
9369 | get the associated tooltip or None if none | |
9370 | """ | |
54f9ee45 | 9371 | return _core_.Window_GetToolTip(*args, **kwargs) |
e811c8ce RD |
9372 | |
9373 | def SetDropTarget(*args, **kwargs): | |
15afbcd0 | 9374 | """ |
a95a7133 | 9375 | SetDropTarget(self, DropTarget dropTarget) |
15afbcd0 RD |
9376 | |
9377 | Associates a drop target with this window. If the window already has | |
9378 | a drop target, it is deleted. | |
9379 | """ | |
54f9ee45 | 9380 | return _core_.Window_SetDropTarget(*args, **kwargs) |
e811c8ce RD |
9381 | |
9382 | def GetDropTarget(*args, **kwargs): | |
15afbcd0 | 9383 | """ |
a95a7133 | 9384 | GetDropTarget(self) -> DropTarget |
15afbcd0 RD |
9385 | |
9386 | Returns the associated drop target, which may be None. | |
9387 | """ | |
54f9ee45 | 9388 | return _core_.Window_GetDropTarget(*args, **kwargs) |
e811c8ce | 9389 | |
5ba5649b RD |
9390 | def DragAcceptFiles(*args, **kwargs): |
9391 | """ | |
9392 | DragAcceptFiles(self, bool accept) | |
9393 | ||
9394 | Enables or disables eligibility for drop file events, EVT_DROP_FILES. | |
9395 | Only functional on Windows. | |
9396 | """ | |
9397 | return _core_.Window_DragAcceptFiles(*args, **kwargs) | |
9398 | ||
e811c8ce | 9399 | def SetConstraints(*args, **kwargs): |
15afbcd0 | 9400 | """ |
a95a7133 | 9401 | SetConstraints(self, LayoutConstraints constraints) |
15afbcd0 RD |
9402 | |
9403 | Sets the window to have the given layout constraints. If an existing | |
9404 | layout constraints object is already owned by the window, it will be | |
9405 | deleted. Pass None to disassociate and delete the window's current | |
9406 | constraints. | |
9407 | ||
9408 | You must call SetAutoLayout to tell a window to use the constraints | |
9409 | automatically in its default EVT_SIZE handler; otherwise, you must | |
9410 | handle EVT_SIZE yourself and call Layout() explicitly. When setting | |
9411 | both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have | |
9412 | effect. | |
9413 | """ | |
54f9ee45 | 9414 | return _core_.Window_SetConstraints(*args, **kwargs) |
e811c8ce RD |
9415 | |
9416 | def GetConstraints(*args, **kwargs): | |
15afbcd0 | 9417 | """ |
a95a7133 | 9418 | GetConstraints(self) -> LayoutConstraints |
15afbcd0 RD |
9419 | |
9420 | Returns a pointer to the window's layout constraints, or None if there | |
9421 | are none. | |
9422 | """ | |
54f9ee45 | 9423 | return _core_.Window_GetConstraints(*args, **kwargs) |
e811c8ce RD |
9424 | |
9425 | def SetAutoLayout(*args, **kwargs): | |
15afbcd0 | 9426 | """ |
a95a7133 | 9427 | SetAutoLayout(self, bool autoLayout) |
15afbcd0 RD |
9428 | |
9429 | Determines whether the Layout function will be called automatically | |
b1fcee84 RD |
9430 | when the window is resized. lease note that this only happens for the |
9431 | windows usually used to contain children, namely `wx.Panel` and | |
9432 | `wx.TopLevelWindow` (and the classes deriving from them). | |
9433 | ||
9434 | This method is called implicitly by `SetSizer` but if you use | |
9435 | `SetConstraints` you should call it manually or otherwise the window | |
9436 | layout won't be correctly updated when its size changes. | |
15afbcd0 | 9437 | """ |
54f9ee45 | 9438 | return _core_.Window_SetAutoLayout(*args, **kwargs) |
e811c8ce RD |
9439 | |
9440 | def GetAutoLayout(*args, **kwargs): | |
15afbcd0 | 9441 | """ |
a95a7133 | 9442 | GetAutoLayout(self) -> bool |
15afbcd0 RD |
9443 | |
9444 | Returns the current autoLayout setting | |
9445 | """ | |
54f9ee45 | 9446 | return _core_.Window_GetAutoLayout(*args, **kwargs) |
e811c8ce RD |
9447 | |
9448 | def Layout(*args, **kwargs): | |
15afbcd0 | 9449 | """ |
a95a7133 | 9450 | Layout(self) -> bool |
15afbcd0 RD |
9451 | |
9452 | Invokes the constraint-based layout algorithm or the sizer-based | |
9453 | algorithm for this window. See SetAutoLayout: when auto layout is on, | |
9454 | this function gets called automatically by the default EVT_SIZE | |
9455 | handler when the window is resized. | |
9456 | """ | |
54f9ee45 | 9457 | return _core_.Window_Layout(*args, **kwargs) |
e811c8ce RD |
9458 | |
9459 | def SetSizer(*args, **kwargs): | |
15afbcd0 | 9460 | """ |
a95a7133 | 9461 | SetSizer(self, Sizer sizer, bool deleteOld=True) |
15afbcd0 RD |
9462 | |
9463 | Sets the window to have the given layout sizer. The window will then | |
9464 | own the object, and will take care of its deletion. If an existing | |
9465 | layout sizer object is already owned by the window, it will be deleted | |
9466 | if the deleteOld parameter is true. Note that this function will also | |
9467 | call SetAutoLayout implicitly with a True parameter if the sizer is | |
ae8162c8 | 9468 | non-None, and False otherwise. |
15afbcd0 | 9469 | """ |
54f9ee45 | 9470 | return _core_.Window_SetSizer(*args, **kwargs) |
e811c8ce RD |
9471 | |
9472 | def SetSizerAndFit(*args, **kwargs): | |
15afbcd0 | 9473 | """ |
a95a7133 | 9474 | SetSizerAndFit(self, Sizer sizer, bool deleteOld=True) |
15afbcd0 RD |
9475 | |
9476 | The same as SetSizer, except it also sets the size hints for the | |
9477 | window based on the sizer's minimum size. | |
9478 | """ | |
54f9ee45 | 9479 | return _core_.Window_SetSizerAndFit(*args, **kwargs) |
e811c8ce RD |
9480 | |
9481 | def GetSizer(*args, **kwargs): | |
15afbcd0 | 9482 | """ |
a95a7133 | 9483 | GetSizer(self) -> Sizer |
15afbcd0 RD |
9484 | |
9485 | Return the sizer associated with the window by a previous call to | |
9486 | SetSizer or None if there isn't one. | |
9487 | """ | |
54f9ee45 | 9488 | return _core_.Window_GetSizer(*args, **kwargs) |
e811c8ce RD |
9489 | |
9490 | def SetContainingSizer(*args, **kwargs): | |
15afbcd0 | 9491 | """ |
a95a7133 | 9492 | SetContainingSizer(self, Sizer sizer) |
15afbcd0 RD |
9493 | |
9494 | This normally does not need to be called by application code. It is | |
9495 | called internally when a window is added to a sizer, and is used so | |
9496 | the window can remove itself from the sizer when it is destroyed. | |
9497 | """ | |
54f9ee45 | 9498 | return _core_.Window_SetContainingSizer(*args, **kwargs) |
e811c8ce RD |
9499 | |
9500 | def GetContainingSizer(*args, **kwargs): | |
15afbcd0 | 9501 | """ |
a95a7133 | 9502 | GetContainingSizer(self) -> Sizer |
15afbcd0 RD |
9503 | |
9504 | Return the sizer that this window is a member of, if any, otherwise None. | |
9505 | """ | |
54f9ee45 | 9506 | return _core_.Window_GetContainingSizer(*args, **kwargs) |
e811c8ce | 9507 | |
a95a7133 RD |
9508 | def InheritAttributes(*args, **kwargs): |
9509 | """ | |
9510 | InheritAttributes(self) | |
9511 | ||
41e2b43e RD |
9512 | This function is (or should be, in case of custom controls) called |
9513 | during window creation to intelligently set up the window visual | |
9514 | attributes, that is the font and the foreground and background | |
9515 | colours. | |
9516 | ||
9517 | By 'intelligently' the following is meant: by default, all windows use | |
9518 | their own default attributes. However if some of the parent's | |
9519 | attributes are explicitly changed (that is, using SetFont and not | |
fa47d7a7 | 9520 | SetOwnFont) and if the corresponding attribute hadn't been |
41e2b43e RD |
9521 | explicitly set for this window itself, then this window takes the same |
9522 | value as used by the parent. In addition, if the window overrides | |
9523 | ShouldInheritColours to return false, the colours will not be changed | |
9524 | no matter what and only the font might. | |
9525 | ||
34621cc5 | 9526 | This rather complicated logic is necessary in order to accommodate the |
ec9b55ca | 9527 | different usage scenarios. The most common one is when all default |
41e2b43e RD |
9528 | attributes are used and in this case, nothing should be inherited as |
9529 | in modern GUIs different controls use different fonts (and colours) | |
9530 | than their siblings so they can't inherit the same value from the | |
9531 | parent. However it was also deemed desirable to allow to simply change | |
9532 | the attributes of all children at once by just changing the font or | |
9533 | colour of their common parent, hence in this case we do inherit the | |
9534 | parents attributes. | |
9535 | ||
a95a7133 | 9536 | """ |
54f9ee45 | 9537 | return _core_.Window_InheritAttributes(*args, **kwargs) |
a95a7133 RD |
9538 | |
9539 | def ShouldInheritColours(*args, **kwargs): | |
9540 | """ | |
9541 | ShouldInheritColours(self) -> bool | |
9542 | ||
9543 | Return true from here to allow the colours of this window to be | |
41e2b43e RD |
9544 | changed by InheritAttributes, returning false forbids inheriting them |
9545 | from the parent window. | |
a95a7133 | 9546 | |
41e2b43e RD |
9547 | The base class version returns false, but this method is overridden in |
9548 | wxControl where it returns true. | |
a95a7133 | 9549 | """ |
54f9ee45 | 9550 | return _core_.Window_ShouldInheritColours(*args, **kwargs) |
a95a7133 | 9551 | |
e811c8ce | 9552 | def PostCreate(self, pre): |
15afbcd0 RD |
9553 | """ |
9554 | Phase 3 of the 2-phase create <wink!> | |
9555 | Call this method after precreating the window with the 2-phase create method. | |
9556 | """ | |
e811c8ce RD |
9557 | self.this = pre.this |
9558 | self.thisown = pre.thisown | |
9559 | pre.thisown = 0 | |
9560 | if hasattr(self, '_setOORInfo'): | |
9561 | self._setOORInfo(self) | |
9562 | if hasattr(self, '_setCallbackInfo'): | |
9563 | self._setCallbackInfo(self, self.__class__) | |
9564 | ||
7e08d4ef | 9565 | def SendSizeEvent(self): |
453fb36b | 9566 | self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1))) |
7e08d4ef | 9567 | |
2131d850 | 9568 | _core_.Window_swigregister(Window) |
e811c8ce RD |
9569 | |
9570 | def PreWindow(*args, **kwargs): | |
15afbcd0 RD |
9571 | """ |
9572 | PreWindow() -> Window | |
9573 | ||
9574 | Precreate a Window for 2-phase creation. | |
9575 | """ | |
54f9ee45 | 9576 | val = _core_.new_PreWindow(*args, **kwargs) |
e811c8ce RD |
9577 | return val |
9578 | ||
0085ce49 RD |
9579 | def Window_NewControlId(*args): |
9580 | """ | |
15afbcd0 RD |
9581 | Window_NewControlId() -> int |
9582 | ||
9583 | Generate a control id for the controls which were not given one. | |
9584 | """ | |
0085ce49 | 9585 | return _core_.Window_NewControlId(*args) |
e811c8ce RD |
9586 | |
9587 | def Window_NextControlId(*args, **kwargs): | |
0085ce49 | 9588 | """ |
15afbcd0 RD |
9589 | Window_NextControlId(int winid) -> int |
9590 | ||
9591 | Get the id of the control following the one with the given | |
41e2b43e | 9592 | autogenerated) id |
15afbcd0 | 9593 | """ |
0085ce49 | 9594 | return _core_.Window_NextControlId(*args, **kwargs) |
e811c8ce RD |
9595 | |
9596 | def Window_PrevControlId(*args, **kwargs): | |
0085ce49 | 9597 | """ |
15afbcd0 RD |
9598 | Window_PrevControlId(int winid) -> int |
9599 | ||
9600 | Get the id of the control preceding the one with the given | |
41e2b43e | 9601 | autogenerated) id |
15afbcd0 | 9602 | """ |
0085ce49 | 9603 | return _core_.Window_PrevControlId(*args, **kwargs) |
e811c8ce | 9604 | |
0085ce49 RD |
9605 | def Window_FindFocus(*args): |
9606 | """ | |
15afbcd0 RD |
9607 | Window_FindFocus() -> Window |
9608 | ||
9609 | Returns the window or control that currently has the keyboard focus, | |
9610 | or None. | |
9611 | """ | |
0085ce49 | 9612 | return _core_.Window_FindFocus(*args) |
e811c8ce | 9613 | |
0085ce49 RD |
9614 | def Window_GetCapture(*args): |
9615 | """ | |
15afbcd0 RD |
9616 | Window_GetCapture() -> Window |
9617 | ||
9618 | Returns the window which currently captures the mouse or None | |
9619 | """ | |
0085ce49 | 9620 | return _core_.Window_GetCapture(*args) |
e811c8ce | 9621 | |
74a57fcd | 9622 | def Window_GetClassDefaultAttributes(*args, **kwargs): |
0085ce49 | 9623 | """ |
74a57fcd RD |
9624 | Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
9625 | ||
41e2b43e RD |
9626 | Get the default attributes for this class. This is useful if you want |
9627 | to use the same font or colour in your own control as in a standard | |
9628 | control -- which is a much better idea than hard coding specific | |
db3e571a RD |
9629 | colours or fonts which might look completely out of place on the |
9630 | user's system, especially if it uses themes. | |
74a57fcd RD |
9631 | |
9632 | The variant parameter is only relevant under Mac currently and is | |
41e2b43e | 9633 | ignore under other platforms. Under Mac, it will change the size of |
db3e571a RD |
9634 | the returned font. See `wx.Window.SetWindowVariant` for more about |
9635 | this. | |
74a57fcd | 9636 | """ |
0085ce49 | 9637 | return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd | 9638 | |
e811c8ce | 9639 | def DLG_PNT(win, point_or_x, y=None): |
15afbcd0 RD |
9640 | """ |
9641 | Convenience function for converting a Point or (x,y) in | |
9642 | dialog units to pixel units. | |
9643 | """ | |
e811c8ce RD |
9644 | if y is None: |
9645 | return win.ConvertDialogPointToPixels(point_or_x) | |
9646 | else: | |
fd3f2efe | 9647 | return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) |
e811c8ce RD |
9648 | |
9649 | def DLG_SZE(win, size_width, height=None): | |
15afbcd0 RD |
9650 | """ |
9651 | Convenience function for converting a Size or (w,h) in | |
9652 | dialog units to pixel units. | |
9653 | """ | |
e811c8ce RD |
9654 | if height is None: |
9655 | return win.ConvertDialogSizeToPixels(size_width) | |
9656 | else: | |
fd3f2efe | 9657 | return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) |
e811c8ce RD |
9658 | |
9659 | ||
9660 | def FindWindowById(*args, **kwargs): | |
0085ce49 | 9661 | """ |
15afbcd0 RD |
9662 | FindWindowById(long id, Window parent=None) -> Window |
9663 | ||
9664 | Find the first window in the application with the given id. If parent | |
9665 | is None, the search will start from all top-level frames and dialog | |
9666 | boxes; if non-None, the search will be limited to the given window | |
9667 | hierarchy. The search is recursive in both cases. | |
9668 | """ | |
0085ce49 | 9669 | return _core_.FindWindowById(*args, **kwargs) |
e811c8ce RD |
9670 | |
9671 | def FindWindowByName(*args, **kwargs): | |
0085ce49 | 9672 | """ |
15afbcd0 RD |
9673 | FindWindowByName(String name, Window parent=None) -> Window |
9674 | ||
9675 | Find a window by its name (as given in a window constructor or Create | |
9676 | function call). If parent is None, the search will start from all | |
9677 | top-level frames and dialog boxes; if non-None, the search will be | |
9678 | limited to the given window hierarchy. The search is recursive in both | |
9679 | cases. | |
9680 | ||
9681 | If no window with such name is found, wx.FindWindowByLabel is called. | |
9682 | """ | |
0085ce49 | 9683 | return _core_.FindWindowByName(*args, **kwargs) |
e811c8ce RD |
9684 | |
9685 | def FindWindowByLabel(*args, **kwargs): | |
0085ce49 | 9686 | """ |
15afbcd0 RD |
9687 | FindWindowByLabel(String label, Window parent=None) -> Window |
9688 | ||
9689 | Find a window by its label. Depending on the type of window, the label | |
9690 | may be a window title or panel item label. If parent is None, the | |
9691 | search will start from all top-level frames and dialog boxes; if | |
9692 | non-None, the search will be limited to the given window | |
9693 | hierarchy. The search is recursive in both cases. | |
9694 | """ | |
0085ce49 | 9695 | return _core_.FindWindowByLabel(*args, **kwargs) |
e811c8ce RD |
9696 | |
9697 | def Window_FromHWND(*args, **kwargs): | |
0085ce49 RD |
9698 | """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window""" |
9699 | return _core_.Window_FromHWND(*args, **kwargs) | |
b6b0383e | 9700 | |
0085ce49 RD |
9701 | def GetTopLevelWindows(*args): |
9702 | """ | |
b6b0383e RD |
9703 | GetTopLevelWindows() -> PyObject |
9704 | ||
9705 | Returns a list of the the application's top-level windows, (frames, | |
9706 | dialogs, etc.) NOTE: Currently this is a copy of the list maintained | |
9707 | by wxWidgets, and so it is only valid as long as no top-level windows | |
9708 | are closed or new top-level windows are created. | |
9709 | ||
9710 | """ | |
0085ce49 | 9711 | return _core_.GetTopLevelWindows(*args) |
e811c8ce RD |
9712 | #--------------------------------------------------------------------------- |
9713 | ||
9714 | class Validator(EvtHandler): | |
093d3ff1 | 9715 | """Proxy of C++ Validator class""" |
0085ce49 RD |
9716 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
9717 | __repr__ = _swig_repr | |
9718 | def __init__(self, *args, **kwargs): | |
a95a7133 | 9719 | """__init__(self) -> Validator""" |
0085ce49 | 9720 | _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs)) |
d14a1e28 | 9721 | self._setOORInfo(self) |
e811c8ce RD |
9722 | |
9723 | def Clone(*args, **kwargs): | |
a95a7133 | 9724 | """Clone(self) -> Validator""" |
54f9ee45 | 9725 | return _core_.Validator_Clone(*args, **kwargs) |
e811c8ce RD |
9726 | |
9727 | def Validate(*args, **kwargs): | |
a95a7133 | 9728 | """Validate(self, Window parent) -> bool""" |
54f9ee45 | 9729 | return _core_.Validator_Validate(*args, **kwargs) |
e811c8ce RD |
9730 | |
9731 | def TransferToWindow(*args, **kwargs): | |
a95a7133 | 9732 | """TransferToWindow(self) -> bool""" |
54f9ee45 | 9733 | return _core_.Validator_TransferToWindow(*args, **kwargs) |
e811c8ce RD |
9734 | |
9735 | def TransferFromWindow(*args, **kwargs): | |
a95a7133 | 9736 | """TransferFromWindow(self) -> bool""" |
54f9ee45 | 9737 | return _core_.Validator_TransferFromWindow(*args, **kwargs) |
e811c8ce RD |
9738 | |
9739 | def GetWindow(*args, **kwargs): | |
a95a7133 | 9740 | """GetWindow(self) -> Window""" |
54f9ee45 | 9741 | return _core_.Validator_GetWindow(*args, **kwargs) |
e811c8ce RD |
9742 | |
9743 | def SetWindow(*args, **kwargs): | |
a95a7133 | 9744 | """SetWindow(self, Window window)""" |
54f9ee45 | 9745 | return _core_.Validator_SetWindow(*args, **kwargs) |
e811c8ce RD |
9746 | |
9747 | def IsSilent(*args, **kwargs): | |
66c033b4 | 9748 | """IsSilent() -> bool""" |
54f9ee45 | 9749 | return _core_.Validator_IsSilent(*args, **kwargs) |
e811c8ce RD |
9750 | |
9751 | IsSilent = staticmethod(IsSilent) | |
9752 | def SetBellOnError(*args, **kwargs): | |
66c033b4 | 9753 | """SetBellOnError(int doIt=True)""" |
54f9ee45 | 9754 | return _core_.Validator_SetBellOnError(*args, **kwargs) |
e811c8ce RD |
9755 | |
9756 | SetBellOnError = staticmethod(SetBellOnError) | |
2131d850 | 9757 | _core_.Validator_swigregister(Validator) |
e811c8ce | 9758 | |
0085ce49 RD |
9759 | def Validator_IsSilent(*args): |
9760 | """Validator_IsSilent() -> bool""" | |
9761 | return _core_.Validator_IsSilent(*args) | |
e811c8ce RD |
9762 | |
9763 | def Validator_SetBellOnError(*args, **kwargs): | |
0085ce49 RD |
9764 | """Validator_SetBellOnError(int doIt=True)""" |
9765 | return _core_.Validator_SetBellOnError(*args, **kwargs) | |
e811c8ce RD |
9766 | |
9767 | class PyValidator(Validator): | |
093d3ff1 | 9768 | """Proxy of C++ PyValidator class""" |
0085ce49 RD |
9769 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
9770 | __repr__ = _swig_repr | |
9771 | def __init__(self, *args, **kwargs): | |
a95a7133 | 9772 | """__init__(self) -> PyValidator""" |
0085ce49 | 9773 | _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs)) |
e811c8ce RD |
9774 | |
9775 | self._setCallbackInfo(self, PyValidator, 1) | |
9776 | self._setOORInfo(self) | |
9777 | ||
9778 | def _setCallbackInfo(*args, **kwargs): | |
a95a7133 | 9779 | """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)""" |
54f9ee45 | 9780 | return _core_.PyValidator__setCallbackInfo(*args, **kwargs) |
e811c8ce | 9781 | |
2131d850 | 9782 | _core_.PyValidator_swigregister(PyValidator) |
e811c8ce RD |
9783 | |
9784 | #--------------------------------------------------------------------------- | |
9785 | ||
9786 | class Menu(EvtHandler): | |
093d3ff1 | 9787 | """Proxy of C++ Menu class""" |
0085ce49 RD |
9788 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
9789 | __repr__ = _swig_repr | |
9790 | def __init__(self, *args, **kwargs): | |
a95a7133 | 9791 | """__init__(self, String title=EmptyString, long style=0) -> Menu""" |
0085ce49 | 9792 | _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs)) |
e811c8ce RD |
9793 | self._setOORInfo(self) |
9794 | ||
9795 | def Append(*args, **kwargs): | |
a95a7133 | 9796 | """Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem""" |
54f9ee45 | 9797 | return _core_.Menu_Append(*args, **kwargs) |
e811c8ce RD |
9798 | |
9799 | def AppendSeparator(*args, **kwargs): | |
a95a7133 | 9800 | """AppendSeparator(self) -> MenuItem""" |
54f9ee45 | 9801 | return _core_.Menu_AppendSeparator(*args, **kwargs) |
e811c8ce RD |
9802 | |
9803 | def AppendCheckItem(*args, **kwargs): | |
a95a7133 | 9804 | """AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9805 | return _core_.Menu_AppendCheckItem(*args, **kwargs) |
e811c8ce RD |
9806 | |
9807 | def AppendRadioItem(*args, **kwargs): | |
a95a7133 | 9808 | """AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9809 | return _core_.Menu_AppendRadioItem(*args, **kwargs) |
e811c8ce RD |
9810 | |
9811 | def AppendMenu(*args, **kwargs): | |
a95a7133 | 9812 | """AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9813 | return _core_.Menu_AppendMenu(*args, **kwargs) |
e811c8ce | 9814 | |
50efceee RD |
9815 | def AppendSubMenu(*args, **kwargs): |
9816 | """AppendSubMenu(self, Menu submenu, String text, String help=EmptyString) -> MenuItem""" | |
9817 | return _core_.Menu_AppendSubMenu(*args, **kwargs) | |
9818 | ||
e811c8ce | 9819 | def AppendItem(*args, **kwargs): |
a95a7133 | 9820 | """AppendItem(self, MenuItem item) -> MenuItem""" |
54f9ee45 | 9821 | return _core_.Menu_AppendItem(*args, **kwargs) |
e811c8ce | 9822 | |
e811c8ce | 9823 | def InsertItem(*args, **kwargs): |
a95a7133 | 9824 | """InsertItem(self, size_t pos, MenuItem item) -> MenuItem""" |
54f9ee45 | 9825 | return _core_.Menu_InsertItem(*args, **kwargs) |
e811c8ce | 9826 | |
0085ce49 RD |
9827 | def PrependItem(*args, **kwargs): |
9828 | """PrependItem(self, MenuItem item) -> MenuItem""" | |
9829 | return _core_.Menu_PrependItem(*args, **kwargs) | |
9830 | ||
9831 | def Break(*args, **kwargs): | |
9832 | """Break(self)""" | |
9833 | return _core_.Menu_Break(*args, **kwargs) | |
9834 | ||
e811c8ce | 9835 | def Insert(*args, **kwargs): |
0df68c9f | 9836 | """ |
a95a7133 | 9837 | Insert(self, size_t pos, int id, String text, String help=EmptyString, |
a41e16b6 | 9838 | int kind=ITEM_NORMAL) -> MenuItem |
0df68c9f | 9839 | """ |
54f9ee45 | 9840 | return _core_.Menu_Insert(*args, **kwargs) |
e811c8ce RD |
9841 | |
9842 | def InsertSeparator(*args, **kwargs): | |
a95a7133 | 9843 | """InsertSeparator(self, size_t pos) -> MenuItem""" |
54f9ee45 | 9844 | return _core_.Menu_InsertSeparator(*args, **kwargs) |
e811c8ce RD |
9845 | |
9846 | def InsertCheckItem(*args, **kwargs): | |
a95a7133 | 9847 | """InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9848 | return _core_.Menu_InsertCheckItem(*args, **kwargs) |
e811c8ce RD |
9849 | |
9850 | def InsertRadioItem(*args, **kwargs): | |
a95a7133 | 9851 | """InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9852 | return _core_.Menu_InsertRadioItem(*args, **kwargs) |
e811c8ce RD |
9853 | |
9854 | def InsertMenu(*args, **kwargs): | |
a95a7133 | 9855 | """InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9856 | return _core_.Menu_InsertMenu(*args, **kwargs) |
e811c8ce | 9857 | |
e811c8ce | 9858 | def Prepend(*args, **kwargs): |
a95a7133 | 9859 | """Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem""" |
54f9ee45 | 9860 | return _core_.Menu_Prepend(*args, **kwargs) |
e811c8ce RD |
9861 | |
9862 | def PrependSeparator(*args, **kwargs): | |
a95a7133 | 9863 | """PrependSeparator(self) -> MenuItem""" |
54f9ee45 | 9864 | return _core_.Menu_PrependSeparator(*args, **kwargs) |
e811c8ce RD |
9865 | |
9866 | def PrependCheckItem(*args, **kwargs): | |
a95a7133 | 9867 | """PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9868 | return _core_.Menu_PrependCheckItem(*args, **kwargs) |
e811c8ce RD |
9869 | |
9870 | def PrependRadioItem(*args, **kwargs): | |
a95a7133 | 9871 | """PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9872 | return _core_.Menu_PrependRadioItem(*args, **kwargs) |
e811c8ce RD |
9873 | |
9874 | def PrependMenu(*args, **kwargs): | |
a95a7133 | 9875 | """PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem""" |
54f9ee45 | 9876 | return _core_.Menu_PrependMenu(*args, **kwargs) |
e811c8ce RD |
9877 | |
9878 | def Remove(*args, **kwargs): | |
a95a7133 | 9879 | """Remove(self, int id) -> MenuItem""" |
54f9ee45 | 9880 | return _core_.Menu_Remove(*args, **kwargs) |
e811c8ce RD |
9881 | |
9882 | def RemoveItem(*args, **kwargs): | |
a95a7133 | 9883 | """RemoveItem(self, MenuItem item) -> MenuItem""" |
54f9ee45 | 9884 | return _core_.Menu_RemoveItem(*args, **kwargs) |
e811c8ce RD |
9885 | |
9886 | def Delete(*args, **kwargs): | |
a95a7133 | 9887 | """Delete(self, int id) -> bool""" |
54f9ee45 | 9888 | return _core_.Menu_Delete(*args, **kwargs) |
e811c8ce RD |
9889 | |
9890 | def DeleteItem(*args, **kwargs): | |
a95a7133 | 9891 | """DeleteItem(self, MenuItem item) -> bool""" |
54f9ee45 | 9892 | return _core_.Menu_DeleteItem(*args, **kwargs) |
e811c8ce RD |
9893 | |
9894 | def Destroy(*args, **kwargs): | |
0df68c9f | 9895 | """ |
a95a7133 | 9896 | Destroy(self) |
e811c8ce | 9897 | |
0df68c9f RD |
9898 | Deletes the C++ object this Python object is a proxy for. |
9899 | """ | |
7e08d4ef RD |
9900 | val = _core_.Menu_Destroy(*args, **kwargs) |
9901 | args[0].thisown = 0 | |
9902 | return val | |
e811c8ce RD |
9903 | |
9904 | def DestroyId(*args, **kwargs): | |
0df68c9f | 9905 | """ |
a95a7133 | 9906 | DestroyId(self, int id) -> bool |
e811c8ce | 9907 | |
0df68c9f RD |
9908 | Deletes the C++ object this Python object is a proxy for. |
9909 | """ | |
7e08d4ef RD |
9910 | val = _core_.Menu_DestroyId(*args, **kwargs) |
9911 | args[0].thisown = 0 | |
9912 | return val | |
e811c8ce RD |
9913 | |
9914 | def DestroyItem(*args, **kwargs): | |
0df68c9f | 9915 | """ |
a95a7133 | 9916 | DestroyItem(self, MenuItem item) -> bool |
e811c8ce | 9917 | |
0df68c9f RD |
9918 | Deletes the C++ object this Python object is a proxy for. |
9919 | """ | |
7e08d4ef RD |
9920 | val = _core_.Menu_DestroyItem(*args, **kwargs) |
9921 | args[0].thisown = 0 | |
9922 | return val | |
e811c8ce RD |
9923 | |
9924 | def GetMenuItemCount(*args, **kwargs): | |
a95a7133 | 9925 | """GetMenuItemCount(self) -> size_t""" |
54f9ee45 | 9926 | return _core_.Menu_GetMenuItemCount(*args, **kwargs) |
e811c8ce RD |
9927 | |
9928 | def GetMenuItems(*args, **kwargs): | |
a95a7133 | 9929 | """GetMenuItems(self) -> PyObject""" |
54f9ee45 | 9930 | return _core_.Menu_GetMenuItems(*args, **kwargs) |
e811c8ce RD |
9931 | |
9932 | def FindItem(*args, **kwargs): | |
a95a7133 | 9933 | """FindItem(self, String item) -> int""" |
54f9ee45 | 9934 | return _core_.Menu_FindItem(*args, **kwargs) |
e811c8ce RD |
9935 | |
9936 | def FindItemById(*args, **kwargs): | |
a95a7133 | 9937 | """FindItemById(self, int id) -> MenuItem""" |
54f9ee45 | 9938 | return _core_.Menu_FindItemById(*args, **kwargs) |
e811c8ce RD |
9939 | |
9940 | def FindItemByPosition(*args, **kwargs): | |
a95a7133 | 9941 | """FindItemByPosition(self, size_t position) -> MenuItem""" |
54f9ee45 | 9942 | return _core_.Menu_FindItemByPosition(*args, **kwargs) |
e811c8ce RD |
9943 | |
9944 | def Enable(*args, **kwargs): | |
a95a7133 | 9945 | """Enable(self, int id, bool enable)""" |
54f9ee45 | 9946 | return _core_.Menu_Enable(*args, **kwargs) |
e811c8ce RD |
9947 | |
9948 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 9949 | """IsEnabled(self, int id) -> bool""" |
54f9ee45 | 9950 | return _core_.Menu_IsEnabled(*args, **kwargs) |
e811c8ce RD |
9951 | |
9952 | def Check(*args, **kwargs): | |
a95a7133 | 9953 | """Check(self, int id, bool check)""" |
54f9ee45 | 9954 | return _core_.Menu_Check(*args, **kwargs) |
e811c8ce RD |
9955 | |
9956 | def IsChecked(*args, **kwargs): | |
a95a7133 | 9957 | """IsChecked(self, int id) -> bool""" |
54f9ee45 | 9958 | return _core_.Menu_IsChecked(*args, **kwargs) |
e811c8ce RD |
9959 | |
9960 | def SetLabel(*args, **kwargs): | |
a95a7133 | 9961 | """SetLabel(self, int id, String label)""" |
54f9ee45 | 9962 | return _core_.Menu_SetLabel(*args, **kwargs) |
e811c8ce RD |
9963 | |
9964 | def GetLabel(*args, **kwargs): | |
a95a7133 | 9965 | """GetLabel(self, int id) -> String""" |
54f9ee45 | 9966 | return _core_.Menu_GetLabel(*args, **kwargs) |
e811c8ce RD |
9967 | |
9968 | def SetHelpString(*args, **kwargs): | |
a95a7133 | 9969 | """SetHelpString(self, int id, String helpString)""" |
54f9ee45 | 9970 | return _core_.Menu_SetHelpString(*args, **kwargs) |
e811c8ce RD |
9971 | |
9972 | def GetHelpString(*args, **kwargs): | |
a95a7133 | 9973 | """GetHelpString(self, int id) -> String""" |
54f9ee45 | 9974 | return _core_.Menu_GetHelpString(*args, **kwargs) |
e811c8ce RD |
9975 | |
9976 | def SetTitle(*args, **kwargs): | |
a95a7133 | 9977 | """SetTitle(self, String title)""" |
54f9ee45 | 9978 | return _core_.Menu_SetTitle(*args, **kwargs) |
e811c8ce RD |
9979 | |
9980 | def GetTitle(*args, **kwargs): | |
a95a7133 | 9981 | """GetTitle(self) -> String""" |
54f9ee45 | 9982 | return _core_.Menu_GetTitle(*args, **kwargs) |
e811c8ce RD |
9983 | |
9984 | def SetEventHandler(*args, **kwargs): | |
a95a7133 | 9985 | """SetEventHandler(self, EvtHandler handler)""" |
54f9ee45 | 9986 | return _core_.Menu_SetEventHandler(*args, **kwargs) |
e811c8ce RD |
9987 | |
9988 | def GetEventHandler(*args, **kwargs): | |
a95a7133 | 9989 | """GetEventHandler(self) -> EvtHandler""" |
54f9ee45 | 9990 | return _core_.Menu_GetEventHandler(*args, **kwargs) |
e811c8ce RD |
9991 | |
9992 | def SetInvokingWindow(*args, **kwargs): | |
a95a7133 | 9993 | """SetInvokingWindow(self, Window win)""" |
54f9ee45 | 9994 | return _core_.Menu_SetInvokingWindow(*args, **kwargs) |
e811c8ce RD |
9995 | |
9996 | def GetInvokingWindow(*args, **kwargs): | |
a95a7133 | 9997 | """GetInvokingWindow(self) -> Window""" |
54f9ee45 | 9998 | return _core_.Menu_GetInvokingWindow(*args, **kwargs) |
e811c8ce RD |
9999 | |
10000 | def GetStyle(*args, **kwargs): | |
a95a7133 | 10001 | """GetStyle(self) -> long""" |
54f9ee45 | 10002 | return _core_.Menu_GetStyle(*args, **kwargs) |
e811c8ce RD |
10003 | |
10004 | def UpdateUI(*args, **kwargs): | |
a95a7133 | 10005 | """UpdateUI(self, EvtHandler source=None)""" |
54f9ee45 | 10006 | return _core_.Menu_UpdateUI(*args, **kwargs) |
e811c8ce RD |
10007 | |
10008 | def GetMenuBar(*args, **kwargs): | |
a95a7133 | 10009 | """GetMenuBar(self) -> MenuBar""" |
54f9ee45 | 10010 | return _core_.Menu_GetMenuBar(*args, **kwargs) |
e811c8ce RD |
10011 | |
10012 | def Attach(*args, **kwargs): | |
a95a7133 | 10013 | """Attach(self, wxMenuBarBase menubar)""" |
54f9ee45 | 10014 | return _core_.Menu_Attach(*args, **kwargs) |
e811c8ce RD |
10015 | |
10016 | def Detach(*args, **kwargs): | |
a95a7133 | 10017 | """Detach(self)""" |
54f9ee45 | 10018 | return _core_.Menu_Detach(*args, **kwargs) |
e811c8ce RD |
10019 | |
10020 | def IsAttached(*args, **kwargs): | |
a95a7133 | 10021 | """IsAttached(self) -> bool""" |
54f9ee45 | 10022 | return _core_.Menu_IsAttached(*args, **kwargs) |
e811c8ce RD |
10023 | |
10024 | def SetParent(*args, **kwargs): | |
a95a7133 | 10025 | """SetParent(self, Menu parent)""" |
54f9ee45 | 10026 | return _core_.Menu_SetParent(*args, **kwargs) |
e811c8ce RD |
10027 | |
10028 | def GetParent(*args, **kwargs): | |
a95a7133 | 10029 | """GetParent(self) -> Menu""" |
54f9ee45 | 10030 | return _core_.Menu_GetParent(*args, **kwargs) |
e811c8ce | 10031 | |
2131d850 | 10032 | _core_.Menu_swigregister(Menu) |
d14a1e28 RD |
10033 | DefaultValidator = cvar.DefaultValidator |
10034 | ||
10035 | #--------------------------------------------------------------------------- | |
10036 | ||
10037 | class MenuBar(Window): | |
093d3ff1 | 10038 | """Proxy of C++ MenuBar class""" |
0085ce49 RD |
10039 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10040 | __repr__ = _swig_repr | |
10041 | def __init__(self, *args, **kwargs): | |
a95a7133 | 10042 | """__init__(self, long style=0) -> MenuBar""" |
0085ce49 | 10043 | _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs)) |
d14a1e28 | 10044 | self._setOORInfo(self) |
e811c8ce RD |
10045 | |
10046 | def Append(*args, **kwargs): | |
a95a7133 | 10047 | """Append(self, Menu menu, String title) -> bool""" |
54f9ee45 | 10048 | return _core_.MenuBar_Append(*args, **kwargs) |
e811c8ce RD |
10049 | |
10050 | def Insert(*args, **kwargs): | |
a95a7133 | 10051 | """Insert(self, size_t pos, Menu menu, String title) -> bool""" |
54f9ee45 | 10052 | return _core_.MenuBar_Insert(*args, **kwargs) |
e811c8ce RD |
10053 | |
10054 | def GetMenuCount(*args, **kwargs): | |
a95a7133 | 10055 | """GetMenuCount(self) -> size_t""" |
54f9ee45 | 10056 | return _core_.MenuBar_GetMenuCount(*args, **kwargs) |
e811c8ce RD |
10057 | |
10058 | def GetMenu(*args, **kwargs): | |
a95a7133 | 10059 | """GetMenu(self, size_t pos) -> Menu""" |
54f9ee45 | 10060 | return _core_.MenuBar_GetMenu(*args, **kwargs) |
e811c8ce RD |
10061 | |
10062 | def Replace(*args, **kwargs): | |
a95a7133 | 10063 | """Replace(self, size_t pos, Menu menu, String title) -> Menu""" |
54f9ee45 | 10064 | return _core_.MenuBar_Replace(*args, **kwargs) |
e811c8ce RD |
10065 | |
10066 | def Remove(*args, **kwargs): | |
a95a7133 | 10067 | """Remove(self, size_t pos) -> Menu""" |
54f9ee45 | 10068 | return _core_.MenuBar_Remove(*args, **kwargs) |
e811c8ce RD |
10069 | |
10070 | def EnableTop(*args, **kwargs): | |
a95a7133 | 10071 | """EnableTop(self, size_t pos, bool enable)""" |
54f9ee45 | 10072 | return _core_.MenuBar_EnableTop(*args, **kwargs) |
e811c8ce RD |
10073 | |
10074 | def IsEnabledTop(*args, **kwargs): | |
a95a7133 | 10075 | """IsEnabledTop(self, size_t pos) -> bool""" |
54f9ee45 | 10076 | return _core_.MenuBar_IsEnabledTop(*args, **kwargs) |
e811c8ce RD |
10077 | |
10078 | def SetLabelTop(*args, **kwargs): | |
a95a7133 | 10079 | """SetLabelTop(self, size_t pos, String label)""" |
54f9ee45 | 10080 | return _core_.MenuBar_SetLabelTop(*args, **kwargs) |
e811c8ce RD |
10081 | |
10082 | def GetLabelTop(*args, **kwargs): | |
a95a7133 | 10083 | """GetLabelTop(self, size_t pos) -> String""" |
54f9ee45 | 10084 | return _core_.MenuBar_GetLabelTop(*args, **kwargs) |
e811c8ce RD |
10085 | |
10086 | def FindMenuItem(*args, **kwargs): | |
a95a7133 | 10087 | """FindMenuItem(self, String menu, String item) -> int""" |
54f9ee45 | 10088 | return _core_.MenuBar_FindMenuItem(*args, **kwargs) |
e811c8ce RD |
10089 | |
10090 | def FindItemById(*args, **kwargs): | |
a95a7133 | 10091 | """FindItemById(self, int id) -> MenuItem""" |
54f9ee45 | 10092 | return _core_.MenuBar_FindItemById(*args, **kwargs) |
e811c8ce RD |
10093 | |
10094 | def FindMenu(*args, **kwargs): | |
a95a7133 | 10095 | """FindMenu(self, String title) -> int""" |
54f9ee45 | 10096 | return _core_.MenuBar_FindMenu(*args, **kwargs) |
e811c8ce RD |
10097 | |
10098 | def Enable(*args, **kwargs): | |
a95a7133 | 10099 | """Enable(self, int id, bool enable)""" |
54f9ee45 | 10100 | return _core_.MenuBar_Enable(*args, **kwargs) |
e811c8ce RD |
10101 | |
10102 | def Check(*args, **kwargs): | |
a95a7133 | 10103 | """Check(self, int id, bool check)""" |
54f9ee45 | 10104 | return _core_.MenuBar_Check(*args, **kwargs) |
e811c8ce RD |
10105 | |
10106 | def IsChecked(*args, **kwargs): | |
a95a7133 | 10107 | """IsChecked(self, int id) -> bool""" |
54f9ee45 | 10108 | return _core_.MenuBar_IsChecked(*args, **kwargs) |
e811c8ce RD |
10109 | |
10110 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 10111 | """IsEnabled(self, int id) -> bool""" |
54f9ee45 | 10112 | return _core_.MenuBar_IsEnabled(*args, **kwargs) |
e811c8ce RD |
10113 | |
10114 | def SetLabel(*args, **kwargs): | |
a95a7133 | 10115 | """SetLabel(self, int id, String label)""" |
54f9ee45 | 10116 | return _core_.MenuBar_SetLabel(*args, **kwargs) |
e811c8ce RD |
10117 | |
10118 | def GetLabel(*args, **kwargs): | |
a95a7133 | 10119 | """GetLabel(self, int id) -> String""" |
54f9ee45 | 10120 | return _core_.MenuBar_GetLabel(*args, **kwargs) |
e811c8ce RD |
10121 | |
10122 | def SetHelpString(*args, **kwargs): | |
a95a7133 | 10123 | """SetHelpString(self, int id, String helpString)""" |
54f9ee45 | 10124 | return _core_.MenuBar_SetHelpString(*args, **kwargs) |
e811c8ce RD |
10125 | |
10126 | def GetHelpString(*args, **kwargs): | |
a95a7133 | 10127 | """GetHelpString(self, int id) -> String""" |
54f9ee45 | 10128 | return _core_.MenuBar_GetHelpString(*args, **kwargs) |
e811c8ce RD |
10129 | |
10130 | def GetFrame(*args, **kwargs): | |
a95a7133 | 10131 | """GetFrame(self) -> wxFrame""" |
54f9ee45 | 10132 | return _core_.MenuBar_GetFrame(*args, **kwargs) |
e811c8ce RD |
10133 | |
10134 | def IsAttached(*args, **kwargs): | |
a95a7133 | 10135 | """IsAttached(self) -> bool""" |
54f9ee45 | 10136 | return _core_.MenuBar_IsAttached(*args, **kwargs) |
e811c8ce RD |
10137 | |
10138 | def Attach(*args, **kwargs): | |
a95a7133 | 10139 | """Attach(self, wxFrame frame)""" |
54f9ee45 | 10140 | return _core_.MenuBar_Attach(*args, **kwargs) |
e811c8ce RD |
10141 | |
10142 | def Detach(*args, **kwargs): | |
a95a7133 | 10143 | """Detach(self)""" |
54f9ee45 | 10144 | return _core_.MenuBar_Detach(*args, **kwargs) |
e811c8ce | 10145 | |
4f433fef RD |
10146 | def SetAutoWindowMenu(*args, **kwargs): |
10147 | """SetAutoWindowMenu(bool enable)""" | |
10148 | return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs) | |
10149 | ||
10150 | SetAutoWindowMenu = staticmethod(SetAutoWindowMenu) | |
10151 | def GetAutoWindowMenu(*args, **kwargs): | |
10152 | """GetAutoWindowMenu() -> bool""" | |
10153 | return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs) | |
10154 | ||
10155 | GetAutoWindowMenu = staticmethod(GetAutoWindowMenu) | |
2131d850 | 10156 | _core_.MenuBar_swigregister(MenuBar) |
d14a1e28 | 10157 | |
4f433fef | 10158 | def MenuBar_SetAutoWindowMenu(*args, **kwargs): |
0085ce49 RD |
10159 | """MenuBar_SetAutoWindowMenu(bool enable)""" |
10160 | return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs) | |
4f433fef | 10161 | |
0085ce49 RD |
10162 | def MenuBar_GetAutoWindowMenu(*args): |
10163 | """MenuBar_GetAutoWindowMenu() -> bool""" | |
10164 | return _core_.MenuBar_GetAutoWindowMenu(*args) | |
4f433fef | 10165 | |
d14a1e28 RD |
10166 | #--------------------------------------------------------------------------- |
10167 | ||
10168 | class MenuItem(Object): | |
093d3ff1 | 10169 | """Proxy of C++ MenuItem class""" |
0085ce49 RD |
10170 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10171 | __repr__ = _swig_repr | |
10172 | def __init__(self, *args, **kwargs): | |
0df68c9f | 10173 | """ |
a95a7133 | 10174 | __init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString, |
196addbf RD |
10175 | String help=EmptyString, int kind=ITEM_NORMAL, |
10176 | Menu subMenu=None) -> MenuItem | |
0df68c9f | 10177 | """ |
0085ce49 RD |
10178 | _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs)) |
10179 | __swig_destroy__ = _core_.delete_MenuItem | |
10180 | __del__ = lambda self : None; | |
e811c8ce | 10181 | def GetMenu(*args, **kwargs): |
a95a7133 | 10182 | """GetMenu(self) -> Menu""" |
54f9ee45 | 10183 | return _core_.MenuItem_GetMenu(*args, **kwargs) |
e811c8ce RD |
10184 | |
10185 | def SetMenu(*args, **kwargs): | |
a95a7133 | 10186 | """SetMenu(self, Menu menu)""" |
54f9ee45 | 10187 | return _core_.MenuItem_SetMenu(*args, **kwargs) |
e811c8ce RD |
10188 | |
10189 | def SetId(*args, **kwargs): | |
a95a7133 | 10190 | """SetId(self, int id)""" |
54f9ee45 | 10191 | return _core_.MenuItem_SetId(*args, **kwargs) |
e811c8ce RD |
10192 | |
10193 | def GetId(*args, **kwargs): | |
a95a7133 | 10194 | """GetId(self) -> int""" |
54f9ee45 | 10195 | return _core_.MenuItem_GetId(*args, **kwargs) |
e811c8ce RD |
10196 | |
10197 | def IsSeparator(*args, **kwargs): | |
a95a7133 | 10198 | """IsSeparator(self) -> bool""" |
54f9ee45 | 10199 | return _core_.MenuItem_IsSeparator(*args, **kwargs) |
e811c8ce RD |
10200 | |
10201 | def SetText(*args, **kwargs): | |
a95a7133 | 10202 | """SetText(self, String str)""" |
54f9ee45 | 10203 | return _core_.MenuItem_SetText(*args, **kwargs) |
e811c8ce RD |
10204 | |
10205 | def GetLabel(*args, **kwargs): | |
a95a7133 | 10206 | """GetLabel(self) -> String""" |
54f9ee45 | 10207 | return _core_.MenuItem_GetLabel(*args, **kwargs) |
e811c8ce RD |
10208 | |
10209 | def GetText(*args, **kwargs): | |
a95a7133 | 10210 | """GetText(self) -> String""" |
54f9ee45 | 10211 | return _core_.MenuItem_GetText(*args, **kwargs) |
e811c8ce RD |
10212 | |
10213 | def GetLabelFromText(*args, **kwargs): | |
66c033b4 | 10214 | """GetLabelFromText(String text) -> String""" |
54f9ee45 | 10215 | return _core_.MenuItem_GetLabelFromText(*args, **kwargs) |
e811c8ce RD |
10216 | |
10217 | GetLabelFromText = staticmethod(GetLabelFromText) | |
10218 | def GetKind(*args, **kwargs): | |
a95a7133 | 10219 | """GetKind(self) -> int""" |
54f9ee45 | 10220 | return _core_.MenuItem_GetKind(*args, **kwargs) |
e811c8ce | 10221 | |
a95a7133 RD |
10222 | def SetKind(*args, **kwargs): |
10223 | """SetKind(self, int kind)""" | |
54f9ee45 | 10224 | return _core_.MenuItem_SetKind(*args, **kwargs) |
a95a7133 | 10225 | |
e811c8ce | 10226 | def SetCheckable(*args, **kwargs): |
a95a7133 | 10227 | """SetCheckable(self, bool checkable)""" |
54f9ee45 | 10228 | return _core_.MenuItem_SetCheckable(*args, **kwargs) |
e811c8ce RD |
10229 | |
10230 | def IsCheckable(*args, **kwargs): | |
a95a7133 | 10231 | """IsCheckable(self) -> bool""" |
54f9ee45 | 10232 | return _core_.MenuItem_IsCheckable(*args, **kwargs) |
e811c8ce RD |
10233 | |
10234 | def IsSubMenu(*args, **kwargs): | |
a95a7133 | 10235 | """IsSubMenu(self) -> bool""" |
54f9ee45 | 10236 | return _core_.MenuItem_IsSubMenu(*args, **kwargs) |
e811c8ce RD |
10237 | |
10238 | def SetSubMenu(*args, **kwargs): | |
a95a7133 | 10239 | """SetSubMenu(self, Menu menu)""" |
54f9ee45 | 10240 | return _core_.MenuItem_SetSubMenu(*args, **kwargs) |
e811c8ce RD |
10241 | |
10242 | def GetSubMenu(*args, **kwargs): | |
a95a7133 | 10243 | """GetSubMenu(self) -> Menu""" |
54f9ee45 | 10244 | return _core_.MenuItem_GetSubMenu(*args, **kwargs) |
e811c8ce RD |
10245 | |
10246 | def Enable(*args, **kwargs): | |
a95a7133 | 10247 | """Enable(self, bool enable=True)""" |
54f9ee45 | 10248 | return _core_.MenuItem_Enable(*args, **kwargs) |
e811c8ce RD |
10249 | |
10250 | def IsEnabled(*args, **kwargs): | |
a95a7133 | 10251 | """IsEnabled(self) -> bool""" |
54f9ee45 | 10252 | return _core_.MenuItem_IsEnabled(*args, **kwargs) |
e811c8ce RD |
10253 | |
10254 | def Check(*args, **kwargs): | |
a95a7133 | 10255 | """Check(self, bool check=True)""" |
54f9ee45 | 10256 | return _core_.MenuItem_Check(*args, **kwargs) |
e811c8ce RD |
10257 | |
10258 | def IsChecked(*args, **kwargs): | |
a95a7133 | 10259 | """IsChecked(self) -> bool""" |
54f9ee45 | 10260 | return _core_.MenuItem_IsChecked(*args, **kwargs) |
e811c8ce RD |
10261 | |
10262 | def Toggle(*args, **kwargs): | |
a95a7133 | 10263 | """Toggle(self)""" |
54f9ee45 | 10264 | return _core_.MenuItem_Toggle(*args, **kwargs) |
e811c8ce RD |
10265 | |
10266 | def SetHelp(*args, **kwargs): | |
a95a7133 | 10267 | """SetHelp(self, String str)""" |
54f9ee45 | 10268 | return _core_.MenuItem_SetHelp(*args, **kwargs) |
e811c8ce RD |
10269 | |
10270 | def GetHelp(*args, **kwargs): | |
a95a7133 | 10271 | """GetHelp(self) -> String""" |
54f9ee45 | 10272 | return _core_.MenuItem_GetHelp(*args, **kwargs) |
e811c8ce RD |
10273 | |
10274 | def GetAccel(*args, **kwargs): | |
a95a7133 | 10275 | """GetAccel(self) -> AcceleratorEntry""" |
54f9ee45 | 10276 | return _core_.MenuItem_GetAccel(*args, **kwargs) |
e811c8ce RD |
10277 | |
10278 | def SetAccel(*args, **kwargs): | |
a95a7133 | 10279 | """SetAccel(self, AcceleratorEntry accel)""" |
54f9ee45 | 10280 | return _core_.MenuItem_SetAccel(*args, **kwargs) |
e811c8ce | 10281 | |
091f5bed RD |
10282 | def SetBitmap(*args, **kwargs): |
10283 | """SetBitmap(self, Bitmap bitmap)""" | |
10284 | return _core_.MenuItem_SetBitmap(*args, **kwargs) | |
10285 | ||
10286 | def GetBitmap(*args, **kwargs): | |
10287 | """GetBitmap(self) -> Bitmap""" | |
10288 | return _core_.MenuItem_GetBitmap(*args, **kwargs) | |
10289 | ||
c1280d1e RD |
10290 | def SetFont(*args, **kwargs): |
10291 | """SetFont(self, Font font)""" | |
10292 | return _core_.MenuItem_SetFont(*args, **kwargs) | |
10293 | ||
10294 | def GetFont(*args, **kwargs): | |
10295 | """GetFont(self) -> Font""" | |
10296 | return _core_.MenuItem_GetFont(*args, **kwargs) | |
10297 | ||
10298 | def SetTextColour(*args, **kwargs): | |
10299 | """SetTextColour(self, Colour colText)""" | |
10300 | return _core_.MenuItem_SetTextColour(*args, **kwargs) | |
10301 | ||
10302 | def GetTextColour(*args, **kwargs): | |
10303 | """GetTextColour(self) -> Colour""" | |
10304 | return _core_.MenuItem_GetTextColour(*args, **kwargs) | |
10305 | ||
10306 | def SetBackgroundColour(*args, **kwargs): | |
10307 | """SetBackgroundColour(self, Colour colBack)""" | |
10308 | return _core_.MenuItem_SetBackgroundColour(*args, **kwargs) | |
10309 | ||
10310 | def GetBackgroundColour(*args, **kwargs): | |
10311 | """GetBackgroundColour(self) -> Colour""" | |
10312 | return _core_.MenuItem_GetBackgroundColour(*args, **kwargs) | |
10313 | ||
10314 | def SetBitmaps(*args, **kwargs): | |
10315 | """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)""" | |
10316 | return _core_.MenuItem_SetBitmaps(*args, **kwargs) | |
10317 | ||
10318 | def SetDisabledBitmap(*args, **kwargs): | |
10319 | """SetDisabledBitmap(self, Bitmap bmpDisabled)""" | |
10320 | return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs) | |
10321 | ||
10322 | def GetDisabledBitmap(*args, **kwargs): | |
10323 | """GetDisabledBitmap(self) -> Bitmap""" | |
10324 | return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs) | |
10325 | ||
10326 | def SetMarginWidth(*args, **kwargs): | |
10327 | """SetMarginWidth(self, int nWidth)""" | |
10328 | return _core_.MenuItem_SetMarginWidth(*args, **kwargs) | |
10329 | ||
10330 | def GetMarginWidth(*args, **kwargs): | |
10331 | """GetMarginWidth(self) -> int""" | |
10332 | return _core_.MenuItem_GetMarginWidth(*args, **kwargs) | |
10333 | ||
e811c8ce | 10334 | def GetDefaultMarginWidth(*args, **kwargs): |
66c033b4 | 10335 | """GetDefaultMarginWidth() -> int""" |
54f9ee45 | 10336 | return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs) |
e811c8ce RD |
10337 | |
10338 | GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth) | |
c1280d1e RD |
10339 | def IsOwnerDrawn(*args, **kwargs): |
10340 | """IsOwnerDrawn(self) -> bool""" | |
10341 | return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs) | |
10342 | ||
10343 | def SetOwnerDrawn(*args, **kwargs): | |
10344 | """SetOwnerDrawn(self, bool ownerDrawn=True)""" | |
10345 | return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs) | |
10346 | ||
10347 | def ResetOwnerDrawn(*args, **kwargs): | |
10348 | """ResetOwnerDrawn(self)""" | |
10349 | return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs) | |
10350 | ||
2131d850 | 10351 | _core_.MenuItem_swigregister(MenuItem) |
d14a1e28 | 10352 | |
e811c8ce | 10353 | def MenuItem_GetLabelFromText(*args, **kwargs): |
0085ce49 RD |
10354 | """MenuItem_GetLabelFromText(String text) -> String""" |
10355 | return _core_.MenuItem_GetLabelFromText(*args, **kwargs) | |
d14a1e28 | 10356 | |
0085ce49 RD |
10357 | def MenuItem_GetDefaultMarginWidth(*args): |
10358 | """MenuItem_GetDefaultMarginWidth() -> int""" | |
10359 | return _core_.MenuItem_GetDefaultMarginWidth(*args) | |
d14a1e28 RD |
10360 | |
10361 | #--------------------------------------------------------------------------- | |
10362 | ||
10363 | class Control(Window): | |
15afbcd0 RD |
10364 | """ |
10365 | This is the base class for a control or 'widget'. | |
10366 | ||
41e2b43e RD |
10367 | A control is generally a small window which processes user input |
10368 | and/or displays one or more item of data. | |
15afbcd0 | 10369 | """ |
0085ce49 RD |
10370 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10371 | __repr__ = _swig_repr | |
10372 | def __init__(self, *args, **kwargs): | |
0df68c9f | 10373 | """ |
248ed943 RD |
10374 | __init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
10375 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
b2dc1044 | 10376 | String name=ControlNameStr) -> Control |
15afbcd0 | 10377 | |
41e2b43e RD |
10378 | Create a Control. Normally you should only call this from a subclass' |
10379 | __init__ as a plain old wx.Control is not very useful. | |
0df68c9f | 10380 | """ |
0085ce49 | 10381 | _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs)) |
d14a1e28 | 10382 | self._setOORInfo(self) |
e811c8ce RD |
10383 | |
10384 | def Create(*args, **kwargs): | |
0df68c9f | 10385 | """ |
248ed943 RD |
10386 | Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
10387 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
b2dc1044 | 10388 | String name=ControlNameStr) -> bool |
15afbcd0 RD |
10389 | |
10390 | Do the 2nd phase and create the GUI control. | |
0df68c9f | 10391 | """ |
54f9ee45 | 10392 | return _core_.Control_Create(*args, **kwargs) |
e811c8ce RD |
10393 | |
10394 | def Command(*args, **kwargs): | |
15afbcd0 | 10395 | """ |
a95a7133 | 10396 | Command(self, CommandEvent event) |
15afbcd0 | 10397 | |
41e2b43e RD |
10398 | Simulates the effect of the user issuing a command to the item. |
10399 | ||
10400 | :see: `wx.CommandEvent` | |
10401 | ||
15afbcd0 | 10402 | """ |
54f9ee45 | 10403 | return _core_.Control_Command(*args, **kwargs) |
e811c8ce RD |
10404 | |
10405 | def GetLabel(*args, **kwargs): | |
15afbcd0 | 10406 | """ |
a95a7133 | 10407 | GetLabel(self) -> String |
15afbcd0 RD |
10408 | |
10409 | Return a control's text. | |
10410 | """ | |
54f9ee45 | 10411 | return _core_.Control_GetLabel(*args, **kwargs) |
e811c8ce | 10412 | |
74a57fcd | 10413 | def GetClassDefaultAttributes(*args, **kwargs): |
110da5b0 RD |
10414 | """ |
10415 | GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes | |
10416 | ||
10417 | Get the default attributes for this class. This is useful if you want | |
10418 | to use the same font or colour in your own control as in a standard | |
10419 | control -- which is a much better idea than hard coding specific | |
10420 | colours or fonts which might look completely out of place on the | |
10421 | user's system, especially if it uses themes. | |
10422 | ||
10423 | The variant parameter is only relevant under Mac currently and is | |
10424 | ignore under other platforms. Under Mac, it will change the size of | |
10425 | the returned font. See `wx.Window.SetWindowVariant` for more about | |
10426 | this. | |
10427 | """ | |
54f9ee45 | 10428 | return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd RD |
10429 | |
10430 | GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) | |
2131d850 | 10431 | _core_.Control_swigregister(Control) |
b2dc1044 | 10432 | ControlNameStr = cvar.ControlNameStr |
d14a1e28 RD |
10433 | |
10434 | def PreControl(*args, **kwargs): | |
15afbcd0 RD |
10435 | """ |
10436 | PreControl() -> Control | |
10437 | ||
10438 | Precreate a Control control for 2-phase creation | |
10439 | """ | |
54f9ee45 | 10440 | val = _core_.new_PreControl(*args, **kwargs) |
d14a1e28 RD |
10441 | return val |
10442 | ||
74a57fcd | 10443 | def Control_GetClassDefaultAttributes(*args, **kwargs): |
0085ce49 | 10444 | """ |
110da5b0 RD |
10445 | Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes |
10446 | ||
10447 | Get the default attributes for this class. This is useful if you want | |
10448 | to use the same font or colour in your own control as in a standard | |
10449 | control -- which is a much better idea than hard coding specific | |
10450 | colours or fonts which might look completely out of place on the | |
10451 | user's system, especially if it uses themes. | |
10452 | ||
10453 | The variant parameter is only relevant under Mac currently and is | |
10454 | ignore under other platforms. Under Mac, it will change the size of | |
10455 | the returned font. See `wx.Window.SetWindowVariant` for more about | |
10456 | this. | |
10457 | """ | |
0085ce49 | 10458 | return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) |
74a57fcd | 10459 | |
d14a1e28 RD |
10460 | #--------------------------------------------------------------------------- |
10461 | ||
10462 | class ItemContainer(object): | |
15afbcd0 | 10463 | """ |
53aa7709 RD |
10464 | The wx.ItemContainer class defines an interface which is implemented |
10465 | by all controls which have string subitems, each of which may be | |
10466 | selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well | |
10467 | as `wx.ComboBox` which implements an extended interface deriving from | |
41e2b43e | 10468 | this one. |
15afbcd0 | 10469 | |
41e2b43e RD |
10470 | It defines the methods for accessing the control's items and although |
10471 | each of the derived classes implements them differently, they still | |
10472 | all conform to the same interface. | |
15afbcd0 | 10473 | |
41e2b43e RD |
10474 | The items in a wx.ItemContainer have (non empty) string labels and, |
10475 | optionally, client data associated with them. | |
15afbcd0 RD |
10476 | |
10477 | """ | |
0085ce49 RD |
10478 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10479 | def __init__(self): raise AttributeError, "No constructor defined" | |
10480 | __repr__ = _swig_repr | |
e811c8ce | 10481 | def Append(*args, **kwargs): |
15afbcd0 | 10482 | """ |
a95a7133 | 10483 | Append(self, String item, PyObject clientData=None) -> int |
15afbcd0 | 10484 | |
41e2b43e RD |
10485 | Adds the item to the control, associating the given data with the item |
10486 | if not None. The return value is the index of the newly added item | |
10487 | which may be different from the last one if the control is sorted (e.g. | |
10488 | has wx.LB_SORT or wx.CB_SORT style). | |
15afbcd0 | 10489 | """ |
54f9ee45 | 10490 | return _core_.ItemContainer_Append(*args, **kwargs) |
e811c8ce RD |
10491 | |
10492 | def AppendItems(*args, **kwargs): | |
15afbcd0 | 10493 | """ |
f5b96ee1 | 10494 | AppendItems(self, List strings) |
15afbcd0 | 10495 | |
41e2b43e RD |
10496 | Apend several items at once to the control. Notice that calling this |
10497 | method may be much faster than appending the items one by one if you | |
10498 | need to add a lot of items. | |
15afbcd0 | 10499 | """ |
54f9ee45 | 10500 | return _core_.ItemContainer_AppendItems(*args, **kwargs) |
e811c8ce RD |
10501 | |
10502 | def Insert(*args, **kwargs): | |
15afbcd0 | 10503 | """ |
50f151d7 | 10504 | Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int |
15afbcd0 | 10505 | |
41e2b43e | 10506 | Insert an item into the control before the item at the ``pos`` index, |
15afbcd0 RD |
10507 | optionally associating some data object with the item. |
10508 | """ | |
54f9ee45 | 10509 | return _core_.ItemContainer_Insert(*args, **kwargs) |
e811c8ce RD |
10510 | |
10511 | def Clear(*args, **kwargs): | |
15afbcd0 | 10512 | """ |
a95a7133 | 10513 | Clear(self) |
15afbcd0 RD |
10514 | |
10515 | Removes all items from the control. | |
10516 | """ | |
54f9ee45 | 10517 | return _core_.ItemContainer_Clear(*args, **kwargs) |
e811c8ce RD |
10518 | |
10519 | def Delete(*args, **kwargs): | |
15afbcd0 | 10520 | """ |
50f151d7 | 10521 | Delete(self, unsigned int n) |
15afbcd0 | 10522 | |
41e2b43e RD |
10523 | Deletes the item at the zero-based index 'n' from the control. Note |
10524 | that it is an error (signalled by a `wx.PyAssertionError` exception if | |
10525 | enabled) to remove an item with the index negative or greater or equal | |
10526 | than the number of items in the control. | |
15afbcd0 | 10527 | """ |
54f9ee45 | 10528 | return _core_.ItemContainer_Delete(*args, **kwargs) |
e811c8ce | 10529 | |
53aa7709 RD |
10530 | def GetClientData(*args, **kwargs): |
10531 | """ | |
50f151d7 | 10532 | GetClientData(self, unsigned int n) -> PyObject |
53aa7709 RD |
10533 | |
10534 | Returns the client data associated with the given item, (if any.) | |
10535 | """ | |
10536 | return _core_.ItemContainer_GetClientData(*args, **kwargs) | |
10537 | ||
10538 | def SetClientData(*args, **kwargs): | |
10539 | """ | |
50f151d7 | 10540 | SetClientData(self, unsigned int n, PyObject clientData) |
53aa7709 RD |
10541 | |
10542 | Associate the given client data with the item at position n. | |
10543 | """ | |
10544 | return _core_.ItemContainer_SetClientData(*args, **kwargs) | |
10545 | ||
e811c8ce | 10546 | def GetCount(*args, **kwargs): |
15afbcd0 | 10547 | """ |
50f151d7 | 10548 | GetCount(self) -> unsigned int |
15afbcd0 RD |
10549 | |
10550 | Returns the number of items in the control. | |
10551 | """ | |
54f9ee45 | 10552 | return _core_.ItemContainer_GetCount(*args, **kwargs) |
e811c8ce RD |
10553 | |
10554 | def IsEmpty(*args, **kwargs): | |
15afbcd0 | 10555 | """ |
a95a7133 | 10556 | IsEmpty(self) -> bool |
15afbcd0 RD |
10557 | |
10558 | Returns True if the control is empty or False if it has some items. | |
10559 | """ | |
54f9ee45 | 10560 | return _core_.ItemContainer_IsEmpty(*args, **kwargs) |
e811c8ce RD |
10561 | |
10562 | def GetString(*args, **kwargs): | |
15afbcd0 | 10563 | """ |
50f151d7 | 10564 | GetString(self, unsigned int n) -> String |
15afbcd0 RD |
10565 | |
10566 | Returns the label of the item with the given index. | |
10567 | """ | |
54f9ee45 | 10568 | return _core_.ItemContainer_GetString(*args, **kwargs) |
e811c8ce RD |
10569 | |
10570 | def GetStrings(*args, **kwargs): | |
a95a7133 | 10571 | """GetStrings(self) -> wxArrayString""" |
54f9ee45 | 10572 | return _core_.ItemContainer_GetStrings(*args, **kwargs) |
e811c8ce RD |
10573 | |
10574 | def SetString(*args, **kwargs): | |
15afbcd0 | 10575 | """ |
50f151d7 | 10576 | SetString(self, unsigned int n, String s) |
15afbcd0 RD |
10577 | |
10578 | Sets the label for the given item. | |
10579 | """ | |
54f9ee45 | 10580 | return _core_.ItemContainer_SetString(*args, **kwargs) |
e811c8ce RD |
10581 | |
10582 | def FindString(*args, **kwargs): | |
15afbcd0 | 10583 | """ |
a95a7133 | 10584 | FindString(self, String s) -> int |
15afbcd0 RD |
10585 | |
10586 | Finds an item whose label matches the given string. Returns the | |
41e2b43e RD |
10587 | zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not |
10588 | found. | |
15afbcd0 | 10589 | """ |
54f9ee45 | 10590 | return _core_.ItemContainer_FindString(*args, **kwargs) |
e811c8ce | 10591 | |
53aa7709 | 10592 | def SetSelection(*args, **kwargs): |
15afbcd0 | 10593 | """ |
53aa7709 | 10594 | SetSelection(self, int n) |
15afbcd0 RD |
10595 | |
10596 | Sets the item at index 'n' to be the selected item. | |
10597 | """ | |
53aa7709 | 10598 | return _core_.ItemContainer_SetSelection(*args, **kwargs) |
e811c8ce RD |
10599 | |
10600 | def GetSelection(*args, **kwargs): | |
15afbcd0 | 10601 | """ |
a95a7133 | 10602 | GetSelection(self) -> int |
15afbcd0 | 10603 | |
41e2b43e RD |
10604 | Returns the index of the selected item or ``wx.NOT_FOUND`` if no item |
10605 | is selected. | |
15afbcd0 | 10606 | """ |
54f9ee45 | 10607 | return _core_.ItemContainer_GetSelection(*args, **kwargs) |
e811c8ce | 10608 | |
53aa7709 RD |
10609 | def SetStringSelection(*args, **kwargs): |
10610 | """SetStringSelection(self, String s) -> bool""" | |
10611 | return _core_.ItemContainer_SetStringSelection(*args, **kwargs) | |
10612 | ||
e811c8ce | 10613 | def GetStringSelection(*args, **kwargs): |
15afbcd0 | 10614 | """ |
a95a7133 | 10615 | GetStringSelection(self) -> String |
15afbcd0 | 10616 | |
41e2b43e RD |
10617 | Returns the label of the selected item or an empty string if no item |
10618 | is selected. | |
15afbcd0 | 10619 | """ |
54f9ee45 | 10620 | return _core_.ItemContainer_GetStringSelection(*args, **kwargs) |
e811c8ce | 10621 | |
53aa7709 | 10622 | def Select(*args, **kwargs): |
15afbcd0 | 10623 | """ |
53aa7709 | 10624 | Select(self, int n) |
15afbcd0 | 10625 | |
53aa7709 RD |
10626 | This is the same as `SetSelection` and exists only because it is |
10627 | slightly more natural for controls which support multiple selection. | |
15afbcd0 | 10628 | """ |
53aa7709 | 10629 | return _core_.ItemContainer_Select(*args, **kwargs) |
e811c8ce | 10630 | |
2131d850 | 10631 | _core_.ItemContainer_swigregister(ItemContainer) |
d14a1e28 RD |
10632 | |
10633 | #--------------------------------------------------------------------------- | |
10634 | ||
10635 | class ControlWithItems(Control,ItemContainer): | |
15afbcd0 | 10636 | """ |
41e2b43e RD |
10637 | wx.ControlWithItems combines the ``wx.ItemContainer`` class with the |
10638 | wx.Control class, and is used for the base class of various controls | |
10639 | that have items. | |
15afbcd0 | 10640 | """ |
0085ce49 RD |
10641 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10642 | def __init__(self): raise AttributeError, "No constructor defined" | |
10643 | __repr__ = _swig_repr | |
2131d850 | 10644 | _core_.ControlWithItems_swigregister(ControlWithItems) |
d14a1e28 RD |
10645 | |
10646 | #--------------------------------------------------------------------------- | |
10647 | ||
10648 | class SizerItem(Object): | |
248ed943 RD |
10649 | """ |
10650 | The wx.SizerItem class is used to track the position, size and other | |
01f6b6d3 RD |
10651 | attributes of each item managed by a `wx.Sizer`. It is not usually |
10652 | necessary to use this class because the sizer elements can also be | |
10653 | identified by their positions or window or sizer references but | |
10654 | sometimes it may be more convenient to use wx.SizerItem directly. | |
10655 | Also, custom classes derived from `wx.PySizer` will probably need to | |
10656 | use the collection of wx.SizerItems held by wx.Sizer when calculating | |
10657 | layout. | |
248ed943 RD |
10658 | |
10659 | :see: `wx.Sizer`, `wx.GBSizerItem` | |
10660 | """ | |
0085ce49 RD |
10661 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
10662 | __repr__ = _swig_repr | |
10663 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
10664 | """ |
10665 | __init__(self) -> SizerItem | |
10666 | ||
10667 | Constructs an empty wx.SizerItem. Either a window, sizer or spacer | |
10668 | size will need to be set before this item can be used in a Sizer. | |
10669 | ||
10670 | You will probably never need to create a wx.SizerItem directly as they | |
10671 | are created automatically when the sizer's Add, Insert or Prepend | |
10672 | methods are called. | |
10673 | ||
10674 | :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer` | |
10675 | """ | |
0085ce49 RD |
10676 | _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs)) |
10677 | __swig_destroy__ = _core_.delete_SizerItem | |
10678 | __del__ = lambda self : None; | |
e811c8ce | 10679 | def DeleteWindows(*args, **kwargs): |
248ed943 RD |
10680 | """ |
10681 | DeleteWindows(self) | |
10682 | ||
10683 | Destroy the window or the windows in a subsizer, depending on the type | |
10684 | of item. | |
10685 | """ | |
54f9ee45 | 10686 | return _core_.SizerItem_DeleteWindows(*args, **kwargs) |
e811c8ce RD |
10687 | |
10688 | def DetachSizer(*args, **kwargs): | |
248ed943 RD |
10689 | """ |
10690 | DetachSizer(self) | |
10691 | ||
10692 | Enable deleting the SizerItem without destroying the contained sizer. | |
10693 | """ | |
54f9ee45 | 10694 | return _core_.SizerItem_DetachSizer(*args, **kwargs) |
e811c8ce RD |
10695 | |
10696 | def GetSize(*args, **kwargs): | |
248ed943 RD |
10697 | """ |
10698 | GetSize(self) -> Size | |
10699 | ||
10700 | Get the current size of the item, as set in the last Layout. | |
10701 | """ | |
54f9ee45 | 10702 | return _core_.SizerItem_GetSize(*args, **kwargs) |
e811c8ce RD |
10703 | |
10704 | def CalcMin(*args, **kwargs): | |
248ed943 RD |
10705 | """ |
10706 | CalcMin(self) -> Size | |
10707 | ||
10708 | Calculates the minimum desired size for the item, including any space | |
10709 | needed by borders. | |
10710 | """ | |
54f9ee45 | 10711 | return _core_.SizerItem_CalcMin(*args, **kwargs) |
e811c8ce RD |
10712 | |
10713 | def SetDimension(*args, **kwargs): | |
248ed943 RD |
10714 | """ |
10715 | SetDimension(self, Point pos, Size size) | |
10716 | ||
10717 | Set the position and size of the space allocated for this item by the | |
10718 | sizer, and adjust the position and size of the item (window or | |
10719 | subsizer) to be within that space taking alignment and borders into | |
10720 | account. | |
10721 | """ | |
54f9ee45 | 10722 | return _core_.SizerItem_SetDimension(*args, **kwargs) |
e811c8ce RD |
10723 | |
10724 | def GetMinSize(*args, **kwargs): | |
248ed943 RD |
10725 | """ |
10726 | GetMinSize(self) -> Size | |
10727 | ||
10728 | Get the minimum size needed for the item. | |
10729 | """ | |
54f9ee45 | 10730 | return _core_.SizerItem_GetMinSize(*args, **kwargs) |
e811c8ce | 10731 | |
dfbb5885 RD |
10732 | def GetMinSizeWithBorder(*args, **kwargs): |
10733 | """ | |
10734 | GetMinSizeWithBorder(self) -> Size | |
10735 | ||
10736 | Get the minimum size needed for the item with space for the borders | |
10737 | added, if needed. | |
10738 | """ | |
10739 | return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs) | |
10740 | ||
e811c8ce | 10741 | def SetInitSize(*args, **kwargs): |
a95a7133 | 10742 | """SetInitSize(self, int x, int y)""" |
54f9ee45 | 10743 | return _core_.SizerItem_SetInitSize(*args, **kwargs) |
e811c8ce RD |
10744 | |
10745 | def SetRatioWH(*args, **kwargs): | |
248ed943 RD |
10746 | """ |
10747 | SetRatioWH(self, int width, int height) | |
10748 | ||
10749 | Set the ratio item attribute. | |
10750 | """ | |
54f9ee45 | 10751 | return _core_.SizerItem_SetRatioWH(*args, **kwargs) |
e811c8ce RD |
10752 | |
10753 | def SetRatioSize(*args, **kwargs): | |
248ed943 RD |
10754 | """ |
10755 | SetRatioSize(self, Size size) | |
10756 | ||
10757 | Set the ratio item attribute. | |
10758 | """ | |
54f9ee45 | 10759 | return _core_.SizerItem_SetRatioSize(*args, **kwargs) |
e811c8ce RD |
10760 | |
10761 | def SetRatio(*args, **kwargs): | |
248ed943 RD |
10762 | """ |
10763 | SetRatio(self, float ratio) | |
10764 | ||
10765 | Set the ratio item attribute. | |
10766 | """ | |
54f9ee45 | 10767 | return _core_.SizerItem_SetRatio(*args, **kwargs) |
e811c8ce RD |
10768 | |
10769 | def GetRatio(*args, **kwargs): | |
248ed943 RD |
10770 | """ |
10771 | GetRatio(self) -> float | |
10772 | ||
10773 | Set the ratio item attribute. | |
10774 | """ | |
54f9ee45 | 10775 | return _core_.SizerItem_GetRatio(*args, **kwargs) |
e811c8ce | 10776 | |
d3b6e4ff RD |
10777 | def GetRect(*args, **kwargs): |
10778 | """ | |
10779 | GetRect(self) -> Rect | |
10780 | ||
10781 | Returns the rectangle that the sizer item should occupy | |
10782 | """ | |
10783 | return _core_.SizerItem_GetRect(*args, **kwargs) | |
10784 | ||
e811c8ce | 10785 | def IsWindow(*args, **kwargs): |
248ed943 RD |
10786 | """ |
10787 | IsWindow(self) -> bool | |
10788 | ||
10789 | Is this sizer item a window? | |
10790 | """ | |
54f9ee45 | 10791 | return _core_.SizerItem_IsWindow(*args, **kwargs) |
e811c8ce RD |
10792 | |
10793 | def IsSizer(*args, **kwargs): | |
248ed943 RD |
10794 | """ |
10795 | IsSizer(self) -> bool | |
10796 | ||
10797 | Is this sizer item a subsizer? | |
10798 | """ | |
54f9ee45 | 10799 | return _core_.SizerItem_IsSizer(*args, **kwargs) |
e811c8ce RD |
10800 | |
10801 | def IsSpacer(*args, **kwargs): | |
248ed943 RD |
10802 | """ |
10803 | IsSpacer(self) -> bool | |
10804 | ||
10805 | Is this sizer item a spacer? | |
10806 | """ | |
54f9ee45 | 10807 | return _core_.SizerItem_IsSpacer(*args, **kwargs) |
e811c8ce RD |
10808 | |
10809 | def SetProportion(*args, **kwargs): | |
248ed943 RD |
10810 | """ |
10811 | SetProportion(self, int proportion) | |
10812 | ||
10813 | Set the proportion value for this item. | |
10814 | """ | |
54f9ee45 | 10815 | return _core_.SizerItem_SetProportion(*args, **kwargs) |
e811c8ce RD |
10816 | |
10817 | def GetProportion(*args, **kwargs): | |
248ed943 RD |
10818 | """ |
10819 | GetProportion(self) -> int | |
10820 | ||
10821 | Get the proportion value for this item. | |
10822 | """ | |
54f9ee45 | 10823 | return _core_.SizerItem_GetProportion(*args, **kwargs) |
e811c8ce | 10824 | |
248ed943 RD |
10825 | SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.") |
10826 | GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.") | |
e811c8ce | 10827 | def SetFlag(*args, **kwargs): |
248ed943 RD |
10828 | """ |
10829 | SetFlag(self, int flag) | |
10830 | ||
10831 | Set the flag value for this item. | |
10832 | """ | |
54f9ee45 | 10833 | return _core_.SizerItem_SetFlag(*args, **kwargs) |
e811c8ce RD |
10834 | |
10835 | def GetFlag(*args, **kwargs): | |
248ed943 RD |
10836 | """ |
10837 | GetFlag(self) -> int | |
10838 | ||
10839 | Get the flag value for this item. | |
10840 | """ | |
54f9ee45 | 10841 | return _core_.SizerItem_GetFlag(*args, **kwargs) |
e811c8ce RD |
10842 | |
10843 | def SetBorder(*args, **kwargs): | |
248ed943 RD |
10844 | """ |
10845 | SetBorder(self, int border) | |
10846 | ||
10847 | Set the border value for this item. | |
10848 | """ | |
54f9ee45 | 10849 | return _core_.SizerItem_SetBorder(*args, **kwargs) |
e811c8ce RD |
10850 | |
10851 | def GetBorder(*args, **kwargs): | |
248ed943 RD |
10852 | """ |
10853 | GetBorder(self) -> int | |
10854 | ||
10855 | Get the border value for this item. | |
10856 | """ | |
54f9ee45 | 10857 | return _core_.SizerItem_GetBorder(*args, **kwargs) |
e811c8ce RD |
10858 | |
10859 | def GetWindow(*args, **kwargs): | |
248ed943 RD |
10860 | """ |
10861 | GetWindow(self) -> Window | |
10862 | ||
10863 | Get the window (if any) that is managed by this sizer item. | |
10864 | """ | |
54f9ee45 | 10865 | return _core_.SizerItem_GetWindow(*args, **kwargs) |
e811c8ce RD |
10866 | |
10867 | def SetWindow(*args, **kwargs): | |
248ed943 RD |
10868 | """ |
10869 | SetWindow(self, Window window) | |
10870 | ||
10871 | Set the window to be managed by this sizer item. | |
10872 | """ | |
54f9ee45 | 10873 | return _core_.SizerItem_SetWindow(*args, **kwargs) |
e811c8ce RD |
10874 | |
10875 | def GetSizer(*args, **kwargs): | |
248ed943 RD |
10876 | """ |
10877 | GetSizer(self) -> Sizer | |
10878 | ||
10879 | Get the subsizer (if any) that is managed by this sizer item. | |
10880 | """ | |
54f9ee45 | 10881 | return _core_.SizerItem_GetSizer(*args, **kwargs) |
e811c8ce RD |
10882 | |
10883 | def SetSizer(*args, **kwargs): | |
248ed943 RD |
10884 | """ |
10885 | SetSizer(self, Sizer sizer) | |
10886 | ||
10887 | Set the subsizer to be managed by this sizer item. | |
10888 | """ | |
54f9ee45 | 10889 | return _core_.SizerItem_SetSizer(*args, **kwargs) |
e811c8ce RD |
10890 | |
10891 | def GetSpacer(*args, **kwargs): | |
248ed943 RD |
10892 | """ |
10893 | GetSpacer(self) -> Size | |
10894 | ||
10895 | Get the size of the spacer managed by this sizer item. | |
10896 | """ | |
54f9ee45 | 10897 | return _core_.SizerItem_GetSpacer(*args, **kwargs) |
e811c8ce RD |
10898 | |
10899 | def SetSpacer(*args, **kwargs): | |
248ed943 RD |
10900 | """ |
10901 | SetSpacer(self, Size size) | |
10902 | ||
10903 | Set the size of the spacer to be managed by this sizer item. | |
10904 | """ | |
54f9ee45 | 10905 | return _core_.SizerItem_SetSpacer(*args, **kwargs) |
e811c8ce RD |
10906 | |
10907 | def Show(*args, **kwargs): | |
248ed943 RD |
10908 | """ |
10909 | Show(self, bool show) | |
10910 | ||
10911 | Set the show item attribute, which sizers use to determine if the item | |
10912 | is to be made part of the layout or not. If the item is tracking a | |
10913 | window then it is shown or hidden as needed. | |
10914 | """ | |
54f9ee45 | 10915 | return _core_.SizerItem_Show(*args, **kwargs) |
e811c8ce RD |
10916 | |
10917 | def IsShown(*args, **kwargs): | |
248ed943 RD |
10918 | """ |
10919 | IsShown(self) -> bool | |
10920 | ||
10921 | Is the item to be shown in the layout? | |
10922 | """ | |
54f9ee45 | 10923 | return _core_.SizerItem_IsShown(*args, **kwargs) |
e811c8ce RD |
10924 | |
10925 | def GetPosition(*args, **kwargs): | |
248ed943 RD |
10926 | """ |
10927 | GetPosition(self) -> Point | |
10928 | ||
10929 | Returns the current position of the item, as set in the last Layout. | |
10930 | """ | |
54f9ee45 | 10931 | return _core_.SizerItem_GetPosition(*args, **kwargs) |
e811c8ce RD |
10932 | |
10933 | def GetUserData(*args, **kwargs): | |
248ed943 RD |
10934 | """ |
10935 | GetUserData(self) -> PyObject | |
10936 | ||
10937 | Returns the userData associated with this sizer item, or None if there | |
10938 | isn't any. | |
10939 | """ | |
54f9ee45 | 10940 | return _core_.SizerItem_GetUserData(*args, **kwargs) |
e811c8ce | 10941 | |
091f5bed RD |
10942 | def SetUserData(*args, **kwargs): |
10943 | """ | |
10944 | SetUserData(self, PyObject userData) | |
10945 | ||
10946 | Associate a Python object with this sizer item. | |
10947 | """ | |
10948 | return _core_.SizerItem_SetUserData(*args, **kwargs) | |
10949 | ||
2131d850 | 10950 | _core_.SizerItem_swigregister(SizerItem) |
d14a1e28 | 10951 | |
248ed943 | 10952 | def SizerItemWindow(*args, **kwargs): |
0df68c9f | 10953 | """ |
248ed943 RD |
10954 | SizerItemWindow(Window window, int proportion, int flag, int border, |
10955 | PyObject userData=None) -> SizerItem | |
10956 | ||
10957 | Constructs a `wx.SizerItem` for tracking a window. | |
0df68c9f | 10958 | """ |
248ed943 | 10959 | val = _core_.new_SizerItemWindow(*args, **kwargs) |
d14a1e28 RD |
10960 | return val |
10961 | ||
248ed943 | 10962 | def SizerItemSpacer(*args, **kwargs): |
0df68c9f | 10963 | """ |
248ed943 RD |
10964 | SizerItemSpacer(int width, int height, int proportion, int flag, int border, |
10965 | PyObject userData=None) -> SizerItem | |
10966 | ||
10967 | Constructs a `wx.SizerItem` for tracking a spacer. | |
0df68c9f | 10968 | """ |
248ed943 | 10969 | val = _core_.new_SizerItemSpacer(*args, **kwargs) |
d14a1e28 RD |
10970 | return val |
10971 | ||
10972 | def SizerItemSizer(*args, **kwargs): | |
0df68c9f RD |
10973 | """ |
10974 | SizerItemSizer(Sizer sizer, int proportion, int flag, int border, | |
248ed943 RD |
10975 | PyObject userData=None) -> SizerItem |
10976 | ||
10977 | Constructs a `wx.SizerItem` for tracking a subsizer | |
0df68c9f | 10978 | """ |
54f9ee45 | 10979 | val = _core_.new_SizerItemSizer(*args, **kwargs) |
d14a1e28 RD |
10980 | return val |
10981 | ||
10982 | class Sizer(Object): | |
248ed943 RD |
10983 | """ |
10984 | wx.Sizer is the abstract base class used for laying out subwindows in | |
10985 | a window. You cannot use wx.Sizer directly; instead, you will have to | |
10986 | use one of the sizer classes derived from it such as `wx.BoxSizer`, | |
10987 | `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer` | |
10988 | and `wx.GridBagSizer`. | |
10989 | ||
10990 | The concept implemented by sizers in wxWidgets is closely related to | |
10991 | layout tools in other GUI toolkits, such as Java's AWT, the GTK | |
10992 | toolkit or the Qt toolkit. It is based upon the idea of the individual | |
10993 | subwindows reporting their minimal required size and their ability to | |
10994 | get stretched if the size of the parent window has changed. This will | |
10995 | most often mean that the programmer does not set the original size of | |
10996 | a dialog in the beginning, rather the dialog will assigned a sizer and | |
10997 | this sizer will be queried about the recommended size. The sizer in | |
10998 | turn will query its children, which can be normal windows or contorls, | |
10999 | empty space or other sizers, so that a hierarchy of sizers can be | |
11000 | constructed. Note that wxSizer does not derive from wxWindow and thus | |
11001 | do not interfere with tab ordering and requires very little resources | |
11002 | compared to a real window on screen. | |
11003 | ||
11004 | What makes sizers so well fitted for use in wxWidgets is the fact that | |
11005 | every control reports its own minimal size and the algorithm can | |
11006 | handle differences in font sizes or different window (dialog item) | |
11007 | sizes on different platforms without problems. If for example the | |
11008 | standard font as well as the overall design of Mac widgets requires | |
11009 | more space than on Windows, then the initial size of a dialog using a | |
11010 | sizer will automatically be bigger on Mac than on Windows. | |
11011 | """ | |
0085ce49 RD |
11012 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11013 | def __init__(self): raise AttributeError, "No constructor defined" | |
11014 | __repr__ = _swig_repr | |
11015 | __swig_destroy__ = _core_.delete_Sizer | |
11016 | __del__ = lambda self : None; | |
e811c8ce | 11017 | def _setOORInfo(*args, **kwargs): |
a95a7133 | 11018 | """_setOORInfo(self, PyObject _self)""" |
54f9ee45 | 11019 | return _core_.Sizer__setOORInfo(*args, **kwargs) |
e811c8ce RD |
11020 | |
11021 | def Add(*args, **kwargs): | |
0df68c9f | 11022 | """ |
248ed943 | 11023 | Add(self, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11024 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11025 | |
11026 | Appends a child item to the sizer. | |
0df68c9f | 11027 | """ |
54f9ee45 | 11028 | return _core_.Sizer_Add(*args, **kwargs) |
e811c8ce RD |
11029 | |
11030 | def Insert(*args, **kwargs): | |
0df68c9f | 11031 | """ |
248ed943 | 11032 | Insert(self, int before, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11033 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11034 | |
11035 | Inserts a new item into the list of items managed by this sizer before | |
11036 | the item at index *before*. See `Add` for a description of the parameters. | |
0df68c9f | 11037 | """ |
54f9ee45 | 11038 | return _core_.Sizer_Insert(*args, **kwargs) |
e811c8ce RD |
11039 | |
11040 | def Prepend(*args, **kwargs): | |
0df68c9f | 11041 | """ |
248ed943 | 11042 | Prepend(self, item, int proportion=0, int flag=0, int border=0, |
d3b6e4ff | 11043 | PyObject userData=None) -> wx.SizerItem |
248ed943 RD |
11044 | |
11045 | Adds a new item to the begining of the list of sizer items managed by | |
11046 | this sizer. See `Add` for a description of the parameters. | |
0df68c9f | 11047 | """ |
54f9ee45 | 11048 | return _core_.Sizer_Prepend(*args, **kwargs) |
e811c8ce RD |
11049 | |
11050 | def Remove(*args, **kwargs): | |
248ed943 RD |
11051 | """ |
11052 | Remove(self, item) -> bool | |
11053 | ||
11054 | Removes an item from the sizer and destroys it. This method does not | |
11055 | cause any layout or resizing to take place, call `Layout` to update | |
11056 | the layout on screen after removing a child from the sizer. The | |
11057 | *item* parameter can be either a window, a sizer, or the zero-based | |
11058 | index of an item to remove. Returns True if the child item was found | |
11059 | and removed. | |
11060 | """ | |
54f9ee45 | 11061 | return _core_.Sizer_Remove(*args, **kwargs) |
e811c8ce | 11062 | |
1c0f361b | 11063 | def Detach(*args, **kwargs): |
248ed943 RD |
11064 | """ |
11065 | Detach(self, item) -> bool | |
11066 | ||
11067 | Detaches an item from the sizer without destroying it. This method | |
11068 | does not cause any layout or resizing to take place, call `Layout` to | |
11069 | do so. The *item* parameter can be either a window, a sizer, or the | |
11070 | zero-based index of the item to be detached. Returns True if the child item | |
11071 | was found and detached. | |
11072 | """ | |
1c0f361b RD |
11073 | return _core_.Sizer_Detach(*args, **kwargs) |
11074 | ||
d3b6e4ff RD |
11075 | def GetItem(*args, **kwargs): |
11076 | """ | |
11077 | GetItem(self, item) -> wx.SizerItem | |
11078 | ||
11079 | Returns the `wx.SizerItem` which holds the *item* given. The *item* | |
11080 | parameter can be either a window, a sizer, or the zero-based index of | |
4d170c95 | 11081 | the item to be found. |
d3b6e4ff RD |
11082 | """ |
11083 | return _core_.Sizer_GetItem(*args, **kwargs) | |
11084 | ||
e811c8ce | 11085 | def _SetItemMinSize(*args, **kwargs): |
a95a7133 | 11086 | """_SetItemMinSize(self, PyObject item, Size size)""" |
54f9ee45 | 11087 | return _core_.Sizer__SetItemMinSize(*args, **kwargs) |
e811c8ce | 11088 | |
248ed943 RD |
11089 | def SetItemMinSize(self, item, *args): |
11090 | """ | |
11091 | SetItemMinSize(self, item, Size size) | |
11092 | ||
11093 | Sets the minimum size that will be allocated for an item in the sizer. | |
11094 | The *item* parameter can be either a window, a sizer, or the | |
11095 | zero-based index of the item. If a window or sizer is given then it | |
11096 | will be searched for recursivly in subsizers if neccessary. | |
11097 | """ | |
11098 | if len(args) == 2: | |
11099 | # for backward compatibility accept separate width,height args too | |
11100 | return self._SetItemMinSize(item, args) | |
11101 | else: | |
11102 | return self._SetItemMinSize(item, args[0]) | |
11103 | ||
e811c8ce | 11104 | def AddItem(*args, **kwargs): |
248ed943 RD |
11105 | """ |
11106 | AddItem(self, SizerItem item) | |
11107 | ||
11108 | Adds a `wx.SizerItem` to the sizer. | |
11109 | """ | |
54f9ee45 | 11110 | return _core_.Sizer_AddItem(*args, **kwargs) |
e811c8ce RD |
11111 | |
11112 | def InsertItem(*args, **kwargs): | |
248ed943 RD |
11113 | """ |
11114 | InsertItem(self, int index, SizerItem item) | |
11115 | ||
11116 | Inserts a `wx.SizerItem` to the sizer at the position given by *index*. | |
11117 | """ | |
54f9ee45 | 11118 | return _core_.Sizer_InsertItem(*args, **kwargs) |
e811c8ce RD |
11119 | |
11120 | def PrependItem(*args, **kwargs): | |
248ed943 RD |
11121 | """ |
11122 | PrependItem(self, SizerItem item) | |
11123 | ||
11124 | Prepends a `wx.SizerItem` to the sizer. | |
11125 | """ | |
54f9ee45 | 11126 | return _core_.Sizer_PrependItem(*args, **kwargs) |
e811c8ce | 11127 | |
248ed943 | 11128 | def AddMany(self, items): |
66c033b4 RD |
11129 | """ |
11130 | AddMany is a convenience method for adding several items | |
11131 | to a sizer at one time. Simply pass it a list of tuples, | |
11132 | where each tuple consists of the parameters that you | |
11133 | would normally pass to the `Add` method. | |
11134 | """ | |
248ed943 RD |
11135 | for item in items: |
11136 | if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)): | |
11137 | item = (item, ) | |
11138 | self.Add(*item) | |
d14a1e28 | 11139 | |
74e96f3d | 11140 | # for backwards compatibility only, please do not use in new code |
b9d6a5f3 RD |
11141 | def AddWindow(self, *args, **kw): |
11142 | """Compatibility alias for `Add`.""" | |
11143 | return self.Add(*args, **kw) | |
11144 | def AddSizer(self, *args, **kw): | |
11145 | """Compatibility alias for `Add`.""" | |
11146 | return self.Add(*args, **kw) | |
11147 | def AddSpacer(self, *args, **kw): | |
11148 | """Compatibility alias for `Add`.""" | |
11149 | return self.Add(*args, **kw) | |
11150 | ||
11151 | def PrependWindow(self, *args, **kw): | |
11152 | """Compatibility alias for `Prepend`.""" | |
11153 | return self.Prepend(*args, **kw) | |
11154 | def PrependSizer(self, *args, **kw): | |
11155 | """Compatibility alias for `Prepend`.""" | |
11156 | return self.Prepend(*args, **kw) | |
11157 | def PrependSpacer(self, *args, **kw): | |
11158 | """Compatibility alias for `Prepend`.""" | |
11159 | return self.Prepend(*args, **kw) | |
11160 | ||
11161 | def InsertWindow(self, *args, **kw): | |
11162 | """Compatibility alias for `Insert`.""" | |
11163 | return self.Insert(*args, **kw) | |
11164 | def InsertSizer(self, *args, **kw): | |
11165 | """Compatibility alias for `Insert`.""" | |
11166 | return self.Insert(*args, **kw) | |
11167 | def InsertSpacer(self, *args, **kw): | |
11168 | """Compatibility alias for `Insert`.""" | |
11169 | return self.Insert(*args, **kw) | |
11170 | ||
11171 | def RemoveWindow(self, *args, **kw): | |
11172 | """Compatibility alias for `Remove`.""" | |
11173 | return self.Remove(*args, **kw) | |
11174 | def RemoveSizer(self, *args, **kw): | |
11175 | """Compatibility alias for `Remove`.""" | |
11176 | return self.Remove(*args, **kw) | |
11177 | def RemovePos(self, *args, **kw): | |
11178 | """Compatibility alias for `Remove`.""" | |
11179 | return self.Remove(*args, **kw) | |
d14a1e28 RD |
11180 | |
11181 | ||
e811c8ce | 11182 | def SetDimension(*args, **kwargs): |
248ed943 RD |
11183 | """ |
11184 | SetDimension(self, int x, int y, int width, int height) | |
11185 | ||
11186 | Call this to force the sizer to take the given dimension and thus | |
11187 | force the items owned by the sizer to resize themselves according to | |
11188 | the rules defined by the parameter in the `Add`, `Insert` or `Prepend` | |
11189 | methods. | |
11190 | """ | |
54f9ee45 | 11191 | return _core_.Sizer_SetDimension(*args, **kwargs) |
e811c8ce RD |
11192 | |
11193 | def SetMinSize(*args, **kwargs): | |
248ed943 RD |
11194 | """ |
11195 | SetMinSize(self, Size size) | |
11196 | ||
11197 | Call this to give the sizer a minimal size. Normally, the sizer will | |
11198 | calculate its minimal size based purely on how much space its children | |
11199 | need. After calling this method `GetMinSize` will return either the | |
11200 | minimal size as requested by its children or the minimal size set | |
11201 | here, depending on which is bigger. | |
11202 | """ | |
54f9ee45 | 11203 | return _core_.Sizer_SetMinSize(*args, **kwargs) |
e811c8ce RD |
11204 | |
11205 | def GetSize(*args, **kwargs): | |
248ed943 RD |
11206 | """ |
11207 | GetSize(self) -> Size | |
11208 | ||
11209 | Returns the current size of the space managed by the sizer. | |
11210 | """ | |
54f9ee45 | 11211 | return _core_.Sizer_GetSize(*args, **kwargs) |
e811c8ce RD |
11212 | |
11213 | def GetPosition(*args, **kwargs): | |
248ed943 RD |
11214 | """ |
11215 | GetPosition(self) -> Point | |
11216 | ||
11217 | Returns the current position of the sizer's managed space. | |
11218 | """ | |
54f9ee45 | 11219 | return _core_.Sizer_GetPosition(*args, **kwargs) |
e811c8ce RD |
11220 | |
11221 | def GetMinSize(*args, **kwargs): | |
248ed943 RD |
11222 | """ |
11223 | GetMinSize(self) -> Size | |
11224 | ||
11225 | Returns the minimal size of the sizer. This is either the combined | |
11226 | minimal size of all the children and their borders or the minimal size | |
11227 | set by SetMinSize, depending on which is bigger. | |
11228 | """ | |
54f9ee45 | 11229 | return _core_.Sizer_GetMinSize(*args, **kwargs) |
e811c8ce | 11230 | |
d14a1e28 | 11231 | def GetSizeTuple(self): |
1c0f361b | 11232 | return self.GetSize().Get() |
d14a1e28 | 11233 | def GetPositionTuple(self): |
1c0f361b | 11234 | return self.GetPosition().Get() |
d14a1e28 | 11235 | def GetMinSizeTuple(self): |
1c0f361b | 11236 | return self.GetMinSize().Get() |
d14a1e28 | 11237 | |
e811c8ce | 11238 | def RecalcSizes(*args, **kwargs): |
248ed943 RD |
11239 | """ |
11240 | RecalcSizes(self) | |
11241 | ||
11242 | Using the sizes calculated by `CalcMin` reposition and resize all the | |
11243 | items managed by this sizer. You should not need to call this directly as | |
11244 | it is called by `Layout`. | |
11245 | """ | |
54f9ee45 | 11246 | return _core_.Sizer_RecalcSizes(*args, **kwargs) |
e811c8ce RD |
11247 | |
11248 | def CalcMin(*args, **kwargs): | |
248ed943 RD |
11249 | """ |
11250 | CalcMin(self) -> Size | |
11251 | ||
11252 | This method is where the sizer will do the actual calculation of its | |
11253 | children's minimal sizes. You should not need to call this directly as | |
11254 | it is called by `Layout`. | |
11255 | """ | |
54f9ee45 | 11256 | return _core_.Sizer_CalcMin(*args, **kwargs) |
e811c8ce RD |
11257 | |
11258 | def Layout(*args, **kwargs): | |
248ed943 RD |
11259 | """ |
11260 | Layout(self) | |
11261 | ||
11262 | This method will force the recalculation and layout of the items | |
11263 | controlled by the sizer using the current space allocated to the | |
11264 | sizer. Normally this is called automatically from the owning window's | |
11265 | EVT_SIZE handler, but it is also useful to call it from user code when | |
11266 | one of the items in a sizer change size, or items are added or | |
11267 | removed. | |
11268 | """ | |
54f9ee45 | 11269 | return _core_.Sizer_Layout(*args, **kwargs) |
e811c8ce RD |
11270 | |
11271 | def Fit(*args, **kwargs): | |
248ed943 RD |
11272 | """ |
11273 | Fit(self, Window window) -> Size | |
11274 | ||
11275 | Tell the sizer to resize the *window* to match the sizer's minimal | |
11276 | size. This is commonly done in the constructor of the window itself in | |
11277 | order to set its initial size to match the needs of the children as | |
11278 | determined by the sizer. Returns the new size. | |
11279 | ||
11280 | For a top level window this is the total window size, not the client size. | |
11281 | """ | |
54f9ee45 | 11282 | return _core_.Sizer_Fit(*args, **kwargs) |
e811c8ce RD |
11283 | |
11284 | def FitInside(*args, **kwargs): | |
248ed943 RD |
11285 | """ |
11286 | FitInside(self, Window window) | |
11287 | ||
11288 | Tell the sizer to resize the *virtual size* of the *window* to match the | |
11289 | sizer's minimal size. This will not alter the on screen size of the | |
11290 | window, but may cause the addition/removal/alteration of scrollbars | |
11291 | required to view the virtual area in windows which manage it. | |
11292 | ||
11293 | :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints` | |
11294 | ||
11295 | """ | |
54f9ee45 | 11296 | return _core_.Sizer_FitInside(*args, **kwargs) |
e811c8ce RD |
11297 | |
11298 | def SetSizeHints(*args, **kwargs): | |
248ed943 RD |
11299 | """ |
11300 | SetSizeHints(self, Window window) | |
11301 | ||
11302 | Tell the sizer to set (and `Fit`) the minimal size of the *window* to | |
11303 | match the sizer's minimal size. This is commonly done in the | |
11304 | constructor of the window itself if the window is resizable (as are | |
11305 | many dialogs under Unix and frames on probably all platforms) in order | |
11306 | to prevent the window from being sized smaller than the minimal size | |
11307 | required by the sizer. | |
11308 | """ | |
54f9ee45 | 11309 | return _core_.Sizer_SetSizeHints(*args, **kwargs) |
e811c8ce RD |
11310 | |
11311 | def SetVirtualSizeHints(*args, **kwargs): | |
248ed943 RD |
11312 | """ |
11313 | SetVirtualSizeHints(self, Window window) | |
11314 | ||
11315 | Tell the sizer to set the minimal size of the window virtual area to | |
11316 | match the sizer's minimal size. For windows with managed scrollbars | |
11317 | this will set them appropriately. | |
11318 | ||
11319 | :see: `wx.ScrolledWindow.SetScrollbars` | |
11320 | ||
11321 | """ | |
54f9ee45 | 11322 | return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs) |
e811c8ce RD |
11323 | |
11324 | def Clear(*args, **kwargs): | |
248ed943 RD |
11325 | """ |
11326 | Clear(self, bool deleteWindows=False) | |
11327 | ||
11328 | Clear all items from the sizer, optionally destroying the window items | |
11329 | as well. | |
11330 | """ | |
54f9ee45 | 11331 | return _core_.Sizer_Clear(*args, **kwargs) |
e811c8ce RD |
11332 | |
11333 | def DeleteWindows(*args, **kwargs): | |
248ed943 RD |
11334 | """ |
11335 | DeleteWindows(self) | |
11336 | ||
11337 | Destroy all windows managed by the sizer. | |
11338 | """ | |
54f9ee45 | 11339 | return _core_.Sizer_DeleteWindows(*args, **kwargs) |
e811c8ce RD |
11340 | |
11341 | def GetChildren(*args, **kwargs): | |
248ed943 | 11342 | """ |
51b83b37 | 11343 | GetChildren(self) -> list |
248ed943 RD |
11344 | |
11345 | Returns a list of all the `wx.SizerItem` objects managed by the sizer. | |
11346 | """ | |
54f9ee45 | 11347 | return _core_.Sizer_GetChildren(*args, **kwargs) |
e811c8ce RD |
11348 | |
11349 | def Show(*args, **kwargs): | |
248ed943 | 11350 | """ |
ae8162c8 | 11351 | Show(self, item, bool show=True, bool recursive=false) -> bool |
e811c8ce | 11352 | |
248ed943 RD |
11353 | Shows or hides an item managed by the sizer. To make a sizer item |
11354 | disappear or reappear, use Show followed by `Layout`. The *item* | |
11355 | parameter can be either a window, a sizer, or the zero-based index of | |
7e63a440 RD |
11356 | the item. Use the recursive parameter to show or hide an item in a |
11357 | subsizer. Returns True if the item was found. | |
248ed943 RD |
11358 | """ |
11359 | return _core_.Sizer_Show(*args, **kwargs) | |
e811c8ce RD |
11360 | |
11361 | def IsShown(*args, **kwargs): | |
248ed943 RD |
11362 | """ |
11363 | IsShown(self, item) | |
11364 | ||
b1fcee84 | 11365 | Determines if the item is currently shown. To make a sizer |
248ed943 RD |
11366 | item disappear or reappear, use Show followed by `Layout`. The *item* |
11367 | parameter can be either a window, a sizer, or the zero-based index of | |
11368 | the item. | |
11369 | """ | |
54f9ee45 | 11370 | return _core_.Sizer_IsShown(*args, **kwargs) |
e811c8ce | 11371 | |
7e63a440 | 11372 | def Hide(self, item, recursive=False): |
248ed943 | 11373 | """ |
27fb7603 | 11374 | A convenience method for `Show` (item, False, recursive). |
248ed943 | 11375 | """ |
06759a38 | 11376 | return self.Show(item, False, recursive) |
248ed943 | 11377 | |
e811c8ce | 11378 | def ShowItems(*args, **kwargs): |
248ed943 RD |
11379 | """ |
11380 | ShowItems(self, bool show) | |
11381 | ||
84f85550 | 11382 | Recursively call `wx.SizerItem.Show` on all sizer items. |
248ed943 | 11383 | """ |
54f9ee45 | 11384 | return _core_.Sizer_ShowItems(*args, **kwargs) |
e811c8ce | 11385 | |
2131d850 | 11386 | _core_.Sizer_swigregister(Sizer) |
d14a1e28 RD |
11387 | |
11388 | class PySizer(Sizer): | |
248ed943 RD |
11389 | """ |
11390 | wx.PySizer is a special version of `wx.Sizer` that has been | |
11391 | instrumented to allow the C++ virtual methods to be overloaded in | |
11392 | Python derived classes. You would derive from this class if you are | |
11393 | wanting to implement a custom sizer in Python code. Simply implement | |
11394 | `CalcMin` and `RecalcSizes` in the derived class and you're all set. | |
11395 | For example:: | |
11396 | ||
11397 | class MySizer(wx.PySizer): | |
11398 | def __init__(self): | |
11399 | wx.PySizer.__init__(self) | |
11400 | ||
11401 | def CalcMin(self): | |
11402 | for item in self.GetChildren(): | |
11403 | # calculate the total minimum width and height needed | |
11404 | # by all items in the sizer according to this sizer's | |
11405 | # layout algorithm. | |
11406 | ... | |
11407 | return wx.Size(width, height) | |
11408 | ||
11409 | def RecalcSizes(self): | |
11410 | # find the space allotted to this sizer | |
11411 | pos = self.GetPosition() | |
11412 | size = self.GetSize() | |
11413 | for item in self.GetChildren(): | |
11414 | # Recalculate (if necessary) the position and size of | |
11415 | # each item and then call item.SetDimension to do the | |
11416 | # actual positioning and sizing of the items within the | |
11417 | # space alloted to this sizer. | |
11418 | ... | |
11419 | item.SetDimension(itemPos, itemSize) | |
11420 | ||
11421 | ||
11422 | When `Layout` is called it first calls `CalcMin` followed by | |
11423 | `RecalcSizes` so you can optimize a bit by saving the results of | |
e505d15e | 11424 | `CalcMin` and reusing them in `RecalcSizes`. |
248ed943 RD |
11425 | |
11426 | :see: `wx.SizerItem`, `wx.Sizer.GetChildren` | |
11427 | ||
11428 | ||
11429 | """ | |
0085ce49 RD |
11430 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11431 | __repr__ = _swig_repr | |
11432 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11433 | """ |
11434 | __init__(self) -> PySizer | |
11435 | ||
11436 | Creates a wx.PySizer. Must be called from the __init__ in the derived | |
11437 | class. | |
11438 | """ | |
0085ce49 | 11439 | _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs)) |
d14a1e28 | 11440 | self._setCallbackInfo(self, PySizer);self._setOORInfo(self) |
e811c8ce RD |
11441 | |
11442 | def _setCallbackInfo(*args, **kwargs): | |
a95a7133 | 11443 | """_setCallbackInfo(self, PyObject self, PyObject _class)""" |
54f9ee45 | 11444 | return _core_.PySizer__setCallbackInfo(*args, **kwargs) |
e811c8ce | 11445 | |
2131d850 | 11446 | _core_.PySizer_swigregister(PySizer) |
d14a1e28 RD |
11447 | |
11448 | #--------------------------------------------------------------------------- | |
11449 | ||
11450 | class BoxSizer(Sizer): | |
248ed943 RD |
11451 | """ |
11452 | The basic idea behind a box sizer is that windows will most often be | |
11453 | laid out in rather simple basic geometry, typically in a row or a | |
11454 | column or nested hierarchies of either. A wx.BoxSizer will lay out | |
11455 | its items in a simple row or column, depending on the orientation | |
11456 | parameter passed to the constructor. | |
11457 | """ | |
0085ce49 RD |
11458 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11459 | __repr__ = _swig_repr | |
11460 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11461 | """ |
11462 | __init__(self, int orient=HORIZONTAL) -> BoxSizer | |
11463 | ||
11464 | Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL`` | |
11465 | or ``wx.HORIZONTAL`` for creating either a column sizer or a row | |
11466 | sizer. | |
11467 | """ | |
0085ce49 | 11468 | _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs)) |
d14a1e28 | 11469 | self._setOORInfo(self) |
e811c8ce RD |
11470 | |
11471 | def GetOrientation(*args, **kwargs): | |
248ed943 RD |
11472 | """ |
11473 | GetOrientation(self) -> int | |
11474 | ||
11475 | Returns the current orientation of the sizer. | |
11476 | """ | |
54f9ee45 | 11477 | return _core_.BoxSizer_GetOrientation(*args, **kwargs) |
e811c8ce RD |
11478 | |
11479 | def SetOrientation(*args, **kwargs): | |
248ed943 RD |
11480 | """ |
11481 | SetOrientation(self, int orient) | |
e811c8ce | 11482 | |
248ed943 RD |
11483 | Resets the orientation of the sizer. |
11484 | """ | |
11485 | return _core_.BoxSizer_SetOrientation(*args, **kwargs) | |
e811c8ce | 11486 | |
2131d850 | 11487 | _core_.BoxSizer_swigregister(BoxSizer) |
d14a1e28 RD |
11488 | |
11489 | #--------------------------------------------------------------------------- | |
11490 | ||
11491 | class StaticBoxSizer(BoxSizer): | |
248ed943 RD |
11492 | """ |
11493 | wx.StaticBoxSizer derives from and functions identically to the | |
11494 | `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer | |
11495 | manages. Note that this static box must be created separately and | |
11496 | passed to the sizer constructor. | |
11497 | """ | |
0085ce49 RD |
11498 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11499 | __repr__ = _swig_repr | |
11500 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11501 | """ |
11502 | __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer | |
11503 | ||
11504 | Constructor. It takes an associated static box and the orientation | |
11505 | *orient* as parameters - orient can be either of ``wx.VERTICAL`` or | |
11506 | ``wx.HORIZONTAL``. | |
11507 | """ | |
0085ce49 | 11508 | _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs)) |
d14a1e28 | 11509 | self._setOORInfo(self) |
e811c8ce RD |
11510 | |
11511 | def GetStaticBox(*args, **kwargs): | |
248ed943 RD |
11512 | """ |
11513 | GetStaticBox(self) -> StaticBox | |
e811c8ce | 11514 | |
248ed943 RD |
11515 | Returns the static box associated with this sizer. |
11516 | """ | |
11517 | return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs) | |
e811c8ce | 11518 | |
2131d850 | 11519 | _core_.StaticBoxSizer_swigregister(StaticBoxSizer) |
d14a1e28 RD |
11520 | |
11521 | #--------------------------------------------------------------------------- | |
11522 | ||
11523 | class GridSizer(Sizer): | |
248ed943 RD |
11524 | """ |
11525 | A grid sizer is a sizer which lays out its children in a | |
11526 | two-dimensional table with all cells having the same size. In other | |
11527 | words, the width of each cell within the grid is the width of the | |
11528 | widest item added to the sizer and the height of each grid cell is the | |
11529 | height of the tallest item. An optional vertical and/or horizontal | |
11530 | gap between items can also be specified (in pixels.) | |
11531 | ||
11532 | Items are placed in the cells of the grid in the order they are added, | |
11533 | in row-major order. In other words, the first row is filled first, | |
11534 | then the second, and so on until all items have been added. (If | |
11535 | neccessary, additional rows will be added as items are added.) If you | |
11536 | need to have greater control over the cells that items are placed in | |
11537 | then use the `wx.GridBagSizer`. | |
11538 | ||
11539 | """ | |
0085ce49 RD |
11540 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11541 | __repr__ = _swig_repr | |
11542 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11543 | """ |
11544 | __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer | |
11545 | ||
11546 | Constructor for a wx.GridSizer. *rows* and *cols* determine the number | |
11547 | of columns and rows in the sizer - if either of the parameters is | |
11548 | zero, it will be calculated to from the total number of children in | |
11549 | the sizer, thus making the sizer grow dynamically. *vgap* and *hgap* | |
11550 | define extra space between all children. | |
11551 | """ | |
0085ce49 | 11552 | _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs)) |
d14a1e28 | 11553 | self._setOORInfo(self) |
e811c8ce | 11554 | |
e811c8ce | 11555 | def SetCols(*args, **kwargs): |
248ed943 RD |
11556 | """ |
11557 | SetCols(self, int cols) | |
11558 | ||
11559 | Sets the number of columns in the sizer. | |
11560 | """ | |
54f9ee45 | 11561 | return _core_.GridSizer_SetCols(*args, **kwargs) |
e811c8ce RD |
11562 | |
11563 | def SetRows(*args, **kwargs): | |
248ed943 RD |
11564 | """ |
11565 | SetRows(self, int rows) | |
11566 | ||
11567 | Sets the number of rows in the sizer. | |
11568 | """ | |
54f9ee45 | 11569 | return _core_.GridSizer_SetRows(*args, **kwargs) |
e811c8ce RD |
11570 | |
11571 | def SetVGap(*args, **kwargs): | |
248ed943 RD |
11572 | """ |
11573 | SetVGap(self, int gap) | |
11574 | ||
11575 | Sets the vertical gap (in pixels) between the cells in the sizer. | |
11576 | """ | |
54f9ee45 | 11577 | return _core_.GridSizer_SetVGap(*args, **kwargs) |
e811c8ce RD |
11578 | |
11579 | def SetHGap(*args, **kwargs): | |
248ed943 RD |
11580 | """ |
11581 | SetHGap(self, int gap) | |
11582 | ||
11583 | Sets the horizontal gap (in pixels) between cells in the sizer | |
11584 | """ | |
54f9ee45 | 11585 | return _core_.GridSizer_SetHGap(*args, **kwargs) |
e811c8ce RD |
11586 | |
11587 | def GetCols(*args, **kwargs): | |
248ed943 RD |
11588 | """ |
11589 | GetCols(self) -> int | |
11590 | ||
11591 | Returns the number of columns in the sizer. | |
11592 | """ | |
54f9ee45 | 11593 | return _core_.GridSizer_GetCols(*args, **kwargs) |
e811c8ce RD |
11594 | |
11595 | def GetRows(*args, **kwargs): | |
248ed943 RD |
11596 | """ |
11597 | GetRows(self) -> int | |
11598 | ||
11599 | Returns the number of rows in the sizer. | |
11600 | """ | |
54f9ee45 | 11601 | return _core_.GridSizer_GetRows(*args, **kwargs) |
e811c8ce RD |
11602 | |
11603 | def GetVGap(*args, **kwargs): | |
248ed943 RD |
11604 | """ |
11605 | GetVGap(self) -> int | |
11606 | ||
11607 | Returns the vertical gap (in pixels) between the cells in the sizer. | |
11608 | """ | |
54f9ee45 | 11609 | return _core_.GridSizer_GetVGap(*args, **kwargs) |
e811c8ce RD |
11610 | |
11611 | def GetHGap(*args, **kwargs): | |
248ed943 RD |
11612 | """ |
11613 | GetHGap(self) -> int | |
11614 | ||
11615 | Returns the horizontal gap (in pixels) between cells in the sizer. | |
11616 | """ | |
54f9ee45 | 11617 | return _core_.GridSizer_GetHGap(*args, **kwargs) |
e811c8ce | 11618 | |
0085ce49 RD |
11619 | def CalcRowsCols(self): |
11620 | """ | |
11621 | CalcRowsCols() -> (rows, cols) | |
11622 | ||
11623 | Calculates how many rows and columns will be in the sizer based | |
11624 | on the current number of items and also the rows, cols specified | |
11625 | in the constructor. | |
11626 | """ | |
11627 | nitems = len(self.GetChildren()) | |
11628 | rows = self.GetRows() | |
11629 | cols = self.GetCols() | |
11630 | assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed" | |
11631 | if cols != 0: | |
11632 | rows = (nitems + cols - 1) / cols | |
11633 | elif rows != 0: | |
11634 | cols = (nitems + rows - 1) / rows | |
11635 | return (rows, cols) | |
d14a1e28 | 11636 | |
2131d850 | 11637 | _core_.GridSizer_swigregister(GridSizer) |
d14a1e28 RD |
11638 | |
11639 | #--------------------------------------------------------------------------- | |
11640 | ||
54f9ee45 RD |
11641 | FLEX_GROWMODE_NONE = _core_.FLEX_GROWMODE_NONE |
11642 | FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED | |
11643 | FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL | |
d14a1e28 | 11644 | class FlexGridSizer(GridSizer): |
248ed943 RD |
11645 | """ |
11646 | A flex grid sizer is a sizer which lays out its children in a | |
11647 | two-dimensional table with all table cells in one row having the same | |
11648 | height and all cells in one column having the same width, but all | |
11649 | rows or all columns are not necessarily the same height or width as in | |
11650 | the `wx.GridSizer`. | |
11651 | ||
11652 | wx.FlexGridSizer can also size items equally in one direction but | |
11653 | unequally ("flexibly") in the other. If the sizer is only flexible | |
11654 | in one direction (this can be changed using `SetFlexibleDirection`), it | |
11655 | needs to be decided how the sizer should grow in the other ("non | |
11656 | flexible") direction in order to fill the available space. The | |
11657 | `SetNonFlexibleGrowMode` method serves this purpose. | |
11658 | ||
11659 | ||
11660 | """ | |
0085ce49 RD |
11661 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11662 | __repr__ = _swig_repr | |
11663 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11664 | """ |
11665 | __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer | |
11666 | ||
11667 | Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the | |
11668 | number of columns and rows in the sizer - if either of the parameters | |
11669 | is zero, it will be calculated to from the total number of children in | |
11670 | the sizer, thus making the sizer grow dynamically. *vgap* and *hgap* | |
11671 | define extra space between all children. | |
11672 | """ | |
0085ce49 | 11673 | _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs)) |
d14a1e28 | 11674 | self._setOORInfo(self) |
e811c8ce | 11675 | |
248ed943 RD |
11676 | def AddGrowableRow(*args, **kwargs): |
11677 | """ | |
11678 | AddGrowableRow(self, size_t idx, int proportion=0) | |
e811c8ce | 11679 | |
248ed943 RD |
11680 | Specifies that row *idx* (starting from zero) should be grown if there |
11681 | is extra space available to the sizer. | |
e811c8ce | 11682 | |
248ed943 RD |
11683 | The *proportion* parameter has the same meaning as the stretch factor |
11684 | for the box sizers except that if all proportions are 0, then all | |
11685 | columns are resized equally (instead of not being resized at all). | |
11686 | """ | |
54f9ee45 | 11687 | return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs) |
e811c8ce RD |
11688 | |
11689 | def RemoveGrowableRow(*args, **kwargs): | |
248ed943 RD |
11690 | """ |
11691 | RemoveGrowableRow(self, size_t idx) | |
11692 | ||
11693 | Specifies that row *idx* is no longer growable. | |
11694 | """ | |
54f9ee45 | 11695 | return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs) |
e811c8ce RD |
11696 | |
11697 | def AddGrowableCol(*args, **kwargs): | |
248ed943 RD |
11698 | """ |
11699 | AddGrowableCol(self, size_t idx, int proportion=0) | |
11700 | ||
11701 | Specifies that column *idx* (starting from zero) should be grown if | |
11702 | there is extra space available to the sizer. | |
11703 | ||
11704 | The *proportion* parameter has the same meaning as the stretch factor | |
11705 | for the box sizers except that if all proportions are 0, then all | |
11706 | columns are resized equally (instead of not being resized at all). | |
11707 | """ | |
54f9ee45 | 11708 | return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs) |
e811c8ce RD |
11709 | |
11710 | def RemoveGrowableCol(*args, **kwargs): | |
248ed943 RD |
11711 | """ |
11712 | RemoveGrowableCol(self, size_t idx) | |
11713 | ||
11714 | Specifies that column *idx* is no longer growable. | |
11715 | """ | |
54f9ee45 | 11716 | return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs) |
e811c8ce RD |
11717 | |
11718 | def SetFlexibleDirection(*args, **kwargs): | |
248ed943 RD |
11719 | """ |
11720 | SetFlexibleDirection(self, int direction) | |
11721 | ||
11722 | Specifies whether the sizer should flexibly resize its columns, rows, | |
11723 | or both. Argument *direction* can be one of the following values. Any | |
11724 | other value is ignored. | |
11725 | ||
11726 | ============== ======================================= | |
11727 | wx.VERTICAL Rows are flexibly sized. | |
11728 | wx.HORIZONTAL Columns are flexibly sized. | |
11729 | wx.BOTH Both rows and columns are flexibly sized | |
11730 | (this is the default value). | |
11731 | ============== ======================================= | |
11732 | ||
11733 | Note that this method does not trigger relayout. | |
11734 | ||
11735 | """ | |
54f9ee45 | 11736 | return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs) |
e811c8ce RD |
11737 | |
11738 | def GetFlexibleDirection(*args, **kwargs): | |
248ed943 RD |
11739 | """ |
11740 | GetFlexibleDirection(self) -> int | |
11741 | ||
11742 | Returns a value that specifies whether the sizer | |
11743 | flexibly resizes its columns, rows, or both (default). | |
11744 | ||
11745 | :see: `SetFlexibleDirection` | |
11746 | """ | |
54f9ee45 | 11747 | return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs) |
e811c8ce RD |
11748 | |
11749 | def SetNonFlexibleGrowMode(*args, **kwargs): | |
248ed943 RD |
11750 | """ |
11751 | SetNonFlexibleGrowMode(self, int mode) | |
11752 | ||
11753 | Specifies how the sizer should grow in the non-flexible direction if | |
11754 | there is one (so `SetFlexibleDirection` must have been called | |
11755 | previously). Argument *mode* can be one of the following values: | |
11756 | ||
11757 | ========================== ================================================= | |
11758 | wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction. | |
11759 | wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with | |
11760 | `AddGrowableCol` and `AddGrowableRow`. In this | |
11761 | case equal sizing applies to minimum sizes of | |
11762 | columns or rows (this is the default value). | |
11763 | wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in | |
11764 | the non flexible direction, whether they are | |
11765 | growable or not in the flexbile direction. | |
11766 | ========================== ================================================= | |
11767 | ||
11768 | Note that this method does not trigger relayout. | |
11769 | ||
11770 | ||
11771 | """ | |
54f9ee45 | 11772 | return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs) |
e811c8ce RD |
11773 | |
11774 | def GetNonFlexibleGrowMode(*args, **kwargs): | |
248ed943 RD |
11775 | """ |
11776 | GetNonFlexibleGrowMode(self) -> int | |
11777 | ||
11778 | Returns the value that specifies how the sizer grows in the | |
11779 | non-flexible direction if there is one. | |
11780 | ||
11781 | :see: `SetNonFlexibleGrowMode` | |
11782 | """ | |
54f9ee45 | 11783 | return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs) |
e811c8ce RD |
11784 | |
11785 | def GetRowHeights(*args, **kwargs): | |
fd2dc343 RD |
11786 | """ |
11787 | GetRowHeights(self) -> list | |
11788 | ||
11789 | Returns a list of integers representing the heights of each of the | |
11790 | rows in the sizer. | |
11791 | """ | |
54f9ee45 | 11792 | return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs) |
e811c8ce RD |
11793 | |
11794 | def GetColWidths(*args, **kwargs): | |
fd2dc343 RD |
11795 | """ |
11796 | GetColWidths(self) -> list | |
11797 | ||
11798 | Returns a list of integers representing the widths of each of the | |
11799 | columns in the sizer. | |
11800 | """ | |
54f9ee45 | 11801 | return _core_.FlexGridSizer_GetColWidths(*args, **kwargs) |
e811c8ce | 11802 | |
2131d850 | 11803 | _core_.FlexGridSizer_swigregister(FlexGridSizer) |
d14a1e28 | 11804 | |
e505d15e RD |
11805 | class StdDialogButtonSizer(BoxSizer): |
11806 | """ | |
11807 | A special sizer that knows how to order and position standard buttons | |
11808 | in order to conform to the current platform's standards. You simply | |
11809 | need to add each `wx.Button` to the sizer, and be sure to create the | |
53aa7709 | 11810 | buttons using the standard ID's. Then call `Realize` and the sizer |
e505d15e RD |
11811 | will take care of the rest. |
11812 | ||
11813 | """ | |
0085ce49 RD |
11814 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11815 | __repr__ = _swig_repr | |
11816 | def __init__(self, *args, **kwargs): | |
e505d15e | 11817 | """__init__(self) -> StdDialogButtonSizer""" |
0085ce49 | 11818 | _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs)) |
e505d15e RD |
11819 | def AddButton(*args, **kwargs): |
11820 | """ | |
11821 | AddButton(self, wxButton button) | |
11822 | ||
11823 | Use this to add the buttons to this sizer. Do not use the `Add` | |
11824 | method in the base class. | |
11825 | """ | |
11826 | return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs) | |
11827 | ||
53aa7709 | 11828 | def Realize(*args, **kwargs): |
e505d15e | 11829 | """ |
53aa7709 | 11830 | Realize(self) |
e505d15e RD |
11831 | |
11832 | This funciton needs to be called after all the buttons have been added | |
11833 | to the sizer. It will reorder them and position them in a platform | |
11834 | specifc manner. | |
11835 | """ | |
53aa7709 | 11836 | return _core_.StdDialogButtonSizer_Realize(*args, **kwargs) |
51b83b37 RD |
11837 | |
11838 | def SetAffirmativeButton(*args, **kwargs): | |
11839 | """SetAffirmativeButton(self, wxButton button)""" | |
11840 | return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs) | |
11841 | ||
11842 | def SetNegativeButton(*args, **kwargs): | |
11843 | """SetNegativeButton(self, wxButton button)""" | |
11844 | return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs) | |
11845 | ||
11846 | def SetCancelButton(*args, **kwargs): | |
11847 | """SetCancelButton(self, wxButton button)""" | |
11848 | return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs) | |
e505d15e RD |
11849 | |
11850 | def GetAffirmativeButton(*args, **kwargs): | |
11851 | """GetAffirmativeButton(self) -> wxButton""" | |
11852 | return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs) | |
11853 | ||
11854 | def GetApplyButton(*args, **kwargs): | |
11855 | """GetApplyButton(self) -> wxButton""" | |
11856 | return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs) | |
11857 | ||
11858 | def GetNegativeButton(*args, **kwargs): | |
11859 | """GetNegativeButton(self) -> wxButton""" | |
11860 | return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs) | |
11861 | ||
11862 | def GetCancelButton(*args, **kwargs): | |
11863 | """GetCancelButton(self) -> wxButton""" | |
11864 | return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs) | |
11865 | ||
11866 | def GetHelpButton(*args, **kwargs): | |
11867 | """GetHelpButton(self) -> wxButton""" | |
11868 | return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs) | |
11869 | ||
2131d850 | 11870 | _core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer) |
e505d15e | 11871 | |
d14a1e28 RD |
11872 | #--------------------------------------------------------------------------- |
11873 | ||
11874 | class GBPosition(object): | |
248ed943 RD |
11875 | """ |
11876 | This class represents the position of an item in a virtual grid of | |
11877 | rows and columns managed by a `wx.GridBagSizer`. wxPython has | |
11878 | typemaps that will automatically convert from a 2-element sequence of | |
11879 | integers to a wx.GBPosition, so you can use the more pythonic | |
11880 | representation of the position nearly transparently in Python code. | |
11881 | """ | |
0085ce49 RD |
11882 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11883 | __repr__ = _swig_repr | |
11884 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11885 | """ |
11886 | __init__(self, int row=0, int col=0) -> GBPosition | |
11887 | ||
11888 | This class represents the position of an item in a virtual grid of | |
11889 | rows and columns managed by a `wx.GridBagSizer`. wxPython has | |
11890 | typemaps that will automatically convert from a 2-element sequence of | |
11891 | integers to a wx.GBPosition, so you can use the more pythonic | |
11892 | representation of the position nearly transparently in Python code. | |
11893 | """ | |
0085ce49 RD |
11894 | _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs)) |
11895 | __swig_destroy__ = _core_.delete_GBPosition | |
11896 | __del__ = lambda self : None; | |
e811c8ce | 11897 | def GetRow(*args, **kwargs): |
a95a7133 | 11898 | """GetRow(self) -> int""" |
54f9ee45 | 11899 | return _core_.GBPosition_GetRow(*args, **kwargs) |
e811c8ce RD |
11900 | |
11901 | def GetCol(*args, **kwargs): | |
a95a7133 | 11902 | """GetCol(self) -> int""" |
54f9ee45 | 11903 | return _core_.GBPosition_GetCol(*args, **kwargs) |
e811c8ce RD |
11904 | |
11905 | def SetRow(*args, **kwargs): | |
a95a7133 | 11906 | """SetRow(self, int row)""" |
54f9ee45 | 11907 | return _core_.GBPosition_SetRow(*args, **kwargs) |
e811c8ce RD |
11908 | |
11909 | def SetCol(*args, **kwargs): | |
a95a7133 | 11910 | """SetCol(self, int col)""" |
54f9ee45 | 11911 | return _core_.GBPosition_SetCol(*args, **kwargs) |
e811c8ce RD |
11912 | |
11913 | def __eq__(*args, **kwargs): | |
e9d6f3a4 RD |
11914 | """ |
11915 | __eq__(self, PyObject other) -> bool | |
11916 | ||
11917 | Compare GBPosition for equality. | |
11918 | """ | |
54f9ee45 | 11919 | return _core_.GBPosition___eq__(*args, **kwargs) |
e811c8ce RD |
11920 | |
11921 | def __ne__(*args, **kwargs): | |
e9d6f3a4 RD |
11922 | """ |
11923 | __ne__(self, PyObject other) -> bool | |
11924 | ||
11925 | Compare GBPosition for inequality. | |
11926 | """ | |
54f9ee45 | 11927 | return _core_.GBPosition___ne__(*args, **kwargs) |
e811c8ce RD |
11928 | |
11929 | def Set(*args, **kwargs): | |
a95a7133 | 11930 | """Set(self, int row=0, int col=0)""" |
54f9ee45 | 11931 | return _core_.GBPosition_Set(*args, **kwargs) |
e811c8ce RD |
11932 | |
11933 | def Get(*args, **kwargs): | |
a95a7133 | 11934 | """Get(self) -> PyObject""" |
54f9ee45 | 11935 | return _core_.GBPosition_Get(*args, **kwargs) |
e811c8ce | 11936 | |
41e2b43e | 11937 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
11938 | def __str__(self): return str(self.Get()) |
11939 | def __repr__(self): return 'wx.GBPosition'+str(self.Get()) | |
11940 | def __len__(self): return len(self.Get()) | |
11941 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
11942 | def __setitem__(self, index, val): |
11943 | if index == 0: self.SetRow(val) | |
11944 | elif index == 1: self.SetCol(val) | |
11945 | else: raise IndexError | |
e811c8ce | 11946 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
11947 | __safe_for_unpickling__ = True |
11948 | def __reduce__(self): return (wx.GBPosition, self.Get()) | |
d14a1e28 RD |
11949 | |
11950 | row = property(GetRow, SetRow) | |
11951 | col = property(GetCol, SetCol) | |
11952 | ||
2131d850 | 11953 | _core_.GBPosition_swigregister(GBPosition) |
d14a1e28 RD |
11954 | |
11955 | class GBSpan(object): | |
248ed943 RD |
11956 | """ |
11957 | This class is used to hold the row and column spanning attributes of | |
11958 | items in a `wx.GridBagSizer`. wxPython has typemaps that will | |
11959 | automatically convert from a 2-element sequence of integers to a | |
11960 | wx.GBSpan, so you can use the more pythonic representation of the span | |
11961 | nearly transparently in Python code. | |
11962 | ||
11963 | """ | |
0085ce49 RD |
11964 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
11965 | __repr__ = _swig_repr | |
11966 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
11967 | """ |
11968 | __init__(self, int rowspan=1, int colspan=1) -> GBSpan | |
11969 | ||
11970 | Construct a new wxGBSpan, optionally setting the rowspan and | |
11971 | colspan. The default is (1,1). (Meaning that the item occupies one | |
11972 | cell in each direction. | |
11973 | """ | |
0085ce49 RD |
11974 | _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs)) |
11975 | __swig_destroy__ = _core_.delete_GBSpan | |
11976 | __del__ = lambda self : None; | |
e811c8ce | 11977 | def GetRowspan(*args, **kwargs): |
a95a7133 | 11978 | """GetRowspan(self) -> int""" |
54f9ee45 | 11979 | return _core_.GBSpan_GetRowspan(*args, **kwargs) |
e811c8ce RD |
11980 | |
11981 | def GetColspan(*args, **kwargs): | |
a95a7133 | 11982 | """GetColspan(self) -> int""" |
54f9ee45 | 11983 | return _core_.GBSpan_GetColspan(*args, **kwargs) |
e811c8ce RD |
11984 | |
11985 | def SetRowspan(*args, **kwargs): | |
a95a7133 | 11986 | """SetRowspan(self, int rowspan)""" |
54f9ee45 | 11987 | return _core_.GBSpan_SetRowspan(*args, **kwargs) |
e811c8ce RD |
11988 | |
11989 | def SetColspan(*args, **kwargs): | |
a95a7133 | 11990 | """SetColspan(self, int colspan)""" |
54f9ee45 | 11991 | return _core_.GBSpan_SetColspan(*args, **kwargs) |
e811c8ce RD |
11992 | |
11993 | def __eq__(*args, **kwargs): | |
e9d6f3a4 RD |
11994 | """ |
11995 | __eq__(self, PyObject other) -> bool | |
11996 | ||
11997 | Compare wxGBSpan for equality. | |
11998 | """ | |
54f9ee45 | 11999 | return _core_.GBSpan___eq__(*args, **kwargs) |
e811c8ce RD |
12000 | |
12001 | def __ne__(*args, **kwargs): | |
e9d6f3a4 RD |
12002 | """ |
12003 | __ne__(self, PyObject other) -> bool | |
12004 | ||
12005 | Compare GBSpan for inequality. | |
12006 | """ | |
54f9ee45 | 12007 | return _core_.GBSpan___ne__(*args, **kwargs) |
e811c8ce RD |
12008 | |
12009 | def Set(*args, **kwargs): | |
a95a7133 | 12010 | """Set(self, int rowspan=1, int colspan=1)""" |
54f9ee45 | 12011 | return _core_.GBSpan_Set(*args, **kwargs) |
e811c8ce RD |
12012 | |
12013 | def Get(*args, **kwargs): | |
a95a7133 | 12014 | """Get(self) -> PyObject""" |
54f9ee45 | 12015 | return _core_.GBSpan_Get(*args, **kwargs) |
e811c8ce | 12016 | |
41e2b43e | 12017 | asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") |
e811c8ce RD |
12018 | def __str__(self): return str(self.Get()) |
12019 | def __repr__(self): return 'wx.GBSpan'+str(self.Get()) | |
12020 | def __len__(self): return len(self.Get()) | |
12021 | def __getitem__(self, index): return self.Get()[index] | |
d14a1e28 RD |
12022 | def __setitem__(self, index, val): |
12023 | if index == 0: self.SetRowspan(val) | |
12024 | elif index == 1: self.SetColspan(val) | |
12025 | else: raise IndexError | |
e811c8ce | 12026 | def __nonzero__(self): return self.Get() != (0,0) |
74e96f3d RD |
12027 | __safe_for_unpickling__ = True |
12028 | def __reduce__(self): return (wx.GBSpan, self.Get()) | |
d14a1e28 RD |
12029 | |
12030 | rowspan = property(GetRowspan, SetRowspan) | |
12031 | colspan = property(GetColspan, SetColspan) | |
12032 | ||
2131d850 | 12033 | _core_.GBSpan_swigregister(GBSpan) |
d14a1e28 RD |
12034 | |
12035 | class GBSizerItem(SizerItem): | |
248ed943 RD |
12036 | """ |
12037 | The wx.GBSizerItem class is used to track the additional data about | |
12038 | items in a `wx.GridBagSizer` such as the item's position in the grid | |
12039 | and how many rows or columns it spans. | |
12040 | ||
12041 | """ | |
0085ce49 RD |
12042 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12043 | __repr__ = _swig_repr | |
12044 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12045 | """ |
12046 | __init__(self) -> GBSizerItem | |
12047 | ||
12048 | Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer | |
12049 | size will need to be set, as well as a position and span before this | |
12050 | item can be used in a Sizer. | |
12051 | ||
12052 | You will probably never need to create a wx.GBSizerItem directly as they | |
12053 | are created automatically when the sizer's Add method is called. | |
12054 | """ | |
0085ce49 RD |
12055 | _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs)) |
12056 | __swig_destroy__ = _core_.delete_GBSizerItem | |
12057 | __del__ = lambda self : None; | |
e811c8ce | 12058 | def GetPos(*args, **kwargs): |
248ed943 RD |
12059 | """ |
12060 | GetPos(self) -> GBPosition | |
12061 | ||
12062 | Get the grid position of the item | |
12063 | """ | |
54f9ee45 | 12064 | return _core_.GBSizerItem_GetPos(*args, **kwargs) |
e811c8ce RD |
12065 | |
12066 | def GetPosTuple(self): return self.GetPos().Get() | |
12067 | def GetSpan(*args, **kwargs): | |
248ed943 RD |
12068 | """ |
12069 | GetSpan(self) -> GBSpan | |
12070 | ||
12071 | Get the row and column spanning of the item | |
12072 | """ | |
54f9ee45 | 12073 | return _core_.GBSizerItem_GetSpan(*args, **kwargs) |
e811c8ce RD |
12074 | |
12075 | def GetSpanTuple(self): return self.GetSpan().Get() | |
12076 | def SetPos(*args, **kwargs): | |
248ed943 RD |
12077 | """ |
12078 | SetPos(self, GBPosition pos) -> bool | |
12079 | ||
12080 | If the item is already a member of a sizer then first ensure that | |
12081 | there is no other item that would intersect with this one at the new | |
12082 | position, then set the new position. Returns True if the change is | |
12083 | successful and after the next Layout() the item will be moved. | |
12084 | """ | |
54f9ee45 | 12085 | return _core_.GBSizerItem_SetPos(*args, **kwargs) |
e811c8ce RD |
12086 | |
12087 | def SetSpan(*args, **kwargs): | |
248ed943 RD |
12088 | """ |
12089 | SetSpan(self, GBSpan span) -> bool | |
12090 | ||
12091 | If the item is already a member of a sizer then first ensure that | |
12092 | there is no other item that would intersect with this one with its new | |
12093 | spanning size, then set the new spanning. Returns True if the change | |
12094 | is successful and after the next Layout() the item will be resized. | |
12095 | ||
12096 | """ | |
54f9ee45 | 12097 | return _core_.GBSizerItem_SetSpan(*args, **kwargs) |
e811c8ce | 12098 | |
248ed943 | 12099 | def Intersects(*args, **kwargs): |
0df68c9f | 12100 | """ |
a95a7133 | 12101 | Intersects(self, GBSizerItem other) -> bool |
248ed943 RD |
12102 | |
12103 | Returns True if this item and the other item instersect. | |
0df68c9f | 12104 | """ |
248ed943 RD |
12105 | return _core_.GBSizerItem_Intersects(*args, **kwargs) |
12106 | ||
12107 | def IntersectsPos(*args, **kwargs): | |
12108 | """ | |
12109 | IntersectsPos(self, GBPosition pos, GBSpan span) -> bool | |
12110 | ||
12111 | Returns True if the given pos/span would intersect with this item. | |
12112 | """ | |
12113 | return _core_.GBSizerItem_IntersectsPos(*args, **kwargs) | |
e811c8ce RD |
12114 | |
12115 | def GetEndPos(*args, **kwargs): | |
248ed943 RD |
12116 | """ |
12117 | GetEndPos(self) -> GBPosition | |
12118 | ||
12119 | Get the row and column of the endpoint of this item. | |
12120 | """ | |
54f9ee45 | 12121 | return _core_.GBSizerItem_GetEndPos(*args, **kwargs) |
e811c8ce RD |
12122 | |
12123 | def GetGBSizer(*args, **kwargs): | |
248ed943 RD |
12124 | """ |
12125 | GetGBSizer(self) -> GridBagSizer | |
12126 | ||
12127 | Get the sizer this item is a member of. | |
12128 | """ | |
54f9ee45 | 12129 | return _core_.GBSizerItem_GetGBSizer(*args, **kwargs) |
e811c8ce RD |
12130 | |
12131 | def SetGBSizer(*args, **kwargs): | |
248ed943 RD |
12132 | """ |
12133 | SetGBSizer(self, GridBagSizer sizer) | |
12134 | ||
12135 | Set the sizer this item is a member of. | |
12136 | """ | |
54f9ee45 | 12137 | return _core_.GBSizerItem_SetGBSizer(*args, **kwargs) |
e811c8ce | 12138 | |
2131d850 | 12139 | _core_.GBSizerItem_swigregister(GBSizerItem) |
d14a1e28 RD |
12140 | DefaultSpan = cvar.DefaultSpan |
12141 | ||
12142 | def GBSizerItemWindow(*args, **kwargs): | |
0df68c9f RD |
12143 | """ |
12144 | GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag, | |
248ed943 RD |
12145 | int border, PyObject userData=None) -> GBSizerItem |
12146 | ||
12147 | Construct a `wx.GBSizerItem` for a window. | |
0df68c9f | 12148 | """ |
54f9ee45 | 12149 | val = _core_.new_GBSizerItemWindow(*args, **kwargs) |
d14a1e28 RD |
12150 | return val |
12151 | ||
12152 | def GBSizerItemSizer(*args, **kwargs): | |
0df68c9f RD |
12153 | """ |
12154 | GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, | |
248ed943 RD |
12155 | int border, PyObject userData=None) -> GBSizerItem |
12156 | ||
12157 | Construct a `wx.GBSizerItem` for a sizer | |
0df68c9f | 12158 | """ |
54f9ee45 | 12159 | val = _core_.new_GBSizerItemSizer(*args, **kwargs) |
d14a1e28 RD |
12160 | return val |
12161 | ||
12162 | def GBSizerItemSpacer(*args, **kwargs): | |
0df68c9f RD |
12163 | """ |
12164 | GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span, | |
248ed943 RD |
12165 | int flag, int border, PyObject userData=None) -> GBSizerItem |
12166 | ||
12167 | Construct a `wx.GBSizerItem` for a spacer. | |
0df68c9f | 12168 | """ |
54f9ee45 | 12169 | val = _core_.new_GBSizerItemSpacer(*args, **kwargs) |
d14a1e28 RD |
12170 | return val |
12171 | ||
12172 | class GridBagSizer(FlexGridSizer): | |
248ed943 RD |
12173 | """ |
12174 | A `wx.Sizer` that can lay out items in a virtual grid like a | |
12175 | `wx.FlexGridSizer` but in this case explicit positioning of the items | |
12176 | is allowed using `wx.GBPosition`, and items can optionally span more | |
12177 | than one row and/or column using `wx.GBSpan`. The total size of the | |
12178 | virtual grid is determined by the largest row and column that items are | |
12179 | positioned at, adjusted for spanning. | |
12180 | ||
12181 | """ | |
0085ce49 RD |
12182 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12183 | __repr__ = _swig_repr | |
12184 | def __init__(self, *args, **kwargs): | |
248ed943 RD |
12185 | """ |
12186 | __init__(self, int vgap=0, int hgap=0) -> GridBagSizer | |
12187 | ||
12188 | Constructor, with optional parameters to specify the gap between the | |
12189 | rows and columns. | |
12190 | """ | |
0085ce49 | 12191 | _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs)) |
1823fbb4 RD |
12192 | self._setOORInfo(self) |
12193 | ||
e811c8ce | 12194 | def Add(*args, **kwargs): |
0df68c9f | 12195 | """ |
248ed943 | 12196 | Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0, |
d3b6e4ff | 12197 | int border=0, userData=None) -> wx.GBSizerItem |
248ed943 RD |
12198 | |
12199 | Adds an item to the sizer at the grid cell *pos*, optionally spanning | |
12200 | more than one row or column as specified with *span*. The remaining | |
12201 | args behave similarly to `wx.Sizer.Add`. | |
12202 | ||
12203 | Returns True if the item was successfully placed at the given cell | |
12204 | position, False if something was already there. | |
12205 | ||
0df68c9f | 12206 | """ |
54f9ee45 | 12207 | return _core_.GridBagSizer_Add(*args, **kwargs) |
e811c8ce RD |
12208 | |
12209 | def AddItem(*args, **kwargs): | |
248ed943 | 12210 | """ |
d3b6e4ff | 12211 | Add(self, GBSizerItem item) -> wx.GBSizerItem |
248ed943 RD |
12212 | |
12213 | Add an item to the sizer using a `wx.GBSizerItem`. Returns True if | |
12214 | the item was successfully placed at its given cell position, False if | |
12215 | something was already there. | |
12216 | """ | |
54f9ee45 | 12217 | return _core_.GridBagSizer_AddItem(*args, **kwargs) |
e811c8ce | 12218 | |
84f85550 RD |
12219 | def GetCellSize(*args, **kwargs): |
12220 | """ | |
12221 | GetCellSize(self, int row, int col) -> Size | |
12222 | ||
12223 | Get the size of the specified cell, including hgap and | |
12224 | vgap. Only valid after a Layout. | |
12225 | """ | |
12226 | return _core_.GridBagSizer_GetCellSize(*args, **kwargs) | |
12227 | ||
e811c8ce | 12228 | def GetEmptyCellSize(*args, **kwargs): |
248ed943 RD |
12229 | """ |
12230 | GetEmptyCellSize(self) -> Size | |
12231 | ||
12232 | Get the size used for cells in the grid with no item. | |
12233 | """ | |
54f9ee45 | 12234 | return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs) |
e811c8ce RD |
12235 | |
12236 | def SetEmptyCellSize(*args, **kwargs): | |
248ed943 RD |
12237 | """ |
12238 | SetEmptyCellSize(self, Size sz) | |
12239 | ||
12240 | Set the size used for cells in the grid with no item. | |
12241 | """ | |
54f9ee45 | 12242 | return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs) |
e811c8ce RD |
12243 | |
12244 | def GetItemPosition(*args): | |
0df68c9f | 12245 | """ |
248ed943 RD |
12246 | GetItemPosition(self, item) -> GBPosition |
12247 | ||
12248 | Get the grid position of the specified *item* where *item* is either a | |
12249 | window or subsizer that is a member of this sizer, or a zero-based | |
12250 | index of an item. | |
0df68c9f | 12251 | """ |
54f9ee45 | 12252 | return _core_.GridBagSizer_GetItemPosition(*args) |
e811c8ce RD |
12253 | |
12254 | def SetItemPosition(*args): | |
0df68c9f | 12255 | """ |
248ed943 RD |
12256 | SetItemPosition(self, item, GBPosition pos) -> bool |
12257 | ||
12258 | Set the grid position of the specified *item* where *item* is either a | |
12259 | window or subsizer that is a member of this sizer, or a zero-based | |
12260 | index of an item. Returns True on success. If the move is not | |
12261 | allowed (because an item is already there) then False is returned. | |
12262 | ||
0df68c9f | 12263 | """ |
54f9ee45 | 12264 | return _core_.GridBagSizer_SetItemPosition(*args) |
e811c8ce RD |
12265 | |
12266 | def GetItemSpan(*args): | |
0df68c9f | 12267 | """ |
248ed943 RD |
12268 | GetItemSpan(self, item) -> GBSpan |
12269 | ||
12270 | Get the row/col spanning of the specified *item* where *item* is | |
12271 | either a window or subsizer that is a member of this sizer, or a | |
12272 | zero-based index of an item. | |
0df68c9f | 12273 | """ |
54f9ee45 | 12274 | return _core_.GridBagSizer_GetItemSpan(*args) |
e811c8ce RD |
12275 | |
12276 | def SetItemSpan(*args): | |
0df68c9f | 12277 | """ |
248ed943 RD |
12278 | SetItemSpan(self, item, GBSpan span) -> bool |
12279 | ||
12280 | Set the row/col spanning of the specified *item* where *item* is | |
12281 | either a window or subsizer that is a member of this sizer, or a | |
12282 | zero-based index of an item. Returns True on success. If the move is | |
12283 | not allowed (because an item is already there) then False is returned. | |
0df68c9f | 12284 | """ |
54f9ee45 | 12285 | return _core_.GridBagSizer_SetItemSpan(*args) |
e811c8ce RD |
12286 | |
12287 | def FindItem(*args): | |
0df68c9f | 12288 | """ |
248ed943 RD |
12289 | FindItem(self, item) -> GBSizerItem |
12290 | ||
12291 | Find the sizer item for the given window or subsizer, returns None if | |
12292 | not found. (non-recursive) | |
0df68c9f | 12293 | """ |
54f9ee45 | 12294 | return _core_.GridBagSizer_FindItem(*args) |
e811c8ce RD |
12295 | |
12296 | def FindItemAtPosition(*args, **kwargs): | |
248ed943 RD |
12297 | """ |
12298 | FindItemAtPosition(self, GBPosition pos) -> GBSizerItem | |
12299 | ||
12300 | Return the sizer item for the given grid cell, or None if there is no | |
12301 | item at that position. (non-recursive) | |
12302 | """ | |
54f9ee45 | 12303 | return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs) |
e811c8ce RD |
12304 | |
12305 | def FindItemAtPoint(*args, **kwargs): | |
248ed943 RD |
12306 | """ |
12307 | FindItemAtPoint(self, Point pt) -> GBSizerItem | |
12308 | ||
12309 | Return the sizer item located at the point given in *pt*, or None if | |
12310 | there is no item at that point. The (x,y) coordinates in pt correspond | |
12311 | to the client coordinates of the window using the sizer for | |
12312 | layout. (non-recursive) | |
12313 | """ | |
54f9ee45 | 12314 | return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs) |
e811c8ce | 12315 | |
248ed943 RD |
12316 | def CheckForIntersection(*args, **kwargs): |
12317 | """ | |
12318 | CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool | |
e811c8ce | 12319 | |
248ed943 RD |
12320 | Look at all items and see if any intersect (or would overlap) the |
12321 | given *item*. Returns True if so, False if there would be no overlap. | |
12322 | If an *excludeItem* is given then it will not be checked for | |
12323 | intersection, for example it may be the item we are checking the | |
12324 | position of. | |
e811c8ce | 12325 | |
248ed943 RD |
12326 | """ |
12327 | return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs) | |
e811c8ce | 12328 | |
248ed943 | 12329 | def CheckForIntersectionPos(*args, **kwargs): |
0df68c9f | 12330 | """ |
248ed943 RD |
12331 | CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool |
12332 | ||
12333 | Look at all items and see if any intersect (or would overlap) the | |
12334 | given position and span. Returns True if so, False if there would be | |
12335 | no overlap. If an *excludeItem* is given then it will not be checked | |
12336 | for intersection, for example it may be the item we are checking the | |
12337 | position of. | |
0df68c9f | 12338 | """ |
248ed943 | 12339 | return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs) |
e811c8ce | 12340 | |
2131d850 | 12341 | _core_.GridBagSizer_swigregister(GridBagSizer) |
d14a1e28 RD |
12342 | |
12343 | #--------------------------------------------------------------------------- | |
12344 | ||
54f9ee45 RD |
12345 | Left = _core_.Left |
12346 | Top = _core_.Top | |
12347 | Right = _core_.Right | |
12348 | Bottom = _core_.Bottom | |
12349 | Width = _core_.Width | |
12350 | Height = _core_.Height | |
12351 | Centre = _core_.Centre | |
12352 | Center = _core_.Center | |
12353 | CentreX = _core_.CentreX | |
12354 | CentreY = _core_.CentreY | |
12355 | Unconstrained = _core_.Unconstrained | |
12356 | AsIs = _core_.AsIs | |
12357 | PercentOf = _core_.PercentOf | |
12358 | Above = _core_.Above | |
12359 | Below = _core_.Below | |
12360 | LeftOf = _core_.LeftOf | |
12361 | RightOf = _core_.RightOf | |
12362 | SameAs = _core_.SameAs | |
12363 | Absolute = _core_.Absolute | |
d14a1e28 | 12364 | class IndividualLayoutConstraint(Object): |
15afbcd0 | 12365 | """ |
41e2b43e RD |
12366 | Objects of this class are stored in the `wx.LayoutConstraints` class as |
12367 | one of eight possible constraints that a window can be involved in. | |
12368 | You will never need to create an instance of | |
12369 | wx.IndividualLayoutConstraint, rather you should create a | |
12370 | `wx.LayoutConstraints` instance and use the individual contstraints | |
15afbcd0 | 12371 | that it contains. |
15afbcd0 | 12372 | """ |
0085ce49 RD |
12373 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12374 | def __init__(self): raise AttributeError, "No constructor defined" | |
12375 | __repr__ = _swig_repr | |
e811c8ce | 12376 | def Set(*args, **kwargs): |
41e2b43e RD |
12377 | """ |
12378 | Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN) | |
12379 | ||
12380 | Sets the properties of the constraint. Normally called by one of the | |
12381 | convenience functions such as Above, RightOf, SameAs. | |
12382 | """ | |
54f9ee45 | 12383 | return _core_.IndividualLayoutConstraint_Set(*args, **kwargs) |
e811c8ce RD |
12384 | |
12385 | def LeftOf(*args, **kwargs): | |
15afbcd0 | 12386 | """ |
a95a7133 | 12387 | LeftOf(self, Window sibling, int marg=0) |
15afbcd0 | 12388 | |
41e2b43e RD |
12389 | Constrains this edge to be to the left of the given window, with an |
12390 | optional margin. Implicitly, this is relative to the left edge of the | |
12391 | other window. | |
15afbcd0 | 12392 | """ |
54f9ee45 | 12393 | return _core_.IndividualLayoutConstraint_LeftOf(*args, **kwargs) |
e811c8ce RD |
12394 | |
12395 | def RightOf(*args, **kwargs): | |
15afbcd0 | 12396 | """ |
a95a7133 | 12397 | RightOf(self, Window sibling, int marg=0) |
15afbcd0 | 12398 | |
41e2b43e RD |
12399 | Constrains this edge to be to the right of the given window, with an |
12400 | optional margin. Implicitly, this is relative to the right edge of the | |
12401 | other window. | |
15afbcd0 | 12402 | """ |
54f9ee45 | 12403 | return _core_.IndividualLayoutConstraint_RightOf(*args, **kwargs) |
e811c8ce RD |
12404 | |
12405 | def Above(*args, **kwargs): | |
15afbcd0 | 12406 | """ |
a95a7133 | 12407 | Above(self, Window sibling, int marg=0) |
15afbcd0 | 12408 | |
41e2b43e RD |
12409 | Constrains this edge to be above the given window, with an optional |
12410 | margin. Implicitly, this is relative to the top edge of the other | |
12411 | window. | |
15afbcd0 | 12412 | """ |
54f9ee45 | 12413 | return _core_.IndividualLayoutConstraint_Above(*args, **kwargs) |
e811c8ce RD |
12414 | |
12415 | def Below(*args, **kwargs): | |
15afbcd0 | 12416 | """ |
a95a7133 | 12417 | Below(self, Window sibling, int marg=0) |
15afbcd0 | 12418 | |
41e2b43e RD |
12419 | Constrains this edge to be below the given window, with an optional |
12420 | margin. Implicitly, this is relative to the bottom edge of the other | |
12421 | window. | |
15afbcd0 | 12422 | """ |
54f9ee45 | 12423 | return _core_.IndividualLayoutConstraint_Below(*args, **kwargs) |
e811c8ce RD |
12424 | |
12425 | def SameAs(*args, **kwargs): | |
15afbcd0 | 12426 | """ |
a95a7133 | 12427 | SameAs(self, Window otherW, int edge, int marg=0) |
15afbcd0 | 12428 | |
41e2b43e RD |
12429 | Constrains this edge or dimension to be to the same as the edge of the |
12430 | given window, with an optional margin. | |
15afbcd0 | 12431 | """ |
54f9ee45 | 12432 | return _core_.IndividualLayoutConstraint_SameAs(*args, **kwargs) |
e811c8ce RD |
12433 | |
12434 | def PercentOf(*args, **kwargs): | |
15afbcd0 | 12435 | """ |
a95a7133 | 12436 | PercentOf(self, Window otherW, int wh, int per) |
15afbcd0 | 12437 | |
41e2b43e RD |
12438 | Constrains this edge or dimension to be to a percentage of the given |
12439 | window, with an optional margin. | |
15afbcd0 | 12440 | """ |
54f9ee45 | 12441 | return _core_.IndividualLayoutConstraint_PercentOf(*args, **kwargs) |
e811c8ce RD |
12442 | |
12443 | def Absolute(*args, **kwargs): | |
15afbcd0 | 12444 | """ |
a95a7133 | 12445 | Absolute(self, int val) |
15afbcd0 | 12446 | |
41e2b43e | 12447 | Constrains this edge or dimension to be the given absolute value. |
15afbcd0 | 12448 | """ |
54f9ee45 | 12449 | return _core_.IndividualLayoutConstraint_Absolute(*args, **kwargs) |
e811c8ce RD |
12450 | |
12451 | def Unconstrained(*args, **kwargs): | |
15afbcd0 | 12452 | """ |
a95a7133 | 12453 | Unconstrained(self) |
15afbcd0 | 12454 | |
41e2b43e RD |
12455 | Sets this edge or dimension to be unconstrained, that is, dependent on |
12456 | other edges and dimensions from which this value can be deduced. | |
15afbcd0 | 12457 | """ |
54f9ee45 | 12458 | return _core_.IndividualLayoutConstraint_Unconstrained(*args, **kwargs) |
e811c8ce RD |
12459 | |
12460 | def AsIs(*args, **kwargs): | |
15afbcd0 | 12461 | """ |
a95a7133 | 12462 | AsIs(self) |
15afbcd0 | 12463 | |
41e2b43e RD |
12464 | Sets this edge or constraint to be whatever the window's value is at |
12465 | the moment. If either of the width and height constraints are *as is*, | |
12466 | the window will not be resized, but moved instead. This is important | |
12467 | when considering panel items which are intended to have a default | |
12468 | size, such as a button, which may take its size from the size of the | |
12469 | button label. | |
15afbcd0 | 12470 | """ |
54f9ee45 | 12471 | return _core_.IndividualLayoutConstraint_AsIs(*args, **kwargs) |
e811c8ce RD |
12472 | |
12473 | def GetOtherWindow(*args, **kwargs): | |
a95a7133 | 12474 | """GetOtherWindow(self) -> Window""" |
54f9ee45 | 12475 | return _core_.IndividualLayoutConstraint_GetOtherWindow(*args, **kwargs) |
e811c8ce RD |
12476 | |
12477 | def GetMyEdge(*args, **kwargs): | |
a95a7133 | 12478 | """GetMyEdge(self) -> int""" |
54f9ee45 | 12479 | return _core_.IndividualLayoutConstraint_GetMyEdge(*args, **kwargs) |
e811c8ce RD |
12480 | |
12481 | def SetEdge(*args, **kwargs): | |
a95a7133 | 12482 | """SetEdge(self, int which)""" |
54f9ee45 | 12483 | return _core_.IndividualLayoutConstraint_SetEdge(*args, **kwargs) |
e811c8ce RD |
12484 | |
12485 | def SetValue(*args, **kwargs): | |
a95a7133 | 12486 | """SetValue(self, int v)""" |
54f9ee45 | 12487 | return _core_.IndividualLayoutConstraint_SetValue(*args, **kwargs) |
e811c8ce RD |
12488 | |
12489 | def GetMargin(*args, **kwargs): | |
a95a7133 | 12490 | """GetMargin(self) -> int""" |
54f9ee45 | 12491 | return _core_.IndividualLayoutConstraint_GetMargin(*args, **kwargs) |
e811c8ce RD |
12492 | |
12493 | def SetMargin(*args, **kwargs): | |
a95a7133 | 12494 | """SetMargin(self, int m)""" |
54f9ee45 | 12495 | return _core_.IndividualLayoutConstraint_SetMargin(*args, **kwargs) |
e811c8ce RD |
12496 | |
12497 | def GetValue(*args, **kwargs): | |
a95a7133 | 12498 | """GetValue(self) -> int""" |
54f9ee45 | 12499 | return _core_.IndividualLayoutConstraint_GetValue(*args, **kwargs) |
e811c8ce RD |
12500 | |
12501 | def GetPercent(*args, **kwargs): | |
a95a7133 | 12502 | """GetPercent(self) -> int""" |
54f9ee45 | 12503 | return _core_.IndividualLayoutConstraint_GetPercent(*args, **kwargs) |
e811c8ce RD |
12504 | |
12505 | def GetOtherEdge(*args, **kwargs): | |
a95a7133 | 12506 | """GetOtherEdge(self) -> int""" |
54f9ee45 | 12507 | return _core_.IndividualLayoutConstraint_GetOtherEdge(*args, **kwargs) |
e811c8ce RD |
12508 | |
12509 | def GetDone(*args, **kwargs): | |
a95a7133 | 12510 | """GetDone(self) -> bool""" |
54f9ee45 | 12511 | return _core_.IndividualLayoutConstraint_GetDone(*args, **kwargs) |
e811c8ce RD |
12512 | |
12513 | def SetDone(*args, **kwargs): | |
a95a7133 | 12514 | """SetDone(self, bool d)""" |
54f9ee45 | 12515 | return _core_.IndividualLayoutConstraint_SetDone(*args, **kwargs) |
e811c8ce RD |
12516 | |
12517 | def GetRelationship(*args, **kwargs): | |
a95a7133 | 12518 | """GetRelationship(self) -> int""" |
54f9ee45 | 12519 | return _core_.IndividualLayoutConstraint_GetRelationship(*args, **kwargs) |
e811c8ce RD |
12520 | |
12521 | def SetRelationship(*args, **kwargs): | |
a95a7133 | 12522 | """SetRelationship(self, int r)""" |
54f9ee45 | 12523 | return _core_.IndividualLayoutConstraint_SetRelationship(*args, **kwargs) |
e811c8ce RD |
12524 | |
12525 | def ResetIfWin(*args, **kwargs): | |
15afbcd0 | 12526 | """ |
a95a7133 | 12527 | ResetIfWin(self, Window otherW) -> bool |
15afbcd0 RD |
12528 | |
12529 | Reset constraint if it mentions otherWin | |
12530 | """ | |
54f9ee45 | 12531 | return _core_.IndividualLayoutConstraint_ResetIfWin(*args, **kwargs) |
e811c8ce RD |
12532 | |
12533 | def SatisfyConstraint(*args, **kwargs): | |
15afbcd0 | 12534 | """ |
a95a7133 | 12535 | SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool |
15afbcd0 RD |
12536 | |
12537 | Try to satisfy constraint | |
12538 | """ | |
54f9ee45 | 12539 | return _core_.IndividualLayoutConstraint_SatisfyConstraint(*args, **kwargs) |
e811c8ce RD |
12540 | |
12541 | def GetEdge(*args, **kwargs): | |
15afbcd0 | 12542 | """ |
a95a7133 | 12543 | GetEdge(self, int which, Window thisWin, Window other) -> int |
15afbcd0 RD |
12544 | |
12545 | Get the value of this edge or dimension, or if this | |
12546 | is not determinable, -1. | |
12547 | """ | |
54f9ee45 | 12548 | return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs) |
e811c8ce | 12549 | |
2131d850 | 12550 | _core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint) |
d14a1e28 RD |
12551 | |
12552 | class LayoutConstraints(Object): | |
15afbcd0 | 12553 | """ |
41e2b43e RD |
12554 | **Note:** constraints are now deprecated and you should use sizers |
12555 | instead. | |
15afbcd0 | 12556 | |
41e2b43e RD |
12557 | Objects of this class can be associated with a window to define its |
12558 | layout constraints, with respect to siblings or its parent. | |
15afbcd0 RD |
12559 | |
12560 | The class consists of the following eight constraints of class | |
12561 | wx.IndividualLayoutConstraint, some or all of which should be accessed | |
12562 | directly to set the appropriate constraints. | |
12563 | ||
12564 | * left: represents the left hand edge of the window | |
12565 | * right: represents the right hand edge of the window | |
12566 | * top: represents the top edge of the window | |
12567 | * bottom: represents the bottom edge of the window | |
12568 | * width: represents the width of the window | |
12569 | * height: represents the height of the window | |
12570 | * centreX: represents the horizontal centre point of the window | |
12571 | * centreY: represents the vertical centre point of the window | |
12572 | ||
41e2b43e RD |
12573 | Most constraints are initially set to have the relationship |
12574 | wxUnconstrained, which means that their values should be calculated by | |
12575 | looking at known constraints. The exceptions are width and height, | |
12576 | which are set to wxAsIs to ensure that if the user does not specify a | |
12577 | constraint, the existing width and height will be used, to be | |
12578 | compatible with panel items which often have take a default size. If | |
12579 | the constraint is ``wx.AsIs``, the dimension will not be changed. | |
12580 | ||
12581 | :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints` | |
15afbcd0 RD |
12582 | |
12583 | """ | |
0085ce49 RD |
12584 | thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') |
12585 | __repr__ = _swig_repr | |
54f9ee45 RD |
12586 | left = property(_core_.LayoutConstraints_left_get) |
12587 | top = property(_core_.LayoutConstraints_top_get) | |
12588 | right = property(_core_.LayoutConstraints_right_get) | |
12589 | bottom = property(_core_.LayoutConstraints_bottom_get) | |
12590 | width = property(_core_.LayoutConstraints_width_get) | |
12591 | height = property(_core_.LayoutConstraints_height_get) | |
12592 | centreX = property(_core_.LayoutConstraints_centreX_get) | |
12593 | centreY = property(_core_.LayoutConstraints_centreY_get) | |
0085ce49 | 12594 | def __init__(self, *args, **kwargs): |
a95a7133 | 12595 | """__init__(self) -> LayoutConstraints""" |
0085ce49 RD |
12596 | _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs)) |
12597 | __swig_destroy__ = _core_.delete_LayoutConstraints | |
12598 | __del__ = lambda self : None; | |
e811c8ce | 12599 | def SatisfyConstraints(*args, **kwargs): |
6c3b4aae | 12600 | """SatisfyConstraints(Window win) -> (areSatisfied, noChanges)""" |
54f9ee45 | 12601 | return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs) |
e811c8ce RD |
12602 | |
12603 | def AreSatisfied(*args, **kwargs): | |
a95a7133 | 12604 | """AreSatisfied(self) -> bool""" |
54f9ee45 | 12605 | return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs) |
e811c8ce | 12606 | |
2131d850 | 12607 | _core_.LayoutConstraints_swigregister(LayoutConstraints) |
d14a1e28 RD |
12608 | |
12609 | #---------------------------------------------------------------------------- | |
12610 | ||
322913ce | 12611 | # Use Python's bool constants if available, make some if not |
d14a1e28 RD |
12612 | try: |
12613 | True | |
12614 | except NameError: | |
322913ce RD |
12615 | __builtins__.True = 1==1 |
12616 | __builtins__.False = 1==0 | |
4f89f6a3 RD |
12617 | def bool(value): return not not value |
12618 | __builtins__.bool = bool | |
d14a1e28 | 12619 | |
d14a1e28 RD |
12620 | |
12621 | ||
12622 | # workarounds for bad wxRTTI names | |
12623 | __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge' | |
12624 | __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider' | |
12625 | __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' | |
12626 | ||
12627 | ||
12628 | #---------------------------------------------------------------------------- | |
12629 | # Load version numbers from __version__... Ensure that major and minor | |
7bc1e663 | 12630 | # versions are the same for both wxPython and wxWidgets. |
d14a1e28 RD |
12631 | |
12632 | from __version__ import * | |
12633 | __version__ = VERSION_STRING | |
12634 | ||
7bc1e663 RD |
12635 | assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch" |
12636 | assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch" | |
54f9ee45 | 12637 | if RELEASE_VERSION != _core_.RELEASE_VERSION: |
d14a1e28 | 12638 | import warnings |
7bc1e663 | 12639 | warnings.warn("wxPython/wxWidgets release number mismatch") |
d14a1e28 RD |
12640 | |
12641 | #---------------------------------------------------------------------------- | |
12642 | ||
70b7a5fe RD |
12643 | # Set wxPython's default string<-->unicode conversion encoding from |
12644 | # the locale, but only if Python's default hasn't been changed. (We | |
12645 | # assume that if the user has customized it already then that is the | |
12646 | # encoding we need to use as well.) | |
12647 | # | |
12648 | # The encoding selected here is used when string or unicode objects | |
12649 | # need to be converted in order to pass them to wxWidgets. Please be | |
12650 | # aware that the default encoding within the same locale may be | |
12651 | # slightly different on different platforms. For example, please see | |
e505d15e RD |
12652 | # http://www.alanwood.net/demos/charsetdiffs.html for differences |
12653 | # between the common latin/roman encodings. | |
396fb509 RD |
12654 | |
12655 | default = _sys.getdefaultencoding() | |
12656 | if default == 'ascii': | |
12657 | import locale | |
12658 | import codecs | |
12659 | try: | |
12660 | default = locale.getdefaultlocale()[1] | |
12661 | codecs.lookup(default) | |
70b7a5fe | 12662 | except (ValueError, LookupError, TypeError): |
396fb509 RD |
12663 | default = _sys.getdefaultencoding() |
12664 | del locale | |
12665 | del codecs | |
5cbf236d RD |
12666 | if default: |
12667 | wx.SetDefaultPyEncoding(default) | |
12668 | del default | |
5cbf236d RD |
12669 | |
12670 | #---------------------------------------------------------------------------- | |
12671 | ||
d14a1e28 RD |
12672 | class PyDeadObjectError(AttributeError): |
12673 | pass | |
12674 | ||
d14a1e28 RD |
12675 | class _wxPyDeadObject(object): |
12676 | """ | |
12677 | Instances of wx objects that are OOR capable will have their __class__ | |
12678 | changed to this class when the C++ object is deleted. This should help | |
12679 | prevent crashes due to referencing a bogus C++ pointer. | |
12680 | """ | |
12681 | reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)" | |
12682 | attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed." | |
12683 | ||
3a04f143 | 12684 | def __repr__(self): |
d14a1e28 RD |
12685 | if not hasattr(self, "_name"): |
12686 | self._name = "[unknown]" | |
12687 | return self.reprStr % self._name | |
12688 | ||
3a04f143 | 12689 | def __getattr__(self, *args): |
d14a1e28 RD |
12690 | if not hasattr(self, "_name"): |
12691 | self._name = "[unknown]" | |
3a04f143 RD |
12692 | raise PyDeadObjectError(self.attrStr % self._name) |
12693 | ||
12694 | def __nonzero__(self): | |
12695 | return 0 | |
12696 | ||
12697 | ||
12698 | ||
12699 | class PyUnbornObjectError(AttributeError): | |
12700 | pass | |
12701 | ||
12702 | class _wxPyUnbornObject(object): | |
12703 | """ | |
54f9ee45 | 12704 | Some stock objects are created when the wx._core module is |
3a04f143 RD |
12705 | imported, but their C++ instance is not created until the wx.App |
12706 | object is created and initialized. These object instances will | |
12707 | temporarily have their __class__ changed to this class so an | |
12708 | exception will be raised if they are used before the C++ instance | |
12709 | is ready. | |
12710 | """ | |
12711 | ||
12712 | reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)" | |
12713 | attrStr = "The C++ part of this object has not been initialized, attribute access not allowed." | |
12714 | ||
12715 | def __repr__(self): | |
12716 | #if not hasattr(self, "_name"): | |
12717 | # self._name = "[unknown]" | |
12718 | return self.reprStr #% self._name | |
12719 | ||
12720 | def __getattr__(self, *args): | |
12721 | #if not hasattr(self, "_name"): | |
12722 | # self._name = "[unknown]" | |
12723 | raise PyUnbornObjectError(self.attrStr) # % self._name ) | |
d14a1e28 RD |
12724 | |
12725 | def __nonzero__(self): | |
12726 | return 0 | |
12727 | ||
12728 | ||
12729 | #---------------------------------------------------------------------------- | |
d14a1e28 RD |
12730 | |
12731 | def CallAfter(callable, *args, **kw): | |
12732 | """ | |
12733 | Call the specified function after the current and pending event | |
12734 | handlers have been completed. This is also good for making GUI | |
61863841 RD |
12735 | method calls from non-GUI threads. Any extra positional or |
12736 | keyword args are passed on to the callable when it is called. | |
12737 | ||
12738 | :see: `wx.FutureCall` | |
d14a1e28 RD |
12739 | """ |
12740 | app = wx.GetApp() | |
dfbb5885 | 12741 | assert app is not None, 'No wx.App created yet' |
d14a1e28 | 12742 | |
148275d3 RD |
12743 | if not hasattr(app, "_CallAfterId"): |
12744 | app._CallAfterId = wx.NewEventType() | |
12745 | app.Connect(-1, -1, app._CallAfterId, | |
12746 | lambda event: event.callable(*event.args, **event.kw) ) | |
d14a1e28 | 12747 | evt = wx.PyEvent() |
148275d3 | 12748 | evt.SetEventType(app._CallAfterId) |
d14a1e28 RD |
12749 | evt.callable = callable |
12750 | evt.args = args | |
12751 | evt.kw = kw | |
12752 | wx.PostEvent(app, evt) | |
12753 | ||
d14a1e28 RD |
12754 | #---------------------------------------------------------------------------- |
12755 | ||
12756 | ||
12757 | class FutureCall: | |
12758 | """ | |
8ac8dba0 | 12759 | A convenience class for `wx.Timer`, that calls the given callable |
d14a1e28 RD |
12760 | object once after the given amount of milliseconds, passing any |
12761 | positional or keyword args. The return value of the callable is | |
61863841 | 12762 | availbale after it has been run with the `GetResult` method. |
d14a1e28 RD |
12763 | |
12764 | If you don't need to get the return value or restart the timer | |
12765 | then there is no need to hold a reference to this object. It will | |
12766 | hold a reference to itself while the timer is running (the timer | |
12767 | has a reference to self.Notify) but the cycle will be broken when | |
12768 | the timer completes, automatically cleaning up the wx.FutureCall | |
12769 | object. | |
61863841 RD |
12770 | |
12771 | :see: `wx.CallAfter` | |
d14a1e28 RD |
12772 | """ |
12773 | def __init__(self, millis, callable, *args, **kwargs): | |
12774 | self.millis = millis | |
12775 | self.callable = callable | |
12776 | self.SetArgs(*args, **kwargs) | |
12777 | self.runCount = 0 | |
4276dc52 | 12778 | self.running = False |
d14a1e28 RD |
12779 | self.hasRun = False |
12780 | self.result = None | |
12781 | self.timer = None | |
12782 | self.Start() | |
12783 | ||
12784 | def __del__(self): | |
12785 | self.Stop() | |
12786 | ||
12787 | ||
12788 | def Start(self, millis=None, *args, **kwargs): | |
12789 | """ | |
12790 | (Re)start the timer | |
12791 | """ | |
12792 | self.hasRun = False | |
12793 | if millis is not None: | |
12794 | self.millis = millis | |
12795 | if args or kwargs: | |
12796 | self.SetArgs(*args, **kwargs) | |
12797 | self.Stop() | |
12798 | self.timer = wx.PyTimer(self.Notify) | |
12799 | self.timer.Start(self.millis, wx.TIMER_ONE_SHOT) | |
4276dc52 | 12800 | self.running = True |
d14a1e28 RD |
12801 | Restart = Start |
12802 | ||
12803 | ||
12804 | def Stop(self): | |
12805 | """ | |
12806 | Stop and destroy the timer. | |
12807 | """ | |
12808 | if self.timer is not None: | |
12809 | self.timer.Stop() | |
12810 | self.timer = None | |
12811 | ||
12812 | ||
12813 | def GetInterval(self): | |
12814 | if self.timer is not None: | |
12815 | return self.timer.GetInterval() | |
12816 | else: | |
12817 | return 0 | |
12818 | ||
12819 | ||
12820 | def IsRunning(self): | |
12821 | return self.timer is not None and self.timer.IsRunning() | |
12822 | ||
12823 | ||
12824 | def SetArgs(self, *args, **kwargs): | |
12825 | """ | |
12826 | (Re)set the args passed to the callable object. This is | |
12827 | useful in conjunction with Restart if you want to schedule a | |
12828 | new call to the same callable object but with different | |
12829 | parameters. | |
12830 | """ | |
12831 | self.args = args | |
12832 | self.kwargs = kwargs | |
12833 | ||
12834 | ||
12835 | def HasRun(self): | |
12836 | return self.hasRun | |
12837 | ||
12838 | def GetResult(self): | |
12839 | return self.result | |
12840 | ||
12841 | def Notify(self): | |
12842 | """ | |
12843 | The timer has expired so call the callable. | |
12844 | """ | |
12845 | if self.callable and getattr(self.callable, 'im_self', True): | |
12846 | self.runCount += 1 | |
4276dc52 | 12847 | self.running = False |
d14a1e28 RD |
12848 | self.result = self.callable(*self.args, **self.kwargs) |
12849 | self.hasRun = True | |
4276dc52 RD |
12850 | if not self.running: |
12851 | # if it wasn't restarted, then cleanup | |
12852 | wx.CallAfter(self.Stop) | |
d14a1e28 RD |
12853 | |
12854 | ||
a95a7133 RD |
12855 | |
12856 | #---------------------------------------------------------------------------- | |
12857 | # Control which items in this module should be documented by epydoc. | |
12858 | # We allow only classes and functions, which will help reduce the size | |
12859 | # of the docs by filtering out the zillions of constants, EVT objects, | |
12860 | # and etc that don't make much sense by themselves, but are instead | |
12861 | # documented (or will be) as part of the classes/functions/methods | |
12862 | # where they should be used. | |
12863 | ||
66c033b4 RD |
12864 | class __DocFilter: |
12865 | """ | |
12866 | A filter for epydoc that only allows non-Ptr classes and | |
12867 | fucntions, in order to reduce the clutter in the API docs. | |
12868 | """ | |
12869 | def __init__(self, globals): | |
12870 | self._globals = globals | |
12871 | ||
12872 | def __call__(self, name): | |
12873 | import types | |
12874 | obj = self._globals.get(name, None) | |
12875 | if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]: | |
12876 | return False | |
0085ce49 | 12877 | if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') : |
66c033b4 RD |
12878 | return False |
12879 | return True | |
a95a7133 | 12880 | |
d14a1e28 RD |
12881 | #---------------------------------------------------------------------------- |
12882 | #---------------------------------------------------------------------------- | |
12883 | ||
12884 | # Import other modules in this package that should show up in the | |
12885 | # "core" wx namespace | |
54f9ee45 RD |
12886 | from _gdi import * |
12887 | from _windows import * | |
12888 | from _controls import * | |
12889 | from _misc import * | |
d14a1e28 RD |
12890 | |
12891 | #---------------------------------------------------------------------------- | |
12892 | #---------------------------------------------------------------------------- | |
12893 | ||
12894 | ||
32fe5131 | 12895 |