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