]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_misc.py
Add wxSVGFileDC
[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
8c3a7183
RD
1989EXEC_NOEVENTS = _misc_.EXEC_NOEVENTS
1990EXEC_BLOCK = _misc_.EXEC_BLOCK
d55e5bfc
RD
1991
1992def Execute(*args, **kwargs):
554f62e9
RD
1993 """Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long"""
1994 return _misc_.Execute(*args, **kwargs)
c9c2cf70
RD
1995
1996def Kill(*args, **kwargs):
554f62e9
RD
1997 """Kill(long pid, int sig=SIGTERM, int rc, int flags=KILL_NOCHILDREN) -> int"""
1998 return _misc_.Kill(*args, **kwargs)
d55e5bfc
RD
1999#---------------------------------------------------------------------------
2000
2001JOYSTICK1 = _misc_.JOYSTICK1
2002JOYSTICK2 = _misc_.JOYSTICK2
2003JOY_BUTTON_ANY = _misc_.JOY_BUTTON_ANY
2004JOY_BUTTON1 = _misc_.JOY_BUTTON1
2005JOY_BUTTON2 = _misc_.JOY_BUTTON2
2006JOY_BUTTON3 = _misc_.JOY_BUTTON3
2007JOY_BUTTON4 = _misc_.JOY_BUTTON4
2008class Joystick(object):
093d3ff1 2009 """Proxy of C++ Joystick class"""
554f62e9
RD
2010 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2011 __repr__ = _swig_repr
2012 def __init__(self, *args, **kwargs):
d55e5bfc 2013 """__init__(self, int joystick=JOYSTICK1) -> Joystick"""
554f62e9
RD
2014 _misc_.Joystick_swiginit(self,_misc_.new_Joystick(*args, **kwargs))
2015 __swig_destroy__ = _misc_.delete_Joystick
2016 __del__ = lambda self : None;
d55e5bfc
RD
2017 def GetPosition(*args, **kwargs):
2018 """GetPosition(self) -> Point"""
2019 return _misc_.Joystick_GetPosition(*args, **kwargs)
2020
2021 def GetZPosition(*args, **kwargs):
2022 """GetZPosition(self) -> int"""
2023 return _misc_.Joystick_GetZPosition(*args, **kwargs)
2024
2025 def GetButtonState(*args, **kwargs):
2026 """GetButtonState(self) -> int"""
2027 return _misc_.Joystick_GetButtonState(*args, **kwargs)
2028
2029 def GetPOVPosition(*args, **kwargs):
2030 """GetPOVPosition(self) -> int"""
2031 return _misc_.Joystick_GetPOVPosition(*args, **kwargs)
2032
2033 def GetPOVCTSPosition(*args, **kwargs):
2034 """GetPOVCTSPosition(self) -> int"""
2035 return _misc_.Joystick_GetPOVCTSPosition(*args, **kwargs)
2036
2037 def GetRudderPosition(*args, **kwargs):
2038 """GetRudderPosition(self) -> int"""
2039 return _misc_.Joystick_GetRudderPosition(*args, **kwargs)
2040
2041 def GetUPosition(*args, **kwargs):
2042 """GetUPosition(self) -> int"""
2043 return _misc_.Joystick_GetUPosition(*args, **kwargs)
2044
2045 def GetVPosition(*args, **kwargs):
2046 """GetVPosition(self) -> int"""
2047 return _misc_.Joystick_GetVPosition(*args, **kwargs)
2048
2049 def GetMovementThreshold(*args, **kwargs):
2050 """GetMovementThreshold(self) -> int"""
2051 return _misc_.Joystick_GetMovementThreshold(*args, **kwargs)
2052
2053 def SetMovementThreshold(*args, **kwargs):
2054 """SetMovementThreshold(self, int threshold)"""
2055 return _misc_.Joystick_SetMovementThreshold(*args, **kwargs)
2056
2057 def IsOk(*args, **kwargs):
2058 """IsOk(self) -> bool"""
2059 return _misc_.Joystick_IsOk(*args, **kwargs)
2060
2061 def GetNumberJoysticks(*args, **kwargs):
2062 """GetNumberJoysticks(self) -> int"""
2063 return _misc_.Joystick_GetNumberJoysticks(*args, **kwargs)
2064
2065 def GetManufacturerId(*args, **kwargs):
2066 """GetManufacturerId(self) -> int"""
2067 return _misc_.Joystick_GetManufacturerId(*args, **kwargs)
2068
2069 def GetProductId(*args, **kwargs):
2070 """GetProductId(self) -> int"""
2071 return _misc_.Joystick_GetProductId(*args, **kwargs)
2072
2073 def GetProductName(*args, **kwargs):
2074 """GetProductName(self) -> String"""
2075 return _misc_.Joystick_GetProductName(*args, **kwargs)
2076
2077 def GetXMin(*args, **kwargs):
2078 """GetXMin(self) -> int"""
2079 return _misc_.Joystick_GetXMin(*args, **kwargs)
2080
2081 def GetYMin(*args, **kwargs):
2082 """GetYMin(self) -> int"""
2083 return _misc_.Joystick_GetYMin(*args, **kwargs)
2084
2085 def GetZMin(*args, **kwargs):
2086 """GetZMin(self) -> int"""
2087 return _misc_.Joystick_GetZMin(*args, **kwargs)
2088
2089 def GetXMax(*args, **kwargs):
2090 """GetXMax(self) -> int"""
2091 return _misc_.Joystick_GetXMax(*args, **kwargs)
2092
2093 def GetYMax(*args, **kwargs):
2094 """GetYMax(self) -> int"""
2095 return _misc_.Joystick_GetYMax(*args, **kwargs)
2096
2097 def GetZMax(*args, **kwargs):
2098 """GetZMax(self) -> int"""
2099 return _misc_.Joystick_GetZMax(*args, **kwargs)
2100
2101 def GetNumberButtons(*args, **kwargs):
2102 """GetNumberButtons(self) -> int"""
2103 return _misc_.Joystick_GetNumberButtons(*args, **kwargs)
2104
2105 def GetNumberAxes(*args, **kwargs):
2106 """GetNumberAxes(self) -> int"""
2107 return _misc_.Joystick_GetNumberAxes(*args, **kwargs)
2108
2109 def GetMaxButtons(*args, **kwargs):
2110 """GetMaxButtons(self) -> int"""
2111 return _misc_.Joystick_GetMaxButtons(*args, **kwargs)
2112
2113 def GetMaxAxes(*args, **kwargs):
2114 """GetMaxAxes(self) -> int"""
2115 return _misc_.Joystick_GetMaxAxes(*args, **kwargs)
2116
2117 def GetPollingMin(*args, **kwargs):
2118 """GetPollingMin(self) -> int"""
2119 return _misc_.Joystick_GetPollingMin(*args, **kwargs)
2120
2121 def GetPollingMax(*args, **kwargs):
2122 """GetPollingMax(self) -> int"""
2123 return _misc_.Joystick_GetPollingMax(*args, **kwargs)
2124
2125 def GetRudderMin(*args, **kwargs):
2126 """GetRudderMin(self) -> int"""
2127 return _misc_.Joystick_GetRudderMin(*args, **kwargs)
2128
2129 def GetRudderMax(*args, **kwargs):
2130 """GetRudderMax(self) -> int"""
2131 return _misc_.Joystick_GetRudderMax(*args, **kwargs)
2132
2133 def GetUMin(*args, **kwargs):
2134 """GetUMin(self) -> int"""
2135 return _misc_.Joystick_GetUMin(*args, **kwargs)
2136
2137 def GetUMax(*args, **kwargs):
2138 """GetUMax(self) -> int"""
2139 return _misc_.Joystick_GetUMax(*args, **kwargs)
2140
2141 def GetVMin(*args, **kwargs):
2142 """GetVMin(self) -> int"""
2143 return _misc_.Joystick_GetVMin(*args, **kwargs)
2144
2145 def GetVMax(*args, **kwargs):
2146 """GetVMax(self) -> int"""
2147 return _misc_.Joystick_GetVMax(*args, **kwargs)
2148
2149 def HasRudder(*args, **kwargs):
2150 """HasRudder(self) -> bool"""
2151 return _misc_.Joystick_HasRudder(*args, **kwargs)
2152
2153 def HasZ(*args, **kwargs):
2154 """HasZ(self) -> bool"""
2155 return _misc_.Joystick_HasZ(*args, **kwargs)
2156
2157 def HasU(*args, **kwargs):
2158 """HasU(self) -> bool"""
2159 return _misc_.Joystick_HasU(*args, **kwargs)
2160
2161 def HasV(*args, **kwargs):
2162 """HasV(self) -> bool"""
2163 return _misc_.Joystick_HasV(*args, **kwargs)
2164
2165 def HasPOV(*args, **kwargs):
2166 """HasPOV(self) -> bool"""
2167 return _misc_.Joystick_HasPOV(*args, **kwargs)
2168
2169 def HasPOV4Dir(*args, **kwargs):
2170 """HasPOV4Dir(self) -> bool"""
2171 return _misc_.Joystick_HasPOV4Dir(*args, **kwargs)
2172
2173 def HasPOVCTS(*args, **kwargs):
2174 """HasPOVCTS(self) -> bool"""
2175 return _misc_.Joystick_HasPOVCTS(*args, **kwargs)
2176
2177 def SetCapture(*args, **kwargs):
2178 """SetCapture(self, Window win, int pollingFreq=0) -> bool"""
2179 return _misc_.Joystick_SetCapture(*args, **kwargs)
2180
2181 def ReleaseCapture(*args, **kwargs):
2182 """ReleaseCapture(self) -> bool"""
2183 return _misc_.Joystick_ReleaseCapture(*args, **kwargs)
2184
2185 def __nonzero__(self): return self.IsOk()
97ab0f6a
RD
2186 ButtonState = property(GetButtonState,doc="See `GetButtonState`")
2187 ManufacturerId = property(GetManufacturerId,doc="See `GetManufacturerId`")
2188 MaxAxes = property(GetMaxAxes,doc="See `GetMaxAxes`")
2189 MaxButtons = property(GetMaxButtons,doc="See `GetMaxButtons`")
2190 MovementThreshold = property(GetMovementThreshold,SetMovementThreshold,doc="See `GetMovementThreshold` and `SetMovementThreshold`")
2191 NumberAxes = property(GetNumberAxes,doc="See `GetNumberAxes`")
2192 NumberButtons = property(GetNumberButtons,doc="See `GetNumberButtons`")
2193 NumberJoysticks = property(GetNumberJoysticks,doc="See `GetNumberJoysticks`")
2194 POVCTSPosition = property(GetPOVCTSPosition,doc="See `GetPOVCTSPosition`")
2195 POVPosition = property(GetPOVPosition,doc="See `GetPOVPosition`")
2196 PollingMax = property(GetPollingMax,doc="See `GetPollingMax`")
2197 PollingMin = property(GetPollingMin,doc="See `GetPollingMin`")
2198 Position = property(GetPosition,doc="See `GetPosition`")
2199 ProductId = property(GetProductId,doc="See `GetProductId`")
2200 ProductName = property(GetProductName,doc="See `GetProductName`")
2201 RudderMax = property(GetRudderMax,doc="See `GetRudderMax`")
2202 RudderMin = property(GetRudderMin,doc="See `GetRudderMin`")
2203 RudderPosition = property(GetRudderPosition,doc="See `GetRudderPosition`")
2204 UMax = property(GetUMax,doc="See `GetUMax`")
2205 UMin = property(GetUMin,doc="See `GetUMin`")
2206 UPosition = property(GetUPosition,doc="See `GetUPosition`")
2207 VMax = property(GetVMax,doc="See `GetVMax`")
2208 VMin = property(GetVMin,doc="See `GetVMin`")
2209 VPosition = property(GetVPosition,doc="See `GetVPosition`")
2210 XMax = property(GetXMax,doc="See `GetXMax`")
2211 XMin = property(GetXMin,doc="See `GetXMin`")
2212 YMax = property(GetYMax,doc="See `GetYMax`")
2213 YMin = property(GetYMin,doc="See `GetYMin`")
2214 ZMax = property(GetZMax,doc="See `GetZMax`")
2215 ZMin = property(GetZMin,doc="See `GetZMin`")
2216 ZPosition = property(GetZPosition,doc="See `GetZPosition`")
2131d850 2217_misc_.Joystick_swigregister(Joystick)
d55e5bfc
RD
2218
2219wxEVT_JOY_BUTTON_DOWN = _misc_.wxEVT_JOY_BUTTON_DOWN
2220wxEVT_JOY_BUTTON_UP = _misc_.wxEVT_JOY_BUTTON_UP
2221wxEVT_JOY_MOVE = _misc_.wxEVT_JOY_MOVE
2222wxEVT_JOY_ZMOVE = _misc_.wxEVT_JOY_ZMOVE
2223class JoystickEvent(_core.Event):
093d3ff1 2224 """Proxy of C++ JoystickEvent class"""
554f62e9
RD
2225 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2226 __repr__ = _swig_repr
2227 def __init__(self, *args, **kwargs):
d55e5bfc 2228 """
f460c29d 2229 __init__(self, EventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1,
d55e5bfc
RD
2230 int change=0) -> JoystickEvent
2231 """
554f62e9 2232 _misc_.JoystickEvent_swiginit(self,_misc_.new_JoystickEvent(*args, **kwargs))
d55e5bfc
RD
2233 def GetPosition(*args, **kwargs):
2234 """GetPosition(self) -> Point"""
2235 return _misc_.JoystickEvent_GetPosition(*args, **kwargs)
2236
2237 def GetZPosition(*args, **kwargs):
2238 """GetZPosition(self) -> int"""
2239 return _misc_.JoystickEvent_GetZPosition(*args, **kwargs)
2240
2241 def GetButtonState(*args, **kwargs):
2242 """GetButtonState(self) -> int"""
2243 return _misc_.JoystickEvent_GetButtonState(*args, **kwargs)
2244
2245 def GetButtonChange(*args, **kwargs):
2246 """GetButtonChange(self) -> int"""
2247 return _misc_.JoystickEvent_GetButtonChange(*args, **kwargs)
2248
2249 def GetJoystick(*args, **kwargs):
2250 """GetJoystick(self) -> int"""
2251 return _misc_.JoystickEvent_GetJoystick(*args, **kwargs)
2252
2253 def SetJoystick(*args, **kwargs):
2254 """SetJoystick(self, int stick)"""
2255 return _misc_.JoystickEvent_SetJoystick(*args, **kwargs)
2256
2257 def SetButtonState(*args, **kwargs):
2258 """SetButtonState(self, int state)"""
2259 return _misc_.JoystickEvent_SetButtonState(*args, **kwargs)
2260
2261 def SetButtonChange(*args, **kwargs):
2262 """SetButtonChange(self, int change)"""
2263 return _misc_.JoystickEvent_SetButtonChange(*args, **kwargs)
2264
2265 def SetPosition(*args, **kwargs):
2266 """SetPosition(self, Point pos)"""
2267 return _misc_.JoystickEvent_SetPosition(*args, **kwargs)
2268
2269 def SetZPosition(*args, **kwargs):
2270 """SetZPosition(self, int zPos)"""
2271 return _misc_.JoystickEvent_SetZPosition(*args, **kwargs)
2272
2273 def IsButton(*args, **kwargs):
2274 """IsButton(self) -> bool"""
2275 return _misc_.JoystickEvent_IsButton(*args, **kwargs)
2276
2277 def IsMove(*args, **kwargs):
2278 """IsMove(self) -> bool"""
2279 return _misc_.JoystickEvent_IsMove(*args, **kwargs)
2280
2281 def IsZMove(*args, **kwargs):
2282 """IsZMove(self) -> bool"""
2283 return _misc_.JoystickEvent_IsZMove(*args, **kwargs)
2284
2285 def ButtonDown(*args, **kwargs):
2286 """ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool"""
2287 return _misc_.JoystickEvent_ButtonDown(*args, **kwargs)
2288
2289 def ButtonUp(*args, **kwargs):
2290 """ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool"""
2291 return _misc_.JoystickEvent_ButtonUp(*args, **kwargs)
2292
2293 def ButtonIsDown(*args, **kwargs):
2294 """ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool"""
2295 return _misc_.JoystickEvent_ButtonIsDown(*args, **kwargs)
2296
fef4c27a
RD
2297 m_pos = property(GetPosition, SetPosition)
2298 m_zPosition = property(GetZPosition, SetZPosition)
2299 m_buttonChange = property(GetButtonChange, SetButtonChange)
2300 m_buttonState = property(GetButtonState, SetButtonState)
2301 m_joyStick = property(GetJoystick, SetJoystick)
2302
97ab0f6a
RD
2303 ButtonChange = property(GetButtonChange,SetButtonChange,doc="See `GetButtonChange` and `SetButtonChange`")
2304 ButtonState = property(GetButtonState,SetButtonState,doc="See `GetButtonState` and `SetButtonState`")
2305 Joystick = property(GetJoystick,SetJoystick,doc="See `GetJoystick` and `SetJoystick`")
2306 Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
2307 ZPosition = property(GetZPosition,SetZPosition,doc="See `GetZPosition` and `SetZPosition`")
2131d850 2308_misc_.JoystickEvent_swigregister(JoystickEvent)
d55e5bfc
RD
2309
2310EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN )
2311EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP )
2312EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE )
2313EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE )
2314
2315EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN,
2316 wxEVT_JOY_BUTTON_UP,
2317 wxEVT_JOY_MOVE,
2318 wxEVT_JOY_ZMOVE,
2319 ])
2320
2321
2322#---------------------------------------------------------------------------
2323
2324SOUND_SYNC = _misc_.SOUND_SYNC
2325SOUND_ASYNC = _misc_.SOUND_ASYNC
2326SOUND_LOOP = _misc_.SOUND_LOOP
2327class Sound(object):
093d3ff1 2328 """Proxy of C++ Sound class"""
554f62e9
RD
2329 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2330 __repr__ = _swig_repr
2331 def __init__(self, *args, **kwargs):
b1f29bf7 2332 """__init__(self, String fileName=EmptyString) -> Sound"""
554f62e9
RD
2333 _misc_.Sound_swiginit(self,_misc_.new_Sound(*args, **kwargs))
2334 __swig_destroy__ = _misc_.delete_Sound
2335 __del__ = lambda self : None;
b1f29bf7
RD
2336 def Create(*args, **kwargs):
2337 """Create(self, String fileName) -> bool"""
2338 return _misc_.Sound_Create(*args, **kwargs)
2339
2340 def CreateFromData(*args, **kwargs):
2341 """CreateFromData(self, PyObject data) -> bool"""
2342 return _misc_.Sound_CreateFromData(*args, **kwargs)
d55e5bfc
RD
2343
2344 def IsOk(*args, **kwargs):
2345 """IsOk(self) -> bool"""
2346 return _misc_.Sound_IsOk(*args, **kwargs)
2347
b1f29bf7 2348 def Play(*args, **kwargs):
d55e5bfc 2349 """Play(self, unsigned int flags=SOUND_ASYNC) -> bool"""
b1f29bf7 2350 return _misc_.Sound_Play(*args, **kwargs)
d55e5bfc 2351
b1f29bf7 2352 def PlaySound(*args, **kwargs):
c24da6d6 2353 """PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
b1f29bf7 2354 return _misc_.Sound_PlaySound(*args, **kwargs)
d55e5bfc
RD
2355
2356 PlaySound = staticmethod(PlaySound)
2357 def Stop(*args, **kwargs):
c24da6d6 2358 """Stop()"""
d55e5bfc
RD
2359 return _misc_.Sound_Stop(*args, **kwargs)
2360
2361 Stop = staticmethod(Stop)
2362 def __nonzero__(self): return self.IsOk()
2131d850 2363_misc_.Sound_swigregister(Sound)
d55e5bfc 2364
b1f29bf7
RD
2365def SoundFromData(*args, **kwargs):
2366 """SoundFromData(PyObject data) -> Sound"""
2367 val = _misc_.new_SoundFromData(*args, **kwargs)
b1f29bf7
RD
2368 return val
2369
2370def Sound_PlaySound(*args, **kwargs):
554f62e9
RD
2371 """Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool"""
2372 return _misc_.Sound_PlaySound(*args, **kwargs)
d55e5bfc 2373
554f62e9
RD
2374def Sound_Stop(*args):
2375 """Sound_Stop()"""
2376 return _misc_.Sound_Stop(*args)
d55e5bfc
RD
2377
2378#---------------------------------------------------------------------------
2379
2380MAILCAP_STANDARD = _misc_.MAILCAP_STANDARD
2381MAILCAP_NETSCAPE = _misc_.MAILCAP_NETSCAPE
2382MAILCAP_KDE = _misc_.MAILCAP_KDE
2383MAILCAP_GNOME = _misc_.MAILCAP_GNOME
2384MAILCAP_ALL = _misc_.MAILCAP_ALL
2385class FileTypeInfo(object):
093d3ff1 2386 """Proxy of C++ FileTypeInfo class"""
554f62e9
RD
2387 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2388 __repr__ = _swig_repr
2389 def __init__(self, *args, **kwargs):
d55e5bfc 2390 """__init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo"""
554f62e9 2391 _misc_.FileTypeInfo_swiginit(self,_misc_.new_FileTypeInfo(*args, **kwargs))
d55e5bfc
RD
2392 def IsValid(*args, **kwargs):
2393 """IsValid(self) -> bool"""
2394 return _misc_.FileTypeInfo_IsValid(*args, **kwargs)
2395
2396 def SetIcon(*args, **kwargs):
2397 """SetIcon(self, String iconFile, int iconIndex=0)"""
2398 return _misc_.FileTypeInfo_SetIcon(*args, **kwargs)
2399
2400 def SetShortDesc(*args, **kwargs):
2401 """SetShortDesc(self, String shortDesc)"""
2402 return _misc_.FileTypeInfo_SetShortDesc(*args, **kwargs)
2403
2404 def GetMimeType(*args, **kwargs):
2405 """GetMimeType(self) -> String"""
2406 return _misc_.FileTypeInfo_GetMimeType(*args, **kwargs)
2407
2408 def GetOpenCommand(*args, **kwargs):
2409 """GetOpenCommand(self) -> String"""
2410 return _misc_.FileTypeInfo_GetOpenCommand(*args, **kwargs)
2411
2412 def GetPrintCommand(*args, **kwargs):
2413 """GetPrintCommand(self) -> String"""
2414 return _misc_.FileTypeInfo_GetPrintCommand(*args, **kwargs)
2415
2416 def GetShortDesc(*args, **kwargs):
2417 """GetShortDesc(self) -> String"""
2418 return _misc_.FileTypeInfo_GetShortDesc(*args, **kwargs)
2419
2420 def GetDescription(*args, **kwargs):
2421 """GetDescription(self) -> String"""
2422 return _misc_.FileTypeInfo_GetDescription(*args, **kwargs)
2423
2424 def GetExtensions(*args, **kwargs):
2425 """GetExtensions(self) -> wxArrayString"""
2426 return _misc_.FileTypeInfo_GetExtensions(*args, **kwargs)
2427
2428 def GetExtensionsCount(*args, **kwargs):
554f62e9 2429 """GetExtensionsCount(self) -> size_t"""
d55e5bfc
RD
2430 return _misc_.FileTypeInfo_GetExtensionsCount(*args, **kwargs)
2431
2432 def GetIconFile(*args, **kwargs):
2433 """GetIconFile(self) -> String"""
2434 return _misc_.FileTypeInfo_GetIconFile(*args, **kwargs)
2435
2436 def GetIconIndex(*args, **kwargs):
2437 """GetIconIndex(self) -> int"""
2438 return _misc_.FileTypeInfo_GetIconIndex(*args, **kwargs)
2439
97ab0f6a
RD
2440 Description = property(GetDescription,doc="See `GetDescription`")
2441 Extensions = property(GetExtensions,doc="See `GetExtensions`")
2442 ExtensionsCount = property(GetExtensionsCount,doc="See `GetExtensionsCount`")
2443 IconFile = property(GetIconFile,doc="See `GetIconFile`")
2444 IconIndex = property(GetIconIndex,doc="See `GetIconIndex`")
2445 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2446 OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`")
2447 PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`")
2448 ShortDesc = property(GetShortDesc,SetShortDesc,doc="See `GetShortDesc` and `SetShortDesc`")
2131d850 2449_misc_.FileTypeInfo_swigregister(FileTypeInfo)
d55e5bfc
RD
2450
2451def FileTypeInfoSequence(*args, **kwargs):
2452 """FileTypeInfoSequence(wxArrayString sArray) -> FileTypeInfo"""
2453 val = _misc_.new_FileTypeInfoSequence(*args, **kwargs)
d55e5bfc
RD
2454 return val
2455
2456def NullFileTypeInfo(*args, **kwargs):
2457 """NullFileTypeInfo() -> FileTypeInfo"""
2458 val = _misc_.new_NullFileTypeInfo(*args, **kwargs)
d55e5bfc
RD
2459 return val
2460
2461class FileType(object):
093d3ff1 2462 """Proxy of C++ FileType class"""
554f62e9
RD
2463 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2464 __repr__ = _swig_repr
2465 def __init__(self, *args, **kwargs):
d55e5bfc 2466 """__init__(self, FileTypeInfo ftInfo) -> FileType"""
554f62e9
RD
2467 _misc_.FileType_swiginit(self,_misc_.new_FileType(*args, **kwargs))
2468 __swig_destroy__ = _misc_.delete_FileType
2469 __del__ = lambda self : None;
d55e5bfc
RD
2470 def GetMimeType(*args, **kwargs):
2471 """GetMimeType(self) -> PyObject"""
2472 return _misc_.FileType_GetMimeType(*args, **kwargs)
2473
2474 def GetMimeTypes(*args, **kwargs):
2475 """GetMimeTypes(self) -> PyObject"""
2476 return _misc_.FileType_GetMimeTypes(*args, **kwargs)
2477
2478 def GetExtensions(*args, **kwargs):
2479 """GetExtensions(self) -> PyObject"""
2480 return _misc_.FileType_GetExtensions(*args, **kwargs)
2481
2482 def GetIcon(*args, **kwargs):
2483 """GetIcon(self) -> Icon"""
2484 return _misc_.FileType_GetIcon(*args, **kwargs)
2485
2486 def GetIconInfo(*args, **kwargs):
2487 """GetIconInfo(self) -> PyObject"""
2488 return _misc_.FileType_GetIconInfo(*args, **kwargs)
2489
2490 def GetDescription(*args, **kwargs):
2491 """GetDescription(self) -> PyObject"""
2492 return _misc_.FileType_GetDescription(*args, **kwargs)
2493
2494 def GetOpenCommand(*args, **kwargs):
2495 """GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject"""
2496 return _misc_.FileType_GetOpenCommand(*args, **kwargs)
2497
2498 def GetPrintCommand(*args, **kwargs):
2499 """GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject"""
2500 return _misc_.FileType_GetPrintCommand(*args, **kwargs)
2501
2502 def GetAllCommands(*args, **kwargs):
2503 """GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject"""
2504 return _misc_.FileType_GetAllCommands(*args, **kwargs)
2505
2506 def SetCommand(*args, **kwargs):
2507 """SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool"""
2508 return _misc_.FileType_SetCommand(*args, **kwargs)
2509
2510 def SetDefaultIcon(*args, **kwargs):
2511 """SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool"""
2512 return _misc_.FileType_SetDefaultIcon(*args, **kwargs)
2513
2514 def Unassociate(*args, **kwargs):
2515 """Unassociate(self) -> bool"""
2516 return _misc_.FileType_Unassociate(*args, **kwargs)
2517
2518 def ExpandCommand(*args, **kwargs):
c24da6d6 2519 """ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
d55e5bfc
RD
2520 return _misc_.FileType_ExpandCommand(*args, **kwargs)
2521
2522 ExpandCommand = staticmethod(ExpandCommand)
97ab0f6a
RD
2523 AllCommands = property(GetAllCommands,doc="See `GetAllCommands`")
2524 Description = property(GetDescription,doc="See `GetDescription`")
2525 Extensions = property(GetExtensions,doc="See `GetExtensions`")
2526 Icon = property(GetIcon,doc="See `GetIcon`")
2527 IconInfo = property(GetIconInfo,doc="See `GetIconInfo`")
2528 MimeType = property(GetMimeType,doc="See `GetMimeType`")
2529 MimeTypes = property(GetMimeTypes,doc="See `GetMimeTypes`")
2530 OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`")
2531 PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`")
2131d850 2532_misc_.FileType_swigregister(FileType)
d55e5bfc
RD
2533
2534def FileType_ExpandCommand(*args, **kwargs):
554f62e9
RD
2535 """FileType_ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String"""
2536 return _misc_.FileType_ExpandCommand(*args, **kwargs)
d55e5bfc
RD
2537
2538class MimeTypesManager(object):
093d3ff1 2539 """Proxy of C++ MimeTypesManager class"""
554f62e9
RD
2540 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2541 __repr__ = _swig_repr
d55e5bfc 2542 def IsOfType(*args, **kwargs):
c24da6d6 2543 """IsOfType(String mimeType, String wildcard) -> bool"""
d55e5bfc
RD
2544 return _misc_.MimeTypesManager_IsOfType(*args, **kwargs)
2545
2546 IsOfType = staticmethod(IsOfType)
554f62e9 2547 def __init__(self, *args, **kwargs):
d55e5bfc 2548 """__init__(self) -> MimeTypesManager"""
554f62e9 2549 _misc_.MimeTypesManager_swiginit(self,_misc_.new_MimeTypesManager(*args, **kwargs))
d55e5bfc
RD
2550 def Initialize(*args, **kwargs):
2551 """Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)"""
2552 return _misc_.MimeTypesManager_Initialize(*args, **kwargs)
2553
2554 def ClearData(*args, **kwargs):
2555 """ClearData(self)"""
2556 return _misc_.MimeTypesManager_ClearData(*args, **kwargs)
2557
2558 def GetFileTypeFromExtension(*args, **kwargs):
2559 """GetFileTypeFromExtension(self, String ext) -> FileType"""
2560 return _misc_.MimeTypesManager_GetFileTypeFromExtension(*args, **kwargs)
2561
2562 def GetFileTypeFromMimeType(*args, **kwargs):
2563 """GetFileTypeFromMimeType(self, String mimeType) -> FileType"""
2564 return _misc_.MimeTypesManager_GetFileTypeFromMimeType(*args, **kwargs)
2565
2566 def ReadMailcap(*args, **kwargs):
2567 """ReadMailcap(self, String filename, bool fallback=False) -> bool"""
2568 return _misc_.MimeTypesManager_ReadMailcap(*args, **kwargs)
2569
2570 def ReadMimeTypes(*args, **kwargs):
2571 """ReadMimeTypes(self, String filename) -> bool"""
2572 return _misc_.MimeTypesManager_ReadMimeTypes(*args, **kwargs)
2573
2574 def EnumAllFileTypes(*args, **kwargs):
2575 """EnumAllFileTypes(self) -> PyObject"""
2576 return _misc_.MimeTypesManager_EnumAllFileTypes(*args, **kwargs)
2577
2578 def AddFallback(*args, **kwargs):
2579 """AddFallback(self, FileTypeInfo ft)"""
2580 return _misc_.MimeTypesManager_AddFallback(*args, **kwargs)
2581
2582 def Associate(*args, **kwargs):
2583 """Associate(self, FileTypeInfo ftInfo) -> FileType"""
2584 return _misc_.MimeTypesManager_Associate(*args, **kwargs)
2585
2586 def Unassociate(*args, **kwargs):
2587 """Unassociate(self, FileType ft) -> bool"""
2588 return _misc_.MimeTypesManager_Unassociate(*args, **kwargs)
2589
554f62e9
RD
2590 __swig_destroy__ = _misc_.delete_MimeTypesManager
2591 __del__ = lambda self : None;
2131d850 2592_misc_.MimeTypesManager_swigregister(MimeTypesManager)
d55e5bfc
RD
2593TheMimeTypesManager = cvar.TheMimeTypesManager
2594
2595def MimeTypesManager_IsOfType(*args, **kwargs):
554f62e9
RD
2596 """MimeTypesManager_IsOfType(String mimeType, String wildcard) -> bool"""
2597 return _misc_.MimeTypesManager_IsOfType(*args, **kwargs)
d55e5bfc
RD
2598
2599#---------------------------------------------------------------------------
2600
2601class ArtProvider(object):
c24da6d6
RD
2602 """
2603 The wx.ArtProvider class is used to customize the look of wxWidgets
2604 application. When wxWidgets needs to display an icon or a bitmap (e.g.
2605 in the standard file dialog), it does not use hard-coded resource but
2606 asks wx.ArtProvider for it instead. This way the users can plug in
2607 their own wx.ArtProvider class and easily replace standard art with
2608 his/her own version. It is easy thing to do: all that is needed is
2609 to derive a class from wx.ArtProvider, override it's CreateBitmap
4391d97b 2610 method and register the provider with `wx.ArtProvider.Push`::
c24da6d6
RD
2611
2612 class MyArtProvider(wx.ArtProvider):
2613 def __init__(self):
2614 wx.ArtProvider.__init__(self)
2615
2616 def CreateBitmap(self, artid, client, size):
2617 ...
2618 return bmp
2619
c24da6d6 2620 """
554f62e9
RD
2621 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2622 __repr__ = _swig_repr
2623 def __init__(self, *args, **kwargs):
c24da6d6
RD
2624 """
2625 __init__(self) -> ArtProvider
2626
2627 The wx.ArtProvider class is used to customize the look of wxWidgets
2628 application. When wxWidgets needs to display an icon or a bitmap (e.g.
2629 in the standard file dialog), it does not use hard-coded resource but
2630 asks wx.ArtProvider for it instead. This way the users can plug in
2631 their own wx.ArtProvider class and easily replace standard art with
2632 his/her own version. It is easy thing to do: all that is needed is
2633 to derive a class from wx.ArtProvider, override it's CreateBitmap
4391d97b 2634 method and register the provider with `wx.ArtProvider.Push`::
c24da6d6
RD
2635
2636 class MyArtProvider(wx.ArtProvider):
2637 def __init__(self):
2638 wx.ArtProvider.__init__(self)
2639
2640 def CreateBitmap(self, artid, client, size):
2641 ...
2642 return bmp
2643
c24da6d6 2644 """
554f62e9 2645 _misc_.ArtProvider_swiginit(self,_misc_.new_ArtProvider(*args, **kwargs))
c25f90f6 2646 ArtProvider._setCallbackInfo(self, self, ArtProvider)
d55e5bfc 2647
554f62e9
RD
2648 __swig_destroy__ = _misc_.delete_ArtProvider
2649 __del__ = lambda self : None;
d55e5bfc
RD
2650 def _setCallbackInfo(*args, **kwargs):
2651 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2652 return _misc_.ArtProvider__setCallbackInfo(*args, **kwargs)
2653
4391d97b 2654 def Push(*args, **kwargs):
d55e5bfc 2655 """
4391d97b 2656 Push(ArtProvider provider)
d55e5bfc
RD
2657
2658 Add new provider to the top of providers stack.
2659 """
4391d97b 2660 return _misc_.ArtProvider_Push(*args, **kwargs)
d55e5bfc 2661
4391d97b 2662 Push = staticmethod(Push)
584d6f48 2663 PushProvider = Push
4391d97b 2664 def Insert(*args, **kwargs):
226118fc 2665 """
4391d97b 2666 Insert(ArtProvider provider)
226118fc
RD
2667
2668 Add new provider to the bottom of providers stack.
2669 """
4391d97b 2670 return _misc_.ArtProvider_Insert(*args, **kwargs)
226118fc 2671
4391d97b 2672 Insert = staticmethod(Insert)
584d6f48 2673 InsertProvider = Insert
4391d97b 2674 def Pop(*args, **kwargs):
d55e5bfc 2675 """
4391d97b 2676 Pop() -> bool
d55e5bfc
RD
2677
2678 Remove latest added provider and delete it.
2679 """
4391d97b 2680 return _misc_.ArtProvider_Pop(*args, **kwargs)
d55e5bfc 2681
4391d97b 2682 Pop = staticmethod(Pop)
584d6f48 2683 PopProvider = Pop
4391d97b 2684 def Delete(*args, **kwargs):
d55e5bfc 2685 """
4391d97b 2686 Delete(ArtProvider provider) -> bool
d55e5bfc 2687
c24da6d6
RD
2688 Remove provider. The provider must have been added previously! The
2689 provider is _not_ deleted.
d55e5bfc 2690 """
4391d97b 2691 val = _misc_.ArtProvider_Delete(*args, **kwargs)
7e08d4ef
RD
2692 args[1].thisown = 1
2693 return val
d55e5bfc 2694
4391d97b 2695 Delete = staticmethod(Delete)
584d6f48 2696 RemoveProvider = Delete
d55e5bfc
RD
2697 def GetBitmap(*args, **kwargs):
2698 """
c24da6d6 2699 GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
d55e5bfc
RD
2700
2701 Query the providers for bitmap with given ID and return it. Return
2702 wx.NullBitmap if no provider provides it.
2703 """
2704 return _misc_.ArtProvider_GetBitmap(*args, **kwargs)
2705
2706 GetBitmap = staticmethod(GetBitmap)
2707 def GetIcon(*args, **kwargs):
2708 """
c24da6d6 2709 GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
d55e5bfc 2710
c24da6d6 2711 Query the providers for icon with given ID and return it. Return
d55e5bfc
RD
2712 wx.NullIcon if no provider provides it.
2713 """
2714 return _misc_.ArtProvider_GetIcon(*args, **kwargs)
2715
2716 GetIcon = staticmethod(GetIcon)
8c3a7183
RD
2717 def GetIconBundle(*args, **kwargs):
2718 """
2719 GetIconBundle(wxArtID id, wxArtClient client=wxART_OTHER) -> wxIconBundle
2720
2721 Query the providers for iconbundle with given ID and return it. Return
2722 wx.NullIconBundle if no provider provides it.
2723 """
2724 return _misc_.ArtProvider_GetIconBundle(*args, **kwargs)
2725
2726 GetIconBundle = staticmethod(GetIconBundle)
0c549c5f 2727 def GetSizeHint(*args, **kwargs):
9c874b48 2728 """
0c549c5f 2729 GetSizeHint(String client, bool platform_dependent=False) -> Size
9c874b48 2730
0c549c5f 2731 Get the size hint of an icon from a specific Art Client, queries the
9c874b48
RD
2732 topmost provider if platform_dependent = false
2733 """
0c549c5f 2734 return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
9c874b48 2735
0c549c5f 2736 GetSizeHint = staticmethod(GetSizeHint)
d55e5bfc
RD
2737 def Destroy(*args, **kwargs):
2738 """Destroy(self)"""
b39fe951
RD
2739 args[0].this.own(False)
2740 return _misc_.ArtProvider_Destroy(*args, **kwargs)
d55e5bfc 2741
2131d850 2742_misc_.ArtProvider_swigregister(ArtProvider)
d55e5bfc
RD
2743ART_TOOLBAR = cvar.ART_TOOLBAR
2744ART_MENU = cvar.ART_MENU
2745ART_FRAME_ICON = cvar.ART_FRAME_ICON
2746ART_CMN_DIALOG = cvar.ART_CMN_DIALOG
2747ART_HELP_BROWSER = cvar.ART_HELP_BROWSER
2748ART_MESSAGE_BOX = cvar.ART_MESSAGE_BOX
4cf4100f 2749ART_BUTTON = cvar.ART_BUTTON
8c3a7183 2750ART_LIST = cvar.ART_LIST
d55e5bfc
RD
2751ART_OTHER = cvar.ART_OTHER
2752ART_ADD_BOOKMARK = cvar.ART_ADD_BOOKMARK
2753ART_DEL_BOOKMARK = cvar.ART_DEL_BOOKMARK
2754ART_HELP_SIDE_PANEL = cvar.ART_HELP_SIDE_PANEL
2755ART_HELP_SETTINGS = cvar.ART_HELP_SETTINGS
2756ART_HELP_BOOK = cvar.ART_HELP_BOOK
2757ART_HELP_FOLDER = cvar.ART_HELP_FOLDER
2758ART_HELP_PAGE = cvar.ART_HELP_PAGE
2759ART_GO_BACK = cvar.ART_GO_BACK
2760ART_GO_FORWARD = cvar.ART_GO_FORWARD
2761ART_GO_UP = cvar.ART_GO_UP
2762ART_GO_DOWN = cvar.ART_GO_DOWN
2763ART_GO_TO_PARENT = cvar.ART_GO_TO_PARENT
2764ART_GO_HOME = cvar.ART_GO_HOME
2765ART_FILE_OPEN = cvar.ART_FILE_OPEN
68350608
RD
2766ART_FILE_SAVE = cvar.ART_FILE_SAVE
2767ART_FILE_SAVE_AS = cvar.ART_FILE_SAVE_AS
d55e5bfc
RD
2768ART_PRINT = cvar.ART_PRINT
2769ART_HELP = cvar.ART_HELP
2770ART_TIP = cvar.ART_TIP
2771ART_REPORT_VIEW = cvar.ART_REPORT_VIEW
2772ART_LIST_VIEW = cvar.ART_LIST_VIEW
2773ART_NEW_DIR = cvar.ART_NEW_DIR
f78cc896
RD
2774ART_HARDDISK = cvar.ART_HARDDISK
2775ART_FLOPPY = cvar.ART_FLOPPY
2776ART_CDROM = cvar.ART_CDROM
2777ART_REMOVABLE = cvar.ART_REMOVABLE
d55e5bfc 2778ART_FOLDER = cvar.ART_FOLDER
f78cc896 2779ART_FOLDER_OPEN = cvar.ART_FOLDER_OPEN
d55e5bfc
RD
2780ART_GO_DIR_UP = cvar.ART_GO_DIR_UP
2781ART_EXECUTABLE_FILE = cvar.ART_EXECUTABLE_FILE
2782ART_NORMAL_FILE = cvar.ART_NORMAL_FILE
2783ART_TICK_MARK = cvar.ART_TICK_MARK
2784ART_CROSS_MARK = cvar.ART_CROSS_MARK
2785ART_ERROR = cvar.ART_ERROR
2786ART_QUESTION = cvar.ART_QUESTION
2787ART_WARNING = cvar.ART_WARNING
2788ART_INFORMATION = cvar.ART_INFORMATION
2789ART_MISSING_IMAGE = cvar.ART_MISSING_IMAGE
68350608
RD
2790ART_COPY = cvar.ART_COPY
2791ART_CUT = cvar.ART_CUT
2792ART_PASTE = cvar.ART_PASTE
2793ART_DELETE = cvar.ART_DELETE
a187dc0b 2794ART_NEW = cvar.ART_NEW
68350608
RD
2795ART_UNDO = cvar.ART_UNDO
2796ART_REDO = cvar.ART_REDO
2797ART_QUIT = cvar.ART_QUIT
2798ART_FIND = cvar.ART_FIND
2799ART_FIND_AND_REPLACE = cvar.ART_FIND_AND_REPLACE
d55e5bfc 2800
4391d97b 2801def ArtProvider_Push(*args, **kwargs):
554f62e9 2802 """
4391d97b 2803 ArtProvider_Push(ArtProvider provider)
d55e5bfc
RD
2804
2805 Add new provider to the top of providers stack.
2806 """
4391d97b 2807 return _misc_.ArtProvider_Push(*args, **kwargs)
d55e5bfc 2808
4391d97b 2809def ArtProvider_Insert(*args, **kwargs):
226118fc 2810 """
4391d97b 2811 ArtProvider_Insert(ArtProvider provider)
226118fc
RD
2812
2813 Add new provider to the bottom of providers stack.
2814 """
4391d97b 2815 return _misc_.ArtProvider_Insert(*args, **kwargs)
226118fc 2816
4391d97b 2817def ArtProvider_Pop(*args):
554f62e9 2818 """
4391d97b 2819 ArtProvider_Pop() -> bool
d55e5bfc
RD
2820
2821 Remove latest added provider and delete it.
2822 """
4391d97b 2823 return _misc_.ArtProvider_Pop(*args)
d55e5bfc 2824
4391d97b 2825def ArtProvider_Delete(*args, **kwargs):
554f62e9 2826 """
4391d97b 2827 ArtProvider_Delete(ArtProvider provider) -> bool
d55e5bfc 2828
c24da6d6
RD
2829 Remove provider. The provider must have been added previously! The
2830 provider is _not_ deleted.
d55e5bfc 2831 """
4391d97b 2832 val = _misc_.ArtProvider_Delete(*args, **kwargs)
554f62e9
RD
2833 args[1].thisown = 1
2834 return val
d55e5bfc
RD
2835
2836def ArtProvider_GetBitmap(*args, **kwargs):
554f62e9 2837 """
d55e5bfc
RD
2838 ArtProvider_GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap
2839
2840 Query the providers for bitmap with given ID and return it. Return
2841 wx.NullBitmap if no provider provides it.
2842 """
554f62e9 2843 return _misc_.ArtProvider_GetBitmap(*args, **kwargs)
d55e5bfc
RD
2844
2845def ArtProvider_GetIcon(*args, **kwargs):
554f62e9 2846 """
d55e5bfc
RD
2847 ArtProvider_GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon
2848
c24da6d6 2849 Query the providers for icon with given ID and return it. Return
d55e5bfc
RD
2850 wx.NullIcon if no provider provides it.
2851 """
554f62e9 2852 return _misc_.ArtProvider_GetIcon(*args, **kwargs)
d55e5bfc 2853
8c3a7183
RD
2854def ArtProvider_GetIconBundle(*args, **kwargs):
2855 """
2856 ArtProvider_GetIconBundle(wxArtID id, wxArtClient client=wxART_OTHER) -> wxIconBundle
2857
2858 Query the providers for iconbundle with given ID and return it. Return
2859 wx.NullIconBundle if no provider provides it.
2860 """
2861 return _misc_.ArtProvider_GetIconBundle(*args, **kwargs)
2862
0c549c5f 2863def ArtProvider_GetSizeHint(*args, **kwargs):
554f62e9 2864 """
0c549c5f 2865 ArtProvider_GetSizeHint(String client, bool platform_dependent=False) -> Size
9c874b48 2866
0c549c5f 2867 Get the size hint of an icon from a specific Art Client, queries the
9c874b48
RD
2868 topmost provider if platform_dependent = false
2869 """
554f62e9 2870 return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
9c874b48 2871
d55e5bfc
RD
2872#---------------------------------------------------------------------------
2873
2874CONFIG_USE_LOCAL_FILE = _misc_.CONFIG_USE_LOCAL_FILE
2875CONFIG_USE_GLOBAL_FILE = _misc_.CONFIG_USE_GLOBAL_FILE
2876CONFIG_USE_RELATIVE_PATH = _misc_.CONFIG_USE_RELATIVE_PATH
2877CONFIG_USE_NO_ESCAPE_CHARACTERS = _misc_.CONFIG_USE_NO_ESCAPE_CHARACTERS
2878class ConfigBase(object):
2879 """
2880 wx.ConfigBase class defines the basic interface of all config
79fccf9d
RD
2881 classes. It can not be used by itself (it is an abstract base class)
2882 and you will always use one of its derivations: wx.Config or
2883 wx.FileConfig.
2884
2885 wx.ConfigBase organizes the items in a tree-like structure, modeled
2886 after the Unix/Dos filesystem. There are groups that act like
2887 directories and entries, key/value pairs that act like files. There
2888 is always one current group given by the current path. As in the file
2889 system case, to specify a key in the config class you must use a path
2890 to it. Config classes also support the notion of the current group,
2891 which makes it possible to use relative paths.
d55e5bfc
RD
2892
2893 Keys are pairs "key_name = value" where value may be of string,
2894 integer floating point or boolean, you can not store binary data
79fccf9d
RD
2895 without first encoding it as a string. For performance reasons items
2896 should be kept small, no more than a couple kilobytes.
d55e5bfc
RD
2897
2898 """
554f62e9
RD
2899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2900 def __init__(self): raise AttributeError, "No constructor defined"
2901 __repr__ = _swig_repr
2902 __swig_destroy__ = _misc_.delete_ConfigBase
2903 __del__ = lambda self : None;
d55e5bfc
RD
2904 Type_Unknown = _misc_.ConfigBase_Type_Unknown
2905 Type_String = _misc_.ConfigBase_Type_String
2906 Type_Boolean = _misc_.ConfigBase_Type_Boolean
2907 Type_Integer = _misc_.ConfigBase_Type_Integer
2908 Type_Float = _misc_.ConfigBase_Type_Float
2909 def Set(*args, **kwargs):
2910 """
c24da6d6 2911 Set(ConfigBase config) -> ConfigBase
d55e5bfc 2912
79fccf9d
RD
2913 Sets the global config object (the one returned by Get) and returns a
2914 reference to the previous global config object.
d55e5bfc
RD
2915 """
2916 return _misc_.ConfigBase_Set(*args, **kwargs)
2917
2918 Set = staticmethod(Set)
2919 def Get(*args, **kwargs):
2920 """
c24da6d6 2921 Get(bool createOnDemand=True) -> ConfigBase
d55e5bfc
RD
2922
2923 Returns the current global config object, creating one if neccessary.
2924 """
2925 return _misc_.ConfigBase_Get(*args, **kwargs)
2926
2927 Get = staticmethod(Get)
2928 def Create(*args, **kwargs):
2929 """
c24da6d6 2930 Create() -> ConfigBase
d55e5bfc
RD
2931
2932 Create and return a new global config object. This function will
2933 create the "best" implementation of wx.Config available for the
2934 current platform.
2935 """
2936 return _misc_.ConfigBase_Create(*args, **kwargs)
2937
2938 Create = staticmethod(Create)
2939 def DontCreateOnDemand(*args, **kwargs):
2940 """
c24da6d6 2941 DontCreateOnDemand()
d55e5bfc 2942
79fccf9d
RD
2943 Should Get() try to create a new log object if there isn't a current
2944 one?
d55e5bfc
RD
2945 """
2946 return _misc_.ConfigBase_DontCreateOnDemand(*args, **kwargs)
2947
2948 DontCreateOnDemand = staticmethod(DontCreateOnDemand)
2949 def SetPath(*args, **kwargs):
2950 """
2951 SetPath(self, String path)
2952
79fccf9d
RD
2953 Set current path: if the first character is '/', it's the absolute
2954 path, otherwise it's a relative path. '..' is supported. If the
2955 strPath doesn't exist it is created.
d55e5bfc
RD
2956 """
2957 return _misc_.ConfigBase_SetPath(*args, **kwargs)
2958
2959 def GetPath(*args, **kwargs):
2960 """
2961 GetPath(self) -> String
2962
2963 Retrieve the current path (always as absolute path)
2964 """
2965 return _misc_.ConfigBase_GetPath(*args, **kwargs)
2966
2967 def GetFirstGroup(*args, **kwargs):
2968 """
2969 GetFirstGroup() -> (more, value, index)
2970
79fccf9d
RD
2971 Allows enumerating the subgroups in a config object. Returns a tuple
2972 containing a flag indicating there are more items, the name of the
2973 current item, and an index to pass to GetNextGroup to fetch the next
2974 item.
d55e5bfc
RD
2975 """
2976 return _misc_.ConfigBase_GetFirstGroup(*args, **kwargs)
2977
2978 def GetNextGroup(*args, **kwargs):
2979 """
2980 GetNextGroup(long index) -> (more, value, index)
2981
79fccf9d
RD
2982 Allows enumerating the subgroups in a config object. Returns a tuple
2983 containing a flag indicating there are more items, the name of the
2984 current item, and an index to pass to GetNextGroup to fetch the next
2985 item.
d55e5bfc
RD
2986 """
2987 return _misc_.ConfigBase_GetNextGroup(*args, **kwargs)
2988
2989 def GetFirstEntry(*args, **kwargs):
2990 """
2991 GetFirstEntry() -> (more, value, index)
2992
2993 Allows enumerating the entries in the current group in a config
79fccf9d
RD
2994 object. Returns a tuple containing a flag indicating there are more
2995 items, the name of the current item, and an index to pass to
d55e5bfc
RD
2996 GetNextGroup to fetch the next item.
2997 """
2998 return _misc_.ConfigBase_GetFirstEntry(*args, **kwargs)
2999
3000 def GetNextEntry(*args, **kwargs):
3001 """
3002 GetNextEntry(long index) -> (more, value, index)
3003
3004 Allows enumerating the entries in the current group in a config
79fccf9d
RD
3005 object. Returns a tuple containing a flag indicating there are more
3006 items, the name of the current item, and an index to pass to
d55e5bfc
RD
3007 GetNextGroup to fetch the next item.
3008 """
3009 return _misc_.ConfigBase_GetNextEntry(*args, **kwargs)
3010
3011 def GetNumberOfEntries(*args, **kwargs):
3012 """
3013 GetNumberOfEntries(self, bool recursive=False) -> size_t
3014
79fccf9d
RD
3015 Get the number of entries in the current group, with or without its
3016 subgroups.
d55e5bfc
RD
3017 """
3018 return _misc_.ConfigBase_GetNumberOfEntries(*args, **kwargs)
3019
3020 def GetNumberOfGroups(*args, **kwargs):
3021 """
3022 GetNumberOfGroups(self, bool recursive=False) -> size_t
3023
79fccf9d
RD
3024 Get the number of subgroups in the current group, with or without its
3025 subgroups.
d55e5bfc
RD
3026 """
3027 return _misc_.ConfigBase_GetNumberOfGroups(*args, **kwargs)
3028
3029 def HasGroup(*args, **kwargs):
3030 """
3031 HasGroup(self, String name) -> bool
3032
3033 Returns True if the group by this name exists
3034 """
3035 return _misc_.ConfigBase_HasGroup(*args, **kwargs)
3036
3037 def HasEntry(*args, **kwargs):
3038 """
3039 HasEntry(self, String name) -> bool
3040
3041 Returns True if the entry by this name exists
3042 """
3043 return _misc_.ConfigBase_HasEntry(*args, **kwargs)
3044
3045 def Exists(*args, **kwargs):
3046 """
3047 Exists(self, String name) -> bool
3048
3049 Returns True if either a group or an entry with a given name exists
3050 """
3051 return _misc_.ConfigBase_Exists(*args, **kwargs)
3052
3053 def GetEntryType(*args, **kwargs):
3054 """
3055 GetEntryType(self, String name) -> int
3056
3057 Get the type of the entry. Returns one of the wx.Config.Type_XXX values.
3058 """
3059 return _misc_.ConfigBase_GetEntryType(*args, **kwargs)
3060
3061 def Read(*args, **kwargs):
3062 """
3063 Read(self, String key, String defaultVal=EmptyString) -> String
3064
3065 Returns the value of key if it exists, defaultVal otherwise.
3066 """
3067 return _misc_.ConfigBase_Read(*args, **kwargs)
3068
3069 def ReadInt(*args, **kwargs):
3070 """
3071 ReadInt(self, String key, long defaultVal=0) -> long
3072
3073 Returns the value of key if it exists, defaultVal otherwise.
3074 """
3075 return _misc_.ConfigBase_ReadInt(*args, **kwargs)
3076
3077 def ReadFloat(*args, **kwargs):
3078 """
3079 ReadFloat(self, String key, double defaultVal=0.0) -> double
3080
3081 Returns the value of key if it exists, defaultVal otherwise.
3082 """
3083 return _misc_.ConfigBase_ReadFloat(*args, **kwargs)
3084
3085 def ReadBool(*args, **kwargs):
3086 """
3087 ReadBool(self, String key, bool defaultVal=False) -> bool
3088
3089 Returns the value of key if it exists, defaultVal otherwise.
3090 """
3091 return _misc_.ConfigBase_ReadBool(*args, **kwargs)
3092
3093 def Write(*args, **kwargs):
3094 """
3095 Write(self, String key, String value) -> bool
3096
3097 write the value (return True on success)
3098 """
3099 return _misc_.ConfigBase_Write(*args, **kwargs)
3100
3101 def WriteInt(*args, **kwargs):
3102 """
3103 WriteInt(self, String key, long value) -> bool
3104
3105 write the value (return True on success)
3106 """
3107 return _misc_.ConfigBase_WriteInt(*args, **kwargs)
3108
3109 def WriteFloat(*args, **kwargs):
3110 """
3111 WriteFloat(self, String key, double value) -> bool
3112
3113 write the value (return True on success)
3114 """
3115 return _misc_.ConfigBase_WriteFloat(*args, **kwargs)
3116
3117 def WriteBool(*args, **kwargs):
3118 """
3119 WriteBool(self, String key, bool value) -> bool
3120
3121 write the value (return True on success)
3122 """
3123 return _misc_.ConfigBase_WriteBool(*args, **kwargs)
3124
3125 def Flush(*args, **kwargs):
3126 """
3127 Flush(self, bool currentOnly=False) -> bool
3128
3129 permanently writes all changes
3130 """
3131 return _misc_.ConfigBase_Flush(*args, **kwargs)
3132
3133 def RenameEntry(*args, **kwargs):
3134 """
3135 RenameEntry(self, String oldName, String newName) -> bool
3136
3137 Rename an entry. Returns False on failure (probably because the new
3138 name is already taken by an existing entry)
3139 """
3140 return _misc_.ConfigBase_RenameEntry(*args, **kwargs)
3141
3142 def RenameGroup(*args, **kwargs):
3143 """
3144 RenameGroup(self, String oldName, String newName) -> bool
3145
79fccf9d 3146 Rename a group. Returns False on failure (probably because the new
d55e5bfc
RD
3147 name is already taken by an existing entry)
3148 """
3149 return _misc_.ConfigBase_RenameGroup(*args, **kwargs)
3150
3151 def DeleteEntry(*args, **kwargs):
3152 """
3153 DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -> bool
3154
79fccf9d
RD
3155 Deletes the specified entry and the group it belongs to if it was the
3156 last key in it and the second parameter is True
d55e5bfc
RD
3157 """
3158 return _misc_.ConfigBase_DeleteEntry(*args, **kwargs)
3159
3160 def DeleteGroup(*args, **kwargs):
3161 """
3162 DeleteGroup(self, String key) -> bool
3163
3164 Delete the group (with all subgroups)
3165 """
3166 return _misc_.ConfigBase_DeleteGroup(*args, **kwargs)
3167
3168 def DeleteAll(*args, **kwargs):
3169 """
3170 DeleteAll(self) -> bool
3171
3172 Delete the whole underlying object (disk file, registry key, ...)
c24da6d6 3173 primarly intended for use by deinstallation routine.
d55e5bfc
RD
3174 """
3175 return _misc_.ConfigBase_DeleteAll(*args, **kwargs)
3176
3177 def SetExpandEnvVars(*args, **kwargs):
3178 """
3179 SetExpandEnvVars(self, bool doIt=True)
3180
79fccf9d
RD
3181 We can automatically expand environment variables in the config
3182 entries this option is on by default, you can turn it on/off at any
3183 time)
d55e5bfc
RD
3184 """
3185 return _misc_.ConfigBase_SetExpandEnvVars(*args, **kwargs)
3186
3187 def IsExpandingEnvVars(*args, **kwargs):
3188 """
3189 IsExpandingEnvVars(self) -> bool
3190
3191 Are we currently expanding environment variables?
3192 """
3193 return _misc_.ConfigBase_IsExpandingEnvVars(*args, **kwargs)
3194
3195 def SetRecordDefaults(*args, **kwargs):
3196 """
3197 SetRecordDefaults(self, bool doIt=True)
3198
3199 Set whether the config objec should record default values.
3200 """
3201 return _misc_.ConfigBase_SetRecordDefaults(*args, **kwargs)
3202
3203 def IsRecordingDefaults(*args, **kwargs):
3204 """
3205 IsRecordingDefaults(self) -> bool
3206
3207 Are we currently recording default values?
3208 """
3209 return _misc_.ConfigBase_IsRecordingDefaults(*args, **kwargs)
3210
3211 def ExpandEnvVars(*args, **kwargs):
3212 """
3213 ExpandEnvVars(self, String str) -> String
3214
3215 Expand any environment variables in str and return the result
3216 """
3217 return _misc_.ConfigBase_ExpandEnvVars(*args, **kwargs)
3218
3219 def GetAppName(*args, **kwargs):
3220 """GetAppName(self) -> String"""
3221 return _misc_.ConfigBase_GetAppName(*args, **kwargs)
3222
3223 def GetVendorName(*args, **kwargs):
3224 """GetVendorName(self) -> String"""
3225 return _misc_.ConfigBase_GetVendorName(*args, **kwargs)
3226
3227 def SetAppName(*args, **kwargs):
3228 """SetAppName(self, String appName)"""
3229 return _misc_.ConfigBase_SetAppName(*args, **kwargs)
3230
3231 def SetVendorName(*args, **kwargs):
3232 """SetVendorName(self, String vendorName)"""
3233 return _misc_.ConfigBase_SetVendorName(*args, **kwargs)
3234
3235 def SetStyle(*args, **kwargs):
3236 """SetStyle(self, long style)"""
3237 return _misc_.ConfigBase_SetStyle(*args, **kwargs)
3238
3239 def GetStyle(*args, **kwargs):
3240 """GetStyle(self) -> long"""
3241 return _misc_.ConfigBase_GetStyle(*args, **kwargs)
3242
226118fc
RD
3243 AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
3244 EntryType = property(GetEntryType,doc="See `GetEntryType`")
3245 FirstEntry = property(GetFirstEntry,doc="See `GetFirstEntry`")
3246 FirstGroup = property(GetFirstGroup,doc="See `GetFirstGroup`")
3247 NextEntry = property(GetNextEntry,doc="See `GetNextEntry`")
3248 NextGroup = property(GetNextGroup,doc="See `GetNextGroup`")
3249 NumberOfEntries = property(GetNumberOfEntries,doc="See `GetNumberOfEntries`")
3250 NumberOfGroups = property(GetNumberOfGroups,doc="See `GetNumberOfGroups`")
3251 Path = property(GetPath,SetPath,doc="See `GetPath` and `SetPath`")
3252 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
3253 VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
2131d850 3254_misc_.ConfigBase_swigregister(ConfigBase)
d55e5bfc
RD
3255
3256def ConfigBase_Set(*args, **kwargs):
554f62e9 3257 """
d55e5bfc
RD
3258 ConfigBase_Set(ConfigBase config) -> ConfigBase
3259
79fccf9d
RD
3260 Sets the global config object (the one returned by Get) and returns a
3261 reference to the previous global config object.
d55e5bfc 3262 """
554f62e9 3263 return _misc_.ConfigBase_Set(*args, **kwargs)
d55e5bfc
RD
3264
3265def ConfigBase_Get(*args, **kwargs):
554f62e9 3266 """
d55e5bfc
RD
3267 ConfigBase_Get(bool createOnDemand=True) -> ConfigBase
3268
3269 Returns the current global config object, creating one if neccessary.
3270 """
554f62e9 3271 return _misc_.ConfigBase_Get(*args, **kwargs)
d55e5bfc 3272
554f62e9
RD
3273def ConfigBase_Create(*args):
3274 """
d55e5bfc
RD
3275 ConfigBase_Create() -> ConfigBase
3276
3277 Create and return a new global config object. This function will
3278 create the "best" implementation of wx.Config available for the
3279 current platform.
3280 """
554f62e9 3281 return _misc_.ConfigBase_Create(*args)
d55e5bfc 3282
554f62e9
RD
3283def ConfigBase_DontCreateOnDemand(*args):
3284 """
d55e5bfc
RD
3285 ConfigBase_DontCreateOnDemand()
3286
79fccf9d
RD
3287 Should Get() try to create a new log object if there isn't a current
3288 one?
d55e5bfc 3289 """
554f62e9 3290 return _misc_.ConfigBase_DontCreateOnDemand(*args)
d55e5bfc
RD
3291
3292class Config(ConfigBase):
3293 """
3294 This ConfigBase-derived class will use the registry on Windows,
3295 and will be a wx.FileConfig on other platforms.
3296 """
554f62e9
RD
3297 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3298 __repr__ = _swig_repr
3299 def __init__(self, *args, **kwargs):
d55e5bfc
RD
3300 """
3301 __init__(self, String appName=EmptyString, String vendorName=EmptyString,
3302 String localFilename=EmptyString, String globalFilename=EmptyString,
3303 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> Config
3304 """
554f62e9
RD
3305 _misc_.Config_swiginit(self,_misc_.new_Config(*args, **kwargs))
3306 __swig_destroy__ = _misc_.delete_Config
3307 __del__ = lambda self : None;
2131d850 3308_misc_.Config_swigregister(Config)
d55e5bfc
RD
3309
3310class FileConfig(ConfigBase):
3311 """This config class will use a file for storage on all platforms."""
554f62e9
RD
3312 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3313 __repr__ = _swig_repr
3314 def __init__(self, *args, **kwargs):
d55e5bfc
RD
3315 """
3316 __init__(self, String appName=EmptyString, String vendorName=EmptyString,
3317 String localFilename=EmptyString, String globalFilename=EmptyString,
3318 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig
3319 """
554f62e9
RD
3320 _misc_.FileConfig_swiginit(self,_misc_.new_FileConfig(*args, **kwargs))
3321 __swig_destroy__ = _misc_.delete_FileConfig
3322 __del__ = lambda self : None;
cbfc9df6
RD
3323 def GetGlobalFileName(*args, **kwargs):
3324 """GetGlobalFileName(String szFile) -> String"""
3325 return _misc_.FileConfig_GetGlobalFileName(*args, **kwargs)
3326
3327 GetGlobalFileName = staticmethod(GetGlobalFileName)
3328 def GetLocalFileName(*args, **kwargs):
3329 """GetLocalFileName(String szFile, int style=0) -> String"""
3330 return _misc_.FileConfig_GetLocalFileName(*args, **kwargs)
3331
3332 GetLocalFileName = staticmethod(GetLocalFileName)
2131d850 3333_misc_.FileConfig_swigregister(FileConfig)
d55e5bfc 3334
cbfc9df6
RD
3335def FileConfig_GetGlobalFileName(*args, **kwargs):
3336 """FileConfig_GetGlobalFileName(String szFile) -> String"""
3337 return _misc_.FileConfig_GetGlobalFileName(*args, **kwargs)
3338
3339def FileConfig_GetLocalFileName(*args, **kwargs):
3340 """FileConfig_GetLocalFileName(String szFile, int style=0) -> String"""
3341 return _misc_.FileConfig_GetLocalFileName(*args, **kwargs)
3342
d55e5bfc
RD
3343class ConfigPathChanger(object):
3344 """
79fccf9d
RD
3345 A handy little class which changes current path to the path of given
3346 entry and restores it in the destructoir: so if you declare a local
3347 variable of this type, you work in the entry directory and the path is
3348 automatically restored when the function returns.
d55e5bfc 3349 """
554f62e9
RD
3350 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3351 __repr__ = _swig_repr
3352 def __init__(self, *args, **kwargs):
d55e5bfc 3353 """__init__(self, ConfigBase config, String entry) -> ConfigPathChanger"""
554f62e9
RD
3354 _misc_.ConfigPathChanger_swiginit(self,_misc_.new_ConfigPathChanger(*args, **kwargs))
3355 __swig_destroy__ = _misc_.delete_ConfigPathChanger
3356 __del__ = lambda self : None;
d55e5bfc
RD
3357 def Name(*args, **kwargs):
3358 """
3359 Name(self) -> String
3360
3361 Get the key name
3362 """
3363 return _misc_.ConfigPathChanger_Name(*args, **kwargs)
3364
2131d850 3365_misc_.ConfigPathChanger_swigregister(ConfigPathChanger)
d55e5bfc
RD
3366
3367
3368def ExpandEnvVars(*args, **kwargs):
554f62e9 3369 """
d55e5bfc
RD
3370 ExpandEnvVars(String sz) -> String
3371
3372 Replace environment variables ($SOMETHING) with their values. The
79fccf9d
RD
3373 format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric
3374 characters and '_' only. '$' must be escaped ('\$') in order to be
3375 taken literally.
d55e5bfc 3376 """
554f62e9 3377 return _misc_.ExpandEnvVars(*args, **kwargs)
d55e5bfc
RD
3378#---------------------------------------------------------------------------
3379
3380class DateTime(object):
093d3ff1 3381 """Proxy of C++ DateTime class"""
554f62e9
RD
3382 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
3383 __repr__ = _swig_repr
d55e5bfc
RD
3384 Local = _misc_.DateTime_Local
3385 GMT_12 = _misc_.DateTime_GMT_12
3386 GMT_11 = _misc_.DateTime_GMT_11
3387 GMT_10 = _misc_.DateTime_GMT_10
3388 GMT_9 = _misc_.DateTime_GMT_9
3389 GMT_8 = _misc_.DateTime_GMT_8
3390 GMT_7 = _misc_.DateTime_GMT_7
3391 GMT_6 = _misc_.DateTime_GMT_6
3392 GMT_5 = _misc_.DateTime_GMT_5
3393 GMT_4 = _misc_.DateTime_GMT_4
3394 GMT_3 = _misc_.DateTime_GMT_3
3395 GMT_2 = _misc_.DateTime_GMT_2
3396 GMT_1 = _misc_.DateTime_GMT_1
3397 GMT0 = _misc_.DateTime_GMT0
3398 GMT1 = _misc_.DateTime_GMT1
3399 GMT2 = _misc_.DateTime_GMT2
3400 GMT3 = _misc_.DateTime_GMT3
3401 GMT4 = _misc_.DateTime_GMT4
3402 GMT5 = _misc_.DateTime_GMT5
3403 GMT6 = _misc_.DateTime_GMT6
3404 GMT7 = _misc_.DateTime_GMT7
3405 GMT8 = _misc_.DateTime_GMT8
3406 GMT9 = _misc_.DateTime_GMT9
3407 GMT10 = _misc_.DateTime_GMT10
3408 GMT11 = _misc_.DateTime_GMT11
3409 GMT12 = _misc_.DateTime_GMT12
8f514ab4 3410 GMT13 = _misc_.DateTime_GMT13
d55e5bfc
RD
3411 WET = _misc_.DateTime_WET
3412 WEST = _misc_.DateTime_WEST
3413 CET = _misc_.DateTime_CET
3414 CEST = _misc_.DateTime_CEST
3415 EET = _misc_.DateTime_EET
3416 EEST = _misc_.DateTime_EEST
3417 MSK = _misc_.DateTime_MSK
3418 MSD = _misc_.DateTime_MSD
3419 AST = _misc_.DateTime_AST
3420 ADT = _misc_.DateTime_ADT
3421 EST = _misc_.DateTime_EST
3422 EDT = _misc_.DateTime_EDT
3423 CST = _misc_.DateTime_CST
3424 CDT = _misc_.DateTime_CDT
3425 MST = _misc_.DateTime_MST
3426 MDT = _misc_.DateTime_MDT
3427 PST = _misc_.DateTime_PST
3428 PDT = _misc_.DateTime_PDT
3429 HST = _misc_.DateTime_HST
3430 AKST = _misc_.DateTime_AKST
3431 AKDT = _misc_.DateTime_AKDT
3432 A_WST = _misc_.DateTime_A_WST
3433 A_CST = _misc_.DateTime_A_CST
3434 A_EST = _misc_.DateTime_A_EST
3435 A_ESST = _misc_.DateTime_A_ESST
8f514ab4
RD
3436 NZST = _misc_.DateTime_NZST
3437 NZDT = _misc_.DateTime_NZDT
d55e5bfc
RD
3438 UTC = _misc_.DateTime_UTC
3439 Gregorian = _misc_.DateTime_Gregorian
3440 Julian = _misc_.DateTime_Julian
3441 Gr_Unknown = _misc_.DateTime_Gr_Unknown
3442 Gr_Standard = _misc_.DateTime_Gr_Standard
3443 Gr_Alaska = _misc_.DateTime_Gr_Alaska
3444 Gr_Albania = _misc_.DateTime_Gr_Albania
3445 Gr_Austria = _misc_.DateTime_Gr_Austria
3446 Gr_Austria_Brixen = _misc_.DateTime_Gr_Austria_Brixen
3447 Gr_Austria_Salzburg = _misc_.DateTime_Gr_Austria_Salzburg
3448 Gr_Austria_Tyrol = _misc_.DateTime_Gr_Austria_Tyrol
3449 Gr_Austria_Carinthia = _misc_.DateTime_Gr_Austria_Carinthia
3450 Gr_Austria_Styria = _misc_.DateTime_Gr_Austria_Styria
3451 Gr_Belgium = _misc_.DateTime_Gr_Belgium
3452 Gr_Bulgaria = _misc_.DateTime_Gr_Bulgaria
3453 Gr_Bulgaria_1 = _misc_.DateTime_Gr_Bulgaria_1
3454 Gr_Bulgaria_2 = _misc_.DateTime_Gr_Bulgaria_2
3455 Gr_Bulgaria_3 = _misc_.DateTime_Gr_Bulgaria_3
3456 Gr_Canada = _misc_.DateTime_Gr_Canada
3457 Gr_China = _misc_.DateTime_Gr_China
3458 Gr_China_1 = _misc_.DateTime_Gr_China_1
3459 Gr_China_2 = _misc_.DateTime_Gr_China_2
3460 Gr_Czechoslovakia = _misc_.DateTime_Gr_Czechoslovakia
3461 Gr_Denmark = _misc_.DateTime_Gr_Denmark
3462 Gr_Egypt = _misc_.DateTime_Gr_Egypt
3463 Gr_Estonia = _misc_.DateTime_Gr_Estonia
3464 Gr_Finland = _misc_.DateTime_Gr_Finland
3465 Gr_France = _misc_.DateTime_Gr_France
3466 Gr_France_Alsace = _misc_.DateTime_Gr_France_Alsace
3467 Gr_France_Lorraine = _misc_.DateTime_Gr_France_Lorraine
3468 Gr_France_Strasbourg = _misc_.DateTime_Gr_France_Strasbourg
3469 Gr_Germany = _misc_.DateTime_Gr_Germany
3470 Gr_Germany_Catholic = _misc_.DateTime_Gr_Germany_Catholic
3471 Gr_Germany_Prussia = _misc_.DateTime_Gr_Germany_Prussia
3472 Gr_Germany_Protestant = _misc_.DateTime_Gr_Germany_Protestant
3473 Gr_GreatBritain = _misc_.DateTime_Gr_GreatBritain
3474 Gr_Greece = _misc_.DateTime_Gr_Greece
3475 Gr_Hungary = _misc_.DateTime_Gr_Hungary
3476 Gr_Ireland = _misc_.DateTime_Gr_Ireland
3477 Gr_Italy = _misc_.DateTime_Gr_Italy
3478 Gr_Japan = _misc_.DateTime_Gr_Japan
3479 Gr_Japan_1 = _misc_.DateTime_Gr_Japan_1
3480 Gr_Japan_2 = _misc_.DateTime_Gr_Japan_2
3481 Gr_Japan_3 = _misc_.DateTime_Gr_Japan_3
3482 Gr_Latvia = _misc_.DateTime_Gr_Latvia
3483 Gr_Lithuania = _misc_.DateTime_Gr_Lithuania
3484 Gr_Luxemburg = _misc_.DateTime_Gr_Luxemburg
3485 Gr_Netherlands = _misc_.DateTime_Gr_Netherlands
3486 Gr_Netherlands_Groningen = _misc_.DateTime_Gr_Netherlands_Groningen
3487 Gr_Netherlands_Gelderland = _misc_.DateTime_Gr_Netherlands_Gelderland
3488 Gr_Netherlands_Utrecht = _misc_.DateTime_Gr_Netherlands_Utrecht
3489 Gr_Netherlands_Friesland = _misc_.DateTime_Gr_Netherlands_Friesland
3490 Gr_Norway = _misc_.DateTime_Gr_Norway
3491 Gr_Poland = _misc_.DateTime_Gr_Poland
3492 Gr_Portugal = _misc_.DateTime_Gr_Portugal
3493 Gr_Romania = _misc_.DateTime_Gr_Romania
3494 Gr_Russia = _misc_.DateTime_Gr_Russia
3495 Gr_Scotland = _misc_.DateTime_Gr_Scotland
3496 Gr_Spain = _misc_.DateTime_Gr_Spain
3497 Gr_Sweden = _misc_.DateTime_Gr_Sweden
3498 Gr_Switzerland = _misc_.DateTime_Gr_Switzerland
3499 Gr_Switzerland_Catholic = _misc_.DateTime_Gr_Switzerland_Catholic
3500 Gr_Switzerland_Protestant = _misc_.DateTime_Gr_Switzerland_Protestant
3501 Gr_Turkey = _misc_.DateTime_Gr_Turkey
3502 Gr_USA = _misc_.DateTime_Gr_USA
3503 Gr_Wales = _misc_.DateTime_Gr_Wales
3504 Gr_Yugoslavia = _misc_.DateTime_Gr_Yugoslavia
3505 Country_Unknown = _misc_.DateTime_Country_Unknown
3506 Country_Default = _misc_.DateTime_Country_Default
3507 Country_WesternEurope_Start = _misc_.DateTime_Country_WesternEurope_Start
3508 Country_EEC = _misc_.DateTime_Country_EEC
3509 France = _misc_.DateTime_France
3510 Germany = _misc_.DateTime_Germany
3511 UK = _misc_.DateTime_UK
3512 Country_WesternEurope_End = _misc_.DateTime_Country_WesternEurope_End
3513 Russia = _misc_.DateTime_Russia
3514 USA = _misc_.DateTime_USA
3515 Jan = _misc_.DateTime_Jan
3516 Feb = _misc_.DateTime_Feb
3517 Mar = _misc_.DateTime_Mar
3518 Apr = _misc_.DateTime_Apr
3519 May = _misc_.DateTime_May
3520 Jun = _misc_.DateTime_Jun
3521 Jul = _misc_.DateTime_Jul
3522 Aug = _misc_.DateTime_Aug
3523 Sep = _misc_.DateTime_Sep
3524 Oct = _misc_.DateTime_Oct
3525 Nov = _misc_.DateTime_Nov
3526 Dec = _misc_.DateTime_Dec
3527 Inv_Month = _misc_.DateTime_Inv_Month
3528 Sun = _misc_.DateTime_Sun
3529 Mon = _misc_.DateTime_Mon
3530 Tue = _misc_.DateTime_Tue
3531 Wed = _misc_.DateTime_Wed
3532 Thu = _misc_.DateTime_Thu
3533 Fri = _misc_.DateTime_Fri
3534 Sat = _misc_.DateTime_Sat
3535 Inv_WeekDay = _misc_.DateTime_Inv_WeekDay
3536 Inv_Year = _misc_.DateTime_Inv_Year
3537 Name_Full = _misc_.DateTime_Name_Full
3538 Name_Abbr = _misc_.DateTime_Name_Abbr
3539 Default_First = _misc_.DateTime_Default_First
3540 Monday_First = _misc_.DateTime_Monday_First
3541 Sunday_First = _misc_.DateTime_Sunday_First
3542 def SetCountry(*args, **kwargs):
c24da6d6 3543 """SetCountry(int country)"""
d55e5bfc
RD
3544 return _misc_.DateTime_SetCountry(*args, **kwargs)
3545
3546 SetCountry = staticmethod(SetCountry)
3547 def GetCountry(*args, **kwargs):
c24da6d6 3548 """GetCountry() -> int"""
d55e5bfc
RD
3549 return _misc_.DateTime_GetCountry(*args, **kwargs)
3550
3551 GetCountry = staticmethod(GetCountry)
3552 def IsWestEuropeanCountry(*args, **kwargs):
c24da6d6 3553 """IsWestEuropeanCountry(int country=Country_Default) -> bool"""
d55e5bfc
RD
3554 return _misc_.DateTime_IsWestEuropeanCountry(*args, **kwargs)
3555
3556 IsWestEuropeanCountry = staticmethod(IsWestEuropeanCountry)
3557 def GetCurrentYear(*args, **kwargs):
c24da6d6 3558 """GetCurrentYear(int cal=Gregorian) -> int"""
d55e5bfc
RD
3559 return _misc_.DateTime_GetCurrentYear(*args, **kwargs)
3560
3561 GetCurrentYear = staticmethod(GetCurrentYear)
3562 def ConvertYearToBC(*args, **kwargs):
c24da6d6 3563 """ConvertYearToBC(int year) -> int"""
d55e5bfc
RD
3564 return _misc_.DateTime_ConvertYearToBC(*args, **kwargs)
3565
3566 ConvertYearToBC = staticmethod(ConvertYearToBC)
3567 def GetCurrentMonth(*args, **kwargs):
c24da6d6 3568 """GetCurrentMonth(int cal=Gregorian) -> int"""
d55e5bfc
RD
3569 return _misc_.DateTime_GetCurrentMonth(*args, **kwargs)
3570
3571 GetCurrentMonth = staticmethod(GetCurrentMonth)
3572 def IsLeapYear(*args, **kwargs):
c24da6d6 3573 """IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
d55e5bfc
RD
3574 return _misc_.DateTime_IsLeapYear(*args, **kwargs)
3575
3576 IsLeapYear = staticmethod(IsLeapYear)
3577 def GetCentury(*args, **kwargs):
c24da6d6 3578 """GetCentury(int year=Inv_Year) -> int"""
d55e5bfc
RD
3579 return _misc_.DateTime_GetCentury(*args, **kwargs)
3580
3581 GetCentury = staticmethod(GetCentury)
3582 def GetNumberOfDaysinYear(*args, **kwargs):
c24da6d6 3583 """GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
d55e5bfc
RD
3584 return _misc_.DateTime_GetNumberOfDaysinYear(*args, **kwargs)
3585
3586 GetNumberOfDaysinYear = staticmethod(GetNumberOfDaysinYear)
3587 def GetNumberOfDaysInMonth(*args, **kwargs):
c24da6d6 3588 """GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
d55e5bfc
RD
3589 return _misc_.DateTime_GetNumberOfDaysInMonth(*args, **kwargs)
3590
3591 GetNumberOfDaysInMonth = staticmethod(GetNumberOfDaysInMonth)
3592 def GetMonthName(*args, **kwargs):
c24da6d6 3593 """GetMonthName(int month, int flags=Name_Full) -> String"""
d55e5bfc
RD
3594 return _misc_.DateTime_GetMonthName(*args, **kwargs)
3595
3596 GetMonthName = staticmethod(GetMonthName)
3597 def GetWeekDayName(*args, **kwargs):
c24da6d6 3598 """GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
d55e5bfc
RD
3599 return _misc_.DateTime_GetWeekDayName(*args, **kwargs)
3600
3601 GetWeekDayName = staticmethod(GetWeekDayName)
3602 def GetAmPmStrings(*args, **kwargs):
a001823c
RD
3603 """
3604 GetAmPmStrings() -> (am, pm)
3605
3606 Get the AM and PM strings in the current locale (may be empty)
3607 """
d55e5bfc
RD
3608 return _misc_.DateTime_GetAmPmStrings(*args, **kwargs)
3609
3610 GetAmPmStrings = staticmethod(GetAmPmStrings)
3611 def IsDSTApplicable(*args, **kwargs):
c24da6d6 3612 """IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
d55e5bfc
RD
3613 return _misc_.DateTime_IsDSTApplicable(*args, **kwargs)
3614
3615 IsDSTApplicable = staticmethod(IsDSTApplicable)
3616 def GetBeginDST(*args, **kwargs):
c24da6d6 3617 """GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
d55e5bfc
RD
3618 return _misc_.DateTime_GetBeginDST(*args, **kwargs)
3619
3620 GetBeginDST = staticmethod(GetBeginDST)
3621 def GetEndDST(*args, **kwargs):
c24da6d6 3622 """GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
d55e5bfc
RD
3623 return _misc_.DateTime_GetEndDST(*args, **kwargs)
3624
3625 GetEndDST = staticmethod(GetEndDST)
3626 def Now(*args, **kwargs):
c24da6d6 3627 """Now() -> DateTime"""
d55e5bfc
RD
3628 return _misc_.DateTime_Now(*args, **kwargs)
3629
3630 Now = staticmethod(Now)
3631 def UNow(*args, **kwargs):
c24da6d6 3632 """UNow() -> DateTime"""
d55e5bfc
RD
3633 return _misc_.DateTime_UNow(*args, **kwargs)
3634
3635 UNow = staticmethod(UNow)
3636 def Today(*args, **kwargs):
c24da6d6 3637 """Today() -> DateTime"""
d55e5bfc
RD
3638 return _misc_.DateTime_Today(*args, **kwargs)
3639
3640 Today = staticmethod(Today)
554f62e9 3641 def __init__(self, *args, **kwargs):
d55e5bfc 3642 """__init__(self) -> DateTime"""
554f62e9
RD
3643 _misc_.DateTime_swiginit(self,_misc_.new_DateTime(*args, **kwargs))
3644 __swig_destroy__ = _misc_.delete_DateTime
3645 __del__ = lambda self : None;
d55e5bfc
RD
3646 def SetToCurrent(*args, **kwargs):
3647 """SetToCurrent(self) -> DateTime"""
3648 return _misc_.DateTime_SetToCurrent(*args, **kwargs)
3649
3650 def SetTimeT(*args, **kwargs):
3651 """SetTimeT(self, time_t timet) -> DateTime"""
3652 return _misc_.DateTime_SetTimeT(*args, **kwargs)
3653
3654 def SetJDN(*args, **kwargs):
3655 """SetJDN(self, double jdn) -> DateTime"""
3656 return _misc_.DateTime_SetJDN(*args, **kwargs)
3657
3658 def SetHMS(*args, **kwargs):
3659 """SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime"""
3660 return _misc_.DateTime_SetHMS(*args, **kwargs)
3661
3662 def Set(*args, **kwargs):
3663 """
3664 Set(self, int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
3665 int minute=0, int second=0, int millisec=0) -> DateTime
3666 """
3667 return _misc_.DateTime_Set(*args, **kwargs)
3668
3669 def ResetTime(*args, **kwargs):
3670 """ResetTime(self) -> DateTime"""
3671 return _misc_.DateTime_ResetTime(*args, **kwargs)
3672
6a6c9417
RD
3673 def GetDateOnly(*args, **kwargs):
3674 """GetDateOnly(self) -> DateTime"""
3675 return _misc_.DateTime_GetDateOnly(*args, **kwargs)
3676
d55e5bfc
RD
3677 def SetYear(*args, **kwargs):
3678 """SetYear(self, int year) -> DateTime"""
3679 return _misc_.DateTime_SetYear(*args, **kwargs)
3680
3681 def SetMonth(*args, **kwargs):
3682 """SetMonth(self, int month) -> DateTime"""
3683 return _misc_.DateTime_SetMonth(*args, **kwargs)
3684
3685 def SetDay(*args, **kwargs):
3686 """SetDay(self, int day) -> DateTime"""
3687 return _misc_.DateTime_SetDay(*args, **kwargs)
3688
3689 def SetHour(*args, **kwargs):
3690 """SetHour(self, int hour) -> DateTime"""
3691 return _misc_.DateTime_SetHour(*args, **kwargs)
3692
3693 def SetMinute(*args, **kwargs):
3694 """SetMinute(self, int minute) -> DateTime"""
3695 return _misc_.DateTime_SetMinute(*args, **kwargs)
3696
3697 def SetSecond(*args, **kwargs):
3698 """SetSecond(self, int second) -> DateTime"""
3699 return _misc_.DateTime_SetSecond(*args, **kwargs)
3700
3701 def SetMillisecond(*args, **kwargs):
3702 """SetMillisecond(self, int millisecond) -> DateTime"""
3703 return _misc_.DateTime_SetMillisecond(*args, **kwargs)
3704
3705 def SetToWeekDayInSameWeek(*args, **kwargs):
3706 """SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime"""
3707 return _misc_.DateTime_SetToWeekDayInSameWeek(*args, **kwargs)
3708
3709 def GetWeekDayInSameWeek(*args, **kwargs):
3710 """GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime"""
3711 return _misc_.DateTime_GetWeekDayInSameWeek(*args, **kwargs)
3712
3713 def SetToNextWeekDay(*args, **kwargs):
3714 """SetToNextWeekDay(self, int weekday) -> DateTime"""
3715 return _misc_.DateTime_SetToNextWeekDay(*args, **kwargs)
3716
3717 def GetNextWeekDay(*args, **kwargs):
3718 """GetNextWeekDay(self, int weekday) -> DateTime"""
3719 return _misc_.DateTime_GetNextWeekDay(*args, **kwargs)
3720
3721 def SetToPrevWeekDay(*args, **kwargs):
3722 """SetToPrevWeekDay(self, int weekday) -> DateTime"""
3723 return _misc_.DateTime_SetToPrevWeekDay(*args, **kwargs)
3724
3725 def GetPrevWeekDay(*args, **kwargs):
3726 """GetPrevWeekDay(self, int weekday) -> DateTime"""
3727 return _misc_.DateTime_GetPrevWeekDay(*args, **kwargs)
3728
3729 def SetToWeekDay(*args, **kwargs):
3730 """SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool"""
3731 return _misc_.DateTime_SetToWeekDay(*args, **kwargs)
3732
3733 def SetToLastWeekDay(*args, **kwargs):
3734 """SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool"""
3735 return _misc_.DateTime_SetToLastWeekDay(*args, **kwargs)
3736
3737 def GetLastWeekDay(*args, **kwargs):
3738 """GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3739 return _misc_.DateTime_GetLastWeekDay(*args, **kwargs)
3740
629e65c2
RD
3741 def SetToWeekOfYear(*args, **kwargs):
3742 """SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime"""
3743 return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs)
3744
3745 SetToWeekOfYear = staticmethod(SetToWeekOfYear)
d55e5bfc
RD
3746 def SetToLastMonthDay(*args, **kwargs):
3747 """SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3748 return _misc_.DateTime_SetToLastMonthDay(*args, **kwargs)
3749
3750 def GetLastMonthDay(*args, **kwargs):
3751 """GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime"""
3752 return _misc_.DateTime_GetLastMonthDay(*args, **kwargs)
3753
3754 def SetToYearDay(*args, **kwargs):
3755 """SetToYearDay(self, int yday) -> DateTime"""
3756 return _misc_.DateTime_SetToYearDay(*args, **kwargs)
3757
3758 def GetYearDay(*args, **kwargs):
3759 """GetYearDay(self, int yday) -> DateTime"""
3760 return _misc_.DateTime_GetYearDay(*args, **kwargs)
3761
3762 def GetJulianDayNumber(*args, **kwargs):
3763 """GetJulianDayNumber(self) -> double"""
3764 return _misc_.DateTime_GetJulianDayNumber(*args, **kwargs)
3765
3766 def GetJDN(*args, **kwargs):
3767 """GetJDN(self) -> double"""
3768 return _misc_.DateTime_GetJDN(*args, **kwargs)
3769
3770 def GetModifiedJulianDayNumber(*args, **kwargs):
3771 """GetModifiedJulianDayNumber(self) -> double"""
3772 return _misc_.DateTime_GetModifiedJulianDayNumber(*args, **kwargs)
3773
3774 def GetMJD(*args, **kwargs):
3775 """GetMJD(self) -> double"""
3776 return _misc_.DateTime_GetMJD(*args, **kwargs)
3777
3778 def GetRataDie(*args, **kwargs):
3779 """GetRataDie(self) -> double"""
3780 return _misc_.DateTime_GetRataDie(*args, **kwargs)
3781
3782 def ToTimezone(*args, **kwargs):
3783 """ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3784 return _misc_.DateTime_ToTimezone(*args, **kwargs)
3785
3786 def MakeTimezone(*args, **kwargs):
3787 """MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3788 return _misc_.DateTime_MakeTimezone(*args, **kwargs)
3789
9d7dfdff
RD
3790 def FromTimezone(*args, **kwargs):
3791 """FromTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3792 return _misc_.DateTime_FromTimezone(*args, **kwargs)
3793
3794 def MakeFromTimezone(*args, **kwargs):
3795 """MakeFromTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime"""
3796 return _misc_.DateTime_MakeFromTimezone(*args, **kwargs)
3797
3798 def ToUTC(*args, **kwargs):
3799 """ToUTC(self, bool noDST=False) -> DateTime"""
3800 return _misc_.DateTime_ToUTC(*args, **kwargs)
3801
3802 def MakeUTC(*args, **kwargs):
3803 """MakeUTC(self, bool noDST=False) -> DateTime"""
3804 return _misc_.DateTime_MakeUTC(*args, **kwargs)
3805
d55e5bfc
RD
3806 def ToGMT(*args, **kwargs):
3807 """ToGMT(self, bool noDST=False) -> DateTime"""
3808 return _misc_.DateTime_ToGMT(*args, **kwargs)
3809
3810 def MakeGMT(*args, **kwargs):
3811 """MakeGMT(self, bool noDST=False) -> DateTime"""
3812 return _misc_.DateTime_MakeGMT(*args, **kwargs)
3813
9d7dfdff
RD
3814 def FromUTC(*args, **kwargs):
3815 """FromUTC(self, bool noDST=False) -> DateTime"""
3816 return _misc_.DateTime_FromUTC(*args, **kwargs)
3817
3818 def MakeFromUTC(*args, **kwargs):
3819 """MakeFromUTC(self, bool noDST=False) -> DateTime"""
3820 return _misc_.DateTime_MakeFromUTC(*args, **kwargs)
3821
d55e5bfc
RD
3822 def IsDST(*args, **kwargs):
3823 """IsDST(self, int country=Country_Default) -> int"""
3824 return _misc_.DateTime_IsDST(*args, **kwargs)
3825
3826 def IsValid(*args, **kwargs):
3827 """IsValid(self) -> bool"""
3828 return _misc_.DateTime_IsValid(*args, **kwargs)
3829
b39fe951
RD
3830 IsOk = IsValid
3831 Ok = IsOk
3832 def __nonzero__(self): return self.IsOk()
d55e5bfc
RD
3833 def GetTicks(*args, **kwargs):
3834 """GetTicks(self) -> time_t"""
3835 return _misc_.DateTime_GetTicks(*args, **kwargs)
3836
3837 def GetYear(*args, **kwargs):
3838 """GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3839 return _misc_.DateTime_GetYear(*args, **kwargs)
3840
3841 def GetMonth(*args, **kwargs):
3842 """GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3843 return _misc_.DateTime_GetMonth(*args, **kwargs)
3844
3845 def GetDay(*args, **kwargs):
3846 """GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3847 return _misc_.DateTime_GetDay(*args, **kwargs)
3848
3849 def GetWeekDay(*args, **kwargs):
3850 """GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3851 return _misc_.DateTime_GetWeekDay(*args, **kwargs)
3852
3853 def GetHour(*args, **kwargs):
3854 """GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3855 return _misc_.DateTime_GetHour(*args, **kwargs)
3856
3857 def GetMinute(*args, **kwargs):
3858 """GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3859 return _misc_.DateTime_GetMinute(*args, **kwargs)
3860
3861 def GetSecond(*args, **kwargs):
3862 """GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3863 return _misc_.DateTime_GetSecond(*args, **kwargs)
3864
3865 def GetMillisecond(*args, **kwargs):
3866 """GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3867 return _misc_.DateTime_GetMillisecond(*args, **kwargs)
3868
3869 def GetDayOfYear(*args, **kwargs):
3870 """GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3871 return _misc_.DateTime_GetDayOfYear(*args, **kwargs)
3872
3873 def GetWeekOfYear(*args, **kwargs):
3874 """GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3875 return _misc_.DateTime_GetWeekOfYear(*args, **kwargs)
3876
3877 def GetWeekOfMonth(*args, **kwargs):
3878 """GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int"""
3879 return _misc_.DateTime_GetWeekOfMonth(*args, **kwargs)
3880
3881 def IsWorkDay(*args, **kwargs):
3882 """IsWorkDay(self, int country=Country_Default) -> bool"""
3883 return _misc_.DateTime_IsWorkDay(*args, **kwargs)
3884
3885 def IsEqualTo(*args, **kwargs):
3886 """IsEqualTo(self, DateTime datetime) -> bool"""
3887 return _misc_.DateTime_IsEqualTo(*args, **kwargs)
3888
3889 def IsEarlierThan(*args, **kwargs):
3890 """IsEarlierThan(self, DateTime datetime) -> bool"""
3891 return _misc_.DateTime_IsEarlierThan(*args, **kwargs)
3892
3893 def IsLaterThan(*args, **kwargs):
3894 """IsLaterThan(self, DateTime datetime) -> bool"""
3895 return _misc_.DateTime_IsLaterThan(*args, **kwargs)
3896
3897 def IsStrictlyBetween(*args, **kwargs):
3898 """IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool"""
3899 return _misc_.DateTime_IsStrictlyBetween(*args, **kwargs)
3900
3901 def IsBetween(*args, **kwargs):
3902 """IsBetween(self, DateTime t1, DateTime t2) -> bool"""
3903 return _misc_.DateTime_IsBetween(*args, **kwargs)
3904
3905 def IsSameDate(*args, **kwargs):
3906 """IsSameDate(self, DateTime dt) -> bool"""
3907 return _misc_.DateTime_IsSameDate(*args, **kwargs)
3908
3909 def IsSameTime(*args, **kwargs):
3910 """IsSameTime(self, DateTime dt) -> bool"""
3911 return _misc_.DateTime_IsSameTime(*args, **kwargs)
3912
3913 def IsEqualUpTo(*args, **kwargs):
3914 """IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool"""
3915 return _misc_.DateTime_IsEqualUpTo(*args, **kwargs)
3916
3917 def AddTS(*args, **kwargs):
3918 """AddTS(self, TimeSpan diff) -> DateTime"""
3919 return _misc_.DateTime_AddTS(*args, **kwargs)
3920
3921 def AddDS(*args, **kwargs):
3922 """AddDS(self, DateSpan diff) -> DateTime"""
3923 return _misc_.DateTime_AddDS(*args, **kwargs)
3924
3925 def SubtractTS(*args, **kwargs):
3926 """SubtractTS(self, TimeSpan diff) -> DateTime"""
3927 return _misc_.DateTime_SubtractTS(*args, **kwargs)
3928
3929 def SubtractDS(*args, **kwargs):
3930 """SubtractDS(self, DateSpan diff) -> DateTime"""
3931 return _misc_.DateTime_SubtractDS(*args, **kwargs)
3932
3933 def Subtract(*args, **kwargs):
3934 """Subtract(self, DateTime dt) -> TimeSpan"""
3935 return _misc_.DateTime_Subtract(*args, **kwargs)
3936
3937 def __iadd__(*args):
3938 """
3939 __iadd__(self, TimeSpan diff) -> DateTime
3940 __iadd__(self, DateSpan diff) -> DateTime
3941 """
3942 return _misc_.DateTime___iadd__(*args)
3943
3944 def __isub__(*args):
3945 """
3946 __isub__(self, TimeSpan diff) -> DateTime
3947 __isub__(self, DateSpan diff) -> DateTime
3948 """
3949 return _misc_.DateTime___isub__(*args)
3950
3951 def __add__(*args):
3952 """
3953 __add__(self, TimeSpan other) -> DateTime
3954 __add__(self, DateSpan other) -> DateTime
3955 """
3956 return _misc_.DateTime___add__(*args)
3957
3958 def __sub__(*args):
3959 """
3960 __sub__(self, DateTime other) -> TimeSpan
3961 __sub__(self, TimeSpan other) -> DateTime
3962 __sub__(self, DateSpan other) -> DateTime
3963 """
3964 return _misc_.DateTime___sub__(*args)
3965
fef4c27a 3966 def __lt__(*args, **kwargs):
d55e5bfc 3967 """__lt__(self, DateTime other) -> bool"""
fef4c27a 3968 return _misc_.DateTime___lt__(*args, **kwargs)
d55e5bfc 3969
fef4c27a 3970 def __le__(*args, **kwargs):
d55e5bfc 3971 """__le__(self, DateTime other) -> bool"""
fef4c27a 3972 return _misc_.DateTime___le__(*args, **kwargs)
d55e5bfc 3973
fef4c27a 3974 def __gt__(*args, **kwargs):
d55e5bfc 3975 """__gt__(self, DateTime other) -> bool"""
fef4c27a 3976 return _misc_.DateTime___gt__(*args, **kwargs)
d55e5bfc 3977
fef4c27a 3978 def __ge__(*args, **kwargs):
d55e5bfc 3979 """__ge__(self, DateTime other) -> bool"""
fef4c27a 3980 return _misc_.DateTime___ge__(*args, **kwargs)
d55e5bfc 3981
fef4c27a 3982 def __eq__(*args, **kwargs):
d55e5bfc 3983 """__eq__(self, DateTime other) -> bool"""
fef4c27a 3984 return _misc_.DateTime___eq__(*args, **kwargs)
d55e5bfc 3985
fef4c27a 3986 def __ne__(*args, **kwargs):
d55e5bfc 3987 """__ne__(self, DateTime other) -> bool"""
fef4c27a 3988 return _misc_.DateTime___ne__(*args, **kwargs)
d55e5bfc
RD
3989
3990 def ParseRfc822Date(*args, **kwargs):
3991 """ParseRfc822Date(self, String date) -> int"""
3992 return _misc_.DateTime_ParseRfc822Date(*args, **kwargs)
3993
3994 def ParseFormat(*args, **kwargs):
fef4c27a 3995 """ParseFormat(self, String date, String format=DefaultDateTimeFormat, DateTime dateDef=DefaultDateTime) -> int"""
d55e5bfc
RD
3996 return _misc_.DateTime_ParseFormat(*args, **kwargs)
3997
3998 def ParseDateTime(*args, **kwargs):
3999 """ParseDateTime(self, String datetime) -> int"""
4000 return _misc_.DateTime_ParseDateTime(*args, **kwargs)
4001
4002 def ParseDate(*args, **kwargs):
4003 """ParseDate(self, String date) -> int"""
4004 return _misc_.DateTime_ParseDate(*args, **kwargs)
4005
4006 def ParseTime(*args, **kwargs):
4007 """ParseTime(self, String time) -> int"""
4008 return _misc_.DateTime_ParseTime(*args, **kwargs)
4009
4010 def Format(*args, **kwargs):
fef4c27a 4011 """Format(self, String format=DefaultDateTimeFormat, wxDateTime::TimeZone tz=LOCAL_TZ) -> String"""
d55e5bfc
RD
4012 return _misc_.DateTime_Format(*args, **kwargs)
4013
4014 def FormatDate(*args, **kwargs):
4015 """FormatDate(self) -> String"""
4016 return _misc_.DateTime_FormatDate(*args, **kwargs)
4017
4018 def FormatTime(*args, **kwargs):
4019 """FormatTime(self) -> String"""
4020 return _misc_.DateTime_FormatTime(*args, **kwargs)
4021
4022 def FormatISODate(*args, **kwargs):
4023 """FormatISODate(self) -> String"""
4024 return _misc_.DateTime_FormatISODate(*args, **kwargs)
4025
4026 def FormatISOTime(*args, **kwargs):
4027 """FormatISOTime(self) -> String"""
4028 return _misc_.DateTime_FormatISOTime(*args, **kwargs)
4029
4030 def __repr__(self):
4031 if self.IsValid():
70b7a5fe
RD
4032 f = self.Format().encode(wx.GetDefaultPyEncoding())
4033 return '<wx.DateTime: \"%s\" at %s>' % ( f, self.this)
d55e5bfc
RD
4034 else:
4035 return '<wx.DateTime: \"INVALID\" at %s>' % self.this
4036 def __str__(self):
4037 if self.IsValid():
70b7a5fe 4038 return self.Format().encode(wx.GetDefaultPyEncoding())
d55e5bfc
RD
4039 else:
4040 return "INVALID DateTime"
4041
226118fc
RD
4042 Day = property(GetDay,SetDay,doc="See `GetDay` and `SetDay`")
4043 DayOfYear = property(GetDayOfYear,doc="See `GetDayOfYear`")
4044 Hour = property(GetHour,SetHour,doc="See `GetHour` and `SetHour`")
4045 JDN = property(GetJDN,SetJDN,doc="See `GetJDN` and `SetJDN`")
4046 JulianDayNumber = property(GetJulianDayNumber,doc="See `GetJulianDayNumber`")
4047 LastMonthDay = property(GetLastMonthDay,doc="See `GetLastMonthDay`")
4048 LastWeekDay = property(GetLastWeekDay,doc="See `GetLastWeekDay`")
4049 MJD = property(GetMJD,doc="See `GetMJD`")
4050 Millisecond = property(GetMillisecond,SetMillisecond,doc="See `GetMillisecond` and `SetMillisecond`")
4051 Minute = property(GetMinute,SetMinute,doc="See `GetMinute` and `SetMinute`")
4052 ModifiedJulianDayNumber = property(GetModifiedJulianDayNumber,doc="See `GetModifiedJulianDayNumber`")
4053 Month = property(GetMonth,SetMonth,doc="See `GetMonth` and `SetMonth`")
4054 NextWeekDay = property(GetNextWeekDay,doc="See `GetNextWeekDay`")
4055 PrevWeekDay = property(GetPrevWeekDay,doc="See `GetPrevWeekDay`")
4056 RataDie = property(GetRataDie,doc="See `GetRataDie`")
4057 Second = property(GetSecond,SetSecond,doc="See `GetSecond` and `SetSecond`")
4058 Ticks = property(GetTicks,doc="See `GetTicks`")
226118fc
RD
4059 WeekDay = property(GetWeekDay,doc="See `GetWeekDay`")
4060 WeekDayInSameWeek = property(GetWeekDayInSameWeek,doc="See `GetWeekDayInSameWeek`")
4061 WeekOfMonth = property(GetWeekOfMonth,doc="See `GetWeekOfMonth`")
4062 WeekOfYear = property(GetWeekOfYear,doc="See `GetWeekOfYear`")
4063 Year = property(GetYear,SetYear,doc="See `GetYear` and `SetYear`")
4064 YearDay = property(GetYearDay,doc="See `GetYearDay`")
2131d850 4065_misc_.DateTime_swigregister(DateTime)
fef4c27a
RD
4066DefaultDateTimeFormat = cvar.DefaultDateTimeFormat
4067DefaultTimeSpanFormat = cvar.DefaultTimeSpanFormat
d55e5bfc
RD
4068
4069def DateTime_SetCountry(*args, **kwargs):
554f62e9
RD
4070 """DateTime_SetCountry(int country)"""
4071 return _misc_.DateTime_SetCountry(*args, **kwargs)
d55e5bfc 4072
554f62e9
RD
4073def DateTime_GetCountry(*args):
4074 """DateTime_GetCountry() -> int"""
4075 return _misc_.DateTime_GetCountry(*args)
d55e5bfc
RD
4076
4077def DateTime_IsWestEuropeanCountry(*args, **kwargs):
554f62e9
RD
4078 """DateTime_IsWestEuropeanCountry(int country=Country_Default) -> bool"""
4079 return _misc_.DateTime_IsWestEuropeanCountry(*args, **kwargs)
d55e5bfc
RD
4080
4081def DateTime_GetCurrentYear(*args, **kwargs):
554f62e9
RD
4082 """DateTime_GetCurrentYear(int cal=Gregorian) -> int"""
4083 return _misc_.DateTime_GetCurrentYear(*args, **kwargs)
d55e5bfc
RD
4084
4085def DateTime_ConvertYearToBC(*args, **kwargs):
554f62e9
RD
4086 """DateTime_ConvertYearToBC(int year) -> int"""
4087 return _misc_.DateTime_ConvertYearToBC(*args, **kwargs)
d55e5bfc
RD
4088
4089def DateTime_GetCurrentMonth(*args, **kwargs):
554f62e9
RD
4090 """DateTime_GetCurrentMonth(int cal=Gregorian) -> int"""
4091 return _misc_.DateTime_GetCurrentMonth(*args, **kwargs)
d55e5bfc
RD
4092
4093def DateTime_IsLeapYear(*args, **kwargs):
554f62e9
RD
4094 """DateTime_IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool"""
4095 return _misc_.DateTime_IsLeapYear(*args, **kwargs)
d55e5bfc
RD
4096
4097def DateTime_GetCentury(*args, **kwargs):
554f62e9
RD
4098 """DateTime_GetCentury(int year=Inv_Year) -> int"""
4099 return _misc_.DateTime_GetCentury(*args, **kwargs)
d55e5bfc
RD
4100
4101def DateTime_GetNumberOfDaysinYear(*args, **kwargs):
554f62e9
RD
4102 """DateTime_GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int"""
4103 return _misc_.DateTime_GetNumberOfDaysinYear(*args, **kwargs)
d55e5bfc
RD
4104
4105def DateTime_GetNumberOfDaysInMonth(*args, **kwargs):
554f62e9
RD
4106 """DateTime_GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int"""
4107 return _misc_.DateTime_GetNumberOfDaysInMonth(*args, **kwargs)
d55e5bfc
RD
4108
4109def DateTime_GetMonthName(*args, **kwargs):
554f62e9
RD
4110 """DateTime_GetMonthName(int month, int flags=Name_Full) -> String"""
4111 return _misc_.DateTime_GetMonthName(*args, **kwargs)
d55e5bfc
RD
4112
4113def DateTime_GetWeekDayName(*args, **kwargs):
554f62e9
RD
4114 """DateTime_GetWeekDayName(int weekday, int flags=Name_Full) -> String"""
4115 return _misc_.DateTime_GetWeekDayName(*args, **kwargs)
d55e5bfc 4116
554f62e9
RD
4117def DateTime_GetAmPmStrings(*args):
4118 """
a001823c
RD
4119 GetAmPmStrings() -> (am, pm)
4120
4121 Get the AM and PM strings in the current locale (may be empty)
4122 """
554f62e9 4123 return _misc_.DateTime_GetAmPmStrings(*args)
d55e5bfc
RD
4124
4125def DateTime_IsDSTApplicable(*args, **kwargs):
554f62e9
RD
4126 """DateTime_IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool"""
4127 return _misc_.DateTime_IsDSTApplicable(*args, **kwargs)
d55e5bfc
RD
4128
4129def DateTime_GetBeginDST(*args, **kwargs):
554f62e9
RD
4130 """DateTime_GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
4131 return _misc_.DateTime_GetBeginDST(*args, **kwargs)
d55e5bfc
RD
4132
4133def DateTime_GetEndDST(*args, **kwargs):
554f62e9
RD
4134 """DateTime_GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime"""
4135 return _misc_.DateTime_GetEndDST(*args, **kwargs)
d55e5bfc 4136
554f62e9
RD
4137def DateTime_Now(*args):
4138 """DateTime_Now() -> DateTime"""
4139 return _misc_.DateTime_Now(*args)
d55e5bfc 4140
554f62e9
RD
4141def DateTime_UNow(*args):
4142 """DateTime_UNow() -> DateTime"""
4143 return _misc_.DateTime_UNow(*args)
d55e5bfc 4144
554f62e9
RD
4145def DateTime_Today(*args):
4146 """DateTime_Today() -> DateTime"""
4147 return _misc_.DateTime_Today(*args)
d55e5bfc
RD
4148
4149def DateTimeFromTimeT(*args, **kwargs):
4150 """DateTimeFromTimeT(time_t timet) -> DateTime"""
4151 val = _misc_.new_DateTimeFromTimeT(*args, **kwargs)
d55e5bfc
RD
4152 return val
4153
4154def DateTimeFromJDN(*args, **kwargs):
4155 """DateTimeFromJDN(double jdn) -> DateTime"""
4156 val = _misc_.new_DateTimeFromJDN(*args, **kwargs)
d55e5bfc
RD
4157 return val
4158
4159def DateTimeFromHMS(*args, **kwargs):
4160 """DateTimeFromHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime"""
4161 val = _misc_.new_DateTimeFromHMS(*args, **kwargs)
d55e5bfc
RD
4162 return val
4163
4164def DateTimeFromDMY(*args, **kwargs):
4165 """
4166 DateTimeFromDMY(int day, int month=Inv_Month, int year=Inv_Year, int hour=0,
4167 int minute=0, int second=0, int millisec=0) -> DateTime
4168 """
4169 val = _misc_.new_DateTimeFromDMY(*args, **kwargs)
554f62e9
RD
4170 return val
4171
4172def DateTimeFromDateTime(*args, **kwargs):
4173 """DateTimeFromDateTime(DateTime date) -> DateTime"""
4174 val = _misc_.new_DateTimeFromDateTime(*args, **kwargs)
d55e5bfc
RD
4175 return val
4176
629e65c2 4177def DateTime_SetToWeekOfYear(*args, **kwargs):
554f62e9
RD
4178 """DateTime_SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime"""
4179 return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs)
629e65c2 4180
d55e5bfc 4181class TimeSpan(object):
093d3ff1 4182 """Proxy of C++ TimeSpan class"""
554f62e9
RD
4183 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4184 __repr__ = _swig_repr
e9d6f3a4
RD
4185 def Milliseconds(*args, **kwargs):
4186 """Milliseconds(long ms) -> TimeSpan"""
4187 return _misc_.TimeSpan_Milliseconds(*args, **kwargs)
4188
4189 Milliseconds = staticmethod(Milliseconds)
4190 def Millisecond(*args, **kwargs):
4191 """Millisecond() -> TimeSpan"""
4192 return _misc_.TimeSpan_Millisecond(*args, **kwargs)
4193
4194 Millisecond = staticmethod(Millisecond)
d55e5bfc 4195 def Seconds(*args, **kwargs):
c24da6d6 4196 """Seconds(long sec) -> TimeSpan"""
d55e5bfc
RD
4197 return _misc_.TimeSpan_Seconds(*args, **kwargs)
4198
4199 Seconds = staticmethod(Seconds)
4200 def Second(*args, **kwargs):
c24da6d6 4201 """Second() -> TimeSpan"""
d55e5bfc
RD
4202 return _misc_.TimeSpan_Second(*args, **kwargs)
4203
4204 Second = staticmethod(Second)
4205 def Minutes(*args, **kwargs):
c24da6d6 4206 """Minutes(long min) -> TimeSpan"""
d55e5bfc
RD
4207 return _misc_.TimeSpan_Minutes(*args, **kwargs)
4208
4209 Minutes = staticmethod(Minutes)
4210 def Minute(*args, **kwargs):
c24da6d6 4211 """Minute() -> TimeSpan"""
d55e5bfc
RD
4212 return _misc_.TimeSpan_Minute(*args, **kwargs)
4213
4214 Minute = staticmethod(Minute)
4215 def Hours(*args, **kwargs):
c24da6d6 4216 """Hours(long hours) -> TimeSpan"""
d55e5bfc
RD
4217 return _misc_.TimeSpan_Hours(*args, **kwargs)
4218
4219 Hours = staticmethod(Hours)
4220 def Hour(*args, **kwargs):
c24da6d6 4221 """Hour() -> TimeSpan"""
d55e5bfc
RD
4222 return _misc_.TimeSpan_Hour(*args, **kwargs)
4223
4224 Hour = staticmethod(Hour)
4225 def Days(*args, **kwargs):
c24da6d6 4226 """Days(long days) -> TimeSpan"""
d55e5bfc
RD
4227 return _misc_.TimeSpan_Days(*args, **kwargs)
4228
4229 Days = staticmethod(Days)
4230 def Day(*args, **kwargs):
c24da6d6 4231 """Day() -> TimeSpan"""
d55e5bfc
RD
4232 return _misc_.TimeSpan_Day(*args, **kwargs)
4233
4234 Day = staticmethod(Day)
4235 def Weeks(*args, **kwargs):
c24da6d6 4236 """Weeks(long days) -> TimeSpan"""
d55e5bfc
RD
4237 return _misc_.TimeSpan_Weeks(*args, **kwargs)
4238
4239 Weeks = staticmethod(Weeks)
4240 def Week(*args, **kwargs):
c24da6d6 4241 """Week() -> TimeSpan"""
d55e5bfc
RD
4242 return _misc_.TimeSpan_Week(*args, **kwargs)
4243
4244 Week = staticmethod(Week)
554f62e9 4245 def __init__(self, *args, **kwargs):
d55e5bfc 4246 """__init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan"""
554f62e9
RD
4247 _misc_.TimeSpan_swiginit(self,_misc_.new_TimeSpan(*args, **kwargs))
4248 __swig_destroy__ = _misc_.delete_TimeSpan
4249 __del__ = lambda self : None;
d55e5bfc
RD
4250 def Add(*args, **kwargs):
4251 """Add(self, TimeSpan diff) -> TimeSpan"""
4252 return _misc_.TimeSpan_Add(*args, **kwargs)
4253
4254 def Subtract(*args, **kwargs):
4255 """Subtract(self, TimeSpan diff) -> TimeSpan"""
4256 return _misc_.TimeSpan_Subtract(*args, **kwargs)
4257
4258 def Multiply(*args, **kwargs):
4259 """Multiply(self, int n) -> TimeSpan"""
4260 return _misc_.TimeSpan_Multiply(*args, **kwargs)
4261
4262 def Neg(*args, **kwargs):
4263 """Neg(self) -> TimeSpan"""
4264 return _misc_.TimeSpan_Neg(*args, **kwargs)
4265
4266 def Abs(*args, **kwargs):
4267 """Abs(self) -> TimeSpan"""
4268 return _misc_.TimeSpan_Abs(*args, **kwargs)
4269
4270 def __iadd__(*args, **kwargs):
4271 """__iadd__(self, TimeSpan diff) -> TimeSpan"""
4272 return _misc_.TimeSpan___iadd__(*args, **kwargs)
4273
4274 def __isub__(*args, **kwargs):
4275 """__isub__(self, TimeSpan diff) -> TimeSpan"""
4276 return _misc_.TimeSpan___isub__(*args, **kwargs)
4277
4278 def __imul__(*args, **kwargs):
4279 """__imul__(self, int n) -> TimeSpan"""
4280 return _misc_.TimeSpan___imul__(*args, **kwargs)
4281
4282 def __neg__(*args, **kwargs):
4283 """__neg__(self) -> TimeSpan"""
4284 return _misc_.TimeSpan___neg__(*args, **kwargs)
4285
4286 def __add__(*args, **kwargs):
4287 """__add__(self, TimeSpan other) -> TimeSpan"""
4288 return _misc_.TimeSpan___add__(*args, **kwargs)
4289
4290 def __sub__(*args, **kwargs):
4291 """__sub__(self, TimeSpan other) -> TimeSpan"""
4292 return _misc_.TimeSpan___sub__(*args, **kwargs)
4293
4294 def __mul__(*args, **kwargs):
4295 """__mul__(self, int n) -> TimeSpan"""
4296 return _misc_.TimeSpan___mul__(*args, **kwargs)
4297
4298 def __rmul__(*args, **kwargs):
4299 """__rmul__(self, int n) -> TimeSpan"""
4300 return _misc_.TimeSpan___rmul__(*args, **kwargs)
4301
4302 def __lt__(*args, **kwargs):
4303 """__lt__(self, TimeSpan other) -> bool"""
4304 return _misc_.TimeSpan___lt__(*args, **kwargs)
4305
4306 def __le__(*args, **kwargs):
4307 """__le__(self, TimeSpan other) -> bool"""
4308 return _misc_.TimeSpan___le__(*args, **kwargs)
4309
4310 def __gt__(*args, **kwargs):
4311 """__gt__(self, TimeSpan other) -> bool"""
4312 return _misc_.TimeSpan___gt__(*args, **kwargs)
4313
4314 def __ge__(*args, **kwargs):
4315 """__ge__(self, TimeSpan other) -> bool"""
4316 return _misc_.TimeSpan___ge__(*args, **kwargs)
4317
4318 def __eq__(*args, **kwargs):
4319 """__eq__(self, TimeSpan other) -> bool"""
4320 return _misc_.TimeSpan___eq__(*args, **kwargs)
4321
4322 def __ne__(*args, **kwargs):
4323 """__ne__(self, TimeSpan other) -> bool"""
4324 return _misc_.TimeSpan___ne__(*args, **kwargs)
4325
4326 def IsNull(*args, **kwargs):
4327 """IsNull(self) -> bool"""
4328 return _misc_.TimeSpan_IsNull(*args, **kwargs)
4329
4330 def IsPositive(*args, **kwargs):
4331 """IsPositive(self) -> bool"""
4332 return _misc_.TimeSpan_IsPositive(*args, **kwargs)
4333
4334 def IsNegative(*args, **kwargs):
4335 """IsNegative(self) -> bool"""
4336 return _misc_.TimeSpan_IsNegative(*args, **kwargs)
4337
4338 def IsEqualTo(*args, **kwargs):
4339 """IsEqualTo(self, TimeSpan ts) -> bool"""
4340 return _misc_.TimeSpan_IsEqualTo(*args, **kwargs)
4341
4342 def IsLongerThan(*args, **kwargs):
4343 """IsLongerThan(self, TimeSpan ts) -> bool"""
4344 return _misc_.TimeSpan_IsLongerThan(*args, **kwargs)
4345
4346 def IsShorterThan(*args, **kwargs):
4347 """IsShorterThan(self, TimeSpan t) -> bool"""
4348 return _misc_.TimeSpan_IsShorterThan(*args, **kwargs)
4349
4350 def GetWeeks(*args, **kwargs):
4351 """GetWeeks(self) -> int"""
4352 return _misc_.TimeSpan_GetWeeks(*args, **kwargs)
4353
4354 def GetDays(*args, **kwargs):
4355 """GetDays(self) -> int"""
4356 return _misc_.TimeSpan_GetDays(*args, **kwargs)
4357
4358 def GetHours(*args, **kwargs):
4359 """GetHours(self) -> int"""
4360 return _misc_.TimeSpan_GetHours(*args, **kwargs)
4361
4362 def GetMinutes(*args, **kwargs):
4363 """GetMinutes(self) -> int"""
4364 return _misc_.TimeSpan_GetMinutes(*args, **kwargs)
4365
4366 def GetSeconds(*args, **kwargs):
4367 """GetSeconds(self) -> wxLongLong"""
4368 return _misc_.TimeSpan_GetSeconds(*args, **kwargs)
4369
4370 def GetMilliseconds(*args, **kwargs):
4371 """GetMilliseconds(self) -> wxLongLong"""
4372 return _misc_.TimeSpan_GetMilliseconds(*args, **kwargs)
4373
4374 def Format(*args, **kwargs):
fef4c27a 4375 """Format(self, String format=DefaultTimeSpanFormat) -> String"""
d55e5bfc
RD
4376 return _misc_.TimeSpan_Format(*args, **kwargs)
4377
4378 def __repr__(self):
70b7a5fe
RD
4379 f = self.Format().encode(wx.GetDefaultPyEncoding())
4380 return '<wx.TimeSpan: \"%s\" at %s>' % ( f, self.this)
d55e5bfc 4381 def __str__(self):
70b7a5fe 4382 return self.Format().encode(wx.GetDefaultPyEncoding())
d55e5bfc 4383
994453b8
RD
4384 Days = property(GetDays,doc="See `GetDays`")
4385 Hours = property(GetHours,doc="See `GetHours`")
4386 Milliseconds = property(GetMilliseconds,doc="See `GetMilliseconds`")
4387 Minutes = property(GetMinutes,doc="See `GetMinutes`")
4388 Seconds = property(GetSeconds,doc="See `GetSeconds`")
4389 Weeks = property(GetWeeks,doc="See `GetWeeks`")
2131d850 4390_misc_.TimeSpan_swigregister(TimeSpan)
d55e5bfc 4391
e9d6f3a4
RD
4392def TimeSpan_Milliseconds(*args, **kwargs):
4393 """TimeSpan_Milliseconds(long ms) -> TimeSpan"""
4394 return _misc_.TimeSpan_Milliseconds(*args, **kwargs)
4395
4396def TimeSpan_Millisecond(*args):
4397 """TimeSpan_Millisecond() -> TimeSpan"""
4398 return _misc_.TimeSpan_Millisecond(*args)
4399
d55e5bfc 4400def TimeSpan_Seconds(*args, **kwargs):
554f62e9
RD
4401 """TimeSpan_Seconds(long sec) -> TimeSpan"""
4402 return _misc_.TimeSpan_Seconds(*args, **kwargs)
d55e5bfc 4403
554f62e9
RD
4404def TimeSpan_Second(*args):
4405 """TimeSpan_Second() -> TimeSpan"""
4406 return _misc_.TimeSpan_Second(*args)
d55e5bfc
RD
4407
4408def TimeSpan_Minutes(*args, **kwargs):
554f62e9
RD
4409 """TimeSpan_Minutes(long min) -> TimeSpan"""
4410 return _misc_.TimeSpan_Minutes(*args, **kwargs)
d55e5bfc 4411
554f62e9
RD
4412def TimeSpan_Minute(*args):
4413 """TimeSpan_Minute() -> TimeSpan"""
4414 return _misc_.TimeSpan_Minute(*args)
d55e5bfc
RD
4415
4416def TimeSpan_Hours(*args, **kwargs):
554f62e9
RD
4417 """TimeSpan_Hours(long hours) -> TimeSpan"""
4418 return _misc_.TimeSpan_Hours(*args, **kwargs)
d55e5bfc 4419
554f62e9
RD
4420def TimeSpan_Hour(*args):
4421 """TimeSpan_Hour() -> TimeSpan"""
4422 return _misc_.TimeSpan_Hour(*args)
d55e5bfc
RD
4423
4424def TimeSpan_Days(*args, **kwargs):
554f62e9
RD
4425 """TimeSpan_Days(long days) -> TimeSpan"""
4426 return _misc_.TimeSpan_Days(*args, **kwargs)
d55e5bfc 4427
554f62e9
RD
4428def TimeSpan_Day(*args):
4429 """TimeSpan_Day() -> TimeSpan"""
4430 return _misc_.TimeSpan_Day(*args)
d55e5bfc
RD
4431
4432def TimeSpan_Weeks(*args, **kwargs):
554f62e9
RD
4433 """TimeSpan_Weeks(long days) -> TimeSpan"""
4434 return _misc_.TimeSpan_Weeks(*args, **kwargs)
d55e5bfc 4435
554f62e9
RD
4436def TimeSpan_Week(*args):
4437 """TimeSpan_Week() -> TimeSpan"""
4438 return _misc_.TimeSpan_Week(*args)
d55e5bfc
RD
4439
4440class DateSpan(object):
093d3ff1 4441 """Proxy of C++ DateSpan class"""
554f62e9
RD
4442 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4443 __repr__ = _swig_repr
4444 def __init__(self, *args, **kwargs):
d55e5bfc 4445 """__init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan"""
554f62e9
RD
4446 _misc_.DateSpan_swiginit(self,_misc_.new_DateSpan(*args, **kwargs))
4447 __swig_destroy__ = _misc_.delete_DateSpan
4448 __del__ = lambda self : None;
d55e5bfc 4449 def Days(*args, **kwargs):
c24da6d6 4450 """Days(int days) -> DateSpan"""
d55e5bfc
RD
4451 return _misc_.DateSpan_Days(*args, **kwargs)
4452
4453 Days = staticmethod(Days)
4454 def Day(*args, **kwargs):
c24da6d6 4455 """Day() -> DateSpan"""
d55e5bfc
RD
4456 return _misc_.DateSpan_Day(*args, **kwargs)
4457
4458 Day = staticmethod(Day)
4459 def Weeks(*args, **kwargs):
c24da6d6 4460 """Weeks(int weeks) -> DateSpan"""
d55e5bfc
RD
4461 return _misc_.DateSpan_Weeks(*args, **kwargs)
4462
4463 Weeks = staticmethod(Weeks)
4464 def Week(*args, **kwargs):
c24da6d6 4465 """Week() -> DateSpan"""
d55e5bfc
RD
4466 return _misc_.DateSpan_Week(*args, **kwargs)
4467
4468 Week = staticmethod(Week)
4469 def Months(*args, **kwargs):
c24da6d6 4470 """Months(int mon) -> DateSpan"""
d55e5bfc
RD
4471 return _misc_.DateSpan_Months(*args, **kwargs)
4472
4473 Months = staticmethod(Months)
4474 def Month(*args, **kwargs):
c24da6d6 4475 """Month() -> DateSpan"""
d55e5bfc
RD
4476 return _misc_.DateSpan_Month(*args, **kwargs)
4477
4478 Month = staticmethod(Month)
4479 def Years(*args, **kwargs):
c24da6d6 4480 """Years(int years) -> DateSpan"""
d55e5bfc
RD
4481 return _misc_.DateSpan_Years(*args, **kwargs)
4482
4483 Years = staticmethod(Years)
4484 def Year(*args, **kwargs):
c24da6d6 4485 """Year() -> DateSpan"""
d55e5bfc
RD
4486 return _misc_.DateSpan_Year(*args, **kwargs)
4487
4488 Year = staticmethod(Year)
4489 def SetYears(*args, **kwargs):
4490 """SetYears(self, int n) -> DateSpan"""
4491 return _misc_.DateSpan_SetYears(*args, **kwargs)
4492
4493 def SetMonths(*args, **kwargs):
4494 """SetMonths(self, int n) -> DateSpan"""
4495 return _misc_.DateSpan_SetMonths(*args, **kwargs)
4496
4497 def SetWeeks(*args, **kwargs):
4498 """SetWeeks(self, int n) -> DateSpan"""
4499 return _misc_.DateSpan_SetWeeks(*args, **kwargs)
4500
4501 def SetDays(*args, **kwargs):
4502 """SetDays(self, int n) -> DateSpan"""
4503 return _misc_.DateSpan_SetDays(*args, **kwargs)
4504
4505 def GetYears(*args, **kwargs):
4506 """GetYears(self) -> int"""
4507 return _misc_.DateSpan_GetYears(*args, **kwargs)
4508
4509 def GetMonths(*args, **kwargs):
4510 """GetMonths(self) -> int"""
4511 return _misc_.DateSpan_GetMonths(*args, **kwargs)
4512
4513 def GetWeeks(*args, **kwargs):
4514 """GetWeeks(self) -> int"""
4515 return _misc_.DateSpan_GetWeeks(*args, **kwargs)
4516
4517 def GetDays(*args, **kwargs):
4518 """GetDays(self) -> int"""
4519 return _misc_.DateSpan_GetDays(*args, **kwargs)
4520
4521 def GetTotalDays(*args, **kwargs):
4522 """GetTotalDays(self) -> int"""
4523 return _misc_.DateSpan_GetTotalDays(*args, **kwargs)
4524
4525 def Add(*args, **kwargs):
4526 """Add(self, DateSpan other) -> DateSpan"""
4527 return _misc_.DateSpan_Add(*args, **kwargs)
4528
4529 def Subtract(*args, **kwargs):
4530 """Subtract(self, DateSpan other) -> DateSpan"""
4531 return _misc_.DateSpan_Subtract(*args, **kwargs)
4532
4533 def Neg(*args, **kwargs):
4534 """Neg(self) -> DateSpan"""
4535 return _misc_.DateSpan_Neg(*args, **kwargs)
4536
4537 def Multiply(*args, **kwargs):
4538 """Multiply(self, int factor) -> DateSpan"""
4539 return _misc_.DateSpan_Multiply(*args, **kwargs)
4540
4541 def __iadd__(*args, **kwargs):
4542 """__iadd__(self, DateSpan other) -> DateSpan"""
4543 return _misc_.DateSpan___iadd__(*args, **kwargs)
4544
4545 def __isub__(*args, **kwargs):
4546 """__isub__(self, DateSpan other) -> DateSpan"""
4547 return _misc_.DateSpan___isub__(*args, **kwargs)
4548
4549 def __neg__(*args, **kwargs):
4550 """__neg__(self) -> DateSpan"""
4551 return _misc_.DateSpan___neg__(*args, **kwargs)
4552
4553 def __imul__(*args, **kwargs):
4554 """__imul__(self, int factor) -> DateSpan"""
4555 return _misc_.DateSpan___imul__(*args, **kwargs)
4556
4557 def __add__(*args, **kwargs):
4558 """__add__(self, DateSpan other) -> DateSpan"""
4559 return _misc_.DateSpan___add__(*args, **kwargs)
4560
4561 def __sub__(*args, **kwargs):
4562 """__sub__(self, DateSpan other) -> DateSpan"""
4563 return _misc_.DateSpan___sub__(*args, **kwargs)
4564
4565 def __mul__(*args, **kwargs):
4566 """__mul__(self, int n) -> DateSpan"""
4567 return _misc_.DateSpan___mul__(*args, **kwargs)
4568
4569 def __rmul__(*args, **kwargs):
4570 """__rmul__(self, int n) -> DateSpan"""
4571 return _misc_.DateSpan___rmul__(*args, **kwargs)
4572
4573 def __eq__(*args, **kwargs):
4574 """__eq__(self, DateSpan other) -> bool"""
4575 return _misc_.DateSpan___eq__(*args, **kwargs)
4576
4577 def __ne__(*args, **kwargs):
4578 """__ne__(self, DateSpan other) -> bool"""
4579 return _misc_.DateSpan___ne__(*args, **kwargs)
4580
226118fc
RD
4581 Days = property(GetDays,SetDays,doc="See `GetDays` and `SetDays`")
4582 Months = property(GetMonths,SetMonths,doc="See `GetMonths` and `SetMonths`")
4583 TotalDays = property(GetTotalDays,doc="See `GetTotalDays`")
4584 Weeks = property(GetWeeks,SetWeeks,doc="See `GetWeeks` and `SetWeeks`")
4585 Years = property(GetYears,SetYears,doc="See `GetYears` and `SetYears`")
2131d850 4586_misc_.DateSpan_swigregister(DateSpan)
d55e5bfc
RD
4587
4588def DateSpan_Days(*args, **kwargs):
554f62e9
RD
4589 """DateSpan_Days(int days) -> DateSpan"""
4590 return _misc_.DateSpan_Days(*args, **kwargs)
d55e5bfc 4591
554f62e9
RD
4592def DateSpan_Day(*args):
4593 """DateSpan_Day() -> DateSpan"""
4594 return _misc_.DateSpan_Day(*args)
d55e5bfc
RD
4595
4596def DateSpan_Weeks(*args, **kwargs):
554f62e9
RD
4597 """DateSpan_Weeks(int weeks) -> DateSpan"""
4598 return _misc_.DateSpan_Weeks(*args, **kwargs)
d55e5bfc 4599
554f62e9
RD
4600def DateSpan_Week(*args):
4601 """DateSpan_Week() -> DateSpan"""
4602 return _misc_.DateSpan_Week(*args)
d55e5bfc
RD
4603
4604def DateSpan_Months(*args, **kwargs):
554f62e9
RD
4605 """DateSpan_Months(int mon) -> DateSpan"""
4606 return _misc_.DateSpan_Months(*args, **kwargs)
d55e5bfc 4607
554f62e9
RD
4608def DateSpan_Month(*args):
4609 """DateSpan_Month() -> DateSpan"""
4610 return _misc_.DateSpan_Month(*args)
d55e5bfc
RD
4611
4612def DateSpan_Years(*args, **kwargs):
554f62e9
RD
4613 """DateSpan_Years(int years) -> DateSpan"""
4614 return _misc_.DateSpan_Years(*args, **kwargs)
d55e5bfc 4615
554f62e9
RD
4616def DateSpan_Year(*args):
4617 """DateSpan_Year() -> DateSpan"""
4618 return _misc_.DateSpan_Year(*args)
d55e5bfc
RD
4619
4620
554f62e9
RD
4621def GetLocalTime(*args):
4622 """GetLocalTime() -> long"""
4623 return _misc_.GetLocalTime(*args)
d55e5bfc 4624
554f62e9
RD
4625def GetUTCTime(*args):
4626 """GetUTCTime() -> long"""
4627 return _misc_.GetUTCTime(*args)
d55e5bfc 4628
554f62e9
RD
4629def GetCurrentTime(*args):
4630 """GetCurrentTime() -> long"""
4631 return _misc_.GetCurrentTime(*args)
d55e5bfc 4632
554f62e9
RD
4633def GetLocalTimeMillis(*args):
4634 """GetLocalTimeMillis() -> wxLongLong"""
4635 return _misc_.GetLocalTimeMillis(*args)
d55e5bfc
RD
4636#---------------------------------------------------------------------------
4637
4638DF_INVALID = _misc_.DF_INVALID
4639DF_TEXT = _misc_.DF_TEXT
4640DF_BITMAP = _misc_.DF_BITMAP
4641DF_METAFILE = _misc_.DF_METAFILE
4642DF_SYLK = _misc_.DF_SYLK
4643DF_DIF = _misc_.DF_DIF
4644DF_TIFF = _misc_.DF_TIFF
4645DF_OEMTEXT = _misc_.DF_OEMTEXT
4646DF_DIB = _misc_.DF_DIB
4647DF_PALETTE = _misc_.DF_PALETTE
4648DF_PENDATA = _misc_.DF_PENDATA
4649DF_RIFF = _misc_.DF_RIFF
4650DF_WAVE = _misc_.DF_WAVE
4651DF_UNICODETEXT = _misc_.DF_UNICODETEXT
4652DF_ENHMETAFILE = _misc_.DF_ENHMETAFILE
4653DF_FILENAME = _misc_.DF_FILENAME
4654DF_LOCALE = _misc_.DF_LOCALE
4655DF_PRIVATE = _misc_.DF_PRIVATE
4656DF_HTML = _misc_.DF_HTML
4657DF_MAX = _misc_.DF_MAX
4658class DataFormat(object):
4659 """
4660 A wx.DataFormat is an encapsulation of a platform-specific format
79fccf9d
RD
4661 handle which is used by the system for the clipboard and drag and drop
4662 operations. The applications are usually only interested in, for
4663 example, pasting data from the clipboard only if the data is in a
4664 format the program understands. A data format is is used to uniquely
4665 identify this format.
d55e5bfc 4666 """
554f62e9
RD
4667 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4668 __repr__ = _swig_repr
4669 def __init__(self, *args, **kwargs):
d55e5bfc
RD
4670 """
4671 __init__(self, int type) -> DataFormat
4672
79fccf9d
RD
4673 Constructs a data format object for one of the standard data formats
4674 or an empty data object (use SetType or SetId later in this case)
d55e5bfc 4675 """
554f62e9
RD
4676 _misc_.DataFormat_swiginit(self,_misc_.new_DataFormat(*args, **kwargs))
4677 __swig_destroy__ = _misc_.delete_DataFormat
4678 __del__ = lambda self : None;
d55e5bfc
RD
4679 def __eq__(*args):
4680 """
4681 __eq__(self, int format) -> bool
4682 __eq__(self, DataFormat format) -> bool
4683 """
4684 return _misc_.DataFormat___eq__(*args)
4685
4686 def __ne__(*args):
4687 """
4688 __ne__(self, int format) -> bool
4689 __ne__(self, DataFormat format) -> bool
4690 """
4691 return _misc_.DataFormat___ne__(*args)
4692
4693 def SetType(*args, **kwargs):
4694 """
4695 SetType(self, int format)
4696
79fccf9d
RD
4697 Sets the format to the given value, which should be one of wx.DF_XXX
4698 constants.
d55e5bfc
RD
4699 """
4700 return _misc_.DataFormat_SetType(*args, **kwargs)
4701
4702 def GetType(*args, **kwargs):
4703 """
4704 GetType(self) -> int
4705
4706 Returns the platform-specific number identifying the format.
4707 """
4708 return _misc_.DataFormat_GetType(*args, **kwargs)
4709
0d3847e8
RD
4710 def _GetId(*args, **kwargs):
4711 """_GetId(self) -> String"""
4712 return _misc_.DataFormat__GetId(*args, **kwargs)
d55e5bfc 4713
0d3847e8
RD
4714 def GetId(self):
4715 """Returns the name of a custom format (this function will fail for a
4716 format)."""
4717 nolog = wx.LogNull()
4718 return self._GetId()
d55e5bfc
RD
4719
4720 def SetId(*args, **kwargs):
4721 """
4722 SetId(self, String format)
4723
4724 Sets the format to be the custom format identified by the given name.
4725 """
4726 return _misc_.DataFormat_SetId(*args, **kwargs)
4727
226118fc
RD
4728 Id = property(GetId,SetId,doc="See `GetId` and `SetId`")
4729 Type = property(GetType,SetType,doc="See `GetType` and `SetType`")
2131d850 4730_misc_.DataFormat_swigregister(DataFormat)
d55e5bfc
RD
4731DefaultDateTime = cvar.DefaultDateTime
4732
4733def CustomDataFormat(*args, **kwargs):
4734 """
4735 CustomDataFormat(String format) -> DataFormat
4736
79fccf9d
RD
4737 Constructs a data format object for a custom format identified by its
4738 name.
d55e5bfc
RD
4739 """
4740 val = _misc_.new_CustomDataFormat(*args, **kwargs)
d55e5bfc
RD
4741 return val
4742
4743class DataObject(object):
a07a67e6
RD
4744 """
4745 A wx.DataObject represents data that can be copied to or from the
4746 clipboard, or dragged and dropped. The important thing about
4747 wx.DataObject is that this is a 'smart' piece of data unlike usual
4748 'dumb' data containers such as memory buffers or files. Being 'smart'
4749 here means that the data object itself should know what data formats
4750 it supports and how to render itself in each of supported formats.
4751
4752 **NOTE**: This class is an abstract base class and can not be used
4753 directly from Python. If you need a custom type of data object then
4754 you should instead derive from `wx.PyDataObjectSimple` or use
4755 `wx.CustomDataObject`.
4756
4757 """
554f62e9
RD
4758 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4759 def __init__(self): raise AttributeError, "No constructor defined"
4760 __repr__ = _swig_repr
d55e5bfc
RD
4761 Get = _misc_.DataObject_Get
4762 Set = _misc_.DataObject_Set
4763 Both = _misc_.DataObject_Both
554f62e9
RD
4764 __swig_destroy__ = _misc_.delete_DataObject
4765 __del__ = lambda self : None;
d55e5bfc 4766 def GetPreferredFormat(*args, **kwargs):
a07a67e6
RD
4767 """
4768 GetPreferredFormat(self, int dir=Get) -> DataFormat
4769
4770 Returns the preferred format for either rendering the data (if dir is
4771 Get, its default value) or for setting it. Usually this will be the
4772 native format of the wx.DataObject.
4773 """
d55e5bfc
RD
4774 return _misc_.DataObject_GetPreferredFormat(*args, **kwargs)
4775
4776 def GetFormatCount(*args, **kwargs):
a07a67e6
RD
4777 """
4778 GetFormatCount(self, int dir=Get) -> size_t
4779
4780 Returns the number of available formats for rendering or setting the
4781 data.
4782 """
d55e5bfc
RD
4783 return _misc_.DataObject_GetFormatCount(*args, **kwargs)
4784
4785 def IsSupported(*args, **kwargs):
a07a67e6
RD
4786 """
4787 IsSupported(self, DataFormat format, int dir=Get) -> bool
4788
4789 Returns True if this format is supported.
4790 """
d55e5bfc
RD
4791 return _misc_.DataObject_IsSupported(*args, **kwargs)
4792
4793 def GetDataSize(*args, **kwargs):
a07a67e6
RD
4794 """
4795 GetDataSize(self, DataFormat format) -> size_t
4796
4797 Get the (total) size of data for the given format
4798 """
d55e5bfc
RD
4799 return _misc_.DataObject_GetDataSize(*args, **kwargs)
4800
4801 def GetAllFormats(*args, **kwargs):
a07a67e6
RD
4802 """
4803 GetAllFormats(self, int dir=Get) -> [formats]
4804
4805 Returns a list of all the wx.DataFormats that this dataobject supports
4806 in the given direction.
4807 """
d55e5bfc
RD
4808 return _misc_.DataObject_GetAllFormats(*args, **kwargs)
4809
4810 def GetDataHere(*args, **kwargs):
a07a67e6
RD
4811 """
4812 GetDataHere(self, DataFormat format) -> String
4813
4814 Get the data bytes in the specified format, returns None on failure.
a07a67e6 4815 """
d55e5bfc
RD
4816 return _misc_.DataObject_GetDataHere(*args, **kwargs)
4817
4818 def SetData(*args, **kwargs):
a07a67e6
RD
4819 """
4820 SetData(self, DataFormat format, String data) -> bool
4821
4822 Set the data in the specified format from the bytes in the the data string.
4823
4824 """
d55e5bfc
RD
4825 return _misc_.DataObject_SetData(*args, **kwargs)
4826
226118fc
RD
4827 AllFormats = property(GetAllFormats,doc="See `GetAllFormats`")
4828 DataHere = property(GetDataHere,doc="See `GetDataHere`")
4829 DataSize = property(GetDataSize,doc="See `GetDataSize`")
4830 FormatCount = property(GetFormatCount,doc="See `GetFormatCount`")
4831 PreferredFormat = property(GetPreferredFormat,doc="See `GetPreferredFormat`")
2131d850 4832_misc_.DataObject_swigregister(DataObject)
d55e5bfc
RD
4833FormatInvalid = cvar.FormatInvalid
4834
4835class DataObjectSimple(DataObject):
a07a67e6
RD
4836 """
4837 wx.DataObjectSimple is a `wx.DataObject` which only supports one
4838 format. This is the simplest possible `wx.DataObject` implementation.
4839
4840 This is still an "abstract base class" meaning that you can't use it
4841 directly. You either need to use one of the predefined base classes,
4842 or derive your own class from `wx.PyDataObjectSimple`.
4843
4844 """
554f62e9
RD
4845 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4846 __repr__ = _swig_repr
4847 def __init__(self, *args, **kwargs):
a07a67e6
RD
4848 """
4849 __init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple
4850
4851 Constructor accepts the supported format (none by default) which may
4852 also be set later with `SetFormat`.
4853 """
554f62e9 4854 _misc_.DataObjectSimple_swiginit(self,_misc_.new_DataObjectSimple(*args, **kwargs))
d55e5bfc 4855 def GetFormat(*args, **kwargs):
a07a67e6
RD
4856 """
4857 GetFormat(self) -> DataFormat
4858
4859 Returns the (one and only one) format supported by this object. It is
4860 assumed that the format is supported in both directions.
4861 """
d55e5bfc
RD
4862 return _misc_.DataObjectSimple_GetFormat(*args, **kwargs)
4863
4864 def SetFormat(*args, **kwargs):
a07a67e6
RD
4865 """
4866 SetFormat(self, DataFormat format)
4867
4868 Sets the supported format.
4869 """
d55e5bfc
RD
4870 return _misc_.DataObjectSimple_SetFormat(*args, **kwargs)
4871
a07a67e6
RD
4872 def GetDataSize(*args, **kwargs):
4873 """
4874 GetDataSize(self) -> size_t
4875
4876 Get the size of our data.
4877 """
4878 return _misc_.DataObjectSimple_GetDataSize(*args, **kwargs)
4879
4880 def GetDataHere(*args, **kwargs):
4881 """
4882 GetDataHere(self) -> String
4883
4884 Returns the data bytes from the data object as a string, returns None
4885 on failure. Must be implemented in the derived class if the object
4886 supports rendering its data.
4887 """
4888 return _misc_.DataObjectSimple_GetDataHere(*args, **kwargs)
4889
4890 def SetData(*args, **kwargs):
4891 """
4892 SetData(self, String data) -> bool
4893
4894 Copy the data value to the data object. Must be implemented in the
4895 derived class if the object supports setting its data.
4896
4897 """
4898 return _misc_.DataObjectSimple_SetData(*args, **kwargs)
4899
226118fc 4900 Format = property(GetFormat,SetFormat,doc="See `GetFormat` and `SetFormat`")
2131d850 4901_misc_.DataObjectSimple_swigregister(DataObjectSimple)
d55e5bfc
RD
4902
4903class PyDataObjectSimple(DataObjectSimple):
a07a67e6
RD
4904 """
4905 wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
4906 Python-aware and knows how to reflect calls to its C++ virtual methods
4907 to methods in the Python derived class. You should derive from this
4908 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
4909 need to create your own simple single-format type of `wx.DataObject`.
4910
4911 """
554f62e9
RD
4912 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4913 __repr__ = _swig_repr
4914 def __init__(self, *args, **kwargs):
a07a67e6
RD
4915 """
4916 __init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple
4917
4918 wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
4919 Python-aware and knows how to reflect calls to its C++ virtual methods
4920 to methods in the Python derived class. You should derive from this
4921 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
4922 need to create your own simple single-format type of `wx.DataObject`.
4923
4924 """
554f62e9 4925 _misc_.PyDataObjectSimple_swiginit(self,_misc_.new_PyDataObjectSimple(*args, **kwargs))
c25f90f6 4926 PyDataObjectSimple._setCallbackInfo(self, self, PyDataObjectSimple)
d55e5bfc
RD
4927
4928 def _setCallbackInfo(*args, **kwargs):
4929 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
4930 return _misc_.PyDataObjectSimple__setCallbackInfo(*args, **kwargs)
4931
2131d850 4932_misc_.PyDataObjectSimple_swigregister(PyDataObjectSimple)
d55e5bfc
RD
4933
4934class DataObjectComposite(DataObject):
a07a67e6
RD
4935 """
4936 wx.DataObjectComposite is the simplest `wx.DataObject` derivation
4937 which may be sued to support multiple formats. It contains several
4938 'wx.DataObjectSimple` objects and supports any format supported by at
4939 least one of them. Only one of these data objects is *preferred* (the
4940 first one if not explicitly changed by using the second parameter of
4941 `Add`) and its format determines the preferred format of the composite
4942 data object as well.
4943
4944 See `wx.DataObject` documentation for the reasons why you might prefer
4945 to use wx.DataObject directly instead of wx.DataObjectComposite for
4946 efficiency reasons.
4947
4948 """
554f62e9
RD
4949 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4950 __repr__ = _swig_repr
4951 def __init__(self, *args, **kwargs):
a07a67e6
RD
4952 """
4953 __init__(self) -> DataObjectComposite
4954
4955 wx.DataObjectComposite is the simplest `wx.DataObject` derivation
4956 which may be sued to support multiple formats. It contains several
4957 'wx.DataObjectSimple` objects and supports any format supported by at
4958 least one of them. Only one of these data objects is *preferred* (the
4959 first one if not explicitly changed by using the second parameter of
4960 `Add`) and its format determines the preferred format of the composite
4961 data object as well.
4962
4963 See `wx.DataObject` documentation for the reasons why you might prefer
4964 to use wx.DataObject directly instead of wx.DataObjectComposite for
4965 efficiency reasons.
4966
4967 """
554f62e9 4968 _misc_.DataObjectComposite_swiginit(self,_misc_.new_DataObjectComposite(*args, **kwargs))
d55e5bfc 4969 def Add(*args, **kwargs):
a07a67e6
RD
4970 """
4971 Add(self, DataObjectSimple dataObject, bool preferred=False)
4972
4973 Adds the dataObject to the list of supported objects and it becomes
4974 the preferred object if preferred is True.
4975 """
d55e5bfc
RD
4976 return _misc_.DataObjectComposite_Add(*args, **kwargs)
4977
e9d6f3a4
RD
4978 def GetReceivedFormat(*args, **kwargs):
4979 """
4980 GetReceivedFormat(self) -> DataFormat
4981
4982 Report the format passed to the `SetData` method. This should be the
4983 format of the data object within the composite that recieved data from
4984 the clipboard or the DnD operation. You can use this method to find
4985 out what kind of data object was recieved.
4986 """
4987 return _misc_.DataObjectComposite_GetReceivedFormat(*args, **kwargs)
4988
226118fc 4989 ReceivedFormat = property(GetReceivedFormat,doc="See `GetReceivedFormat`")
2131d850 4990_misc_.DataObjectComposite_swigregister(DataObjectComposite)
d55e5bfc
RD
4991
4992class TextDataObject(DataObjectSimple):
a07a67e6
RD
4993 """
4994 wx.TextDataObject is a specialization of `wx.DataObject` for text
4995 data. It can be used without change to paste data into the `wx.Clipboard`
4996 or a `wx.DropSource`.
4997
4998 Alternativly, you may wish to derive a new class from the
4999 `wx.PyTextDataObject` class for providing text on-demand in order to
5000 minimize memory consumption when offering data in several formats,
5001 such as plain text and RTF, because by default the text is stored in a
5002 string in this class, but it might as well be generated on demand when
5003 requested. For this, `GetTextLength` and `GetText` will have to be
5004 overridden.
5005 """
554f62e9
RD
5006 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5007 __repr__ = _swig_repr
5008 def __init__(self, *args, **kwargs):
a07a67e6
RD
5009 """
5010 __init__(self, String text=EmptyString) -> TextDataObject
5011
5012 Constructor, may be used to initialise the text (otherwise `SetText`
5013 should be used later).
5014 """
554f62e9 5015 _misc_.TextDataObject_swiginit(self,_misc_.new_TextDataObject(*args, **kwargs))
d55e5bfc 5016 def GetTextLength(*args, **kwargs):
a07a67e6
RD
5017 """
5018 GetTextLength(self) -> size_t
5019
5020 Returns the data size. By default, returns the size of the text data
5021 set in the constructor or using `SetText`. This can be overridden (via
5022 `wx.PyTextDataObject`) to provide text size data on-demand. It is
5023 recommended to return the text length plus 1 for a trailing zero, but
5024 this is not strictly required.
5025 """
d55e5bfc
RD
5026 return _misc_.TextDataObject_GetTextLength(*args, **kwargs)
5027
5028 def GetText(*args, **kwargs):
a07a67e6
RD
5029 """
5030 GetText(self) -> String
5031
5032 Returns the text associated with the data object.
5033 """
d55e5bfc
RD
5034 return _misc_.TextDataObject_GetText(*args, **kwargs)
5035
5036 def SetText(*args, **kwargs):
a07a67e6
RD
5037 """
5038 SetText(self, String text)
5039
5040 Sets the text associated with the data object. This method is called
5041 when the data object receives the data and, by default, copies the
5042 text into the member variable. If you want to process the text on the
5043 fly you may wish to override this function (via
5044 `wx.PyTextDataObject`.)
5045 """
d55e5bfc
RD
5046 return _misc_.TextDataObject_SetText(*args, **kwargs)
5047
994453b8
RD
5048 Text = property(GetText,SetText,doc="See `GetText` and `SetText`")
5049 TextLength = property(GetTextLength,doc="See `GetTextLength`")
2131d850 5050_misc_.TextDataObject_swigregister(TextDataObject)
d55e5bfc
RD
5051
5052class PyTextDataObject(TextDataObject):
a07a67e6
RD
5053 """
5054 wx.PyTextDataObject is a version of `wx.TextDataObject` that is
5055 Python-aware and knows how to reflect calls to its C++ virtual methods
5056 to methods in the Python derived class. You should derive from this
5057 class and overload `GetTextLength`, `GetText`, and `SetText` when you
5058 want to be able to provide text on demand instead of preloading it
5059 into the data object.
5060 """
554f62e9
RD
5061 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5062 __repr__ = _swig_repr
5063 def __init__(self, *args, **kwargs):
a07a67e6
RD
5064 """
5065 __init__(self, String text=EmptyString) -> PyTextDataObject
5066
5067 wx.PyTextDataObject is a version of `wx.TextDataObject` that is
5068 Python-aware and knows how to reflect calls to its C++ virtual methods
5069 to methods in the Python derived class. You should derive from this
5070 class and overload `GetTextLength`, `GetText`, and `SetText` when you
5071 want to be able to provide text on demand instead of preloading it
5072 into the data object.
5073 """
554f62e9 5074 _misc_.PyTextDataObject_swiginit(self,_misc_.new_PyTextDataObject(*args, **kwargs))
c25f90f6 5075 PyTextDataObject._setCallbackInfo(self, self, PyTextDataObject)
d55e5bfc
RD
5076
5077 def _setCallbackInfo(*args, **kwargs):
5078 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5079 return _misc_.PyTextDataObject__setCallbackInfo(*args, **kwargs)
5080
2131d850 5081_misc_.PyTextDataObject_swigregister(PyTextDataObject)
d55e5bfc
RD
5082
5083class BitmapDataObject(DataObjectSimple):
a07a67e6
RD
5084 """
5085 wx.BitmapDataObject is a specialization of wxDataObject for bitmap
5086 data. It can be used without change to paste data into the `wx.Clipboard`
5087 or a `wx.DropSource`.
5088
5089 """
554f62e9
RD
5090 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5091 __repr__ = _swig_repr
5092 def __init__(self, *args, **kwargs):
a07a67e6
RD
5093 """
5094 __init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject
5095
5096 Constructor, optionally passing a bitmap (otherwise use `SetBitmap`
5097 later).
5098 """
554f62e9 5099 _misc_.BitmapDataObject_swiginit(self,_misc_.new_BitmapDataObject(*args, **kwargs))
d55e5bfc 5100 def GetBitmap(*args, **kwargs):
a07a67e6
RD
5101 """
5102 GetBitmap(self) -> Bitmap
5103
5104 Returns the bitmap associated with the data object. You may wish to
5105 override this method (by deriving from `wx.PyBitmapDataObject`) when
5106 offering data on-demand, but this is not required by wxWidgets'
5107 internals. Use this method to get data in bitmap form from the
5108 `wx.Clipboard`.
5109 """
d55e5bfc
RD
5110 return _misc_.BitmapDataObject_GetBitmap(*args, **kwargs)
5111
5112 def SetBitmap(*args, **kwargs):
a07a67e6
RD
5113 """
5114 SetBitmap(self, Bitmap bitmap)
5115
5116 Sets the bitmap associated with the data object. This method is called
5117 when the data object receives data. Usually there will be no reason to
5118 override this function.
5119 """
d55e5bfc
RD
5120 return _misc_.BitmapDataObject_SetBitmap(*args, **kwargs)
5121
226118fc 5122 Bitmap = property(GetBitmap,SetBitmap,doc="See `GetBitmap` and `SetBitmap`")
2131d850 5123_misc_.BitmapDataObject_swigregister(BitmapDataObject)
d55e5bfc
RD
5124
5125class PyBitmapDataObject(BitmapDataObject):
a07a67e6
RD
5126 """
5127 wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
5128 Python-aware and knows how to reflect calls to its C++ virtual methods
5129 to methods in the Python derived class. To be able to provide bitmap
5130 data on demand derive from this class and overload `GetBitmap`.
5131 """
554f62e9
RD
5132 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5133 __repr__ = _swig_repr
5134 def __init__(self, *args, **kwargs):
a07a67e6
RD
5135 """
5136 __init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject
5137
5138 wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
5139 Python-aware and knows how to reflect calls to its C++ virtual methods
5140 to methods in the Python derived class. To be able to provide bitmap
5141 data on demand derive from this class and overload `GetBitmap`.
5142 """
554f62e9 5143 _misc_.PyBitmapDataObject_swiginit(self,_misc_.new_PyBitmapDataObject(*args, **kwargs))
c25f90f6 5144 PyBitmapDataObject._setCallbackInfo(self, self, PyBitmapDataObject)
d55e5bfc
RD
5145
5146 def _setCallbackInfo(*args, **kwargs):
5147 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5148 return _misc_.PyBitmapDataObject__setCallbackInfo(*args, **kwargs)
5149
2131d850 5150_misc_.PyBitmapDataObject_swigregister(PyBitmapDataObject)
d55e5bfc
RD
5151
5152class FileDataObject(DataObjectSimple):
a07a67e6
RD
5153 """
5154 wx.FileDataObject is a specialization of `wx.DataObjectSimple` for
5155 file names. The program works with it just as if it were a list of
5156 absolute file names, but internally it uses the same format as
5157 Explorer and other compatible programs under Windows or GNOME/KDE
5158 filemanager under Unix which makes it possible to receive files from
5159 them using this class.
a07a67e6 5160 """
554f62e9
RD
5161 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5162 __repr__ = _swig_repr
5163 def __init__(self, *args, **kwargs):
d55e5bfc 5164 """__init__(self) -> FileDataObject"""
554f62e9 5165 _misc_.FileDataObject_swiginit(self,_misc_.new_FileDataObject(*args, **kwargs))
d55e5bfc 5166 def GetFilenames(*args, **kwargs):
a001823c
RD
5167 """
5168 GetFilenames(self) -> [names]
5169
5170 Returns a list of file names.
5171 """
d55e5bfc
RD
5172 return _misc_.FileDataObject_GetFilenames(*args, **kwargs)
5173
5174 def AddFile(*args, **kwargs):
a07a67e6
RD
5175 """
5176 AddFile(self, String filename)
5177
5178 Adds a file to the list of files represented by this data object.
5179 """
d55e5bfc
RD
5180 return _misc_.FileDataObject_AddFile(*args, **kwargs)
5181
97ab0f6a 5182 Filenames = property(GetFilenames,doc="See `GetFilenames`")
2131d850 5183_misc_.FileDataObject_swigregister(FileDataObject)
d55e5bfc
RD
5184
5185class CustomDataObject(DataObjectSimple):
a07a67e6
RD
5186 """
5187 wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
5188 some application-specific data in arbitrary format. Python strings
5189 are used for getting and setting data, but any picklable object can
5190 easily be transfered via strings. A copy of the data is stored in the
5191 data object.
5192 """
554f62e9
RD
5193 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5194 __repr__ = _swig_repr
5195 def __init__(self, *args):
a07a67e6 5196 """
fef4c27a
RD
5197 __init__(self, DataFormat format) -> CustomDataObject
5198 __init__(self, String formatName) -> CustomDataObject
5199 __init__(self) -> CustomDataObject
a07a67e6
RD
5200
5201 wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
5202 some application-specific data in arbitrary format. Python strings
5203 are used for getting and setting data, but any picklable object can
5204 easily be transfered via strings. A copy of the data is stored in the
5205 data object.
5206 """
554f62e9 5207 _misc_.CustomDataObject_swiginit(self,_misc_.new_CustomDataObject(*args))
d55e5bfc 5208 def SetData(*args, **kwargs):
a07a67e6
RD
5209 """
5210 SetData(self, String data) -> bool
5211
5212 Copy the data value to the data object.
5213 """
d55e5bfc
RD
5214 return _misc_.CustomDataObject_SetData(*args, **kwargs)
5215
a07a67e6 5216 TakeData = SetData
d55e5bfc 5217 def GetSize(*args, **kwargs):
a07a67e6
RD
5218 """
5219 GetSize(self) -> size_t
5220
5221 Get the size of the data.
5222 """
d55e5bfc
RD
5223 return _misc_.CustomDataObject_GetSize(*args, **kwargs)
5224
5225 def GetData(*args, **kwargs):
a07a67e6
RD
5226 """
5227 GetData(self) -> String
5228
5229 Returns the data bytes from the data object as a string.
5230 """
d55e5bfc
RD
5231 return _misc_.CustomDataObject_GetData(*args, **kwargs)
5232
226118fc
RD
5233 Data = property(GetData,SetData,doc="See `GetData` and `SetData`")
5234 Size = property(GetSize,doc="See `GetSize`")
2131d850 5235_misc_.CustomDataObject_swigregister(CustomDataObject)
d55e5bfc 5236
7449af73 5237class URLDataObject(DataObject):
a07a67e6
RD
5238 """
5239 This data object holds a URL in a format that is compatible with some
5240 browsers such that it is able to be dragged to or from them.
5241 """
554f62e9
RD
5242 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5243 __repr__ = _swig_repr
5244 def __init__(self, *args, **kwargs):
a07a67e6 5245 """
fc46b7f3 5246 __init__(self, String url=EmptyString) -> URLDataObject
a07a67e6
RD
5247
5248 This data object holds a URL in a format that is compatible with some
5249 browsers such that it is able to be dragged to or from them.
5250 """
554f62e9 5251 _misc_.URLDataObject_swiginit(self,_misc_.new_URLDataObject(*args, **kwargs))
d55e5bfc 5252 def GetURL(*args, **kwargs):
a07a67e6
RD
5253 """
5254 GetURL(self) -> String
5255
5256 Returns a string containing the current URL.
5257 """
d55e5bfc
RD
5258 return _misc_.URLDataObject_GetURL(*args, **kwargs)
5259
5260 def SetURL(*args, **kwargs):
a07a67e6
RD
5261 """
5262 SetURL(self, String url)
5263
5264 Set the URL.
5265 """
d55e5bfc
RD
5266 return _misc_.URLDataObject_SetURL(*args, **kwargs)
5267
dba7934c 5268 URL = property(GetURL,SetURL,doc="See `GetURL` and `SetURL`")
2131d850 5269_misc_.URLDataObject_swigregister(URLDataObject)
d55e5bfc
RD
5270
5271class MetafileDataObject(DataObjectSimple):
093d3ff1 5272 """Proxy of C++ MetafileDataObject class"""
554f62e9
RD
5273 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5274 __repr__ = _swig_repr
5275 def __init__(self, *args, **kwargs):
d55e5bfc 5276 """__init__(self) -> MetafileDataObject"""
554f62e9 5277 _misc_.MetafileDataObject_swiginit(self,_misc_.new_MetafileDataObject(*args, **kwargs))
d55e5bfc
RD
5278 def SetMetafile(*args, **kwargs):
5279 """SetMetafile(self, wxMetafile metafile)"""
5280 return _misc_.MetafileDataObject_SetMetafile(*args, **kwargs)
5281
5282 def GetMetafile(*args, **kwargs):
5283 """GetMetafile(self) -> wxMetafile"""
5284 return _misc_.MetafileDataObject_GetMetafile(*args, **kwargs)
5285
2131d850 5286_misc_.MetafileDataObject_swigregister(MetafileDataObject)
d55e5bfc
RD
5287
5288#---------------------------------------------------------------------------
5289
5290Drag_CopyOnly = _misc_.Drag_CopyOnly
5291Drag_AllowMove = _misc_.Drag_AllowMove
5292Drag_DefaultMove = _misc_.Drag_DefaultMove
5293DragError = _misc_.DragError
5294DragNone = _misc_.DragNone
5295DragCopy = _misc_.DragCopy
5296DragMove = _misc_.DragMove
5297DragLink = _misc_.DragLink
5298DragCancel = _misc_.DragCancel
5299
5300def IsDragResultOk(*args, **kwargs):
554f62e9
RD
5301 """IsDragResultOk(int res) -> bool"""
5302 return _misc_.IsDragResultOk(*args, **kwargs)
d55e5bfc 5303class DropSource(object):
093d3ff1 5304 """Proxy of C++ DropSource class"""
554f62e9
RD
5305 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5306 __repr__ = _swig_repr
5307 def __init__(self, *args, **kwargs):
d55e5bfc
RD
5308 """
5309 __init__(self, Window win, Cursor copy=wxNullCursor, Cursor move=wxNullCursor,
5310 Cursor none=wxNullCursor) -> DropSource
5311 """
554f62e9 5312 _misc_.DropSource_swiginit(self,_misc_.new_DropSource(*args, **kwargs))
c25f90f6 5313 DropSource._setCallbackInfo(self, self, DropSource)
e058867b 5314
d55e5bfc 5315 def _setCallbackInfo(*args, **kwargs):
c25f90f6 5316 """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)"""
d55e5bfc
RD
5317 return _misc_.DropSource__setCallbackInfo(*args, **kwargs)
5318
554f62e9
RD
5319 __swig_destroy__ = _misc_.delete_DropSource
5320 __del__ = lambda self : None;
d55e5bfc
RD
5321 def SetData(*args, **kwargs):
5322 """SetData(self, DataObject data)"""
5323 return _misc_.DropSource_SetData(*args, **kwargs)
5324
5325 def GetDataObject(*args, **kwargs):
5326 """GetDataObject(self) -> DataObject"""
5327 return _misc_.DropSource_GetDataObject(*args, **kwargs)
5328
5329 def SetCursor(*args, **kwargs):
5330 """SetCursor(self, int res, Cursor cursor)"""
5331 return _misc_.DropSource_SetCursor(*args, **kwargs)
5332
5333 def DoDragDrop(*args, **kwargs):
5334 """DoDragDrop(self, int flags=Drag_CopyOnly) -> int"""
5335 return _misc_.DropSource_DoDragDrop(*args, **kwargs)
5336
b06b3e70
RD
5337 def GiveFeedback(*args, **kwargs):
5338 """GiveFeedback(self, int effect) -> bool"""
5339 return _misc_.DropSource_GiveFeedback(*args, **kwargs)
5340
5341 def base_GiveFeedback(*args, **kw):
5342 return DropSource.GiveFeedback(*args, **kw)
5343 base_GiveFeedback = wx._deprecated(base_GiveFeedback,
5344 "Please use DropSource.GiveFeedback instead.")
d55e5bfc 5345
226118fc 5346 DataObject = property(GetDataObject,SetData,doc="See `GetDataObject` and `SetData`")
2131d850 5347_misc_.DropSource_swigregister(DropSource)
d55e5bfc 5348
60d5fcc1
RD
5349def DROP_ICON(filename):
5350 """
5351 Returns either a `wx.Cursor` or `wx.Icon` created from the image file
5352 ``filename``. This function is useful with the `wx.DropSource` class
5353 which, depending on platform accepts either a icon or a cursor.
5354 """
5355 img = wx.Image(filename)
5356 if wx.Platform == '__WXGTK__':
5357 return wx.IconFromBitmap(wx.BitmapFromImage(img))
5358 else:
5359 return wx.CursorFromImage(img)
5360
d55e5bfc 5361class DropTarget(object):
093d3ff1 5362 """Proxy of C++ DropTarget class"""
554f62e9
RD
5363 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5364 __repr__ = _swig_repr
5365 def __init__(self, *args, **kwargs):
d55e5bfc 5366 """__init__(self, DataObject dataObject=None) -> DropTarget"""
554f62e9 5367 _misc_.DropTarget_swiginit(self,_misc_.new_DropTarget(*args, **kwargs))
c25f90f6 5368 DropTarget._setCallbackInfo(self, self, DropTarget)
d55e5bfc
RD
5369
5370 def _setCallbackInfo(*args, **kwargs):
5371 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5372 return _misc_.DropTarget__setCallbackInfo(*args, **kwargs)
5373
554f62e9
RD
5374 __swig_destroy__ = _misc_.delete_DropTarget
5375 __del__ = lambda self : None;
d55e5bfc
RD
5376 def GetDataObject(*args, **kwargs):
5377 """GetDataObject(self) -> DataObject"""
5378 return _misc_.DropTarget_GetDataObject(*args, **kwargs)
5379
5380 def SetDataObject(*args, **kwargs):
5381 """SetDataObject(self, DataObject dataObject)"""
5382 return _misc_.DropTarget_SetDataObject(*args, **kwargs)
5383
b06b3e70
RD
5384 def OnEnter(*args, **kwargs):
5385 """OnEnter(self, int x, int y, int def) -> int"""
5386 return _misc_.DropTarget_OnEnter(*args, **kwargs)
5387
5388 def OnDragOver(*args, **kwargs):
5389 """OnDragOver(self, int x, int y, int def) -> int"""
5390 return _misc_.DropTarget_OnDragOver(*args, **kwargs)
5391
5392 def OnLeave(*args, **kwargs):
5393 """OnLeave(self)"""
5394 return _misc_.DropTarget_OnLeave(*args, **kwargs)
d55e5bfc 5395
b06b3e70
RD
5396 def OnDrop(*args, **kwargs):
5397 """OnDrop(self, int x, int y) -> bool"""
5398 return _misc_.DropTarget_OnDrop(*args, **kwargs)
d55e5bfc 5399
b06b3e70
RD
5400 def base_OnEnter(*args, **kw):
5401 return DropTarget.OnEnter(*args, **kw)
5402 base_OnEnter = wx._deprecated(base_OnEnter,
5403 "Please use DropTarget.OnEnter instead.")
d55e5bfc 5404
b06b3e70
RD
5405 def base_OnDragOver(*args, **kw):
5406 return DropTarget.OnDragOver(*args, **kw)
5407 base_OnDragOver = wx._deprecated(base_OnDragOver,
5408 "Please use DropTarget.OnDragOver instead.")
5409
5410 def base_OnLeave(*args, **kw):
5411 return DropTarget.OnLeave(*args, **kw)
5412 base_OnLeave = wx._deprecated(base_OnLeave,
5413 "Please use DropTarget.OnLeave instead.")
5414
5415 def base_OnDrop(*args, **kw):
5416 return DropTarget.OnDrop(*args, **kw)
5417 base_OnDrop = wx._deprecated(base_OnDrop,
5418 "Please use DropTarget.OnDrop instead.")
d55e5bfc
RD
5419
5420 def GetData(*args, **kwargs):
5421 """GetData(self) -> bool"""
5422 return _misc_.DropTarget_GetData(*args, **kwargs)
5423
0c549c5f
RD
5424 def SetDefaultAction(*args, **kwargs):
5425 """SetDefaultAction(self, int action)"""
5426 return _misc_.DropTarget_SetDefaultAction(*args, **kwargs)
5427
5428 def GetDefaultAction(*args, **kwargs):
5429 """GetDefaultAction(self) -> int"""
5430 return _misc_.DropTarget_GetDefaultAction(*args, **kwargs)
5431
226118fc
RD
5432 DataObject = property(GetDataObject,SetDataObject,doc="See `GetDataObject` and `SetDataObject`")
5433 DefaultAction = property(GetDefaultAction,SetDefaultAction,doc="See `GetDefaultAction` and `SetDefaultAction`")
2131d850 5434_misc_.DropTarget_swigregister(DropTarget)
d55e5bfc
RD
5435
5436PyDropTarget = DropTarget
5437class TextDropTarget(DropTarget):
093d3ff1 5438 """Proxy of C++ TextDropTarget class"""
554f62e9
RD
5439 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5440 __repr__ = _swig_repr
5441 def __init__(self, *args, **kwargs):
d55e5bfc 5442 """__init__(self) -> TextDropTarget"""
554f62e9 5443 _misc_.TextDropTarget_swiginit(self,_misc_.new_TextDropTarget(*args, **kwargs))
c25f90f6 5444 TextDropTarget._setCallbackInfo(self, self, TextDropTarget)
d55e5bfc
RD
5445
5446 def _setCallbackInfo(*args, **kwargs):
5447 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5448 return _misc_.TextDropTarget__setCallbackInfo(*args, **kwargs)
5449
b06b3e70
RD
5450 def OnDropText(*args, **kwargs):
5451 """OnDropText(self, int x, int y, String text) -> bool"""
5452 return _misc_.TextDropTarget_OnDropText(*args, **kwargs)
5453
5454 def OnEnter(*args, **kwargs):
5455 """OnEnter(self, int x, int y, int def) -> int"""
5456 return _misc_.TextDropTarget_OnEnter(*args, **kwargs)
5457
5458 def OnDragOver(*args, **kwargs):
5459 """OnDragOver(self, int x, int y, int def) -> int"""
5460 return _misc_.TextDropTarget_OnDragOver(*args, **kwargs)
d55e5bfc 5461
b06b3e70
RD
5462 def OnLeave(*args, **kwargs):
5463 """OnLeave(self)"""
5464 return _misc_.TextDropTarget_OnLeave(*args, **kwargs)
d55e5bfc 5465
b06b3e70
RD
5466 def OnDrop(*args, **kwargs):
5467 """OnDrop(self, int x, int y) -> bool"""
5468 return _misc_.TextDropTarget_OnDrop(*args, **kwargs)
d55e5bfc 5469
b06b3e70
RD
5470 def OnData(*args, **kwargs):
5471 """OnData(self, int x, int y, int def) -> int"""
5472 return _misc_.TextDropTarget_OnData(*args, **kwargs)
d55e5bfc 5473
b06b3e70
RD
5474 def base_OnDropText(*args, **kw):
5475 return TextDropTarget.OnDropText(*args, **kw)
5476 base_OnDropText = wx._deprecated(base_OnDropText,
5477 "Please use TextDropTarget.OnDropText instead.")
5478
5479 def base_OnEnter(*args, **kw):
5480 return TextDropTarget.OnEnter(*args, **kw)
5481 base_OnEnter = wx._deprecated(base_OnEnter,
5482 "Please use TextDropTarget.OnEnter instead.")
5483
5484 def base_OnDragOver(*args, **kw):
5485 return TextDropTarget.OnDragOver(*args, **kw)
5486 base_OnDragOver = wx._deprecated(base_OnDragOver,
5487 "Please use TextDropTarget.OnDragOver instead.")
5488
5489 def base_OnLeave(*args, **kw):
5490 return TextDropTarget.OnLeave(*args, **kw)
5491 base_OnLeave = wx._deprecated(base_OnLeave,
5492 "Please use TextDropTarget.OnLeave instead.")
5493
5494 def base_OnDrop(*args, **kw):
5495 return TextDropTarget.OnDrop(*args, **kw)
5496 base_OnDrop = wx._deprecated(base_OnDrop,
5497 "Please use TextDropTarget.OnDrop instead.")
5498
5499 def base_OnData(*args, **kw):
5500 return TextDropTarget.OnData(*args, **kw)
5501 base_OnData = wx._deprecated(base_OnData,
5502 "Please use TextDropTarget.OnData instead.")
d55e5bfc 5503
2131d850 5504_misc_.TextDropTarget_swigregister(TextDropTarget)
d55e5bfc
RD
5505
5506class FileDropTarget(DropTarget):
093d3ff1 5507 """Proxy of C++ FileDropTarget class"""
554f62e9
RD
5508 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5509 __repr__ = _swig_repr
5510 def __init__(self, *args, **kwargs):
d55e5bfc 5511 """__init__(self) -> FileDropTarget"""
554f62e9 5512 _misc_.FileDropTarget_swiginit(self,_misc_.new_FileDropTarget(*args, **kwargs))
c25f90f6 5513 FileDropTarget._setCallbackInfo(self, self, FileDropTarget)
d55e5bfc
RD
5514
5515 def _setCallbackInfo(*args, **kwargs):
5516 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
5517 return _misc_.FileDropTarget__setCallbackInfo(*args, **kwargs)
5518
b06b3e70
RD
5519 def OnDropFiles(*args, **kwargs):
5520 """OnDropFiles(self, int x, int y, wxArrayString filenames) -> bool"""
5521 return _misc_.FileDropTarget_OnDropFiles(*args, **kwargs)
5522
5523 def OnEnter(*args, **kwargs):
5524 """OnEnter(self, int x, int y, int def) -> int"""
5525 return _misc_.FileDropTarget_OnEnter(*args, **kwargs)
5526
5527 def OnDragOver(*args, **kwargs):
5528 """OnDragOver(self, int x, int y, int def) -> int"""
5529 return _misc_.FileDropTarget_OnDragOver(*args, **kwargs)
5530
5531 def OnLeave(*args, **kwargs):
5532 """OnLeave(self)"""
5533 return _misc_.FileDropTarget_OnLeave(*args, **kwargs)
5534
5535 def OnDrop(*args, **kwargs):
5536 """OnDrop(self, int x, int y) -> bool"""
5537 return _misc_.FileDropTarget_OnDrop(*args, **kwargs)
5538
5539 def OnData(*args, **kwargs):
5540 """OnData(self, int x, int y, int def) -> int"""
5541 return _misc_.FileDropTarget_OnData(*args, **kwargs)
5542
5543 def base_OnDropFiles(*args, **kw):
5544 return FileDropTarget.OnDropFiles(*args, **kw)
5545 base_OnDropFiles = wx._deprecated(base_OnDropFiles,
5546 "Please use FileDropTarget.OnDropFiles instead.")
5547
5548 def base_OnEnter(*args, **kw):
5549 return FileDropTarget.OnEnter(*args, **kw)
5550 base_OnEnter = wx._deprecated(base_OnEnter,
5551 "Please use FileDropTarget.OnEnter instead.")
5552
5553 def base_OnDragOver(*args, **kw):
5554 return FileDropTarget.OnDragOver(*args, **kw)
5555 base_OnDragOver = wx._deprecated(base_OnDragOver,
5556 "Please use FileDropTarget.OnDragOver instead.")
5557
5558 def base_OnLeave(*args, **kw):
5559 return FileDropTarget.OnLeave(*args, **kw)
5560 base_OnLeave = wx._deprecated(base_OnLeave,
5561 "Please use FileDropTarget.OnLeave instead.")
5562
5563 def base_OnDrop(*args, **kw):
5564 return FileDropTarget.OnDrop(*args, **kw)
5565 base_OnDrop = wx._deprecated(base_OnDrop,
5566 "Please use FileDropTarget.OnDrop instead.")
5567
5568 def base_OnData(*args, **kw):
5569 return FileDropTarget.OnData(*args, **kw)
5570 base_OnData = wx._deprecated(base_OnData,
5571 "Please use FileDropTarget.OnData instead.")
d55e5bfc 5572
2131d850 5573_misc_.FileDropTarget_swigregister(FileDropTarget)
d55e5bfc
RD
5574
5575#---------------------------------------------------------------------------
5576
5577class Clipboard(_core.Object):
5578 """
c24da6d6
RD
5579 wx.Clipboard represents the system clipboard and provides methods to
5580 copy data to it or paste data from it. Normally, you should only use
5581 ``wx.TheClipboard`` which is a reference to a global wx.Clipboard
5582 instance.
5583
5584 Call ``wx.TheClipboard``'s `Open` method to get ownership of the
5585 clipboard. If this operation returns True, you now own the
5586 clipboard. Call `SetData` to put data on the clipboard, or `GetData`
5587 to retrieve data from the clipboard. Call `Close` to close the
5588 clipboard and relinquish ownership. You should keep the clipboard open
5589 only momentarily.
d55e5bfc 5590
c24da6d6 5591 :see: `wx.DataObject`
d55e5bfc
RD
5592
5593 """
554f62e9
RD
5594 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5595 __repr__ = _swig_repr
5596 def __init__(self, *args, **kwargs):
d55e5bfc 5597 """__init__(self) -> Clipboard"""
554f62e9
RD
5598 _misc_.Clipboard_swiginit(self,_misc_.new_Clipboard(*args, **kwargs))
5599 __swig_destroy__ = _misc_.delete_Clipboard
5600 __del__ = lambda self : None;
d55e5bfc
RD
5601 def Open(*args, **kwargs):
5602 """
5603 Open(self) -> bool
5604
c24da6d6
RD
5605 Call this function to open the clipboard before calling SetData and
5606 GetData. Call Close when you have finished with the clipboard. You
5607 should keep the clipboard open for only a very short time. Returns
5608 True on success.
d55e5bfc
RD
5609 """
5610 return _misc_.Clipboard_Open(*args, **kwargs)
5611
5612 def Close(*args, **kwargs):
5613 """
5614 Close(self)
5615
5616 Closes the clipboard.
5617 """
5618 return _misc_.Clipboard_Close(*args, **kwargs)
5619
5620 def IsOpened(*args, **kwargs):
5621 """
5622 IsOpened(self) -> bool
5623
5624 Query whether the clipboard is opened
5625 """
5626 return _misc_.Clipboard_IsOpened(*args, **kwargs)
5627
5628 def AddData(*args, **kwargs):
5629 """
5630 AddData(self, DataObject data) -> bool
5631
c24da6d6
RD
5632 Call this function to add the data object to the clipboard. You may
5633 call this function repeatedly after having cleared the clipboard.
d55e5bfc
RD
5634 After this function has been called, the clipboard owns the data, so
5635 do not delete the data explicitly.
c24da6d6
RD
5636
5637 :see: `wx.DataObject`
d55e5bfc
RD
5638 """
5639 return _misc_.Clipboard_AddData(*args, **kwargs)
5640
5641 def SetData(*args, **kwargs):
5642 """
5643 SetData(self, DataObject data) -> bool
5644
c24da6d6
RD
5645 Set the clipboard data, this is the same as `Clear` followed by
5646 `AddData`.
5647
5648 :see: `wx.DataObject`
d55e5bfc
RD
5649 """
5650 return _misc_.Clipboard_SetData(*args, **kwargs)
5651
5652 def IsSupported(*args, **kwargs):
5653 """
5654 IsSupported(self, DataFormat format) -> bool
5655
5656 Returns True if the given format is available in the data object(s) on
5657 the clipboard.
5658 """
5659 return _misc_.Clipboard_IsSupported(*args, **kwargs)
5660
5661 def GetData(*args, **kwargs):
5662 """
5663 GetData(self, DataObject data) -> bool
5664
c24da6d6
RD
5665 Call this function to fill data with data on the clipboard, if
5666 available in the required format. Returns true on success.
d55e5bfc
RD
5667 """
5668 return _misc_.Clipboard_GetData(*args, **kwargs)
5669
5670 def Clear(*args, **kwargs):
5671 """
5672 Clear(self)
5673
c24da6d6 5674 Clears data from the clipboard object and also the system's clipboard
d55e5bfc
RD
5675 if possible.
5676 """
5677 return _misc_.Clipboard_Clear(*args, **kwargs)
5678
5679 def Flush(*args, **kwargs):
5680 """
5681 Flush(self) -> bool
5682
5683 Flushes the clipboard: this means that the data which is currently on
c24da6d6
RD
5684 clipboard will stay available even after the application exits,
5685 possibly eating memory, otherwise the clipboard will be emptied on
5686 exit. Returns False if the operation is unsuccesful for any reason.
d55e5bfc
RD
5687 """
5688 return _misc_.Clipboard_Flush(*args, **kwargs)
5689
5690 def UsePrimarySelection(*args, **kwargs):
5691 """
5692 UsePrimarySelection(self, bool primary=True)
5693
ddeca22c
RD
5694 On platforms supporting it (the X11 based platforms), selects the so
5695 called PRIMARY SELECTION as the clipboard as opposed to the normal
5696 clipboard, if primary is True. On other platforms all clipboard
5697 operations fail when using the primary selection. This allows code
5698 supporting the primary selection to be written without ill effects on
5699 the other platforms.
d55e5bfc
RD
5700 """
5701 return _misc_.Clipboard_UsePrimarySelection(*args, **kwargs)
5702
ddeca22c
RD
5703 def IsUsingPrimarySelection(*args, **kwargs):
5704 """
5705 IsUsingPrimarySelection(self) -> bool
5706
5707 Return true if we're using primary selection
5708 """
5709 return _misc_.Clipboard_IsUsingPrimarySelection(*args, **kwargs)
5710
a001823c
RD
5711 def Get(*args, **kwargs):
5712 """
5713 Get() -> Clipboard
5714
5715 Returns global instance (wxTheClipboard) of the object.
5716 """
5717 return _misc_.Clipboard_Get(*args, **kwargs)
5718
5719 Get = staticmethod(Get)
2131d850 5720_misc_.Clipboard_swigregister(Clipboard)
d55e5bfc 5721
554f62e9
RD
5722def Clipboard_Get(*args):
5723 """
a001823c
RD
5724 Clipboard_Get() -> Clipboard
5725
5726 Returns global instance (wxTheClipboard) of the object.
5727 """
554f62e9 5728 return _misc_.Clipboard_Get(*args)
a001823c
RD
5729
5730class _wxPyDelayedInitWrapper(object):
5731 def __init__(self, initfunc, *args, **kwargs):
5732 self._initfunc = initfunc
5733 self._args = args
5734 self._kwargs = kwargs
5735 self._instance = None
5736 def _checkInstance(self):
5737 if self._instance is None:
9d7dfdff
RD
5738 if wx.GetApp():
5739 self._instance = self._initfunc(*self._args, **self._kwargs)
a001823c
RD
5740 def __getattr__(self, name):
5741 self._checkInstance()
5742 return getattr(self._instance, name)
5743 def __repr__(self):
5744 self._checkInstance()
5745 return repr(self._instance)
5746TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
5747
d55e5bfc
RD
5748class ClipboardLocker(object):
5749 """
c24da6d6
RD
5750 A helpful class for opening the clipboard and automatically
5751 closing it when the locker is destroyed.
d55e5bfc 5752 """
554f62e9
RD
5753 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5754 __repr__ = _swig_repr
5755 def __init__(self, *args, **kwargs):
d55e5bfc
RD
5756 """
5757 __init__(self, Clipboard clipboard=None) -> ClipboardLocker
5758
c24da6d6
RD
5759 A helpful class for opening the clipboard and automatically
5760 closing it when the locker is destroyed.
d55e5bfc 5761 """
554f62e9
RD
5762 _misc_.ClipboardLocker_swiginit(self,_misc_.new_ClipboardLocker(*args, **kwargs))
5763 __swig_destroy__ = _misc_.delete_ClipboardLocker
5764 __del__ = lambda self : None;
d55e5bfc
RD
5765 def __nonzero__(*args, **kwargs):
5766 """
5767 __nonzero__(self) -> bool
5768
5769 A ClipboardLocker instance evaluates to True if the clipboard was
5770 successfully opened.
5771 """
5772 return _misc_.ClipboardLocker___nonzero__(*args, **kwargs)
5773
2131d850 5774_misc_.ClipboardLocker_swigregister(ClipboardLocker)
d55e5bfc
RD
5775
5776#---------------------------------------------------------------------------
5777
5778class VideoMode(object):
5779 """A simple struct containing video mode parameters for a display"""
554f62e9
RD
5780 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5781 __repr__ = _swig_repr
5782 def __init__(self, *args, **kwargs):
d55e5bfc
RD
5783 """
5784 __init__(self, int width=0, int height=0, int depth=0, int freq=0) -> VideoMode
5785
5786 A simple struct containing video mode parameters for a display
5787 """
554f62e9
RD
5788 _misc_.VideoMode_swiginit(self,_misc_.new_VideoMode(*args, **kwargs))
5789 __swig_destroy__ = _misc_.delete_VideoMode
5790 __del__ = lambda self : None;
d55e5bfc
RD
5791 def Matches(*args, **kwargs):
5792 """
5793 Matches(self, VideoMode other) -> bool
5794
f52cbe90
RD
5795 Returns True if this mode matches the other one in the sense that all
5796 non-zero fields of the other mode have the same value in this
d55e5bfc
RD
5797 one (except for refresh which is allowed to have a greater value)
5798 """
5799 return _misc_.VideoMode_Matches(*args, **kwargs)
5800
5801 def GetWidth(*args, **kwargs):
5802 """
5803 GetWidth(self) -> int
5804
79fccf9d 5805 Returns the screen width in pixels (e.g. 640*480), 0 means unspecified
d55e5bfc
RD
5806 """
5807 return _misc_.VideoMode_GetWidth(*args, **kwargs)
5808
5809 def GetHeight(*args, **kwargs):
5810 """
5811 GetHeight(self) -> int
5812
f52cbe90 5813 Returns the screen height in pixels (e.g. 640*480), 0 means unspecified
d55e5bfc
RD
5814 """
5815 return _misc_.VideoMode_GetHeight(*args, **kwargs)
5816
5817 def GetDepth(*args, **kwargs):
5818 """
5819 GetDepth(self) -> int
5820
79fccf9d
RD
5821 Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
5822 means unspecified/known
d55e5bfc
RD
5823 """
5824 return _misc_.VideoMode_GetDepth(*args, **kwargs)
5825
5826 def IsOk(*args, **kwargs):
5827 """
5828 IsOk(self) -> bool
5829
5830 returns true if the object has been initialized
5831 """
5832 return _misc_.VideoMode_IsOk(*args, **kwargs)
5833
5834 def __nonzero__(self): return self.IsOk()
5835 def __eq__(*args, **kwargs):
5836 """__eq__(self, VideoMode other) -> bool"""
5837 return _misc_.VideoMode___eq__(*args, **kwargs)
5838
5839 def __ne__(*args, **kwargs):
5840 """__ne__(self, VideoMode other) -> bool"""
5841 return _misc_.VideoMode___ne__(*args, **kwargs)
5842
5843 w = property(_misc_.VideoMode_w_get, _misc_.VideoMode_w_set)
5844 h = property(_misc_.VideoMode_h_get, _misc_.VideoMode_h_set)
5845 bpp = property(_misc_.VideoMode_bpp_get, _misc_.VideoMode_bpp_set)
5846 refresh = property(_misc_.VideoMode_refresh_get, _misc_.VideoMode_refresh_set)
dba7934c
RD
5847 Depth = property(GetDepth,doc="See `GetDepth`")
5848 Height = property(GetHeight,doc="See `GetHeight`")
5849 Width = property(GetWidth,doc="See `GetWidth`")
2131d850 5850_misc_.VideoMode_swigregister(VideoMode)
d55e5bfc
RD
5851
5852class Display(object):
5853 """Represents a display/monitor attached to the system"""
554f62e9
RD
5854 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5855 __repr__ = _swig_repr
5856 def __init__(self, *args, **kwargs):
d55e5bfc 5857 """
c2829a8f 5858 __init__(self, unsigned int index=0) -> Display
d55e5bfc 5859
79fccf9d
RD
5860 Set up a Display instance with the specified display. The displays
5861 are numbered from 0 to GetCount() - 1, 0 is always the primary display
5862 and the only one which is always supported
d55e5bfc 5863 """
554f62e9
RD
5864 _misc_.Display_swiginit(self,_misc_.new_Display(*args, **kwargs))
5865 __swig_destroy__ = _misc_.delete_Display
5866 __del__ = lambda self : None;
d55e5bfc
RD
5867 def GetCount(*args, **kwargs):
5868 """
c2829a8f 5869 GetCount() -> unsigned int
d55e5bfc
RD
5870
5871 Return the number of available displays.
5872 """
5873 return _misc_.Display_GetCount(*args, **kwargs)
5874
5875 GetCount = staticmethod(GetCount)
5876 def GetFromPoint(*args, **kwargs):
5877 """
c24da6d6 5878 GetFromPoint(Point pt) -> int
d55e5bfc 5879
79fccf9d
RD
5880 Find the display where the given point lies, return wx.NOT_FOUND if it
5881 doesn't belong to any display
d55e5bfc
RD
5882 """
5883 return _misc_.Display_GetFromPoint(*args, **kwargs)
5884
5885 GetFromPoint = staticmethod(GetFromPoint)
5886 def GetFromWindow(*args, **kwargs):
5887 """
c24da6d6 5888 GetFromWindow(Window window) -> int
d55e5bfc 5889
79fccf9d
RD
5890 Find the display where the given window lies, return wx.NOT_FOUND if
5891 it is not shown at all.
d55e5bfc
RD
5892 """
5893 return _misc_.Display_GetFromWindow(*args, **kwargs)
5894
5895 GetFromWindow = staticmethod(GetFromWindow)
5896 def IsOk(*args, **kwargs):
5897 """
5898 IsOk(self) -> bool
5899
5900 Return true if the object was initialized successfully
5901 """
5902 return _misc_.Display_IsOk(*args, **kwargs)
5903
5904 def __nonzero__(self): return self.IsOk()
5905 def GetGeometry(*args, **kwargs):
5906 """
5907 GetGeometry(self) -> Rect
5908
79fccf9d
RD
5909 Returns the bounding rectangle of the display whose index was passed
5910 to the constructor.
d55e5bfc
RD
5911 """
5912 return _misc_.Display_GetGeometry(*args, **kwargs)
5913
f52cbe90
RD
5914 def GetClientArea(*args, **kwargs):
5915 """
5916 GetClientArea(self) -> Rect
5917
5918 Returns the bounding rectangle the client area of the display,
5919 i.e., without taskbars and such.
5920 """
5921 return _misc_.Display_GetClientArea(*args, **kwargs)
5922
d55e5bfc
RD
5923 def GetName(*args, **kwargs):
5924 """
5925 GetName(self) -> String
5926
5927 Returns the display's name. A name is not available on all platforms.
5928 """
5929 return _misc_.Display_GetName(*args, **kwargs)
5930
5931 def IsPrimary(*args, **kwargs):
5932 """
5933 IsPrimary(self) -> bool
5934
f52cbe90 5935 Returns True if the display is the primary display. The primary
d55e5bfc
RD
5936 display is the one whose index is 0.
5937 """
5938 return _misc_.Display_IsPrimary(*args, **kwargs)
5939
5940 def GetModes(*args, **kwargs):
5941 """
5942 GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]
5943
79fccf9d
RD
5944 Enumerate all video modes supported by this display matching the given
5945 one (in the sense of VideoMode.Match()).
d55e5bfc 5946
79fccf9d
RD
5947 As any mode matches the default value of the argument and there is
5948 always at least one video mode supported by display, the returned
5949 array is only empty for the default value of the argument if this
5950 function is not supported at all on this platform.
d55e5bfc
RD
5951 """
5952 return _misc_.Display_GetModes(*args, **kwargs)
5953
5954 def GetCurrentMode(*args, **kwargs):
5955 """
5956 GetCurrentMode(self) -> VideoMode
5957
5958 Get the current video mode.
5959 """
5960 return _misc_.Display_GetCurrentMode(*args, **kwargs)
5961
5962 def ChangeMode(*args, **kwargs):
5963 """
5964 ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool
5965
03837c5c
RD
5966 Changes the video mode of this display to the mode specified in the
5967 mode parameter.
5968
5969 If wx.DefaultVideoMode is passed in as the mode parameter, the defined
5970 behaviour is that wx.Display will reset the video mode to the default
5971 mode used by the display. On Windows, the behavior is normal.
5972 However, there are differences on other platforms. On Unix variations
5973 using X11 extensions it should behave as defined, but some
5974 irregularities may occur.
5975
5976 On wxMac passing in wx.DefaultVideoMode as the mode parameter does
5977 nothing. This happens because Carbon no longer has access to
5978 DMUseScreenPrefs, an undocumented function that changed the video mode
5979 to the system default by using the system's 'scrn' resource.
5980
5981 Returns True if succeeded, False otherwise
d55e5bfc
RD
5982 """
5983 return _misc_.Display_ChangeMode(*args, **kwargs)
5984
5985 def ResetMode(*args, **kwargs):
5986 """
5987 ResetMode(self)
5988
5989 Restore the default video mode (just a more readable synonym)
5990 """
5991 return _misc_.Display_ResetMode(*args, **kwargs)
5992
226118fc
RD
5993 ClientArea = property(GetClientArea,doc="See `GetClientArea`")
5994 CurrentMode = property(GetCurrentMode,doc="See `GetCurrentMode`")
5995 Geometry = property(GetGeometry,doc="See `GetGeometry`")
5996 Modes = property(GetModes,doc="See `GetModes`")
5997 Name = property(GetName,doc="See `GetName`")
2131d850 5998_misc_.Display_swigregister(Display)
d55e5bfc
RD
5999DefaultVideoMode = cvar.DefaultVideoMode
6000
554f62e9
RD
6001def Display_GetCount(*args):
6002 """
c2829a8f 6003 Display_GetCount() -> unsigned int
d55e5bfc
RD
6004
6005 Return the number of available displays.
6006 """
554f62e9 6007 return _misc_.Display_GetCount(*args)
d55e5bfc
RD
6008
6009def Display_GetFromPoint(*args, **kwargs):
554f62e9 6010 """
d55e5bfc
RD
6011 Display_GetFromPoint(Point pt) -> int
6012
79fccf9d
RD
6013 Find the display where the given point lies, return wx.NOT_FOUND if it
6014 doesn't belong to any display
d55e5bfc 6015 """
554f62e9 6016 return _misc_.Display_GetFromPoint(*args, **kwargs)
d55e5bfc
RD
6017
6018def Display_GetFromWindow(*args, **kwargs):
554f62e9 6019 """
d55e5bfc
RD
6020 Display_GetFromWindow(Window window) -> int
6021
79fccf9d
RD
6022 Find the display where the given window lies, return wx.NOT_FOUND if
6023 it is not shown at all.
d55e5bfc 6024 """
554f62e9 6025 return _misc_.Display_GetFromWindow(*args, **kwargs)
d55e5bfc 6026
c1cb24a4
RD
6027#---------------------------------------------------------------------------
6028
6029class StandardPaths(object):
6030 """
e9d6f3a4
RD
6031 wx.StandardPaths returns standard locations in the file system and
6032 should be used by programs to find their data files in a portable way.
c1cb24a4
RD
6033
6034 In the description of the methods below, the example return values are
6035 given for the Unix, Windows and Mac OS X systems, however please note
e9d6f3a4
RD
6036 that these are just examples and the actual values may differ. For
6037 example, under Windows the system administrator may change the
c1cb24a4
RD
6038 standard directories locations, i.e. the Windows directory may be
6039 named W:\Win2003 instead of the default C:\Windows.
6040
6041 The strings appname and username should be replaced with the value
6042 returned by `wx.App.GetAppName` and the name of the currently logged
6043 in user, respectively. The string prefix is only used under Unix and
6044 is /usr/local by default but may be changed using `SetInstallPrefix`.
6045
6046 The directories returned by the methods of this class may or may not
6047 exist. If they don't exist, it's up to the caller to create them,
e9d6f3a4 6048 wx.StandardPaths doesn't do it.
c1cb24a4
RD
6049
6050 Finally note that these functions only work with standardly packaged
6051 applications. I.e. under Unix you should follow the standard
6052 installation conventions and under Mac you should create your
6053 application bundle according to the Apple guidelines. Again, this
6054 class doesn't help you to do it.
6055 """
554f62e9
RD
6056 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6057 def __init__(self): raise AttributeError, "No constructor defined"
6058 __repr__ = _swig_repr
e9d6f3a4
RD
6059 ResourceCat_None = _misc_.StandardPaths_ResourceCat_None
6060 ResourceCat_Messages = _misc_.StandardPaths_ResourceCat_Messages
6061 ResourceCat_Max = _misc_.StandardPaths_ResourceCat_Max
c1cb24a4
RD
6062 def Get(*args, **kwargs):
6063 """
6064 Get() -> StandardPaths
6065
8fb0e70a 6066 Return the global standard paths singleton
c1cb24a4
RD
6067 """
6068 return _misc_.StandardPaths_Get(*args, **kwargs)
6069
6070 Get = staticmethod(Get)
428947f3
RD
6071 def GetExecutablePath(*args, **kwargs):
6072 """
6073 GetExecutablePath(self) -> String
6074
6075 Return the path (directory+filename) of the running executable or an
6076 empty string if it couldn't be determined. The path is returned as an
6077 absolute path whenever possible.
6078 """
6079 return _misc_.StandardPaths_GetExecutablePath(*args, **kwargs)
6080
c1cb24a4
RD
6081 def GetConfigDir(*args, **kwargs):
6082 """
6083 GetConfigDir(self) -> String
6084
6085 Return the directory with system config files: /etc under Unix,
8fb0e70a 6086 'c:\Documents and Settings\All Users\Application Data' under Windows,
c1cb24a4
RD
6087 /Library/Preferences for Mac
6088 """
6089 return _misc_.StandardPaths_GetConfigDir(*args, **kwargs)
6090
6091 def GetUserConfigDir(*args, **kwargs):
6092 """
6093 GetUserConfigDir(self) -> String
6094
6095 Return the directory for the user config files: $HOME under Unix,
8fb0e70a 6096 'c:\Documents and Settings\username' under Windows, and
c1cb24a4
RD
6097 ~/Library/Preferences under Mac
6098
6099 Only use this if you have a single file to put there, otherwise
6100 `GetUserDataDir` is more appropriate
6101 """
6102 return _misc_.StandardPaths_GetUserConfigDir(*args, **kwargs)
6103
6104 def GetDataDir(*args, **kwargs):
6105 """
6106 GetDataDir(self) -> String
6107
6108 Return the location of the application's global, (i.e. not
6109 user-specific,) data files: prefix/share/appname under Unix,
8fb0e70a 6110 'c:\Program Files\appname' under Windows,
c1cb24a4
RD
6111 appname.app/Contents/SharedSupport app bundle directory under Mac.
6112 """
6113 return _misc_.StandardPaths_GetDataDir(*args, **kwargs)
6114
6115 def GetLocalDataDir(*args, **kwargs):
6116 """
6117 GetLocalDataDir(self) -> String
6118
6119 Return the location for application data files which are
6120 host-specific. Same as `GetDataDir` except under Unix where it is
6121 /etc/appname
6122 """
6123 return _misc_.StandardPaths_GetLocalDataDir(*args, **kwargs)
6124
6125 def GetUserDataDir(*args, **kwargs):
6126 """
6127 GetUserDataDir(self) -> String
6128
6129 Return the directory for the user-dependent application data files:
6130 $HOME/.appname under Unix, c:\Documents and
8fb0e70a 6131 Settings\username\Application Data\appname under Windows and
c1cb24a4
RD
6132 ~/Library/Application Support/appname under Mac
6133 """
6134 return _misc_.StandardPaths_GetUserDataDir(*args, **kwargs)
6135
6136 def GetUserLocalDataDir(*args, **kwargs):
6137 """
6138 GetUserLocalDataDir(self) -> String
6139
6140 Return the directory for user data files which shouldn't be shared
6141 with the other machines
6142
6143 Same as `GetUserDataDir` for all platforms except Windows where it is
8fb0e70a 6144 the 'Local Settings\Application Data\appname' directory.
c1cb24a4
RD
6145 """
6146 return _misc_.StandardPaths_GetUserLocalDataDir(*args, **kwargs)
6147
6148 def GetPluginsDir(*args, **kwargs):
6149 """
6150 GetPluginsDir(self) -> String
6151
6152 Return the directory where the loadable modules (plugins) live:
6153 prefix/lib/appname under Unix, program directory under Windows and
6154 Contents/Plugins app bundle subdirectory under Mac
6155 """
6156 return _misc_.StandardPaths_GetPluginsDir(*args, **kwargs)
6157
e9d6f3a4
RD
6158 def GetResourcesDir(*args, **kwargs):
6159 """
6160 GetResourcesDir(self) -> String
6161
6162 Get resources directory. Resources are auxiliary files used by the
6163 application and include things like image and sound files.
6164
6165 Same as `GetDataDir` for all platforms except Mac where it returns
6166 Contents/Resources subdirectory of the app bundle.
6167 """
6168 return _misc_.StandardPaths_GetResourcesDir(*args, **kwargs)
6169
6170 def GetLocalizedResourcesDir(*args, **kwargs):
6171 """
6172 GetLocalizedResourcesDir(self, String lang, int category=ResourceCat_None) -> String
6173
6174 Get localized resources directory containing the resource files of the
6175 specified category for the given language.
6176
6177 In general this is just GetResourcesDir()/lang under Windows and Unix
6178 and GetResourcesDir()/lang.lproj under Mac but is something quite
6179 different under Unix for the message catalog category (namely the
6180 standard prefix/share/locale/lang/LC_MESSAGES.)
6181 """
6182 return _misc_.StandardPaths_GetLocalizedResourcesDir(*args, **kwargs)
6183
50efceee
RD
6184 def GetDocumentsDir(*args, **kwargs):
6185 """
6186 GetDocumentsDir(self) -> String
6187
6188 Return the Documents directory for the current user.
6189
6190 C:\Documents and Settings\username\Documents under Windows,
6191 $HOME under Unix and ~/Documents under Mac
6192 """
6193 return _misc_.StandardPaths_GetDocumentsDir(*args, **kwargs)
6194
ae8635b6
RD
6195 def GetTempDir(*args, **kwargs):
6196 """
6197 GetTempDir(self) -> String
6198
6199 Return the user's directory for temporary files.
6200 """
6201 return _misc_.StandardPaths_GetTempDir(*args, **kwargs)
6202
c1cb24a4 6203 def SetInstallPrefix(*args, **kwargs):
828cff19
RD
6204 """
6205 SetInstallPrefix(self, String prefix)
6206
6207 Set the program installation directory which is /usr/local by default.
6208 This value will be used by other methods such as `GetDataDir` and
6209 `GetPluginsDir` as the prefix for what they return. (This function
6210 only has meaning on Unix systems.)
6211 """
c1cb24a4
RD
6212 return _misc_.StandardPaths_SetInstallPrefix(*args, **kwargs)
6213
6214 def GetInstallPrefix(*args, **kwargs):
828cff19
RD
6215 """
6216 GetInstallPrefix(self) -> String
6217
6218 Get the program installation prefix. The default is the prefix where
6219 Python is installed. (This function only has meaning on Unix systems.)
6220 """
c1cb24a4
RD
6221 return _misc_.StandardPaths_GetInstallPrefix(*args, **kwargs)
6222
2131d850 6223_misc_.StandardPaths_swigregister(StandardPaths)
c1cb24a4 6224
554f62e9
RD
6225def StandardPaths_Get(*args):
6226 """
c1cb24a4
RD
6227 StandardPaths_Get() -> StandardPaths
6228
8fb0e70a 6229 Return the global standard paths singleton
c1cb24a4 6230 """
554f62e9 6231 return _misc_.StandardPaths_Get(*args)
c1cb24a4 6232
704eda0c
RD
6233#---------------------------------------------------------------------------
6234
6235POWER_SOCKET = _misc_.POWER_SOCKET
6236POWER_BATTERY = _misc_.POWER_BATTERY
6237POWER_UNKNOWN = _misc_.POWER_UNKNOWN
6238BATTERY_NORMAL_STATE = _misc_.BATTERY_NORMAL_STATE
6239BATTERY_LOW_STATE = _misc_.BATTERY_LOW_STATE
6240BATTERY_CRITICAL_STATE = _misc_.BATTERY_CRITICAL_STATE
6241BATTERY_SHUTDOWN_STATE = _misc_.BATTERY_SHUTDOWN_STATE
6242BATTERY_UNKNOWN_STATE = _misc_.BATTERY_UNKNOWN_STATE
6243class PowerEvent(_core.Event):
6244 """
6245 wx.PowerEvent is generated when the system online status changes.
6246 Currently this is only implemented for Windows.
6247 """
6248 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6249 __repr__ = _swig_repr
6250 def __init__(self, *args, **kwargs):
6251 """
6252 __init__(self, EventType evtType) -> PowerEvent
6253
6254 wx.PowerEvent is generated when the system online status changes.
6255 Currently this is only implemented for Windows.
6256 """
6257 _misc_.PowerEvent_swiginit(self,_misc_.new_PowerEvent(*args, **kwargs))
6258 def Veto(*args, **kwargs):
6259 """Veto(self)"""
6260 return _misc_.PowerEvent_Veto(*args, **kwargs)
6261
6262 def IsVetoed(*args, **kwargs):
6263 """IsVetoed(self) -> bool"""
6264 return _misc_.PowerEvent_IsVetoed(*args, **kwargs)
6265
6266_misc_.PowerEvent_swigregister(PowerEvent)
6267
6268wxEVT_POWER_SUSPENDING = _misc_.wxEVT_POWER_SUSPENDING
6269wxEVT_POWER_SUSPENDED = _misc_.wxEVT_POWER_SUSPENDED
6270wxEVT_POWER_SUSPEND_CANCEL = _misc_.wxEVT_POWER_SUSPEND_CANCEL
6271wxEVT_POWER_RESUME = _misc_.wxEVT_POWER_RESUME
6272EVT_POWER_SUSPENDING = wx.PyEventBinder( wxEVT_POWER_SUSPENDING , 1 )
6273EVT_POWER_SUSPENDED = wx.PyEventBinder( wxEVT_POWER_SUSPENDED , 1 )
6274EVT_POWER_SUSPEND_CANCEL = wx.PyEventBinder( wxEVT_POWER_SUSPEND_CANCEL , 1 )
6275EVT_POWER_RESUME = wx.PyEventBinder( wxEVT_POWER_RESUME , 1 )
6276
6277
6278def GetPowerType(*args):
6279 """
6280 GetPowerType() -> int
6281
6282 return the current system power state: online or offline
6283 """
6284 return _misc_.GetPowerType(*args)
6285
6286def GetBatteryState(*args):
6287 """
6288 GetBatteryState() -> int
6289
6290 return approximate battery state
6291 """
6292 return _misc_.GetBatteryState(*args)
b39fe951
RD
6293#---------------------------------------------------------------------------
6294
6295class AboutDialogInfo(object):
6296 """
f1b46404
RD
6297 `wx.AboutDialogInfo` contains information to be shown in the standard
6298 About dialog displayed by the `wx.AboutBox` function. This class
6299 contains the general information about the program, such as its name,
6300 version, copyright and so on, as well as lists of the program
6301 developers, documentation writers, artists and translators.
b39fe951
RD
6302
6303 While all the main platforms have a native implementation of the about
6304 dialog, they are often more limited than the generic version provided
6305 by wxWidgets and so the generic version is used if
6306 `wx.AboutDialogInfo` has any fields not supported by the native
6307 version. Currently GTK+ version supports all the possible fields
6308 natively but MSW and Mac versions don't support URLs, licence text nor
6309 custom icons in the about dialog and if either of those is used,
6310 wxAboutBox() will automatically use the generic version so you should
6311 avoid specifying these fields to achieve more native look and feel.
6312
6313 """
6314 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
6315 __repr__ = _swig_repr
6316 def __init__(self, *args, **kwargs):
6317 """
6318 __init__(self) -> AboutDialogInfo
6319
f1b46404
RD
6320 `wx.AboutDialogInfo` contains information to be shown in the standard
6321 About dialog displayed by the `wx.AboutBox` function. This class
6322 contains the general information about the program, such as its name,
6323 version, copyright and so on, as well as lists of the program
6324 developers, documentation writers, artists and translators.
b39fe951
RD
6325
6326 While all the main platforms have a native implementation of the about
6327 dialog, they are often more limited than the generic version provided
6328 by wxWidgets and so the generic version is used if
6329 `wx.AboutDialogInfo` has any fields not supported by the native
6330 version. Currently GTK+ version supports all the possible fields
6331 natively but MSW and Mac versions don't support URLs, licence text nor
6332 custom icons in the about dialog and if either of those is used,
6333 wxAboutBox() will automatically use the generic version so you should
6334 avoid specifying these fields to achieve more native look and feel.
6335
6336 """
6337 _misc_.AboutDialogInfo_swiginit(self,_misc_.new_AboutDialogInfo(*args, **kwargs))
6338 __swig_destroy__ = _misc_.delete_AboutDialogInfo
6339 __del__ = lambda self : None;
6340 def SetName(*args, **kwargs):
6341 """
6342 SetName(self, String name)
6343
6344 Set the name of the program. If this method is not called, the string
6345 returned by `wx.App.GetAppName` will be shown in the dialog.
6346 """
6347 return _misc_.AboutDialogInfo_SetName(*args, **kwargs)
6348
6349 def GetName(*args, **kwargs):
6350 """
6351 GetName(self) -> String
6352
6353 Returns the program name.
6354 """
6355 return _misc_.AboutDialogInfo_GetName(*args, **kwargs)
6356
6357 Name = property(GetName,SetName)
6358 def SetVersion(*args, **kwargs):
6359 """
6360 SetVersion(self, String version)
6361
6362 Set the version of the program. The version is in free format,
6363 i.e. not necessarily in the x.y.z form but it shouldn't contain the
6364 "version" word.
6365 """
6366 return _misc_.AboutDialogInfo_SetVersion(*args, **kwargs)
6367
6368 def HasVersion(*args, **kwargs):
6369 """
6370 HasVersion(self) -> bool
6371
6372 Returns ``True`` if the version property has been set.
6373 """
6374 return _misc_.AboutDialogInfo_HasVersion(*args, **kwargs)
6375
6376 def GetVersion(*args, **kwargs):
6377 """
6378 GetVersion(self) -> String
6379
6380 Returns the version value.
6381 """
6382 return _misc_.AboutDialogInfo_GetVersion(*args, **kwargs)
6383
6384 Version = property(GetVersion,SetVersion)
6385 def SetDescription(*args, **kwargs):
6386 """
6387 SetDescription(self, String desc)
6388
6389 Set brief, but possibly multiline, description of the program.
6390 """
6391 return _misc_.AboutDialogInfo_SetDescription(*args, **kwargs)
6392
6393 def HasDescription(*args, **kwargs):
6394 """
6395 HasDescription(self) -> bool
6396
6397 Returns ``True`` if the description property has been set.
6398 """
6399 return _misc_.AboutDialogInfo_HasDescription(*args, **kwargs)
6400
6401 def GetDescription(*args, **kwargs):
6402 """
6403 GetDescription(self) -> String
6404
6405 Returns the description value.
6406 """
6407 return _misc_.AboutDialogInfo_GetDescription(*args, **kwargs)
6408
6409 Description = property(GetDescription,SetDescription)
6410 def SetCopyright(*args, **kwargs):
6411 """
6412 SetCopyright(self, String copyright)
6413
6414 Set the short string containing the program copyright
6415 information. Notice that any occurrences of "(C)" in ``copyright``
6416 will be replaced by the copyright symbol (circled C) automatically,
6417 which means that you can avoid using this symbol in the program source
6418 code which can be problematic.
6419 """
6420 return _misc_.AboutDialogInfo_SetCopyright(*args, **kwargs)
6421
6422 def HasCopyright(*args, **kwargs):
6423 """
6424 HasCopyright(self) -> bool
6425
6426 Returns ``True`` if the copyright property has been set.
6427 """
6428 return _misc_.AboutDialogInfo_HasCopyright(*args, **kwargs)
6429
6430 def GetCopyright(*args, **kwargs):
6431 """
6432 GetCopyright(self) -> String
6433
6434 Returns the copyright value.
6435 """
6436 return _misc_.AboutDialogInfo_GetCopyright(*args, **kwargs)
6437
6438 Copyright = property(GetCopyright,SetCopyright)
6439 def SetLicence(*args, **kwargs):
6440 """
6441 SetLicence(self, String licence)
6442
6443 Set the long, multiline string containing the text of the program
6444 licence.
6445
6446 Only GTK+ version supports showing the licence text in the native
6447 about dialog currently so the generic version will be used under all
6448 the other platforms if this method is called. To preserve the native
6449 look and feel it is advised that you do not call this method but
6450 provide a separate menu item in the "Help" menu for displaying the
6451 text of your program licence.
6452
6453 """
6454 return _misc_.AboutDialogInfo_SetLicence(*args, **kwargs)
6455
6456 def SetLicense(*args, **kwargs):
6457 """
6458 SetLicense(self, String licence)
6459
6460 This is the same as `SetLicence`.
6461 """
6462 return _misc_.AboutDialogInfo_SetLicense(*args, **kwargs)
6463
6464 def HasLicence(*args, **kwargs):
6465 """
6466 HasLicence(self) -> bool
6467
6468 Returns ``True`` if the licence property has been set.
6469 """
6470 return _misc_.AboutDialogInfo_HasLicence(*args, **kwargs)
6471
6472 def GetLicence(*args, **kwargs):
6473 """
6474 GetLicence(self) -> String
6475
6476 Returns the licence value.
6477 """
6478 return _misc_.AboutDialogInfo_GetLicence(*args, **kwargs)
6479
6480 Licence = property(GetLicence,SetLicence)
6481 License = Licence
6482 def SetIcon(*args, **kwargs):
6483 """
6484 SetIcon(self, Icon icon)
6485
6486 Set the icon to be shown in the dialog. By default the icon of the
6487 main frame will be shown if the native about dialog supports custom
6488 icons. If it doesn't but a valid icon is specified using this method,
6489 the generic about dialog is used instead so you should avoid calling
6490 this function for maximally native look and feel.
6491 """
6492 return _misc_.AboutDialogInfo_SetIcon(*args, **kwargs)
6493
6494 def HasIcon(*args, **kwargs):
6495 """
6496 HasIcon(self) -> bool
6497
6498 Returns ``True`` if the icon property has been set.
6499 """
6500 return _misc_.AboutDialogInfo_HasIcon(*args, **kwargs)
6501
6502 def GetIcon(*args, **kwargs):
6503 """
6504 GetIcon(self) -> Icon
6505
6506 Return the current icon value.
6507 """
6508 return _misc_.AboutDialogInfo_GetIcon(*args, **kwargs)
6509
6510 Icon = property(GetIcon,SetIcon)
6511 def _SetWebSite(*args, **kwargs):
6512 """_SetWebSite(self, String url, String desc=wxEmptyString)"""
6513 return _misc_.AboutDialogInfo__SetWebSite(*args, **kwargs)
6514
6515 def _GetWebSiteURL(*args, **kwargs):
6516 """_GetWebSiteURL(self) -> String"""
6517 return _misc_.AboutDialogInfo__GetWebSiteURL(*args, **kwargs)
6518
6519 def _GetWebSiteDescription(*args, **kwargs):
6520 """_GetWebSiteDescription(self) -> String"""
6521 return _misc_.AboutDialogInfo__GetWebSiteDescription(*args, **kwargs)
6522
6523 def HasWebSite(*args, **kwargs):
6524 """HasWebSite(self) -> bool"""
6525 return _misc_.AboutDialogInfo_HasWebSite(*args, **kwargs)
6526
6527 def SetWebSite(self, args):
6528 """
6529 SetWebSite(self, URL, [Description])
6530
6531 Set the web site property. The ``args`` parameter can
6532 either be a single string for the URL, to a 2-tuple of
6533 (URL, Description) strings.
6534 """
6535 if type(args) in [str, unicode]:
6536 self._SetWebSite(args)
6537 else:
6538 self._SetWebSite(args[0], args[1])
6539
6540 def GetWebSite(self):
6541 """
6542 GetWebSite(self) --> (URL, Description)
6543 """
6544 return (self._GetWebSiteURL(), self._GetWebSiteDescription())
6545
6546 WebSite = property(GetWebSite,SetWebSite)
6547 def SetDevelopers(*args, **kwargs):
6548 """
6549 SetDevelopers(self, list developers)
6550
6551 Set the list of the developers of the program.
6552 """
6553 return _misc_.AboutDialogInfo_SetDevelopers(*args, **kwargs)
6554
6555 def AddDeveloper(*args, **kwargs):
6556 """
6557 AddDeveloper(self, String developer)
6558
6559 Add a string to the list of developers.
6560 """
6561 return _misc_.AboutDialogInfo_AddDeveloper(*args, **kwargs)
6562
6563 def HasDevelopers(*args, **kwargs):
6564 """
6565 HasDevelopers(self) -> bool
6566
6567 Returns ``True if any developers have been set.
6568 """
6569 return _misc_.AboutDialogInfo_HasDevelopers(*args, **kwargs)
6570
6571 def GetDevelopers(*args, **kwargs):
6572 """
6573 GetDevelopers(self) --> list
6574
6575 Returns the list of developers.
6576 """
6577 return _misc_.AboutDialogInfo_GetDevelopers(*args, **kwargs)
6578
6579 Developers = property(GetDevelopers,SetDevelopers)
6580 def SetDocWriters(*args, **kwargs):
6581 """
6582 SetDocWriters(self, list docwriters)
6583
6584 Set the list of the documentation writers.
6585 """
6586 return _misc_.AboutDialogInfo_SetDocWriters(*args, **kwargs)
6587
6588 def AddDocWriter(*args, **kwargs):
6589 """
6590 AddDocWriter(self, String docwriter)
6591
6592 Add a string to the list of documentation writers.
6593 """
6594 return _misc_.AboutDialogInfo_AddDocWriter(*args, **kwargs)
6595
6596 def HasDocWriters(*args, **kwargs):
6597 """
6598 HasDocWriters(self) -> bool
6599
6600 Returns ``True if any documentation writers have been set.
6601 """
6602 return _misc_.AboutDialogInfo_HasDocWriters(*args, **kwargs)
6603
6604 def GetDocWriters(*args, **kwargs):
6605 """
6606 GetDocWriters(self) --> list
6607
6608 Returns the list of documentation writers.
6609 """
6610 return _misc_.AboutDialogInfo_GetDocWriters(*args, **kwargs)
6611
6612 DocWriters = property(GetDocWriters,SetDocWriters)
6613 def SetArtists(*args, **kwargs):
6614 """
6615 SetArtists(self, list artists)
6616
6617 Set the list of artists for the program.
6618 """
6619 return _misc_.AboutDialogInfo_SetArtists(*args, **kwargs)
6620
6621 def AddArtist(*args, **kwargs):
6622 """
6623 AddArtist(self, String artist)
6624
6625 Add a string to the list of artists.
6626 """
6627 return _misc_.AboutDialogInfo_AddArtist(*args, **kwargs)
6628
6629 def HasArtists(*args, **kwargs):
6630 """
6631 HasArtists(self) -> bool
6632
6633 Returns ``True`` if any artists have been set.
6634 """
6635 return _misc_.AboutDialogInfo_HasArtists(*args, **kwargs)
6636
6637 def GetArtists(*args, **kwargs):
6638 """
6639 GetArtists(self) --> list
6640
6641 Returns the list od artists.
6642 """
6643 return _misc_.AboutDialogInfo_GetArtists(*args, **kwargs)
6644
6645 Artists = property(GetArtists,SetArtists)
6646 def SetTranslators(*args, **kwargs):
6647 """
6648 SetTranslators(self, list translators)
6649
6650 Sets the list of program translators.
6651 """
6652 return _misc_.AboutDialogInfo_SetTranslators(*args, **kwargs)
6653
6654 def AddTranslator(*args, **kwargs):
6655 """
6656 AddTranslator(self, String translator)
6657
6658 Add a string to the list of translators.
6659 """
6660 return _misc_.AboutDialogInfo_AddTranslator(*args, **kwargs)
6661
6662 def HasTranslators(*args, **kwargs):
6663 """
6664 HasTranslators(self) -> bool
6665
6666 Returns ``True`` if any translators have been set.
6667 """
6668 return _misc_.AboutDialogInfo_HasTranslators(*args, **kwargs)
6669
6670 def GetTranslators(*args, **kwargs):
6671 """
6672 GetTranslators(self) --> list
6673
6674 Returns the list of program translators.
6675 """
6676 return _misc_.AboutDialogInfo_GetTranslators(*args, **kwargs)
6677
6678 Translators = property(GetTranslators,SetTranslators)
6679 def IsSimple(*args, **kwargs):
6680 """IsSimple(self) -> bool"""
6681 return _misc_.AboutDialogInfo_IsSimple(*args, **kwargs)
6682
6683 def GetDescriptionAndCredits(*args, **kwargs):
6684 """GetDescriptionAndCredits(self) -> String"""
6685 return _misc_.AboutDialogInfo_GetDescriptionAndCredits(*args, **kwargs)
6686
6687_misc_.AboutDialogInfo_swigregister(AboutDialogInfo)
6688
6689
6690def AboutBox(*args, **kwargs):
6691 """
6692 AboutBox(AboutDialogInfo info)
6693
6694 This function shows the standard about dialog containing the
6695 information specified in ``info``. If the current platform has a
6696 native about dialog which is capable of showing all the fields in
24f6c4e8
RD
6697 `wx.AboutDialogInfo`, the native dialog is used, otherwise the
6698 function falls back to the generic wxWidgets version of the dialog.
b39fe951
RD
6699 """
6700 return _misc_.AboutBox(*args, **kwargs)
d55e5bfc 6701
7449af73 6702