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