]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/msw/_misc.py
test for special keys first, before testing for alphanumeric ones as even keys such...
[wxWidgets.git] / wxPython / src / msw / _misc.py
1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
3
4 import _misc_
5 import new
6 new_instancemethod = new.instancemethod
7 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
8 if (name == "thisown"): return self.this.own(value)
9 if (name == "this"):
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
15 if (not static) or hasattr(self,name):
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):
24 if (name == "thisown"): return self.this.own()
25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
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
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):
46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
54 import _core
55 wx = _core
56 #---------------------------------------------------------------------------
57
58 SYS_OEM_FIXED_FONT = _misc_.SYS_OEM_FIXED_FONT
59 SYS_ANSI_FIXED_FONT = _misc_.SYS_ANSI_FIXED_FONT
60 SYS_ANSI_VAR_FONT = _misc_.SYS_ANSI_VAR_FONT
61 SYS_SYSTEM_FONT = _misc_.SYS_SYSTEM_FONT
62 SYS_DEVICE_DEFAULT_FONT = _misc_.SYS_DEVICE_DEFAULT_FONT
63 SYS_DEFAULT_PALETTE = _misc_.SYS_DEFAULT_PALETTE
64 SYS_SYSTEM_FIXED_FONT = _misc_.SYS_SYSTEM_FIXED_FONT
65 SYS_DEFAULT_GUI_FONT = _misc_.SYS_DEFAULT_GUI_FONT
66 SYS_ICONTITLE_FONT = _misc_.SYS_ICONTITLE_FONT
67 SYS_COLOUR_SCROLLBAR = _misc_.SYS_COLOUR_SCROLLBAR
68 SYS_COLOUR_BACKGROUND = _misc_.SYS_COLOUR_BACKGROUND
69 SYS_COLOUR_DESKTOP = _misc_.SYS_COLOUR_DESKTOP
70 SYS_COLOUR_ACTIVECAPTION = _misc_.SYS_COLOUR_ACTIVECAPTION
71 SYS_COLOUR_INACTIVECAPTION = _misc_.SYS_COLOUR_INACTIVECAPTION
72 SYS_COLOUR_MENU = _misc_.SYS_COLOUR_MENU
73 SYS_COLOUR_WINDOW = _misc_.SYS_COLOUR_WINDOW
74 SYS_COLOUR_WINDOWFRAME = _misc_.SYS_COLOUR_WINDOWFRAME
75 SYS_COLOUR_MENUTEXT = _misc_.SYS_COLOUR_MENUTEXT
76 SYS_COLOUR_WINDOWTEXT = _misc_.SYS_COLOUR_WINDOWTEXT
77 SYS_COLOUR_CAPTIONTEXT = _misc_.SYS_COLOUR_CAPTIONTEXT
78 SYS_COLOUR_ACTIVEBORDER = _misc_.SYS_COLOUR_ACTIVEBORDER
79 SYS_COLOUR_INACTIVEBORDER = _misc_.SYS_COLOUR_INACTIVEBORDER
80 SYS_COLOUR_APPWORKSPACE = _misc_.SYS_COLOUR_APPWORKSPACE
81 SYS_COLOUR_HIGHLIGHT = _misc_.SYS_COLOUR_HIGHLIGHT
82 SYS_COLOUR_HIGHLIGHTTEXT = _misc_.SYS_COLOUR_HIGHLIGHTTEXT
83 SYS_COLOUR_BTNFACE = _misc_.SYS_COLOUR_BTNFACE
84 SYS_COLOUR_3DFACE = _misc_.SYS_COLOUR_3DFACE
85 SYS_COLOUR_BTNSHADOW = _misc_.SYS_COLOUR_BTNSHADOW
86 SYS_COLOUR_3DSHADOW = _misc_.SYS_COLOUR_3DSHADOW
87 SYS_COLOUR_GRAYTEXT = _misc_.SYS_COLOUR_GRAYTEXT
88 SYS_COLOUR_BTNTEXT = _misc_.SYS_COLOUR_BTNTEXT
89 SYS_COLOUR_INACTIVECAPTIONTEXT = _misc_.SYS_COLOUR_INACTIVECAPTIONTEXT
90 SYS_COLOUR_BTNHIGHLIGHT = _misc_.SYS_COLOUR_BTNHIGHLIGHT
91 SYS_COLOUR_BTNHILIGHT = _misc_.SYS_COLOUR_BTNHILIGHT
92 SYS_COLOUR_3DHIGHLIGHT = _misc_.SYS_COLOUR_3DHIGHLIGHT
93 SYS_COLOUR_3DHILIGHT = _misc_.SYS_COLOUR_3DHILIGHT
94 SYS_COLOUR_3DDKSHADOW = _misc_.SYS_COLOUR_3DDKSHADOW
95 SYS_COLOUR_3DLIGHT = _misc_.SYS_COLOUR_3DLIGHT
96 SYS_COLOUR_INFOTEXT = _misc_.SYS_COLOUR_INFOTEXT
97 SYS_COLOUR_INFOBK = _misc_.SYS_COLOUR_INFOBK
98 SYS_COLOUR_LISTBOX = _misc_.SYS_COLOUR_LISTBOX
99 SYS_COLOUR_HOTLIGHT = _misc_.SYS_COLOUR_HOTLIGHT
100 SYS_COLOUR_GRADIENTACTIVECAPTION = _misc_.SYS_COLOUR_GRADIENTACTIVECAPTION
101 SYS_COLOUR_GRADIENTINACTIVECAPTION = _misc_.SYS_COLOUR_GRADIENTINACTIVECAPTION
102 SYS_COLOUR_MENUHILIGHT = _misc_.SYS_COLOUR_MENUHILIGHT
103 SYS_COLOUR_MENUBAR = _misc_.SYS_COLOUR_MENUBAR
104 SYS_COLOUR_MAX = _misc_.SYS_COLOUR_MAX
105 SYS_MOUSE_BUTTONS = _misc_.SYS_MOUSE_BUTTONS
106 SYS_BORDER_X = _misc_.SYS_BORDER_X
107 SYS_BORDER_Y = _misc_.SYS_BORDER_Y
108 SYS_CURSOR_X = _misc_.SYS_CURSOR_X
109 SYS_CURSOR_Y = _misc_.SYS_CURSOR_Y
110 SYS_DCLICK_X = _misc_.SYS_DCLICK_X
111 SYS_DCLICK_Y = _misc_.SYS_DCLICK_Y
112 SYS_DRAG_X = _misc_.SYS_DRAG_X
113 SYS_DRAG_Y = _misc_.SYS_DRAG_Y
114 SYS_EDGE_X = _misc_.SYS_EDGE_X
115 SYS_EDGE_Y = _misc_.SYS_EDGE_Y
116 SYS_HSCROLL_ARROW_X = _misc_.SYS_HSCROLL_ARROW_X
117 SYS_HSCROLL_ARROW_Y = _misc_.SYS_HSCROLL_ARROW_Y
118 SYS_HTHUMB_X = _misc_.SYS_HTHUMB_X
119 SYS_ICON_X = _misc_.SYS_ICON_X
120 SYS_ICON_Y = _misc_.SYS_ICON_Y
121 SYS_ICONSPACING_X = _misc_.SYS_ICONSPACING_X
122 SYS_ICONSPACING_Y = _misc_.SYS_ICONSPACING_Y
123 SYS_WINDOWMIN_X = _misc_.SYS_WINDOWMIN_X
124 SYS_WINDOWMIN_Y = _misc_.SYS_WINDOWMIN_Y
125 SYS_SCREEN_X = _misc_.SYS_SCREEN_X
126 SYS_SCREEN_Y = _misc_.SYS_SCREEN_Y
127 SYS_FRAMESIZE_X = _misc_.SYS_FRAMESIZE_X
128 SYS_FRAMESIZE_Y = _misc_.SYS_FRAMESIZE_Y
129 SYS_SMALLICON_X = _misc_.SYS_SMALLICON_X
130 SYS_SMALLICON_Y = _misc_.SYS_SMALLICON_Y
131 SYS_HSCROLL_Y = _misc_.SYS_HSCROLL_Y
132 SYS_VSCROLL_X = _misc_.SYS_VSCROLL_X
133 SYS_VSCROLL_ARROW_X = _misc_.SYS_VSCROLL_ARROW_X
134 SYS_VSCROLL_ARROW_Y = _misc_.SYS_VSCROLL_ARROW_Y
135 SYS_VTHUMB_Y = _misc_.SYS_VTHUMB_Y
136 SYS_CAPTION_Y = _misc_.SYS_CAPTION_Y
137 SYS_MENU_Y = _misc_.SYS_MENU_Y
138 SYS_NETWORK_PRESENT = _misc_.SYS_NETWORK_PRESENT
139 SYS_PENWINDOWS_PRESENT = _misc_.SYS_PENWINDOWS_PRESENT
140 SYS_SHOW_SOUNDS = _misc_.SYS_SHOW_SOUNDS
141 SYS_SWAP_BUTTONS = _misc_.SYS_SWAP_BUTTONS
142 SYS_CAN_DRAW_FRAME_DECORATIONS = _misc_.SYS_CAN_DRAW_FRAME_DECORATIONS
143 SYS_CAN_ICONIZE_FRAME = _misc_.SYS_CAN_ICONIZE_FRAME
144 SYS_TABLET_PRESENT = _misc_.SYS_TABLET_PRESENT
145 SYS_SCREEN_NONE = _misc_.SYS_SCREEN_NONE
146 SYS_SCREEN_TINY = _misc_.SYS_SCREEN_TINY
147 SYS_SCREEN_PDA = _misc_.SYS_SCREEN_PDA
148 SYS_SCREEN_SMALL = _misc_.SYS_SCREEN_SMALL
149 SYS_SCREEN_DESKTOP = _misc_.SYS_SCREEN_DESKTOP
150 class SystemSettings(object):
151 """Proxy of C++ SystemSettings class"""
152 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
153 def __init__(self): raise AttributeError, "No constructor defined"
154 __repr__ = _swig_repr
155 def GetColour(*args, **kwargs):
156 """GetColour(int index) -> Colour"""
157 return _misc_.SystemSettings_GetColour(*args, **kwargs)
158
159 GetColour = staticmethod(GetColour)
160 def GetFont(*args, **kwargs):
161 """GetFont(int index) -> Font"""
162 return _misc_.SystemSettings_GetFont(*args, **kwargs)
163
164 GetFont = staticmethod(GetFont)
165 def GetMetric(*args, **kwargs):
166 """GetMetric(int index, Window win=None) -> int"""
167 return _misc_.SystemSettings_GetMetric(*args, **kwargs)
168
169 GetMetric = staticmethod(GetMetric)
170 def HasFeature(*args, **kwargs):
171 """HasFeature(int index) -> bool"""
172 return _misc_.SystemSettings_HasFeature(*args, **kwargs)
173
174 HasFeature = staticmethod(HasFeature)
175 def GetScreenType(*args, **kwargs):
176 """GetScreenType() -> int"""
177 return _misc_.SystemSettings_GetScreenType(*args, **kwargs)
178
179 GetScreenType = staticmethod(GetScreenType)
180 def SetScreenType(*args, **kwargs):
181 """SetScreenType(int screen)"""
182 return _misc_.SystemSettings_SetScreenType(*args, **kwargs)
183
184 SetScreenType = staticmethod(SetScreenType)
185 _misc_.SystemSettings_swigregister(SystemSettings)
186
187 def SystemSettings_GetColour(*args, **kwargs):
188 """SystemSettings_GetColour(int index) -> Colour"""
189 return _misc_.SystemSettings_GetColour(*args, **kwargs)
190
191 def SystemSettings_GetFont(*args, **kwargs):
192 """SystemSettings_GetFont(int index) -> Font"""
193 return _misc_.SystemSettings_GetFont(*args, **kwargs)
194
195 def SystemSettings_GetMetric(*args, **kwargs):
196 """SystemSettings_GetMetric(int index, Window win=None) -> int"""
197 return _misc_.SystemSettings_GetMetric(*args, **kwargs)
198
199 def SystemSettings_HasFeature(*args, **kwargs):
200 """SystemSettings_HasFeature(int index) -> bool"""
201 return _misc_.SystemSettings_HasFeature(*args, **kwargs)
202
203 def SystemSettings_GetScreenType(*args):
204 """SystemSettings_GetScreenType() -> int"""
205 return _misc_.SystemSettings_GetScreenType(*args)
206
207 def SystemSettings_SetScreenType(*args, **kwargs):
208 """SystemSettings_SetScreenType(int screen)"""
209 return _misc_.SystemSettings_SetScreenType(*args, **kwargs)
210
211 class SystemOptions(_core.Object):
212 """Proxy of C++ SystemOptions class"""
213 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
214 __repr__ = _swig_repr
215 def __init__(self, *args, **kwargs):
216 """__init__(self) -> SystemOptions"""
217 _misc_.SystemOptions_swiginit(self,_misc_.new_SystemOptions(*args, **kwargs))
218 def SetOption(*args, **kwargs):
219 """SetOption(String name, String value)"""
220 return _misc_.SystemOptions_SetOption(*args, **kwargs)
221
222 SetOption = staticmethod(SetOption)
223 def SetOptionInt(*args, **kwargs):
224 """SetOptionInt(String name, int value)"""
225 return _misc_.SystemOptions_SetOptionInt(*args, **kwargs)
226
227 SetOptionInt = staticmethod(SetOptionInt)
228 def GetOption(*args, **kwargs):
229 """GetOption(String name) -> String"""
230 return _misc_.SystemOptions_GetOption(*args, **kwargs)
231
232 GetOption = staticmethod(GetOption)
233 def GetOptionInt(*args, **kwargs):
234 """GetOptionInt(String name) -> int"""
235 return _misc_.SystemOptions_GetOptionInt(*args, **kwargs)
236
237 GetOptionInt = staticmethod(GetOptionInt)
238 def HasOption(*args, **kwargs):
239 """HasOption(String name) -> bool"""
240 return _misc_.SystemOptions_HasOption(*args, **kwargs)
241
242 HasOption = staticmethod(HasOption)
243 def IsFalse(*args, **kwargs):
244 """IsFalse(String name) -> bool"""
245 return _misc_.SystemOptions_IsFalse(*args, **kwargs)
246
247 IsFalse = staticmethod(IsFalse)
248 _misc_.SystemOptions_swigregister(SystemOptions)
249 cvar = _misc_.cvar
250 WINDOW_DEFAULT_VARIANT = cvar.WINDOW_DEFAULT_VARIANT
251
252 def SystemOptions_SetOption(*args, **kwargs):
253 """SystemOptions_SetOption(String name, String value)"""
254 return _misc_.SystemOptions_SetOption(*args, **kwargs)
255
256 def SystemOptions_SetOptionInt(*args, **kwargs):
257 """SystemOptions_SetOptionInt(String name, int value)"""
258 return _misc_.SystemOptions_SetOptionInt(*args, **kwargs)
259
260 def SystemOptions_GetOption(*args, **kwargs):
261 """SystemOptions_GetOption(String name) -> String"""
262 return _misc_.SystemOptions_GetOption(*args, **kwargs)
263
264 def SystemOptions_GetOptionInt(*args, **kwargs):
265 """SystemOptions_GetOptionInt(String name) -> int"""
266 return _misc_.SystemOptions_GetOptionInt(*args, **kwargs)
267
268 def SystemOptions_HasOption(*args, **kwargs):
269 """SystemOptions_HasOption(String name) -> bool"""
270 return _misc_.SystemOptions_HasOption(*args, **kwargs)
271
272 def SystemOptions_IsFalse(*args, **kwargs):
273 """SystemOptions_IsFalse(String name) -> bool"""
274 return _misc_.SystemOptions_IsFalse(*args, **kwargs)
275
276 #---------------------------------------------------------------------------
277
278
279 def NewId(*args):
280 """NewId() -> long"""
281 return _misc_.NewId(*args)
282
283 def RegisterId(*args, **kwargs):
284 """RegisterId(long id)"""
285 return _misc_.RegisterId(*args, **kwargs)
286
287 def GetCurrentId(*args):
288 """GetCurrentId() -> long"""
289 return _misc_.GetCurrentId(*args)
290
291 def IsStockID(*args, **kwargs):
292 """IsStockID(int id) -> bool"""
293 return _misc_.IsStockID(*args, **kwargs)
294
295 def IsStockLabel(*args, **kwargs):
296 """IsStockLabel(int id, String label) -> bool"""
297 return _misc_.IsStockLabel(*args, **kwargs)
298 STOCK_NOFLAGS = _misc_.STOCK_NOFLAGS
299 STOCK_WITH_MNEMONIC = _misc_.STOCK_WITH_MNEMONIC
300 STOCK_WITH_ACCELERATOR = _misc_.STOCK_WITH_ACCELERATOR
301
302 def GetStockLabel(*args, **kwargs):
303 """GetStockLabel(int id, long flags=STOCK_WITH_MNEMONIC) -> String"""
304 return _misc_.GetStockLabel(*args, **kwargs)
305 STOCK_MENU = _misc_.STOCK_MENU
306
307 def GetStockHelpString(*args, **kwargs):
308 """GetStockHelpString(int id, int client=STOCK_MENU) -> String"""
309 return _misc_.GetStockHelpString(*args, **kwargs)
310
311 def Bell(*args):
312 """Bell()"""
313 return _misc_.Bell(*args)
314
315 def EndBusyCursor(*args):
316 """EndBusyCursor()"""
317 return _misc_.EndBusyCursor(*args)
318
319 def GetElapsedTime(*args, **kwargs):
320 """GetElapsedTime(bool resetTimer=True) -> long"""
321 return _misc_.GetElapsedTime(*args, **kwargs)
322 GetElapsedTime = wx._deprecated(GetElapsedTime)
323
324 def IsBusy(*args):
325 """IsBusy() -> bool"""
326 return _misc_.IsBusy(*args)
327
328 def Now(*args):
329 """Now() -> String"""
330 return _misc_.Now(*args)
331
332 def Shell(*args, **kwargs):
333 """Shell(String command=EmptyString) -> bool"""
334 return _misc_.Shell(*args, **kwargs)
335
336 def StartTimer(*args):
337 """StartTimer()"""
338 return _misc_.StartTimer(*args)
339
340 def GetOsVersion(*args):
341 """GetOsVersion() -> (platform, major, minor)"""
342 return _misc_.GetOsVersion(*args)
343
344 def GetOsDescription(*args):
345 """GetOsDescription() -> String"""
346 return _misc_.GetOsDescription(*args)
347
348 def IsPlatformLittleEndian(*args):
349 """IsPlatformLittleEndian() -> bool"""
350 return _misc_.IsPlatformLittleEndian(*args)
351
352 def IsPlatform64Bit(*args):
353 """IsPlatform64Bit() -> bool"""
354 return _misc_.IsPlatform64Bit(*args)
355
356 def GetFreeMemory(*args):
357 """GetFreeMemory() -> wxMemorySize"""
358 return _misc_.GetFreeMemory(*args)
359 SHUTDOWN_POWEROFF = _misc_.SHUTDOWN_POWEROFF
360 SHUTDOWN_REBOOT = _misc_.SHUTDOWN_REBOOT
361
362 def Shutdown(*args, **kwargs):
363 """Shutdown(int wFlags) -> bool"""
364 return _misc_.Shutdown(*args, **kwargs)
365
366 def Sleep(*args, **kwargs):
367 """Sleep(int secs)"""
368 return _misc_.Sleep(*args, **kwargs)
369
370 def MilliSleep(*args, **kwargs):
371 """MilliSleep(unsigned long milliseconds)"""
372 return _misc_.MilliSleep(*args, **kwargs)
373
374 def MicroSleep(*args, **kwargs):
375 """MicroSleep(unsigned long microseconds)"""
376 return _misc_.MicroSleep(*args, **kwargs)
377 Usleep = MilliSleep
378
379 def EnableTopLevelWindows(*args, **kwargs):
380 """EnableTopLevelWindows(bool enable)"""
381 return _misc_.EnableTopLevelWindows(*args, **kwargs)
382
383 def StripMenuCodes(*args, **kwargs):
384 """StripMenuCodes(String in) -> String"""
385 return _misc_.StripMenuCodes(*args, **kwargs)
386
387 def GetEmailAddress(*args):
388 """GetEmailAddress() -> String"""
389 return _misc_.GetEmailAddress(*args)
390
391 def GetHostName(*args):
392 """GetHostName() -> String"""
393 return _misc_.GetHostName(*args)
394
395 def GetFullHostName(*args):
396 """GetFullHostName() -> String"""
397 return _misc_.GetFullHostName(*args)
398
399 def GetUserId(*args):
400 """GetUserId() -> String"""
401 return _misc_.GetUserId(*args)
402
403 def GetUserName(*args):
404 """GetUserName() -> String"""
405 return _misc_.GetUserName(*args)
406
407 def GetHomeDir(*args):
408 """GetHomeDir() -> String"""
409 return _misc_.GetHomeDir(*args)
410
411 def GetUserHome(*args, **kwargs):
412 """GetUserHome(String user=EmptyString) -> String"""
413 return _misc_.GetUserHome(*args, **kwargs)
414
415 def GetProcessId(*args):
416 """GetProcessId() -> unsigned long"""
417 return _misc_.GetProcessId(*args)
418
419 def Trap(*args):
420 """Trap()"""
421 return _misc_.Trap(*args)
422
423 def FileSelector(*args, **kwargs):
424 """
425 FileSelector(String message=FileSelectorPromptStr, String default_path=EmptyString,
426 String default_filename=EmptyString,
427 String default_extension=EmptyString,
428 String wildcard=FileSelectorDefaultWildcardStr,
429 int flags=0, Window parent=None, int x=-1,
430 int y=-1) -> String
431 """
432 return _misc_.FileSelector(*args, **kwargs)
433
434 def LoadFileSelector(*args, **kwargs):
435 """
436 LoadFileSelector(String what, String extension, String default_name=EmptyString,
437 Window parent=None) -> String
438 """
439 return _misc_.LoadFileSelector(*args, **kwargs)
440
441 def SaveFileSelector(*args, **kwargs):
442 """
443 SaveFileSelector(String what, String extension, String default_name=EmptyString,
444 Window parent=None) -> String
445 """
446 return _misc_.SaveFileSelector(*args, **kwargs)
447
448 def DirSelector(*args, **kwargs):
449 """
450 DirSelector(String message=DirSelectorPromptStr, String defaultPath=EmptyString,
451 long style=wxDD_DEFAULT_STYLE,
452 Point pos=DefaultPosition, Window parent=None) -> String
453 """
454 return _misc_.DirSelector(*args, **kwargs)
455
456 def GetTextFromUser(*args, **kwargs):
457 """
458 GetTextFromUser(String message, String caption=EmptyString, String default_value=EmptyString,
459 Window parent=None,
460 int x=-1, int y=-1, bool centre=True) -> String
461 """
462 return _misc_.GetTextFromUser(*args, **kwargs)
463
464 def GetPasswordFromUser(*args, **kwargs):
465 """
466 GetPasswordFromUser(String message, String caption=EmptyString, String default_value=EmptyString,
467 Window parent=None) -> String
468 """
469 return _misc_.GetPasswordFromUser(*args, **kwargs)
470
471 def GetSingleChoice(*args, **kwargs):
472 """
473 GetSingleChoice(String message, String caption, int choices, Window parent=None,
474 int x=-1, int y=-1, bool centre=True,
475 int width=150, int height=200) -> String
476 """
477 return _misc_.GetSingleChoice(*args, **kwargs)
478
479 def GetSingleChoiceIndex(*args, **kwargs):
480 """
481 GetSingleChoiceIndex(String message, String caption, int choices, Window parent=None,
482 int x=-1, int y=-1, bool centre=True,
483 int width=150, int height=200) -> int
484 """
485 return _misc_.GetSingleChoiceIndex(*args, **kwargs)
486
487 def MessageBox(*args, **kwargs):
488 """
489 MessageBox(String message, String caption=EmptyString, int style=wxOK|wxCENTRE,
490 Window parent=None, int x=-1,
491 int y=-1) -> int
492 """
493 return _misc_.MessageBox(*args, **kwargs)
494
495 def GetNumberFromUser(*args, **kwargs):
496 """
497 GetNumberFromUser(String message, String prompt, String caption, long value,
498 long min=0, long max=100, Window parent=None,
499 Point pos=DefaultPosition) -> long
500 """
501 return _misc_.GetNumberFromUser(*args, **kwargs)
502
503 def ColourDisplay(*args):
504 """ColourDisplay() -> bool"""
505 return _misc_.ColourDisplay(*args)
506
507 def DisplayDepth(*args):
508 """DisplayDepth() -> int"""
509 return _misc_.DisplayDepth(*args)
510
511 def GetDisplayDepth(*args):
512 """GetDisplayDepth() -> int"""
513 return _misc_.GetDisplayDepth(*args)
514
515 def DisplaySize(*args):
516 """DisplaySize() -> (width, height)"""
517 return _misc_.DisplaySize(*args)
518
519 def GetDisplaySize(*args):
520 """GetDisplaySize() -> Size"""
521 return _misc_.GetDisplaySize(*args)
522
523 def DisplaySizeMM(*args):
524 """DisplaySizeMM() -> (width, height)"""
525 return _misc_.DisplaySizeMM(*args)
526
527 def GetDisplaySizeMM(*args):
528 """GetDisplaySizeMM() -> Size"""
529 return _misc_.GetDisplaySizeMM(*args)
530
531 def ClientDisplayRect(*args):
532 """ClientDisplayRect() -> (x, y, width, height)"""
533 return _misc_.ClientDisplayRect(*args)
534
535 def GetClientDisplayRect(*args):
536 """GetClientDisplayRect() -> Rect"""
537 return _misc_.GetClientDisplayRect(*args)
538
539 def SetCursor(*args, **kwargs):
540 """SetCursor(Cursor cursor)"""
541 return _misc_.SetCursor(*args, **kwargs)
542
543 def GetXDisplay(*args):
544 """
545 GetXDisplay() -> void
546
547 Returns a swigified pointer to the X11 display. Returns None on
548 other platforms.
549 """
550 return _misc_.GetXDisplay(*args)
551
552 def BeginBusyCursor(*args, **kwargs):
553 """BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR)"""
554 return _misc_.BeginBusyCursor(*args, **kwargs)
555
556 def GetMousePosition(*args):
557 """
558 GetMousePosition() -> Point
559
560 Get the current mouse position on the screen.
561 """
562 return _misc_.GetMousePosition(*args)
563
564 def FindWindowAtPointer(*args):
565 """
566 FindWindowAtPointer() -> Window
567
568 Returns the window currently under the mouse pointer, if it belongs to
569 this application. Otherwise it returns None.
570 """
571 return _misc_.FindWindowAtPointer(*args)
572
573 def GetActiveWindow(*args):
574 """
575 GetActiveWindow() -> Window
576
577 Get the currently active window of this application, or None
578 """
579 return _misc_.GetActiveWindow(*args)
580
581 def GenericFindWindowAtPoint(*args, **kwargs):
582 """GenericFindWindowAtPoint(Point pt) -> Window"""
583 return _misc_.GenericFindWindowAtPoint(*args, **kwargs)
584
585 def FindWindowAtPoint(*args, **kwargs):
586 """FindWindowAtPoint(Point pt) -> Window"""
587 return _misc_.FindWindowAtPoint(*args, **kwargs)
588
589 def GetTopLevelParent(*args, **kwargs):
590 """GetTopLevelParent(Window win) -> Window"""
591 return _misc_.GetTopLevelParent(*args, **kwargs)
592
593 def LaunchDefaultBrowser(*args, **kwargs):
594 """
595 LaunchDefaultBrowser(String url) -> bool
596
597 Launches the user's default browser and tells it to open the location
598 at ``url``. Returns ``True`` if the application was successfully
599 launched.
600 """
601 return _misc_.LaunchDefaultBrowser(*args, **kwargs)
602
603 def GetKeyState(*args, **kwargs):
604 """
605 GetKeyState(int key) -> bool
606
607 Get the state of a key (true if pressed or toggled on, false if not.)
608 This is generally most useful getting the state of the modifier or
609 toggle keys. On some platforms those may be the only keys that this
610 function is able to detect.
611
612 """
613 return _misc_.GetKeyState(*args, **kwargs)
614 class MouseState(object):
615 """
616 `wx.MouseState` is used to hold information about mouse button and
617 modifier key states and is what is returned from `wx.GetMouseState`.
618 """
619 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
620 __repr__ = _swig_repr
621 def __init__(self, *args, **kwargs):
622 """
623 __init__(self) -> MouseState
624
625 `wx.MouseState` is used to hold information about mouse button and
626 modifier key states and is what is returned from `wx.GetMouseState`.
627 """
628 _misc_.MouseState_swiginit(self,_misc_.new_MouseState(*args, **kwargs))
629 __swig_destroy__ = _misc_.delete_MouseState
630 __del__ = lambda self : None;
631 def GetX(*args, **kwargs):
632 """GetX(self) -> int"""
633 return _misc_.MouseState_GetX(*args, **kwargs)
634
635 def GetY(*args, **kwargs):
636 """GetY(self) -> int"""
637 return _misc_.MouseState_GetY(*args, **kwargs)
638
639 def LeftDown(*args, **kwargs):
640 """LeftDown(self) -> bool"""
641 return _misc_.MouseState_LeftDown(*args, **kwargs)
642
643 def MiddleDown(*args, **kwargs):
644 """MiddleDown(self) -> bool"""
645 return _misc_.MouseState_MiddleDown(*args, **kwargs)
646
647 def RightDown(*args, **kwargs):
648 """RightDown(self) -> bool"""
649 return _misc_.MouseState_RightDown(*args, **kwargs)
650
651 def ControlDown(*args, **kwargs):
652 """ControlDown(self) -> bool"""
653 return _misc_.MouseState_ControlDown(*args, **kwargs)
654
655 def ShiftDown(*args, **kwargs):
656 """ShiftDown(self) -> bool"""
657 return _misc_.MouseState_ShiftDown(*args, **kwargs)
658
659 def AltDown(*args, **kwargs):
660 """AltDown(self) -> bool"""
661 return _misc_.MouseState_AltDown(*args, **kwargs)
662
663 def MetaDown(*args, **kwargs):
664 """MetaDown(self) -> bool"""
665 return _misc_.MouseState_MetaDown(*args, **kwargs)
666
667 def CmdDown(*args, **kwargs):
668 """CmdDown(self) -> bool"""
669 return _misc_.MouseState_CmdDown(*args, **kwargs)
670
671 def SetX(*args, **kwargs):
672 """SetX(self, int x)"""
673 return _misc_.MouseState_SetX(*args, **kwargs)
674
675 def SetY(*args, **kwargs):
676 """SetY(self, int y)"""
677 return _misc_.MouseState_SetY(*args, **kwargs)
678
679 def SetLeftDown(*args, **kwargs):
680 """SetLeftDown(self, bool down)"""
681 return _misc_.MouseState_SetLeftDown(*args, **kwargs)
682
683 def SetMiddleDown(*args, **kwargs):
684 """SetMiddleDown(self, bool down)"""
685 return _misc_.MouseState_SetMiddleDown(*args, **kwargs)
686
687 def SetRightDown(*args, **kwargs):
688 """SetRightDown(self, bool down)"""
689 return _misc_.MouseState_SetRightDown(*args, **kwargs)
690
691 def SetControlDown(*args, **kwargs):
692 """SetControlDown(self, bool down)"""
693 return _misc_.MouseState_SetControlDown(*args, **kwargs)
694
695 def SetShiftDown(*args, **kwargs):
696 """SetShiftDown(self, bool down)"""
697 return _misc_.MouseState_SetShiftDown(*args, **kwargs)
698
699 def SetAltDown(*args, **kwargs):
700 """SetAltDown(self, bool down)"""
701 return _misc_.MouseState_SetAltDown(*args, **kwargs)
702
703 def SetMetaDown(*args, **kwargs):
704 """SetMetaDown(self, bool down)"""
705 return _misc_.MouseState_SetMetaDown(*args, **kwargs)
706
707 x = property(GetX, SetX)
708 y = property(GetY, SetY)
709 leftDown = property(LeftDown, SetLeftDown)
710 middleDown = property(MiddleDown, SetMiddleDown)
711 rightDown = property(RightDown, SetRightDown)
712 controlDown = property(ControlDown, SetControlDown)
713 shiftDown = property(ShiftDown, SetShiftDown)
714 altDown = property(AltDown, SetAltDown)
715 metaDown = property(MetaDown, SetMetaDown)
716 cmdDown = property(CmdDown)
717
718 _misc_.MouseState_swigregister(MouseState)
719 FileSelectorPromptStr = cvar.FileSelectorPromptStr
720 FileSelectorDefaultWildcardStr = cvar.FileSelectorDefaultWildcardStr
721 DirSelectorPromptStr = cvar.DirSelectorPromptStr
722
723
724 def GetMouseState(*args):
725 """
726 GetMouseState() -> MouseState
727
728 Returns the current state of the mouse. Returns an instance of a
729 `wx.MouseState` object that contains the current position of the mouse
730 pointer in screen coordinants, as well as boolean values indicating
731 the up/down status of the mouse buttons and the modifier keys.
732 """
733 return _misc_.GetMouseState(*args)
734
735 def WakeUpMainThread(*args):
736 """WakeUpMainThread()"""
737 return _misc_.WakeUpMainThread(*args)
738
739 def MutexGuiEnter(*args):
740 """MutexGuiEnter()"""
741 return _misc_.MutexGuiEnter(*args)
742
743 def MutexGuiLeave(*args):
744 """MutexGuiLeave()"""
745 return _misc_.MutexGuiLeave(*args)
746 class MutexGuiLocker(object):
747 """Proxy of C++ MutexGuiLocker class"""
748 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
749 __repr__ = _swig_repr
750 def __init__(self, *args, **kwargs):
751 """__init__(self) -> MutexGuiLocker"""
752 _misc_.MutexGuiLocker_swiginit(self,_misc_.new_MutexGuiLocker(*args, **kwargs))
753 __swig_destroy__ = _misc_.delete_MutexGuiLocker
754 __del__ = lambda self : None;
755 _misc_.MutexGuiLocker_swigregister(MutexGuiLocker)
756
757
758 def Thread_IsMain(*args):
759 """Thread_IsMain() -> bool"""
760 return _misc_.Thread_IsMain(*args)
761 #---------------------------------------------------------------------------
762
763 class ToolTip(_core.Object):
764 """Proxy of C++ ToolTip class"""
765 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
766 __repr__ = _swig_repr
767 def __init__(self, *args, **kwargs):
768 """__init__(self, String tip) -> ToolTip"""
769 _misc_.ToolTip_swiginit(self,_misc_.new_ToolTip(*args, **kwargs))
770 __swig_destroy__ = _misc_.delete_ToolTip
771 __del__ = lambda self : None;
772 def SetTip(*args, **kwargs):
773 """SetTip(self, String tip)"""
774 return _misc_.ToolTip_SetTip(*args, **kwargs)
775
776 def GetTip(*args, **kwargs):
777 """GetTip(self) -> String"""
778 return _misc_.ToolTip_GetTip(*args, **kwargs)
779
780 def GetWindow(*args, **kwargs):
781 """GetWindow(self) -> Window"""
782 return _misc_.ToolTip_GetWindow(*args, **kwargs)
783
784 def Enable(*args, **kwargs):
785 """Enable(bool flag)"""
786 return _misc_.ToolTip_Enable(*args, **kwargs)
787
788 Enable = staticmethod(Enable)
789 def SetDelay(*args, **kwargs):
790 """SetDelay(long milliseconds)"""
791 return _misc_.ToolTip_SetDelay(*args, **kwargs)
792
793 SetDelay = staticmethod(SetDelay)
794 Tip = property(GetTip,SetTip,doc="See `GetTip` and `SetTip`")
795 Window = property(GetWindow,doc="See `GetWindow`")
796 _misc_.ToolTip_swigregister(ToolTip)
797
798 def ToolTip_Enable(*args, **kwargs):
799 """ToolTip_Enable(bool flag)"""
800 return _misc_.ToolTip_Enable(*args, **kwargs)
801
802 def ToolTip_SetDelay(*args, **kwargs):
803 """ToolTip_SetDelay(long milliseconds)"""
804 return _misc_.ToolTip_SetDelay(*args, **kwargs)
805
806 class Caret(object):
807 """Proxy of C++ Caret class"""
808 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
809 __repr__ = _swig_repr
810 def __init__(self, *args, **kwargs):
811 """__init__(self, Window window, Size size) -> Caret"""
812 _misc_.Caret_swiginit(self,_misc_.new_Caret(*args, **kwargs))
813 __swig_destroy__ = _misc_.delete_Caret
814 __del__ = lambda self : None;
815 def Destroy(*args, **kwargs):
816 """
817 Destroy(self)
818
819 Deletes the C++ object this Python object is a proxy for.
820 """
821 args[0].this.own(False)
822 return _misc_.Caret_Destroy(*args, **kwargs)
823
824 def IsOk(*args, **kwargs):
825 """IsOk(self) -> bool"""
826 return _misc_.Caret_IsOk(*args, **kwargs)
827
828 def IsVisible(*args, **kwargs):
829 """IsVisible(self) -> bool"""
830 return _misc_.Caret_IsVisible(*args, **kwargs)
831
832 def GetPosition(*args, **kwargs):
833 """GetPosition(self) -> Point"""
834 return _misc_.Caret_GetPosition(*args, **kwargs)
835
836 def GetPositionTuple(*args, **kwargs):
837 """GetPositionTuple() -> (x,y)"""
838 return _misc_.Caret_GetPositionTuple(*args, **kwargs)
839
840 def GetSize(*args, **kwargs):
841 """GetSize(self) -> Size"""
842 return _misc_.Caret_GetSize(*args, **kwargs)
843
844 def GetSizeTuple(*args, **kwargs):
845 """GetSizeTuple() -> (width, height)"""
846 return _misc_.Caret_GetSizeTuple(*args, **kwargs)
847
848 def GetWindow(*args, **kwargs):
849 """GetWindow(self) -> Window"""
850 return _misc_.Caret_GetWindow(*args, **kwargs)
851
852 def MoveXY(*args, **kwargs):
853 """MoveXY(self, int x, int y)"""
854 return _misc_.Caret_MoveXY(*args, **kwargs)
855
856 def Move(*args, **kwargs):
857 """Move(self, Point pt)"""
858 return _misc_.Caret_Move(*args, **kwargs)
859
860 def SetSizeWH(*args, **kwargs):
861 """SetSizeWH(self, int width, int height)"""
862 return _misc_.Caret_SetSizeWH(*args, **kwargs)
863
864 def SetSize(*args, **kwargs):
865 """SetSize(self, Size size)"""
866 return _misc_.Caret_SetSize(*args, **kwargs)
867
868 def Show(*args, **kwargs):
869 """Show(self, int show=True)"""
870 return _misc_.Caret_Show(*args, **kwargs)
871
872 def Hide(*args, **kwargs):
873 """Hide(self)"""
874 return _misc_.Caret_Hide(*args, **kwargs)
875
876 def __nonzero__(self): return self.IsOk()
877 def GetBlinkTime(*args, **kwargs):
878 """GetBlinkTime() -> int"""
879 return _misc_.Caret_GetBlinkTime(*args, **kwargs)
880
881 GetBlinkTime = staticmethod(GetBlinkTime)
882 def SetBlinkTime(*args, **kwargs):
883 """SetBlinkTime(int milliseconds)"""
884 return _misc_.Caret_SetBlinkTime(*args, **kwargs)
885
886 SetBlinkTime = staticmethod(SetBlinkTime)
887 Position = property(GetPosition,doc="See `GetPosition`")
888 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
889 Window = property(GetWindow,doc="See `GetWindow`")
890 _misc_.Caret_swigregister(Caret)
891
892 def Caret_GetBlinkTime(*args):
893 """Caret_GetBlinkTime() -> int"""
894 return _misc_.Caret_GetBlinkTime(*args)
895
896 def Caret_SetBlinkTime(*args, **kwargs):
897 """Caret_SetBlinkTime(int milliseconds)"""
898 return _misc_.Caret_SetBlinkTime(*args, **kwargs)
899
900 class BusyCursor(object):
901 """Proxy of C++ BusyCursor class"""
902 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
903 __repr__ = _swig_repr
904 def __init__(self, *args, **kwargs):
905 """__init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor"""
906 _misc_.BusyCursor_swiginit(self,_misc_.new_BusyCursor(*args, **kwargs))
907 __swig_destroy__ = _misc_.delete_BusyCursor
908 __del__ = lambda self : None;
909 _misc_.BusyCursor_swigregister(BusyCursor)
910
911 class WindowDisabler(object):
912 """Proxy of C++ WindowDisabler class"""
913 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
914 __repr__ = _swig_repr
915 def __init__(self, *args, **kwargs):
916 """__init__(self, Window winToSkip=None) -> WindowDisabler"""
917 _misc_.WindowDisabler_swiginit(self,_misc_.new_WindowDisabler(*args, **kwargs))
918 __swig_destroy__ = _misc_.delete_WindowDisabler
919 __del__ = lambda self : None;
920 _misc_.WindowDisabler_swigregister(WindowDisabler)
921
922 class BusyInfo(_core.Object):
923 """Proxy of C++ BusyInfo class"""
924 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
925 __repr__ = _swig_repr
926 def __init__(self, *args, **kwargs):
927 """__init__(self, String message, Window parent=None) -> BusyInfo"""
928 _misc_.BusyInfo_swiginit(self,_misc_.new_BusyInfo(*args, **kwargs))
929 __swig_destroy__ = _misc_.delete_BusyInfo
930 __del__ = lambda self : None;
931 def Destroy(self): pass
932 _misc_.BusyInfo_swigregister(BusyInfo)
933
934 class StopWatch(object):
935 """Proxy of C++ StopWatch class"""
936 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
937 __repr__ = _swig_repr
938 def __init__(self, *args, **kwargs):
939 """__init__(self) -> StopWatch"""
940 _misc_.StopWatch_swiginit(self,_misc_.new_StopWatch(*args, **kwargs))
941 __swig_destroy__ = _misc_.delete_StopWatch
942 __del__ = lambda self : None;
943 def Start(*args, **kwargs):
944 """Start(self, long t0=0)"""
945 return _misc_.StopWatch_Start(*args, **kwargs)
946
947 def Pause(*args, **kwargs):
948 """Pause(self)"""
949 return _misc_.StopWatch_Pause(*args, **kwargs)
950
951 def Resume(*args, **kwargs):
952 """Resume(self)"""
953 return _misc_.StopWatch_Resume(*args, **kwargs)
954
955 def Time(*args, **kwargs):
956 """Time(self) -> long"""
957 return _misc_.StopWatch_Time(*args, **kwargs)
958
959 _misc_.StopWatch_swigregister(StopWatch)
960
961 class FileHistory(_core.Object):
962 """Proxy of C++ FileHistory class"""
963 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
964 __repr__ = _swig_repr
965 def __init__(self, *args, **kwargs):
966 """__init__(self, int maxFiles=9, int idBase=ID_FILE1) -> FileHistory"""
967 _misc_.FileHistory_swiginit(self,_misc_.new_FileHistory(*args, **kwargs))
968 __swig_destroy__ = _misc_.delete_FileHistory
969 __del__ = lambda self : None;
970 def AddFileToHistory(*args, **kwargs):
971 """AddFileToHistory(self, String file)"""
972 return _misc_.FileHistory_AddFileToHistory(*args, **kwargs)
973
974 def RemoveFileFromHistory(*args, **kwargs):
975 """RemoveFileFromHistory(self, int i)"""
976 return _misc_.FileHistory_RemoveFileFromHistory(*args, **kwargs)
977
978 def GetMaxFiles(*args, **kwargs):
979 """GetMaxFiles(self) -> int"""
980 return _misc_.FileHistory_GetMaxFiles(*args, **kwargs)
981
982 def UseMenu(*args, **kwargs):
983 """UseMenu(self, Menu menu)"""
984 return _misc_.FileHistory_UseMenu(*args, **kwargs)
985
986 def RemoveMenu(*args, **kwargs):
987 """RemoveMenu(self, Menu menu)"""
988 return _misc_.FileHistory_RemoveMenu(*args, **kwargs)
989
990 def Load(*args, **kwargs):
991 """Load(self, ConfigBase config)"""
992 return _misc_.FileHistory_Load(*args, **kwargs)
993
994 def Save(*args, **kwargs):
995 """Save(self, ConfigBase config)"""
996 return _misc_.FileHistory_Save(*args, **kwargs)
997
998 def AddFilesToMenu(*args, **kwargs):
999 """AddFilesToMenu(self)"""
1000 return _misc_.FileHistory_AddFilesToMenu(*args, **kwargs)
1001
1002 def AddFilesToThisMenu(*args, **kwargs):
1003 """AddFilesToThisMenu(self, Menu menu)"""
1004 return _misc_.FileHistory_AddFilesToThisMenu(*args, **kwargs)
1005
1006 def GetHistoryFile(*args, **kwargs):
1007 """GetHistoryFile(self, int i) -> String"""
1008 return _misc_.FileHistory_GetHistoryFile(*args, **kwargs)
1009
1010 def GetCount(*args, **kwargs):
1011 """GetCount(self) -> int"""
1012 return _misc_.FileHistory_GetCount(*args, **kwargs)
1013
1014 GetNoHistoryFiles = GetCount
1015 Count = property(GetCount,doc="See `GetCount`")
1016 HistoryFile = property(GetHistoryFile,doc="See `GetHistoryFile`")
1017 MaxFiles = property(GetMaxFiles,doc="See `GetMaxFiles`")
1018 NoHistoryFiles = property(GetNoHistoryFiles,doc="See `GetNoHistoryFiles`")
1019 _misc_.FileHistory_swigregister(FileHistory)
1020
1021 class SingleInstanceChecker(object):
1022 """Proxy of C++ SingleInstanceChecker class"""
1023 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1024 __repr__ = _swig_repr
1025 def __init__(self, *args, **kwargs):
1026 """__init__(self, String name, String path=EmptyString) -> SingleInstanceChecker"""
1027 _misc_.SingleInstanceChecker_swiginit(self,_misc_.new_SingleInstanceChecker(*args, **kwargs))
1028 __swig_destroy__ = _misc_.delete_SingleInstanceChecker
1029 __del__ = lambda self : None;
1030 def Create(*args, **kwargs):
1031 """Create(self, String name, String path=EmptyString) -> bool"""
1032 return _misc_.SingleInstanceChecker_Create(*args, **kwargs)
1033
1034 def IsAnotherRunning(*args, **kwargs):
1035 """IsAnotherRunning(self) -> bool"""
1036 return _misc_.SingleInstanceChecker_IsAnotherRunning(*args, **kwargs)
1037
1038 _misc_.SingleInstanceChecker_swigregister(SingleInstanceChecker)
1039
1040 def PreSingleInstanceChecker(*args, **kwargs):
1041 """PreSingleInstanceChecker() -> SingleInstanceChecker"""
1042 val = _misc_.new_PreSingleInstanceChecker(*args, **kwargs)
1043 return val
1044
1045 #---------------------------------------------------------------------------
1046
1047 OS_UNKNOWN = _misc_.OS_UNKNOWN
1048 OS_MAC_OS = _misc_.OS_MAC_OS
1049 OS_MAC_OSX_DARWIN = _misc_.OS_MAC_OSX_DARWIN
1050 OS_MAC = _misc_.OS_MAC
1051 OS_WINDOWS_9X = _misc_.OS_WINDOWS_9X
1052 OS_WINDOWS_NT = _misc_.OS_WINDOWS_NT
1053 OS_WINDOWS_MICRO = _misc_.OS_WINDOWS_MICRO
1054 OS_WINDOWS_CE = _misc_.OS_WINDOWS_CE
1055 OS_WINDOWS = _misc_.OS_WINDOWS
1056 OS_UNIX_LINUX = _misc_.OS_UNIX_LINUX
1057 OS_UNIX_FREEBSD = _misc_.OS_UNIX_FREEBSD
1058 OS_UNIX_OPENBSD = _misc_.OS_UNIX_OPENBSD
1059 OS_UNIX_NETBSD = _misc_.OS_UNIX_NETBSD
1060 OS_UNIX_SOLARIS = _misc_.OS_UNIX_SOLARIS
1061 OS_UNIX_AIX = _misc_.OS_UNIX_AIX
1062 OS_UNIX_HPUX = _misc_.OS_UNIX_HPUX
1063 OS_UNIX = _misc_.OS_UNIX
1064 OS_DOS = _misc_.OS_DOS
1065 OS_OS2 = _misc_.OS_OS2
1066 PORT_UNKNOWN = _misc_.PORT_UNKNOWN
1067 PORT_BASE = _misc_.PORT_BASE
1068 PORT_MSW = _misc_.PORT_MSW
1069 PORT_MOTIF = _misc_.PORT_MOTIF
1070 PORT_GTK = _misc_.PORT_GTK
1071 PORT_MGL = _misc_.PORT_MGL
1072 PORT_X11 = _misc_.PORT_X11
1073 PORT_PM = _misc_.PORT_PM
1074 PORT_OS2 = _misc_.PORT_OS2
1075 PORT_MAC = _misc_.PORT_MAC
1076 PORT_COCOA = _misc_.PORT_COCOA
1077 PORT_WINCE = _misc_.PORT_WINCE
1078 PORT_PALMOS = _misc_.PORT_PALMOS
1079 PORT_DFB = _misc_.PORT_DFB
1080 ARCH_INVALID = _misc_.ARCH_INVALID
1081 ARCH_32 = _misc_.ARCH_32
1082 ARCH_64 = _misc_.ARCH_64
1083 ARCH_MAX = _misc_.ARCH_MAX
1084 ENDIAN_INVALID = _misc_.ENDIAN_INVALID
1085 ENDIAN_BIG = _misc_.ENDIAN_BIG
1086 ENDIAN_LITTLE = _misc_.ENDIAN_LITTLE
1087 ENDIAN_PDP = _misc_.ENDIAN_PDP
1088 ENDIAN_MAX = _misc_.ENDIAN_MAX
1089 class PlatformInformation(object):
1090 """Proxy of C++ PlatformInformation class"""
1091 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1092 __repr__ = _swig_repr
1093 def __init__(self, *args, **kwargs):
1094 """__init__(self) -> PlatformInformation"""
1095 _misc_.PlatformInformation_swiginit(self,_misc_.new_PlatformInformation(*args, **kwargs))
1096 def __eq__(*args, **kwargs):
1097 """__eq__(self, PlatformInformation t) -> bool"""
1098 return _misc_.PlatformInformation___eq__(*args, **kwargs)
1099
1100 def __ne__(*args, **kwargs):
1101 """__ne__(self, PlatformInformation t) -> bool"""
1102 return _misc_.PlatformInformation___ne__(*args, **kwargs)
1103
1104 def GetOSMajorVersion(*args, **kwargs):
1105 """GetOSMajorVersion(self) -> int"""
1106 return _misc_.PlatformInformation_GetOSMajorVersion(*args, **kwargs)
1107
1108 def GetOSMinorVersion(*args, **kwargs):
1109 """GetOSMinorVersion(self) -> int"""
1110 return _misc_.PlatformInformation_GetOSMinorVersion(*args, **kwargs)
1111
1112 def CheckOSVersion(*args, **kwargs):
1113 """CheckOSVersion(self, int major, int minor) -> bool"""
1114 return _misc_.PlatformInformation_CheckOSVersion(*args, **kwargs)
1115
1116 def GetToolkitMajorVersion(*args, **kwargs):
1117 """GetToolkitMajorVersion(self) -> int"""
1118 return _misc_.PlatformInformation_GetToolkitMajorVersion(*args, **kwargs)
1119
1120 def GetToolkitMinorVersion(*args, **kwargs):
1121 """GetToolkitMinorVersion(self) -> int"""
1122 return _misc_.PlatformInformation_GetToolkitMinorVersion(*args, **kwargs)
1123
1124 def CheckToolkitVersion(*args, **kwargs):
1125 """CheckToolkitVersion(self, int major, int minor) -> bool"""
1126 return _misc_.PlatformInformation_CheckToolkitVersion(*args, **kwargs)
1127
1128 def IsUsingUniversalWidgets(*args, **kwargs):
1129 """IsUsingUniversalWidgets(self) -> bool"""
1130 return _misc_.PlatformInformation_IsUsingUniversalWidgets(*args, **kwargs)
1131
1132 def GetOperatingSystemId(*args, **kwargs):
1133 """GetOperatingSystemId(self) -> int"""
1134 return _misc_.PlatformInformation_GetOperatingSystemId(*args, **kwargs)
1135
1136 def GetPortId(*args, **kwargs):
1137 """GetPortId(self) -> int"""
1138 return _misc_.PlatformInformation_GetPortId(*args, **kwargs)
1139
1140 def GetArchitecture(*args, **kwargs):
1141 """GetArchitecture(self) -> int"""
1142 return _misc_.PlatformInformation_GetArchitecture(*args, **kwargs)
1143
1144 def GetEndianness(*args, **kwargs):
1145 """GetEndianness(self) -> int"""
1146 return _misc_.PlatformInformation_GetEndianness(*args, **kwargs)
1147
1148 def GetOperatingSystemFamilyName(*args, **kwargs):
1149 """GetOperatingSystemFamilyName(self) -> String"""
1150 return _misc_.PlatformInformation_GetOperatingSystemFamilyName(*args, **kwargs)
1151
1152 def GetOperatingSystemIdName(*args, **kwargs):
1153 """GetOperatingSystemIdName(self) -> String"""
1154 return _misc_.PlatformInformation_GetOperatingSystemIdName(*args, **kwargs)
1155
1156 def GetPortIdName(*args, **kwargs):
1157 """GetPortIdName(self) -> String"""
1158 return _misc_.PlatformInformation_GetPortIdName(*args, **kwargs)
1159
1160 def GetPortIdShortName(*args, **kwargs):
1161 """GetPortIdShortName(self) -> String"""
1162 return _misc_.PlatformInformation_GetPortIdShortName(*args, **kwargs)
1163
1164 def GetArchName(*args, **kwargs):
1165 """GetArchName(self) -> String"""
1166 return _misc_.PlatformInformation_GetArchName(*args, **kwargs)
1167
1168 def GetEndiannessName(*args, **kwargs):
1169 """GetEndiannessName(self) -> String"""
1170 return _misc_.PlatformInformation_GetEndiannessName(*args, **kwargs)
1171
1172 def SetOSVersion(*args, **kwargs):
1173 """SetOSVersion(self, int major, int minor)"""
1174 return _misc_.PlatformInformation_SetOSVersion(*args, **kwargs)
1175
1176 def SetToolkitVersion(*args, **kwargs):
1177 """SetToolkitVersion(self, int major, int minor)"""
1178 return _misc_.PlatformInformation_SetToolkitVersion(*args, **kwargs)
1179
1180 def SetOperatingSystemId(*args, **kwargs):
1181 """SetOperatingSystemId(self, int n)"""
1182 return _misc_.PlatformInformation_SetOperatingSystemId(*args, **kwargs)
1183
1184 def SetPortId(*args, **kwargs):
1185 """SetPortId(self, int n)"""
1186 return _misc_.PlatformInformation_SetPortId(*args, **kwargs)
1187
1188 def SetArchitecture(*args, **kwargs):
1189 """SetArchitecture(self, int n)"""
1190 return _misc_.PlatformInformation_SetArchitecture(*args, **kwargs)
1191
1192 def SetEndianness(*args, **kwargs):
1193 """SetEndianness(self, int n)"""
1194 return _misc_.PlatformInformation_SetEndianness(*args, **kwargs)
1195
1196 def IsOk(*args, **kwargs):
1197 """IsOk(self) -> bool"""
1198 return _misc_.PlatformInformation_IsOk(*args, **kwargs)
1199
1200 ArchName = property(GetArchName,doc="See `GetArchName`")
1201 Architecture = property(GetArchitecture,SetArchitecture,doc="See `GetArchitecture` and `SetArchitecture`")
1202 Endianness = property(GetEndianness,SetEndianness,doc="See `GetEndianness` and `SetEndianness`")
1203 EndiannessName = property(GetEndiannessName,doc="See `GetEndiannessName`")
1204 OSMajorVersion = property(GetOSMajorVersion,doc="See `GetOSMajorVersion`")
1205 OSMinorVersion = property(GetOSMinorVersion,doc="See `GetOSMinorVersion`")
1206 OperatingSystemFamilyName = property(GetOperatingSystemFamilyName,doc="See `GetOperatingSystemFamilyName`")
1207 OperatingSystemId = property(GetOperatingSystemId,SetOperatingSystemId,doc="See `GetOperatingSystemId` and `SetOperatingSystemId`")
1208 OperatingSystemIdName = property(GetOperatingSystemIdName,doc="See `GetOperatingSystemIdName`")
1209 PortId = property(GetPortId,SetPortId,doc="See `GetPortId` and `SetPortId`")
1210 PortIdName = property(GetPortIdName,doc="See `GetPortIdName`")
1211 PortIdShortName = property(GetPortIdShortName,doc="See `GetPortIdShortName`")
1212 ToolkitMajorVersion = property(GetToolkitMajorVersion,doc="See `GetToolkitMajorVersion`")
1213 ToolkitMinorVersion = property(GetToolkitMinorVersion,doc="See `GetToolkitMinorVersion`")
1214 _misc_.PlatformInformation_swigregister(PlatformInformation)
1215
1216
1217 def DrawWindowOnDC(*args, **kwargs):
1218 """DrawWindowOnDC(Window window, DC dc) -> bool"""
1219 return _misc_.DrawWindowOnDC(*args, **kwargs)
1220 #---------------------------------------------------------------------------
1221
1222 class TipProvider(object):
1223 """Proxy of C++ TipProvider class"""
1224 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1225 def __init__(self): raise AttributeError, "No constructor defined"
1226 __repr__ = _swig_repr
1227 __swig_destroy__ = _misc_.delete_TipProvider
1228 __del__ = lambda self : None;
1229 def GetTip(*args, **kwargs):
1230 """GetTip(self) -> String"""
1231 return _misc_.TipProvider_GetTip(*args, **kwargs)
1232
1233 def GetCurrentTip(*args, **kwargs):
1234 """GetCurrentTip(self) -> size_t"""
1235 return _misc_.TipProvider_GetCurrentTip(*args, **kwargs)
1236
1237 def PreprocessTip(*args, **kwargs):
1238 """PreprocessTip(self, String tip) -> String"""
1239 return _misc_.TipProvider_PreprocessTip(*args, **kwargs)
1240
1241 CurrentTip = property(GetCurrentTip,doc="See `GetCurrentTip`")
1242 Tip = property(GetTip,doc="See `GetTip`")
1243 _misc_.TipProvider_swigregister(TipProvider)
1244
1245 class PyTipProvider(TipProvider):
1246 """Proxy of C++ PyTipProvider class"""
1247 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1248 __repr__ = _swig_repr
1249 def __init__(self, *args, **kwargs):
1250 """__init__(self, size_t currentTip) -> PyTipProvider"""
1251 _misc_.PyTipProvider_swiginit(self,_misc_.new_PyTipProvider(*args, **kwargs))
1252 PyTipProvider._setCallbackInfo(self, self, PyTipProvider)
1253
1254 def _setCallbackInfo(*args, **kwargs):
1255 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1256 return _misc_.PyTipProvider__setCallbackInfo(*args, **kwargs)
1257
1258 _misc_.PyTipProvider_swigregister(PyTipProvider)
1259
1260
1261 def ShowTip(*args, **kwargs):
1262 """ShowTip(Window parent, TipProvider tipProvider, bool showAtStartup=True) -> bool"""
1263 return _misc_.ShowTip(*args, **kwargs)
1264
1265 def CreateFileTipProvider(*args, **kwargs):
1266 """CreateFileTipProvider(String filename, size_t currentTip) -> TipProvider"""
1267 return _misc_.CreateFileTipProvider(*args, **kwargs)
1268 #---------------------------------------------------------------------------
1269
1270 TIMER_CONTINUOUS = _misc_.TIMER_CONTINUOUS
1271 TIMER_ONE_SHOT = _misc_.TIMER_ONE_SHOT
1272 wxEVT_TIMER = _misc_.wxEVT_TIMER
1273 class Timer(_core.EvtHandler):
1274 """Proxy of C++ Timer class"""
1275 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1276 __repr__ = _swig_repr
1277 def __init__(self, *args, **kwargs):
1278 """__init__(self, EvtHandler owner=None, int id=ID_ANY) -> Timer"""
1279 _misc_.Timer_swiginit(self,_misc_.new_Timer(*args, **kwargs))
1280 self._setOORInfo(self,0); self.this.own(True); Timer._setCallbackInfo(self, self, Timer)
1281
1282 __swig_destroy__ = _misc_.delete_Timer
1283 __del__ = lambda self : None;
1284 def _setCallbackInfo(*args, **kwargs):
1285 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)"""
1286 return _misc_.Timer__setCallbackInfo(*args, **kwargs)
1287
1288 def SetOwner(*args, **kwargs):
1289 """SetOwner(self, EvtHandler owner, int id=ID_ANY)"""
1290 return _misc_.Timer_SetOwner(*args, **kwargs)
1291
1292 def GetOwner(*args, **kwargs):
1293 """GetOwner(self) -> EvtHandler"""
1294 return _misc_.Timer_GetOwner(*args, **kwargs)
1295
1296 def Start(*args, **kwargs):
1297 """Start(self, int milliseconds=-1, bool oneShot=False) -> bool"""
1298 return _misc_.Timer_Start(*args, **kwargs)
1299
1300 def Stop(*args, **kwargs):
1301 """Stop(self)"""
1302 return _misc_.Timer_Stop(*args, **kwargs)
1303
1304 def Notify(*args, **kwargs):
1305 """Notify(self)"""
1306 return _misc_.Timer_Notify(*args, **kwargs)
1307
1308 def IsRunning(*args, **kwargs):
1309 """IsRunning(self) -> bool"""
1310 return _misc_.Timer_IsRunning(*args, **kwargs)
1311
1312 def GetInterval(*args, **kwargs):
1313 """GetInterval(self) -> int"""
1314 return _misc_.Timer_GetInterval(*args, **kwargs)
1315
1316 def GetId(*args, **kwargs):
1317 """GetId(self) -> int"""
1318 return _misc_.Timer_GetId(*args, **kwargs)
1319
1320 def IsOneShot(*args, **kwargs):
1321 """IsOneShot(self) -> bool"""
1322 return _misc_.Timer_IsOneShot(*args, **kwargs)
1323
1324 def Destroy(self):
1325 """NO-OP: Timers must be destroyed by normal reference counting"""
1326 pass
1327
1328 Id = property(GetId,doc="See `GetId`")
1329 Interval = property(GetInterval,doc="See `GetInterval`")
1330 Owner = property(GetOwner,SetOwner,doc="See `GetOwner` and `SetOwner`")
1331 _misc_.Timer_swigregister(Timer)
1332
1333 # For backwards compatibility with 2.4
1334 class PyTimer(Timer):
1335 def __init__(self, notify):
1336 Timer.__init__(self)
1337 self.notify = notify
1338
1339 def Notify(self):
1340 if self.notify:
1341 self.notify()
1342
1343
1344 EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
1345
1346
1347 class TimerEvent(_core.Event):
1348 """Proxy of C++ TimerEvent class"""
1349 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1350 __repr__ = _swig_repr
1351 def __init__(self, *args, **kwargs):
1352 """__init__(self, int timerid=0, int interval=0) -> TimerEvent"""
1353 _misc_.TimerEvent_swiginit(self,_misc_.new_TimerEvent(*args, **kwargs))
1354 def GetInterval(*args, **kwargs):
1355 """GetInterval(self) -> int"""
1356 return _misc_.TimerEvent_GetInterval(*args, **kwargs)
1357
1358 Interval = property(GetInterval,doc="See `GetInterval`")
1359 _misc_.TimerEvent_swigregister(TimerEvent)
1360
1361 class TimerRunner(object):
1362 """Proxy of C++ TimerRunner class"""
1363 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1364 __repr__ = _swig_repr
1365 def __init__(self, *args):
1366 """
1367 __init__(self, wxTimer timer) -> TimerRunner
1368 __init__(self, wxTimer timer, int milli, bool oneShot=False) -> TimerRunner
1369 """
1370 _misc_.TimerRunner_swiginit(self,_misc_.new_TimerRunner(*args))
1371 __swig_destroy__ = _misc_.delete_TimerRunner
1372 __del__ = lambda self : None;
1373 def Start(*args, **kwargs):
1374 """Start(self, int milli, bool oneShot=False)"""
1375 return _misc_.TimerRunner_Start(*args, **kwargs)
1376
1377 _misc_.TimerRunner_swigregister(TimerRunner)
1378
1379 #---------------------------------------------------------------------------
1380
1381 LOG_FatalError = _misc_.LOG_FatalError
1382 LOG_Error = _misc_.LOG_Error
1383 LOG_Warning = _misc_.LOG_Warning
1384 LOG_Message = _misc_.LOG_Message
1385 LOG_Status = _misc_.LOG_Status
1386 LOG_Info = _misc_.LOG_Info
1387 LOG_Debug = _misc_.LOG_Debug
1388 LOG_Trace = _misc_.LOG_Trace
1389 LOG_Progress = _misc_.LOG_Progress
1390 LOG_User = _misc_.LOG_User
1391 LOG_Max = _misc_.LOG_Max
1392 TRACE_MemAlloc = _misc_.TRACE_MemAlloc
1393 TRACE_Messages = _misc_.TRACE_Messages
1394 TRACE_ResAlloc = _misc_.TRACE_ResAlloc
1395 TRACE_RefCount = _misc_.TRACE_RefCount
1396 TRACE_OleCalls = _misc_.TRACE_OleCalls
1397 TraceMemAlloc = _misc_.TraceMemAlloc
1398 TraceMessages = _misc_.TraceMessages
1399 TraceResAlloc = _misc_.TraceResAlloc
1400 TraceRefCount = _misc_.TraceRefCount
1401 TraceOleCalls = _misc_.TraceOleCalls
1402 class Log(object):
1403 """Proxy of C++ Log class"""
1404 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1405 __repr__ = _swig_repr
1406 def __init__(self, *args, **kwargs):
1407 """__init__(self) -> Log"""
1408 _misc_.Log_swiginit(self,_misc_.new_Log(*args, **kwargs))
1409 __swig_destroy__ = _misc_.delete_Log
1410 __del__ = lambda self : None;
1411 def IsEnabled(*args, **kwargs):
1412 """IsEnabled() -> bool"""
1413 return _misc_.Log_IsEnabled(*args, **kwargs)
1414
1415 IsEnabled = staticmethod(IsEnabled)
1416 def EnableLogging(*args, **kwargs):
1417 """EnableLogging(bool doIt=True) -> bool"""
1418 return _misc_.Log_EnableLogging(*args, **kwargs)
1419
1420 EnableLogging = staticmethod(EnableLogging)
1421 def OnLog(*args, **kwargs):
1422 """OnLog(LogLevel level, wxChar szString, time_t t)"""
1423 return _misc_.Log_OnLog(*args, **kwargs)
1424
1425 OnLog = staticmethod(OnLog)
1426 def Flush(*args, **kwargs):
1427 """Flush(self)"""
1428 return _misc_.Log_Flush(*args, **kwargs)
1429
1430 def FlushActive(*args, **kwargs):
1431 """FlushActive()"""
1432 return _misc_.Log_FlushActive(*args, **kwargs)
1433
1434 FlushActive = staticmethod(FlushActive)
1435 def GetActiveTarget(*args, **kwargs):
1436 """GetActiveTarget() -> Log"""
1437 return _misc_.Log_GetActiveTarget(*args, **kwargs)
1438
1439 GetActiveTarget = staticmethod(GetActiveTarget)
1440 def SetActiveTarget(*args, **kwargs):
1441 """SetActiveTarget(Log pLogger) -> Log"""
1442 return _misc_.Log_SetActiveTarget(*args, **kwargs)
1443
1444 SetActiveTarget = staticmethod(SetActiveTarget)
1445 def Suspend(*args, **kwargs):
1446 """Suspend()"""
1447 return _misc_.Log_Suspend(*args, **kwargs)
1448
1449 Suspend = staticmethod(Suspend)
1450 def Resume(*args, **kwargs):
1451 """Resume()"""
1452 return _misc_.Log_Resume(*args, **kwargs)
1453
1454 Resume = staticmethod(Resume)
1455 def SetVerbose(*args, **kwargs):
1456 """SetVerbose(bool bVerbose=True)"""
1457 return _misc_.Log_SetVerbose(*args, **kwargs)
1458
1459 SetVerbose = staticmethod(SetVerbose)
1460 def SetLogLevel(*args, **kwargs):
1461 """SetLogLevel(LogLevel logLevel)"""
1462 return _misc_.Log_SetLogLevel(*args, **kwargs)
1463
1464 SetLogLevel = staticmethod(SetLogLevel)
1465 def DontCreateOnDemand(*args, **kwargs):
1466 """DontCreateOnDemand()"""
1467 return _misc_.Log_DontCreateOnDemand(*args, **kwargs)
1468
1469 DontCreateOnDemand = staticmethod(DontCreateOnDemand)
1470 def SetRepetitionCounting(*args, **kwargs):
1471 """SetRepetitionCounting(bool bRepetCounting=True)"""
1472 return _misc_.Log_SetRepetitionCounting(*args, **kwargs)
1473
1474 SetRepetitionCounting = staticmethod(SetRepetitionCounting)
1475 def GetRepetitionCounting(*args, **kwargs):
1476 """GetRepetitionCounting() -> bool"""
1477 return _misc_.Log_GetRepetitionCounting(*args, **kwargs)
1478
1479 GetRepetitionCounting = staticmethod(GetRepetitionCounting)
1480 def SetTraceMask(*args, **kwargs):
1481 """SetTraceMask(TraceMask ulMask)"""
1482 return _misc_.Log_SetTraceMask(*args, **kwargs)
1483
1484 SetTraceMask = staticmethod(SetTraceMask)
1485 def AddTraceMask(*args, **kwargs):
1486 """AddTraceMask(String str)"""
1487 return _misc_.Log_AddTraceMask(*args, **kwargs)
1488
1489 AddTraceMask = staticmethod(AddTraceMask)
1490 def RemoveTraceMask(*args, **kwargs):
1491 """RemoveTraceMask(String str)"""
1492 return _misc_.Log_RemoveTraceMask(*args, **kwargs)
1493
1494 RemoveTraceMask = staticmethod(RemoveTraceMask)
1495 def ClearTraceMasks(*args, **kwargs):
1496 """ClearTraceMasks()"""
1497 return _misc_.Log_ClearTraceMasks(*args, **kwargs)
1498
1499 ClearTraceMasks = staticmethod(ClearTraceMasks)
1500 def GetTraceMasks(*args, **kwargs):
1501 """GetTraceMasks() -> wxArrayString"""
1502 return _misc_.Log_GetTraceMasks(*args, **kwargs)
1503
1504 GetTraceMasks = staticmethod(GetTraceMasks)
1505 def SetTimestamp(*args, **kwargs):
1506 """SetTimestamp(wxChar ts)"""
1507 return _misc_.Log_SetTimestamp(*args, **kwargs)
1508
1509 SetTimestamp = staticmethod(SetTimestamp)
1510 def GetVerbose(*args, **kwargs):
1511 """GetVerbose() -> bool"""
1512 return _misc_.Log_GetVerbose(*args, **kwargs)
1513
1514 GetVerbose = staticmethod(GetVerbose)
1515 def GetTraceMask(*args, **kwargs):
1516 """GetTraceMask() -> TraceMask"""
1517 return _misc_.Log_GetTraceMask(*args, **kwargs)
1518
1519 GetTraceMask = staticmethod(GetTraceMask)
1520 def IsAllowedTraceMask(*args, **kwargs):
1521 """IsAllowedTraceMask(wxChar mask) -> bool"""
1522 return _misc_.Log_IsAllowedTraceMask(*args, **kwargs)
1523
1524 IsAllowedTraceMask = staticmethod(IsAllowedTraceMask)
1525 def GetLogLevel(*args, **kwargs):
1526 """GetLogLevel() -> LogLevel"""
1527 return _misc_.Log_GetLogLevel(*args, **kwargs)
1528
1529 GetLogLevel = staticmethod(GetLogLevel)
1530 def GetTimestamp(*args, **kwargs):
1531 """GetTimestamp() -> wxChar"""
1532 return _misc_.Log_GetTimestamp(*args, **kwargs)
1533
1534 GetTimestamp = staticmethod(GetTimestamp)
1535 def TimeStamp(*args, **kwargs):
1536 """TimeStamp() -> String"""
1537 return _misc_.Log_TimeStamp(*args, **kwargs)
1538
1539 TimeStamp = staticmethod(TimeStamp)
1540 def Destroy(*args, **kwargs):
1541 """Destroy(self)"""
1542 args[0].this.own(False)
1543 return _misc_.Log_Destroy(*args, **kwargs)
1544
1545 _misc_.Log_swigregister(Log)
1546
1547 def Log_IsEnabled(*args):
1548 """Log_IsEnabled() -> bool"""
1549 return _misc_.Log_IsEnabled(*args)
1550
1551 def Log_EnableLogging(*args, **kwargs):
1552 """Log_EnableLogging(bool doIt=True) -> bool"""
1553 return _misc_.Log_EnableLogging(*args, **kwargs)
1554
1555 def Log_OnLog(*args, **kwargs):
1556 """Log_OnLog(LogLevel level, wxChar szString, time_t t)"""
1557 return _misc_.Log_OnLog(*args, **kwargs)
1558
1559 def Log_FlushActive(*args):
1560 """Log_FlushActive()"""
1561 return _misc_.Log_FlushActive(*args)
1562
1563 def Log_GetActiveTarget(*args):
1564 """Log_GetActiveTarget() -> Log"""
1565 return _misc_.Log_GetActiveTarget(*args)
1566
1567 def Log_SetActiveTarget(*args, **kwargs):
1568 """Log_SetActiveTarget(Log pLogger) -> Log"""
1569 return _misc_.Log_SetActiveTarget(*args, **kwargs)
1570
1571 def Log_Suspend(*args):
1572 """Log_Suspend()"""
1573 return _misc_.Log_Suspend(*args)
1574
1575 def Log_Resume(*args):
1576 """Log_Resume()"""
1577 return _misc_.Log_Resume(*args)
1578
1579 def Log_SetVerbose(*args, **kwargs):
1580 """Log_SetVerbose(bool bVerbose=True)"""
1581 return _misc_.Log_SetVerbose(*args, **kwargs)
1582
1583 def Log_SetLogLevel(*args, **kwargs):
1584 """Log_SetLogLevel(LogLevel logLevel)"""
1585 return _misc_.Log_SetLogLevel(*args, **kwargs)
1586
1587 def Log_DontCreateOnDemand(*args):
1588 """Log_DontCreateOnDemand()"""
1589 return _misc_.Log_DontCreateOnDemand(*args)
1590
1591 def Log_SetRepetitionCounting(*args, **kwargs):
1592 """Log_SetRepetitionCounting(bool bRepetCounting=True)"""
1593 return _misc_.Log_SetRepetitionCounting(*args, **kwargs)
1594
1595 def Log_GetRepetitionCounting(*args):
1596 """Log_GetRepetitionCounting() -> bool"""
1597 return _misc_.Log_GetRepetitionCounting(*args)
1598
1599 def Log_SetTraceMask(*args, **kwargs):
1600 """Log_SetTraceMask(TraceMask ulMask)"""
1601 return _misc_.Log_SetTraceMask(*args, **kwargs)
1602
1603 def Log_AddTraceMask(*args, **kwargs):
1604 """Log_AddTraceMask(String str)"""
1605 return _misc_.Log_AddTraceMask(*args, **kwargs)
1606
1607 def Log_RemoveTraceMask(*args, **kwargs):
1608 """Log_RemoveTraceMask(String str)"""
1609 return _misc_.Log_RemoveTraceMask(*args, **kwargs)
1610
1611 def Log_ClearTraceMasks(*args):
1612 """Log_ClearTraceMasks()"""
1613 return _misc_.Log_ClearTraceMasks(*args)
1614
1615 def Log_GetTraceMasks(*args):
1616 """Log_GetTraceMasks() -> wxArrayString"""
1617 return _misc_.Log_GetTraceMasks(*args)
1618
1619 def Log_SetTimestamp(*args, **kwargs):
1620 """Log_SetTimestamp(wxChar ts)"""
1621 return _misc_.Log_SetTimestamp(*args, **kwargs)
1622
1623 def Log_GetVerbose(*args):
1624 """Log_GetVerbose() -> bool"""
1625 return _misc_.Log_GetVerbose(*args)
1626
1627 def Log_GetTraceMask(*args):
1628 """Log_GetTraceMask() -> TraceMask"""
1629 return _misc_.Log_GetTraceMask(*args)
1630
1631 def Log_IsAllowedTraceMask(*args, **kwargs):
1632 """Log_IsAllowedTraceMask(wxChar mask) -> bool"""
1633 return _misc_.Log_IsAllowedTraceMask(*args, **kwargs)
1634
1635 def Log_GetLogLevel(*args):
1636 """Log_GetLogLevel() -> LogLevel"""
1637 return _misc_.Log_GetLogLevel(*args)
1638
1639 def Log_GetTimestamp(*args):
1640 """Log_GetTimestamp() -> wxChar"""
1641 return _misc_.Log_GetTimestamp(*args)
1642
1643 def Log_TimeStamp(*args):
1644 """Log_TimeStamp() -> String"""
1645 return _misc_.Log_TimeStamp(*args)
1646
1647 class LogStderr(Log):
1648 """Proxy of C++ LogStderr class"""
1649 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1650 __repr__ = _swig_repr
1651 def __init__(self, *args, **kwargs):
1652 """__init__(self) -> LogStderr"""
1653 _misc_.LogStderr_swiginit(self,_misc_.new_LogStderr(*args, **kwargs))
1654 _misc_.LogStderr_swigregister(LogStderr)
1655
1656 class LogTextCtrl(Log):
1657 """Proxy of C++ LogTextCtrl class"""
1658 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1659 __repr__ = _swig_repr
1660 def __init__(self, *args, **kwargs):
1661 """__init__(self, wxTextCtrl pTextCtrl) -> LogTextCtrl"""
1662 _misc_.LogTextCtrl_swiginit(self,_misc_.new_LogTextCtrl(*args, **kwargs))
1663 _misc_.LogTextCtrl_swigregister(LogTextCtrl)
1664
1665 class LogGui(Log):
1666 """Proxy of C++ LogGui class"""
1667 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1668 __repr__ = _swig_repr
1669 def __init__(self, *args, **kwargs):
1670 """__init__(self) -> LogGui"""
1671 _misc_.LogGui_swiginit(self,_misc_.new_LogGui(*args, **kwargs))
1672 _misc_.LogGui_swigregister(LogGui)
1673
1674 class LogWindow(Log):
1675 """Proxy of C++ LogWindow class"""
1676 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1677 __repr__ = _swig_repr
1678 def __init__(self, *args, **kwargs):
1679 """__init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow"""
1680 _misc_.LogWindow_swiginit(self,_misc_.new_LogWindow(*args, **kwargs))
1681 def Show(*args, **kwargs):
1682 """Show(self, bool bShow=True)"""
1683 return _misc_.LogWindow_Show(*args, **kwargs)
1684
1685 def GetFrame(*args, **kwargs):
1686 """GetFrame(self) -> wxFrame"""
1687 return _misc_.LogWindow_GetFrame(*args, **kwargs)
1688
1689 def GetOldLog(*args, **kwargs):
1690 """GetOldLog(self) -> Log"""
1691 return _misc_.LogWindow_GetOldLog(*args, **kwargs)
1692
1693 def IsPassingMessages(*args, **kwargs):
1694 """IsPassingMessages(self) -> bool"""
1695 return _misc_.LogWindow_IsPassingMessages(*args, **kwargs)
1696
1697 def PassMessages(*args, **kwargs):
1698 """PassMessages(self, bool bDoPass)"""
1699 return _misc_.LogWindow_PassMessages(*args, **kwargs)
1700
1701 Frame = property(GetFrame,doc="See `GetFrame`")
1702 OldLog = property(GetOldLog,doc="See `GetOldLog`")
1703 _misc_.LogWindow_swigregister(LogWindow)
1704
1705 class LogChain(Log):
1706 """Proxy of C++ LogChain class"""
1707 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1708 __repr__ = _swig_repr
1709 def __init__(self, *args, **kwargs):
1710 """__init__(self, Log logger) -> LogChain"""
1711 _misc_.LogChain_swiginit(self,_misc_.new_LogChain(*args, **kwargs))
1712 def SetLog(*args, **kwargs):
1713 """SetLog(self, Log logger)"""
1714 return _misc_.LogChain_SetLog(*args, **kwargs)
1715
1716 def PassMessages(*args, **kwargs):
1717 """PassMessages(self, bool bDoPass)"""
1718 return _misc_.LogChain_PassMessages(*args, **kwargs)
1719
1720 def IsPassingMessages(*args, **kwargs):
1721 """IsPassingMessages(self) -> bool"""
1722 return _misc_.LogChain_IsPassingMessages(*args, **kwargs)
1723
1724 def GetOldLog(*args, **kwargs):
1725 """GetOldLog(self) -> Log"""
1726 return _misc_.LogChain_GetOldLog(*args, **kwargs)
1727
1728 OldLog = property(GetOldLog,doc="See `GetOldLog`")
1729 _misc_.LogChain_swigregister(LogChain)
1730
1731 class LogBuffer(Log):
1732 """Proxy of C++ LogBuffer class"""
1733 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1734 __repr__ = _swig_repr
1735 def __init__(self, *args, **kwargs):
1736 """__init__(self) -> LogBuffer"""
1737 _misc_.LogBuffer_swiginit(self,_misc_.new_LogBuffer(*args, **kwargs))
1738 def GetBuffer(*args, **kwargs):
1739 """GetBuffer(self) -> String"""
1740 return _misc_.LogBuffer_GetBuffer(*args, **kwargs)
1741
1742 Buffer = property(GetBuffer,doc="See `GetBuffer`")
1743 _misc_.LogBuffer_swigregister(LogBuffer)
1744
1745
1746 def SysErrorCode(*args):
1747 """SysErrorCode() -> unsigned long"""
1748 return _misc_.SysErrorCode(*args)
1749
1750 def SysErrorMsg(*args, **kwargs):
1751 """SysErrorMsg(unsigned long nErrCode=0) -> String"""
1752 return _misc_.SysErrorMsg(*args, **kwargs)
1753
1754 def LogFatalError(*args, **kwargs):
1755 """LogFatalError(String msg)"""
1756 return _misc_.LogFatalError(*args, **kwargs)
1757
1758 def LogError(*args, **kwargs):
1759 """LogError(String msg)"""
1760 return _misc_.LogError(*args, **kwargs)
1761
1762 def LogWarning(*args, **kwargs):
1763 """LogWarning(String msg)"""
1764 return _misc_.LogWarning(*args, **kwargs)
1765
1766 def LogMessage(*args, **kwargs):
1767 """LogMessage(String msg)"""
1768 return _misc_.LogMessage(*args, **kwargs)
1769
1770 def LogInfo(*args, **kwargs):
1771 """LogInfo(String msg)"""
1772 return _misc_.LogInfo(*args, **kwargs)
1773
1774 def LogDebug(*args, **kwargs):
1775 """LogDebug(String msg)"""
1776 return _misc_.LogDebug(*args, **kwargs)
1777
1778 def LogVerbose(*args, **kwargs):
1779 """LogVerbose(String msg)"""
1780 return _misc_.LogVerbose(*args, **kwargs)
1781
1782 def LogStatus(*args, **kwargs):
1783 """LogStatus(String msg)"""
1784 return _misc_.LogStatus(*args, **kwargs)
1785
1786 def LogStatusFrame(*args, **kwargs):
1787 """LogStatusFrame(wxFrame pFrame, String msg)"""
1788 return _misc_.LogStatusFrame(*args, **kwargs)
1789
1790 def LogSysError(*args, **kwargs):
1791 """LogSysError(String msg)"""
1792 return _misc_.LogSysError(*args, **kwargs)
1793
1794 def LogGeneric(*args, **kwargs):
1795 """LogGeneric(unsigned long level, String msg)"""
1796 return _misc_.LogGeneric(*args, **kwargs)
1797
1798 def SafeShowMessage(*args, **kwargs):
1799 """SafeShowMessage(String title, String text)"""
1800 return _misc_.SafeShowMessage(*args, **kwargs)
1801 class LogNull(object):
1802 """Proxy of C++ LogNull class"""
1803 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1804 __repr__ = _swig_repr
1805 def __init__(self, *args, **kwargs):
1806 """__init__(self) -> LogNull"""
1807 _misc_.LogNull_swiginit(self,_misc_.new_LogNull(*args, **kwargs))
1808 __swig_destroy__ = _misc_.delete_LogNull
1809 __del__ = lambda self : None;
1810 _misc_.LogNull_swigregister(LogNull)
1811
1812 def LogTrace(*args):
1813 """
1814 LogTrace(unsigned long mask, String msg)
1815 LogTrace(String mask, String msg)
1816 """
1817 return _misc_.LogTrace(*args)
1818
1819 class PyLog(Log):
1820 """Proxy of C++ PyLog class"""
1821 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1822 __repr__ = _swig_repr
1823 def __init__(self, *args, **kwargs):
1824 """__init__(self) -> PyLog"""
1825 _misc_.PyLog_swiginit(self,_misc_.new_PyLog(*args, **kwargs))
1826 PyLog._setCallbackInfo(self, self, PyLog)
1827
1828 def _setCallbackInfo(*args, **kwargs):
1829 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1830 return _misc_.PyLog__setCallbackInfo(*args, **kwargs)
1831
1832 _misc_.PyLog_swigregister(PyLog)
1833
1834 #---------------------------------------------------------------------------
1835
1836 PROCESS_DEFAULT = _misc_.PROCESS_DEFAULT
1837 PROCESS_REDIRECT = _misc_.PROCESS_REDIRECT
1838 KILL_OK = _misc_.KILL_OK
1839 KILL_BAD_SIGNAL = _misc_.KILL_BAD_SIGNAL
1840 KILL_ACCESS_DENIED = _misc_.KILL_ACCESS_DENIED
1841 KILL_NO_PROCESS = _misc_.KILL_NO_PROCESS
1842 KILL_ERROR = _misc_.KILL_ERROR
1843 KILL_NOCHILDREN = _misc_.KILL_NOCHILDREN
1844 KILL_CHILDREN = _misc_.KILL_CHILDREN
1845 SIGNONE = _misc_.SIGNONE
1846 SIGHUP = _misc_.SIGHUP
1847 SIGINT = _misc_.SIGINT
1848 SIGQUIT = _misc_.SIGQUIT
1849 SIGILL = _misc_.SIGILL
1850 SIGTRAP = _misc_.SIGTRAP
1851 SIGABRT = _misc_.SIGABRT
1852 SIGIOT = _misc_.SIGIOT
1853 SIGEMT = _misc_.SIGEMT
1854 SIGFPE = _misc_.SIGFPE
1855 SIGKILL = _misc_.SIGKILL
1856 SIGBUS = _misc_.SIGBUS
1857 SIGSEGV = _misc_.SIGSEGV
1858 SIGSYS = _misc_.SIGSYS
1859 SIGPIPE = _misc_.SIGPIPE
1860 SIGALRM = _misc_.SIGALRM
1861 SIGTERM = _misc_.SIGTERM
1862 class Process(_core.EvtHandler):
1863 """Proxy of C++ Process class"""
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 Kill(*args, **kwargs):
1867 """Kill(int pid, int sig=SIGTERM, int flags=KILL_NOCHILDREN) -> int"""
1868 return _misc_.Process_Kill(*args, **kwargs)
1869
1870 Kill = staticmethod(Kill)
1871 def Exists(*args, **kwargs):
1872 """Exists(int pid) -> bool"""
1873 return _misc_.Process_Exists(*args, **kwargs)
1874
1875 Exists = staticmethod(Exists)
1876 def Open(*args, **kwargs):
1877 """Open(String cmd, int flags=EXEC_ASYNC) -> Process"""
1878 return _misc_.Process_Open(*args, **kwargs)
1879
1880 Open = staticmethod(Open)
1881 def __init__(self, *args, **kwargs):
1882 """__init__(self, EvtHandler parent=None, int id=-1) -> Process"""
1883 _misc_.Process_swiginit(self,_misc_.new_Process(*args, **kwargs))
1884 Process._setCallbackInfo(self, self, Process); self.this.own(False)
1885
1886 __swig_destroy__ = _misc_.delete_Process
1887 __del__ = lambda self : None;
1888 def _setCallbackInfo(*args, **kwargs):
1889 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
1890 return _misc_.Process__setCallbackInfo(*args, **kwargs)
1891
1892 def GetPid(*args, **kwargs):
1893 """
1894 GetPid(self) -> long
1895
1896 get the process ID of the process executed by Open()
1897 """
1898 return _misc_.Process_GetPid(*args, **kwargs)
1899
1900 def OnTerminate(*args, **kwargs):
1901 """OnTerminate(self, int pid, int status)"""
1902 return _misc_.Process_OnTerminate(*args, **kwargs)
1903
1904 def base_OnTerminate(*args, **kw):
1905 return Process.OnTerminate(*args, **kw)
1906 base_OnTerminate = wx._deprecated(base_OnTerminate,
1907 "Please use Process.OnTerminate instead.")
1908
1909 def Redirect(*args, **kwargs):
1910 """Redirect(self)"""
1911 return _misc_.Process_Redirect(*args, **kwargs)
1912
1913 def IsRedirected(*args, **kwargs):
1914 """IsRedirected(self) -> bool"""
1915 return _misc_.Process_IsRedirected(*args, **kwargs)
1916
1917 def Detach(*args, **kwargs):
1918 """Detach(self)"""
1919 return _misc_.Process_Detach(*args, **kwargs)
1920
1921 def GetInputStream(*args, **kwargs):
1922 """GetInputStream(self) -> InputStream"""
1923 return _misc_.Process_GetInputStream(*args, **kwargs)
1924
1925 def GetErrorStream(*args, **kwargs):
1926 """GetErrorStream(self) -> InputStream"""
1927 return _misc_.Process_GetErrorStream(*args, **kwargs)
1928
1929 def GetOutputStream(*args, **kwargs):
1930 """GetOutputStream(self) -> OutputStream"""
1931 return _misc_.Process_GetOutputStream(*args, **kwargs)
1932
1933 def CloseOutput(*args, **kwargs):
1934 """CloseOutput(self)"""
1935 return _misc_.Process_CloseOutput(*args, **kwargs)
1936
1937 def IsInputOpened(*args, **kwargs):
1938 """IsInputOpened(self) -> bool"""
1939 return _misc_.Process_IsInputOpened(*args, **kwargs)
1940
1941 def IsInputAvailable(*args, **kwargs):
1942 """IsInputAvailable(self) -> bool"""
1943 return _misc_.Process_IsInputAvailable(*args, **kwargs)
1944
1945 def IsErrorAvailable(*args, **kwargs):
1946 """IsErrorAvailable(self) -> bool"""
1947 return _misc_.Process_IsErrorAvailable(*args, **kwargs)
1948
1949 ErrorStream = property(GetErrorStream,doc="See `GetErrorStream`")
1950 InputStream = property(GetInputStream,doc="See `GetInputStream`")
1951 OutputStream = property(GetOutputStream,doc="See `GetOutputStream`")
1952 InputOpened = property(IsInputOpened)
1953 InputAvailable = property(IsInputAvailable)
1954 ErrorAvailable = property(IsErrorAvailable)
1955 _misc_.Process_swigregister(Process)
1956
1957 def Process_Kill(*args, **kwargs):
1958 """Process_Kill(int pid, int sig=SIGTERM, int flags=KILL_NOCHILDREN) -> int"""
1959 return _misc_.Process_Kill(*args, **kwargs)
1960
1961 def Process_Exists(*args, **kwargs):
1962 """Process_Exists(int pid) -> bool"""
1963 return _misc_.Process_Exists(*args, **kwargs)
1964
1965 def Process_Open(*args, **kwargs):
1966 """Process_Open(String cmd, int flags=EXEC_ASYNC) -> Process"""
1967 return _misc_.Process_Open(*args, **kwargs)
1968
1969 class ProcessEvent(_core.Event):
1970 """Proxy of C++ ProcessEvent class"""
1971 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1972 __repr__ = _swig_repr
1973 def __init__(self, *args, **kwargs):
1974 """__init__(self, int id=0, int pid=0, int exitcode=0) -> ProcessEvent"""
1975 _misc_.ProcessEvent_swiginit(self,_misc_.new_ProcessEvent(*args, **kwargs))
1976 def GetPid(*args, **kwargs):
1977 """GetPid(self) -> int"""
1978 return _misc_.ProcessEvent_GetPid(*args, **kwargs)
1979
1980 def GetExitCode(*args, **kwargs):
1981 """GetExitCode(self) -> int"""
1982 return _misc_.ProcessEvent_GetExitCode(*args, **kwargs)
1983
1984 m_pid = property(_misc_.ProcessEvent_m_pid_get, _misc_.ProcessEvent_m_pid_set)
1985 m_exitcode = property(_misc_.ProcessEvent_m_exitcode_get, _misc_.ProcessEvent_m_exitcode_set)
1986 ExitCode = property(GetExitCode,doc="See `GetExitCode`")
1987 Pid = property(GetPid,doc="See `GetPid`")
1988 _misc_.ProcessEvent_swigregister(ProcessEvent)
1989
1990 wxEVT_END_PROCESS = _misc_.wxEVT_END_PROCESS
1991 EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 )
1992
1993 EXEC_ASYNC = _misc_.EXEC_ASYNC
1994 EXEC_SYNC = _misc_.EXEC_SYNC
1995 EXEC_NOHIDE = _misc_.EXEC_NOHIDE
1996 EXEC_MAKE_GROUP_LEADER = _misc_.EXEC_MAKE_GROUP_LEADER
1997 EXEC_NODISABLE = _misc_.EXEC_NODISABLE
1998
1999 def Execute(*args, **kwargs):
2000 """Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long"""
2001 return _misc_.Execute(*args, **kwargs)
2002
2003 def Kill(*args, **kwargs):
2004 """Kill(long pid, int sig=SIGTERM, int rc, int flags=KILL_NOCHILDREN) -> int"""
2005 return _misc_.Kill(*args, **kwargs)
2006 #---------------------------------------------------------------------------
2007
2008 JOYSTICK1 = _misc_.JOYSTICK1
2009 JOYSTICK2 = _misc_.JOYSTICK2
2010 JOY_BUTTON_ANY = _misc_.JOY_BUTTON_ANY
2011 JOY_BUTTON1 = _misc_.JOY_BUTTON1
2012 JOY_BUTTON2 = _misc_.JOY_BUTTON2
2013 JOY_BUTTON3 = _misc_.JOY_BUTTON3
2014 JOY_BUTTON4 = _misc_.JOY_BUTTON4
2015 class Joystick(object):
2016 """Proxy of C++ Joystick class"""
2017 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2018 __repr__ = _swig_repr
2019 def __init__(self, *args, **kwargs):
2020 """__init__(self, int joystick=JOYSTICK1) -> Joystick"""
2021 _misc_.Joystick_swiginit(self,_misc_.new_Joystick(*args, **kwargs))
2022 __swig_destroy__ = _misc_.delete_Joystick
2023 __del__ = lambda self : None;
2024 def GetPosition(*args, **kwargs):
2025 """GetPosition(self) -> Point"""
2026 return _misc_.Joystick_GetPosition(*args, **kwargs)
2027
2028 def GetZPosition(*args, **kwargs):
2029 """GetZPosition(self) -> int"""
2030 return _misc_.Joystick_GetZPosition(*args, **kwargs)
2031
2032 def GetButtonState(*args, **kwargs):
2033 """GetButtonState(self) -> int"""
2034 return _misc_.Joystick_GetButtonState(*args, **kwargs)
2035
2036 def GetPOVPosition(*args, **kwargs):
2037 """GetPOVPosition(self) -> int"""
2038 return _misc_.Joystick_GetPOVPosition(*args, **kwargs)
2039
2040 def GetPOVCTSPosition(*args, **kwargs):
2041 """GetPOVCTSPosition(self) -> int"""
2042 return _misc_.Joystick_GetPOVCTSPosition(*args, **kwargs)
2043
2044 def GetRudderPosition(*args, **kwargs):
2045 """GetRudderPosition(self) -> int"""
2046 return _misc_.Joystick_GetRudderPosition(*args, **kwargs)
2047
2048 def GetUPosition(*args, **kwargs):
2049 """GetUPosition(self) -> int"""
2050 return _misc_.Joystick_GetUPosition(*args, **kwargs)
2051
2052 def GetVPosition(*args, **kwargs):
2053 """GetVPosition(self) -> int"""
2054 return _misc_.Joystick_GetVPosition(*args, **kwargs)
2055
2056 def GetMovementThreshold(*args, **kwargs):
2057 """GetMovementThreshold(self) -> int"""
2058 return _misc_.Joystick_GetMovementThreshold(*args, **kwargs)
2059
2060 def SetMovementThreshold(*args, **kwargs):
2061 """SetMovementThreshold(self, int threshold)"""
2062 return _misc_.Joystick_SetMovementThreshold(*args, **kwargs)
2063
2064 def IsOk(*args, **kwargs):
2065 """IsOk(self) -> bool"""
2066 return _misc_.Joystick_IsOk(*args, **kwargs)
2067
2068 def GetNumberJoysticks(*args, **kwargs):
2069 """GetNumberJoysticks(self) -> int"""
2070 return _misc_.Joystick_GetNumberJoysticks(*args, **kwargs)
2071
2072 def GetManufacturerId(*args, **kwargs):
2073 """GetManufacturerId(self) -> int"""
2074 return _misc_.Joystick_GetManufacturerId(*args, **kwargs)
2075
2076 def GetProductId(*args, **kwargs):
2077 """GetProductId(self) -> int"""
2078 return _misc_.Joystick_GetProductId(*args, **kwargs)
2079
2080 def GetProductName(*args, **kwargs):
2081 """GetProductName(self) -> String"""
2082 return _misc_.Joystick_GetProductName(*args, **kwargs)
2083
2084 def GetXMin(*args, **kwargs):
2085 """GetXMin(self) -> int"""
2086 return _misc_.Joystick_GetXMin(*args, **kwargs)
2087
2088 def GetYMin(*args, **kwargs):
2089 """GetYMin(self) -> int"""
2090 return _misc_.Joystick_GetYMin(*args, **kwargs)
2091
2092 def GetZMin(*args, **kwargs):
2093 """GetZMin(self) -> int"""
2094 return _misc_.Joystick_GetZMin(*args, **kwargs)
2095
2096 def GetXMax(*args, **kwargs):
2097 """GetXMax(self) -> int"""
2098 return _misc_.Joystick_GetXMax(*args, **kwargs)
2099
2100 def GetYMax(*args, **kwargs):
2101 """GetYMax(self) -> int"""
2102 return _misc_.Joystick_GetYMax(*args, **kwargs)
2103
2104 def GetZMax(*args, **kwargs):
2105 """GetZMax(self) -> int"""
2106 return _misc_.Joystick_GetZMax(*args, **kwargs)
2107
2108 def GetNumberButtons(*args, **kwargs):
2109 """GetNumberButtons(self) -> int"""
2110 return _misc_.Joystick_GetNumberButtons(*args, **kwargs)
2111
2112 def GetNumberAxes(*args, **kwargs):
2113 """GetNumberAxes(self) -> int"""
2114 return _misc_.Joystick_GetNumberAxes(*args, **kwargs)
2115
2116 def GetMaxButtons(*args, **kwargs):
2117 """GetMaxButtons(self) -> int"""
2118 return _misc_.Joystick_GetMaxButtons(*args, **kwargs)
2119
2120 def GetMaxAxes(*args, **kwargs):
2121 """GetMaxAxes(self) -> int"""
2122 return _misc_.Joystick_GetMaxAxes(*args, **kwargs)
2123
2124 def GetPollingMin(*args, **kwargs):
2125 """GetPollingMin(self) -> int"""
2126 return _misc_.Joystick_GetPollingMin(*args, **kwargs)
2127
2128 def GetPollingMax(*args, **kwargs):
2129 """GetPollingMax(self) -> int"""
2130 return _misc_.Joystick_GetPollingMax(*args, **kwargs)
2131
2132 def GetRudderMin(*args, **kwargs):
2133 """GetRudderMin(self) -> int"""
2134 return _misc_.Joystick_GetRudderMin(*args, **kwargs)
2135
2136 def GetRudderMax(*args, **kwargs):
2137 """GetRudderMax(self) -> int"""
2138 return _misc_.Joystick_GetRudderMax(*args, **kwargs)
2139
2140 def GetUMin(*args, **kwargs):
2141 """GetUMin(self) -> int"""
2142 return _misc_.Joystick_GetUMin(*args, **kwargs)
2143
2144 def GetUMax(*args, **kwargs):
2145 """GetUMax(self) -> int"""
2146 return _misc_.Joystick_GetUMax(*args, **kwargs)
2147
2148 def GetVMin(*args, **kwargs):
2149 """GetVMin(self) -> int"""
2150 return _misc_.Joystick_GetVMin(*args, **kwargs)
2151
2152 def GetVMax(*args, **kwargs):
2153 """GetVMax(self) -> int"""
2154 return _misc_.Joystick_GetVMax(*args, **kwargs)
2155
2156 def HasRudder(*args, **kwargs):
2157 """HasRudder(self) -> bool"""
2158 return _misc_.Joystick_HasRudder(*args, **kwargs)
2159
2160 def HasZ(*args, **kwargs):
2161 """HasZ(self) -> bool"""
2162 return _misc_.Joystick_HasZ(*args, **kwargs)
2163
2164 def HasU(*args, **kwargs):
2165 """HasU(self) -> bool"""
2166 return _misc_.Joystick_HasU(*args, **kwargs)
2167
2168 def HasV(*args, **kwargs):
2169 """HasV(self) -> bool"""
2170 return _misc_.Joystick_HasV(*args, **kwargs)
2171
2172 def HasPOV(*args, **kwargs):
2173 """HasPOV(self) -> bool"""
2174 return _misc_.Joystick_HasPOV(*args, **kwargs)
2175
2176 def HasPOV4Dir(*args, **kwargs):
2177 """HasPOV4Dir(self) -> bool"""
2178 return _misc_.Joystick_HasPOV4Dir(*args, **kwargs)
2179
2180 def HasPOVCTS(*args, **kwargs):
2181 """HasPOVCTS(self) -> bool"""
2182 return _misc_.Joystick_HasPOVCTS(*args, **kwargs)
2183
2184 def SetCapture(*args, **kwargs):
2185 """SetCapture(self, Window win, int pollingFreq=0) -> bool"""
2186 return _misc_.Joystick_SetCapture(*args, **kwargs)
2187
2188 def ReleaseCapture(*args, **kwargs):
2189 """ReleaseCapture(self) -> bool"""
2190 return _misc_.Joystick_ReleaseCapture(*args, **kwargs)
2191
2192 def __nonzero__(self): return self.IsOk()
2193 ButtonState = property(GetButtonState,doc="See `GetButtonState`")
2194 ManufacturerId = property(GetManufacturerId,doc="See `GetManufacturerId`")
2195 MaxAxes = property(GetMaxAxes,doc="See `GetMaxAxes`")
2196 MaxButtons = property(GetMaxButtons,doc="See `GetMaxButtons`")
2197 MovementThreshold = property(GetMovementThreshold,SetMovementThreshold,doc="See `GetMovementThreshold` and `SetMovementThreshold`")
2198 NumberAxes = property(GetNumberAxes,doc="See `GetNumberAxes`")
2199 NumberButtons = property(GetNumberButtons,doc="See `GetNumberButtons`")
2200 NumberJoysticks = property(GetNumberJoysticks,doc="See `GetNumberJoysticks`")
2201 POVCTSPosition = property(GetPOVCTSPosition,doc="See `GetPOVCTSPosition`")
2202 POVPosition = property(GetPOVPosition,doc="See `GetPOVPosition`")
2203 PollingMax = property(GetPollingMax,doc="See `GetPollingMax`")
2204 PollingMin = property(GetPollingMin,doc="See `GetPollingMin`")
2205 Position = property(GetPosition,doc="See `GetPosition`")
2206 ProductId = property(GetProductId,doc="See `GetProductId`")
2207 ProductName = property(GetProductName,doc="See `GetProductName`")
2208 RudderMax = property(GetRudderMax,doc="See `GetRudderMax`")
2209 RudderMin = property(GetRudderMin,doc="See `GetRudderMin`")
2210 RudderPosition = property(GetRudderPosition,doc="See `GetRudderPosition`")
2211 UMax = property(GetUMax,doc="See `GetUMax`")
2212 UMin = property(GetUMin,doc="See `GetUMin`")
2213 UPosition = property(GetUPosition,doc="See `GetUPosition`")
2214 VMax = property(GetVMax,doc="See `GetVMax`")
2215 VMin = property(GetVMin,doc="See `GetVMin`")
2216 VPosition = property(GetVPosition,doc="See `GetVPosition`")
2217 XMax = property(GetXMax,doc="See `GetXMax`")
2218 XMin = property(GetXMin,doc="See `GetXMin`")
2219 YMax = property(GetYMax,doc="See `GetYMax`")
2220 YMin = property(GetYMin,doc="See `GetYMin`")
2221 ZMax = property(GetZMax,doc="See `GetZMax`")
2222 ZMin = property(GetZMin,doc="See `GetZMin`")
2223 ZPosition = property(GetZPosition,doc="See `GetZPosition`")
2224 _misc_.Joystick_swigregister(Joystick)
2225
2226 wxEVT_JOY_BUTTON_DOWN = _misc_.wxEVT_JOY_BUTTON_DOWN
2227 wxEVT_JOY_BUTTON_UP = _misc_.wxEVT_JOY_BUTTON_UP
2228 wxEVT_JOY_MOVE = _misc_.wxEVT_JOY_MOVE
2229 wxEVT_JOY_ZMOVE = _misc_.wxEVT_JOY_ZMOVE
2230 class JoystickEvent(_core.Event):
2231 """Proxy of C++ JoystickEvent class"""
2232 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2233 __repr__ = _swig_repr
2234 def __init__(self, *args, **kwargs):
2235 """
2236 __init__(self, EventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1,
2237 int change=0) -> JoystickEvent
2238 """
2239 _misc_.JoystickEvent_swiginit(self,_misc_.new_JoystickEvent(*args, **kwargs))
2240 def GetPosition(*args, **kwargs):
2241 """GetPosition(self) -> Point"""
2242 return _misc_.JoystickEvent_GetPosition(*args, **kwargs)
2243
2244 def GetZPosition(*args, **kwargs):
2245 """GetZPosition(self) -> int"""
2246 return _misc_.JoystickEvent_GetZPosition(*args, **kwargs)
2247
2248 def GetButtonState(*args, **kwargs):
2249 """GetButtonState(self) -> int"""
2250 return _misc_.JoystickEvent_GetButtonState(*args, **kwargs)
2251
2252 def GetButtonChange(*args, **kwargs):
2253 """GetButtonChange(self) -> int"""
2254 return _misc_.JoystickEvent_GetButtonChange(*args, **kwargs)
2255
2256 def GetJoystick(*args, **kwargs):
2257 """GetJoystick(self) -> int"""
2258 return _misc_.JoystickEvent_GetJoystick(*args, **kwargs)
2259
2260 def SetJoystick(*args, **kwargs):
2261 """SetJoystick(self, int stick)"""
2262 return _misc_.JoystickEvent_SetJoystick(*args, **kwargs)
2263
2264 def SetButtonState(*args, **kwargs):
2265 """SetButtonState(self, int state)"""
2266 return _misc_.JoystickEvent_SetButtonState(*args, **kwargs)
2267
2268 def SetButtonChange(*args, **kwargs):
2269 """SetButtonChange(self, int change)"""
2270 return _misc_.JoystickEvent_SetButtonChange(*args, **kwargs)
2271
2272 def SetPosition(*args, **kwargs):
2273 """SetPosition(self, Point pos)"""
2274 return _misc_.JoystickEvent_SetPosition(*args, **kwargs)
2275
2276 def SetZPosition(*args, **kwargs):
2277 """SetZPosition(self, int zPos)"""
2278 return _misc_.JoystickEvent_SetZPosition(*args, **kwargs)
2279
2280 def IsButton(*args, **kwargs):
2281 """IsButton(self) -> bool"""
2282 return _misc_.JoystickEvent_IsButton(*args, **kwargs)
2283
2284 def IsMove(*args, **kwargs):
2285 """IsMove(self) -> bool"""
2286 return _misc_.JoystickEvent_IsMove(*args, **kwargs)
2287
2288 def IsZMove(*args, **kwargs):
2289 """IsZMove(self) -> bool"""
2290 return _misc_.JoystickEvent_IsZMove(*args, **kwargs)
2291
2292 def ButtonDown(*args, **kwargs):
2293 """ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool"""
2294 return _misc_.JoystickEvent_ButtonDown(*args, **kwargs)
2295
2296 def ButtonUp(*args, **kwargs):
2297 """ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool"""
2298 return _misc_.JoystickEvent_ButtonUp(*args, **kwargs)
2299
2300 def ButtonIsDown(*args, **kwargs):
2301 """ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool"""
2302 return _misc_.JoystickEvent_ButtonIsDown(*args, **kwargs)
2303
2304 m_pos = property(GetPosition, SetPosition)
2305 m_zPosition = property(GetZPosition, SetZPosition)
2306 m_buttonChange = property(GetButtonChange, SetButtonChange)
2307 m_buttonState = property(GetButtonState, SetButtonState)
2308 m_joyStick = property(GetJoystick, SetJoystick)
2309
2310 ButtonChange = property(GetButtonChange,SetButtonChange,doc="See `GetButtonChange` and `SetButtonChange`")
2311 ButtonState = property(GetButtonState,SetButtonState,doc="See `GetButtonState` and `SetButtonState`")
2312 Joystick = property(GetJoystick,SetJoystick,doc="See `GetJoystick` and `SetJoystick`")
2313 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2314 ZPosition = property(GetZPosition,SetZPosition,doc="See `GetZPosition` and `SetZPosition`")
2315 _misc_.JoystickEvent_swigregister(JoystickEvent)
2316
2317 EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN )
2318 EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP )
2319 EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE )
2320 EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE )
2321
2322 EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN,
2323 wxEVT_JOY_BUTTON_UP,
2324 wxEVT_JOY_MOVE,
2325 wxEVT_JOY_ZMOVE,
2326 ])
2327
2328
2329 #---------------------------------------------------------------------------
2330
2331 SOUND_SYNC = _misc_.SOUND_SYNC
2332 SOUND_ASYNC = _misc_.SOUND_ASYNC
2333 SOUND_LOOP = _misc_.SOUND_LOOP
2334 class Sound(object):
2335 """Proxy of C++ Sound class"""
2336 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2337 __repr__ = _swig_repr
2338 def __init__(self, *args, **kwargs):
2339 """__init__(self, String fileName=EmptyString) -> Sound"""
2340 _misc_.Sound_swiginit(self,_misc_.new_Sound(*args, **kwargs))
2341 __swig_destroy__ = _misc_.delete_Sound
2342 __del__ = lambda self : None;
2343 def Create(*args, **kwargs):
2344 """Create(self, String fileName) -> bool"""
2345 return _misc_.Sound_Create(*args, **kwargs)
2346
2347 def CreateFromData(*args, **kwargs):
2348 """CreateFromData(self, PyObject data) -> bool"""
2349 return _misc_.Sound_CreateFromData(*args, **kwargs)
2350
2351 def IsOk(*args, **kwargs):
2352 """IsOk(self) -> bool"""
2353 return _misc_.Sound_IsOk(*args, **kwargs)
2354
2355 def Play(*args, **kwargs):
2356 """Play(self, unsigned int flags=SOUND_ASYNC) -> bool"""
2357 return _misc_.Sound_Play(*args, **kwargs)
2358
2359 def PlaySound(*args, **kwargs):
2360 """PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
2361 return _misc_.Sound_PlaySound(*args, **kwargs)
2362
2363 PlaySound = staticmethod(PlaySound)
2364 def Stop(*args, **kwargs):
2365 """Stop()"""
2366 return _misc_.Sound_Stop(*args, **kwargs)
2367
2368 Stop = staticmethod(Stop)
2369 def __nonzero__(self): return self.IsOk()
2370 _misc_.Sound_swigregister(Sound)
2371
2372 def SoundFromData(*args, **kwargs):
2373 """SoundFromData(PyObject data) -> Sound"""
2374 val = _misc_.new_SoundFromData(*args, **kwargs)
2375 return val
2376
2377 def Sound_PlaySound(*args, **kwargs):
2378 """Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
2379 return _misc_.Sound_PlaySound(*args, **kwargs)
2380
2381 def Sound_Stop(*args):
2382 """Sound_Stop()"""
2383 return _misc_.Sound_Stop(*args)
2384
2385 #---------------------------------------------------------------------------
2386
2387 MAILCAP_STANDARD = _misc_.MAILCAP_STANDARD
2388 MAILCAP_NETSCAPE = _misc_.MAILCAP_NETSCAPE
2389 MAILCAP_KDE = _misc_.MAILCAP_KDE
2390 MAILCAP_GNOME = _misc_.MAILCAP_GNOME
2391 MAILCAP_ALL = _misc_.MAILCAP_ALL
2392 class FileTypeInfo(object):
2393 """Proxy of C++ FileTypeInfo class"""
2394 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2395 __repr__ = _swig_repr
2396 def __init__(self, *args, **kwargs):
2397 """__init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo"""
2398 _misc_.FileTypeInfo_swiginit(self,_misc_.new_FileTypeInfo(*args, **kwargs))
2399 def IsValid(*args, **kwargs):
2400 """IsValid(self) -> bool"""
2401 return _misc_.FileTypeInfo_IsValid(*args, **kwargs)
2402
2403 def SetIcon(*args, **kwargs):
2404 """SetIcon(self, String iconFile, int iconIndex=0)"""
2405 return _misc_.FileTypeInfo_SetIcon(*args, **kwargs)
2406
2407 def SetShortDesc(*args, **kwargs):
2408 """SetShortDesc(self, String shortDesc)"""
2409 return _misc_.FileTypeInfo_SetShortDesc(*args, **kwargs)
2410
2411 def GetMimeType(*args, **kwargs):
2412 """GetMimeType(self) -> String"""
2413 return _misc_.FileTypeInfo_GetMimeType(*args, **kwargs)
2414
2415 def GetOpenCommand(*args, **kwargs):
2416 """GetOpenCommand(self) -> String"""
2417 return _misc_.FileTypeInfo_GetOpenCommand(*args, **kwargs)
2418
2419 def GetPrintCommand(*args, **kwargs):
2420 """GetPrintCommand(self) -> String"""
2421 return _misc_.FileTypeInfo_GetPrintCommand(*args, **kwargs)
2422
2423 def GetShortDesc(*args, **kwargs):
2424 """GetShortDesc(self) -> String"""
2425 return _misc_.FileTypeInfo_GetShortDesc(*args, **kwargs)
2426
2427 def GetDescription(*args, **kwargs):
2428 """GetDescription(self) -> String"""
2429 return _misc_.FileTypeInfo_GetDescription(*args, **kwargs)
2430
2431 def GetExtensions(*args, **kwargs):
2432 """GetExtensions(self) -> wxArrayString"""
2433 return _misc_.FileTypeInfo_GetExtensions(*args, **kwargs)
2434
2435 def GetExtensionsCount(*args, **kwargs):
2436 """GetExtensionsCount(self) -> size_t"""
2437 return _misc_.FileTypeInfo_GetExtensionsCount(*args, **kwargs)
2438
2439 def GetIconFile(*args, **kwargs):
2440 """GetIconFile(self) -> String"""
2441 return _misc_.FileTypeInfo_GetIconFile(*args, **kwargs)
2442
2443 def GetIconIndex(*args, **kwargs):
2444 """GetIconIndex(self) -> int"""
2445 return _misc_.FileTypeInfo_GetIconIndex(*args, **kwargs)
2446
2447 Description = property(GetDescription,doc="See `GetDescription`")
2448 Extensions = property(GetExtensions,doc="See `GetExtensions`")
2449 ExtensionsCount = property(GetExtensionsCount,doc="See `GetExtensionsCount`")
2450 IconFile = property(GetIconFile,doc="See `GetIconFile`")
2451 IconIndex = property(GetIconIndex,doc="See `GetIconIndex`")
2452 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2453 OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`")
2454 PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`")
2455 ShortDesc = property(GetShortDesc,SetShortDesc,doc="See `GetShortDesc` and `SetShortDesc`")
2456 _misc_.FileTypeInfo_swigregister(FileTypeInfo)
2457
2458 def FileTypeInfoSequence(*args, **kwargs):
2459 """FileTypeInfoSequence(wxArrayString sArray) -> FileTypeInfo"""
2460 val = _misc_.new_FileTypeInfoSequence(*args, **kwargs)
2461 return val
2462
2463 def NullFileTypeInfo(*args, **kwargs):
2464 """NullFileTypeInfo() -> FileTypeInfo"""
2465 val = _misc_.new_NullFileTypeInfo(*args, **kwargs)
2466 return val
2467
2468 class FileType(object):
2469 """Proxy of C++ FileType class"""
2470 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2471 __repr__ = _swig_repr
2472 def __init__(self, *args, **kwargs):
2473 """__init__(self, FileTypeInfo ftInfo) -> FileType"""
2474 _misc_.FileType_swiginit(self,_misc_.new_FileType(*args, **kwargs))
2475 __swig_destroy__ = _misc_.delete_FileType
2476 __del__ = lambda self : None;
2477 def GetMimeType(*args, **kwargs):
2478 """GetMimeType(self) -> PyObject"""
2479 return _misc_.FileType_GetMimeType(*args, **kwargs)
2480
2481 def GetMimeTypes(*args, **kwargs):
2482 """GetMimeTypes(self) -> PyObject"""
2483 return _misc_.FileType_GetMimeTypes(*args, **kwargs)
2484
2485 def GetExtensions(*args, **kwargs):
2486 """GetExtensions(self) -> PyObject"""
2487 return _misc_.FileType_GetExtensions(*args, **kwargs)
2488
2489 def GetIcon(*args, **kwargs):
2490 """GetIcon(self) -> Icon"""
2491 return _misc_.FileType_GetIcon(*args, **kwargs)
2492
2493 def GetIconInfo(*args, **kwargs):
2494 """GetIconInfo(self) -> PyObject"""
2495 return _misc_.FileType_GetIconInfo(*args, **kwargs)
2496
2497 def GetDescription(*args, **kwargs):
2498 """GetDescription(self) -> PyObject"""
2499 return _misc_.FileType_GetDescription(*args, **kwargs)
2500
2501 def GetOpenCommand(*args, **kwargs):
2502 """GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject"""
2503 return _misc_.FileType_GetOpenCommand(*args, **kwargs)
2504
2505 def GetPrintCommand(*args, **kwargs):
2506 """GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject"""
2507 return _misc_.FileType_GetPrintCommand(*args, **kwargs)
2508
2509 def GetAllCommands(*args, **kwargs):
2510 """GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject"""
2511 return _misc_.FileType_GetAllCommands(*args, **kwargs)
2512
2513 def SetCommand(*args, **kwargs):
2514 """SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool"""
2515 return _misc_.FileType_SetCommand(*args, **kwargs)
2516
2517 def SetDefaultIcon(*args, **kwargs):
2518 """SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool"""
2519 return _misc_.FileType_SetDefaultIcon(*args, **kwargs)
2520
2521 def Unassociate(*args, **kwargs):
2522 """Unassociate(self) -> bool"""
2523 return _misc_.FileType_Unassociate(*args, **kwargs)
2524
2525 def ExpandCommand(*args, **kwargs):
2526 """ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
2527 return _misc_.FileType_ExpandCommand(*args, **kwargs)
2528
2529 ExpandCommand = staticmethod(ExpandCommand)
2530 AllCommands = property(GetAllCommands,doc="See `GetAllCommands`")
2531 Description = property(GetDescription,doc="See `GetDescription`")
2532 Extensions = property(GetExtensions,doc="See `GetExtensions`")
2533 Icon = property(GetIcon,doc="See `GetIcon`")
2534 IconInfo = property(GetIconInfo,doc="See `GetIconInfo`")
2535 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2536 MimeTypes = property(GetMimeTypes,doc="See `GetMimeTypes`")
2537 OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`")
2538 PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`")
2539 _misc_.FileType_swigregister(FileType)
2540
2541 def FileType_ExpandCommand(*args, **kwargs):
2542 """FileType_ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
2543 return _misc_.FileType_ExpandCommand(*args, **kwargs)
2544
2545 class MimeTypesManager(object):
2546 """Proxy of C++ MimeTypesManager class"""
2547 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2548 __repr__ = _swig_repr
2549 def IsOfType(*args, **kwargs):
2550 """IsOfType(String mimeType, String wildcard) -> bool"""
2551 return _misc_.MimeTypesManager_IsOfType(*args, **kwargs)
2552
2553 IsOfType = staticmethod(IsOfType)
2554 def __init__(self, *args, **kwargs):
2555 """__init__(self) -> MimeTypesManager"""
2556 _misc_.MimeTypesManager_swiginit(self,_misc_.new_MimeTypesManager(*args, **kwargs))
2557 def Initialize(*args, **kwargs):
2558 """Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)"""
2559 return _misc_.MimeTypesManager_Initialize(*args, **kwargs)
2560
2561 def ClearData(*args, **kwargs):
2562 """ClearData(self)"""
2563 return _misc_.MimeTypesManager_ClearData(*args, **kwargs)
2564
2565 def GetFileTypeFromExtension(*args, **kwargs):
2566 """GetFileTypeFromExtension(self, String ext) -> FileType"""
2567 return _misc_.MimeTypesManager_GetFileTypeFromExtension(*args, **kwargs)
2568
2569 def GetFileTypeFromMimeType(*args, **kwargs):
2570 """GetFileTypeFromMimeType(self, String mimeType) -> FileType"""
2571 return _misc_.MimeTypesManager_GetFileTypeFromMimeType(*args, **kwargs)
2572
2573 def ReadMailcap(*args, **kwargs):
2574 """ReadMailcap(self, String filename, bool fallback=False) -> bool"""
2575 return _misc_.MimeTypesManager_ReadMailcap(*args, **kwargs)
2576
2577 def ReadMimeTypes(*args, **kwargs):
2578 """ReadMimeTypes(self, String filename) -> bool"""
2579 return _misc_.MimeTypesManager_ReadMimeTypes(*args, **kwargs)
2580
2581 def EnumAllFileTypes(*args, **kwargs):
2582 """EnumAllFileTypes(self) -> PyObject"""
2583 return _misc_.MimeTypesManager_EnumAllFileTypes(*args, **kwargs)
2584
2585 def AddFallback(*args, **kwargs):
2586 """AddFallback(self, FileTypeInfo ft)"""
2587 return _misc_.MimeTypesManager_AddFallback(*args, **kwargs)
2588
2589 def Associate(*args, **kwargs):
2590 """Associate(self, FileTypeInfo ftInfo) -> FileType"""
2591 return _misc_.MimeTypesManager_Associate(*args, **kwargs)
2592
2593 def Unassociate(*args, **kwargs):
2594 """Unassociate(self, FileType ft) -> bool"""
2595 return _misc_.MimeTypesManager_Unassociate(*args, **kwargs)
2596
2597 __swig_destroy__ = _misc_.delete_MimeTypesManager
2598 __del__ = lambda self : None;
2599 _misc_.MimeTypesManager_swigregister(MimeTypesManager)
2600 TheMimeTypesManager = cvar.TheMimeTypesManager
2601
2602 def MimeTypesManager_IsOfType(*args, **kwargs):
2603 """MimeTypesManager_IsOfType(String mimeType, String wildcard) -> bool"""
2604 return _misc_.MimeTypesManager_IsOfType(*args, **kwargs)
2605
2606 #---------------------------------------------------------------------------
2607
2608 class ArtProvider(object):
2609 """
2610 The wx.ArtProvider class is used to customize the look of wxWidgets
2611 application. When wxWidgets needs to display an icon or a bitmap (e.g.
2612 in the standard file dialog), it does not use hard-coded resource but
2613 asks wx.ArtProvider for it instead. This way the users can plug in
2614 their own wx.ArtProvider class and easily replace standard art with
2615 his/her own version. It is easy thing to do: all that is needed is
2616 to derive a class from wx.ArtProvider, override it's CreateBitmap
2617 method and register the provider with `wx.ArtProvider.Push`::
2618
2619 class MyArtProvider(wx.ArtProvider):
2620 def __init__(self):
2621 wx.ArtProvider.__init__(self)
2622
2623 def CreateBitmap(self, artid, client, size):
2624 ...
2625 return bmp
2626
2627 """
2628 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2629 __repr__ = _swig_repr
2630 def __init__(self, *args, **kwargs):
2631 """
2632 __init__(self) -> ArtProvider
2633
2634 The wx.ArtProvider class is used to customize the look of wxWidgets
2635 application. When wxWidgets needs to display an icon or a bitmap (e.g.
2636 in the standard file dialog), it does not use hard-coded resource but
2637 asks wx.ArtProvider for it instead. This way the users can plug in
2638 their own wx.ArtProvider class and easily replace standard art with
2639 his/her own version. It is easy thing to do: all that is needed is
2640 to derive a class from wx.ArtProvider, override it's CreateBitmap
2641 method and register the provider with `wx.ArtProvider.Push`::
2642
2643 class MyArtProvider(wx.ArtProvider):
2644 def __init__(self):
2645 wx.ArtProvider.__init__(self)
2646
2647 def CreateBitmap(self, artid, client, size):
2648 ...
2649 return bmp
2650
2651 """
2652 _misc_.ArtProvider_swiginit(self,_misc_.new_ArtProvider(*args, **kwargs))
2653 ArtProvider._setCallbackInfo(self, self, ArtProvider)
2654
2655 __swig_destroy__ = _misc_.delete_ArtProvider
2656 __del__ = lambda self : None;
2657 def _setCallbackInfo(*args, **kwargs):
2658 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2659 return _misc_.ArtProvider__setCallbackInfo(*args, **kwargs)
2660
2661 def Push(*args, **kwargs):
2662 """
2663 Push(ArtProvider provider)
2664
2665 Add new provider to the top of providers stack.
2666 """
2667 return _misc_.ArtProvider_Push(*args, **kwargs)
2668
2669 Push = staticmethod(Push)
2670 PushProvider = Push
2671 def Insert(*args, **kwargs):
2672 """
2673 Insert(ArtProvider provider)
2674
2675 Add new provider to the bottom of providers stack.
2676 """
2677 return _misc_.ArtProvider_Insert(*args, **kwargs)
2678
2679 Insert = staticmethod(Insert)
2680 InsertProvider = Insert
2681 def Pop(*args, **kwargs):
2682 """
2683 Pop() -> bool
2684
2685 Remove latest added provider and delete it.
2686 """
2687 return _misc_.ArtProvider_Pop(*args, **kwargs)
2688
2689 Pop = staticmethod(Pop)
2690 PopProvider = Pop
2691 def Delete(*args, **kwargs):
2692 """
2693 Delete(ArtProvider provider) -> bool
2694
2695 Remove provider. The provider must have been added previously! The
2696 provider is _not_ deleted.
2697 """
2698 val = _misc_.ArtProvider_Delete(*args, **kwargs)
2699 args[1].thisown = 1
2700 return val
2701
2702 Delete = staticmethod(Delete)
2703 RemoveProvider = Delete
2704 def GetBitmap(*args, **kwargs):
2705 """
2706 GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
2707
2708 Query the providers for bitmap with given ID and return it. Return
2709 wx.NullBitmap if no provider provides it.
2710 """
2711 return _misc_.ArtProvider_GetBitmap(*args, **kwargs)
2712
2713 GetBitmap = staticmethod(GetBitmap)
2714 def GetIcon(*args, **kwargs):
2715 """
2716 GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
2717
2718 Query the providers for icon with given ID and return it. Return
2719 wx.NullIcon if no provider provides it.
2720 """
2721 return _misc_.ArtProvider_GetIcon(*args, **kwargs)
2722
2723 GetIcon = staticmethod(GetIcon)
2724 def GetSizeHint(*args, **kwargs):
2725 """
2726 GetSizeHint(String client, bool platform_dependent=False) -> Size
2727
2728 Get the size hint of an icon from a specific Art Client, queries the
2729 topmost provider if platform_dependent = false
2730 """
2731 return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
2732
2733 GetSizeHint = staticmethod(GetSizeHint)
2734 def Destroy(*args, **kwargs):
2735 """Destroy(self)"""
2736 args[0].this.own(False)
2737 return _misc_.ArtProvider_Destroy(*args, **kwargs)
2738
2739 _misc_.ArtProvider_swigregister(ArtProvider)
2740 ART_TOOLBAR = cvar.ART_TOOLBAR
2741 ART_MENU = cvar.ART_MENU
2742 ART_FRAME_ICON = cvar.ART_FRAME_ICON
2743 ART_CMN_DIALOG = cvar.ART_CMN_DIALOG
2744 ART_HELP_BROWSER = cvar.ART_HELP_BROWSER
2745 ART_MESSAGE_BOX = cvar.ART_MESSAGE_BOX
2746 ART_BUTTON = cvar.ART_BUTTON
2747 ART_OTHER = cvar.ART_OTHER
2748 ART_ADD_BOOKMARK = cvar.ART_ADD_BOOKMARK
2749 ART_DEL_BOOKMARK = cvar.ART_DEL_BOOKMARK
2750 ART_HELP_SIDE_PANEL = cvar.ART_HELP_SIDE_PANEL
2751 ART_HELP_SETTINGS = cvar.ART_HELP_SETTINGS
2752 ART_HELP_BOOK = cvar.ART_HELP_BOOK
2753 ART_HELP_FOLDER = cvar.ART_HELP_FOLDER
2754 ART_HELP_PAGE = cvar.ART_HELP_PAGE
2755 ART_GO_BACK = cvar.ART_GO_BACK
2756 ART_GO_FORWARD = cvar.ART_GO_FORWARD
2757 ART_GO_UP = cvar.ART_GO_UP
2758 ART_GO_DOWN = cvar.ART_GO_DOWN
2759 ART_GO_TO_PARENT = cvar.ART_GO_TO_PARENT
2760 ART_GO_HOME = cvar.ART_GO_HOME
2761 ART_FILE_OPEN = cvar.ART_FILE_OPEN
2762 ART_FILE_SAVE = cvar.ART_FILE_SAVE
2763 ART_FILE_SAVE_AS = cvar.ART_FILE_SAVE_AS
2764 ART_PRINT = cvar.ART_PRINT
2765 ART_HELP = cvar.ART_HELP
2766 ART_TIP = cvar.ART_TIP
2767 ART_REPORT_VIEW = cvar.ART_REPORT_VIEW
2768 ART_LIST_VIEW = cvar.ART_LIST_VIEW
2769 ART_NEW_DIR = cvar.ART_NEW_DIR
2770 ART_HARDDISK = cvar.ART_HARDDISK
2771 ART_FLOPPY = cvar.ART_FLOPPY
2772 ART_CDROM = cvar.ART_CDROM
2773 ART_REMOVABLE = cvar.ART_REMOVABLE
2774 ART_FOLDER = cvar.ART_FOLDER
2775 ART_FOLDER_OPEN = cvar.ART_FOLDER_OPEN
2776 ART_GO_DIR_UP = cvar.ART_GO_DIR_UP
2777 ART_EXECUTABLE_FILE = cvar.ART_EXECUTABLE_FILE
2778 ART_NORMAL_FILE = cvar.ART_NORMAL_FILE
2779 ART_TICK_MARK = cvar.ART_TICK_MARK
2780 ART_CROSS_MARK = cvar.ART_CROSS_MARK
2781 ART_ERROR = cvar.ART_ERROR
2782 ART_QUESTION = cvar.ART_QUESTION
2783 ART_WARNING = cvar.ART_WARNING
2784 ART_INFORMATION = cvar.ART_INFORMATION
2785 ART_MISSING_IMAGE = cvar.ART_MISSING_IMAGE
2786 ART_COPY = cvar.ART_COPY
2787 ART_CUT = cvar.ART_CUT
2788 ART_PASTE = cvar.ART_PASTE
2789 ART_DELETE = cvar.ART_DELETE
2790 ART_NEW = cvar.ART_NEW
2791 ART_UNDO = cvar.ART_UNDO
2792 ART_REDO = cvar.ART_REDO
2793 ART_QUIT = cvar.ART_QUIT
2794 ART_FIND = cvar.ART_FIND
2795 ART_FIND_AND_REPLACE = cvar.ART_FIND_AND_REPLACE
2796
2797 def ArtProvider_Push(*args, **kwargs):
2798 """
2799 ArtProvider_Push(ArtProvider provider)
2800
2801 Add new provider to the top of providers stack.
2802 """
2803 return _misc_.ArtProvider_Push(*args, **kwargs)
2804
2805 def ArtProvider_Insert(*args, **kwargs):
2806 """
2807 ArtProvider_Insert(ArtProvider provider)
2808
2809 Add new provider to the bottom of providers stack.
2810 """
2811 return _misc_.ArtProvider_Insert(*args, **kwargs)
2812
2813 def ArtProvider_Pop(*args):
2814 """
2815 ArtProvider_Pop() -> bool
2816
2817 Remove latest added provider and delete it.
2818 """
2819 return _misc_.ArtProvider_Pop(*args)
2820
2821 def ArtProvider_Delete(*args, **kwargs):
2822 """
2823 ArtProvider_Delete(ArtProvider provider) -> bool
2824
2825 Remove provider. The provider must have been added previously! The
2826 provider is _not_ deleted.
2827 """
2828 val = _misc_.ArtProvider_Delete(*args, **kwargs)
2829 args[1].thisown = 1
2830 return val
2831
2832 def ArtProvider_GetBitmap(*args, **kwargs):
2833 """
2834 ArtProvider_GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
2835
2836 Query the providers for bitmap with given ID and return it. Return
2837 wx.NullBitmap if no provider provides it.
2838 """
2839 return _misc_.ArtProvider_GetBitmap(*args, **kwargs)
2840
2841 def ArtProvider_GetIcon(*args, **kwargs):
2842 """
2843 ArtProvider_GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
2844
2845 Query the providers for icon with given ID and return it. Return
2846 wx.NullIcon if no provider provides it.
2847 """
2848 return _misc_.ArtProvider_GetIcon(*args, **kwargs)
2849
2850 def ArtProvider_GetSizeHint(*args, **kwargs):
2851 """
2852 ArtProvider_GetSizeHint(String client, bool platform_dependent=False) -> Size
2853
2854 Get the size hint of an icon from a specific Art Client, queries the
2855 topmost provider if platform_dependent = false
2856 """
2857 return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
2858
2859 #---------------------------------------------------------------------------
2860
2861 CONFIG_USE_LOCAL_FILE = _misc_.CONFIG_USE_LOCAL_FILE
2862 CONFIG_USE_GLOBAL_FILE = _misc_.CONFIG_USE_GLOBAL_FILE
2863 CONFIG_USE_RELATIVE_PATH = _misc_.CONFIG_USE_RELATIVE_PATH
2864 CONFIG_USE_NO_ESCAPE_CHARACTERS = _misc_.CONFIG_USE_NO_ESCAPE_CHARACTERS
2865 class ConfigBase(object):
2866 """
2867 wx.ConfigBase class defines the basic interface of all config
2868 classes. It can not be used by itself (it is an abstract base class)
2869 and you will always use one of its derivations: wx.Config or
2870 wx.FileConfig.
2871
2872 wx.ConfigBase organizes the items in a tree-like structure, modeled
2873 after the Unix/Dos filesystem. There are groups that act like
2874 directories and entries, key/value pairs that act like files. There
2875 is always one current group given by the current path. As in the file
2876 system case, to specify a key in the config class you must use a path
2877 to it. Config classes also support the notion of the current group,
2878 which makes it possible to use relative paths.
2879
2880 Keys are pairs "key_name = value" where value may be of string,
2881 integer floating point or boolean, you can not store binary data
2882 without first encoding it as a string. For performance reasons items
2883 should be kept small, no more than a couple kilobytes.
2884
2885 """
2886 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2887 def __init__(self): raise AttributeError, "No constructor defined"
2888 __repr__ = _swig_repr
2889 __swig_destroy__ = _misc_.delete_ConfigBase
2890 __del__ = lambda self : None;
2891 Type_Unknown = _misc_.ConfigBase_Type_Unknown
2892 Type_String = _misc_.ConfigBase_Type_String
2893 Type_Boolean = _misc_.ConfigBase_Type_Boolean
2894 Type_Integer = _misc_.ConfigBase_Type_Integer
2895 Type_Float = _misc_.ConfigBase_Type_Float
2896 def Set(*args, **kwargs):
2897 """
2898 Set(ConfigBase config) -> ConfigBase
2899
2900 Sets the global config object (the one returned by Get) and returns a
2901 reference to the previous global config object.
2902 """
2903 return _misc_.ConfigBase_Set(*args, **kwargs)
2904
2905 Set = staticmethod(Set)
2906 def Get(*args, **kwargs):
2907 """
2908 Get(bool createOnDemand=True) -> ConfigBase
2909
2910 Returns the current global config object, creating one if neccessary.
2911 """
2912 return _misc_.ConfigBase_Get(*args, **kwargs)
2913
2914 Get = staticmethod(Get)
2915 def Create(*args, **kwargs):
2916 """
2917 Create() -> ConfigBase
2918
2919 Create and return a new global config object. This function will
2920 create the "best" implementation of wx.Config available for the
2921 current platform.
2922 """
2923 return _misc_.ConfigBase_Create(*args, **kwargs)
2924
2925 Create = staticmethod(Create)
2926 def DontCreateOnDemand(*args, **kwargs):
2927 """
2928 DontCreateOnDemand()
2929
2930 Should Get() try to create a new log object if there isn't a current
2931 one?
2932 """
2933 return _misc_.ConfigBase_DontCreateOnDemand(*args, **kwargs)
2934
2935 DontCreateOnDemand = staticmethod(DontCreateOnDemand)
2936 def SetPath(*args, **kwargs):
2937 """
2938 SetPath(self, String path)
2939
2940 Set current path: if the first character is '/', it's the absolute
2941 path, otherwise it's a relative path. '..' is supported. If the
2942 strPath doesn't exist it is created.
2943 """
2944 return _misc_.ConfigBase_SetPath(*args, **kwargs)
2945
2946 def GetPath(*args, **kwargs):
2947 """
2948 GetPath(self) -> String
2949
2950 Retrieve the current path (always as absolute path)
2951 """
2952 return _misc_.ConfigBase_GetPath(*args, **kwargs)
2953
2954 def GetFirstGroup(*args, **kwargs):
2955 """
2956 GetFirstGroup() -> (more, value, index)
2957
2958 Allows enumerating the subgroups in a config object. Returns a tuple
2959 containing a flag indicating there are more items, the name of the
2960 current item, and an index to pass to GetNextGroup to fetch the next
2961 item.
2962 """
2963 return _misc_.ConfigBase_GetFirstGroup(*args, **kwargs)
2964
2965 def GetNextGroup(*args, **kwargs):
2966 """
2967 GetNextGroup(long index) -> (more, value, index)
2968
2969 Allows enumerating the subgroups in a config object. Returns a tuple
2970 containing a flag indicating there are more items, the name of the
2971 current item, and an index to pass to GetNextGroup to fetch the next
2972 item.
2973 """
2974 return _misc_.ConfigBase_GetNextGroup(*args, **kwargs)
2975
2976 def GetFirstEntry(*args, **kwargs):
2977 """
2978 GetFirstEntry() -> (more, value, index)
2979
2980 Allows enumerating the entries in the current group in a config
2981 object. Returns a tuple containing a flag indicating there are more
2982 items, the name of the current item, and an index to pass to
2983 GetNextGroup to fetch the next item.
2984 """
2985 return _misc_.ConfigBase_GetFirstEntry(*args, **kwargs)
2986
2987 def GetNextEntry(*args, **kwargs):
2988 """
2989 GetNextEntry(long index) -> (more, value, index)
2990
2991 Allows enumerating the entries in the current group in a config
2992 object. Returns a tuple containing a flag indicating there are more
2993 items, the name of the current item, and an index to pass to
2994 GetNextGroup to fetch the next item.
2995 """
2996 return _misc_.ConfigBase_GetNextEntry(*args, **kwargs)
2997
2998 def GetNumberOfEntries(*args, **kwargs):
2999 """
3000 GetNumberOfEntries(self, bool recursive=False) -> size_t
3001
3002 Get the number of entries in the current group, with or without its
3003 subgroups.
3004 """
3005 return _misc_.ConfigBase_GetNumberOfEntries(*args, **kwargs)
3006
3007 def GetNumberOfGroups(*args, **kwargs):
3008 """
3009 GetNumberOfGroups(self, bool recursive=False) -> size_t
3010
3011 Get the number of subgroups in the current group, with or without its
3012 subgroups.
3013 """
3014 return _misc_.ConfigBase_GetNumberOfGroups(*args, **kwargs)
3015
3016 def HasGroup(*args, **kwargs):
3017 """
3018 HasGroup(self, String name) -> bool
3019
3020 Returns True if the group by this name exists
3021 """
3022 return _misc_.ConfigBase_HasGroup(*args, **kwargs)
3023
3024 def HasEntry(*args, **kwargs):
3025 """
3026 HasEntry(self, String name) -> bool
3027
3028 Returns True if the entry by this name exists
3029 """
3030 return _misc_.ConfigBase_HasEntry(*args, **kwargs)
3031
3032 def Exists(*args, **kwargs):
3033 """
3034 Exists(self, String name) -> bool
3035
3036 Returns True if either a group or an entry with a given name exists
3037 """
3038 return _misc_.ConfigBase_Exists(*args, **kwargs)
3039
3040 def GetEntryType(*args, **kwargs):
3041 """
3042 GetEntryType(self, String name) -> int
3043
3044 Get the type of the entry. Returns one of the wx.Config.Type_XXX values.
3045 """
3046 return _misc_.ConfigBase_GetEntryType(*args, **kwargs)
3047
3048 def Read(*args, **kwargs):
3049 """
3050 Read(self, String key, String defaultVal=EmptyString) -> String
3051
3052 Returns the value of key if it exists, defaultVal otherwise.
3053 """
3054 return _misc_.ConfigBase_Read(*args, **kwargs)
3055
3056 def ReadInt(*args, **kwargs):
3057 """
3058 ReadInt(self, String key, long defaultVal=0) -> long
3059
3060 Returns the value of key if it exists, defaultVal otherwise.
3061 """
3062 return _misc_.ConfigBase_ReadInt(*args, **kwargs)
3063
3064 def ReadFloat(*args, **kwargs):
3065 """
3066 ReadFloat(self, String key, double defaultVal=0.0) -> double
3067
3068 Returns the value of key if it exists, defaultVal otherwise.
3069 """
3070 return _misc_.ConfigBase_ReadFloat(*args, **kwargs)
3071
3072 def ReadBool(*args, **kwargs):
3073 """
3074 ReadBool(self, String key, bool defaultVal=False) -> bool
3075
3076 Returns the value of key if it exists, defaultVal otherwise.
3077 """
3078 return _misc_.ConfigBase_ReadBool(*args, **kwargs)
3079
3080 def Write(*args, **kwargs):
3081 """
3082 Write(self, String key, String value) -> bool
3083
3084 write the value (return True on success)
3085 """
3086 return _misc_.ConfigBase_Write(*args, **kwargs)
3087
3088 def WriteInt(*args, **kwargs):
3089 """
3090 WriteInt(self, String key, long value) -> bool
3091
3092 write the value (return True on success)
3093 """
3094 return _misc_.ConfigBase_WriteInt(*args, **kwargs)
3095
3096 def WriteFloat(*args, **kwargs):
3097 """
3098 WriteFloat(self, String key, double value) -> bool
3099
3100 write the value (return True on success)
3101 """
3102 return _misc_.ConfigBase_WriteFloat(*args, **kwargs)
3103
3104 def WriteBool(*args, **kwargs):
3105 """
3106 WriteBool(self, String key, bool value) -> bool
3107
3108 write the value (return True on success)
3109 """
3110 return _misc_.ConfigBase_WriteBool(*args, **kwargs)
3111
3112 def Flush(*args, **kwargs):
3113 """
3114 Flush(self, bool currentOnly=False) -> bool
3115
3116 permanently writes all changes
3117 """
3118 return _misc_.ConfigBase_Flush(*args, **kwargs)
3119
3120 def RenameEntry(*args, **kwargs):
3121 """
3122 RenameEntry(self, String oldName, String newName) -> bool
3123
3124 Rename an entry. Returns False on failure (probably because the new
3125 name is already taken by an existing entry)
3126 """
3127 return _misc_.ConfigBase_RenameEntry(*args, **kwargs)
3128
3129 def RenameGroup(*args, **kwargs):
3130 """
3131 RenameGroup(self, String oldName, String newName) -> bool
3132
3133 Rename a group. Returns False on failure (probably because the new
3134 name is already taken by an existing entry)
3135 """
3136 return _misc_.ConfigBase_RenameGroup(*args, **kwargs)
3137
3138 def DeleteEntry(*args, **kwargs):
3139 """
3140 DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool
3141
3142 Deletes the specified entry and the group it belongs to if it was the
3143 last key in it and the second parameter is True
3144 """
3145 return _misc_.ConfigBase_DeleteEntry(*args, **kwargs)
3146
3147 def DeleteGroup(*args, **kwargs):
3148 """
3149 DeleteGroup(self, String key) -> bool
3150
3151 Delete the group (with all subgroups)
3152 """
3153 return _misc_.ConfigBase_DeleteGroup(*args, **kwargs)
3154
3155 def DeleteAll(*args, **kwargs):
3156 """
3157 DeleteAll(self) -> bool
3158
3159 Delete the whole underlying object (disk file, registry key, ...)
3160 primarly intended for use by deinstallation routine.
3161 """
3162 return _misc_.ConfigBase_DeleteAll(*args, **kwargs)
3163
3164 def SetExpandEnvVars(*args, **kwargs):
3165 """
3166 SetExpandEnvVars(self, bool doIt=True)
3167
3168 We can automatically expand environment variables in the config
3169 entries this option is on by default, you can turn it on/off at any
3170 time)
3171 """
3172 return _misc_.ConfigBase_SetExpandEnvVars(*args, **kwargs)
3173
3174 def IsExpandingEnvVars(*args, **kwargs):
3175 """
3176 IsExpandingEnvVars(self) -> bool
3177
3178 Are we currently expanding environment variables?
3179 """
3180 return _misc_.ConfigBase_IsExpandingEnvVars(*args, **kwargs)
3181
3182 def SetRecordDefaults(*args, **kwargs):
3183 """
3184 SetRecordDefaults(self, bool doIt=True)
3185
3186 Set whether the config objec should record default values.
3187 """
3188 return _misc_.ConfigBase_SetRecordDefaults(*args, **kwargs)
3189
3190 def IsRecordingDefaults(*args, **kwargs):
3191 """
3192 IsRecordingDefaults(self) -> bool
3193
3194 Are we currently recording default values?
3195 """
3196 return _misc_.ConfigBase_IsRecordingDefaults(*args, **kwargs)
3197
3198 def ExpandEnvVars(*args, **kwargs):
3199 """
3200 ExpandEnvVars(self, String str) -> String
3201
3202 Expand any environment variables in str and return the result
3203 """
3204 return _misc_.ConfigBase_ExpandEnvVars(*args, **kwargs)
3205
3206 def GetAppName(*args, **kwargs):
3207 """GetAppName(self) -> String"""
3208 return _misc_.ConfigBase_GetAppName(*args, **kwargs)
3209
3210 def GetVendorName(*args, **kwargs):
3211 """GetVendorName(self) -> String"""
3212 return _misc_.ConfigBase_GetVendorName(*args, **kwargs)
3213
3214 def SetAppName(*args, **kwargs):
3215 """SetAppName(self, String appName)"""
3216 return _misc_.ConfigBase_SetAppName(*args, **kwargs)
3217
3218 def SetVendorName(*args, **kwargs):
3219 """SetVendorName(self, String vendorName)"""
3220 return _misc_.ConfigBase_SetVendorName(*args, **kwargs)
3221
3222 def SetStyle(*args, **kwargs):
3223 """SetStyle(self, long style)"""
3224 return _misc_.ConfigBase_SetStyle(*args, **kwargs)
3225
3226 def GetStyle(*args, **kwargs):
3227 """GetStyle(self) -> long"""
3228 return _misc_.ConfigBase_GetStyle(*args, **kwargs)
3229
3230 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
3231 EntryType = property(GetEntryType,doc="See `GetEntryType`")
3232 FirstEntry = property(GetFirstEntry,doc="See `GetFirstEntry`")
3233 FirstGroup = property(GetFirstGroup,doc="See `GetFirstGroup`")
3234 NextEntry = property(GetNextEntry,doc="See `GetNextEntry`")
3235 NextGroup = property(GetNextGroup,doc="See `GetNextGroup`")
3236 NumberOfEntries = property(GetNumberOfEntries,doc="See `GetNumberOfEntries`")
3237 NumberOfGroups = property(GetNumberOfGroups,doc="See `GetNumberOfGroups`")
3238 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
3239 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
3240 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
3241 _misc_.ConfigBase_swigregister(ConfigBase)
3242
3243 def ConfigBase_Set(*args, **kwargs):
3244 """
3245 ConfigBase_Set(ConfigBase config) -> ConfigBase
3246
3247 Sets the global config object (the one returned by Get) and returns a
3248 reference to the previous global config object.
3249 """
3250 return _misc_.ConfigBase_Set(*args, **kwargs)
3251
3252 def ConfigBase_Get(*args, **kwargs):
3253 """
3254 ConfigBase_Get(bool createOnDemand=True) -> ConfigBase
3255
3256 Returns the current global config object, creating one if neccessary.
3257 """
3258 return _misc_.ConfigBase_Get(*args, **kwargs)
3259
3260 def ConfigBase_Create(*args):
3261 """
3262 ConfigBase_Create() -> ConfigBase
3263
3264 Create and return a new global config object. This function will
3265 create the "best" implementation of wx.Config available for the
3266 current platform.
3267 """
3268 return _misc_.ConfigBase_Create(*args)
3269
3270 def ConfigBase_DontCreateOnDemand(*args):
3271 """
3272 ConfigBase_DontCreateOnDemand()
3273
3274 Should Get() try to create a new log object if there isn't a current
3275 one?
3276 """
3277 return _misc_.ConfigBase_DontCreateOnDemand(*args)
3278
3279 class Config(ConfigBase):
3280 """
3281 This ConfigBase-derived class will use the registry on Windows,
3282 and will be a wx.FileConfig on other platforms.
3283 """
3284 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3285 __repr__ = _swig_repr
3286 def __init__(self, *args, **kwargs):
3287 """
3288 __init__(self, String appName=EmptyString, String vendorName=EmptyString,
3289 String localFilename=EmptyString, String globalFilename=EmptyString,
3290 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> Config
3291 """
3292 _misc_.Config_swiginit(self,_misc_.new_Config(*args, **kwargs))
3293 __swig_destroy__ = _misc_.delete_Config
3294 __del__ = lambda self : None;
3295 _misc_.Config_swigregister(Config)
3296
3297 class FileConfig(ConfigBase):
3298 """This config class will use a file for storage on all platforms."""
3299 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3300 __repr__ = _swig_repr
3301 def __init__(self, *args, **kwargs):
3302 """
3303 __init__(self, String appName=EmptyString, String vendorName=EmptyString,
3304 String localFilename=EmptyString, String globalFilename=EmptyString,
3305 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig
3306 """
3307 _misc_.FileConfig_swiginit(self,_misc_.new_FileConfig(*args, **kwargs))
3308 __swig_destroy__ = _misc_.delete_FileConfig
3309 __del__ = lambda self : None;
3310 _misc_.FileConfig_swigregister(FileConfig)
3311
3312 class ConfigPathChanger(object):
3313 """
3314 A handy little class which changes current path to the path of given
3315 entry and restores it in the destructoir: so if you declare a local
3316 variable of this type, you work in the entry directory and the path is
3317 automatically restored when the function returns.
3318 """
3319 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3320 __repr__ = _swig_repr
3321 def __init__(self, *args, **kwargs):
3322 """__init__(self, ConfigBase config, String entry) -> ConfigPathChanger"""
3323 _misc_.ConfigPathChanger_swiginit(self,_misc_.new_ConfigPathChanger(*args, **kwargs))
3324 __swig_destroy__ = _misc_.delete_ConfigPathChanger
3325 __del__ = lambda self : None;
3326 def Name(*args, **kwargs):
3327 """
3328 Name(self) -> String
3329
3330 Get the key name
3331 """
3332 return _misc_.ConfigPathChanger_Name(*args, **kwargs)
3333
3334 _misc_.ConfigPathChanger_swigregister(ConfigPathChanger)
3335
3336
3337 def ExpandEnvVars(*args, **kwargs):
3338 """
3339 ExpandEnvVars(String sz) -> String
3340
3341 Replace environment variables ($SOMETHING) with their values. The
3342 format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric
3343 characters and '_' only. '$' must be escaped ('\$') in order to be
3344 taken literally.
3345 """
3346 return _misc_.ExpandEnvVars(*args, **kwargs)
3347 #---------------------------------------------------------------------------
3348
3349 class DateTime(object):
3350 """Proxy of C++ DateTime class"""
3351 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3352 __repr__ = _swig_repr
3353 Local = _misc_.DateTime_Local
3354 GMT_12 = _misc_.DateTime_GMT_12
3355 GMT_11 = _misc_.DateTime_GMT_11
3356 GMT_10 = _misc_.DateTime_GMT_10
3357 GMT_9 = _misc_.DateTime_GMT_9
3358 GMT_8 = _misc_.DateTime_GMT_8
3359 GMT_7 = _misc_.DateTime_GMT_7
3360 GMT_6 = _misc_.DateTime_GMT_6
3361 GMT_5 = _misc_.DateTime_GMT_5
3362 GMT_4 = _misc_.DateTime_GMT_4
3363 GMT_3 = _misc_.DateTime_GMT_3
3364 GMT_2 = _misc_.DateTime_GMT_2
3365 GMT_1 = _misc_.DateTime_GMT_1
3366 GMT0 = _misc_.DateTime_GMT0
3367 GMT1 = _misc_.DateTime_GMT1
3368 GMT2 = _misc_.DateTime_GMT2
3369 GMT3 = _misc_.DateTime_GMT3
3370 GMT4 = _misc_.DateTime_GMT4
3371 GMT5 = _misc_.DateTime_GMT5
3372 GMT6 = _misc_.DateTime_GMT6
3373 GMT7 = _misc_.DateTime_GMT7
3374 GMT8 = _misc_.DateTime_GMT8
3375 GMT9 = _misc_.DateTime_GMT9
3376 GMT10 = _misc_.DateTime_GMT10
3377 GMT11 = _misc_.DateTime_GMT11
3378 GMT12 = _misc_.DateTime_GMT12
3379 GMT13 = _misc_.DateTime_GMT13
3380 WET = _misc_.DateTime_WET
3381 WEST = _misc_.DateTime_WEST
3382 CET = _misc_.DateTime_CET
3383 CEST = _misc_.DateTime_CEST
3384 EET = _misc_.DateTime_EET
3385 EEST = _misc_.DateTime_EEST
3386 MSK = _misc_.DateTime_MSK
3387 MSD = _misc_.DateTime_MSD
3388 AST = _misc_.DateTime_AST
3389 ADT = _misc_.DateTime_ADT
3390 EST = _misc_.DateTime_EST
3391 EDT = _misc_.DateTime_EDT
3392 CST = _misc_.DateTime_CST
3393 CDT = _misc_.DateTime_CDT
3394 MST = _misc_.DateTime_MST
3395 MDT = _misc_.DateTime_MDT
3396 PST = _misc_.DateTime_PST
3397 PDT = _misc_.DateTime_PDT
3398 HST = _misc_.DateTime_HST
3399 AKST = _misc_.DateTime_AKST
3400 AKDT = _misc_.DateTime_AKDT
3401 A_WST = _misc_.DateTime_A_WST
3402 A_CST = _misc_.DateTime_A_CST
3403 A_EST = _misc_.DateTime_A_EST
3404 A_ESST = _misc_.DateTime_A_ESST
3405 NZST = _misc_.DateTime_NZST
3406 NZDT = _misc_.DateTime_NZDT
3407 UTC = _misc_.DateTime_UTC
3408 Gregorian = _misc_.DateTime_Gregorian
3409 Julian = _misc_.DateTime_Julian
3410 Gr_Unknown = _misc_.DateTime_Gr_Unknown
3411 Gr_Standard = _misc_.DateTime_Gr_Standard
3412 Gr_Alaska = _misc_.DateTime_Gr_Alaska
3413 Gr_Albania = _misc_.DateTime_Gr_Albania
3414 Gr_Austria = _misc_.DateTime_Gr_Austria
3415 Gr_Austria_Brixen = _misc_.DateTime_Gr_Austria_Brixen
3416 Gr_Austria_Salzburg = _misc_.DateTime_Gr_Austria_Salzburg
3417 Gr_Austria_Tyrol = _misc_.DateTime_Gr_Austria_Tyrol
3418 Gr_Austria_Carinthia = _misc_.DateTime_Gr_Austria_Carinthia
3419 Gr_Austria_Styria = _misc_.DateTime_Gr_Austria_Styria
3420 Gr_Belgium = _misc_.DateTime_Gr_Belgium
3421 Gr_Bulgaria = _misc_.DateTime_Gr_Bulgaria
3422 Gr_Bulgaria_1 = _misc_.DateTime_Gr_Bulgaria_1
3423 Gr_Bulgaria_2 = _misc_.DateTime_Gr_Bulgaria_2
3424 Gr_Bulgaria_3 = _misc_.DateTime_Gr_Bulgaria_3
3425 Gr_Canada = _misc_.DateTime_Gr_Canada
3426 Gr_China = _misc_.DateTime_Gr_China
3427 Gr_China_1 = _misc_.DateTime_Gr_China_1
3428 Gr_China_2 = _misc_.DateTime_Gr_China_2
3429 Gr_Czechoslovakia = _misc_.DateTime_Gr_Czechoslovakia
3430 Gr_Denmark = _misc_.DateTime_Gr_Denmark
3431 Gr_Egypt = _misc_.DateTime_Gr_Egypt
3432 Gr_Estonia = _misc_.DateTime_Gr_Estonia
3433 Gr_Finland = _misc_.DateTime_Gr_Finland
3434 Gr_France = _misc_.DateTime_Gr_France
3435 Gr_France_Alsace = _misc_.DateTime_Gr_France_Alsace
3436 Gr_France_Lorraine = _misc_.DateTime_Gr_France_Lorraine
3437 Gr_France_Strasbourg = _misc_.DateTime_Gr_France_Strasbourg
3438 Gr_Germany = _misc_.DateTime_Gr_Germany
3439 Gr_Germany_Catholic = _misc_.DateTime_Gr_Germany_Catholic
3440 Gr_Germany_Prussia = _misc_.DateTime_Gr_Germany_Prussia
3441 Gr_Germany_Protestant = _misc_.DateTime_Gr_Germany_Protestant
3442 Gr_GreatBritain = _misc_.DateTime_Gr_GreatBritain
3443 Gr_Greece = _misc_.DateTime_Gr_Greece
3444 Gr_Hungary = _misc_.DateTime_Gr_Hungary
3445 Gr_Ireland = _misc_.DateTime_Gr_Ireland
3446 Gr_Italy = _misc_.DateTime_Gr_Italy
3447 Gr_Japan = _misc_.DateTime_Gr_Japan
3448 Gr_Japan_1 = _misc_.DateTime_Gr_Japan_1
3449 Gr_Japan_2 = _misc_.DateTime_Gr_Japan_2
3450 Gr_Japan_3 = _misc_.DateTime_Gr_Japan_3
3451 Gr_Latvia = _misc_.DateTime_Gr_Latvia
3452 Gr_Lithuania = _misc_.DateTime_Gr_Lithuania
3453 Gr_Luxemburg = _misc_.DateTime_Gr_Luxemburg
3454 Gr_Netherlands = _misc_.DateTime_Gr_Netherlands
3455 Gr_Netherlands_Groningen = _misc_.DateTime_Gr_Netherlands_Groningen
3456 Gr_Netherlands_Gelderland = _misc_.DateTime_Gr_Netherlands_Gelderland
3457 Gr_Netherlands_Utrecht = _misc_.DateTime_Gr_Netherlands_Utrecht
3458 Gr_Netherlands_Friesland = _misc_.DateTime_Gr_Netherlands_Friesland
3459 Gr_Norway = _misc_.DateTime_Gr_Norway
3460 Gr_Poland = _misc_.DateTime_Gr_Poland
3461 Gr_Portugal = _misc_.DateTime_Gr_Portugal
3462 Gr_Romania = _misc_.DateTime_Gr_Romania
3463 Gr_Russia = _misc_.DateTime_Gr_Russia
3464 Gr_Scotland = _misc_.DateTime_Gr_Scotland
3465 Gr_Spain = _misc_.DateTime_Gr_Spain
3466 Gr_Sweden = _misc_.DateTime_Gr_Sweden
3467 Gr_Switzerland = _misc_.DateTime_Gr_Switzerland
3468 Gr_Switzerland_Catholic = _misc_.DateTime_Gr_Switzerland_Catholic
3469 Gr_Switzerland_Protestant = _misc_.DateTime_Gr_Switzerland_Protestant
3470 Gr_Turkey = _misc_.DateTime_Gr_Turkey
3471 Gr_USA = _misc_.DateTime_Gr_USA
3472 Gr_Wales = _misc_.DateTime_Gr_Wales
3473 Gr_Yugoslavia = _misc_.DateTime_Gr_Yugoslavia
3474 Country_Unknown = _misc_.DateTime_Country_Unknown
3475 Country_Default = _misc_.DateTime_Country_Default
3476 Country_WesternEurope_Start = _misc_.DateTime_Country_WesternEurope_Start
3477 Country_EEC = _misc_.DateTime_Country_EEC
3478 France = _misc_.DateTime_France
3479 Germany = _misc_.DateTime_Germany
3480 UK = _misc_.DateTime_UK
3481 Country_WesternEurope_End = _misc_.DateTime_Country_WesternEurope_End
3482 Russia = _misc_.DateTime_Russia
3483 USA = _misc_.DateTime_USA
3484 Jan = _misc_.DateTime_Jan
3485 Feb = _misc_.DateTime_Feb
3486 Mar = _misc_.DateTime_Mar
3487 Apr = _misc_.DateTime_Apr
3488 May = _misc_.DateTime_May
3489 Jun = _misc_.DateTime_Jun
3490 Jul = _misc_.DateTime_Jul
3491 Aug = _misc_.DateTime_Aug
3492 Sep = _misc_.DateTime_Sep
3493 Oct = _misc_.DateTime_Oct
3494 Nov = _misc_.DateTime_Nov
3495 Dec = _misc_.DateTime_Dec
3496 Inv_Month = _misc_.DateTime_Inv_Month
3497 Sun = _misc_.DateTime_Sun
3498 Mon = _misc_.DateTime_Mon
3499 Tue = _misc_.DateTime_Tue
3500 Wed = _misc_.DateTime_Wed
3501 Thu = _misc_.DateTime_Thu
3502 Fri = _misc_.DateTime_Fri
3503 Sat = _misc_.DateTime_Sat
3504 Inv_WeekDay = _misc_.DateTime_Inv_WeekDay
3505 Inv_Year = _misc_.DateTime_Inv_Year
3506 Name_Full = _misc_.DateTime_Name_Full
3507 Name_Abbr = _misc_.DateTime_Name_Abbr
3508 Default_First = _misc_.DateTime_Default_First
3509 Monday_First = _misc_.DateTime_Monday_First
3510 Sunday_First = _misc_.DateTime_Sunday_First
3511 def SetCountry(*args, **kwargs):
3512 """SetCountry(int country)"""
3513 return _misc_.DateTime_SetCountry(*args, **kwargs)
3514
3515 SetCountry = staticmethod(SetCountry)
3516 def GetCountry(*args, **kwargs):
3517 """GetCountry() -> int"""
3518 return _misc_.DateTime_GetCountry(*args, **kwargs)
3519
3520 GetCountry = staticmethod(GetCountry)
3521 def IsWestEuropeanCountry(*args, **kwargs):
3522 """IsWestEuropeanCountry(int country=Country_Default) -> bool"""
3523 return _misc_.DateTime_IsWestEuropeanCountry(*args, **kwargs)
3524
3525 IsWestEuropeanCountry = staticmethod(IsWestEuropeanCountry)
3526 def GetCurrentYear(*args, **kwargs):
3527 """GetCurrentYear(int cal=Gregorian) -> int"""
3528 return _misc_.DateTime_GetCurrentYear(*args, **kwargs)
3529
3530 GetCurrentYear = staticmethod(GetCurrentYear)
3531 def ConvertYearToBC(*args, **kwargs):
3532 """ConvertYearToBC(int year) -> int"""
3533 return _misc_.DateTime_ConvertYearToBC(*args, **kwargs)
3534
3535 ConvertYearToBC = staticmethod(ConvertYearToBC)
3536 def GetCurrentMonth(*args, **kwargs):
3537 """GetCurrentMonth(int cal=Gregorian) -> int"""
3538 return _misc_.DateTime_GetCurrentMonth(*args, **kwargs)
3539
3540 GetCurrentMonth = staticmethod(GetCurrentMonth)
3541 def IsLeapYear(*args, **kwargs):
3542 """IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
3543 return _misc_.DateTime_IsLeapYear(*args, **kwargs)
3544
3545 IsLeapYear = staticmethod(IsLeapYear)
3546 def GetCentury(*args, **kwargs):
3547 """GetCentury(int year=Inv_Year) -> int"""
3548 return _misc_.DateTime_GetCentury(*args, **kwargs)
3549
3550 GetCentury = staticmethod(GetCentury)
3551 def GetNumberOfDaysinYear(*args, **kwargs):
3552 """GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
3553 return _misc_.DateTime_GetNumberOfDaysinYear(*args, **kwargs)
3554
3555 GetNumberOfDaysinYear = staticmethod(GetNumberOfDaysinYear)
3556 def GetNumberOfDaysInMonth(*args, **kwargs):
3557 """GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
3558 return _misc_.DateTime_GetNumberOfDaysInMonth(*args, **kwargs)
3559
3560 GetNumberOfDaysInMonth = staticmethod(GetNumberOfDaysInMonth)
3561 def GetMonthName(*args, **kwargs):
3562 """GetMonthName(int month, int flags=Name_Full) -> String"""
3563 return _misc_.DateTime_GetMonthName(*args, **kwargs)
3564
3565 GetMonthName = staticmethod(GetMonthName)
3566 def GetWeekDayName(*args, **kwargs):
3567 """GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
3568 return _misc_.DateTime_GetWeekDayName(*args, **kwargs)
3569
3570 GetWeekDayName = staticmethod(GetWeekDayName)
3571 def GetAmPmStrings(*args, **kwargs):
3572 """
3573 GetAmPmStrings() -> (am, pm)
3574
3575 Get the AM and PM strings in the current locale (may be empty)
3576 """
3577 return _misc_.DateTime_GetAmPmStrings(*args, **kwargs)
3578
3579 GetAmPmStrings = staticmethod(GetAmPmStrings)
3580 def IsDSTApplicable(*args, **kwargs):
3581 """IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
3582 return _misc_.DateTime_IsDSTApplicable(*args, **kwargs)
3583
3584 IsDSTApplicable = staticmethod(IsDSTApplicable)
3585 def GetBeginDST(*args, **kwargs):
3586 """GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
3587 return _misc_.DateTime_GetBeginDST(*args, **kwargs)
3588
3589 GetBeginDST = staticmethod(GetBeginDST)
3590 def GetEndDST(*args, **kwargs):
3591 """GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
3592 return _misc_.DateTime_GetEndDST(*args, **kwargs)
3593
3594 GetEndDST = staticmethod(GetEndDST)
3595 def Now(*args, **kwargs):
3596 """Now() -> DateTime"""
3597 return _misc_.DateTime_Now(*args, **kwargs)
3598
3599 Now = staticmethod(Now)
3600 def UNow(*args, **kwargs):
3601 """UNow() -> DateTime"""
3602 return _misc_.DateTime_UNow(*args, **kwargs)
3603
3604 UNow = staticmethod(UNow)
3605 def Today(*args, **kwargs):
3606 """Today() -> DateTime"""
3607 return _misc_.DateTime_Today(*args, **kwargs)
3608
3609 Today = staticmethod(Today)
3610 def __init__(self, *args, **kwargs):
3611 """__init__(self) -> DateTime"""
3612 _misc_.DateTime_swiginit(self,_misc_.new_DateTime(*args, **kwargs))
3613 __swig_destroy__ = _misc_.delete_DateTime
3614 __del__ = lambda self : None;
3615 def SetToCurrent(*args, **kwargs):
3616 """SetToCurrent(self) -> DateTime"""
3617 return _misc_.DateTime_SetToCurrent(*args, **kwargs)
3618
3619 def SetTimeT(*args, **kwargs):
3620 """SetTimeT(self, time_t timet) -> DateTime"""
3621 return _misc_.DateTime_SetTimeT(*args, **kwargs)
3622
3623 def SetJDN(*args, **kwargs):
3624 """SetJDN(self, double jdn) -> DateTime"""
3625 return _misc_.DateTime_SetJDN(*args, **kwargs)
3626
3627 def SetHMS(*args, **kwargs):
3628 """SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime"""
3629 return _misc_.DateTime_SetHMS(*args, **kwargs)
3630
3631 def Set(*args, **kwargs):
3632 """
3633 Set(self, int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
3634 int minute=0, int second=0, int millisec=0) -> DateTime
3635 """
3636 return _misc_.DateTime_Set(*args, **kwargs)
3637
3638 def ResetTime(*args, **kwargs):
3639 """ResetTime(self) -> DateTime"""
3640 return _misc_.DateTime_ResetTime(*args, **kwargs)
3641
3642 def GetDateOnly(*args, **kwargs):
3643 """GetDateOnly(self) -> DateTime"""
3644 return _misc_.DateTime_GetDateOnly(*args, **kwargs)
3645
3646 def SetYear(*args, **kwargs):
3647 """SetYear(self, int year) -> DateTime"""
3648 return _misc_.DateTime_SetYear(*args, **kwargs)
3649
3650 def SetMonth(*args, **kwargs):
3651 """SetMonth(self, int month) -> DateTime"""
3652 return _misc_.DateTime_SetMonth(*args, **kwargs)
3653
3654 def SetDay(*args, **kwargs):
3655 """SetDay(self, int day) -> DateTime"""
3656 return _misc_.DateTime_SetDay(*args, **kwargs)
3657
3658 def SetHour(*args, **kwargs):
3659 """SetHour(self, int hour) -> DateTime"""
3660 return _misc_.DateTime_SetHour(*args, **kwargs)
3661
3662 def SetMinute(*args, **kwargs):
3663 """SetMinute(self, int minute) -> DateTime"""
3664 return _misc_.DateTime_SetMinute(*args, **kwargs)
3665
3666 def SetSecond(*args, **kwargs):
3667 """SetSecond(self, int second) -> DateTime"""
3668 return _misc_.DateTime_SetSecond(*args, **kwargs)
3669
3670 def SetMillisecond(*args, **kwargs):
3671 """SetMillisecond(self, int millisecond) -> DateTime"""
3672 return _misc_.DateTime_SetMillisecond(*args, **kwargs)
3673
3674 def SetToWeekDayInSameWeek(*args, **kwargs):
3675 """SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime"""
3676 return _misc_.DateTime_SetToWeekDayInSameWeek(*args, **kwargs)
3677
3678 def GetWeekDayInSameWeek(*args, **kwargs):
3679 """GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime"""
3680 return _misc_.DateTime_GetWeekDayInSameWeek(*args, **kwargs)
3681
3682 def SetToNextWeekDay(*args, **kwargs):
3683 """SetToNextWeekDay(self, int weekday) -> DateTime"""
3684 return _misc_.DateTime_SetToNextWeekDay(*args, **kwargs)
3685
3686 def GetNextWeekDay(*args, **kwargs):
3687 """GetNextWeekDay(self, int weekday) -> DateTime"""
3688 return _misc_.DateTime_GetNextWeekDay(*args, **kwargs)
3689
3690 def SetToPrevWeekDay(*args, **kwargs):
3691 """SetToPrevWeekDay(self, int weekday) -> DateTime"""
3692 return _misc_.DateTime_SetToPrevWeekDay(*args, **kwargs)
3693
3694 def GetPrevWeekDay(*args, **kwargs):
3695 """GetPrevWeekDay(self, int weekday) -> DateTime"""
3696 return _misc_.DateTime_GetPrevWeekDay(*args, **kwargs)
3697
3698 def SetToWeekDay(*args, **kwargs):
3699 """SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool"""
3700 return _misc_.DateTime_SetToWeekDay(*args, **kwargs)
3701
3702 def SetToLastWeekDay(*args, **kwargs):
3703 """SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool"""
3704 return _misc_.DateTime_SetToLastWeekDay(*args, **kwargs)
3705
3706 def GetLastWeekDay(*args, **kwargs):
3707 """GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3708 return _misc_.DateTime_GetLastWeekDay(*args, **kwargs)
3709
3710 def SetToTheWeek(*args, **kwargs):
3711 """SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool"""
3712 return _misc_.DateTime_SetToTheWeek(*args, **kwargs)
3713
3714 def GetWeek(*args, **kwargs):
3715 """GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime"""
3716 return _misc_.DateTime_GetWeek(*args, **kwargs)
3717
3718 SetToTheWeek = wx._deprecated(SetToTheWeek, "SetToTheWeek is deprecated, use (static) SetToWeekOfYear instead")
3719 GetWeek = wx._deprecated(GetWeek, "GetWeek is deprecated, use GetWeekOfYear instead")
3720
3721 def SetToWeekOfYear(*args, **kwargs):
3722 """SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime"""
3723 return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs)
3724
3725 SetToWeekOfYear = staticmethod(SetToWeekOfYear)
3726 def SetToLastMonthDay(*args, **kwargs):
3727 """SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3728 return _misc_.DateTime_SetToLastMonthDay(*args, **kwargs)
3729
3730 def GetLastMonthDay(*args, **kwargs):
3731 """GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3732 return _misc_.DateTime_GetLastMonthDay(*args, **kwargs)
3733
3734 def SetToYearDay(*args, **kwargs):
3735 """SetToYearDay(self, int yday) -> DateTime"""
3736 return _misc_.DateTime_SetToYearDay(*args, **kwargs)
3737
3738 def GetYearDay(*args, **kwargs):
3739 """GetYearDay(self, int yday) -> DateTime"""
3740 return _misc_.DateTime_GetYearDay(*args, **kwargs)
3741
3742 def GetJulianDayNumber(*args, **kwargs):
3743 """GetJulianDayNumber(self) -> double"""
3744 return _misc_.DateTime_GetJulianDayNumber(*args, **kwargs)
3745
3746 def GetJDN(*args, **kwargs):
3747 """GetJDN(self) -> double"""
3748 return _misc_.DateTime_GetJDN(*args, **kwargs)
3749
3750 def GetModifiedJulianDayNumber(*args, **kwargs):
3751 """GetModifiedJulianDayNumber(self) -> double"""
3752 return _misc_.DateTime_GetModifiedJulianDayNumber(*args, **kwargs)
3753
3754 def GetMJD(*args, **kwargs):
3755 """GetMJD(self) -> double"""
3756 return _misc_.DateTime_GetMJD(*args, **kwargs)
3757
3758 def GetRataDie(*args, **kwargs):
3759 """GetRataDie(self) -> double"""
3760 return _misc_.DateTime_GetRataDie(*args, **kwargs)
3761
3762 def ToTimezone(*args, **kwargs):
3763 """ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3764 return _misc_.DateTime_ToTimezone(*args, **kwargs)
3765
3766 def MakeTimezone(*args, **kwargs):
3767 """MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3768 return _misc_.DateTime_MakeTimezone(*args, **kwargs)
3769
3770 def FromTimezone(*args, **kwargs):
3771 """FromTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3772 return _misc_.DateTime_FromTimezone(*args, **kwargs)
3773
3774 def MakeFromTimezone(*args, **kwargs):
3775 """MakeFromTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3776 return _misc_.DateTime_MakeFromTimezone(*args, **kwargs)
3777
3778 def ToUTC(*args, **kwargs):
3779 """ToUTC(self, bool noDST=False) -> DateTime"""
3780 return _misc_.DateTime_ToUTC(*args, **kwargs)
3781
3782 def MakeUTC(*args, **kwargs):
3783 """MakeUTC(self, bool noDST=False) -> DateTime"""
3784 return _misc_.DateTime_MakeUTC(*args, **kwargs)
3785
3786 def ToGMT(*args, **kwargs):
3787 """ToGMT(self, bool noDST=False) -> DateTime"""
3788 return _misc_.DateTime_ToGMT(*args, **kwargs)
3789
3790 def MakeGMT(*args, **kwargs):
3791 """MakeGMT(self, bool noDST=False) -> DateTime"""
3792 return _misc_.DateTime_MakeGMT(*args, **kwargs)
3793
3794 def FromUTC(*args, **kwargs):
3795 """FromUTC(self, bool noDST=False) -> DateTime"""
3796 return _misc_.DateTime_FromUTC(*args, **kwargs)
3797
3798 def MakeFromUTC(*args, **kwargs):
3799 """MakeFromUTC(self, bool noDST=False) -> DateTime"""
3800 return _misc_.DateTime_MakeFromUTC(*args, **kwargs)
3801
3802 def IsDST(*args, **kwargs):
3803 """IsDST(self, int country=Country_Default) -> int"""
3804 return _misc_.DateTime_IsDST(*args, **kwargs)
3805
3806 def IsValid(*args, **kwargs):
3807 """IsValid(self) -> bool"""
3808 return _misc_.DateTime_IsValid(*args, **kwargs)
3809
3810 IsOk = IsValid
3811 Ok = IsOk
3812 def __nonzero__(self): return self.IsOk()
3813 def GetTicks(*args, **kwargs):
3814 """GetTicks(self) -> time_t"""
3815 return _misc_.DateTime_GetTicks(*args, **kwargs)
3816
3817 def GetYear(*args, **kwargs):
3818 """GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3819 return _misc_.DateTime_GetYear(*args, **kwargs)
3820
3821 def GetMonth(*args, **kwargs):
3822 """GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3823 return _misc_.DateTime_GetMonth(*args, **kwargs)
3824
3825 def GetDay(*args, **kwargs):
3826 """GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3827 return _misc_.DateTime_GetDay(*args, **kwargs)
3828
3829 def GetWeekDay(*args, **kwargs):
3830 """GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3831 return _misc_.DateTime_GetWeekDay(*args, **kwargs)
3832
3833 def GetHour(*args, **kwargs):
3834 """GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3835 return _misc_.DateTime_GetHour(*args, **kwargs)
3836
3837 def GetMinute(*args, **kwargs):
3838 """GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3839 return _misc_.DateTime_GetMinute(*args, **kwargs)
3840
3841 def GetSecond(*args, **kwargs):
3842 """GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3843 return _misc_.DateTime_GetSecond(*args, **kwargs)
3844
3845 def GetMillisecond(*args, **kwargs):
3846 """GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3847 return _misc_.DateTime_GetMillisecond(*args, **kwargs)
3848
3849 def GetDayOfYear(*args, **kwargs):
3850 """GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3851 return _misc_.DateTime_GetDayOfYear(*args, **kwargs)
3852
3853 def GetWeekOfYear(*args, **kwargs):
3854 """GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3855 return _misc_.DateTime_GetWeekOfYear(*args, **kwargs)
3856
3857 def GetWeekOfMonth(*args, **kwargs):
3858 """GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3859 return _misc_.DateTime_GetWeekOfMonth(*args, **kwargs)
3860
3861 def IsWorkDay(*args, **kwargs):
3862 """IsWorkDay(self, int country=Country_Default) -> bool"""
3863 return _misc_.DateTime_IsWorkDay(*args, **kwargs)
3864
3865 def IsEqualTo(*args, **kwargs):
3866 """IsEqualTo(self, DateTime datetime) -> bool"""
3867 return _misc_.DateTime_IsEqualTo(*args, **kwargs)
3868
3869 def IsEarlierThan(*args, **kwargs):
3870 """IsEarlierThan(self, DateTime datetime) -> bool"""
3871 return _misc_.DateTime_IsEarlierThan(*args, **kwargs)
3872
3873 def IsLaterThan(*args, **kwargs):
3874 """IsLaterThan(self, DateTime datetime) -> bool"""
3875 return _misc_.DateTime_IsLaterThan(*args, **kwargs)
3876
3877 def IsStrictlyBetween(*args, **kwargs):
3878 """IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool"""
3879 return _misc_.DateTime_IsStrictlyBetween(*args, **kwargs)
3880
3881 def IsBetween(*args, **kwargs):
3882 """IsBetween(self, DateTime t1, DateTime t2) -> bool"""
3883 return _misc_.DateTime_IsBetween(*args, **kwargs)
3884
3885 def IsSameDate(*args, **kwargs):
3886 """IsSameDate(self, DateTime dt) -> bool"""
3887 return _misc_.DateTime_IsSameDate(*args, **kwargs)
3888
3889 def IsSameTime(*args, **kwargs):
3890 """IsSameTime(self, DateTime dt) -> bool"""
3891 return _misc_.DateTime_IsSameTime(*args, **kwargs)
3892
3893 def IsEqualUpTo(*args, **kwargs):
3894 """IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool"""
3895 return _misc_.DateTime_IsEqualUpTo(*args, **kwargs)
3896
3897 def AddTS(*args, **kwargs):
3898 """AddTS(self, TimeSpan diff) -> DateTime"""
3899 return _misc_.DateTime_AddTS(*args, **kwargs)
3900
3901 def AddDS(*args, **kwargs):
3902 """AddDS(self, DateSpan diff) -> DateTime"""
3903 return _misc_.DateTime_AddDS(*args, **kwargs)
3904
3905 def SubtractTS(*args, **kwargs):
3906 """SubtractTS(self, TimeSpan diff) -> DateTime"""
3907 return _misc_.DateTime_SubtractTS(*args, **kwargs)
3908
3909 def SubtractDS(*args, **kwargs):
3910 """SubtractDS(self, DateSpan diff) -> DateTime"""
3911 return _misc_.DateTime_SubtractDS(*args, **kwargs)
3912
3913 def Subtract(*args, **kwargs):
3914 """Subtract(self, DateTime dt) -> TimeSpan"""
3915 return _misc_.DateTime_Subtract(*args, **kwargs)
3916
3917 def __iadd__(*args):
3918 """
3919 __iadd__(self, TimeSpan diff) -> DateTime
3920 __iadd__(self, DateSpan diff) -> DateTime
3921 """
3922 return _misc_.DateTime___iadd__(*args)
3923
3924 def __isub__(*args):
3925 """
3926 __isub__(self, TimeSpan diff) -> DateTime
3927 __isub__(self, DateSpan diff) -> DateTime
3928 """
3929 return _misc_.DateTime___isub__(*args)
3930
3931 def __add__(*args):
3932 """
3933 __add__(self, TimeSpan other) -> DateTime
3934 __add__(self, DateSpan other) -> DateTime
3935 """
3936 return _misc_.DateTime___add__(*args)
3937
3938 def __sub__(*args):
3939 """
3940 __sub__(self, DateTime other) -> TimeSpan
3941 __sub__(self, TimeSpan other) -> DateTime
3942 __sub__(self, DateSpan other) -> DateTime
3943 """
3944 return _misc_.DateTime___sub__(*args)
3945
3946 def __lt__(*args, **kwargs):
3947 """__lt__(self, DateTime other) -> bool"""
3948 return _misc_.DateTime___lt__(*args, **kwargs)
3949
3950 def __le__(*args, **kwargs):
3951 """__le__(self, DateTime other) -> bool"""
3952 return _misc_.DateTime___le__(*args, **kwargs)
3953
3954 def __gt__(*args, **kwargs):
3955 """__gt__(self, DateTime other) -> bool"""
3956 return _misc_.DateTime___gt__(*args, **kwargs)
3957
3958 def __ge__(*args, **kwargs):
3959 """__ge__(self, DateTime other) -> bool"""
3960 return _misc_.DateTime___ge__(*args, **kwargs)
3961
3962 def __eq__(*args, **kwargs):
3963 """__eq__(self, DateTime other) -> bool"""
3964 return _misc_.DateTime___eq__(*args, **kwargs)
3965
3966 def __ne__(*args, **kwargs):
3967 """__ne__(self, DateTime other) -> bool"""
3968 return _misc_.DateTime___ne__(*args, **kwargs)
3969
3970 def ParseRfc822Date(*args, **kwargs):
3971 """ParseRfc822Date(self, String date) -> int"""
3972 return _misc_.DateTime_ParseRfc822Date(*args, **kwargs)
3973
3974 def ParseFormat(*args, **kwargs):
3975 """ParseFormat(self, String date, String format=DefaultDateTimeFormat, DateTime dateDef=DefaultDateTime) -> int"""
3976 return _misc_.DateTime_ParseFormat(*args, **kwargs)
3977
3978 def ParseDateTime(*args, **kwargs):
3979 """ParseDateTime(self, String datetime) -> int"""
3980 return _misc_.DateTime_ParseDateTime(*args, **kwargs)
3981
3982 def ParseDate(*args, **kwargs):
3983 """ParseDate(self, String date) -> int"""
3984 return _misc_.DateTime_ParseDate(*args, **kwargs)
3985
3986 def ParseTime(*args, **kwargs):
3987 """ParseTime(self, String time) -> int"""
3988 return _misc_.DateTime_ParseTime(*args, **kwargs)
3989
3990 def Format(*args, **kwargs):
3991 """Format(self, String format=DefaultDateTimeFormat, wxDateTime::TimeZone tz=LOCAL_TZ) -> String"""
3992 return _misc_.DateTime_Format(*args, **kwargs)
3993
3994 def FormatDate(*args, **kwargs):
3995 """FormatDate(self) -> String"""
3996 return _misc_.DateTime_FormatDate(*args, **kwargs)
3997
3998 def FormatTime(*args, **kwargs):
3999 """FormatTime(self) -> String"""
4000 return _misc_.DateTime_FormatTime(*args, **kwargs)
4001
4002 def FormatISODate(*args, **kwargs):
4003 """FormatISODate(self) -> String"""
4004 return _misc_.DateTime_FormatISODate(*args, **kwargs)
4005
4006 def FormatISOTime(*args, **kwargs):
4007 """FormatISOTime(self) -> String"""
4008 return _misc_.DateTime_FormatISOTime(*args, **kwargs)
4009
4010 def __repr__(self):
4011 if self.IsValid():
4012 f = self.Format().encode(wx.GetDefaultPyEncoding())
4013 return '<wx.DateTime: \"%s\" at %s>' % ( f, self.this)
4014 else:
4015 return '<wx.DateTime: \"INVALID\" at %s>' % self.this
4016 def __str__(self):
4017 if self.IsValid():
4018 return self.Format().encode(wx.GetDefaultPyEncoding())
4019 else:
4020 return "INVALID DateTime"
4021
4022 Day = property(GetDay,SetDay,doc="See `GetDay` and `SetDay`")
4023 DayOfYear = property(GetDayOfYear,doc="See `GetDayOfYear`")
4024 Hour = property(GetHour,SetHour,doc="See `GetHour` and `SetHour`")
4025 JDN = property(GetJDN,SetJDN,doc="See `GetJDN` and `SetJDN`")
4026 JulianDayNumber = property(GetJulianDayNumber,doc="See `GetJulianDayNumber`")
4027 LastMonthDay = property(GetLastMonthDay,doc="See `GetLastMonthDay`")
4028 LastWeekDay = property(GetLastWeekDay,doc="See `GetLastWeekDay`")
4029 MJD = property(GetMJD,doc="See `GetMJD`")
4030 Millisecond = property(GetMillisecond,SetMillisecond,doc="See `GetMillisecond` and `SetMillisecond`")
4031 Minute = property(GetMinute,SetMinute,doc="See `GetMinute` and `SetMinute`")
4032 ModifiedJulianDayNumber = property(GetModifiedJulianDayNumber,doc="See `GetModifiedJulianDayNumber`")
4033 Month = property(GetMonth,SetMonth,doc="See `GetMonth` and `SetMonth`")
4034 NextWeekDay = property(GetNextWeekDay,doc="See `GetNextWeekDay`")
4035 PrevWeekDay = property(GetPrevWeekDay,doc="See `GetPrevWeekDay`")
4036 RataDie = property(GetRataDie,doc="See `GetRataDie`")
4037 Second = property(GetSecond,SetSecond,doc="See `GetSecond` and `SetSecond`")
4038 Ticks = property(GetTicks,doc="See `GetTicks`")
4039 Week = property(GetWeek,doc="See `GetWeek`")
4040 WeekDay = property(GetWeekDay,doc="See `GetWeekDay`")
4041 WeekDayInSameWeek = property(GetWeekDayInSameWeek,doc="See `GetWeekDayInSameWeek`")
4042 WeekOfMonth = property(GetWeekOfMonth,doc="See `GetWeekOfMonth`")
4043 WeekOfYear = property(GetWeekOfYear,doc="See `GetWeekOfYear`")
4044 Year = property(GetYear,SetYear,doc="See `GetYear` and `SetYear`")
4045 YearDay = property(GetYearDay,doc="See `GetYearDay`")
4046 _misc_.DateTime_swigregister(DateTime)
4047 DefaultDateTimeFormat = cvar.DefaultDateTimeFormat
4048 DefaultTimeSpanFormat = cvar.DefaultTimeSpanFormat
4049
4050 def DateTime_SetCountry(*args, **kwargs):
4051 """DateTime_SetCountry(int country)"""
4052 return _misc_.DateTime_SetCountry(*args, **kwargs)
4053
4054 def DateTime_GetCountry(*args):
4055 """DateTime_GetCountry() -> int"""
4056 return _misc_.DateTime_GetCountry(*args)
4057
4058 def DateTime_IsWestEuropeanCountry(*args, **kwargs):
4059 """DateTime_IsWestEuropeanCountry(int country=Country_Default) -> bool"""
4060 return _misc_.DateTime_IsWestEuropeanCountry(*args, **kwargs)
4061
4062 def DateTime_GetCurrentYear(*args, **kwargs):
4063 """DateTime_GetCurrentYear(int cal=Gregorian) -> int"""
4064 return _misc_.DateTime_GetCurrentYear(*args, **kwargs)
4065
4066 def DateTime_ConvertYearToBC(*args, **kwargs):
4067 """DateTime_ConvertYearToBC(int year) -> int"""
4068 return _misc_.DateTime_ConvertYearToBC(*args, **kwargs)
4069
4070 def DateTime_GetCurrentMonth(*args, **kwargs):
4071 """DateTime_GetCurrentMonth(int cal=Gregorian) -> int"""
4072 return _misc_.DateTime_GetCurrentMonth(*args, **kwargs)
4073
4074 def DateTime_IsLeapYear(*args, **kwargs):
4075 """DateTime_IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
4076 return _misc_.DateTime_IsLeapYear(*args, **kwargs)
4077
4078 def DateTime_GetCentury(*args, **kwargs):
4079 """DateTime_GetCentury(int year=Inv_Year) -> int"""
4080 return _misc_.DateTime_GetCentury(*args, **kwargs)
4081
4082 def DateTime_GetNumberOfDaysinYear(*args, **kwargs):
4083 """DateTime_GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
4084 return _misc_.DateTime_GetNumberOfDaysinYear(*args, **kwargs)
4085
4086 def DateTime_GetNumberOfDaysInMonth(*args, **kwargs):
4087 """DateTime_GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
4088 return _misc_.DateTime_GetNumberOfDaysInMonth(*args, **kwargs)
4089
4090 def DateTime_GetMonthName(*args, **kwargs):
4091 """DateTime_GetMonthName(int month, int flags=Name_Full) -> String"""
4092 return _misc_.DateTime_GetMonthName(*args, **kwargs)
4093
4094 def DateTime_GetWeekDayName(*args, **kwargs):
4095 """DateTime_GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
4096 return _misc_.DateTime_GetWeekDayName(*args, **kwargs)
4097
4098 def DateTime_GetAmPmStrings(*args):
4099 """
4100 GetAmPmStrings() -> (am, pm)
4101
4102 Get the AM and PM strings in the current locale (may be empty)
4103 """
4104 return _misc_.DateTime_GetAmPmStrings(*args)
4105
4106 def DateTime_IsDSTApplicable(*args, **kwargs):
4107 """DateTime_IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
4108 return _misc_.DateTime_IsDSTApplicable(*args, **kwargs)
4109
4110 def DateTime_GetBeginDST(*args, **kwargs):
4111 """DateTime_GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
4112 return _misc_.DateTime_GetBeginDST(*args, **kwargs)
4113
4114 def DateTime_GetEndDST(*args, **kwargs):
4115 """DateTime_GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
4116 return _misc_.DateTime_GetEndDST(*args, **kwargs)
4117
4118 def DateTime_Now(*args):
4119 """DateTime_Now() -> DateTime"""
4120 return _misc_.DateTime_Now(*args)
4121
4122 def DateTime_UNow(*args):
4123 """DateTime_UNow() -> DateTime"""
4124 return _misc_.DateTime_UNow(*args)
4125
4126 def DateTime_Today(*args):
4127 """DateTime_Today() -> DateTime"""
4128 return _misc_.DateTime_Today(*args)
4129
4130 def DateTimeFromTimeT(*args, **kwargs):
4131 """DateTimeFromTimeT(time_t timet) -> DateTime"""
4132 val = _misc_.new_DateTimeFromTimeT(*args, **kwargs)
4133 return val
4134
4135 def DateTimeFromJDN(*args, **kwargs):
4136 """DateTimeFromJDN(double jdn) -> DateTime"""
4137 val = _misc_.new_DateTimeFromJDN(*args, **kwargs)
4138 return val
4139
4140 def DateTimeFromHMS(*args, **kwargs):
4141 """DateTimeFromHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime"""
4142 val = _misc_.new_DateTimeFromHMS(*args, **kwargs)
4143 return val
4144
4145 def DateTimeFromDMY(*args, **kwargs):
4146 """
4147 DateTimeFromDMY(int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
4148 int minute=0, int second=0, int millisec=0) -> DateTime
4149 """
4150 val = _misc_.new_DateTimeFromDMY(*args, **kwargs)
4151 return val
4152
4153 def DateTimeFromDateTime(*args, **kwargs):
4154 """DateTimeFromDateTime(DateTime date) -> DateTime"""
4155 val = _misc_.new_DateTimeFromDateTime(*args, **kwargs)
4156 return val
4157
4158 def DateTime_SetToWeekOfYear(*args, **kwargs):
4159 """DateTime_SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime"""
4160 return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs)
4161
4162 class TimeSpan(object):
4163 """Proxy of C++ TimeSpan class"""
4164 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4165 __repr__ = _swig_repr
4166 def Milliseconds(*args, **kwargs):
4167 """Milliseconds(long ms) -> TimeSpan"""
4168 return _misc_.TimeSpan_Milliseconds(*args, **kwargs)
4169
4170 Milliseconds = staticmethod(Milliseconds)
4171 def Millisecond(*args, **kwargs):
4172 """Millisecond() -> TimeSpan"""
4173 return _misc_.TimeSpan_Millisecond(*args, **kwargs)
4174
4175 Millisecond = staticmethod(Millisecond)
4176 def Seconds(*args, **kwargs):
4177 """Seconds(long sec) -> TimeSpan"""
4178 return _misc_.TimeSpan_Seconds(*args, **kwargs)
4179
4180 Seconds = staticmethod(Seconds)
4181 def Second(*args, **kwargs):
4182 """Second() -> TimeSpan"""
4183 return _misc_.TimeSpan_Second(*args, **kwargs)
4184
4185 Second = staticmethod(Second)
4186 def Minutes(*args, **kwargs):
4187 """Minutes(long min) -> TimeSpan"""
4188 return _misc_.TimeSpan_Minutes(*args, **kwargs)
4189
4190 Minutes = staticmethod(Minutes)
4191 def Minute(*args, **kwargs):
4192 """Minute() -> TimeSpan"""
4193 return _misc_.TimeSpan_Minute(*args, **kwargs)
4194
4195 Minute = staticmethod(Minute)
4196 def Hours(*args, **kwargs):
4197 """Hours(long hours) -> TimeSpan"""
4198 return _misc_.TimeSpan_Hours(*args, **kwargs)
4199
4200 Hours = staticmethod(Hours)
4201 def Hour(*args, **kwargs):
4202 """Hour() -> TimeSpan"""
4203 return _misc_.TimeSpan_Hour(*args, **kwargs)
4204
4205 Hour = staticmethod(Hour)
4206 def Days(*args, **kwargs):
4207 """Days(long days) -> TimeSpan"""
4208 return _misc_.TimeSpan_Days(*args, **kwargs)
4209
4210 Days = staticmethod(Days)
4211 def Day(*args, **kwargs):
4212 """Day() -> TimeSpan"""
4213 return _misc_.TimeSpan_Day(*args, **kwargs)
4214
4215 Day = staticmethod(Day)
4216 def Weeks(*args, **kwargs):
4217 """Weeks(long days) -> TimeSpan"""
4218 return _misc_.TimeSpan_Weeks(*args, **kwargs)
4219
4220 Weeks = staticmethod(Weeks)
4221 def Week(*args, **kwargs):
4222 """Week() -> TimeSpan"""
4223 return _misc_.TimeSpan_Week(*args, **kwargs)
4224
4225 Week = staticmethod(Week)
4226 def __init__(self, *args, **kwargs):
4227 """__init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan"""
4228 _misc_.TimeSpan_swiginit(self,_misc_.new_TimeSpan(*args, **kwargs))
4229 __swig_destroy__ = _misc_.delete_TimeSpan
4230 __del__ = lambda self : None;
4231 def Add(*args, **kwargs):
4232 """Add(self, TimeSpan diff) -> TimeSpan"""
4233 return _misc_.TimeSpan_Add(*args, **kwargs)
4234
4235 def Subtract(*args, **kwargs):
4236 """Subtract(self, TimeSpan diff) -> TimeSpan"""
4237 return _misc_.TimeSpan_Subtract(*args, **kwargs)
4238
4239 def Multiply(*args, **kwargs):
4240 """Multiply(self, int n) -> TimeSpan"""
4241 return _misc_.TimeSpan_Multiply(*args, **kwargs)
4242
4243 def Neg(*args, **kwargs):
4244 """Neg(self) -> TimeSpan"""
4245 return _misc_.TimeSpan_Neg(*args, **kwargs)
4246
4247 def Abs(*args, **kwargs):
4248 """Abs(self) -> TimeSpan"""
4249 return _misc_.TimeSpan_Abs(*args, **kwargs)
4250
4251 def __iadd__(*args, **kwargs):
4252 """__iadd__(self, TimeSpan diff) -> TimeSpan"""
4253 return _misc_.TimeSpan___iadd__(*args, **kwargs)
4254
4255 def __isub__(*args, **kwargs):
4256 """__isub__(self, TimeSpan diff) -> TimeSpan"""
4257 return _misc_.TimeSpan___isub__(*args, **kwargs)
4258
4259 def __imul__(*args, **kwargs):
4260 """__imul__(self, int n) -> TimeSpan"""
4261 return _misc_.TimeSpan___imul__(*args, **kwargs)
4262
4263 def __neg__(*args, **kwargs):
4264 """__neg__(self) -> TimeSpan"""
4265 return _misc_.TimeSpan___neg__(*args, **kwargs)
4266
4267 def __add__(*args, **kwargs):
4268 """__add__(self, TimeSpan other) -> TimeSpan"""
4269 return _misc_.TimeSpan___add__(*args, **kwargs)
4270
4271 def __sub__(*args, **kwargs):
4272 """__sub__(self, TimeSpan other) -> TimeSpan"""
4273 return _misc_.TimeSpan___sub__(*args, **kwargs)
4274
4275 def __mul__(*args, **kwargs):
4276 """__mul__(self, int n) -> TimeSpan"""
4277 return _misc_.TimeSpan___mul__(*args, **kwargs)
4278
4279 def __rmul__(*args, **kwargs):
4280 """__rmul__(self, int n) -> TimeSpan"""
4281 return _misc_.TimeSpan___rmul__(*args, **kwargs)
4282
4283 def __lt__(*args, **kwargs):
4284 """__lt__(self, TimeSpan other) -> bool"""
4285 return _misc_.TimeSpan___lt__(*args, **kwargs)
4286
4287 def __le__(*args, **kwargs):
4288 """__le__(self, TimeSpan other) -> bool"""
4289 return _misc_.TimeSpan___le__(*args, **kwargs)
4290
4291 def __gt__(*args, **kwargs):
4292 """__gt__(self, TimeSpan other) -> bool"""
4293 return _misc_.TimeSpan___gt__(*args, **kwargs)
4294
4295 def __ge__(*args, **kwargs):
4296 """__ge__(self, TimeSpan other) -> bool"""
4297 return _misc_.TimeSpan___ge__(*args, **kwargs)
4298
4299 def __eq__(*args, **kwargs):
4300 """__eq__(self, TimeSpan other) -> bool"""
4301 return _misc_.TimeSpan___eq__(*args, **kwargs)
4302
4303 def __ne__(*args, **kwargs):
4304 """__ne__(self, TimeSpan other) -> bool"""
4305 return _misc_.TimeSpan___ne__(*args, **kwargs)
4306
4307 def IsNull(*args, **kwargs):
4308 """IsNull(self) -> bool"""
4309 return _misc_.TimeSpan_IsNull(*args, **kwargs)
4310
4311 def IsPositive(*args, **kwargs):
4312 """IsPositive(self) -> bool"""
4313 return _misc_.TimeSpan_IsPositive(*args, **kwargs)
4314
4315 def IsNegative(*args, **kwargs):
4316 """IsNegative(self) -> bool"""
4317 return _misc_.TimeSpan_IsNegative(*args, **kwargs)
4318
4319 def IsEqualTo(*args, **kwargs):
4320 """IsEqualTo(self, TimeSpan ts) -> bool"""
4321 return _misc_.TimeSpan_IsEqualTo(*args, **kwargs)
4322
4323 def IsLongerThan(*args, **kwargs):
4324 """IsLongerThan(self, TimeSpan ts) -> bool"""
4325 return _misc_.TimeSpan_IsLongerThan(*args, **kwargs)
4326
4327 def IsShorterThan(*args, **kwargs):
4328 """IsShorterThan(self, TimeSpan t) -> bool"""
4329 return _misc_.TimeSpan_IsShorterThan(*args, **kwargs)
4330
4331 def GetWeeks(*args, **kwargs):
4332 """GetWeeks(self) -> int"""
4333 return _misc_.TimeSpan_GetWeeks(*args, **kwargs)
4334
4335 def GetDays(*args, **kwargs):
4336 """GetDays(self) -> int"""
4337 return _misc_.TimeSpan_GetDays(*args, **kwargs)
4338
4339 def GetHours(*args, **kwargs):
4340 """GetHours(self) -> int"""
4341 return _misc_.TimeSpan_GetHours(*args, **kwargs)
4342
4343 def GetMinutes(*args, **kwargs):
4344 """GetMinutes(self) -> int"""
4345 return _misc_.TimeSpan_GetMinutes(*args, **kwargs)
4346
4347 def GetSeconds(*args, **kwargs):
4348 """GetSeconds(self) -> wxLongLong"""
4349 return _misc_.TimeSpan_GetSeconds(*args, **kwargs)
4350
4351 def GetMilliseconds(*args, **kwargs):
4352 """GetMilliseconds(self) -> wxLongLong"""
4353 return _misc_.TimeSpan_GetMilliseconds(*args, **kwargs)
4354
4355 def Format(*args, **kwargs):
4356 """Format(self, String format=DefaultTimeSpanFormat) -> String"""
4357 return _misc_.TimeSpan_Format(*args, **kwargs)
4358
4359 def __repr__(self):
4360 f = self.Format().encode(wx.GetDefaultPyEncoding())
4361 return '<wx.TimeSpan: \"%s\" at %s>' % ( f, self.this)
4362 def __str__(self):
4363 return self.Format().encode(wx.GetDefaultPyEncoding())
4364
4365 Days = property(GetDays,doc="See `GetDays`")
4366 Hours = property(GetHours,doc="See `GetHours`")
4367 Milliseconds = property(GetMilliseconds,doc="See `GetMilliseconds`")
4368 Minutes = property(GetMinutes,doc="See `GetMinutes`")
4369 Seconds = property(GetSeconds,doc="See `GetSeconds`")
4370 Weeks = property(GetWeeks,doc="See `GetWeeks`")
4371 _misc_.TimeSpan_swigregister(TimeSpan)
4372
4373 def TimeSpan_Milliseconds(*args, **kwargs):
4374 """TimeSpan_Milliseconds(long ms) -> TimeSpan"""
4375 return _misc_.TimeSpan_Milliseconds(*args, **kwargs)
4376
4377 def TimeSpan_Millisecond(*args):
4378 """TimeSpan_Millisecond() -> TimeSpan"""
4379 return _misc_.TimeSpan_Millisecond(*args)
4380
4381 def TimeSpan_Seconds(*args, **kwargs):
4382 """TimeSpan_Seconds(long sec) -> TimeSpan"""
4383 return _misc_.TimeSpan_Seconds(*args, **kwargs)
4384
4385 def TimeSpan_Second(*args):
4386 """TimeSpan_Second() -> TimeSpan"""
4387 return _misc_.TimeSpan_Second(*args)
4388
4389 def TimeSpan_Minutes(*args, **kwargs):
4390 """TimeSpan_Minutes(long min) -> TimeSpan"""
4391 return _misc_.TimeSpan_Minutes(*args, **kwargs)
4392
4393 def TimeSpan_Minute(*args):
4394 """TimeSpan_Minute() -> TimeSpan"""
4395 return _misc_.TimeSpan_Minute(*args)
4396
4397 def TimeSpan_Hours(*args, **kwargs):
4398 """TimeSpan_Hours(long hours) -> TimeSpan"""
4399 return _misc_.TimeSpan_Hours(*args, **kwargs)
4400
4401 def TimeSpan_Hour(*args):
4402 """TimeSpan_Hour() -> TimeSpan"""
4403 return _misc_.TimeSpan_Hour(*args)
4404
4405 def TimeSpan_Days(*args, **kwargs):
4406 """TimeSpan_Days(long days) -> TimeSpan"""
4407 return _misc_.TimeSpan_Days(*args, **kwargs)
4408
4409 def TimeSpan_Day(*args):
4410 """TimeSpan_Day() -> TimeSpan"""
4411 return _misc_.TimeSpan_Day(*args)
4412
4413 def TimeSpan_Weeks(*args, **kwargs):
4414 """TimeSpan_Weeks(long days) -> TimeSpan"""
4415 return _misc_.TimeSpan_Weeks(*args, **kwargs)
4416
4417 def TimeSpan_Week(*args):
4418 """TimeSpan_Week() -> TimeSpan"""
4419 return _misc_.TimeSpan_Week(*args)
4420
4421 class DateSpan(object):
4422 """Proxy of C++ DateSpan class"""
4423 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4424 __repr__ = _swig_repr
4425 def __init__(self, *args, **kwargs):
4426 """__init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan"""
4427 _misc_.DateSpan_swiginit(self,_misc_.new_DateSpan(*args, **kwargs))
4428 __swig_destroy__ = _misc_.delete_DateSpan
4429 __del__ = lambda self : None;
4430 def Days(*args, **kwargs):
4431 """Days(int days) -> DateSpan"""
4432 return _misc_.DateSpan_Days(*args, **kwargs)
4433
4434 Days = staticmethod(Days)
4435 def Day(*args, **kwargs):
4436 """Day() -> DateSpan"""
4437 return _misc_.DateSpan_Day(*args, **kwargs)
4438
4439 Day = staticmethod(Day)
4440 def Weeks(*args, **kwargs):
4441 """Weeks(int weeks) -> DateSpan"""
4442 return _misc_.DateSpan_Weeks(*args, **kwargs)
4443
4444 Weeks = staticmethod(Weeks)
4445 def Week(*args, **kwargs):
4446 """Week() -> DateSpan"""
4447 return _misc_.DateSpan_Week(*args, **kwargs)
4448
4449 Week = staticmethod(Week)
4450 def Months(*args, **kwargs):
4451 """Months(int mon) -> DateSpan"""
4452 return _misc_.DateSpan_Months(*args, **kwargs)
4453
4454 Months = staticmethod(Months)
4455 def Month(*args, **kwargs):
4456 """Month() -> DateSpan"""
4457 return _misc_.DateSpan_Month(*args, **kwargs)
4458
4459 Month = staticmethod(Month)
4460 def Years(*args, **kwargs):
4461 """Years(int years) -> DateSpan"""
4462 return _misc_.DateSpan_Years(*args, **kwargs)
4463
4464 Years = staticmethod(Years)
4465 def Year(*args, **kwargs):
4466 """Year() -> DateSpan"""
4467 return _misc_.DateSpan_Year(*args, **kwargs)
4468
4469 Year = staticmethod(Year)
4470 def SetYears(*args, **kwargs):
4471 """SetYears(self, int n) -> DateSpan"""
4472 return _misc_.DateSpan_SetYears(*args, **kwargs)
4473
4474 def SetMonths(*args, **kwargs):
4475 """SetMonths(self, int n) -> DateSpan"""
4476 return _misc_.DateSpan_SetMonths(*args, **kwargs)
4477
4478 def SetWeeks(*args, **kwargs):
4479 """SetWeeks(self, int n) -> DateSpan"""
4480 return _misc_.DateSpan_SetWeeks(*args, **kwargs)
4481
4482 def SetDays(*args, **kwargs):
4483 """SetDays(self, int n) -> DateSpan"""
4484 return _misc_.DateSpan_SetDays(*args, **kwargs)
4485
4486 def GetYears(*args, **kwargs):
4487 """GetYears(self) -> int"""
4488 return _misc_.DateSpan_GetYears(*args, **kwargs)
4489
4490 def GetMonths(*args, **kwargs):
4491 """GetMonths(self) -> int"""
4492 return _misc_.DateSpan_GetMonths(*args, **kwargs)
4493
4494 def GetWeeks(*args, **kwargs):
4495 """GetWeeks(self) -> int"""
4496 return _misc_.DateSpan_GetWeeks(*args, **kwargs)
4497
4498 def GetDays(*args, **kwargs):
4499 """GetDays(self) -> int"""
4500 return _misc_.DateSpan_GetDays(*args, **kwargs)
4501
4502 def GetTotalDays(*args, **kwargs):
4503 """GetTotalDays(self) -> int"""
4504 return _misc_.DateSpan_GetTotalDays(*args, **kwargs)
4505
4506 def Add(*args, **kwargs):
4507 """Add(self, DateSpan other) -> DateSpan"""
4508 return _misc_.DateSpan_Add(*args, **kwargs)
4509
4510 def Subtract(*args, **kwargs):
4511 """Subtract(self, DateSpan other) -> DateSpan"""
4512 return _misc_.DateSpan_Subtract(*args, **kwargs)
4513
4514 def Neg(*args, **kwargs):
4515 """Neg(self) -> DateSpan"""
4516 return _misc_.DateSpan_Neg(*args, **kwargs)
4517
4518 def Multiply(*args, **kwargs):
4519 """Multiply(self, int factor) -> DateSpan"""
4520 return _misc_.DateSpan_Multiply(*args, **kwargs)
4521
4522 def __iadd__(*args, **kwargs):
4523 """__iadd__(self, DateSpan other) -> DateSpan"""
4524 return _misc_.DateSpan___iadd__(*args, **kwargs)
4525
4526 def __isub__(*args, **kwargs):
4527 """__isub__(self, DateSpan other) -> DateSpan"""
4528 return _misc_.DateSpan___isub__(*args, **kwargs)
4529
4530 def __neg__(*args, **kwargs):
4531 """__neg__(self) -> DateSpan"""
4532 return _misc_.DateSpan___neg__(*args, **kwargs)
4533
4534 def __imul__(*args, **kwargs):
4535 """__imul__(self, int factor) -> DateSpan"""
4536 return _misc_.DateSpan___imul__(*args, **kwargs)
4537
4538 def __add__(*args, **kwargs):
4539 """__add__(self, DateSpan other) -> DateSpan"""
4540 return _misc_.DateSpan___add__(*args, **kwargs)
4541
4542 def __sub__(*args, **kwargs):
4543 """__sub__(self, DateSpan other) -> DateSpan"""
4544 return _misc_.DateSpan___sub__(*args, **kwargs)
4545
4546 def __mul__(*args, **kwargs):
4547 """__mul__(self, int n) -> DateSpan"""
4548 return _misc_.DateSpan___mul__(*args, **kwargs)
4549
4550 def __rmul__(*args, **kwargs):
4551 """__rmul__(self, int n) -> DateSpan"""
4552 return _misc_.DateSpan___rmul__(*args, **kwargs)
4553
4554 def __eq__(*args, **kwargs):
4555 """__eq__(self, DateSpan other) -> bool"""
4556 return _misc_.DateSpan___eq__(*args, **kwargs)
4557
4558 def __ne__(*args, **kwargs):
4559 """__ne__(self, DateSpan other) -> bool"""
4560 return _misc_.DateSpan___ne__(*args, **kwargs)
4561
4562 Days = property(GetDays,SetDays,doc="See `GetDays` and `SetDays`")
4563 Months = property(GetMonths,SetMonths,doc="See `GetMonths` and `SetMonths`")
4564 TotalDays = property(GetTotalDays,doc="See `GetTotalDays`")
4565 Weeks = property(GetWeeks,SetWeeks,doc="See `GetWeeks` and `SetWeeks`")
4566 Years = property(GetYears,SetYears,doc="See `GetYears` and `SetYears`")
4567 _misc_.DateSpan_swigregister(DateSpan)
4568
4569 def DateSpan_Days(*args, **kwargs):
4570 """DateSpan_Days(int days) -> DateSpan"""
4571 return _misc_.DateSpan_Days(*args, **kwargs)
4572
4573 def DateSpan_Day(*args):
4574 """DateSpan_Day() -> DateSpan"""
4575 return _misc_.DateSpan_Day(*args)
4576
4577 def DateSpan_Weeks(*args, **kwargs):
4578 """DateSpan_Weeks(int weeks) -> DateSpan"""
4579 return _misc_.DateSpan_Weeks(*args, **kwargs)
4580
4581 def DateSpan_Week(*args):
4582 """DateSpan_Week() -> DateSpan"""
4583 return _misc_.DateSpan_Week(*args)
4584
4585 def DateSpan_Months(*args, **kwargs):
4586 """DateSpan_Months(int mon) -> DateSpan"""
4587 return _misc_.DateSpan_Months(*args, **kwargs)
4588
4589 def DateSpan_Month(*args):
4590 """DateSpan_Month() -> DateSpan"""
4591 return _misc_.DateSpan_Month(*args)
4592
4593 def DateSpan_Years(*args, **kwargs):
4594 """DateSpan_Years(int years) -> DateSpan"""
4595 return _misc_.DateSpan_Years(*args, **kwargs)
4596
4597 def DateSpan_Year(*args):
4598 """DateSpan_Year() -> DateSpan"""
4599 return _misc_.DateSpan_Year(*args)
4600
4601
4602 def GetLocalTime(*args):
4603 """GetLocalTime() -> long"""
4604 return _misc_.GetLocalTime(*args)
4605
4606 def GetUTCTime(*args):
4607 """GetUTCTime() -> long"""
4608 return _misc_.GetUTCTime(*args)
4609
4610 def GetCurrentTime(*args):
4611 """GetCurrentTime() -> long"""
4612 return _misc_.GetCurrentTime(*args)
4613
4614 def GetLocalTimeMillis(*args):
4615 """GetLocalTimeMillis() -> wxLongLong"""
4616 return _misc_.GetLocalTimeMillis(*args)
4617 #---------------------------------------------------------------------------
4618
4619 DF_INVALID = _misc_.DF_INVALID
4620 DF_TEXT = _misc_.DF_TEXT
4621 DF_BITMAP = _misc_.DF_BITMAP
4622 DF_METAFILE = _misc_.DF_METAFILE
4623 DF_SYLK = _misc_.DF_SYLK
4624 DF_DIF = _misc_.DF_DIF
4625 DF_TIFF = _misc_.DF_TIFF
4626 DF_OEMTEXT = _misc_.DF_OEMTEXT
4627 DF_DIB = _misc_.DF_DIB
4628 DF_PALETTE = _misc_.DF_PALETTE
4629 DF_PENDATA = _misc_.DF_PENDATA
4630 DF_RIFF = _misc_.DF_RIFF
4631 DF_WAVE = _misc_.DF_WAVE
4632 DF_UNICODETEXT = _misc_.DF_UNICODETEXT
4633 DF_ENHMETAFILE = _misc_.DF_ENHMETAFILE
4634 DF_FILENAME = _misc_.DF_FILENAME
4635 DF_LOCALE = _misc_.DF_LOCALE
4636 DF_PRIVATE = _misc_.DF_PRIVATE
4637 DF_HTML = _misc_.DF_HTML
4638 DF_MAX = _misc_.DF_MAX
4639 class DataFormat(object):
4640 """
4641 A wx.DataFormat is an encapsulation of a platform-specific format
4642 handle which is used by the system for the clipboard and drag and drop
4643 operations. The applications are usually only interested in, for
4644 example, pasting data from the clipboard only if the data is in a
4645 format the program understands. A data format is is used to uniquely
4646 identify this format.
4647 """
4648 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4649 __repr__ = _swig_repr
4650 def __init__(self, *args, **kwargs):
4651 """
4652 __init__(self, int type) -> DataFormat
4653
4654 Constructs a data format object for one of the standard data formats
4655 or an empty data object (use SetType or SetId later in this case)
4656 """
4657 _misc_.DataFormat_swiginit(self,_misc_.new_DataFormat(*args, **kwargs))
4658 __swig_destroy__ = _misc_.delete_DataFormat
4659 __del__ = lambda self : None;
4660 def __eq__(*args):
4661 """
4662 __eq__(self, int format) -> bool
4663 __eq__(self, DataFormat format) -> bool
4664 """
4665 return _misc_.DataFormat___eq__(*args)
4666
4667 def __ne__(*args):
4668 """
4669 __ne__(self, int format) -> bool
4670 __ne__(self, DataFormat format) -> bool
4671 """
4672 return _misc_.DataFormat___ne__(*args)
4673
4674 def SetType(*args, **kwargs):
4675 """
4676 SetType(self, int format)
4677
4678 Sets the format to the given value, which should be one of wx.DF_XXX
4679 constants.
4680 """
4681 return _misc_.DataFormat_SetType(*args, **kwargs)
4682
4683 def GetType(*args, **kwargs):
4684 """
4685 GetType(self) -> int
4686
4687 Returns the platform-specific number identifying the format.
4688 """
4689 return _misc_.DataFormat_GetType(*args, **kwargs)
4690
4691 def _GetId(*args, **kwargs):
4692 """_GetId(self) -> String"""
4693 return _misc_.DataFormat__GetId(*args, **kwargs)
4694
4695 def GetId(self):
4696 """Returns the name of a custom format (this function will fail for a
4697 format)."""
4698 nolog = wx.LogNull()
4699 return self._GetId()
4700
4701 def SetId(*args, **kwargs):
4702 """
4703 SetId(self, String format)
4704
4705 Sets the format to be the custom format identified by the given name.
4706 """
4707 return _misc_.DataFormat_SetId(*args, **kwargs)
4708
4709 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4710 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
4711 _misc_.DataFormat_swigregister(DataFormat)
4712 DefaultDateTime = cvar.DefaultDateTime
4713
4714 def CustomDataFormat(*args, **kwargs):
4715 """
4716 CustomDataFormat(String format) -> DataFormat
4717
4718 Constructs a data format object for a custom format identified by its
4719 name.
4720 """
4721 val = _misc_.new_CustomDataFormat(*args, **kwargs)
4722 return val
4723
4724 class DataObject(object):
4725 """
4726 A wx.DataObject represents data that can be copied to or from the
4727 clipboard, or dragged and dropped. The important thing about
4728 wx.DataObject is that this is a 'smart' piece of data unlike usual
4729 'dumb' data containers such as memory buffers or files. Being 'smart'
4730 here means that the data object itself should know what data formats
4731 it supports and how to render itself in each of supported formats.
4732
4733 **NOTE**: This class is an abstract base class and can not be used
4734 directly from Python. If you need a custom type of data object then
4735 you should instead derive from `wx.PyDataObjectSimple` or use
4736 `wx.CustomDataObject`.
4737
4738 """
4739 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4740 def __init__(self): raise AttributeError, "No constructor defined"
4741 __repr__ = _swig_repr
4742 Get = _misc_.DataObject_Get
4743 Set = _misc_.DataObject_Set
4744 Both = _misc_.DataObject_Both
4745 __swig_destroy__ = _misc_.delete_DataObject
4746 __del__ = lambda self : None;
4747 def GetPreferredFormat(*args, **kwargs):
4748 """
4749 GetPreferredFormat(self, int dir=Get) -> DataFormat
4750
4751 Returns the preferred format for either rendering the data (if dir is
4752 Get, its default value) or for setting it. Usually this will be the
4753 native format of the wx.DataObject.
4754 """
4755 return _misc_.DataObject_GetPreferredFormat(*args, **kwargs)
4756
4757 def GetFormatCount(*args, **kwargs):
4758 """
4759 GetFormatCount(self, int dir=Get) -> size_t
4760
4761 Returns the number of available formats for rendering or setting the
4762 data.
4763 """
4764 return _misc_.DataObject_GetFormatCount(*args, **kwargs)
4765
4766 def IsSupported(*args, **kwargs):
4767 """
4768 IsSupported(self, DataFormat format, int dir=Get) -> bool
4769
4770 Returns True if this format is supported.
4771 """
4772 return _misc_.DataObject_IsSupported(*args, **kwargs)
4773
4774 def GetDataSize(*args, **kwargs):
4775 """
4776 GetDataSize(self, DataFormat format) -> size_t
4777
4778 Get the (total) size of data for the given format
4779 """
4780 return _misc_.DataObject_GetDataSize(*args, **kwargs)
4781
4782 def GetAllFormats(*args, **kwargs):
4783 """
4784 GetAllFormats(self, int dir=Get) -> [formats]
4785
4786 Returns a list of all the wx.DataFormats that this dataobject supports
4787 in the given direction.
4788 """
4789 return _misc_.DataObject_GetAllFormats(*args, **kwargs)
4790
4791 def GetDataHere(*args, **kwargs):
4792 """
4793 GetDataHere(self, DataFormat format) -> String
4794
4795 Get the data bytes in the specified format, returns None on failure.
4796 """
4797 return _misc_.DataObject_GetDataHere(*args, **kwargs)
4798
4799 def SetData(*args, **kwargs):
4800 """
4801 SetData(self, DataFormat format, String data) -> bool
4802
4803 Set the data in the specified format from the bytes in the the data string.
4804
4805 """
4806 return _misc_.DataObject_SetData(*args, **kwargs)
4807
4808 AllFormats = property(GetAllFormats,doc="See `GetAllFormats`")
4809 DataHere = property(GetDataHere,doc="See `GetDataHere`")
4810 DataSize = property(GetDataSize,doc="See `GetDataSize`")
4811 FormatCount = property(GetFormatCount,doc="See `GetFormatCount`")
4812 PreferredFormat = property(GetPreferredFormat,doc="See `GetPreferredFormat`")
4813 _misc_.DataObject_swigregister(DataObject)
4814 FormatInvalid = cvar.FormatInvalid
4815
4816 class DataObjectSimple(DataObject):
4817 """
4818 wx.DataObjectSimple is a `wx.DataObject` which only supports one
4819 format. This is the simplest possible `wx.DataObject` implementation.
4820
4821 This is still an "abstract base class" meaning that you can't use it
4822 directly. You either need to use one of the predefined base classes,
4823 or derive your own class from `wx.PyDataObjectSimple`.
4824
4825 """
4826 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4827 __repr__ = _swig_repr
4828 def __init__(self, *args, **kwargs):
4829 """
4830 __init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple
4831
4832 Constructor accepts the supported format (none by default) which may
4833 also be set later with `SetFormat`.
4834 """
4835 _misc_.DataObjectSimple_swiginit(self,_misc_.new_DataObjectSimple(*args, **kwargs))
4836 def GetFormat(*args, **kwargs):
4837 """
4838 GetFormat(self) -> DataFormat
4839
4840 Returns the (one and only one) format supported by this object. It is
4841 assumed that the format is supported in both directions.
4842 """
4843 return _misc_.DataObjectSimple_GetFormat(*args, **kwargs)
4844
4845 def SetFormat(*args, **kwargs):
4846 """
4847 SetFormat(self, DataFormat format)
4848
4849 Sets the supported format.
4850 """
4851 return _misc_.DataObjectSimple_SetFormat(*args, **kwargs)
4852
4853 def GetDataSize(*args, **kwargs):
4854 """
4855 GetDataSize(self) -> size_t
4856
4857 Get the size of our data.
4858 """
4859 return _misc_.DataObjectSimple_GetDataSize(*args, **kwargs)
4860
4861 def GetDataHere(*args, **kwargs):
4862 """
4863 GetDataHere(self) -> String
4864
4865 Returns the data bytes from the data object as a string, returns None
4866 on failure. Must be implemented in the derived class if the object
4867 supports rendering its data.
4868 """
4869 return _misc_.DataObjectSimple_GetDataHere(*args, **kwargs)
4870
4871 def SetData(*args, **kwargs):
4872 """
4873 SetData(self, String data) -> bool
4874
4875 Copy the data value to the data object. Must be implemented in the
4876 derived class if the object supports setting its data.
4877
4878 """
4879 return _misc_.DataObjectSimple_SetData(*args, **kwargs)
4880
4881 Format = property(GetFormat,SetFormat,doc="See `GetFormat` and `SetFormat`")
4882 _misc_.DataObjectSimple_swigregister(DataObjectSimple)
4883
4884 class PyDataObjectSimple(DataObjectSimple):
4885 """
4886 wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
4887 Python-aware and knows how to reflect calls to its C++ virtual methods
4888 to methods in the Python derived class. You should derive from this
4889 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
4890 need to create your own simple single-format type of `wx.DataObject`.
4891
4892 """
4893 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4894 __repr__ = _swig_repr
4895 def __init__(self, *args, **kwargs):
4896 """
4897 __init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple
4898
4899 wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
4900 Python-aware and knows how to reflect calls to its C++ virtual methods
4901 to methods in the Python derived class. You should derive from this
4902 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
4903 need to create your own simple single-format type of `wx.DataObject`.
4904
4905 """
4906 _misc_.PyDataObjectSimple_swiginit(self,_misc_.new_PyDataObjectSimple(*args, **kwargs))
4907 PyDataObjectSimple._setCallbackInfo(self, self, PyDataObjectSimple)
4908
4909 def _setCallbackInfo(*args, **kwargs):
4910 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4911 return _misc_.PyDataObjectSimple__setCallbackInfo(*args, **kwargs)
4912
4913 _misc_.PyDataObjectSimple_swigregister(PyDataObjectSimple)
4914
4915 class DataObjectComposite(DataObject):
4916 """
4917 wx.DataObjectComposite is the simplest `wx.DataObject` derivation
4918 which may be sued to support multiple formats. It contains several
4919 'wx.DataObjectSimple` objects and supports any format supported by at
4920 least one of them. Only one of these data objects is *preferred* (the
4921 first one if not explicitly changed by using the second parameter of
4922 `Add`) and its format determines the preferred format of the composite
4923 data object as well.
4924
4925 See `wx.DataObject` documentation for the reasons why you might prefer
4926 to use wx.DataObject directly instead of wx.DataObjectComposite for
4927 efficiency reasons.
4928
4929 """
4930 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4931 __repr__ = _swig_repr
4932 def __init__(self, *args, **kwargs):
4933 """
4934 __init__(self) -> DataObjectComposite
4935
4936 wx.DataObjectComposite is the simplest `wx.DataObject` derivation
4937 which may be sued to support multiple formats. It contains several
4938 'wx.DataObjectSimple` objects and supports any format supported by at
4939 least one of them. Only one of these data objects is *preferred* (the
4940 first one if not explicitly changed by using the second parameter of
4941 `Add`) and its format determines the preferred format of the composite
4942 data object as well.
4943
4944 See `wx.DataObject` documentation for the reasons why you might prefer
4945 to use wx.DataObject directly instead of wx.DataObjectComposite for
4946 efficiency reasons.
4947
4948 """
4949 _misc_.DataObjectComposite_swiginit(self,_misc_.new_DataObjectComposite(*args, **kwargs))
4950 def Add(*args, **kwargs):
4951 """
4952 Add(self, DataObjectSimple dataObject, bool preferred=False)
4953
4954 Adds the dataObject to the list of supported objects and it becomes
4955 the preferred object if preferred is True.
4956 """
4957 return _misc_.DataObjectComposite_Add(*args, **kwargs)
4958
4959 def GetReceivedFormat(*args, **kwargs):
4960 """
4961 GetReceivedFormat(self) -> DataFormat
4962
4963 Report the format passed to the `SetData` method. This should be the
4964 format of the data object within the composite that recieved data from
4965 the clipboard or the DnD operation. You can use this method to find
4966 out what kind of data object was recieved.
4967 """
4968 return _misc_.DataObjectComposite_GetReceivedFormat(*args, **kwargs)
4969
4970 ReceivedFormat = property(GetReceivedFormat,doc="See `GetReceivedFormat`")
4971 _misc_.DataObjectComposite_swigregister(DataObjectComposite)
4972
4973 class TextDataObject(DataObjectSimple):
4974 """
4975 wx.TextDataObject is a specialization of `wx.DataObject` for text
4976 data. It can be used without change to paste data into the `wx.Clipboard`
4977 or a `wx.DropSource`.
4978
4979 Alternativly, you may wish to derive a new class from the
4980 `wx.PyTextDataObject` class for providing text on-demand in order to
4981 minimize memory consumption when offering data in several formats,
4982 such as plain text and RTF, because by default the text is stored in a
4983 string in this class, but it might as well be generated on demand when
4984 requested. For this, `GetTextLength` and `GetText` will have to be
4985 overridden.
4986 """
4987 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4988 __repr__ = _swig_repr
4989 def __init__(self, *args, **kwargs):
4990 """
4991 __init__(self, String text=EmptyString) -> TextDataObject
4992
4993 Constructor, may be used to initialise the text (otherwise `SetText`
4994 should be used later).
4995 """
4996 _misc_.TextDataObject_swiginit(self,_misc_.new_TextDataObject(*args, **kwargs))
4997 def GetTextLength(*args, **kwargs):
4998 """
4999 GetTextLength(self) -> size_t
5000
5001 Returns the data size. By default, returns the size of the text data
5002 set in the constructor or using `SetText`. This can be overridden (via
5003 `wx.PyTextDataObject`) to provide text size data on-demand. It is
5004 recommended to return the text length plus 1 for a trailing zero, but
5005 this is not strictly required.
5006 """
5007 return _misc_.TextDataObject_GetTextLength(*args, **kwargs)
5008
5009 def GetText(*args, **kwargs):
5010 """
5011 GetText(self) -> String
5012
5013 Returns the text associated with the data object.
5014 """
5015 return _misc_.TextDataObject_GetText(*args, **kwargs)
5016
5017 def SetText(*args, **kwargs):
5018 """
5019 SetText(self, String text)
5020
5021 Sets the text associated with the data object. This method is called
5022 when the data object receives the data and, by default, copies the
5023 text into the member variable. If you want to process the text on the
5024 fly you may wish to override this function (via
5025 `wx.PyTextDataObject`.)
5026 """
5027 return _misc_.TextDataObject_SetText(*args, **kwargs)
5028
5029 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
5030 TextLength = property(GetTextLength,doc="See `GetTextLength`")
5031 _misc_.TextDataObject_swigregister(TextDataObject)
5032
5033 class PyTextDataObject(TextDataObject):
5034 """
5035 wx.PyTextDataObject is a version of `wx.TextDataObject` that is
5036 Python-aware and knows how to reflect calls to its C++ virtual methods
5037 to methods in the Python derived class. You should derive from this
5038 class and overload `GetTextLength`, `GetText`, and `SetText` when you
5039 want to be able to provide text on demand instead of preloading it
5040 into the data object.
5041 """
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):
5045 """
5046 __init__(self, String text=EmptyString) -> PyTextDataObject
5047
5048 wx.PyTextDataObject is a version of `wx.TextDataObject` that is
5049 Python-aware and knows how to reflect calls to its C++ virtual methods
5050 to methods in the Python derived class. You should derive from this
5051 class and overload `GetTextLength`, `GetText`, and `SetText` when you
5052 want to be able to provide text on demand instead of preloading it
5053 into the data object.
5054 """
5055 _misc_.PyTextDataObject_swiginit(self,_misc_.new_PyTextDataObject(*args, **kwargs))
5056 PyTextDataObject._setCallbackInfo(self, self, PyTextDataObject)
5057
5058 def _setCallbackInfo(*args, **kwargs):
5059 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5060 return _misc_.PyTextDataObject__setCallbackInfo(*args, **kwargs)
5061
5062 _misc_.PyTextDataObject_swigregister(PyTextDataObject)
5063
5064 class BitmapDataObject(DataObjectSimple):
5065 """
5066 wx.BitmapDataObject is a specialization of wxDataObject for bitmap
5067 data. It can be used without change to paste data into the `wx.Clipboard`
5068 or a `wx.DropSource`.
5069
5070 """
5071 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5072 __repr__ = _swig_repr
5073 def __init__(self, *args, **kwargs):
5074 """
5075 __init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject
5076
5077 Constructor, optionally passing a bitmap (otherwise use `SetBitmap`
5078 later).
5079 """
5080 _misc_.BitmapDataObject_swiginit(self,_misc_.new_BitmapDataObject(*args, **kwargs))
5081 def GetBitmap(*args, **kwargs):
5082 """
5083 GetBitmap(self) -> Bitmap
5084
5085 Returns the bitmap associated with the data object. You may wish to
5086 override this method (by deriving from `wx.PyBitmapDataObject`) when
5087 offering data on-demand, but this is not required by wxWidgets'
5088 internals. Use this method to get data in bitmap form from the
5089 `wx.Clipboard`.
5090 """
5091 return _misc_.BitmapDataObject_GetBitmap(*args, **kwargs)
5092
5093 def SetBitmap(*args, **kwargs):
5094 """
5095 SetBitmap(self, Bitmap bitmap)
5096
5097 Sets the bitmap associated with the data object. This method is called
5098 when the data object receives data. Usually there will be no reason to
5099 override this function.
5100 """
5101 return _misc_.BitmapDataObject_SetBitmap(*args, **kwargs)
5102
5103 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
5104 _misc_.BitmapDataObject_swigregister(BitmapDataObject)
5105
5106 class PyBitmapDataObject(BitmapDataObject):
5107 """
5108 wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
5109 Python-aware and knows how to reflect calls to its C++ virtual methods
5110 to methods in the Python derived class. To be able to provide bitmap
5111 data on demand derive from this class and overload `GetBitmap`.
5112 """
5113 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5114 __repr__ = _swig_repr
5115 def __init__(self, *args, **kwargs):
5116 """
5117 __init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject
5118
5119 wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
5120 Python-aware and knows how to reflect calls to its C++ virtual methods
5121 to methods in the Python derived class. To be able to provide bitmap
5122 data on demand derive from this class and overload `GetBitmap`.
5123 """
5124 _misc_.PyBitmapDataObject_swiginit(self,_misc_.new_PyBitmapDataObject(*args, **kwargs))
5125 PyBitmapDataObject._setCallbackInfo(self, self, PyBitmapDataObject)
5126
5127 def _setCallbackInfo(*args, **kwargs):
5128 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5129 return _misc_.PyBitmapDataObject__setCallbackInfo(*args, **kwargs)
5130
5131 _misc_.PyBitmapDataObject_swigregister(PyBitmapDataObject)
5132
5133 class FileDataObject(DataObjectSimple):
5134 """
5135 wx.FileDataObject is a specialization of `wx.DataObjectSimple` for
5136 file names. The program works with it just as if it were a list of
5137 absolute file names, but internally it uses the same format as
5138 Explorer and other compatible programs under Windows or GNOME/KDE
5139 filemanager under Unix which makes it possible to receive files from
5140 them using this class.
5141 """
5142 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5143 __repr__ = _swig_repr
5144 def __init__(self, *args, **kwargs):
5145 """__init__(self) -> FileDataObject"""
5146 _misc_.FileDataObject_swiginit(self,_misc_.new_FileDataObject(*args, **kwargs))
5147 def GetFilenames(*args, **kwargs):
5148 """
5149 GetFilenames(self) -> [names]
5150
5151 Returns a list of file names.
5152 """
5153 return _misc_.FileDataObject_GetFilenames(*args, **kwargs)
5154
5155 def AddFile(*args, **kwargs):
5156 """
5157 AddFile(self, String filename)
5158
5159 Adds a file to the list of files represented by this data object.
5160 """
5161 return _misc_.FileDataObject_AddFile(*args, **kwargs)
5162
5163 Filenames = property(GetFilenames,doc="See `GetFilenames`")
5164 _misc_.FileDataObject_swigregister(FileDataObject)
5165
5166 class CustomDataObject(DataObjectSimple):
5167 """
5168 wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
5169 some application-specific data in arbitrary format. Python strings
5170 are used for getting and setting data, but any picklable object can
5171 easily be transfered via strings. A copy of the data is stored in the
5172 data object.
5173 """
5174 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5175 __repr__ = _swig_repr
5176 def __init__(self, *args):
5177 """
5178 __init__(self, DataFormat format) -> CustomDataObject
5179 __init__(self, String formatName) -> CustomDataObject
5180 __init__(self) -> CustomDataObject
5181
5182 wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
5183 some application-specific data in arbitrary format. Python strings
5184 are used for getting and setting data, but any picklable object can
5185 easily be transfered via strings. A copy of the data is stored in the
5186 data object.
5187 """
5188 _misc_.CustomDataObject_swiginit(self,_misc_.new_CustomDataObject(*args))
5189 def SetData(*args, **kwargs):
5190 """
5191 SetData(self, String data) -> bool
5192
5193 Copy the data value to the data object.
5194 """
5195 return _misc_.CustomDataObject_SetData(*args, **kwargs)
5196
5197 TakeData = SetData
5198 def GetSize(*args, **kwargs):
5199 """
5200 GetSize(self) -> size_t
5201
5202 Get the size of the data.
5203 """
5204 return _misc_.CustomDataObject_GetSize(*args, **kwargs)
5205
5206 def GetData(*args, **kwargs):
5207 """
5208 GetData(self) -> String
5209
5210 Returns the data bytes from the data object as a string.
5211 """
5212 return _misc_.CustomDataObject_GetData(*args, **kwargs)
5213
5214 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
5215 Size = property(GetSize,doc="See `GetSize`")
5216 _misc_.CustomDataObject_swigregister(CustomDataObject)
5217
5218 class URLDataObject(DataObject):
5219 """
5220 This data object holds a URL in a format that is compatible with some
5221 browsers such that it is able to be dragged to or from them.
5222 """
5223 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5224 __repr__ = _swig_repr
5225 def __init__(self, *args, **kwargs):
5226 """
5227 __init__(self, String url=EmptyString) -> URLDataObject
5228
5229 This data object holds a URL in a format that is compatible with some
5230 browsers such that it is able to be dragged to or from them.
5231 """
5232 _misc_.URLDataObject_swiginit(self,_misc_.new_URLDataObject(*args, **kwargs))
5233 def GetURL(*args, **kwargs):
5234 """
5235 GetURL(self) -> String
5236
5237 Returns a string containing the current URL.
5238 """
5239 return _misc_.URLDataObject_GetURL(*args, **kwargs)
5240
5241 def SetURL(*args, **kwargs):
5242 """
5243 SetURL(self, String url)
5244
5245 Set the URL.
5246 """
5247 return _misc_.URLDataObject_SetURL(*args, **kwargs)
5248
5249 URL = property(GetURL,SetURL,doc="See `GetURL` and `SetURL`")
5250 _misc_.URLDataObject_swigregister(URLDataObject)
5251
5252 class MetafileDataObject(DataObjectSimple):
5253 """Proxy of C++ MetafileDataObject class"""
5254 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5255 __repr__ = _swig_repr
5256 def __init__(self, *args, **kwargs):
5257 """__init__(self) -> MetafileDataObject"""
5258 _misc_.MetafileDataObject_swiginit(self,_misc_.new_MetafileDataObject(*args, **kwargs))
5259 def SetMetafile(*args, **kwargs):
5260 """SetMetafile(self, wxMetafile metafile)"""
5261 return _misc_.MetafileDataObject_SetMetafile(*args, **kwargs)
5262
5263 def GetMetafile(*args, **kwargs):
5264 """GetMetafile(self) -> wxMetafile"""
5265 return _misc_.MetafileDataObject_GetMetafile(*args, **kwargs)
5266
5267 _misc_.MetafileDataObject_swigregister(MetafileDataObject)
5268
5269 #---------------------------------------------------------------------------
5270
5271 Drag_CopyOnly = _misc_.Drag_CopyOnly
5272 Drag_AllowMove = _misc_.Drag_AllowMove
5273 Drag_DefaultMove = _misc_.Drag_DefaultMove
5274 DragError = _misc_.DragError
5275 DragNone = _misc_.DragNone
5276 DragCopy = _misc_.DragCopy
5277 DragMove = _misc_.DragMove
5278 DragLink = _misc_.DragLink
5279 DragCancel = _misc_.DragCancel
5280
5281 def IsDragResultOk(*args, **kwargs):
5282 """IsDragResultOk(int res) -> bool"""
5283 return _misc_.IsDragResultOk(*args, **kwargs)
5284 class DropSource(object):
5285 """Proxy of C++ DropSource class"""
5286 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5287 __repr__ = _swig_repr
5288 def __init__(self, *args, **kwargs):
5289 """
5290 __init__(self, Window win, Cursor copy=wxNullCursor, Cursor move=wxNullCursor,
5291 Cursor none=wxNullCursor) -> DropSource
5292 """
5293 _misc_.DropSource_swiginit(self,_misc_.new_DropSource(*args, **kwargs))
5294 DropSource._setCallbackInfo(self, self, DropSource)
5295
5296 def _setCallbackInfo(*args, **kwargs):
5297 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)"""
5298 return _misc_.DropSource__setCallbackInfo(*args, **kwargs)
5299
5300 __swig_destroy__ = _misc_.delete_DropSource
5301 __del__ = lambda self : None;
5302 def SetData(*args, **kwargs):
5303 """SetData(self, DataObject data)"""
5304 return _misc_.DropSource_SetData(*args, **kwargs)
5305
5306 def GetDataObject(*args, **kwargs):
5307 """GetDataObject(self) -> DataObject"""
5308 return _misc_.DropSource_GetDataObject(*args, **kwargs)
5309
5310 def SetCursor(*args, **kwargs):
5311 """SetCursor(self, int res, Cursor cursor)"""
5312 return _misc_.DropSource_SetCursor(*args, **kwargs)
5313
5314 def DoDragDrop(*args, **kwargs):
5315 """DoDragDrop(self, int flags=Drag_CopyOnly) -> int"""
5316 return _misc_.DropSource_DoDragDrop(*args, **kwargs)
5317
5318 def GiveFeedback(*args, **kwargs):
5319 """GiveFeedback(self, int effect) -> bool"""
5320 return _misc_.DropSource_GiveFeedback(*args, **kwargs)
5321
5322 def base_GiveFeedback(*args, **kw):
5323 return DropSource.GiveFeedback(*args, **kw)
5324 base_GiveFeedback = wx._deprecated(base_GiveFeedback,
5325 "Please use DropSource.GiveFeedback instead.")
5326
5327 DataObject = property(GetDataObject,SetData,doc="See `GetDataObject` and `SetData`")
5328 _misc_.DropSource_swigregister(DropSource)
5329
5330 def DROP_ICON(filename):
5331 """
5332 Returns either a `wx.Cursor` or `wx.Icon` created from the image file
5333 ``filename``. This function is useful with the `wx.DropSource` class
5334 which, depending on platform accepts either a icon or a cursor.
5335 """
5336 img = wx.Image(filename)
5337 if wx.Platform == '__WXGTK__':
5338 return wx.IconFromBitmap(wx.BitmapFromImage(img))
5339 else:
5340 return wx.CursorFromImage(img)
5341
5342 class DropTarget(object):
5343 """Proxy of C++ DropTarget class"""
5344 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5345 __repr__ = _swig_repr
5346 def __init__(self, *args, **kwargs):
5347 """__init__(self, DataObject dataObject=None) -> DropTarget"""
5348 _misc_.DropTarget_swiginit(self,_misc_.new_DropTarget(*args, **kwargs))
5349 DropTarget._setCallbackInfo(self, self, DropTarget)
5350
5351 def _setCallbackInfo(*args, **kwargs):
5352 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5353 return _misc_.DropTarget__setCallbackInfo(*args, **kwargs)
5354
5355 __swig_destroy__ = _misc_.delete_DropTarget
5356 __del__ = lambda self : None;
5357 def GetDataObject(*args, **kwargs):
5358 """GetDataObject(self) -> DataObject"""
5359 return _misc_.DropTarget_GetDataObject(*args, **kwargs)
5360
5361 def SetDataObject(*args, **kwargs):
5362 """SetDataObject(self, DataObject dataObject)"""
5363 return _misc_.DropTarget_SetDataObject(*args, **kwargs)
5364
5365 def OnEnter(*args, **kwargs):
5366 """OnEnter(self, int x, int y, int def) -> int"""
5367 return _misc_.DropTarget_OnEnter(*args, **kwargs)
5368
5369 def OnDragOver(*args, **kwargs):
5370 """OnDragOver(self, int x, int y, int def) -> int"""
5371 return _misc_.DropTarget_OnDragOver(*args, **kwargs)
5372
5373 def OnLeave(*args, **kwargs):
5374 """OnLeave(self)"""
5375 return _misc_.DropTarget_OnLeave(*args, **kwargs)
5376
5377 def OnDrop(*args, **kwargs):
5378 """OnDrop(self, int x, int y) -> bool"""
5379 return _misc_.DropTarget_OnDrop(*args, **kwargs)
5380
5381 def base_OnEnter(*args, **kw):
5382 return DropTarget.OnEnter(*args, **kw)
5383 base_OnEnter = wx._deprecated(base_OnEnter,
5384 "Please use DropTarget.OnEnter instead.")
5385
5386 def base_OnDragOver(*args, **kw):
5387 return DropTarget.OnDragOver(*args, **kw)
5388 base_OnDragOver = wx._deprecated(base_OnDragOver,
5389 "Please use DropTarget.OnDragOver instead.")
5390
5391 def base_OnLeave(*args, **kw):
5392 return DropTarget.OnLeave(*args, **kw)
5393 base_OnLeave = wx._deprecated(base_OnLeave,
5394 "Please use DropTarget.OnLeave instead.")
5395
5396 def base_OnDrop(*args, **kw):
5397 return DropTarget.OnDrop(*args, **kw)
5398 base_OnDrop = wx._deprecated(base_OnDrop,
5399 "Please use DropTarget.OnDrop instead.")
5400
5401 def GetData(*args, **kwargs):
5402 """GetData(self) -> bool"""
5403 return _misc_.DropTarget_GetData(*args, **kwargs)
5404
5405 def SetDefaultAction(*args, **kwargs):
5406 """SetDefaultAction(self, int action)"""
5407 return _misc_.DropTarget_SetDefaultAction(*args, **kwargs)
5408
5409 def GetDefaultAction(*args, **kwargs):
5410 """GetDefaultAction(self) -> int"""
5411 return _misc_.DropTarget_GetDefaultAction(*args, **kwargs)
5412
5413 DataObject = property(GetDataObject,SetDataObject,doc="See `GetDataObject` and `SetDataObject`")
5414 DefaultAction = property(GetDefaultAction,SetDefaultAction,doc="See `GetDefaultAction` and `SetDefaultAction`")
5415 _misc_.DropTarget_swigregister(DropTarget)
5416
5417 PyDropTarget = DropTarget
5418 class TextDropTarget(DropTarget):
5419 """Proxy of C++ TextDropTarget class"""
5420 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5421 __repr__ = _swig_repr
5422 def __init__(self, *args, **kwargs):
5423 """__init__(self) -> TextDropTarget"""
5424 _misc_.TextDropTarget_swiginit(self,_misc_.new_TextDropTarget(*args, **kwargs))
5425 TextDropTarget._setCallbackInfo(self, self, TextDropTarget)
5426
5427 def _setCallbackInfo(*args, **kwargs):
5428 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5429 return _misc_.TextDropTarget__setCallbackInfo(*args, **kwargs)
5430
5431 def OnDropText(*args, **kwargs):
5432 """OnDropText(self, int x, int y, String text) -> bool"""
5433 return _misc_.TextDropTarget_OnDropText(*args, **kwargs)
5434
5435 def OnEnter(*args, **kwargs):
5436 """OnEnter(self, int x, int y, int def) -> int"""
5437 return _misc_.TextDropTarget_OnEnter(*args, **kwargs)
5438
5439 def OnDragOver(*args, **kwargs):
5440 """OnDragOver(self, int x, int y, int def) -> int"""
5441 return _misc_.TextDropTarget_OnDragOver(*args, **kwargs)
5442
5443 def OnLeave(*args, **kwargs):
5444 """OnLeave(self)"""
5445 return _misc_.TextDropTarget_OnLeave(*args, **kwargs)
5446
5447 def OnDrop(*args, **kwargs):
5448 """OnDrop(self, int x, int y) -> bool"""
5449 return _misc_.TextDropTarget_OnDrop(*args, **kwargs)
5450
5451 def OnData(*args, **kwargs):
5452 """OnData(self, int x, int y, int def) -> int"""
5453 return _misc_.TextDropTarget_OnData(*args, **kwargs)
5454
5455 def base_OnDropText(*args, **kw):
5456 return TextDropTarget.OnDropText(*args, **kw)
5457 base_OnDropText = wx._deprecated(base_OnDropText,
5458 "Please use TextDropTarget.OnDropText instead.")
5459
5460 def base_OnEnter(*args, **kw):
5461 return TextDropTarget.OnEnter(*args, **kw)
5462 base_OnEnter = wx._deprecated(base_OnEnter,
5463 "Please use TextDropTarget.OnEnter instead.")
5464
5465 def base_OnDragOver(*args, **kw):
5466 return TextDropTarget.OnDragOver(*args, **kw)
5467 base_OnDragOver = wx._deprecated(base_OnDragOver,
5468 "Please use TextDropTarget.OnDragOver instead.")
5469
5470 def base_OnLeave(*args, **kw):
5471 return TextDropTarget.OnLeave(*args, **kw)
5472 base_OnLeave = wx._deprecated(base_OnLeave,
5473 "Please use TextDropTarget.OnLeave instead.")
5474
5475 def base_OnDrop(*args, **kw):
5476 return TextDropTarget.OnDrop(*args, **kw)
5477 base_OnDrop = wx._deprecated(base_OnDrop,
5478 "Please use TextDropTarget.OnDrop instead.")
5479
5480 def base_OnData(*args, **kw):
5481 return TextDropTarget.OnData(*args, **kw)
5482 base_OnData = wx._deprecated(base_OnData,
5483 "Please use TextDropTarget.OnData instead.")
5484
5485 _misc_.TextDropTarget_swigregister(TextDropTarget)
5486
5487 class FileDropTarget(DropTarget):
5488 """Proxy of C++ FileDropTarget class"""
5489 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5490 __repr__ = _swig_repr
5491 def __init__(self, *args, **kwargs):
5492 """__init__(self) -> FileDropTarget"""
5493 _misc_.FileDropTarget_swiginit(self,_misc_.new_FileDropTarget(*args, **kwargs))
5494 FileDropTarget._setCallbackInfo(self, self, FileDropTarget)
5495
5496 def _setCallbackInfo(*args, **kwargs):
5497 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5498 return _misc_.FileDropTarget__setCallbackInfo(*args, **kwargs)
5499
5500 def OnDropFiles(*args, **kwargs):
5501 """OnDropFiles(self, int x, int y, wxArrayString filenames) -> bool"""
5502 return _misc_.FileDropTarget_OnDropFiles(*args, **kwargs)
5503
5504 def OnEnter(*args, **kwargs):
5505 """OnEnter(self, int x, int y, int def) -> int"""
5506 return _misc_.FileDropTarget_OnEnter(*args, **kwargs)
5507
5508 def OnDragOver(*args, **kwargs):
5509 """OnDragOver(self, int x, int y, int def) -> int"""
5510 return _misc_.FileDropTarget_OnDragOver(*args, **kwargs)
5511
5512 def OnLeave(*args, **kwargs):
5513 """OnLeave(self)"""
5514 return _misc_.FileDropTarget_OnLeave(*args, **kwargs)
5515
5516 def OnDrop(*args, **kwargs):
5517 """OnDrop(self, int x, int y) -> bool"""
5518 return _misc_.FileDropTarget_OnDrop(*args, **kwargs)
5519
5520 def OnData(*args, **kwargs):
5521 """OnData(self, int x, int y, int def) -> int"""
5522 return _misc_.FileDropTarget_OnData(*args, **kwargs)
5523
5524 def base_OnDropFiles(*args, **kw):
5525 return FileDropTarget.OnDropFiles(*args, **kw)
5526 base_OnDropFiles = wx._deprecated(base_OnDropFiles,
5527 "Please use FileDropTarget.OnDropFiles instead.")
5528
5529 def base_OnEnter(*args, **kw):
5530 return FileDropTarget.OnEnter(*args, **kw)
5531 base_OnEnter = wx._deprecated(base_OnEnter,
5532 "Please use FileDropTarget.OnEnter instead.")
5533
5534 def base_OnDragOver(*args, **kw):
5535 return FileDropTarget.OnDragOver(*args, **kw)
5536 base_OnDragOver = wx._deprecated(base_OnDragOver,
5537 "Please use FileDropTarget.OnDragOver instead.")
5538
5539 def base_OnLeave(*args, **kw):
5540 return FileDropTarget.OnLeave(*args, **kw)
5541 base_OnLeave = wx._deprecated(base_OnLeave,
5542 "Please use FileDropTarget.OnLeave instead.")
5543
5544 def base_OnDrop(*args, **kw):
5545 return FileDropTarget.OnDrop(*args, **kw)
5546 base_OnDrop = wx._deprecated(base_OnDrop,
5547 "Please use FileDropTarget.OnDrop instead.")
5548
5549 def base_OnData(*args, **kw):
5550 return FileDropTarget.OnData(*args, **kw)
5551 base_OnData = wx._deprecated(base_OnData,
5552 "Please use FileDropTarget.OnData instead.")
5553
5554 _misc_.FileDropTarget_swigregister(FileDropTarget)
5555
5556 #---------------------------------------------------------------------------
5557
5558 class Clipboard(_core.Object):
5559 """
5560 wx.Clipboard represents the system clipboard and provides methods to
5561 copy data to it or paste data from it. Normally, you should only use
5562 ``wx.TheClipboard`` which is a reference to a global wx.Clipboard
5563 instance.
5564
5565 Call ``wx.TheClipboard``'s `Open` method to get ownership of the
5566 clipboard. If this operation returns True, you now own the
5567 clipboard. Call `SetData` to put data on the clipboard, or `GetData`
5568 to retrieve data from the clipboard. Call `Close` to close the
5569 clipboard and relinquish ownership. You should keep the clipboard open
5570 only momentarily.
5571
5572 :see: `wx.DataObject`
5573
5574 """
5575 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5576 __repr__ = _swig_repr
5577 def __init__(self, *args, **kwargs):
5578 """__init__(self) -> Clipboard"""
5579 _misc_.Clipboard_swiginit(self,_misc_.new_Clipboard(*args, **kwargs))
5580 __swig_destroy__ = _misc_.delete_Clipboard
5581 __del__ = lambda self : None;
5582 def Open(*args, **kwargs):
5583 """
5584 Open(self) -> bool
5585
5586 Call this function to open the clipboard before calling SetData and
5587 GetData. Call Close when you have finished with the clipboard. You
5588 should keep the clipboard open for only a very short time. Returns
5589 True on success.
5590 """
5591 return _misc_.Clipboard_Open(*args, **kwargs)
5592
5593 def Close(*args, **kwargs):
5594 """
5595 Close(self)
5596
5597 Closes the clipboard.
5598 """
5599 return _misc_.Clipboard_Close(*args, **kwargs)
5600
5601 def IsOpened(*args, **kwargs):
5602 """
5603 IsOpened(self) -> bool
5604
5605 Query whether the clipboard is opened
5606 """
5607 return _misc_.Clipboard_IsOpened(*args, **kwargs)
5608
5609 def AddData(*args, **kwargs):
5610 """
5611 AddData(self, DataObject data) -> bool
5612
5613 Call this function to add the data object to the clipboard. You may
5614 call this function repeatedly after having cleared the clipboard.
5615 After this function has been called, the clipboard owns the data, so
5616 do not delete the data explicitly.
5617
5618 :see: `wx.DataObject`
5619 """
5620 return _misc_.Clipboard_AddData(*args, **kwargs)
5621
5622 def SetData(*args, **kwargs):
5623 """
5624 SetData(self, DataObject data) -> bool
5625
5626 Set the clipboard data, this is the same as `Clear` followed by
5627 `AddData`.
5628
5629 :see: `wx.DataObject`
5630 """
5631 return _misc_.Clipboard_SetData(*args, **kwargs)
5632
5633 def IsSupported(*args, **kwargs):
5634 """
5635 IsSupported(self, DataFormat format) -> bool
5636
5637 Returns True if the given format is available in the data object(s) on
5638 the clipboard.
5639 """
5640 return _misc_.Clipboard_IsSupported(*args, **kwargs)
5641
5642 def GetData(*args, **kwargs):
5643 """
5644 GetData(self, DataObject data) -> bool
5645
5646 Call this function to fill data with data on the clipboard, if
5647 available in the required format. Returns true on success.
5648 """
5649 return _misc_.Clipboard_GetData(*args, **kwargs)
5650
5651 def Clear(*args, **kwargs):
5652 """
5653 Clear(self)
5654
5655 Clears data from the clipboard object and also the system's clipboard
5656 if possible.
5657 """
5658 return _misc_.Clipboard_Clear(*args, **kwargs)
5659
5660 def Flush(*args, **kwargs):
5661 """
5662 Flush(self) -> bool
5663
5664 Flushes the clipboard: this means that the data which is currently on
5665 clipboard will stay available even after the application exits,
5666 possibly eating memory, otherwise the clipboard will be emptied on
5667 exit. Returns False if the operation is unsuccesful for any reason.
5668 """
5669 return _misc_.Clipboard_Flush(*args, **kwargs)
5670
5671 def UsePrimarySelection(*args, **kwargs):
5672 """
5673 UsePrimarySelection(self, bool primary=True)
5674
5675 On platforms supporting it (the X11 based platforms), selects the
5676 so called PRIMARY SELECTION as the clipboard as opposed to the
5677 normal clipboard, if primary is True.
5678 """
5679 return _misc_.Clipboard_UsePrimarySelection(*args, **kwargs)
5680
5681 def Get(*args, **kwargs):
5682 """
5683 Get() -> Clipboard
5684
5685 Returns global instance (wxTheClipboard) of the object.
5686 """
5687 return _misc_.Clipboard_Get(*args, **kwargs)
5688
5689 Get = staticmethod(Get)
5690 _misc_.Clipboard_swigregister(Clipboard)
5691
5692 def Clipboard_Get(*args):
5693 """
5694 Clipboard_Get() -> Clipboard
5695
5696 Returns global instance (wxTheClipboard) of the object.
5697 """
5698 return _misc_.Clipboard_Get(*args)
5699
5700 class _wxPyDelayedInitWrapper(object):
5701 def __init__(self, initfunc, *args, **kwargs):
5702 self._initfunc = initfunc
5703 self._args = args
5704 self._kwargs = kwargs
5705 self._instance = None
5706 def _checkInstance(self):
5707 if self._instance is None:
5708 if wx.GetApp():
5709 self._instance = self._initfunc(*self._args, **self._kwargs)
5710 def __getattr__(self, name):
5711 self._checkInstance()
5712 return getattr(self._instance, name)
5713 def __repr__(self):
5714 self._checkInstance()
5715 return repr(self._instance)
5716 TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
5717
5718 class ClipboardLocker(object):
5719 """
5720 A helpful class for opening the clipboard and automatically
5721 closing it when the locker is destroyed.
5722 """
5723 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5724 __repr__ = _swig_repr
5725 def __init__(self, *args, **kwargs):
5726 """
5727 __init__(self, Clipboard clipboard=None) -> ClipboardLocker
5728
5729 A helpful class for opening the clipboard and automatically
5730 closing it when the locker is destroyed.
5731 """
5732 _misc_.ClipboardLocker_swiginit(self,_misc_.new_ClipboardLocker(*args, **kwargs))
5733 __swig_destroy__ = _misc_.delete_ClipboardLocker
5734 __del__ = lambda self : None;
5735 def __nonzero__(*args, **kwargs):
5736 """
5737 __nonzero__(self) -> bool
5738
5739 A ClipboardLocker instance evaluates to True if the clipboard was
5740 successfully opened.
5741 """
5742 return _misc_.ClipboardLocker___nonzero__(*args, **kwargs)
5743
5744 _misc_.ClipboardLocker_swigregister(ClipboardLocker)
5745
5746 #---------------------------------------------------------------------------
5747
5748 class VideoMode(object):
5749 """A simple struct containing video mode parameters for a display"""
5750 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5751 __repr__ = _swig_repr
5752 def __init__(self, *args, **kwargs):
5753 """
5754 __init__(self, int width=0, int height=0, int depth=0, int freq=0) -> VideoMode
5755
5756 A simple struct containing video mode parameters for a display
5757 """
5758 _misc_.VideoMode_swiginit(self,_misc_.new_VideoMode(*args, **kwargs))
5759 __swig_destroy__ = _misc_.delete_VideoMode
5760 __del__ = lambda self : None;
5761 def Matches(*args, **kwargs):
5762 """
5763 Matches(self, VideoMode other) -> bool
5764
5765 Returns True if this mode matches the other one in the sense that all
5766 non-zero fields of the other mode have the same value in this
5767 one (except for refresh which is allowed to have a greater value)
5768 """
5769 return _misc_.VideoMode_Matches(*args, **kwargs)
5770
5771 def GetWidth(*args, **kwargs):
5772 """
5773 GetWidth(self) -> int
5774
5775 Returns the screen width in pixels (e.g. 640*480), 0 means unspecified
5776 """
5777 return _misc_.VideoMode_GetWidth(*args, **kwargs)
5778
5779 def GetHeight(*args, **kwargs):
5780 """
5781 GetHeight(self) -> int
5782
5783 Returns the screen height in pixels (e.g. 640*480), 0 means unspecified
5784 """
5785 return _misc_.VideoMode_GetHeight(*args, **kwargs)
5786
5787 def GetDepth(*args, **kwargs):
5788 """
5789 GetDepth(self) -> int
5790
5791 Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
5792 means unspecified/known
5793 """
5794 return _misc_.VideoMode_GetDepth(*args, **kwargs)
5795
5796 def IsOk(*args, **kwargs):
5797 """
5798 IsOk(self) -> bool
5799
5800 returns true if the object has been initialized
5801 """
5802 return _misc_.VideoMode_IsOk(*args, **kwargs)
5803
5804 def __nonzero__(self): return self.IsOk()
5805 def __eq__(*args, **kwargs):
5806 """__eq__(self, VideoMode other) -> bool"""
5807 return _misc_.VideoMode___eq__(*args, **kwargs)
5808
5809 def __ne__(*args, **kwargs):
5810 """__ne__(self, VideoMode other) -> bool"""
5811 return _misc_.VideoMode___ne__(*args, **kwargs)
5812
5813 w = property(_misc_.VideoMode_w_get, _misc_.VideoMode_w_set)
5814 h = property(_misc_.VideoMode_h_get, _misc_.VideoMode_h_set)
5815 bpp = property(_misc_.VideoMode_bpp_get, _misc_.VideoMode_bpp_set)
5816 refresh = property(_misc_.VideoMode_refresh_get, _misc_.VideoMode_refresh_set)
5817 Depth = property(GetDepth,doc="See `GetDepth`")
5818 Height = property(GetHeight,doc="See `GetHeight`")
5819 Width = property(GetWidth,doc="See `GetWidth`")
5820 _misc_.VideoMode_swigregister(VideoMode)
5821
5822 class Display(object):
5823 """Represents a display/monitor attached to the system"""
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):
5827 """
5828 __init__(self, unsigned int index=0) -> Display
5829
5830 Set up a Display instance with the specified display. The displays
5831 are numbered from 0 to GetCount() - 1, 0 is always the primary display
5832 and the only one which is always supported
5833 """
5834 _misc_.Display_swiginit(self,_misc_.new_Display(*args, **kwargs))
5835 __swig_destroy__ = _misc_.delete_Display
5836 __del__ = lambda self : None;
5837 def GetCount(*args, **kwargs):
5838 """
5839 GetCount() -> unsigned int
5840
5841 Return the number of available displays.
5842 """
5843 return _misc_.Display_GetCount(*args, **kwargs)
5844
5845 GetCount = staticmethod(GetCount)
5846 def GetFromPoint(*args, **kwargs):
5847 """
5848 GetFromPoint(Point pt) -> int
5849
5850 Find the display where the given point lies, return wx.NOT_FOUND if it
5851 doesn't belong to any display
5852 """
5853 return _misc_.Display_GetFromPoint(*args, **kwargs)
5854
5855 GetFromPoint = staticmethod(GetFromPoint)
5856 def GetFromWindow(*args, **kwargs):
5857 """
5858 GetFromWindow(Window window) -> int
5859
5860 Find the display where the given window lies, return wx.NOT_FOUND if
5861 it is not shown at all.
5862 """
5863 return _misc_.Display_GetFromWindow(*args, **kwargs)
5864
5865 GetFromWindow = staticmethod(GetFromWindow)
5866 def IsOk(*args, **kwargs):
5867 """
5868 IsOk(self) -> bool
5869
5870 Return true if the object was initialized successfully
5871 """
5872 return _misc_.Display_IsOk(*args, **kwargs)
5873
5874 def __nonzero__(self): return self.IsOk()
5875 def GetGeometry(*args, **kwargs):
5876 """
5877 GetGeometry(self) -> Rect
5878
5879 Returns the bounding rectangle of the display whose index was passed
5880 to the constructor.
5881 """
5882 return _misc_.Display_GetGeometry(*args, **kwargs)
5883
5884 def GetClientArea(*args, **kwargs):
5885 """
5886 GetClientArea(self) -> Rect
5887
5888 Returns the bounding rectangle the client area of the display,
5889 i.e., without taskbars and such.
5890 """
5891 return _misc_.Display_GetClientArea(*args, **kwargs)
5892
5893 def GetName(*args, **kwargs):
5894 """
5895 GetName(self) -> String
5896
5897 Returns the display's name. A name is not available on all platforms.
5898 """
5899 return _misc_.Display_GetName(*args, **kwargs)
5900
5901 def IsPrimary(*args, **kwargs):
5902 """
5903 IsPrimary(self) -> bool
5904
5905 Returns True if the display is the primary display. The primary
5906 display is the one whose index is 0.
5907 """
5908 return _misc_.Display_IsPrimary(*args, **kwargs)
5909
5910 def GetModes(*args, **kwargs):
5911 """
5912 GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]
5913
5914 Enumerate all video modes supported by this display matching the given
5915 one (in the sense of VideoMode.Match()).
5916
5917 As any mode matches the default value of the argument and there is
5918 always at least one video mode supported by display, the returned
5919 array is only empty for the default value of the argument if this
5920 function is not supported at all on this platform.
5921 """
5922 return _misc_.Display_GetModes(*args, **kwargs)
5923
5924 def GetCurrentMode(*args, **kwargs):
5925 """
5926 GetCurrentMode(self) -> VideoMode
5927
5928 Get the current video mode.
5929 """
5930 return _misc_.Display_GetCurrentMode(*args, **kwargs)
5931
5932 def ChangeMode(*args, **kwargs):
5933 """
5934 ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool
5935
5936 Changes the video mode of this display to the mode specified in the
5937 mode parameter.
5938
5939 If wx.DefaultVideoMode is passed in as the mode parameter, the defined
5940 behaviour is that wx.Display will reset the video mode to the default
5941 mode used by the display. On Windows, the behavior is normal.
5942 However, there are differences on other platforms. On Unix variations
5943 using X11 extensions it should behave as defined, but some
5944 irregularities may occur.
5945
5946 On wxMac passing in wx.DefaultVideoMode as the mode parameter does
5947 nothing. This happens because Carbon no longer has access to
5948 DMUseScreenPrefs, an undocumented function that changed the video mode
5949 to the system default by using the system's 'scrn' resource.
5950
5951 Returns True if succeeded, False otherwise
5952 """
5953 return _misc_.Display_ChangeMode(*args, **kwargs)
5954
5955 def ResetMode(*args, **kwargs):
5956 """
5957 ResetMode(self)
5958
5959 Restore the default video mode (just a more readable synonym)
5960 """
5961 return _misc_.Display_ResetMode(*args, **kwargs)
5962
5963 ClientArea = property(GetClientArea,doc="See `GetClientArea`")
5964 CurrentMode = property(GetCurrentMode,doc="See `GetCurrentMode`")
5965 Geometry = property(GetGeometry,doc="See `GetGeometry`")
5966 Modes = property(GetModes,doc="See `GetModes`")
5967 Name = property(GetName,doc="See `GetName`")
5968 _misc_.Display_swigregister(Display)
5969 DefaultVideoMode = cvar.DefaultVideoMode
5970
5971 def Display_GetCount(*args):
5972 """
5973 Display_GetCount() -> unsigned int
5974
5975 Return the number of available displays.
5976 """
5977 return _misc_.Display_GetCount(*args)
5978
5979 def Display_GetFromPoint(*args, **kwargs):
5980 """
5981 Display_GetFromPoint(Point pt) -> int
5982
5983 Find the display where the given point lies, return wx.NOT_FOUND if it
5984 doesn't belong to any display
5985 """
5986 return _misc_.Display_GetFromPoint(*args, **kwargs)
5987
5988 def Display_GetFromWindow(*args, **kwargs):
5989 """
5990 Display_GetFromWindow(Window window) -> int
5991
5992 Find the display where the given window lies, return wx.NOT_FOUND if
5993 it is not shown at all.
5994 """
5995 return _misc_.Display_GetFromWindow(*args, **kwargs)
5996
5997 #---------------------------------------------------------------------------
5998
5999 class StandardPaths(object):
6000 """
6001 wx.StandardPaths returns standard locations in the file system and
6002 should be used by programs to find their data files in a portable way.
6003
6004 In the description of the methods below, the example return values are
6005 given for the Unix, Windows and Mac OS X systems, however please note
6006 that these are just examples and the actual values may differ. For
6007 example, under Windows the system administrator may change the
6008 standard directories locations, i.e. the Windows directory may be
6009 named W:\Win2003 instead of the default C:\Windows.
6010
6011 The strings appname and username should be replaced with the value
6012 returned by `wx.App.GetAppName` and the name of the currently logged
6013 in user, respectively. The string prefix is only used under Unix and
6014 is /usr/local by default but may be changed using `SetInstallPrefix`.
6015
6016 The directories returned by the methods of this class may or may not
6017 exist. If they don't exist, it's up to the caller to create them,
6018 wx.StandardPaths doesn't do it.
6019
6020 Finally note that these functions only work with standardly packaged
6021 applications. I.e. under Unix you should follow the standard
6022 installation conventions and under Mac you should create your
6023 application bundle according to the Apple guidelines. Again, this
6024 class doesn't help you to do it.
6025 """
6026 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6027 def __init__(self): raise AttributeError, "No constructor defined"
6028 __repr__ = _swig_repr
6029 ResourceCat_None = _misc_.StandardPaths_ResourceCat_None
6030 ResourceCat_Messages = _misc_.StandardPaths_ResourceCat_Messages
6031 ResourceCat_Max = _misc_.StandardPaths_ResourceCat_Max
6032 def Get(*args, **kwargs):
6033 """
6034 Get() -> StandardPaths
6035
6036 Return the global standard paths singleton
6037 """
6038 return _misc_.StandardPaths_Get(*args, **kwargs)
6039
6040 Get = staticmethod(Get)
6041 def GetExecutablePath(*args, **kwargs):
6042 """
6043 GetExecutablePath(self) -> String
6044
6045 Return the path (directory+filename) of the running executable or an
6046 empty string if it couldn't be determined. The path is returned as an
6047 absolute path whenever possible.
6048 """
6049 return _misc_.StandardPaths_GetExecutablePath(*args, **kwargs)
6050
6051 def GetConfigDir(*args, **kwargs):
6052 """
6053 GetConfigDir(self) -> String
6054
6055 Return the directory with system config files: /etc under Unix,
6056 'c:\Documents and Settings\All Users\Application Data' under Windows,
6057 /Library/Preferences for Mac
6058 """
6059 return _misc_.StandardPaths_GetConfigDir(*args, **kwargs)
6060
6061 def GetUserConfigDir(*args, **kwargs):
6062 """
6063 GetUserConfigDir(self) -> String
6064
6065 Return the directory for the user config files: $HOME under Unix,
6066 'c:\Documents and Settings\username' under Windows, and
6067 ~/Library/Preferences under Mac
6068
6069 Only use this if you have a single file to put there, otherwise
6070 `GetUserDataDir` is more appropriate
6071 """
6072 return _misc_.StandardPaths_GetUserConfigDir(*args, **kwargs)
6073
6074 def GetDataDir(*args, **kwargs):
6075 """
6076 GetDataDir(self) -> String
6077
6078 Return the location of the application's global, (i.e. not
6079 user-specific,) data files: prefix/share/appname under Unix,
6080 'c:\Program Files\appname' under Windows,
6081 appname.app/Contents/SharedSupport app bundle directory under Mac.
6082 """
6083 return _misc_.StandardPaths_GetDataDir(*args, **kwargs)
6084
6085 def GetLocalDataDir(*args, **kwargs):
6086 """
6087 GetLocalDataDir(self) -> String
6088
6089 Return the location for application data files which are
6090 host-specific. Same as `GetDataDir` except under Unix where it is
6091 /etc/appname
6092 """
6093 return _misc_.StandardPaths_GetLocalDataDir(*args, **kwargs)
6094
6095 def GetUserDataDir(*args, **kwargs):
6096 """
6097 GetUserDataDir(self) -> String
6098
6099 Return the directory for the user-dependent application data files:
6100 $HOME/.appname under Unix, c:\Documents and
6101 Settings\username\Application Data\appname under Windows and
6102 ~/Library/Application Support/appname under Mac
6103 """
6104 return _misc_.StandardPaths_GetUserDataDir(*args, **kwargs)
6105
6106 def GetUserLocalDataDir(*args, **kwargs):
6107 """
6108 GetUserLocalDataDir(self) -> String
6109
6110 Return the directory for user data files which shouldn't be shared
6111 with the other machines
6112
6113 Same as `GetUserDataDir` for all platforms except Windows where it is
6114 the 'Local Settings\Application Data\appname' directory.
6115 """
6116 return _misc_.StandardPaths_GetUserLocalDataDir(*args, **kwargs)
6117
6118 def GetPluginsDir(*args, **kwargs):
6119 """
6120 GetPluginsDir(self) -> String
6121
6122 Return the directory where the loadable modules (plugins) live:
6123 prefix/lib/appname under Unix, program directory under Windows and
6124 Contents/Plugins app bundle subdirectory under Mac
6125 """
6126 return _misc_.StandardPaths_GetPluginsDir(*args, **kwargs)
6127
6128 def GetResourcesDir(*args, **kwargs):
6129 """
6130 GetResourcesDir(self) -> String
6131
6132 Get resources directory. Resources are auxiliary files used by the
6133 application and include things like image and sound files.
6134
6135 Same as `GetDataDir` for all platforms except Mac where it returns
6136 Contents/Resources subdirectory of the app bundle.
6137 """
6138 return _misc_.StandardPaths_GetResourcesDir(*args, **kwargs)
6139
6140 def GetLocalizedResourcesDir(*args, **kwargs):
6141 """
6142 GetLocalizedResourcesDir(self, String lang, int category=ResourceCat_None) -> String
6143
6144 Get localized resources directory containing the resource files of the
6145 specified category for the given language.
6146
6147 In general this is just GetResourcesDir()/lang under Windows and Unix
6148 and GetResourcesDir()/lang.lproj under Mac but is something quite
6149 different under Unix for the message catalog category (namely the
6150 standard prefix/share/locale/lang/LC_MESSAGES.)
6151 """
6152 return _misc_.StandardPaths_GetLocalizedResourcesDir(*args, **kwargs)
6153
6154 def GetDocumentsDir(*args, **kwargs):
6155 """
6156 GetDocumentsDir(self) -> String
6157
6158 Return the Documents directory for the current user.
6159
6160 C:\Documents and Settings\username\Documents under Windows,
6161 $HOME under Unix and ~/Documents under Mac
6162 """
6163 return _misc_.StandardPaths_GetDocumentsDir(*args, **kwargs)
6164
6165 def GetTempDir(*args, **kwargs):
6166 """
6167 GetTempDir(self) -> String
6168
6169 Return the user's directory for temporary files.
6170 """
6171 return _misc_.StandardPaths_GetTempDir(*args, **kwargs)
6172
6173 def SetInstallPrefix(*args, **kwargs):
6174 """
6175 SetInstallPrefix(self, String prefix)
6176
6177 Set the program installation directory which is /usr/local by default.
6178 This value will be used by other methods such as `GetDataDir` and
6179 `GetPluginsDir` as the prefix for what they return. (This function
6180 only has meaning on Unix systems.)
6181 """
6182 return _misc_.StandardPaths_SetInstallPrefix(*args, **kwargs)
6183
6184 def GetInstallPrefix(*args, **kwargs):
6185 """
6186 GetInstallPrefix(self) -> String
6187
6188 Get the program installation prefix. The default is the prefix where
6189 Python is installed. (This function only has meaning on Unix systems.)
6190 """
6191 return _misc_.StandardPaths_GetInstallPrefix(*args, **kwargs)
6192
6193 _misc_.StandardPaths_swigregister(StandardPaths)
6194
6195 def StandardPaths_Get(*args):
6196 """
6197 StandardPaths_Get() -> StandardPaths
6198
6199 Return the global standard paths singleton
6200 """
6201 return _misc_.StandardPaths_Get(*args)
6202
6203 #---------------------------------------------------------------------------
6204
6205 POWER_SOCKET = _misc_.POWER_SOCKET
6206 POWER_BATTERY = _misc_.POWER_BATTERY
6207 POWER_UNKNOWN = _misc_.POWER_UNKNOWN
6208 BATTERY_NORMAL_STATE = _misc_.BATTERY_NORMAL_STATE
6209 BATTERY_LOW_STATE = _misc_.BATTERY_LOW_STATE
6210 BATTERY_CRITICAL_STATE = _misc_.BATTERY_CRITICAL_STATE
6211 BATTERY_SHUTDOWN_STATE = _misc_.BATTERY_SHUTDOWN_STATE
6212 BATTERY_UNKNOWN_STATE = _misc_.BATTERY_UNKNOWN_STATE
6213 class PowerEvent(_core.Event):
6214 """
6215 wx.PowerEvent is generated when the system online status changes.
6216 Currently this is only implemented for Windows.
6217 """
6218 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6219 __repr__ = _swig_repr
6220 def __init__(self, *args, **kwargs):
6221 """
6222 __init__(self, EventType evtType) -> PowerEvent
6223
6224 wx.PowerEvent is generated when the system online status changes.
6225 Currently this is only implemented for Windows.
6226 """
6227 _misc_.PowerEvent_swiginit(self,_misc_.new_PowerEvent(*args, **kwargs))
6228 def Veto(*args, **kwargs):
6229 """Veto(self)"""
6230 return _misc_.PowerEvent_Veto(*args, **kwargs)
6231
6232 def IsVetoed(*args, **kwargs):
6233 """IsVetoed(self) -> bool"""
6234 return _misc_.PowerEvent_IsVetoed(*args, **kwargs)
6235
6236 _misc_.PowerEvent_swigregister(PowerEvent)
6237
6238 wxEVT_POWER_SUSPENDING = _misc_.wxEVT_POWER_SUSPENDING
6239 wxEVT_POWER_SUSPENDED = _misc_.wxEVT_POWER_SUSPENDED
6240 wxEVT_POWER_SUSPEND_CANCEL = _misc_.wxEVT_POWER_SUSPEND_CANCEL
6241 wxEVT_POWER_RESUME = _misc_.wxEVT_POWER_RESUME
6242 EVT_POWER_SUSPENDING = wx.PyEventBinder( wxEVT_POWER_SUSPENDING , 1 )
6243 EVT_POWER_SUSPENDED = wx.PyEventBinder( wxEVT_POWER_SUSPENDED , 1 )
6244 EVT_POWER_SUSPEND_CANCEL = wx.PyEventBinder( wxEVT_POWER_SUSPEND_CANCEL , 1 )
6245 EVT_POWER_RESUME = wx.PyEventBinder( wxEVT_POWER_RESUME , 1 )
6246
6247
6248 def GetPowerType(*args):
6249 """
6250 GetPowerType() -> int
6251
6252 return the current system power state: online or offline
6253 """
6254 return _misc_.GetPowerType(*args)
6255
6256 def GetBatteryState(*args):
6257 """
6258 GetBatteryState() -> int
6259
6260 return approximate battery state
6261 """
6262 return _misc_.GetBatteryState(*args)
6263 #---------------------------------------------------------------------------
6264
6265 class AboutDialogInfo(object):
6266 """
6267 `wx.AboutDialogInfo` contains information to be shown in the standard
6268 About dialog displayed by the `wx.AboutBox` function. This class
6269 contains the general information about the program, such as its name,
6270 version, copyright and so on, as well as lists of the program
6271 developers, documentation writers, artists and translators.
6272
6273 While all the main platforms have a native implementation of the about
6274 dialog, they are often more limited than the generic version provided
6275 by wxWidgets and so the generic version is used if
6276 `wx.AboutDialogInfo` has any fields not supported by the native
6277 version. Currently GTK+ version supports all the possible fields
6278 natively but MSW and Mac versions don't support URLs, licence text nor
6279 custom icons in the about dialog and if either of those is used,
6280 wxAboutBox() will automatically use the generic version so you should
6281 avoid specifying these fields to achieve more native look and feel.
6282
6283 """
6284 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6285 __repr__ = _swig_repr
6286 def __init__(self, *args, **kwargs):
6287 """
6288 __init__(self) -> AboutDialogInfo
6289
6290 `wx.AboutDialogInfo` contains information to be shown in the standard
6291 About dialog displayed by the `wx.AboutBox` function. This class
6292 contains the general information about the program, such as its name,
6293 version, copyright and so on, as well as lists of the program
6294 developers, documentation writers, artists and translators.
6295
6296 While all the main platforms have a native implementation of the about
6297 dialog, they are often more limited than the generic version provided
6298 by wxWidgets and so the generic version is used if
6299 `wx.AboutDialogInfo` has any fields not supported by the native
6300 version. Currently GTK+ version supports all the possible fields
6301 natively but MSW and Mac versions don't support URLs, licence text nor
6302 custom icons in the about dialog and if either of those is used,
6303 wxAboutBox() will automatically use the generic version so you should
6304 avoid specifying these fields to achieve more native look and feel.
6305
6306 """
6307 _misc_.AboutDialogInfo_swiginit(self,_misc_.new_AboutDialogInfo(*args, **kwargs))
6308 __swig_destroy__ = _misc_.delete_AboutDialogInfo
6309 __del__ = lambda self : None;
6310 def SetName(*args, **kwargs):
6311 """
6312 SetName(self, String name)
6313
6314 Set the name of the program. If this method is not called, the string
6315 returned by `wx.App.GetAppName` will be shown in the dialog.
6316 """
6317 return _misc_.AboutDialogInfo_SetName(*args, **kwargs)
6318
6319 def GetName(*args, **kwargs):
6320 """
6321 GetName(self) -> String
6322
6323 Returns the program name.
6324 """
6325 return _misc_.AboutDialogInfo_GetName(*args, **kwargs)
6326
6327 Name = property(GetName,SetName)
6328 def SetVersion(*args, **kwargs):
6329 """
6330 SetVersion(self, String version)
6331
6332 Set the version of the program. The version is in free format,
6333 i.e. not necessarily in the x.y.z form but it shouldn't contain the
6334 "version" word.
6335 """
6336 return _misc_.AboutDialogInfo_SetVersion(*args, **kwargs)
6337
6338 def HasVersion(*args, **kwargs):
6339 """
6340 HasVersion(self) -> bool
6341
6342 Returns ``True`` if the version property has been set.
6343 """
6344 return _misc_.AboutDialogInfo_HasVersion(*args, **kwargs)
6345
6346 def GetVersion(*args, **kwargs):
6347 """
6348 GetVersion(self) -> String
6349
6350 Returns the version value.
6351 """
6352 return _misc_.AboutDialogInfo_GetVersion(*args, **kwargs)
6353
6354 Version = property(GetVersion,SetVersion)
6355 def SetDescription(*args, **kwargs):
6356 """
6357 SetDescription(self, String desc)
6358
6359 Set brief, but possibly multiline, description of the program.
6360 """
6361 return _misc_.AboutDialogInfo_SetDescription(*args, **kwargs)
6362
6363 def HasDescription(*args, **kwargs):
6364 """
6365 HasDescription(self) -> bool
6366
6367 Returns ``True`` if the description property has been set.
6368 """
6369 return _misc_.AboutDialogInfo_HasDescription(*args, **kwargs)
6370
6371 def GetDescription(*args, **kwargs):
6372 """
6373 GetDescription(self) -> String
6374
6375 Returns the description value.
6376 """
6377 return _misc_.AboutDialogInfo_GetDescription(*args, **kwargs)
6378
6379 Description = property(GetDescription,SetDescription)
6380 def SetCopyright(*args, **kwargs):
6381 """
6382 SetCopyright(self, String copyright)
6383
6384 Set the short string containing the program copyright
6385 information. Notice that any occurrences of "(C)" in ``copyright``
6386 will be replaced by the copyright symbol (circled C) automatically,
6387 which means that you can avoid using this symbol in the program source
6388 code which can be problematic.
6389 """
6390 return _misc_.AboutDialogInfo_SetCopyright(*args, **kwargs)
6391
6392 def HasCopyright(*args, **kwargs):
6393 """
6394 HasCopyright(self) -> bool
6395
6396 Returns ``True`` if the copyright property has been set.
6397 """
6398 return _misc_.AboutDialogInfo_HasCopyright(*args, **kwargs)
6399
6400 def GetCopyright(*args, **kwargs):
6401 """
6402 GetCopyright(self) -> String
6403
6404 Returns the copyright value.
6405 """
6406 return _misc_.AboutDialogInfo_GetCopyright(*args, **kwargs)
6407
6408 Copyright = property(GetCopyright,SetCopyright)
6409 def SetLicence(*args, **kwargs):
6410 """
6411 SetLicence(self, String licence)
6412
6413 Set the long, multiline string containing the text of the program
6414 licence.
6415
6416 Only GTK+ version supports showing the licence text in the native
6417 about dialog currently so the generic version will be used under all
6418 the other platforms if this method is called. To preserve the native
6419 look and feel it is advised that you do not call this method but
6420 provide a separate menu item in the "Help" menu for displaying the
6421 text of your program licence.
6422
6423 """
6424 return _misc_.AboutDialogInfo_SetLicence(*args, **kwargs)
6425
6426 def SetLicense(*args, **kwargs):
6427 """
6428 SetLicense(self, String licence)
6429
6430 This is the same as `SetLicence`.
6431 """
6432 return _misc_.AboutDialogInfo_SetLicense(*args, **kwargs)
6433
6434 def HasLicence(*args, **kwargs):
6435 """
6436 HasLicence(self) -> bool
6437
6438 Returns ``True`` if the licence property has been set.
6439 """
6440 return _misc_.AboutDialogInfo_HasLicence(*args, **kwargs)
6441
6442 def GetLicence(*args, **kwargs):
6443 """
6444 GetLicence(self) -> String
6445
6446 Returns the licence value.
6447 """
6448 return _misc_.AboutDialogInfo_GetLicence(*args, **kwargs)
6449
6450 Licence = property(GetLicence,SetLicence)
6451 License = Licence
6452 def SetIcon(*args, **kwargs):
6453 """
6454 SetIcon(self, Icon icon)
6455
6456 Set the icon to be shown in the dialog. By default the icon of the
6457 main frame will be shown if the native about dialog supports custom
6458 icons. If it doesn't but a valid icon is specified using this method,
6459 the generic about dialog is used instead so you should avoid calling
6460 this function for maximally native look and feel.
6461 """
6462 return _misc_.AboutDialogInfo_SetIcon(*args, **kwargs)
6463
6464 def HasIcon(*args, **kwargs):
6465 """
6466 HasIcon(self) -> bool
6467
6468 Returns ``True`` if the icon property has been set.
6469 """
6470 return _misc_.AboutDialogInfo_HasIcon(*args, **kwargs)
6471
6472 def GetIcon(*args, **kwargs):
6473 """
6474 GetIcon(self) -> Icon
6475
6476 Return the current icon value.
6477 """
6478 return _misc_.AboutDialogInfo_GetIcon(*args, **kwargs)
6479
6480 Icon = property(GetIcon,SetIcon)
6481 def _SetWebSite(*args, **kwargs):
6482 """_SetWebSite(self, String url, String desc=wxEmptyString)"""
6483 return _misc_.AboutDialogInfo__SetWebSite(*args, **kwargs)
6484
6485 def _GetWebSiteURL(*args, **kwargs):
6486 """_GetWebSiteURL(self) -> String"""
6487 return _misc_.AboutDialogInfo__GetWebSiteURL(*args, **kwargs)
6488
6489 def _GetWebSiteDescription(*args, **kwargs):
6490 """_GetWebSiteDescription(self) -> String"""
6491 return _misc_.AboutDialogInfo__GetWebSiteDescription(*args, **kwargs)
6492
6493 def HasWebSite(*args, **kwargs):
6494 """HasWebSite(self) -> bool"""
6495 return _misc_.AboutDialogInfo_HasWebSite(*args, **kwargs)
6496
6497 def SetWebSite(self, args):
6498 """
6499 SetWebSite(self, URL, [Description])
6500
6501 Set the web site property. The ``args`` parameter can
6502 either be a single string for the URL, to a 2-tuple of
6503 (URL, Description) strings.
6504 """
6505 if type(args) in [str, unicode]:
6506 self._SetWebSite(args)
6507 else:
6508 self._SetWebSite(args[0], args[1])
6509
6510 def GetWebSite(self):
6511 """
6512 GetWebSite(self) --> (URL, Description)
6513 """
6514 return (self._GetWebSiteURL(), self._GetWebSiteDescription())
6515
6516 WebSite = property(GetWebSite,SetWebSite)
6517 def SetDevelopers(*args, **kwargs):
6518 """
6519 SetDevelopers(self, list developers)
6520
6521 Set the list of the developers of the program.
6522 """
6523 return _misc_.AboutDialogInfo_SetDevelopers(*args, **kwargs)
6524
6525 def AddDeveloper(*args, **kwargs):
6526 """
6527 AddDeveloper(self, String developer)
6528
6529 Add a string to the list of developers.
6530 """
6531 return _misc_.AboutDialogInfo_AddDeveloper(*args, **kwargs)
6532
6533 def HasDevelopers(*args, **kwargs):
6534 """
6535 HasDevelopers(self) -> bool
6536
6537 Returns ``True if any developers have been set.
6538 """
6539 return _misc_.AboutDialogInfo_HasDevelopers(*args, **kwargs)
6540
6541 def GetDevelopers(*args, **kwargs):
6542 """
6543 GetDevelopers(self) --> list
6544
6545 Returns the list of developers.
6546 """
6547 return _misc_.AboutDialogInfo_GetDevelopers(*args, **kwargs)
6548
6549 Developers = property(GetDevelopers,SetDevelopers)
6550 def SetDocWriters(*args, **kwargs):
6551 """
6552 SetDocWriters(self, list docwriters)
6553
6554 Set the list of the documentation writers.
6555 """
6556 return _misc_.AboutDialogInfo_SetDocWriters(*args, **kwargs)
6557
6558 def AddDocWriter(*args, **kwargs):
6559 """
6560 AddDocWriter(self, String docwriter)
6561
6562 Add a string to the list of documentation writers.
6563 """
6564 return _misc_.AboutDialogInfo_AddDocWriter(*args, **kwargs)
6565
6566 def HasDocWriters(*args, **kwargs):
6567 """
6568 HasDocWriters(self) -> bool
6569
6570 Returns ``True if any documentation writers have been set.
6571 """
6572 return _misc_.AboutDialogInfo_HasDocWriters(*args, **kwargs)
6573
6574 def GetDocWriters(*args, **kwargs):
6575 """
6576 GetDocWriters(self) --> list
6577
6578 Returns the list of documentation writers.
6579 """
6580 return _misc_.AboutDialogInfo_GetDocWriters(*args, **kwargs)
6581
6582 DocWriters = property(GetDocWriters,SetDocWriters)
6583 def SetArtists(*args, **kwargs):
6584 """
6585 SetArtists(self, list artists)
6586
6587 Set the list of artists for the program.
6588 """
6589 return _misc_.AboutDialogInfo_SetArtists(*args, **kwargs)
6590
6591 def AddArtist(*args, **kwargs):
6592 """
6593 AddArtist(self, String artist)
6594
6595 Add a string to the list of artists.
6596 """
6597 return _misc_.AboutDialogInfo_AddArtist(*args, **kwargs)
6598
6599 def HasArtists(*args, **kwargs):
6600 """
6601 HasArtists(self) -> bool
6602
6603 Returns ``True`` if any artists have been set.
6604 """
6605 return _misc_.AboutDialogInfo_HasArtists(*args, **kwargs)
6606
6607 def GetArtists(*args, **kwargs):
6608 """
6609 GetArtists(self) --> list
6610
6611 Returns the list od artists.
6612 """
6613 return _misc_.AboutDialogInfo_GetArtists(*args, **kwargs)
6614
6615 Artists = property(GetArtists,SetArtists)
6616 def SetTranslators(*args, **kwargs):
6617 """
6618 SetTranslators(self, list translators)
6619
6620 Sets the list of program translators.
6621 """
6622 return _misc_.AboutDialogInfo_SetTranslators(*args, **kwargs)
6623
6624 def AddTranslator(*args, **kwargs):
6625 """
6626 AddTranslator(self, String translator)
6627
6628 Add a string to the list of translators.
6629 """
6630 return _misc_.AboutDialogInfo_AddTranslator(*args, **kwargs)
6631
6632 def HasTranslators(*args, **kwargs):
6633 """
6634 HasTranslators(self) -> bool
6635
6636 Returns ``True`` if any translators have been set.
6637 """
6638 return _misc_.AboutDialogInfo_HasTranslators(*args, **kwargs)
6639
6640 def GetTranslators(*args, **kwargs):
6641 """
6642 GetTranslators(self) --> list
6643
6644 Returns the list of program translators.
6645 """
6646 return _misc_.AboutDialogInfo_GetTranslators(*args, **kwargs)
6647
6648 Translators = property(GetTranslators,SetTranslators)
6649 def IsSimple(*args, **kwargs):
6650 """IsSimple(self) -> bool"""
6651 return _misc_.AboutDialogInfo_IsSimple(*args, **kwargs)
6652
6653 def GetDescriptionAndCredits(*args, **kwargs):
6654 """GetDescriptionAndCredits(self) -> String"""
6655 return _misc_.AboutDialogInfo_GetDescriptionAndCredits(*args, **kwargs)
6656
6657 _misc_.AboutDialogInfo_swigregister(AboutDialogInfo)
6658
6659
6660 def AboutBox(*args, **kwargs):
6661 """
6662 AboutBox(AboutDialogInfo info)
6663
6664 This function shows the standard about dialog containing the
6665 information specified in ``info``. If the current platform has a
6666 native about dialog which is capable of showing all the fields in
6667 `wx.AboutDialogInfo`, the native dialog is used, otherwise the
6668 function falls back to the generic wxWidgets version of the dialog.
6669 """
6670 return _misc_.AboutBox(*args, **kwargs)
6671
6672