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