X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5acb46e0cde04773273611029a3b439d74c67bec..70ee369088ef1d54628883a1da7c20b1796d5b94:/wxPython/src/msw/_misc.py diff --git a/wxPython/src/msw/_misc.py b/wxPython/src/msw/_misc.py index f5a89755f3..b4494a0615 100644 --- a/wxPython/src/msw/_misc.py +++ b/wxPython/src/msw/_misc.py @@ -316,11 +316,6 @@ def EndBusyCursor(*args): """EndBusyCursor()""" return _misc_.EndBusyCursor(*args) -def GetElapsedTime(*args, **kwargs): - """GetElapsedTime(bool resetTimer=True) -> long""" - return _misc_.GetElapsedTime(*args, **kwargs) -GetElapsedTime = wx._deprecated(GetElapsedTime) - def IsBusy(*args): """IsBusy() -> bool""" return _misc_.IsBusy(*args) @@ -333,10 +328,6 @@ def Shell(*args, **kwargs): """Shell(String command=EmptyString) -> bool""" return _misc_.Shell(*args, **kwargs) -def StartTimer(*args): - """StartTimer()""" - return _misc_.StartTimer(*args) - def GetOsVersion(*args): """GetOsVersion() -> (platform, major, minor)""" return _misc_.GetOsVersion(*args) @@ -818,9 +809,8 @@ class Caret(object): Deletes the C++ object this Python object is a proxy for. """ - val = _misc_.Caret_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _misc_.Caret_Destroy(*args, **kwargs) def IsOk(*args, **kwargs): """IsOk(self) -> bool""" @@ -925,7 +915,7 @@ class BusyInfo(_core.Object): thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') __repr__ = _swig_repr def __init__(self, *args, **kwargs): - """__init__(self, String message) -> BusyInfo""" + """__init__(self, String message, Window parent=None) -> BusyInfo""" _misc_.BusyInfo_swiginit(self,_misc_.new_BusyInfo(*args, **kwargs)) __swig_destroy__ = _misc_.delete_BusyInfo __del__ = lambda self : None; @@ -939,6 +929,8 @@ class StopWatch(object): def __init__(self, *args, **kwargs): """__init__(self) -> StopWatch""" _misc_.StopWatch_swiginit(self,_misc_.new_StopWatch(*args, **kwargs)) + __swig_destroy__ = _misc_.delete_StopWatch + __del__ = lambda self : None; def Start(*args, **kwargs): """Start(self, long t0=0)""" return _misc_.StopWatch_Start(*args, **kwargs) @@ -1248,7 +1240,7 @@ class PyTipProvider(TipProvider): def __init__(self, *args, **kwargs): """__init__(self, size_t currentTip) -> PyTipProvider""" _misc_.PyTipProvider_swiginit(self,_misc_.new_PyTipProvider(*args, **kwargs)) - self._setCallbackInfo(self, PyTipProvider) + PyTipProvider._setCallbackInfo(self, self, PyTipProvider) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -1276,12 +1268,12 @@ class Timer(_core.EvtHandler): def __init__(self, *args, **kwargs): """__init__(self, EvtHandler owner=None, int id=ID_ANY) -> Timer""" _misc_.Timer_swiginit(self,_misc_.new_Timer(*args, **kwargs)) - self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self, 0) + self._setOORInfo(self,0); self.this.own(True); Timer._setCallbackInfo(self, self, Timer) __swig_destroy__ = _misc_.delete_Timer __del__ = lambda self : None; def _setCallbackInfo(*args, **kwargs): - """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)""" + """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)""" return _misc_.Timer__setCallbackInfo(*args, **kwargs) def SetOwner(*args, **kwargs): @@ -1538,9 +1530,8 @@ class Log(object): TimeStamp = staticmethod(TimeStamp) def Destroy(*args, **kwargs): """Destroy(self)""" - val = _misc_.Log_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _misc_.Log_Destroy(*args, **kwargs) _misc_.Log_swigregister(Log) @@ -1823,7 +1814,7 @@ class PyLog(Log): def __init__(self, *args, **kwargs): """__init__(self) -> PyLog""" _misc_.PyLog_swiginit(self,_misc_.new_PyLog(*args, **kwargs)) - self._setCallbackInfo(self, PyLog) + PyLog._setCallbackInfo(self, self, PyLog) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -1881,12 +1872,22 @@ class Process(_core.EvtHandler): def __init__(self, *args, **kwargs): """__init__(self, EvtHandler parent=None, int id=-1) -> Process""" _misc_.Process_swiginit(self,_misc_.new_Process(*args, **kwargs)) - self._setCallbackInfo(self, Process) + Process._setCallbackInfo(self, self, Process); self.this.own(False) + __swig_destroy__ = _misc_.delete_Process + __del__ = lambda self : None; def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" return _misc_.Process__setCallbackInfo(*args, **kwargs) + def GetPid(*args, **kwargs): + """ + GetPid(self) -> long + + get the process ID of the process executed by Open() + """ + return _misc_.Process_GetPid(*args, **kwargs) + def OnTerminate(*args, **kwargs): """OnTerminate(self, int pid, int status)""" return _misc_.Process_OnTerminate(*args, **kwargs) @@ -2604,7 +2605,7 @@ class ArtProvider(object): their own wx.ArtProvider class and easily replace standard art with his/her own version. It is easy thing to do: all that is needed is to derive a class from wx.ArtProvider, override it's CreateBitmap - method and register the provider with wx.ArtProvider.PushProvider:: + method and register the provider with `wx.ArtProvider.Push`:: class MyArtProvider(wx.ArtProvider): def __init__(self): @@ -2628,7 +2629,7 @@ class ArtProvider(object): their own wx.ArtProvider class and easily replace standard art with his/her own version. It is easy thing to do: all that is needed is to derive a class from wx.ArtProvider, override it's CreateBitmap - method and register the provider with wx.ArtProvider.PushProvider:: + method and register the provider with `wx.ArtProvider.Push`:: class MyArtProvider(wx.ArtProvider): def __init__(self): @@ -2640,7 +2641,7 @@ class ArtProvider(object): """ _misc_.ArtProvider_swiginit(self,_misc_.new_ArtProvider(*args, **kwargs)) - self._setCallbackInfo(self, ArtProvider) + ArtProvider._setCallbackInfo(self, self, ArtProvider) __swig_destroy__ = _misc_.delete_ArtProvider __del__ = lambda self : None; @@ -2648,45 +2649,49 @@ class ArtProvider(object): """_setCallbackInfo(self, PyObject self, PyObject _class)""" return _misc_.ArtProvider__setCallbackInfo(*args, **kwargs) - def PushProvider(*args, **kwargs): + def Push(*args, **kwargs): """ - PushProvider(ArtProvider provider) + Push(ArtProvider provider) Add new provider to the top of providers stack. """ - return _misc_.ArtProvider_PushProvider(*args, **kwargs) + return _misc_.ArtProvider_Push(*args, **kwargs) - PushProvider = staticmethod(PushProvider) - def InsertProvider(*args, **kwargs): + Push = staticmethod(Push) + PushProvider = Push + def Insert(*args, **kwargs): """ - InsertProvider(ArtProvider provider) + Insert(ArtProvider provider) Add new provider to the bottom of providers stack. """ - return _misc_.ArtProvider_InsertProvider(*args, **kwargs) + return _misc_.ArtProvider_Insert(*args, **kwargs) - InsertProvider = staticmethod(InsertProvider) - def PopProvider(*args, **kwargs): + Insert = staticmethod(Insert) + InsertProvider = Insert + def Pop(*args, **kwargs): """ - PopProvider() -> bool + Pop() -> bool Remove latest added provider and delete it. """ - return _misc_.ArtProvider_PopProvider(*args, **kwargs) + return _misc_.ArtProvider_Pop(*args, **kwargs) - PopProvider = staticmethod(PopProvider) - def RemoveProvider(*args, **kwargs): + Pop = staticmethod(Pop) + PopProvider = Pop + def Delete(*args, **kwargs): """ - RemoveProvider(ArtProvider provider) -> bool + Delete(ArtProvider provider) -> bool Remove provider. The provider must have been added previously! The provider is _not_ deleted. """ - val = _misc_.ArtProvider_RemoveProvider(*args, **kwargs) + val = _misc_.ArtProvider_Delete(*args, **kwargs) args[1].thisown = 1 return val - RemoveProvider = staticmethod(RemoveProvider) + Delete = staticmethod(Delete) + RemoveProvider = Delete def GetBitmap(*args, **kwargs): """ GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -> Bitmap @@ -2719,9 +2724,8 @@ class ArtProvider(object): GetSizeHint = staticmethod(GetSizeHint) def Destroy(*args, **kwargs): """Destroy(self)""" - val = _misc_.ArtProvider_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _misc_.ArtProvider_Destroy(*args, **kwargs) _misc_.ArtProvider_swigregister(ArtProvider) ART_TOOLBAR = cvar.ART_TOOLBAR @@ -2781,38 +2785,38 @@ ART_QUIT = cvar.ART_QUIT ART_FIND = cvar.ART_FIND ART_FIND_AND_REPLACE = cvar.ART_FIND_AND_REPLACE -def ArtProvider_PushProvider(*args, **kwargs): +def ArtProvider_Push(*args, **kwargs): """ - ArtProvider_PushProvider(ArtProvider provider) + ArtProvider_Push(ArtProvider provider) Add new provider to the top of providers stack. """ - return _misc_.ArtProvider_PushProvider(*args, **kwargs) + return _misc_.ArtProvider_Push(*args, **kwargs) -def ArtProvider_InsertProvider(*args, **kwargs): +def ArtProvider_Insert(*args, **kwargs): """ - ArtProvider_InsertProvider(ArtProvider provider) + ArtProvider_Insert(ArtProvider provider) Add new provider to the bottom of providers stack. """ - return _misc_.ArtProvider_InsertProvider(*args, **kwargs) + return _misc_.ArtProvider_Insert(*args, **kwargs) -def ArtProvider_PopProvider(*args): +def ArtProvider_Pop(*args): """ - ArtProvider_PopProvider() -> bool + ArtProvider_Pop() -> bool Remove latest added provider and delete it. """ - return _misc_.ArtProvider_PopProvider(*args) + return _misc_.ArtProvider_Pop(*args) -def ArtProvider_RemoveProvider(*args, **kwargs): +def ArtProvider_Delete(*args, **kwargs): """ - ArtProvider_RemoveProvider(ArtProvider provider) -> bool + ArtProvider_Delete(ArtProvider provider) -> bool Remove provider. The provider must have been added previously! The provider is _not_ deleted. """ - val = _misc_.ArtProvider_RemoveProvider(*args, **kwargs) + val = _misc_.ArtProvider_Delete(*args, **kwargs) args[1].thisown = 1 return val @@ -3294,8 +3298,26 @@ class FileConfig(ConfigBase): _misc_.FileConfig_swiginit(self,_misc_.new_FileConfig(*args, **kwargs)) __swig_destroy__ = _misc_.delete_FileConfig __del__ = lambda self : None; + def GetGlobalFileName(*args, **kwargs): + """GetGlobalFileName(String szFile) -> String""" + return _misc_.FileConfig_GetGlobalFileName(*args, **kwargs) + + GetGlobalFileName = staticmethod(GetGlobalFileName) + def GetLocalFileName(*args, **kwargs): + """GetLocalFileName(String szFile, int style=0) -> String""" + return _misc_.FileConfig_GetLocalFileName(*args, **kwargs) + + GetLocalFileName = staticmethod(GetLocalFileName) _misc_.FileConfig_swigregister(FileConfig) +def FileConfig_GetGlobalFileName(*args, **kwargs): + """FileConfig_GetGlobalFileName(String szFile) -> String""" + return _misc_.FileConfig_GetGlobalFileName(*args, **kwargs) + +def FileConfig_GetLocalFileName(*args, **kwargs): + """FileConfig_GetLocalFileName(String szFile, int style=0) -> String""" + return _misc_.FileConfig_GetLocalFileName(*args, **kwargs) + class ConfigPathChanger(object): """ A handy little class which changes current path to the path of given @@ -3363,6 +3385,7 @@ class DateTime(object): GMT10 = _misc_.DateTime_GMT10 GMT11 = _misc_.DateTime_GMT11 GMT12 = _misc_.DateTime_GMT12 + GMT13 = _misc_.DateTime_GMT13 WET = _misc_.DateTime_WET WEST = _misc_.DateTime_WEST CET = _misc_.DateTime_CET @@ -3388,6 +3411,8 @@ class DateTime(object): A_CST = _misc_.DateTime_A_CST A_EST = _misc_.DateTime_A_EST A_ESST = _misc_.DateTime_A_ESST + NZST = _misc_.DateTime_NZST + NZDT = _misc_.DateTime_NZDT UTC = _misc_.DateTime_UTC Gregorian = _misc_.DateTime_Gregorian Julian = _misc_.DateTime_Julian @@ -3623,6 +3648,10 @@ class DateTime(object): """ResetTime(self) -> DateTime""" return _misc_.DateTime_ResetTime(*args, **kwargs) + def GetDateOnly(*args, **kwargs): + """GetDateOnly(self) -> DateTime""" + return _misc_.DateTime_GetDateOnly(*args, **kwargs) + def SetYear(*args, **kwargs): """SetYear(self, int year) -> DateTime""" return _misc_.DateTime_SetYear(*args, **kwargs) @@ -3687,17 +3716,6 @@ class DateTime(object): """GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime""" return _misc_.DateTime_GetLastWeekDay(*args, **kwargs) - def SetToTheWeek(*args, **kwargs): - """SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool""" - return _misc_.DateTime_SetToTheWeek(*args, **kwargs) - - def GetWeek(*args, **kwargs): - """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) @@ -3787,8 +3805,9 @@ class DateTime(object): """IsValid(self) -> bool""" return _misc_.DateTime_IsValid(*args, **kwargs) - Ok = IsValid - def __nonzero__(self): return self.Ok() + IsOk = IsValid + Ok = IsOk + def __nonzero__(self): return self.IsOk() def GetTicks(*args, **kwargs): """GetTicks(self) -> time_t""" return _misc_.DateTime_GetTicks(*args, **kwargs) @@ -4015,7 +4034,6 @@ class DateTime(object): RataDie = property(GetRataDie,doc="See `GetRataDie`") Second = property(GetSecond,SetSecond,doc="See `GetSecond` and `SetSecond`") Ticks = property(GetTicks,doc="See `GetTicks`") - Week = property(GetWeek,doc="See `GetWeek`") WeekDay = property(GetWeekDay,doc="See `GetWeekDay`") WeekDayInSameWeek = property(GetWeekDayInSameWeek,doc="See `GetWeekDayInSameWeek`") WeekOfMonth = property(GetWeekOfMonth,doc="See `GetWeekOfMonth`") @@ -4667,14 +4685,15 @@ class DataFormat(object): """ return _misc_.DataFormat_GetType(*args, **kwargs) - def GetId(*args, **kwargs): - """ - GetId(self) -> String + def _GetId(*args, **kwargs): + """_GetId(self) -> String""" + return _misc_.DataFormat__GetId(*args, **kwargs) - Returns the name of a custom format (this function will fail for a - standard format). - """ - return _misc_.DataFormat_GetId(*args, **kwargs) + def GetId(self): + """Returns the name of a custom format (this function will fail for a + format).""" + nolog = wx.LogNull() + return self._GetId() def SetId(*args, **kwargs): """ @@ -4882,7 +4901,7 @@ class PyDataObjectSimple(DataObjectSimple): """ _misc_.PyDataObjectSimple_swiginit(self,_misc_.new_PyDataObjectSimple(*args, **kwargs)) - self._setCallbackInfo(self, PyDataObjectSimple) + PyDataObjectSimple._setCallbackInfo(self, self, PyDataObjectSimple) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5031,7 +5050,7 @@ class PyTextDataObject(TextDataObject): into the data object. """ _misc_.PyTextDataObject_swiginit(self,_misc_.new_PyTextDataObject(*args, **kwargs)) - self._setCallbackInfo(self, PyTextDataObject) + PyTextDataObject._setCallbackInfo(self, self, PyTextDataObject) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5100,7 +5119,7 @@ class PyBitmapDataObject(BitmapDataObject): data on demand derive from this class and overload `GetBitmap`. """ _misc_.PyBitmapDataObject_swiginit(self,_misc_.new_PyBitmapDataObject(*args, **kwargs)) - self._setCallbackInfo(self, PyBitmapDataObject) + PyBitmapDataObject._setCallbackInfo(self, self, PyBitmapDataObject) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5269,10 +5288,10 @@ class DropSource(object): Cursor none=wxNullCursor) -> DropSource """ _misc_.DropSource_swiginit(self,_misc_.new_DropSource(*args, **kwargs)) - self._setCallbackInfo(self, DropSource, 0) + DropSource._setCallbackInfo(self, self, DropSource) def _setCallbackInfo(*args, **kwargs): - """_setCallbackInfo(self, PyObject self, PyObject _class, int incref)""" + """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)""" return _misc_.DropSource__setCallbackInfo(*args, **kwargs) __swig_destroy__ = _misc_.delete_DropSource @@ -5324,7 +5343,7 @@ class DropTarget(object): def __init__(self, *args, **kwargs): """__init__(self, DataObject dataObject=None) -> DropTarget""" _misc_.DropTarget_swiginit(self,_misc_.new_DropTarget(*args, **kwargs)) - self._setCallbackInfo(self, DropTarget) + DropTarget._setCallbackInfo(self, self, DropTarget) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5388,7 +5407,6 @@ class DropTarget(object): """GetDefaultAction(self) -> int""" return _misc_.DropTarget_GetDefaultAction(*args, **kwargs) - Data = property(GetData,doc="See `GetData`") DataObject = property(GetDataObject,SetDataObject,doc="See `GetDataObject` and `SetDataObject`") DefaultAction = property(GetDefaultAction,SetDefaultAction,doc="See `GetDefaultAction` and `SetDefaultAction`") _misc_.DropTarget_swigregister(DropTarget) @@ -5401,7 +5419,7 @@ class TextDropTarget(DropTarget): def __init__(self, *args, **kwargs): """__init__(self) -> TextDropTarget""" _misc_.TextDropTarget_swiginit(self,_misc_.new_TextDropTarget(*args, **kwargs)) - self._setCallbackInfo(self, TextDropTarget) + TextDropTarget._setCallbackInfo(self, self, TextDropTarget) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5470,7 +5488,7 @@ class FileDropTarget(DropTarget): def __init__(self, *args, **kwargs): """__init__(self) -> FileDropTarget""" _misc_.FileDropTarget_swiginit(self,_misc_.new_FileDropTarget(*args, **kwargs)) - self._setCallbackInfo(self, FileDropTarget) + FileDropTarget._setCallbackInfo(self, self, FileDropTarget) def _setCallbackInfo(*args, **kwargs): """_setCallbackInfo(self, PyObject self, PyObject _class)""" @@ -5666,7 +5684,6 @@ class Clipboard(_core.Object): return _misc_.Clipboard_Get(*args, **kwargs) Get = staticmethod(Get) - Data = property(GetData,SetData,doc="See `GetData` and `SetData`") _misc_.Clipboard_swigregister(Clipboard) def Clipboard_Get(*args): @@ -5805,7 +5822,7 @@ class Display(object): __repr__ = _swig_repr def __init__(self, *args, **kwargs): """ - __init__(self, size_t index=0) -> Display + __init__(self, unsigned int index=0) -> Display Set up a Display instance with the specified display. The displays are numbered from 0 to GetCount() - 1, 0 is always the primary display @@ -5816,7 +5833,7 @@ class Display(object): __del__ = lambda self : None; def GetCount(*args, **kwargs): """ - GetCount() -> size_t + GetCount() -> unsigned int Return the number of available displays. """ @@ -5950,7 +5967,7 @@ DefaultVideoMode = cvar.DefaultVideoMode def Display_GetCount(*args): """ - Display_GetCount() -> size_t + Display_GetCount() -> unsigned int Return the number of available displays. """ @@ -6018,6 +6035,16 @@ class StandardPaths(object): return _misc_.StandardPaths_Get(*args, **kwargs) Get = staticmethod(Get) + def GetExecutablePath(*args, **kwargs): + """ + GetExecutablePath(self) -> String + + Return the path (directory+filename) of the running executable or an + empty string if it couldn't be determined. The path is returned as an + absolute path whenever possible. + """ + return _misc_.StandardPaths_GetExecutablePath(*args, **kwargs) + def GetConfigDir(*args, **kwargs): """ GetConfigDir(self) -> String @@ -6132,6 +6159,14 @@ class StandardPaths(object): """ return _misc_.StandardPaths_GetDocumentsDir(*args, **kwargs) + def GetTempDir(*args, **kwargs): + """ + GetTempDir(self) -> String + + Return the user's directory for temporary files. + """ + return _misc_.StandardPaths_GetTempDir(*args, **kwargs) + def SetInstallPrefix(*args, **kwargs): """ SetInstallPrefix(self, String prefix) @@ -6222,5 +6257,413 @@ def GetBatteryState(*args): return approximate battery state """ return _misc_.GetBatteryState(*args) +#--------------------------------------------------------------------------- + +class AboutDialogInfo(object): + """ + `wx.AboutDialogInfo` contains information to be shown in the standard + About dialog displayed by the `wx.AboutBox` function. This class + contains the general information about the program, such as its name, + version, copyright and so on, as well as lists of the program + developers, documentation writers, artists and translators. + + While all the main platforms have a native implementation of the about + dialog, they are often more limited than the generic version provided + by wxWidgets and so the generic version is used if + `wx.AboutDialogInfo` has any fields not supported by the native + version. Currently GTK+ version supports all the possible fields + natively but MSW and Mac versions don't support URLs, licence text nor + custom icons in the about dialog and if either of those is used, + wxAboutBox() will automatically use the generic version so you should + avoid specifying these fields to achieve more native look and feel. + + """ + thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') + __repr__ = _swig_repr + def __init__(self, *args, **kwargs): + """ + __init__(self) -> AboutDialogInfo + + `wx.AboutDialogInfo` contains information to be shown in the standard + About dialog displayed by the `wx.AboutBox` function. This class + contains the general information about the program, such as its name, + version, copyright and so on, as well as lists of the program + developers, documentation writers, artists and translators. + + While all the main platforms have a native implementation of the about + dialog, they are often more limited than the generic version provided + by wxWidgets and so the generic version is used if + `wx.AboutDialogInfo` has any fields not supported by the native + version. Currently GTK+ version supports all the possible fields + natively but MSW and Mac versions don't support URLs, licence text nor + custom icons in the about dialog and if either of those is used, + wxAboutBox() will automatically use the generic version so you should + avoid specifying these fields to achieve more native look and feel. + + """ + _misc_.AboutDialogInfo_swiginit(self,_misc_.new_AboutDialogInfo(*args, **kwargs)) + __swig_destroy__ = _misc_.delete_AboutDialogInfo + __del__ = lambda self : None; + def SetName(*args, **kwargs): + """ + SetName(self, String name) + + Set the name of the program. If this method is not called, the string + returned by `wx.App.GetAppName` will be shown in the dialog. + """ + return _misc_.AboutDialogInfo_SetName(*args, **kwargs) + + def GetName(*args, **kwargs): + """ + GetName(self) -> String + + Returns the program name. + """ + return _misc_.AboutDialogInfo_GetName(*args, **kwargs) + + Name = property(GetName,SetName) + def SetVersion(*args, **kwargs): + """ + SetVersion(self, String version) + + Set the version of the program. The version is in free format, + i.e. not necessarily in the x.y.z form but it shouldn't contain the + "version" word. + """ + return _misc_.AboutDialogInfo_SetVersion(*args, **kwargs) + + def HasVersion(*args, **kwargs): + """ + HasVersion(self) -> bool + + Returns ``True`` if the version property has been set. + """ + return _misc_.AboutDialogInfo_HasVersion(*args, **kwargs) + + def GetVersion(*args, **kwargs): + """ + GetVersion(self) -> String + + Returns the version value. + """ + return _misc_.AboutDialogInfo_GetVersion(*args, **kwargs) + + Version = property(GetVersion,SetVersion) + def SetDescription(*args, **kwargs): + """ + SetDescription(self, String desc) + + Set brief, but possibly multiline, description of the program. + """ + return _misc_.AboutDialogInfo_SetDescription(*args, **kwargs) + + def HasDescription(*args, **kwargs): + """ + HasDescription(self) -> bool + + Returns ``True`` if the description property has been set. + """ + return _misc_.AboutDialogInfo_HasDescription(*args, **kwargs) + + def GetDescription(*args, **kwargs): + """ + GetDescription(self) -> String + + Returns the description value. + """ + return _misc_.AboutDialogInfo_GetDescription(*args, **kwargs) + + Description = property(GetDescription,SetDescription) + def SetCopyright(*args, **kwargs): + """ + SetCopyright(self, String copyright) + + Set the short string containing the program copyright + information. Notice that any occurrences of "(C)" in ``copyright`` + will be replaced by the copyright symbol (circled C) automatically, + which means that you can avoid using this symbol in the program source + code which can be problematic. + """ + return _misc_.AboutDialogInfo_SetCopyright(*args, **kwargs) + + def HasCopyright(*args, **kwargs): + """ + HasCopyright(self) -> bool + + Returns ``True`` if the copyright property has been set. + """ + return _misc_.AboutDialogInfo_HasCopyright(*args, **kwargs) + + def GetCopyright(*args, **kwargs): + """ + GetCopyright(self) -> String + + Returns the copyright value. + """ + return _misc_.AboutDialogInfo_GetCopyright(*args, **kwargs) + + Copyright = property(GetCopyright,SetCopyright) + def SetLicence(*args, **kwargs): + """ + SetLicence(self, String licence) + + Set the long, multiline string containing the text of the program + licence. + + Only GTK+ version supports showing the licence text in the native + about dialog currently so the generic version will be used under all + the other platforms if this method is called. To preserve the native + look and feel it is advised that you do not call this method but + provide a separate menu item in the "Help" menu for displaying the + text of your program licence. + + """ + return _misc_.AboutDialogInfo_SetLicence(*args, **kwargs) + + def SetLicense(*args, **kwargs): + """ + SetLicense(self, String licence) + + This is the same as `SetLicence`. + """ + return _misc_.AboutDialogInfo_SetLicense(*args, **kwargs) + + def HasLicence(*args, **kwargs): + """ + HasLicence(self) -> bool + + Returns ``True`` if the licence property has been set. + """ + return _misc_.AboutDialogInfo_HasLicence(*args, **kwargs) + + def GetLicence(*args, **kwargs): + """ + GetLicence(self) -> String + + Returns the licence value. + """ + return _misc_.AboutDialogInfo_GetLicence(*args, **kwargs) + + Licence = property(GetLicence,SetLicence) + License = Licence + def SetIcon(*args, **kwargs): + """ + SetIcon(self, Icon icon) + + Set the icon to be shown in the dialog. By default the icon of the + main frame will be shown if the native about dialog supports custom + icons. If it doesn't but a valid icon is specified using this method, + the generic about dialog is used instead so you should avoid calling + this function for maximally native look and feel. + """ + return _misc_.AboutDialogInfo_SetIcon(*args, **kwargs) + + def HasIcon(*args, **kwargs): + """ + HasIcon(self) -> bool + + Returns ``True`` if the icon property has been set. + """ + return _misc_.AboutDialogInfo_HasIcon(*args, **kwargs) + + def GetIcon(*args, **kwargs): + """ + GetIcon(self) -> Icon + + Return the current icon value. + """ + return _misc_.AboutDialogInfo_GetIcon(*args, **kwargs) + + Icon = property(GetIcon,SetIcon) + def _SetWebSite(*args, **kwargs): + """_SetWebSite(self, String url, String desc=wxEmptyString)""" + return _misc_.AboutDialogInfo__SetWebSite(*args, **kwargs) + + def _GetWebSiteURL(*args, **kwargs): + """_GetWebSiteURL(self) -> String""" + return _misc_.AboutDialogInfo__GetWebSiteURL(*args, **kwargs) + + def _GetWebSiteDescription(*args, **kwargs): + """_GetWebSiteDescription(self) -> String""" + return _misc_.AboutDialogInfo__GetWebSiteDescription(*args, **kwargs) + + def HasWebSite(*args, **kwargs): + """HasWebSite(self) -> bool""" + return _misc_.AboutDialogInfo_HasWebSite(*args, **kwargs) + + def SetWebSite(self, args): + """ + SetWebSite(self, URL, [Description]) + + Set the web site property. The ``args`` parameter can + either be a single string for the URL, to a 2-tuple of + (URL, Description) strings. + """ + if type(args) in [str, unicode]: + self._SetWebSite(args) + else: + self._SetWebSite(args[0], args[1]) + + def GetWebSite(self): + """ + GetWebSite(self) --> (URL, Description) + """ + return (self._GetWebSiteURL(), self._GetWebSiteDescription()) + + WebSite = property(GetWebSite,SetWebSite) + def SetDevelopers(*args, **kwargs): + """ + SetDevelopers(self, list developers) + + Set the list of the developers of the program. + """ + return _misc_.AboutDialogInfo_SetDevelopers(*args, **kwargs) + + def AddDeveloper(*args, **kwargs): + """ + AddDeveloper(self, String developer) + + Add a string to the list of developers. + """ + return _misc_.AboutDialogInfo_AddDeveloper(*args, **kwargs) + + def HasDevelopers(*args, **kwargs): + """ + HasDevelopers(self) -> bool + + Returns ``True if any developers have been set. + """ + return _misc_.AboutDialogInfo_HasDevelopers(*args, **kwargs) + + def GetDevelopers(*args, **kwargs): + """ + GetDevelopers(self) --> list + + Returns the list of developers. + """ + return _misc_.AboutDialogInfo_GetDevelopers(*args, **kwargs) + + Developers = property(GetDevelopers,SetDevelopers) + def SetDocWriters(*args, **kwargs): + """ + SetDocWriters(self, list docwriters) + + Set the list of the documentation writers. + """ + return _misc_.AboutDialogInfo_SetDocWriters(*args, **kwargs) + + def AddDocWriter(*args, **kwargs): + """ + AddDocWriter(self, String docwriter) + + Add a string to the list of documentation writers. + """ + return _misc_.AboutDialogInfo_AddDocWriter(*args, **kwargs) + + def HasDocWriters(*args, **kwargs): + """ + HasDocWriters(self) -> bool + + Returns ``True if any documentation writers have been set. + """ + return _misc_.AboutDialogInfo_HasDocWriters(*args, **kwargs) + + def GetDocWriters(*args, **kwargs): + """ + GetDocWriters(self) --> list + + Returns the list of documentation writers. + """ + return _misc_.AboutDialogInfo_GetDocWriters(*args, **kwargs) + + DocWriters = property(GetDocWriters,SetDocWriters) + def SetArtists(*args, **kwargs): + """ + SetArtists(self, list artists) + + Set the list of artists for the program. + """ + return _misc_.AboutDialogInfo_SetArtists(*args, **kwargs) + + def AddArtist(*args, **kwargs): + """ + AddArtist(self, String artist) + + Add a string to the list of artists. + """ + return _misc_.AboutDialogInfo_AddArtist(*args, **kwargs) + + def HasArtists(*args, **kwargs): + """ + HasArtists(self) -> bool + + Returns ``True`` if any artists have been set. + """ + return _misc_.AboutDialogInfo_HasArtists(*args, **kwargs) + + def GetArtists(*args, **kwargs): + """ + GetArtists(self) --> list + + Returns the list od artists. + """ + return _misc_.AboutDialogInfo_GetArtists(*args, **kwargs) + + Artists = property(GetArtists,SetArtists) + def SetTranslators(*args, **kwargs): + """ + SetTranslators(self, list translators) + + Sets the list of program translators. + """ + return _misc_.AboutDialogInfo_SetTranslators(*args, **kwargs) + + def AddTranslator(*args, **kwargs): + """ + AddTranslator(self, String translator) + + Add a string to the list of translators. + """ + return _misc_.AboutDialogInfo_AddTranslator(*args, **kwargs) + + def HasTranslators(*args, **kwargs): + """ + HasTranslators(self) -> bool + + Returns ``True`` if any translators have been set. + """ + return _misc_.AboutDialogInfo_HasTranslators(*args, **kwargs) + + def GetTranslators(*args, **kwargs): + """ + GetTranslators(self) --> list + + Returns the list of program translators. + """ + return _misc_.AboutDialogInfo_GetTranslators(*args, **kwargs) + + Translators = property(GetTranslators,SetTranslators) + def IsSimple(*args, **kwargs): + """IsSimple(self) -> bool""" + return _misc_.AboutDialogInfo_IsSimple(*args, **kwargs) + + def GetDescriptionAndCredits(*args, **kwargs): + """GetDescriptionAndCredits(self) -> String""" + return _misc_.AboutDialogInfo_GetDescriptionAndCredits(*args, **kwargs) + +_misc_.AboutDialogInfo_swigregister(AboutDialogInfo) + + +def AboutBox(*args, **kwargs): + """ + AboutBox(AboutDialogInfo info) + + This function shows the standard about dialog containing the + information specified in ``info``. If the current platform has a + native about dialog which is capable of showing all the fields in + `wx.AboutDialogInfo`, the native dialog is used, otherwise the + function falls back to the generic wxWidgets version of the dialog. + """ + return _misc_.AboutBox(*args, **kwargs)