:right-sidebar: True
AboutDialog
===================================================================
.. currentmodule:: gi.repository.Gtk
.. class:: AboutDialog(*args, **kwargs)
:no-contents-entry:
Superclasses: :class:`~gi.repository.Gtk.Window`, :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`
Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.Native`, :class:`~gi.repository.Gtk.Root`, :class:`~gi.repository.Gtk.ShortcutManager`
:Constructors:
::
AboutDialog(**properties)
new() -> Gtk.Widget
Constructors
------------
.. rst-class:: interim-class
.. class:: AboutDialog
:no-index:
.. classmethod:: new() -> ~gi.repository.Gtk.Widget
Creates a new ``GtkAboutDialog``.
Methods
-------
.. rst-class:: interim-class
.. class:: AboutDialog
:no-index:
.. method:: add_credit_section(section_name: str, people: ~typing.Sequence[str]) -> None
Creates a new section in the "Credits" page.
:param section_name: The name of the section
:param people: The people who belong to that section
.. method:: get_artists() -> list[str]
Returns the names of the artists which are displayed
in the credits page.
.. method:: get_authors() -> list[str]
Returns the names of the authors which are displayed
in the credits page.
.. method:: get_comments() -> str | None
Returns the comments string.
.. method:: get_copyright() -> str | None
Returns the copyright string.
.. method:: get_documenters() -> list[str]
Returns the name of the documenters which are displayed
in the credits page.
.. method:: get_license() -> str | None
Returns the license information.
.. method:: get_license_type() -> ~gi.repository.Gtk.License
Retrieves the license type.
.. method:: get_logo() -> ~gi.repository.Gdk.Paintable | None
Returns the paintable displayed as logo in the about dialog.
.. method:: get_logo_icon_name() -> str | None
Returns the icon name displayed as logo in the about dialog.
.. method:: get_program_name() -> str | None
Returns the program name displayed in the about dialog.
.. method:: get_system_information() -> str | None
Returns the system information that is shown in the about dialog.
.. method:: get_translator_credits() -> str | None
Returns the translator credits string which is displayed
in the credits page.
.. method:: get_version() -> str | None
Returns the version string.
.. method:: get_website() -> str | None
Returns the website URL.
.. method:: get_website_label() -> str | None
Returns the label used for the website link.
.. method:: get_wrap_license() -> bool
Returns whether the license text in the about dialog is
automatically wrapped.
.. method:: set_artists(artists: ~typing.Sequence[str]) -> None
Sets the names of the artists to be displayed
in the "Credits" page.
:param artists: the authors of the artwork
of the application
.. method:: set_authors(authors: ~typing.Sequence[str]) -> None
Sets the names of the authors which are displayed
in the "Credits" page of the about dialog.
:param authors: the authors of the application
.. method:: 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.
:param comments: a comments string
.. method:: 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.
:param copyright: the copyright string
.. method:: set_documenters(documenters: ~typing.Sequence[str]) -> None
Sets the names of the documenters which are displayed
in the "Credits" page.
:param documenters: the authors of the documentation
of the application
.. method:: 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.
:param license: the license information
.. method:: set_license_type(license_type: ~gi.repository.Gtk.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
:obj:`~gi.repository.Gtk.AboutDialog.set_license`.
:param license_type: the type of license
.. method:: set_logo(logo: ~gi.repository.Gdk.Paintable | None = None) -> None
Sets the logo in the about dialog.
:param logo: a ``GdkPaintable``
.. method:: set_logo_icon_name(icon_name: str | None = None) -> None
Sets the icon name to be displayed as logo in the about dialog.
:param icon_name: an icon name
.. method:: 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.
:param name: the program name
.. method:: 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 :obj:`~gi.repository.Gtk.AboutDialog.props.system_information`.
:param system_information: system information
.. method:: 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:
.. code-block:: c
:dedent:
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.
:param translator_credits: the translator credits
.. method:: set_version(version: str | None = None) -> None
Sets the version string to display in the about dialog.
:param version: the version string
.. method:: set_website(website: str | None = None) -> None
Sets the URL to use for the website link.
:param website: a URL string starting with ``http://``
.. method:: set_website_label(website_label: str) -> None
Sets the label to be used for the website link.
:param website_label: the label used for the website link
.. method:: set_wrap_license(wrap_license: bool) -> None
Sets whether the license text in the about dialog should be
automatically wrapped.
:param wrap_license: whether to wrap the license
Properties
----------
.. rst-class:: interim-class
.. class:: AboutDialog
:no-index:
.. attribute:: props.artists
:type: ~typing.Sequence[str]
The people who contributed artwork to the program, as a ``NULL``-terminated
array of strings.
Each string may contain email addresses and URLs, which will be displayed
as links.
.. attribute:: props.authors
:type: ~typing.Sequence[str]
The authors of the program, as a ``NULL``-terminated array of strings.
Each string may contain email addresses and URLs, which will be displayed
as links, see the introduction for more details.
.. attribute:: props.comments
:type: str
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.
.. attribute:: props.copyright
:type: str
Copyright information for the program.
.. attribute:: props.documenters
:type: ~typing.Sequence[str]
The people documenting the program, as a ``NULL``-terminated array of strings.
Each string may contain email addresses and URLs, which will be displayed
as links, see the introduction for more details.
.. attribute:: props.license
:type: str
The license of the program, as free-form text.
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-``NULL`` value, the
:obj:`~gi.repository.Gtk.AboutDialog.props.license_type` property is set to
``GTK_LICENSE_CUSTOM`` as a side effect.
The text may contain links in this format ````
and email references in the form ``, and these will
be converted into clickable links.
.. attribute:: props.license_type
:type: ~gi.repository.Gtk.License
The license of the program.
The ``GtkAboutDialog`` will automatically fill out a standard disclaimer
and link the user to the appropriate online resource for the license
text.
If ``GTK_LICENSE_UNKNOWN`` is used, the link used will be the same
specified in the :obj:`~gi.repository.Gtk.AboutDialog.props.website` property.
If ``GTK_LICENSE_CUSTOM`` is used, the current contents of the
:obj:`~gi.repository.Gtk.AboutDialog.props.license` property are used.
For any other :obj:`~gi.repository.Gtk.License` value, the contents of the
:obj:`~gi.repository.Gtk.AboutDialog.props.license` property are also set by this property as
a side effect.
.. attribute:: props.logo
:type: ~gi.repository.Gdk.Paintable
A logo for the about box.
If it is ``NULL``, the default window icon set with
:obj:`~gi.repository.Gtk.Window.set_default_icon_name` will be used.
.. attribute:: props.logo_icon_name
:type: str
A named icon to use as the logo for the about box.
This property overrides the :obj:`~gi.repository.Gtk.AboutDialog.props.logo` property.
.. attribute:: props.program_name
:type: str
The name of the program.
If this is not set, it defaults to the value returned by
``:func:`~gi.repository.GLib.get_application_name```.
.. attribute:: props.system_information
:type: str
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 ````
and email references in the form ``, and these will
be converted into clickable links.
.. attribute:: props.translator_credits
:type: str
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.
.. attribute:: props.version
:type: str
The version of the program.
.. attribute:: props.website
:type: str
The URL for the link to the website of the program.
This should be a string starting with ``http://`` or ``https://``.
.. attribute:: props.website_label
:type: str
The label for the link to the website of the program.
.. attribute:: props.wrap_license
:type: bool
Whether to wrap the text in the license dialog.
Signals
-------
.. rst-class:: interim-class
.. class:: AboutDialog.signals
:no-index:
.. method:: activate_link(uri: str) -> bool
Emitted every time a URL is activated.
Applications may connect to it to override the default behaviour,
which is to call :obj:`~gi.repository.Gtk.FileLauncher.launch`.
:param uri: the URI that is activated