Class gtk-about-dialog

Package: gtk

Superclasses

gtk-dialog, gtk-window, gtk-bin, gtk-container, gtk-widget, gtk-buildable, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

artists

The artists property of type g-strv (Read / Write)
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.

authors

The authors property of type g-strv (Read / Write)
The authors of the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links.

comments

The comments property of type :string (Read / Write)
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

The copyright property of type :string (Read / Write)
Copyright information for the program.
Default value: nil

documenters

The documenters property of type g-strv (Read / Write)
The people documenting the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links.

license

The license property of type :string (Read / Write)
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 wrap-license property is set to true. Otherwise the text itself must contain the intended linebreaks. When setting this property to a non-nil value, the license-type property is set to the :custom value of the gtk-license enumeration as a side effect.
Default value: nil

license-type

The license-type property of type gtk-license (Read / Write)
The license of the program, as a value of the gtk-license enumeration. The about dialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text. If the :unknown value is used, the link used will be the same specified in the website property. If the :custom value is used, the current contents of the license property are used. For any other gtk-license value, the contents of the license property are also set by this property as a side effect.
Default value: :unkown

logo

The logo property of type gdk-pixbuf (Read / Write)
A logo for the about box. If this is not set, it defaults to the return value of the gtk-window-default-icon-list function.

logo-icon-name

The logo-icon-name property of type :string (Read / Write)
A named icon to use as the logo for the about box. This property overrides the logo property.
Default value: nil

program-name

The program-name property of type :string (Read / Write)
The name of the program. If this is not set, it defaults to the return value of the g-application-name function.
Default value: nil

translator-credits

The translator-credits property of type :string (Read / Write)
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

version

The version property of type :string (Read / Write)
The version of the program.
Default value: nil

website

The website property of type :string (Read / Write)
The URL for the link to the website of the program. This should be a string starting with "http://".
Default value: nil

website-label

The website-label property of type :string (Read / Write)
The label for the link to the website of the program.
Default value: nil

wrap-license

The wrap-license property of type :boolean (Read / Write)
Whether to wrap the text in the license dialog.
Default value: false

Details

The gtk-about-dialog widget 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. The about dialog is typically opened when the user selects the About option from the Help menu. All parts of the about dialog are optional.

The about dialog often contain links and email addresses. The about dialog displays these as clickable links. By default, it calls the gtk-show-uri function when a user clicks one. The behaviour can be overridden with the "activate-link" signal.

To make constructing an about dialog as convenient as possible, you can use the gtk-show-about-dialog function which constructs and shows an about dialog and keeps it around so that it can be shown again.

Note that GTK sets a default title of "About %s" on the about 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 gtk-about-dialog widget, as shown in the following example:

(gtk-show-about-dialog nil
                       :program-name "ExampleCode"
                       :logo example-logo
                       :title "About ExampleCode")

It is also possible to show a gtk-about-dialog widget like any other gtk-dialog widget, e.g. using the gtk-dialog-run function. In this case, you might need to know that the "Close" button returns the :cancel response ID.

Signal Details

The "activate-link" signal

 lambda (dialog uri)    :run-last

The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call the gtk-show-uri function.

dialog: The gtk-about-dialog widget on which the signal was emitted.
uri: A string with the URI that is activated.
Returns: True if the link has been activated.