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