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