Superclass: dialog atk-implementor-iface buildable
The about-dialog offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.
About dialog often contain links and email addresses. about-dialog supports this by offering global hooks (TODO: not implemented in cl-gtk2), which are called when the user clicks on a link or email address, see gtk_about_dialog_set_email_hook() and gtk_about_dialog_set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for <user@host>, URLs are recognized by looking for http://url, with url extending to the next space, tab or line break.
When setting the website and email hooks for the about-dialog widget, you should remember that the order is important: you should set the hook functions before setting the website and email URL properties. Otherwise the about-dialog widget will not display the website and the email addresses as clickable.
Note that GTK+ sets a default title of _("About %s") on the dialog window (where %s is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a about-dialog, as shown in the following example:
(make-instance 'gtk:about-dialog :program-name "ExampleCode" :title "About ExampleCode")
Slots:
string. Accessor: about-dialog-artists.
The people who contributed artwork to the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the description for more details.
string. Accessor: about-dialog-authors.
The authors of the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
string. Accessor: about-dialog-comments.
Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.
Default value: NIL
string. Accessor: about-dialog-copyright.
Copyright information for the program.
Default value: NIL
string. Accessor: about-dialog-documenters.
The people documenting the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
string. Accessor: about-dialog-license.
The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the about-dialog-wrap-license property is set to True; otherwise the text itself must contain the intended linebreaks.
Default value: NIL
about-dialog-logo.
A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list().
string. Accessor: about-dialog-logo-icon-name.
A named icon to use as the logo for the about box. This property overrides the about-dialog-logo property.
Default value: NIL
string. Accessor: about-dialog-program-name.
The name of the program. If this is not set, it defaults to g_get_application_name().
Default value: NIL
string. Accessor: about-dialog-translator-credits.
Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
Default value: NIL
string. Accessor: about-dialog-version.
The version of the program.
Default value: NIL
string. Accessor: about-dialog-website.
The URL for the link to the website of the program. This should be a string starting with "http://.
Default value: NIL
string. Accessor: about-dialog-website-label.
The label for the link to the website of the program. If this is not set, it defaults to the URL specified in the website property.
Default value: NIL
boolean. Accessor: about-dialog-wrap-license.
Whether to wrap the text in the license dialog.
Default value: False
Signals: