Package: gtk
Class gtk:about-dialog
Superclassesgtk:window, gtk:widget, gobject:initially-unowned, gtk:accessible, gtk:buildable, gtk:constraint-target, gtk:native, gtk:root, gtk:shortcut-manager, gobject:object, common-lisp:standard-object, common-lisp:t Documented Subclasses
None
Direct Slotsartists The artists property of type glib:strv-t (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. The authors property of type glib:strv-t (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 copyright The copyright property of type :string (Read / Write) Copyright information for the program. Default value: nil documenters The documenters property of type glib:strv-t (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. The 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:paintable (Read / Write) The logo for the about box. If this is not set, the default window icon set with the gtk:window-default-icon-name function will be used. logo-icon-name The logo-icon-name property of type :string (Read / Write) The 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 system-information The system-information property of type :string (Read / Write) Information about the system on which the program is running. This information is displayed in a separate page, therefore it is fine to use a long multi-paragraph text. Note that the text should contain the intended linebreaks. The text may contain links in this format "<http://www.some.place/>" and email references in the form "<mail-to@some.body>", and these will be converted into clickable links. 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. 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:file-launcher-launch function when a user clicks one. The behaviour can be overridden with the "activate-link" signal. To specify a person with an email address, use a string like "Edgar Allan Poe <edgar@poe.com>". To specify a website with a title, use a string like "GTK team https://www.gtk.org". 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") CSS nodesSignal DetailsThe "activate-link" signallambda (dialog uri) :run-last
| Returned bySlot Access FunctionsInherited Slot Access FunctionsSee also |
2024-11-29