wx.AboutDialogInfo

Inheritance diagram for wx.AboutDialogInfo:



Description

wx.AboutDialogInfo contains information 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. The simple properties from the former group are represented as a string with the exception of the program icon and the program web site, while the lists from the latter group are stored as list of strings and can be either set entirely at once using SetDevelopers and similar functions or built one by one using AddDeveloper etc.

Note

Please also notice that while all the main platforms have the 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, wx.AboutBox will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.

Class API

Methods

__init__()

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, wx.AboutBox will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.


Returns:

wx.AboutDialogInfo


AddArtist(artist)

Adds an artist name to be shown in the program credits.

Parameters:

  • artist (string)

See also

SetArtists


AddDeveloper(developer)

Adds a developer name to be shown in the program credits.

Parameters:

  • developer (string)

See also

SetDevelopers


AddDocWriter(docwriter)

Adds a documentation writer name to be shown in the program credits.

Parameters:

  • docwriter (string)

See also

SetDocWriters


AddTranslator(translator)

Adds a translator name to be shown in the program credits.

Parameters:

  • translator (string)

Note

Notice that if no translator names are specified explicitely, wx.AboutBox will try to use the translation of the string translator-credits from the currently used message catalog – this can be used to show just the name of the translator of the program in the current language.

See also

SetTranslators


GetArtists()

Returns the list of artists.


Returns:

list of string


GetCopyright()

Returns the copyright value.


Returns:

string


GetDescription()

Returns the description value.


Returns:

string


GetDescriptionAndCredits()
No docstrings available for this method.

GetDevelopers()

Returns the list of developers.


Returns:

list of string


GetDocWriters()

Returns the list of documentation writers.


Returns:

list of string


GetIcon()

Return the current icon value.


Returns:

wx.Icon


GetLicence()

Returns the licence value.


Returns:

string


GetName()

Returns the program name.


Returns:

string


GetTranslators()

Returns the list of program translators.


Returns:

list of strings


GetVersion()

Returns the version value.


Returns:

string


GetWebSite()

Returns the web site for the program and its description (which defaults to URL itself if empty).


Returns:

string

Note

Please notice that only GTK+ version currently supports showing the link in the native about dialog so if this method is called, the generic version will be used under all the other platforms.


HasArtists()

Returns True if any artists have been set.


Returns:

bool


HasCopyright()

Returns True if the copyright property has been set.


Returns:

bool


HasDescription()

Returns True if the description property has been set.


Returns:

bool


HasDevelopers()

Returns True if any developers have been set.


Returns:

bool


HasDocWriters()

Returns True if any documentation writers have been set.


Returns:

bool


HasIcon()

Returns True if the icon property has been set.


Returns:

bool


HasLicence()

Returns True if the licence property has been set.


Returns:

bool


HasTranslators()

Returns True if any translators have been set.


Returns:

bool


HasVersion()

Returns True if the version property has been set.


Returns:

bool


HasWebSite()

Returns True if the website property has been set.


Returns:

bool


IsSimple()
No docstrings available for this method.

SetArtists(artists)

Sets the the list of artists to be shown in the program credits.

Parameters:

  • artists (list of strings)

See also

AddArtist


SetCopyright(copyright)

Set the short string containing the program copyright information.

Parameters:

  • copyright (string)

Note

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(desc)

Set brief, but possibly multiline, description of the program.

Parameters:

  • desc (string)

SetDevelopers(developers)

Set the list of developers of the program.

Parameters:

  • developers (list of strings)

See also

AddDeveloper


SetDocWriters(docwriters)

Set the list of documentation writers.

Parameters:

  • docwriters (list of strings)

See also

AddDocWriter


SetIcon(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.

Parameters:


SetLicence(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.

Parameters:

  • licence (string)

SetLicense(licence)

This is the same as SetLicence .

Parameters:

  • licence (string)

SetName(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.

Parameters:

  • name (string)

SetTranslators(translators)

Set the list of translators.

Parameters:

  • translators (list of strings)

See also

AddTranslator


SetVersion(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.

Parameters:

  • version (string)

SetWebSite(url, desc="")

Set the web site for the program and its description (which defaults to URL itself if empty).

Parameters:

  • url (string)
  • desc (string)

Note

Please notice that only GTK+ version currently supports showing the link in the native about dialog so if this method is called, the generic version will be used under all the other platforms.


Properties

Artists
Returns the list of artists.
Returns the copyright value.
Description
Returns the description value.
Developers
Returns the list of developers.
DocWriters
Returns the list of documentation writers.
Icon
Return the current icon value.
Licence
Returns the licence value.
License
Returns the licence value.
Name
Returns the program name.
Translators
Returns the list of program translators.
Version
Returns the version value.
WebSite
Returns the web site for the program and its description (which defaults to URL itself if empty).