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