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