X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/226118fcadb598b473fcac6636ebad6015d9fc6e..944311338650b4f09403e04696a0758eba8db452:/wxPython/src/msw/_misc.py diff --git a/wxPython/src/msw/_misc.py b/wxPython/src/msw/_misc.py index d31c055491..e8738b0e3d 100644 --- a/wxPython/src/msw/_misc.py +++ b/wxPython/src/msw/_misc.py @@ -273,6 +273,9 @@ def SystemOptions_IsFalse(*args, **kwargs): """SystemOptions_IsFalse(String name) -> bool""" return _misc_.SystemOptions_IsFalse(*args, **kwargs) +# Until the new native control for wxMac is up to par, still use the generic one. +SystemOptions.SetOptionInt("mac.listctrl.always_use_generic", 1) + #--------------------------------------------------------------------------- @@ -295,10 +298,18 @@ def IsStockID(*args, **kwargs): def IsStockLabel(*args, **kwargs): """IsStockLabel(int id, String label) -> bool""" return _misc_.IsStockLabel(*args, **kwargs) +STOCK_NOFLAGS = _misc_.STOCK_NOFLAGS +STOCK_WITH_MNEMONIC = _misc_.STOCK_WITH_MNEMONIC +STOCK_WITH_ACCELERATOR = _misc_.STOCK_WITH_ACCELERATOR def GetStockLabel(*args, **kwargs): - """GetStockLabel(int id, bool withCodes=True, String accelerator=EmptyString) -> String""" + """GetStockLabel(int id, long flags=STOCK_WITH_MNEMONIC) -> String""" return _misc_.GetStockLabel(*args, **kwargs) +STOCK_MENU = _misc_.STOCK_MENU + +def GetStockHelpString(*args, **kwargs): + """GetStockHelpString(int id, int client=STOCK_MENU) -> String""" + return _misc_.GetStockHelpString(*args, **kwargs) def Bell(*args): """Bell()""" @@ -783,6 +794,8 @@ class ToolTip(_core.Object): return _misc_.ToolTip_SetDelay(*args, **kwargs) SetDelay = staticmethod(SetDelay) + Tip = property(GetTip,SetTip,doc="See `GetTip` and `SetTip`") + Window = property(GetWindow,doc="See `GetWindow`") _misc_.ToolTip_swigregister(ToolTip) def ToolTip_Enable(*args, **kwargs): @@ -808,9 +821,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""" @@ -1001,6 +1013,10 @@ class FileHistory(_core.Object): return _misc_.FileHistory_GetCount(*args, **kwargs) GetNoHistoryFiles = GetCount + Count = property(GetCount,doc="See `GetCount`") + HistoryFile = property(GetHistoryFile,doc="See `GetHistoryFile`") + MaxFiles = property(GetMaxFiles,doc="See `GetMaxFiles`") + NoHistoryFiles = property(GetNoHistoryFiles,doc="See `GetNoHistoryFiles`") _misc_.FileHistory_swigregister(FileHistory) class SingleInstanceChecker(object): @@ -1094,6 +1110,10 @@ class PlatformInformation(object): """GetOSMinorVersion(self) -> int""" return _misc_.PlatformInformation_GetOSMinorVersion(*args, **kwargs) + def CheckOSVersion(*args, **kwargs): + """CheckOSVersion(self, int major, int minor) -> bool""" + return _misc_.PlatformInformation_CheckOSVersion(*args, **kwargs) + def GetToolkitMajorVersion(*args, **kwargs): """GetToolkitMajorVersion(self) -> int""" return _misc_.PlatformInformation_GetToolkitMajorVersion(*args, **kwargs) @@ -1102,6 +1122,10 @@ class PlatformInformation(object): """GetToolkitMinorVersion(self) -> int""" return _misc_.PlatformInformation_GetToolkitMinorVersion(*args, **kwargs) + def CheckToolkitVersion(*args, **kwargs): + """CheckToolkitVersion(self, int major, int minor) -> bool""" + return _misc_.PlatformInformation_CheckToolkitVersion(*args, **kwargs) + def IsUsingUniversalWidgets(*args, **kwargs): """IsUsingUniversalWidgets(self) -> bool""" return _misc_.PlatformInformation_IsUsingUniversalWidgets(*args, **kwargs) @@ -1174,6 +1198,20 @@ class PlatformInformation(object): """IsOk(self) -> bool""" return _misc_.PlatformInformation_IsOk(*args, **kwargs) + ArchName = property(GetArchName,doc="See `GetArchName`") + Architecture = property(GetArchitecture,SetArchitecture,doc="See `GetArchitecture` and `SetArchitecture`") + Endianness = property(GetEndianness,SetEndianness,doc="See `GetEndianness` and `SetEndianness`") + EndiannessName = property(GetEndiannessName,doc="See `GetEndiannessName`") + OSMajorVersion = property(GetOSMajorVersion,doc="See `GetOSMajorVersion`") + OSMinorVersion = property(GetOSMinorVersion,doc="See `GetOSMinorVersion`") + OperatingSystemFamilyName = property(GetOperatingSystemFamilyName,doc="See `GetOperatingSystemFamilyName`") + OperatingSystemId = property(GetOperatingSystemId,SetOperatingSystemId,doc="See `GetOperatingSystemId` and `SetOperatingSystemId`") + OperatingSystemIdName = property(GetOperatingSystemIdName,doc="See `GetOperatingSystemIdName`") + PortId = property(GetPortId,SetPortId,doc="See `GetPortId` and `SetPortId`") + PortIdName = property(GetPortIdName,doc="See `GetPortIdName`") + PortIdShortName = property(GetPortIdShortName,doc="See `GetPortIdShortName`") + ToolkitMajorVersion = property(GetToolkitMajorVersion,doc="See `GetToolkitMajorVersion`") + ToolkitMinorVersion = property(GetToolkitMinorVersion,doc="See `GetToolkitMinorVersion`") _misc_.PlatformInformation_swigregister(PlatformInformation) @@ -1201,6 +1239,8 @@ class TipProvider(object): """PreprocessTip(self, String tip) -> String""" return _misc_.TipProvider_PreprocessTip(*args, **kwargs) + CurrentTip = property(GetCurrentTip,doc="See `GetCurrentTip`") + Tip = property(GetTip,doc="See `GetTip`") _misc_.TipProvider_swigregister(TipProvider) class PyTipProvider(TipProvider): @@ -1286,6 +1326,9 @@ class Timer(_core.EvtHandler): """NO-OP: Timers must be destroyed by normal reference counting""" pass + Id = property(GetId,doc="See `GetId`") + Interval = property(GetInterval,doc="See `GetInterval`") + Owner = property(GetOwner,SetOwner,doc="See `GetOwner` and `SetOwner`") _misc_.Timer_swigregister(Timer) # For backwards compatibility with 2.4 @@ -1313,6 +1356,7 @@ class TimerEvent(_core.Event): """GetInterval(self) -> int""" return _misc_.TimerEvent_GetInterval(*args, **kwargs) + Interval = property(GetInterval,doc="See `GetInterval`") _misc_.TimerEvent_swigregister(TimerEvent) class TimerRunner(object): @@ -1496,9 +1540,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) @@ -1656,6 +1699,8 @@ class LogWindow(Log): """PassMessages(self, bool bDoPass)""" return _misc_.LogWindow_PassMessages(*args, **kwargs) + Frame = property(GetFrame,doc="See `GetFrame`") + OldLog = property(GetOldLog,doc="See `GetOldLog`") _misc_.LogWindow_swigregister(LogWindow) class LogChain(Log): @@ -1681,6 +1726,7 @@ class LogChain(Log): """GetOldLog(self) -> Log""" return _misc_.LogChain_GetOldLog(*args, **kwargs) + OldLog = property(GetOldLog,doc="See `GetOldLog`") _misc_.LogChain_swigregister(LogChain) class LogBuffer(Log): @@ -1694,6 +1740,7 @@ class LogBuffer(Log): """GetBuffer(self) -> String""" return _misc_.LogBuffer_GetBuffer(*args, **kwargs) + Buffer = property(GetBuffer,doc="See `GetBuffer`") _misc_.LogBuffer_swigregister(LogBuffer) @@ -1890,6 +1937,12 @@ class Process(_core.EvtHandler): """IsErrorAvailable(self) -> bool""" return _misc_.Process_IsErrorAvailable(*args, **kwargs) + ErrorStream = property(GetErrorStream,doc="See `GetErrorStream`") + InputStream = property(GetInputStream,doc="See `GetInputStream`") + OutputStream = property(GetOutputStream,doc="See `GetOutputStream`") + InputOpened = property(IsInputOpened) + InputAvailable = property(IsInputAvailable) + ErrorAvailable = property(IsErrorAvailable) _misc_.Process_swigregister(Process) def Process_Kill(*args, **kwargs): @@ -1921,6 +1974,8 @@ class ProcessEvent(_core.Event): m_pid = property(_misc_.ProcessEvent_m_pid_get, _misc_.ProcessEvent_m_pid_set) m_exitcode = property(_misc_.ProcessEvent_m_exitcode_get, _misc_.ProcessEvent_m_exitcode_set) + ExitCode = property(GetExitCode,doc="See `GetExitCode`") + Pid = property(GetPid,doc="See `GetPid`") _misc_.ProcessEvent_swigregister(ProcessEvent) wxEVT_END_PROCESS = _misc_.wxEVT_END_PROCESS @@ -2126,6 +2181,37 @@ class Joystick(object): return _misc_.Joystick_ReleaseCapture(*args, **kwargs) def __nonzero__(self): return self.IsOk() + ButtonState = property(GetButtonState,doc="See `GetButtonState`") + ManufacturerId = property(GetManufacturerId,doc="See `GetManufacturerId`") + MaxAxes = property(GetMaxAxes,doc="See `GetMaxAxes`") + MaxButtons = property(GetMaxButtons,doc="See `GetMaxButtons`") + MovementThreshold = property(GetMovementThreshold,SetMovementThreshold,doc="See `GetMovementThreshold` and `SetMovementThreshold`") + NumberAxes = property(GetNumberAxes,doc="See `GetNumberAxes`") + NumberButtons = property(GetNumberButtons,doc="See `GetNumberButtons`") + NumberJoysticks = property(GetNumberJoysticks,doc="See `GetNumberJoysticks`") + POVCTSPosition = property(GetPOVCTSPosition,doc="See `GetPOVCTSPosition`") + POVPosition = property(GetPOVPosition,doc="See `GetPOVPosition`") + PollingMax = property(GetPollingMax,doc="See `GetPollingMax`") + PollingMin = property(GetPollingMin,doc="See `GetPollingMin`") + Position = property(GetPosition,doc="See `GetPosition`") + ProductId = property(GetProductId,doc="See `GetProductId`") + ProductName = property(GetProductName,doc="See `GetProductName`") + RudderMax = property(GetRudderMax,doc="See `GetRudderMax`") + RudderMin = property(GetRudderMin,doc="See `GetRudderMin`") + RudderPosition = property(GetRudderPosition,doc="See `GetRudderPosition`") + UMax = property(GetUMax,doc="See `GetUMax`") + UMin = property(GetUMin,doc="See `GetUMin`") + UPosition = property(GetUPosition,doc="See `GetUPosition`") + VMax = property(GetVMax,doc="See `GetVMax`") + VMin = property(GetVMin,doc="See `GetVMin`") + VPosition = property(GetVPosition,doc="See `GetVPosition`") + XMax = property(GetXMax,doc="See `GetXMax`") + XMin = property(GetXMin,doc="See `GetXMin`") + YMax = property(GetYMax,doc="See `GetYMax`") + YMin = property(GetYMin,doc="See `GetYMin`") + ZMax = property(GetZMax,doc="See `GetZMax`") + ZMin = property(GetZMin,doc="See `GetZMin`") + ZPosition = property(GetZPosition,doc="See `GetZPosition`") _misc_.Joystick_swigregister(Joystick) wxEVT_JOY_BUTTON_DOWN = _misc_.wxEVT_JOY_BUTTON_DOWN @@ -2212,6 +2298,11 @@ class JoystickEvent(_core.Event): m_buttonState = property(GetButtonState, SetButtonState) m_joyStick = property(GetJoystick, SetJoystick) + ButtonChange = property(GetButtonChange,SetButtonChange,doc="See `GetButtonChange` and `SetButtonChange`") + ButtonState = property(GetButtonState,SetButtonState,doc="See `GetButtonState` and `SetButtonState`") + Joystick = property(GetJoystick,SetJoystick,doc="See `GetJoystick` and `SetJoystick`") + Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") + ZPosition = property(GetZPosition,SetZPosition,doc="See `GetZPosition` and `SetZPosition`") _misc_.JoystickEvent_swigregister(JoystickEvent) EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN ) @@ -2344,6 +2435,15 @@ class FileTypeInfo(object): """GetIconIndex(self) -> int""" return _misc_.FileTypeInfo_GetIconIndex(*args, **kwargs) + Description = property(GetDescription,doc="See `GetDescription`") + Extensions = property(GetExtensions,doc="See `GetExtensions`") + ExtensionsCount = property(GetExtensionsCount,doc="See `GetExtensionsCount`") + IconFile = property(GetIconFile,doc="See `GetIconFile`") + IconIndex = property(GetIconIndex,doc="See `GetIconIndex`") + MimeType = property(GetMimeType,doc="See `GetMimeType`") + OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`") + PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`") + ShortDesc = property(GetShortDesc,SetShortDesc,doc="See `GetShortDesc` and `SetShortDesc`") _misc_.FileTypeInfo_swigregister(FileTypeInfo) def FileTypeInfoSequence(*args, **kwargs): @@ -2418,6 +2518,15 @@ class FileType(object): return _misc_.FileType_ExpandCommand(*args, **kwargs) ExpandCommand = staticmethod(ExpandCommand) + AllCommands = property(GetAllCommands,doc="See `GetAllCommands`") + Description = property(GetDescription,doc="See `GetDescription`") + Extensions = property(GetExtensions,doc="See `GetExtensions`") + Icon = property(GetIcon,doc="See `GetIcon`") + IconInfo = property(GetIconInfo,doc="See `GetIconInfo`") + MimeType = property(GetMimeType,doc="See `GetMimeType`") + MimeTypes = property(GetMimeTypes,doc="See `GetMimeTypes`") + OpenCommand = property(GetOpenCommand,doc="See `GetOpenCommand`") + PrintCommand = property(GetPrintCommand,doc="See `GetPrintCommand`") _misc_.FileType_swigregister(FileType) def FileType_ExpandCommand(*args, **kwargs): @@ -2496,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): @@ -2520,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): @@ -2540,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 @@ -2611,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 @@ -2673,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 @@ -3679,8 +3791,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) @@ -4233,6 +4346,12 @@ class TimeSpan(object): def __str__(self): return self.Format().encode(wx.GetDefaultPyEncoding()) + Days = property(GetDays,doc="See `GetDays`") + Hours = property(GetHours,doc="See `GetHours`") + Milliseconds = property(GetMilliseconds,doc="See `GetMilliseconds`") + Minutes = property(GetMinutes,doc="See `GetMinutes`") + Seconds = property(GetSeconds,doc="See `GetSeconds`") + Weeks = property(GetWeeks,doc="See `GetWeeks`") _misc_.TimeSpan_swigregister(TimeSpan) def TimeSpan_Milliseconds(*args, **kwargs): @@ -4890,6 +5009,8 @@ class TextDataObject(DataObjectSimple): """ return _misc_.TextDataObject_SetText(*args, **kwargs) + Text = property(GetText,SetText,doc="See `GetText` and `SetText`") + TextLength = property(GetTextLength,doc="See `GetTextLength`") _misc_.TextDataObject_swigregister(TextDataObject) class PyTextDataObject(TextDataObject): @@ -5022,6 +5143,7 @@ class FileDataObject(DataObjectSimple): """ return _misc_.FileDataObject_AddFile(*args, **kwargs) + Filenames = property(GetFilenames,doc="See `GetFilenames`") _misc_.FileDataObject_swigregister(FileDataObject) class CustomDataObject(DataObjectSimple): @@ -5107,6 +5229,7 @@ class URLDataObject(DataObject): """ return _misc_.URLDataObject_SetURL(*args, **kwargs) + URL = property(GetURL,SetURL,doc="See `GetURL` and `SetURL`") _misc_.URLDataObject_swigregister(URLDataObject) class MetafileDataObject(DataObjectSimple): @@ -5676,6 +5799,9 @@ class VideoMode(object): h = property(_misc_.VideoMode_h_get, _misc_.VideoMode_h_set) bpp = property(_misc_.VideoMode_bpp_get, _misc_.VideoMode_bpp_set) refresh = property(_misc_.VideoMode_refresh_get, _misc_.VideoMode_refresh_set) + Depth = property(GetDepth,doc="See `GetDepth`") + Height = property(GetHeight,doc="See `GetHeight`") + Width = property(GetWidth,doc="See `GetWidth`") _misc_.VideoMode_swigregister(VideoMode) class Display(object): @@ -5684,7 +5810,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 @@ -5695,7 +5821,7 @@ class Display(object): __del__ = lambda self : None; def GetCount(*args, **kwargs): """ - GetCount() -> size_t + GetCount() -> unsigned int Return the number of available displays. """ @@ -5829,7 +5955,7 @@ DefaultVideoMode = cvar.DefaultVideoMode def Display_GetCount(*args): """ - Display_GetCount() -> size_t + Display_GetCount() -> unsigned int Return the number of available displays. """ @@ -6101,5 +6227,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)