X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/41e2b43ea4fd82f188cf6f62b71c67bca8844ae9..08e2c5707802f0b17620474f3794ab1528de0739:/wxPython/src/gtk/_misc.py?ds=sidebyside diff --git a/wxPython/src/gtk/_misc.py b/wxPython/src/gtk/_misc.py index 2506f88544..335667a860 100644 --- a/wxPython/src/gtk/_misc.py +++ b/wxPython/src/gtk/_misc.py @@ -3,6 +3,47 @@ import _misc_ +def _swig_setattr_nondynamic(self,class_type,name,value,static=1): + if (name == "this"): + if isinstance(value, class_type): + self.__dict__[name] = value.this + if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown + del value.thisown + return + method = class_type.__swig_setmethods__.get(name,None) + if method: return method(self,value) + if (not static) or hasattr(self,name) or (name == "thisown"): + self.__dict__[name] = value + else: + raise AttributeError("You cannot add attributes to %s" % self) + +def _swig_setattr(self,class_type,name,value): + return _swig_setattr_nondynamic(self,class_type,name,value,0) + +def _swig_getattr(self,class_type,name): + method = class_type.__swig_getmethods__.get(name,None) + if method: return method(self) + raise AttributeError,name + +import types +try: + _object = types.ObjectType + _newclass = 1 +except AttributeError: + class _object : pass + _newclass = 0 +del types + + +def _swig_setattr_nondynamic_method(set): + def set_attr(self,name,value): + if hasattr(self,name) or (name in ("this", "thisown")): + set(self,name,value) + else: + raise AttributeError("You cannot add attributes to %s" % self) + return set_attr + + import _core wx = _core #--------------------------------------------------------------------------- @@ -99,6 +140,7 @@ SYS_SCREEN_PDA = _misc_.SYS_SCREEN_PDA SYS_SCREEN_SMALL = _misc_.SYS_SCREEN_SMALL SYS_SCREEN_DESKTOP = _misc_.SYS_SCREEN_DESKTOP class SystemSettings(object): + """Proxy of C++ SystemSettings class""" def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxSystemSettings instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -165,6 +207,7 @@ def SystemSettings_SetScreenType(*args, **kwargs): return _misc_.SystemSettings_SetScreenType(*args, **kwargs) class SystemOptions(_core.Object): + """Proxy of C++ SystemOptions class""" def __repr__(self): return "<%s.%s; proxy of C++ wxSystemOptions instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -205,6 +248,8 @@ class SystemOptionsPtr(SystemOptions): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = SystemOptions _misc_.SystemOptions_swigregister(SystemOptionsPtr) +cvar = _misc_.cvar +WINDOW_DEFAULT_VARIANT = cvar.WINDOW_DEFAULT_VARIANT def SystemOptions_SetOption(*args, **kwargs): """SystemOptions_SetOption(String name, String value)""" @@ -241,6 +286,18 @@ def GetCurrentId(*args, **kwargs): """GetCurrentId() -> long""" return _misc_.GetCurrentId(*args, **kwargs) +def IsStockID(*args, **kwargs): + """IsStockID(int id) -> bool""" + return _misc_.IsStockID(*args, **kwargs) + +def IsStockLabel(*args, **kwargs): + """IsStockLabel(int id, String label) -> bool""" + return _misc_.IsStockLabel(*args, **kwargs) + +def GetStockLabel(*args, **kwargs): + """GetStockLabel(int id, bool withCodes=True, String accelerator=EmptyString) -> String""" + return _misc_.GetStockLabel(*args, **kwargs) + def Bell(*args, **kwargs): """Bell()""" return _misc_.Bell(*args, **kwargs) @@ -295,9 +352,14 @@ def Sleep(*args, **kwargs): """Sleep(int secs)""" return _misc_.Sleep(*args, **kwargs) -def Usleep(*args, **kwargs): - """Usleep(unsigned long milliseconds)""" - return _misc_.Usleep(*args, **kwargs) +def MilliSleep(*args, **kwargs): + """MilliSleep(unsigned long milliseconds)""" + return _misc_.MilliSleep(*args, **kwargs) + +def MicroSleep(*args, **kwargs): + """MicroSleep(unsigned long microseconds)""" + return _misc_.MicroSleep(*args, **kwargs) +Usleep = MilliSleep def EnableTopLevelWindows(*args, **kwargs): """EnableTopLevelWindows(bool enable)""" @@ -393,17 +455,17 @@ def GetPasswordFromUser(*args, **kwargs): def GetSingleChoice(*args, **kwargs): """ - GetSingleChoice(String message, String caption, int choices, String choices_array, - Window parent=None, int x=-1, - int y=-1, bool centre=True, int width=150, int height=200) -> String + GetSingleChoice(String message, String caption, int choices, Window parent=None, + int x=-1, int y=-1, bool centre=True, + int width=150, int height=200) -> String """ return _misc_.GetSingleChoice(*args, **kwargs) def GetSingleChoiceIndex(*args, **kwargs): """ - GetSingleChoiceIndex(String message, String caption, int choices, String choices_array, - Window parent=None, int x=-1, - int y=-1, bool centre=True, int width=150, int height=200) -> int + GetSingleChoiceIndex(String message, String caption, int choices, Window parent=None, + int x=-1, int y=-1, bool centre=True, + int width=150, int height=200) -> int """ return _misc_.GetSingleChoiceIndex(*args, **kwargs) @@ -484,7 +546,14 @@ def GetTopLevelParent(*args, **kwargs): return _misc_.GetTopLevelParent(*args, **kwargs) def GetKeyState(*args, **kwargs): - """GetKeyState(int key) -> bool""" + """ + GetKeyState(int key) -> bool + + Get the state of a key (true if pressed or toggled on, false if not.) + This is generally most useful getting the state of the modifier or + toggle keys. On some platforms those may be the only keys that work. + + """ return _misc_.GetKeyState(*args, **kwargs) def WakeUpMainThread(*args, **kwargs): @@ -499,6 +568,7 @@ def MutexGuiLeave(*args, **kwargs): """MutexGuiLeave()""" return _misc_.MutexGuiLeave(*args, **kwargs) class MutexGuiLocker(object): + """Proxy of C++ MutexGuiLocker class""" def __repr__(self): return "<%s.%s; proxy of C++ wxMutexGuiLocker instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -520,7 +590,6 @@ class MutexGuiLockerPtr(MutexGuiLocker): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = MutexGuiLocker _misc_.MutexGuiLocker_swigregister(MutexGuiLockerPtr) -cvar = _misc_.cvar FileSelectorPromptStr = cvar.FileSelectorPromptStr FileSelectorDefaultWildcardStr = cvar.FileSelectorDefaultWildcardStr DirSelectorPromptStr = cvar.DirSelectorPromptStr @@ -532,6 +601,7 @@ def Thread_IsMain(*args, **kwargs): #--------------------------------------------------------------------------- class ToolTip(_core.Object): + """Proxy of C++ ToolTip class""" def __repr__(self): return "<%s.%s; proxy of C++ wxToolTip instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -579,6 +649,7 @@ def ToolTip_SetDelay(*args, **kwargs): return _misc_.ToolTip_SetDelay(*args, **kwargs) class Caret(object): + """Proxy of C++ Caret class""" def __repr__(self): return "<%s.%s; proxy of C++ wxCaret instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -587,11 +658,13 @@ class Caret(object): self.this = newobj.this self.thisown = 1 del newobj.thisown - def __del__(self, destroy=_misc_.delete_Caret): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + def Destroy(*args, **kwargs): + """ + Destroy(self) + + Deletes the C++ object this Python object is a proxy for. + """ + return _misc_.Caret_Destroy(*args, **kwargs) def IsOk(*args, **kwargs): """IsOk(self) -> bool""" @@ -646,6 +719,16 @@ class Caret(object): return _misc_.Caret_Hide(*args, **kwargs) def __nonzero__(self): return self.IsOk() + def GetBlinkTime(*args, **kwargs): + """GetBlinkTime() -> int""" + return _misc_.Caret_GetBlinkTime(*args, **kwargs) + + GetBlinkTime = staticmethod(GetBlinkTime) + def SetBlinkTime(*args, **kwargs): + """SetBlinkTime(int milliseconds)""" + return _misc_.Caret_SetBlinkTime(*args, **kwargs) + + SetBlinkTime = staticmethod(SetBlinkTime) class CaretPtr(Caret): def __init__(self, this): @@ -654,7 +737,6 @@ class CaretPtr(Caret): self.__class__ = Caret _misc_.Caret_swigregister(CaretPtr) - def Caret_GetBlinkTime(*args, **kwargs): """Caret_GetBlinkTime() -> int""" return _misc_.Caret_GetBlinkTime(*args, **kwargs) @@ -662,7 +744,9 @@ def Caret_GetBlinkTime(*args, **kwargs): def Caret_SetBlinkTime(*args, **kwargs): """Caret_SetBlinkTime(int milliseconds)""" return _misc_.Caret_SetBlinkTime(*args, **kwargs) + class BusyCursor(object): + """Proxy of C++ BusyCursor class""" def __repr__(self): return "<%s.%s; proxy of C++ wxBusyCursor instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -686,6 +770,7 @@ class BusyCursorPtr(BusyCursor): _misc_.BusyCursor_swigregister(BusyCursorPtr) class WindowDisabler(object): + """Proxy of C++ WindowDisabler class""" def __repr__(self): return "<%s.%s; proxy of C++ wxWindowDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -709,6 +794,7 @@ class WindowDisablerPtr(WindowDisabler): _misc_.WindowDisabler_swigregister(WindowDisablerPtr) class BusyInfo(_core.Object): + """Proxy of C++ BusyInfo class""" def __repr__(self): return "<%s.%s; proxy of C++ wxBusyInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -732,6 +818,7 @@ class BusyInfoPtr(BusyInfo): _misc_.BusyInfo_swigregister(BusyInfoPtr) class StopWatch(object): + """Proxy of C++ StopWatch class""" def __repr__(self): return "<%s.%s; proxy of C++ wxStopWatch instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -765,10 +852,11 @@ class StopWatchPtr(StopWatch): _misc_.StopWatch_swigregister(StopWatchPtr) class FileHistory(_core.Object): + """Proxy of C++ FileHistory class""" def __repr__(self): return "<%s.%s; proxy of C++ wxFileHistory instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, int maxFiles=9) -> FileHistory""" + """__init__(self, int maxFiles=9, int idBase=ID_FILE1) -> FileHistory""" newobj = _misc_.new_FileHistory(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -833,6 +921,7 @@ class FileHistoryPtr(FileHistory): _misc_.FileHistory_swigregister(FileHistoryPtr) class SingleInstanceChecker(object): + """Proxy of C++ SingleInstanceChecker class""" def __repr__(self): return "<%s.%s; proxy of C++ wxSingleInstanceChecker instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -871,11 +960,12 @@ def PreSingleInstanceChecker(*args, **kwargs): def DrawWindowOnDC(*args, **kwargs): - """DrawWindowOnDC(Window window, DC dc, int method)""" + """DrawWindowOnDC(Window window, DC dc) -> bool""" return _misc_.DrawWindowOnDC(*args, **kwargs) #--------------------------------------------------------------------------- class TipProvider(object): + """Proxy of C++ TipProvider class""" def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxTipProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -906,6 +996,7 @@ class TipProviderPtr(TipProvider): _misc_.TipProvider_swigregister(TipProviderPtr) class PyTipProvider(TipProvider): + """Proxy of C++ PyTipProvider class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyTipProvider instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -942,6 +1033,7 @@ TIMER_CONTINUOUS = _misc_.TIMER_CONTINUOUS TIMER_ONE_SHOT = _misc_.TIMER_ONE_SHOT wxEVT_TIMER = _misc_.wxEVT_TIMER class Timer(_core.EvtHandler): + """Proxy of C++ Timer class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyTimer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -950,7 +1042,7 @@ class Timer(_core.EvtHandler): self.this = newobj.this self.thisown = 1 del newobj.thisown - self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self) + self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self, 0) def __del__(self, destroy=_misc_.delete_Timer): """__del__(self)""" @@ -994,6 +1086,10 @@ class Timer(_core.EvtHandler): """GetId(self) -> int""" return _misc_.Timer_GetId(*args, **kwargs) + def Destroy(): + """NO-OP: Timers must be destroyed by normal refrence counting""" + pass + class TimerPtr(Timer): def __init__(self, this): @@ -1017,6 +1113,7 @@ EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) class TimerEvent(_core.Event): + """Proxy of C++ TimerEvent class""" def __repr__(self): return "<%s.%s; proxy of C++ wxTimerEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1038,6 +1135,7 @@ class TimerEventPtr(TimerEvent): _misc_.TimerEvent_swigregister(TimerEventPtr) class TimerRunner(object): + """Proxy of C++ TimerRunner class""" def __repr__(self): return "<%s.%s; proxy of C++ wxTimerRunner instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args): @@ -1091,6 +1189,7 @@ TraceResAlloc = _misc_.TraceResAlloc TraceRefCount = _misc_.TraceRefCount TraceOleCalls = _misc_.TraceOleCalls class Log(object): + """Proxy of C++ Log class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1323,6 +1422,7 @@ def Log_TimeStamp(*args, **kwargs): return _misc_.Log_TimeStamp(*args, **kwargs) class LogStderr(Log): + """Proxy of C++ LogStderr class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogStderr instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1340,6 +1440,7 @@ class LogStderrPtr(LogStderr): _misc_.LogStderr_swigregister(LogStderrPtr) class LogTextCtrl(Log): + """Proxy of C++ LogTextCtrl class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogTextCtrl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1357,6 +1458,7 @@ class LogTextCtrlPtr(LogTextCtrl): _misc_.LogTextCtrl_swigregister(LogTextCtrlPtr) class LogGui(Log): + """Proxy of C++ LogGui class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogGui instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1374,6 +1476,7 @@ class LogGuiPtr(LogGui): _misc_.LogGui_swigregister(LogGuiPtr) class LogWindow(Log): + """Proxy of C++ LogWindow class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1411,6 +1514,7 @@ class LogWindowPtr(LogWindow): _misc_.LogWindow_swigregister(LogWindowPtr) class LogChain(Log): + """Proxy of C++ LogChain class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogChain instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1500,6 +1604,7 @@ def SafeShowMessage(*args, **kwargs): """SafeShowMessage(String title, String text)""" return _misc_.SafeShowMessage(*args, **kwargs) class LogNull(object): + """Proxy of C++ LogNull class""" def __repr__(self): return "<%s.%s; proxy of C++ wxLogNull instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1530,6 +1635,7 @@ def LogTrace(*args): return _misc_.LogTrace(*args) class PyLog(Log): + """Proxy of C++ PyLog class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyLog instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1561,6 +1667,8 @@ KILL_BAD_SIGNAL = _misc_.KILL_BAD_SIGNAL KILL_ACCESS_DENIED = _misc_.KILL_ACCESS_DENIED KILL_NO_PROCESS = _misc_.KILL_NO_PROCESS KILL_ERROR = _misc_.KILL_ERROR +KILL_NOCHILDREN = _misc_.KILL_NOCHILDREN +KILL_CHILDREN = _misc_.KILL_CHILDREN SIGNONE = _misc_.SIGNONE SIGHUP = _misc_.SIGHUP SIGINT = _misc_.SIGINT @@ -1579,10 +1687,11 @@ SIGPIPE = _misc_.SIGPIPE SIGALRM = _misc_.SIGALRM SIGTERM = _misc_.SIGTERM class Process(_core.EvtHandler): + """Proxy of C++ Process class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyProcess instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def Kill(*args, **kwargs): - """Kill(int pid, int sig=SIGTERM) -> int""" + """Kill(int pid, int sig=SIGTERM, int flags=KILL_NOCHILDREN) -> int""" return _misc_.Process_Kill(*args, **kwargs) Kill = staticmethod(Kill) @@ -1661,7 +1770,7 @@ class ProcessPtr(Process): _misc_.Process_swigregister(ProcessPtr) def Process_Kill(*args, **kwargs): - """Process_Kill(int pid, int sig=SIGTERM) -> int""" + """Process_Kill(int pid, int sig=SIGTERM, int flags=KILL_NOCHILDREN) -> int""" return _misc_.Process_Kill(*args, **kwargs) def Process_Exists(*args, **kwargs): @@ -1673,6 +1782,7 @@ def Process_Open(*args, **kwargs): return _misc_.Process_Open(*args, **kwargs) class ProcessEvent(_core.Event): + """Proxy of C++ ProcessEvent class""" def __repr__(self): return "<%s.%s; proxy of C++ wxProcessEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1706,10 +1816,15 @@ EXEC_ASYNC = _misc_.EXEC_ASYNC EXEC_SYNC = _misc_.EXEC_SYNC EXEC_NOHIDE = _misc_.EXEC_NOHIDE EXEC_MAKE_GROUP_LEADER = _misc_.EXEC_MAKE_GROUP_LEADER +EXEC_NODISABLE = _misc_.EXEC_NODISABLE def Execute(*args, **kwargs): """Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long""" return _misc_.Execute(*args, **kwargs) + +def Kill(*args, **kwargs): + """Kill(long pid, int sig=SIGTERM, int rc, int flags=KILL_NOCHILDREN) -> int""" + return _misc_.Kill(*args, **kwargs) #--------------------------------------------------------------------------- JOYSTICK1 = _misc_.JOYSTICK1 @@ -1720,6 +1835,7 @@ JOY_BUTTON2 = _misc_.JOY_BUTTON2 JOY_BUTTON3 = _misc_.JOY_BUTTON3 JOY_BUTTON4 = _misc_.JOY_BUTTON4 class Joystick(object): + """Proxy of C++ Joystick class""" def __repr__(self): return "<%s.%s; proxy of C++ wxJoystick instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -1916,13 +2032,9 @@ wxEVT_JOY_BUTTON_UP = _misc_.wxEVT_JOY_BUTTON_UP wxEVT_JOY_MOVE = _misc_.wxEVT_JOY_MOVE wxEVT_JOY_ZMOVE = _misc_.wxEVT_JOY_ZMOVE class JoystickEvent(_core.Event): + """Proxy of C++ JoystickEvent class""" def __repr__(self): return "<%s.%s; proxy of C++ wxJoystickEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - m_pos = property(_misc_.JoystickEvent_m_pos_get, _misc_.JoystickEvent_m_pos_set) - m_zPosition = property(_misc_.JoystickEvent_m_zPosition_get, _misc_.JoystickEvent_m_zPosition_set) - m_buttonChange = property(_misc_.JoystickEvent_m_buttonChange_get, _misc_.JoystickEvent_m_buttonChange_set) - m_buttonState = property(_misc_.JoystickEvent_m_buttonState_get, _misc_.JoystickEvent_m_buttonState_set) - m_joyStick = property(_misc_.JoystickEvent_m_joyStick_get, _misc_.JoystickEvent_m_joyStick_set) def __init__(self, *args, **kwargs): """ __init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, @@ -1996,6 +2108,12 @@ class JoystickEvent(_core.Event): """ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool""" return _misc_.JoystickEvent_ButtonIsDown(*args, **kwargs) + m_pos = property(GetPosition, SetPosition) + m_zPosition = property(GetZPosition, SetZPosition) + m_buttonChange = property(GetButtonChange, SetButtonChange) + m_buttonState = property(GetButtonState, SetButtonState) + m_joyStick = property(GetJoystick, SetJoystick) + class JoystickEventPtr(JoystickEvent): def __init__(self, this): @@ -2022,6 +2140,7 @@ SOUND_SYNC = _misc_.SOUND_SYNC SOUND_ASYNC = _misc_.SOUND_ASYNC SOUND_LOOP = _misc_.SOUND_LOOP class Sound(object): + """Proxy of C++ Sound class""" def __repr__(self): return "<%s.%s; proxy of C++ wxSound instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2093,6 +2212,7 @@ MAILCAP_KDE = _misc_.MAILCAP_KDE MAILCAP_GNOME = _misc_.MAILCAP_GNOME MAILCAP_ALL = _misc_.MAILCAP_ALL class FileTypeInfo(object): + """Proxy of C++ FileTypeInfo class""" def __repr__(self): return "<%s.%s; proxy of C++ wxFileTypeInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2170,6 +2290,7 @@ def NullFileTypeInfo(*args, **kwargs): return val class FileType(object): + """Proxy of C++ FileType class""" def __repr__(self): return "<%s.%s; proxy of C++ wxFileType instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -2250,6 +2371,7 @@ def FileType_ExpandCommand(*args, **kwargs): return _misc_.FileType_ExpandCommand(*args, **kwargs) class MimeTypesManager(object): + """Proxy of C++ MimeTypesManager class""" def __repr__(self): return "<%s.%s; proxy of C++ wxMimeTypesManager instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def IsOfType(*args, **kwargs): @@ -2443,6 +2565,7 @@ ART_FRAME_ICON = cvar.ART_FRAME_ICON ART_CMN_DIALOG = cvar.ART_CMN_DIALOG ART_HELP_BROWSER = cvar.ART_HELP_BROWSER ART_MESSAGE_BOX = cvar.ART_MESSAGE_BOX +ART_BUTTON = cvar.ART_BUTTON ART_OTHER = cvar.ART_OTHER ART_ADD_BOOKMARK = cvar.ART_ADD_BOOKMARK ART_DEL_BOOKMARK = cvar.ART_DEL_BOOKMARK @@ -2458,13 +2581,20 @@ ART_GO_DOWN = cvar.ART_GO_DOWN ART_GO_TO_PARENT = cvar.ART_GO_TO_PARENT ART_GO_HOME = cvar.ART_GO_HOME ART_FILE_OPEN = cvar.ART_FILE_OPEN +ART_FILE_SAVE = cvar.ART_FILE_SAVE +ART_FILE_SAVE_AS = cvar.ART_FILE_SAVE_AS ART_PRINT = cvar.ART_PRINT ART_HELP = cvar.ART_HELP ART_TIP = cvar.ART_TIP ART_REPORT_VIEW = cvar.ART_REPORT_VIEW ART_LIST_VIEW = cvar.ART_LIST_VIEW ART_NEW_DIR = cvar.ART_NEW_DIR +ART_HARDDISK = cvar.ART_HARDDISK +ART_FLOPPY = cvar.ART_FLOPPY +ART_CDROM = cvar.ART_CDROM +ART_REMOVABLE = cvar.ART_REMOVABLE ART_FOLDER = cvar.ART_FOLDER +ART_FOLDER_OPEN = cvar.ART_FOLDER_OPEN ART_GO_DIR_UP = cvar.ART_GO_DIR_UP ART_EXECUTABLE_FILE = cvar.ART_EXECUTABLE_FILE ART_NORMAL_FILE = cvar.ART_NORMAL_FILE @@ -2475,6 +2605,15 @@ ART_QUESTION = cvar.ART_QUESTION ART_WARNING = cvar.ART_WARNING ART_INFORMATION = cvar.ART_INFORMATION ART_MISSING_IMAGE = cvar.ART_MISSING_IMAGE +ART_COPY = cvar.ART_COPY +ART_CUT = cvar.ART_CUT +ART_PASTE = cvar.ART_PASTE +ART_DELETE = cvar.ART_DELETE +ART_UNDO = cvar.ART_UNDO +ART_REDO = cvar.ART_REDO +ART_QUIT = cvar.ART_QUIT +ART_FIND = cvar.ART_FIND +ART_FIND_AND_REPLACE = cvar.ART_FIND_AND_REPLACE def ArtProvider_PushProvider(*args, **kwargs): """ @@ -3048,6 +3187,7 @@ def ExpandEnvVars(*args, **kwargs): #--------------------------------------------------------------------------- class DateTime(object): + """Proxy of C++ DateTime class""" def __repr__(self): return "<%s.%s; proxy of C++ wxDateTime instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) Local = _misc_.DateTime_Local @@ -3266,7 +3406,11 @@ class DateTime(object): GetWeekDayName = staticmethod(GetWeekDayName) def GetAmPmStrings(*args, **kwargs): - """GetAmPmStrings() -> (am, pm)""" + """ + GetAmPmStrings() -> (am, pm) + + Get the AM and PM strings in the current locale (may be empty) + """ return _misc_.DateTime_GetAmPmStrings(*args, **kwargs) GetAmPmStrings = staticmethod(GetAmPmStrings) @@ -3411,6 +3555,14 @@ class DateTime(object): """GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime""" return _misc_.DateTime_GetWeek(*args, **kwargs) + SetToTheWeek = wx._deprecated(SetToTheWeek, "SetToTheWeek is deprecated, use (static) SetToWeekOfYear instead") + GetWeek = wx._deprecated(GetWeek, "GetWeek is deprecated, use GetWeekOfYear instead") + + def SetToWeekOfYear(*args, **kwargs): + """SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime""" + return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs) + + SetToWeekOfYear = staticmethod(SetToWeekOfYear) def SetToLastMonthDay(*args, **kwargs): """SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime""" return _misc_.DateTime_SetToLastMonthDay(*args, **kwargs) @@ -3606,36 +3758,36 @@ class DateTime(object): """ return _misc_.DateTime___sub__(*args) - def __lt__(*args): + def __lt__(*args, **kwargs): """__lt__(self, DateTime other) -> bool""" - return _misc_.DateTime___lt__(*args) + return _misc_.DateTime___lt__(*args, **kwargs) - def __le__(*args): + def __le__(*args, **kwargs): """__le__(self, DateTime other) -> bool""" - return _misc_.DateTime___le__(*args) + return _misc_.DateTime___le__(*args, **kwargs) - def __gt__(*args): + def __gt__(*args, **kwargs): """__gt__(self, DateTime other) -> bool""" - return _misc_.DateTime___gt__(*args) + return _misc_.DateTime___gt__(*args, **kwargs) - def __ge__(*args): + def __ge__(*args, **kwargs): """__ge__(self, DateTime other) -> bool""" - return _misc_.DateTime___ge__(*args) + return _misc_.DateTime___ge__(*args, **kwargs) - def __eq__(*args): + def __eq__(*args, **kwargs): """__eq__(self, DateTime other) -> bool""" - return _misc_.DateTime___eq__(*args) + return _misc_.DateTime___eq__(*args, **kwargs) - def __ne__(*args): + def __ne__(*args, **kwargs): """__ne__(self, DateTime other) -> bool""" - return _misc_.DateTime___ne__(*args) + return _misc_.DateTime___ne__(*args, **kwargs) def ParseRfc822Date(*args, **kwargs): """ParseRfc822Date(self, String date) -> int""" return _misc_.DateTime_ParseRfc822Date(*args, **kwargs) def ParseFormat(*args, **kwargs): - """ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int""" + """ParseFormat(self, String date, String format=DefaultDateTimeFormat, DateTime dateDef=DefaultDateTime) -> int""" return _misc_.DateTime_ParseFormat(*args, **kwargs) def ParseDateTime(*args, **kwargs): @@ -3651,7 +3803,7 @@ class DateTime(object): return _misc_.DateTime_ParseTime(*args, **kwargs) def Format(*args, **kwargs): - """Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String""" + """Format(self, String format=DefaultDateTimeFormat, wxDateTime::TimeZone tz=LOCAL_TZ) -> String""" return _misc_.DateTime_Format(*args, **kwargs) def FormatDate(*args, **kwargs): @@ -3688,8 +3840,8 @@ class DateTimePtr(DateTime): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = DateTime _misc_.DateTime_swigregister(DateTimePtr) -DateFormatStr = cvar.DateFormatStr -TimeSpanFormatStr = cvar.TimeSpanFormatStr +DefaultDateTimeFormat = cvar.DefaultDateTimeFormat +DefaultTimeSpanFormat = cvar.DefaultTimeSpanFormat def DateTime_SetCountry(*args, **kwargs): """DateTime_SetCountry(int country)""" @@ -3740,7 +3892,11 @@ def DateTime_GetWeekDayName(*args, **kwargs): return _misc_.DateTime_GetWeekDayName(*args, **kwargs) def DateTime_GetAmPmStrings(*args, **kwargs): - """GetAmPmStrings() -> (am, pm)""" + """ + GetAmPmStrings() -> (am, pm) + + Get the AM and PM strings in the current locale (may be empty) + """ return _misc_.DateTime_GetAmPmStrings(*args, **kwargs) def DateTime_IsDSTApplicable(*args, **kwargs): @@ -3794,7 +3950,12 @@ def DateTimeFromDMY(*args, **kwargs): val.thisown = 1 return val +def DateTime_SetToWeekOfYear(*args, **kwargs): + """DateTime_SetToWeekOfYear(int year, int numWeek, int weekday=Mon) -> DateTime""" + return _misc_.DateTime_SetToWeekOfYear(*args, **kwargs) + class TimeSpan(object): + """Proxy of C++ TimeSpan class""" def __repr__(self): return "<%s.%s; proxy of C++ wxTimeSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def Seconds(*args, **kwargs): @@ -3984,7 +4145,7 @@ class TimeSpan(object): return _misc_.TimeSpan_GetMilliseconds(*args, **kwargs) def Format(*args, **kwargs): - """Format(self, String format=TimeSpanFormatStr) -> String""" + """Format(self, String format=DefaultTimeSpanFormat) -> String""" return _misc_.TimeSpan_Format(*args, **kwargs) def __repr__(self): @@ -4041,6 +4202,7 @@ def TimeSpan_Week(*args, **kwargs): return _misc_.TimeSpan_Week(*args, **kwargs) class DateSpan(object): + """Proxy of C++ DateSpan class""" def __repr__(self): return "<%s.%s; proxy of C++ wxDateSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4362,6 +4524,20 @@ def CustomDataFormat(*args, **kwargs): return val class DataObject(object): + """ + A wx.DataObject represents data that can be copied to or from the + clipboard, or dragged and dropped. The important thing about + wx.DataObject is that this is a 'smart' piece of data unlike usual + 'dumb' data containers such as memory buffers or files. Being 'smart' + here means that the data object itself should know what data formats + it supports and how to render itself in each of supported formats. + + **NOTE**: This class is an abstract base class and can not be used + directly from Python. If you need a custom type of data object then + you should instead derive from `wx.PyDataObjectSimple` or use + `wx.CustomDataObject`. + + """ def __init__(self): raise RuntimeError, "No constructor defined" def __repr__(self): return "<%s.%s; proxy of C++ wxDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) @@ -4375,31 +4551,65 @@ class DataObject(object): except: pass def GetPreferredFormat(*args, **kwargs): - """GetPreferredFormat(self, int dir=Get) -> DataFormat""" + """ + GetPreferredFormat(self, int dir=Get) -> DataFormat + + Returns the preferred format for either rendering the data (if dir is + Get, its default value) or for setting it. Usually this will be the + native format of the wx.DataObject. + """ return _misc_.DataObject_GetPreferredFormat(*args, **kwargs) def GetFormatCount(*args, **kwargs): - """GetFormatCount(self, int dir=Get) -> size_t""" + """ + GetFormatCount(self, int dir=Get) -> size_t + + Returns the number of available formats for rendering or setting the + data. + """ return _misc_.DataObject_GetFormatCount(*args, **kwargs) def IsSupported(*args, **kwargs): - """IsSupported(self, DataFormat format, int dir=Get) -> bool""" + """ + IsSupported(self, DataFormat format, int dir=Get) -> bool + + Returns True if this format is supported. + """ return _misc_.DataObject_IsSupported(*args, **kwargs) def GetDataSize(*args, **kwargs): - """GetDataSize(self, DataFormat format) -> size_t""" + """ + GetDataSize(self, DataFormat format) -> size_t + + Get the (total) size of data for the given format + """ return _misc_.DataObject_GetDataSize(*args, **kwargs) def GetAllFormats(*args, **kwargs): - """GetAllFormats(self, DataFormat formats, int dir=Get)""" + """ + GetAllFormats(self, int dir=Get) -> [formats] + + Returns a list of all the wx.DataFormats that this dataobject supports + in the given direction. + """ return _misc_.DataObject_GetAllFormats(*args, **kwargs) def GetDataHere(*args, **kwargs): - """GetDataHere(self, DataFormat format, void buf) -> bool""" + """ + GetDataHere(self, DataFormat format) -> String + + Get the data bytes in the specified format, returns None on failure. + + """ return _misc_.DataObject_GetDataHere(*args, **kwargs) def SetData(*args, **kwargs): - """SetData(self, DataFormat format, size_t len, void buf) -> bool""" + """ + SetData(self, DataFormat format, String data) -> bool + + Set the data in the specified format from the bytes in the the data string. + + """ return _misc_.DataObject_SetData(*args, **kwargs) @@ -4412,22 +4622,73 @@ _misc_.DataObject_swigregister(DataObjectPtr) FormatInvalid = cvar.FormatInvalid class DataObjectSimple(DataObject): + """ + wx.DataObjectSimple is a `wx.DataObject` which only supports one + format. This is the simplest possible `wx.DataObject` implementation. + + This is still an "abstract base class" meaning that you can't use it + directly. You either need to use one of the predefined base classes, + or derive your own class from `wx.PyDataObjectSimple`. + + """ def __repr__(self): return "<%s.%s; proxy of C++ wxDataObjectSimple instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple""" + """ + __init__(self, DataFormat format=FormatInvalid) -> DataObjectSimple + + Constructor accepts the supported format (none by default) which may + also be set later with `SetFormat`. + """ newobj = _misc_.new_DataObjectSimple(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def GetFormat(*args, **kwargs): - """GetFormat(self) -> DataFormat""" + """ + GetFormat(self) -> DataFormat + + Returns the (one and only one) format supported by this object. It is + assumed that the format is supported in both directions. + """ return _misc_.DataObjectSimple_GetFormat(*args, **kwargs) def SetFormat(*args, **kwargs): - """SetFormat(self, DataFormat format)""" + """ + SetFormat(self, DataFormat format) + + Sets the supported format. + """ return _misc_.DataObjectSimple_SetFormat(*args, **kwargs) + def GetDataSize(*args, **kwargs): + """ + GetDataSize(self) -> size_t + + Get the size of our data. + """ + return _misc_.DataObjectSimple_GetDataSize(*args, **kwargs) + + def GetDataHere(*args, **kwargs): + """ + GetDataHere(self) -> String + + Returns the data bytes from the data object as a string, returns None + on failure. Must be implemented in the derived class if the object + supports rendering its data. + """ + return _misc_.DataObjectSimple_GetDataHere(*args, **kwargs) + + def SetData(*args, **kwargs): + """ + SetData(self, String data) -> bool + + Copy the data value to the data object. Must be implemented in the + derived class if the object supports setting its data. + + """ + return _misc_.DataObjectSimple_SetData(*args, **kwargs) + class DataObjectSimplePtr(DataObjectSimple): def __init__(self, this): @@ -4437,10 +4698,27 @@ class DataObjectSimplePtr(DataObjectSimple): _misc_.DataObjectSimple_swigregister(DataObjectSimplePtr) class PyDataObjectSimple(DataObjectSimple): + """ + wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. You should derive from this + class and overload `GetDataSize`, `GetDataHere` and `SetData` when you + need to create your own simple single-format type of `wx.DataObject`. + + """ def __repr__(self): return "<%s.%s; proxy of C++ wxPyDataObjectSimple instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple""" + """ + __init__(self, DataFormat format=FormatInvalid) -> PyDataObjectSimple + + wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. You should derive from this + class and overload `GetDataSize`, `GetDataHere` and `SetData` when you + need to create your own simple single-format type of `wx.DataObject`. + + """ newobj = _misc_.new_PyDataObjectSimple(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4460,16 +4738,50 @@ class PyDataObjectSimplePtr(PyDataObjectSimple): _misc_.PyDataObjectSimple_swigregister(PyDataObjectSimplePtr) class DataObjectComposite(DataObject): + """ + wx.DataObjectComposite is the simplest `wx.DataObject` derivation + which may be sued to support multiple formats. It contains several + 'wx.DataObjectSimple` objects and supports any format supported by at + least one of them. Only one of these data objects is *preferred* (the + first one if not explicitly changed by using the second parameter of + `Add`) and its format determines the preferred format of the composite + data object as well. + + See `wx.DataObject` documentation for the reasons why you might prefer + to use wx.DataObject directly instead of wx.DataObjectComposite for + efficiency reasons. + + """ def __repr__(self): return "<%s.%s; proxy of C++ wxDataObjectComposite instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self) -> DataObjectComposite""" + """ + __init__(self) -> DataObjectComposite + + wx.DataObjectComposite is the simplest `wx.DataObject` derivation + which may be sued to support multiple formats. It contains several + 'wx.DataObjectSimple` objects and supports any format supported by at + least one of them. Only one of these data objects is *preferred* (the + first one if not explicitly changed by using the second parameter of + `Add`) and its format determines the preferred format of the composite + data object as well. + + See `wx.DataObject` documentation for the reasons why you might prefer + to use wx.DataObject directly instead of wx.DataObjectComposite for + efficiency reasons. + + """ newobj = _misc_.new_DataObjectComposite(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def Add(*args, **kwargs): - """Add(self, DataObjectSimple dataObject, int preferred=False)""" + """ + Add(self, DataObjectSimple dataObject, bool preferred=False) + + Adds the dataObject to the list of supported objects and it becomes + the preferred object if preferred is True. + """ return _misc_.DataObjectComposite_Add(*args, **kwargs) @@ -4481,24 +4793,62 @@ class DataObjectCompositePtr(DataObjectComposite): _misc_.DataObjectComposite_swigregister(DataObjectCompositePtr) class TextDataObject(DataObjectSimple): + """ + wx.TextDataObject is a specialization of `wx.DataObject` for text + data. It can be used without change to paste data into the `wx.Clipboard` + or a `wx.DropSource`. + + Alternativly, you may wish to derive a new class from the + `wx.PyTextDataObject` class for providing text on-demand in order to + minimize memory consumption when offering data in several formats, + such as plain text and RTF, because by default the text is stored in a + string in this class, but it might as well be generated on demand when + requested. For this, `GetTextLength` and `GetText` will have to be + overridden. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxTextDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, String text=EmptyString) -> TextDataObject""" + """ + __init__(self, String text=EmptyString) -> TextDataObject + + Constructor, may be used to initialise the text (otherwise `SetText` + should be used later). + """ newobj = _misc_.new_TextDataObject(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def GetTextLength(*args, **kwargs): - """GetTextLength(self) -> size_t""" + """ + GetTextLength(self) -> size_t + + Returns the data size. By default, returns the size of the text data + set in the constructor or using `SetText`. This can be overridden (via + `wx.PyTextDataObject`) to provide text size data on-demand. It is + recommended to return the text length plus 1 for a trailing zero, but + this is not strictly required. + """ return _misc_.TextDataObject_GetTextLength(*args, **kwargs) def GetText(*args, **kwargs): - """GetText(self) -> String""" + """ + GetText(self) -> String + + Returns the text associated with the data object. + """ return _misc_.TextDataObject_GetText(*args, **kwargs) def SetText(*args, **kwargs): - """SetText(self, String text)""" + """ + SetText(self, String text) + + Sets the text associated with the data object. This method is called + when the data object receives the data and, by default, copies the + text into the member variable. If you want to process the text on the + fly you may wish to override this function (via + `wx.PyTextDataObject`.) + """ return _misc_.TextDataObject_SetText(*args, **kwargs) @@ -4510,10 +4860,27 @@ class TextDataObjectPtr(TextDataObject): _misc_.TextDataObject_swigregister(TextDataObjectPtr) class PyTextDataObject(TextDataObject): + """ + wx.PyTextDataObject is a version of `wx.TextDataObject` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. You should derive from this + class and overload `GetTextLength`, `GetText`, and `SetText` when you + want to be able to provide text on demand instead of preloading it + into the data object. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxPyTextDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, String text=EmptyString) -> PyTextDataObject""" + """ + __init__(self, String text=EmptyString) -> PyTextDataObject + + wx.PyTextDataObject is a version of `wx.TextDataObject` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. You should derive from this + class and overload `GetTextLength`, `GetText`, and `SetText` when you + want to be able to provide text on demand instead of preloading it + into the data object. + """ newobj = _misc_.new_PyTextDataObject(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4533,20 +4900,45 @@ class PyTextDataObjectPtr(PyTextDataObject): _misc_.PyTextDataObject_swigregister(PyTextDataObjectPtr) class BitmapDataObject(DataObjectSimple): + """ + wx.BitmapDataObject is a specialization of wxDataObject for bitmap + data. It can be used without change to paste data into the `wx.Clipboard` + or a `wx.DropSource`. + + """ def __repr__(self): return "<%s.%s; proxy of C++ wxBitmapDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject""" + """ + __init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject + + Constructor, optionally passing a bitmap (otherwise use `SetBitmap` + later). + """ newobj = _misc_.new_BitmapDataObject(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def GetBitmap(*args, **kwargs): - """GetBitmap(self) -> Bitmap""" + """ + GetBitmap(self) -> Bitmap + + Returns the bitmap associated with the data object. You may wish to + override this method (by deriving from `wx.PyBitmapDataObject`) when + offering data on-demand, but this is not required by wxWidgets' + internals. Use this method to get data in bitmap form from the + `wx.Clipboard`. + """ return _misc_.BitmapDataObject_GetBitmap(*args, **kwargs) def SetBitmap(*args, **kwargs): - """SetBitmap(self, Bitmap bitmap)""" + """ + SetBitmap(self, Bitmap bitmap) + + Sets the bitmap associated with the data object. This method is called + when the data object receives data. Usually there will be no reason to + override this function. + """ return _misc_.BitmapDataObject_SetBitmap(*args, **kwargs) @@ -4558,10 +4950,23 @@ class BitmapDataObjectPtr(BitmapDataObject): _misc_.BitmapDataObject_swigregister(BitmapDataObjectPtr) class PyBitmapDataObject(BitmapDataObject): + """ + wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. To be able to provide bitmap + data on demand derive from this class and overload `GetBitmap`. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxPyBitmapDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject""" + """ + __init__(self, Bitmap bitmap=wxNullBitmap) -> PyBitmapDataObject + + wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is + Python-aware and knows how to reflect calls to its C++ virtual methods + to methods in the Python derived class. To be able to provide bitmap + data on demand derive from this class and overload `GetBitmap`. + """ newobj = _misc_.new_PyBitmapDataObject(*args, **kwargs) self.this = newobj.this self.thisown = 1 @@ -4581,6 +4986,14 @@ class PyBitmapDataObjectPtr(PyBitmapDataObject): _misc_.PyBitmapDataObject_swigregister(PyBitmapDataObjectPtr) class FileDataObject(DataObjectSimple): + """ + wx.FileDataObject is a specialization of `wx.DataObjectSimple` for + file names. The program works with it just as if it were a list of + absolute file names, but internally it uses the same format as + Explorer and other compatible programs under Windows or GNOME/KDE + filemanager under Unix which makes it possible to receive files from + them using this class. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxFileDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4590,11 +5003,19 @@ class FileDataObject(DataObjectSimple): self.thisown = 1 del newobj.thisown def GetFilenames(*args, **kwargs): - """GetFilenames(self) -> wxArrayString""" + """ + GetFilenames(self) -> [names] + + Returns a list of file names. + """ return _misc_.FileDataObject_GetFilenames(*args, **kwargs) def AddFile(*args, **kwargs): - """AddFile(self, String filename)""" + """ + AddFile(self, String filename) + + Adds a file to the list of files represented by this data object. + """ return _misc_.FileDataObject_AddFile(*args, **kwargs) @@ -4606,28 +5027,54 @@ class FileDataObjectPtr(FileDataObject): _misc_.FileDataObject_swigregister(FileDataObjectPtr) class CustomDataObject(DataObjectSimple): + """ + wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for + some application-specific data in arbitrary format. Python strings + are used for getting and setting data, but any picklable object can + easily be transfered via strings. A copy of the data is stored in the + data object. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxCustomDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, DataFormat format=FormatInvalid) -> CustomDataObject""" - newobj = _misc_.new_CustomDataObject(*args, **kwargs) + def __init__(self, *args): + """ + __init__(self, DataFormat format) -> CustomDataObject + __init__(self, String formatName) -> CustomDataObject + __init__(self) -> CustomDataObject + + wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for + some application-specific data in arbitrary format. Python strings + are used for getting and setting data, but any picklable object can + easily be transfered via strings. A copy of the data is stored in the + data object. + """ + newobj = _misc_.new_CustomDataObject(*args) self.this = newobj.this self.thisown = 1 del newobj.thisown - def TakeData(*args, **kwargs): - """TakeData(self, PyObject data)""" - return _misc_.CustomDataObject_TakeData(*args, **kwargs) - def SetData(*args, **kwargs): - """SetData(self, PyObject data) -> bool""" + """ + SetData(self, String data) -> bool + + Copy the data value to the data object. + """ return _misc_.CustomDataObject_SetData(*args, **kwargs) + TakeData = SetData def GetSize(*args, **kwargs): - """GetSize(self) -> size_t""" + """ + GetSize(self) -> size_t + + Get the size of the data. + """ return _misc_.CustomDataObject_GetSize(*args, **kwargs) def GetData(*args, **kwargs): - """GetData(self) -> PyObject""" + """ + GetData(self) -> String + + Returns the data bytes from the data object as a string. + """ return _misc_.CustomDataObject_GetData(*args, **kwargs) @@ -4639,20 +5086,37 @@ class CustomDataObjectPtr(CustomDataObject): _misc_.CustomDataObject_swigregister(CustomDataObjectPtr) class URLDataObject(DataObjectComposite): + """ + This data object holds a URL in a format that is compatible with some + browsers such that it is able to be dragged to or from them. + """ def __repr__(self): return "<%s.%s; proxy of C++ wxURLDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): - """__init__(self) -> URLDataObject""" + """ + __init__(self) -> URLDataObject + + This data object holds a URL in a format that is compatible with some + browsers such that it is able to be dragged to or from them. + """ newobj = _misc_.new_URLDataObject(*args, **kwargs) self.this = newobj.this self.thisown = 1 del newobj.thisown def GetURL(*args, **kwargs): - """GetURL(self) -> String""" + """ + GetURL(self) -> String + + Returns a string containing the current URL. + """ return _misc_.URLDataObject_GetURL(*args, **kwargs) def SetURL(*args, **kwargs): - """SetURL(self, String url)""" + """ + SetURL(self, String url) + + Set the URL. + """ return _misc_.URLDataObject_SetURL(*args, **kwargs) @@ -4664,6 +5128,7 @@ class URLDataObjectPtr(URLDataObject): _misc_.URLDataObject_swigregister(URLDataObjectPtr) class MetafileDataObject(DataObjectSimple): + """Proxy of C++ MetafileDataObject class""" def __repr__(self): return "<%s.%s; proxy of C++ wxMetafileDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4696,6 +5161,7 @@ def IsDragResultOk(*args, **kwargs): """IsDragResultOk(int res) -> bool""" return _misc_.IsDragResultOk(*args, **kwargs) class DropSource(object): + """Proxy of C++ DropSource class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyDropSource instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4748,6 +5214,7 @@ class DropSourcePtr(DropSource): _misc_.DropSource_swigregister(DropSourcePtr) class DropTarget(object): + """Proxy of C++ DropTarget class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyDropTarget instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4806,6 +5273,7 @@ _misc_.DropTarget_swigregister(DropTargetPtr) PyDropTarget = DropTarget class TextDropTarget(DropTarget): + """Proxy of C++ TextDropTarget class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyTextDropTarget instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -4849,6 +5317,7 @@ class TextDropTargetPtr(TextDropTarget): _misc_.TextDropTarget_swigregister(TextDropTargetPtr) class FileDropTarget(DropTarget): + """Proxy of C++ FileDropTarget class""" def __repr__(self): return "<%s.%s; proxy of C++ wxPyFileDropTarget instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) def __init__(self, *args, **kwargs): @@ -5023,6 +5492,15 @@ class Clipboard(_core.Object): """ return _misc_.Clipboard_UsePrimarySelection(*args, **kwargs) + def Get(*args, **kwargs): + """ + Get() -> Clipboard + + Returns global instance (wxTheClipboard) of the object. + """ + return _misc_.Clipboard_Get(*args, **kwargs) + + Get = staticmethod(Get) class ClipboardPtr(Clipboard): def __init__(self, this): @@ -5031,6 +5509,31 @@ class ClipboardPtr(Clipboard): self.__class__ = Clipboard _misc_.Clipboard_swigregister(ClipboardPtr) +def Clipboard_Get(*args, **kwargs): + """ + Clipboard_Get() -> Clipboard + + Returns global instance (wxTheClipboard) of the object. + """ + return _misc_.Clipboard_Get(*args, **kwargs) + +class _wxPyDelayedInitWrapper(object): + def __init__(self, initfunc, *args, **kwargs): + self._initfunc = initfunc + self._args = args + self._kwargs = kwargs + self._instance = None + def _checkInstance(self): + if self._instance is None: + self._instance = self._initfunc(*self._args, **self._kwargs) + def __getattr__(self, name): + self._checkInstance() + return getattr(self._instance, name) + def __repr__(self): + self._checkInstance() + return repr(self._instance) +TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get) + class ClipboardLocker(object): """ A helpful class for opening the clipboard and automatically @@ -5071,7 +5574,6 @@ class ClipboardLockerPtr(ClipboardLocker): if not hasattr(self,"thisown"): self.thisown = 0 self.__class__ = ClipboardLocker _misc_.ClipboardLocker_swigregister(ClipboardLockerPtr) -TheClipboard = cvar.TheClipboard #--------------------------------------------------------------------------- @@ -5272,7 +5774,22 @@ class Display(object): """ ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool - Change current mode, return true if succeeded, false otherwise + Changes the video mode of this display to the mode specified in the + mode parameter. + + If wx.DefaultVideoMode is passed in as the mode parameter, the defined + behaviour is that wx.Display will reset the video mode to the default + mode used by the display. On Windows, the behavior is normal. + However, there are differences on other platforms. On Unix variations + using X11 extensions it should behave as defined, but some + irregularities may occur. + + On wxMac passing in wx.DefaultVideoMode as the mode parameter does + nothing. This happens because Carbon no longer has access to + DMUseScreenPrefs, an undocumented function that changed the video mode + to the system default by using the system's 'scrn' resource. + + Returns True if succeeded, False otherwise """ return _misc_.Display_ChangeMode(*args, **kwargs) @@ -5319,4 +5836,159 @@ def Display_GetFromWindow(*args, **kwargs): """ return _misc_.Display_GetFromWindow(*args, **kwargs) +#--------------------------------------------------------------------------- + +class StandardPaths(object): + """ + wx.StandardPaths returns the standard locations in the file system and + should be used by the programs to find their data files in a portable + way. + + In the description of the methods below, the example return values are + given for the Unix, Windows and Mac OS X systems, however please note + that these are just the examples and the actual values may differ. For + example, under Windows: the system administrator may change the + standard directories locations, i.e. the Windows directory may be + named W:\Win2003 instead of the default C:\Windows. + + The strings appname and username should be replaced with the value + returned by `wx.App.GetAppName` and the name of the currently logged + in user, respectively. The string prefix is only used under Unix and + is /usr/local by default but may be changed using `SetInstallPrefix`. + + The directories returned by the methods of this class may or may not + exist. If they don't exist, it's up to the caller to create them, + wxStandardPaths doesn't do it. + + Finally note that these functions only work with standardly packaged + applications. I.e. under Unix you should follow the standard + installation conventions and under Mac you should create your + application bundle according to the Apple guidelines. Again, this + class doesn't help you to do it. + """ + def __init__(self): raise RuntimeError, "No constructor defined" + def __repr__(self): + return "<%s.%s; proxy of C++ wxStandardPaths instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) + def Get(*args, **kwargs): + """ + Get() -> StandardPaths + + Return the global standard paths singleton + """ + return _misc_.StandardPaths_Get(*args, **kwargs) + + Get = staticmethod(Get) + def GetConfigDir(*args, **kwargs): + """ + GetConfigDir(self) -> String + + Return the directory with system config files: /etc under Unix, + 'c:\Documents and Settings\All Users\Application Data' under Windows, + /Library/Preferences for Mac + """ + return _misc_.StandardPaths_GetConfigDir(*args, **kwargs) + + def GetUserConfigDir(*args, **kwargs): + """ + GetUserConfigDir(self) -> String + + Return the directory for the user config files: $HOME under Unix, + 'c:\Documents and Settings\username' under Windows, and + ~/Library/Preferences under Mac + + Only use this if you have a single file to put there, otherwise + `GetUserDataDir` is more appropriate + """ + return _misc_.StandardPaths_GetUserConfigDir(*args, **kwargs) + + def GetDataDir(*args, **kwargs): + """ + GetDataDir(self) -> String + + Return the location of the application's global, (i.e. not + user-specific,) data files: prefix/share/appname under Unix, + 'c:\Program Files\appname' under Windows, + appname.app/Contents/SharedSupport app bundle directory under Mac. + """ + return _misc_.StandardPaths_GetDataDir(*args, **kwargs) + + def GetLocalDataDir(*args, **kwargs): + """ + GetLocalDataDir(self) -> String + + Return the location for application data files which are + host-specific. Same as `GetDataDir` except under Unix where it is + /etc/appname + """ + return _misc_.StandardPaths_GetLocalDataDir(*args, **kwargs) + + def GetUserDataDir(*args, **kwargs): + """ + GetUserDataDir(self) -> String + + Return the directory for the user-dependent application data files: + $HOME/.appname under Unix, c:\Documents and + Settings\username\Application Data\appname under Windows and + ~/Library/Application Support/appname under Mac + """ + return _misc_.StandardPaths_GetUserDataDir(*args, **kwargs) + + def GetUserLocalDataDir(*args, **kwargs): + """ + GetUserLocalDataDir(self) -> String + + Return the directory for user data files which shouldn't be shared + with the other machines + + Same as `GetUserDataDir` for all platforms except Windows where it is + the 'Local Settings\Application Data\appname' directory. + """ + return _misc_.StandardPaths_GetUserLocalDataDir(*args, **kwargs) + + def GetPluginsDir(*args, **kwargs): + """ + GetPluginsDir(self) -> String + + Return the directory where the loadable modules (plugins) live: + prefix/lib/appname under Unix, program directory under Windows and + Contents/Plugins app bundle subdirectory under Mac + """ + return _misc_.StandardPaths_GetPluginsDir(*args, **kwargs) + + def SetInstallPrefix(*args, **kwargs): + """ + SetInstallPrefix(self, String prefix) + + Set the program installation directory which is /usr/local by default. + This value will be used by other methods such as `GetDataDir` and + `GetPluginsDir` as the prefix for what they return. (This function + only has meaning on Unix systems.) + """ + return _misc_.StandardPaths_SetInstallPrefix(*args, **kwargs) + + def GetInstallPrefix(*args, **kwargs): + """ + GetInstallPrefix(self) -> String + + Get the program installation prefix. The default is the prefix where + Python is installed. (This function only has meaning on Unix systems.) + """ + return _misc_.StandardPaths_GetInstallPrefix(*args, **kwargs) + + +class StandardPathsPtr(StandardPaths): + def __init__(self, this): + self.this = this + if not hasattr(self,"thisown"): self.thisown = 0 + self.__class__ = StandardPaths +_misc_.StandardPaths_swigregister(StandardPathsPtr) + +def StandardPaths_Get(*args, **kwargs): + """ + StandardPaths_Get() -> StandardPaths + + Return the global standard paths singleton + """ + return _misc_.StandardPaths_Get(*args, **kwargs) +