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