wxaboutdialoginfo

wxaboutdialoginfo contains information shown in the standard about dialog displayed by the wxaboutbox() 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 wxarraystring and can be either set entirely at once using setdevelopers and similar functions or built one by one using adddeveloper etc.

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 wxaboutdialoginfo 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.

derived from

no base class

include files

members

wxaboutdialoginfo::wxaboutdialoginfo

wxaboutdialoginfo()

default constructor leaves all fields are initially uninitialized, in general you should call at least setversion, setcopyright and setdescription.

wxaboutdialoginfo::addartist

void addartist(const wxstring& artist)

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

see also

setartists

wxaboutdialoginfo::adddeveloper

void adddeveloper(const wxstring& developer)

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

see also

setdevelopers

wxaboutdialoginfo::adddocwriter

void adddocwriter(const wxstring& docwriter)

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

see also

setdocwriters

wxaboutdialoginfo::addtranslator

void addtranslator(const wxstring& translator)

adds a translator name to be shown in the program credits. notice that if no translator names are specified explicitely, wxaboutbox() 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

wxaboutdialoginfo::setartists

void setartists(const wxarraystring& artists)

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

see also

addartist

wxaboutdialoginfo::setcopyright

void setcopyright(const wxstring& 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,

wxaboutdialoginfo::setdescription

void setdescription(const wxstring& desc)

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

wxaboutdialoginfo::setdevelopers

void setdevelopers(const wxarraystring& developers)

set the list of developers of the program.

see also

adddeveloper

wxaboutdialoginfo::setdocwriters

void setdocwriters(const wxarraystring& docwriters)

set the list of documentation writers.

see also

adddocwriter

wxaboutdialoginfo::seticon

void seticon(const wxicon& 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.

wxaboutdialoginfo::setlicence

void setlicence(const wxstring& 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.

wxaboutdialoginfo::setlicense

void setlicense(const wxstring& licence)

this is the same as setlicence.

wxaboutdialoginfo::setname

void setname(const wxstring& name)

set the name of the program. if this method is not called, the string returned by wxapp::getappname() will be shown in the dialog.

wxaboutdialoginfo::settranslators

void settranslators(const wxarraystring& translators)

set the list of translators. please see addtranslator for additional discussion.

wxaboutdialoginfo::setversion

void setversion(const wxstring& 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.

wxaboutdialoginfo::setwebsite

void setwebsite(const wxstring& url, const wxstring& desc = wxemptystring)

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

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.