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