Home | Trees | Index | Help |
|
---|
Package wx :: Class AboutDialogInfo |
|
object
--+
|
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.
Method Summary | |
---|---|
AboutDialogInfo |
wx.AboutDialogInfo contains information to be shown in the standard
About dialog displayed by the wx.AboutBox function. |
__del__(self)
| |
Add a string to the list of artists. | |
Add a string to the list of developers. | |
Add a string to the list of documentation writers. | |
Add a string to the list of translators. | |
GetArtists(self) --> list | |
String |
Returns the copyright value. |
String |
Returns the description value. |
String | GetDescriptionAndCredits(self)
|
GetDevelopers(self) --> list | |
GetDocWriters(self) --> list | |
Icon |
Return the current icon value. |
String |
Returns the licence value. |
String |
Returns the program name. |
GetTranslators(self) --> list | |
String |
Returns the version value. |
GetWebSite(self) --> (URL, Description) | |
bool |
Returns True if any artists have been set. |
bool |
Returns True if the copyright property has been set. |
bool |
Returns True if the description property has been set. |
bool |
Returns ``True if any developers have been set. |
bool |
Returns ``True if any documentation writers have been set. |
bool |
Returns True if the icon property has been set. |
bool |
Returns True if the licence property has been set. |
bool |
Returns True if any translators have been set. |
bool |
Returns True if the version property has been set. |
bool | HasWebSite(self)
|
bool | IsSimple(self)
|
Set the list of artists for the program. | |
Set the short string containing the program copyright information. | |
Set brief, but possibly multiline, description of the program. | |
Set the list of the developers of the program. | |
Set the list of the documentation writers. | |
Set the icon to be shown in the dialog. | |
Set the long, multiline string containing the text of the program licence. | |
This is the same as SetLicence . | |
Set the name of the program. | |
Sets the list of program translators. | |
Set the version of the program. | |
SetWebSite(self, URL, [Description]) |
Property Summary | |
---|---|
Artists | |
Copyright | |
Description | |
Developers | |
DocWriters | |
Icon | |
Licence | |
License | |
Name | |
thisown : The membership flag | |
Translators | |
Version | |
WebSite |
Method Details |
---|
__init__(self)
|
AddArtist(self, artist)Add a string to the list of artists.
|
AddDeveloper(self, developer)Add a string to the list of developers.
|
AddDocWriter(self, docwriter)Add a string to the list of documentation writers.
|
AddTranslator(self, translator)Add a string to the list of translators.
|
GetArtists(*args, **kwargs)GetArtists(self) --> list Returns the list od artists. |
GetCopyright(self)Returns the copyright value.
|
GetDescription(self)Returns the description value.
|
GetDevelopers(*args, **kwargs)GetDevelopers(self) --> list Returns the list of developers. |
GetDocWriters(*args, **kwargs)GetDocWriters(self) --> list Returns the list of documentation writers. |
GetIcon(self)Return the current icon value.
|
GetLicence(self)Returns the licence value.
|
GetName(self)Returns the program name.
|
GetTranslators(*args, **kwargs)GetTranslators(self) --> list Returns the list of program translators. |
GetVersion(self)Returns the version value.
|
GetWebSite(self)GetWebSite(self) --> (URL, Description) |
HasArtists(self)Returns True if any artists have been set.
|
HasCopyright(self)Returns True if the copyright property has been set.
|
HasDescription(self)Returns True if the description property has been set.
|
HasDevelopers(self)Returns ``True if any developers have been set.
|
HasDocWriters(self)Returns ``True if any documentation writers have been set.
|
HasIcon(self)Returns True if the icon property has been set.
|
HasLicence(self)Returns True if the licence property has been set.
|
HasTranslators(self)Returns True if any translators have been set.
|
HasVersion(self)Returns True if the version property has been set.
|
SetArtists(self, artists)Set the list of artists for the program.
|
SetCopyright(self, 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.
|
SetDescription(self, desc)Set brief, but possibly multiline, description of the program.
|
SetDevelopers(self, developers)Set the list of the developers of the program.
|
SetDocWriters(self, docwriters)Set the list of the documentation writers.
|
SetIcon(self, 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.
|
SetLicence(self, 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.
|
SetLicense(self, licence)This is the same as
|
SetName(self, name)Set the name of the program. If this method is not called, the string
returned by
|
SetTranslators(self, translators)Sets the list of program translators.
|
SetVersion(self, 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.
|
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. |
Property Details |
---|
Artists
|
Copyright
|
Description
|
Developers
|
DocWriters
|
Icon |
Licence
|
License
|
Name |
thisownThe membership flag |
Translators
|
Version
|
WebSite
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:13:55 2007 | http://epydoc.sf.net |