wxAboutDialogInfo

wxAboutDialogInfo
Contains information shown in the standard About dialog displayed by the about_dlg_show() function.

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 info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog

Functions/Procedures
Supertopics

wxAboutDialogInfo

[proc]
about_dlg_add_artist
( atom info, object person )

Category: wxAboutDialogInfo

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


wxAboutDialogInfo

[proc]
about_dlg_add_developer
( atom info, object person )

Category: wxAboutDialogInfo

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


wxAboutDialogInfo

[proc]
about_dlg_add_doc_writer
( atom info, object person )

Category: wxAboutDialogInfo

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


wxAboutDialogInfo

[proc]
about_dlg_add_translator
( atom info, object person )

Category: wxAboutDialogInfo

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


wxAboutDialogInfo

[proc]
about_dlg_set_copyright
( atom info, object copyright )

Category: wxAboutDialogInfo

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

[proc]
about_dlg_set_description
( atom info, object desc )

Category: wxAboutDialogInfo

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


wxAboutDialogInfo

[proc]
about_dlg_set_icon
( atom info, atom icon )

Category: wxAboutDialogInfo

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

[proc]
about_dlg_set_license
( atom info, object license )

Category: wxAboutDialogInfo

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

[proc]
about_dlg_set_name
( atom info, object name )

Category: wxAboutDialogInfo

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

[proc]
about_dlg_set_version
( atom info, object version )

Category: wxAboutDialogInfo

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

[proc]
about_dlg_set_web_site
( atom info, object params )

Category: wxAboutDialogInfo

params should be {"url", "description"}

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.


wxAboutDialogInfo

[proc]
about_dlg_show
( atom info )

Category: wxAboutDialogInfo

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 info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog.

Example:


procedure show_simple_about_dialog()

    atom info

    info = create( wxAboutDialogInfo, {} )
    about_dlg_set_name( info, "My Program" )
    about_dlg_set_version( info, "1.2.3 Beta" )
    about_dlg_set_description( info, "This program does something great." )
    about_dlg_set_copyright( info, "(C) 2007 Me " )

    about_dlg_show( info )

end procedure