Next: , Up: Widgets

6.2.1 about-dialog

— Class: about-dialog

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")