AboutDialog#

class AboutDialog(*args, **kwargs)#

Superclasses: Window, Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

The GtkAboutDialog offers a simple way to display information about a program.

The shown information includes the programs’ 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.

https://docs.gtk.org/gtk4/aboutdialog.png

About dialogs often contain links and email addresses. GtkAboutDialog displays these as clickable links. By default, it calls launch 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 a GtkAboutDialog as convenient as possible, you can use the function show_about_dialog which constructs and shows a dialog and keeps it around so that it can be shown again.

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 GtkAboutDialog, as shown in the following example:

GFile *logo_file = g_file_new_for_path ("./logo.png");
GdkTexture *example_logo = gdk_texture_new_from_file (logo_file, NULL);
g_object_unref (logo_file);

gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title", _("About ExampleCode"),
                       NULL);

Shortcuts and Gestures#

GtkAboutDialog supports the following keyboard shortcuts:

Escape closes the window.

CSS nodes#

GtkAboutDialog has a single CSS node with the name window and style class .aboutdialog.

Constructors#

class AboutDialog

classmethod new() → Widget#: Creates a new GtkAboutDialog.

Methods#

class AboutDialog

add_credit_section(section_name: str, people: Sequence[str]) → None#

Creates a new section in the “Credits” page.

Parameters:

section_name – The name of the section
people – The people who belong to that section

get_artists() → list[str]#: Returns the names of the artists which are displayed in the credits page.

get_authors() → list[str]#: Returns the names of the authors which are displayed in the credits page.

get_comments() → str | None#: Returns the comments string.

get_copyright() → str | None#: Returns the copyright string.

get_documenters() → list[str]#: Returns the name of the documenters which are displayed in the credits page.

get_license() → str | None#: Returns the license information.

get_license_type() → License#: Retrieves the license type.

get_logo() → Paintable | None#: Returns the paintable displayed as logo in the about dialog.

get_logo_icon_name() → str | None#: Returns the icon name displayed as logo in the about dialog.

get_program_name() → str | None#: Returns the program name displayed in the about dialog.

get_system_information() → str | None#: Returns the system information that is shown in the about dialog.

get_translator_credits() → str | None#: Returns the translator credits string which is displayed in the credits page.

get_version() → str | None#: Returns the version string.

get_website() → str | None#: Returns the website URL.

get_website_label() → str | None#: Returns the label used for the website link.

get_wrap_license() → bool#: Returns whether the license text in the about dialog is automatically wrapped.

set_artists(artists: Sequence[str]) → None#

Sets the names of the artists to be displayed in the “Credits” page.

Parameters:: artists – the authors of the artwork of the application

set_authors(authors: Sequence[str]) → None#

Sets the names of the authors which are displayed in the “Credits” page of the about dialog.

Parameters:: authors – the authors of the application

set_comments(comments: str | None = None) → None#

Sets the comments string to display in the about dialog.

This should be a short string of one or two lines.

Parameters:: comments – a comments string

set_copyright(copyright: str | None = None) → None#

Sets the copyright string to display in the about dialog.

This should be a short string of one or two lines.

Parameters:: copyright – the copyright string

set_documenters(documenters: Sequence[str]) → None#

Sets the names of the documenters which are displayed in the “Credits” page.

Parameters:: documenters – the authors of the documentation of the application

set_license(license: str | None = None) → None#

Sets the license information to be displayed in the about dialog.

If license is NULL, the license page is hidden.

Parameters:: license – the license information

set_license_type(license_type: License) → None#

Sets the license of the application showing the about dialog from a list of known licenses.

This function overrides the license set using set_license.

Parameters:: license_type – the type of license

set_logo(logo: Paintable | None = None) → None#

Sets the logo in the about dialog.

Parameters:: logo – a GdkPaintable

set_logo_icon_name(icon_name: str | None = None) → None#

Sets the icon name to be displayed as logo in the about dialog.

Parameters:: icon_name – an icon name

set_program_name(name: str | None = None) → None#

Sets the name to display in the about dialog.

If name is not set, the string returned by :func:`~gi.repository.GLib.get_application_name` is used.

Parameters:: name – the program name

set_system_information(system_information: str | None = None) → None#

Sets the system information to be displayed in the about dialog.

If system_information is NULL, the system information page is hidden.

See system_information.

Parameters:: system_information – system information

set_translator_credits(translator_credits: str | None = None) → None#

Sets the translator credits string which is displayed in the credits page.

The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext(), a simple way to achieve that is to mark the string for translation:

GtkWidget *about = gtk_about_dialog_new ();
 gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
                                          _("translator-credits"));

It is a good idea to use the customary msgid “translator-credits” for this purpose, since translators will already know the purpose of that msgid, and since GtkAboutDialog will detect if “translator-credits” is untranslated and omit translator credits.

Parameters:: translator_credits – the translator credits

set_version(version: str | None = None) → None#

Sets the version string to display in the about dialog.

Parameters:: version – the version string

set_website(website: str | None = None) → None#

Sets the URL to use for the website link.

Parameters:: website – a URL string starting with http://

set_website_label(website_label: str) → None#

Sets the label to be used for the website link.

Parameters:: website_label – the label used for the website link

set_wrap_license(wrap_license: bool) → None#

Sets whether the license text in the about dialog should be automatically wrapped.

Parameters:: wrap_license – whether to wrap the license

Properties#

class AboutDialog

props.artists: Sequence[str]#: The type of the None singleton.

props.authors: Sequence[str]#: The type of the None singleton.

props.comments: str#: The type of the None singleton.

props.copyright: str#: The type of the None singleton.

props.documenters: Sequence[str]#: The type of the None singleton.

props.license: str#: The type of the None singleton.

props.license_type: License#: The type of the None singleton.

props.logo: Paintable#: The type of the None singleton.

props.logo_icon_name: str#: The type of the None singleton.

props.program_name: str#: The type of the None singleton.

props.system_information: str#: The type of the None singleton.

props.translator_credits: str#: The type of the None singleton.

props.version: str#: The type of the None singleton.

props.website: str#: The type of the None singleton.

props.website_label: str#: The type of the None singleton.

props.wrap_license: bool#: The type of the None singleton.

Signals#

class AboutDialog.signals

activate_link(uri: str) → bool#

The type of the None singleton.

Parameters:: uri – the URI that is activated