Adw.AboutDialog¶

Subclasses:: None

Methods¶

Inherited:: Adw.Dialog (24), Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
class	`new_from_appdata` (resource_path, release_notes_version)
	`add_acknowledgement_section` (name, people)
	`add_credit_section` (name, people)
	`add_legal_section` (title, copyright, license_type, license)
	`add_link` (title, url)
	`get_application_icon` ()
	`get_application_name` ()
	`get_artists` ()
	`get_comments` ()
	`get_copyright` ()
	`get_debug_info` ()
	`get_debug_info_filename` ()
	`get_designers` ()
	`get_developer_name` ()
	`get_developers` ()
	`get_documenters` ()
	`get_issue_url` ()
	`get_license` ()
	`get_license_type` ()
	`get_release_notes` ()
	`get_release_notes_version` ()
	`get_support_url` ()
	`get_translator_credits` ()
	`get_version` ()
	`get_website` ()
	`set_application_icon` (application_icon)
	`set_application_name` (application_name)
	`set_artists` (artists)
	`set_comments` (comments)
	`set_copyright` (copyright)
	`set_debug_info` (debug_info)
	`set_debug_info_filename` (filename)
	`set_designers` (designers)
	`set_developer_name` (developer_name)
	`set_developers` (developers)
	`set_documenters` (documenters)
	`set_issue_url` (issue_url)
	`set_license` (license)
	`set_license_type` (license_type)
	`set_release_notes` (release_notes)
	`set_release_notes_version` (version)
	`set_support_url` (support_url)
	`set_translator_credits` (translator_credits)
	`set_version` (version)
	`set_website` (website)

Virtual Methods¶

Inherited:: Adw.Dialog (2), Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Adw.Dialog (10), Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags
`application-icon`	`str`	r/w/en
`application-name`	`str`	r/w/en
`artists`	[`str`]	r/w/en
`comments`	`str`	r/w/en
`copyright`	`str`	r/w/en
`debug-info`	`str`	r/w/en
`debug-info-filename`	`str`	r/w/en
`designers`	[`str`]	r/w/en
`developer-name`	`str`	r/w/en
`developers`	[`str`]	r/w/en
`documenters`	[`str`]	r/w/en
`issue-url`	`str`	r/w/en
`license`	`str`	r/w/en
`license-type`	`Gtk.License`	r/w/en
`release-notes`	`str`	r/w/en
`release-notes-version`	`str`	r/w/en
`support-url`	`str`	r/w/en
`translator-credits`	`str`	r/w/en
`version`	`str`	r/w/en
`website`	`str`	r/w/en

Signals¶

Inherited:: Adw.Dialog (2), Gtk.Widget (13), GObject.Object (1)

Name	Short Description
`activate-link`	Emitted when a URL is activated.

Fields¶

Inherited:: Adw.Dialog (2), Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Adw.AboutDialog(**kwargs)¶

Bases:: Adw.Dialog
Abstract:: No
Structure:: Adw.AboutDialogClass

A dialog showing information about the application.

an about dialog is typically opened when the user activates the About … item in the application’s primary menu. All parts of the dialog are optional.

Main page

AdwAboutDialog prominently displays the application’s icon, name, developer name and version. They can be set with the [property`AboutDialog`:py:data::application-icon<Adw.AboutDialog.props.application_icon>], [property`AboutDialog`:py:data::application-name<Adw.AboutDialog.props.application_name>], [property`AboutDialog`:py:data::developer-name<Adw.AboutDialog.props.developer_name>] and [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] respectively.

What’s New

AdwAboutDialog provides a way for applications to display their release notes, set with the [property`AboutDialog`:py:data::release-notes<Adw.AboutDialog.props.release_notes>] property.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

Only one version can be shown at a time. By default, the displayed version number matches [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>]. Use [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] to override it.

Details

The Details page displays the application comments and links.

The comments can be set with the [property`AboutDialog`:py:data::comments<Adw.AboutDialog.props.comments>] property. Unlike [property`Gtk`.AboutDialog:comments], this string can be long and detailed. It can also contain links and Pango markup.

To set the application website, use [property`AboutDialog`:py:data::website<Adw.AboutDialog.props.website>]. To add extra links below the website, use [method`AboutDialog`.add_link].

If the Details page doesn’t have any other content besides website, the website will be displayed on the main page instead.

Troubleshooting

AdwAboutDialog displays the following two links on the main page:

Support Questions, set with the [property`AboutDialog`:py:data::support-url<Adw.AboutDialog.props.support_url>] property,
Report an Issue, set with the [property`AboutDialog`:py:data::issue-url<Adw.AboutDialog.props.issue_url>] property.

Additionally, applications can provide debugging information. It will be shown separately on the Troubleshooting page. Use the [property`AboutDialog`:py:data::debug-info<Adw.AboutDialog.props.debug_info>] property to specify it.

It’s intended to be attached to issue reports when reporting issues against the application. As such, it cannot contain markup or links.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [property`AboutDialog`:py:data::debug-info-filename<Adw.AboutDialog.props.debug_info_filename>] would be used as the suggested filename.

Credits and Acknowledgements

The Credits page has the following default sections:

Developers, set with the [property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>] property,
Designers, set with the [property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>] property,
Artists, set with the [property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>] property,
Documenters, set with the [property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>] property,
Translators, set with the [property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>] property.

When setting translator credits, use the strings "translator-credits" or "translator_credits" and mark them as translatable.

The default sections that don’t contain any names won’t be displayed.

The Credits page can also contain an arbitrary number of extra sections below the default ones. Use [method`AboutDialog`.add_credit_section] to add them.

The Acknowledgements page can be used to acknowledge additional people and organizations for their non-development contributions. Use [method`AboutDialog`.add_acknowledgement_section] to add sections to it. For example, it can be used to list backers in a crowdfunded project or to give special thanks.

Each of the people or organizations can have an email address or a website specified. To add a email address, use a string like Edgar Allan Poe <edgar@poe.com>. To specify a website with a title, use a string like The GNOME Project https://www.gnome.org :

Legal

The Legal page displays the copyright and licensing information for the application and other modules.

The copyright string is set with the [property`AboutDialog`:py:data::copyright<Adw.AboutDialog.props.copyright>] property and should be a short string of one or two lines, for example: © 2022 Example.

Licensing information can be quickly set from a list of known licenses with the [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>] property. If the application’s license is not in the list, [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] can be used instead.

To add information about other modules, such as application dependencies or data, use [method`AboutDialog`.add_legal_section].

Constructing

To make constructing an AdwAboutDialog as convenient as possible, you can use the function [func`show_about_dialog`] which constructs and shows a dialog.

```c static void show_about (Gtk.Application *app) { const str *developers[] = { “Angela Avery”, None };

const str *designers[] = { “GNOME Design Team”, None };

adw_show_about_dialog (GTK_WIDGET (Gtk.Application.get_active_window (app)), “application-name”, _(“Example”), “application-icon”, “org.example.App”, “version”, “1.2.3”, “copyright”, “© 2022 Angela Avery”, “issue-url”, “https://gitlab.gnome.org/example/example/-/issues/new”, “license-type”, Gtk.License.GPL_3_0, “developers”, developers, “designers”, designers, “translator-credits”, _(“translator-credits”), None); } ```

CSS nodes

AdwAboutDialog has a main CSS node with the name dialog and the style class .about.

New in version 1.5.

classmethod new()¶

Returns:: the newly created AdwAboutDialog
Return type:: Adw.Dialog

Creates a new AdwAboutDialog.

New in version 1.5.

classmethod new_from_appdata(resource_path, release_notes_version)¶

Parameters:

resource_path (str) – The resource to use
release_notes_version (str or None) – The version to retrieve release notes for

Returns:

the newly created AdwAboutDialog

Return type:

Adw.Dialog

Creates a new AdwAboutDialog using AppStream metadata.

This automatically sets the following properties with the following AppStream values:

[property`AboutDialog`:py:data::application-icon<Adw.AboutDialog.props.application_icon>] is set from the <id>
[property`AboutDialog`:py:data::application-name<Adw.AboutDialog.props.application_name>] is set from the <name>
[property`AboutDialog`:py:data::developer-name<Adw.AboutDialog.props.developer_name>] is set from the <name> within <developer>
[property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] is set from the version of the latest release
[property`AboutDialog`:py:data::website<Adw.AboutDialog.props.website>] is set from the <url type="homepage">
[property`AboutDialog`:py:data::support-url<Adw.AboutDialog.props.support_url>] is set from the <url type="help">
[property`AboutDialog`:py:data::issue-url<Adw.AboutDialog.props.issue_url>] is set from the <url type="bugtracker">
[property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>] is set from the <project_license>. If the license type retrieved from AppStream is not listed in [enum`Gtk`.License], it will be set to GTK_LICENCE_CUSTOM.

If release_notes_version is not NULL, [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] is set to match it, while [property`AboutDialog`:py:data::release-notes<Adw.AboutDialog.props.release_notes>] is set from the AppStream release description for that version.

New in version 1.5.

add_acknowledgement_section(name, people)¶

Parameters:

name (str or None) – the section name
people ([str]) – the list of names

Adds a section to the Acknowledgements page.

This can be used to acknowledge additional people and organizations for their non-development contributions - for example, backers in a crowdfunded project.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]

New in version 1.5.

add_credit_section(name, people)¶

Parameters:

name (str or None) – the section name
people ([str]) – the list of names

Adds an extra section to the Credits page.

Extra sections are displayed below the standard categories.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

add_legal_section(title, copyright, license_type, license)¶

Parameters:

title (str) – the name of the section
copyright (str or None) – a copyright string
license_type (Gtk.License) – the type of license
license (str or None) – custom license information

Adds an extra section to the Legal page.

Extra sections will be displayed below the application’s own information.

The parameters copyright, license_type and license will be used to present the it the same way as [property`AboutDialog`:py:data::copyright<Adw.AboutDialog.props.copyright>], [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>] and [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] are for the application’s own information.

See those properties for more details.

This can be useful to attribute the application dependencies or data.

Examples:

Adw.AboutDialog.add_legal_section (ADW_ABOUT_DIALOG (about), _(“Custom license only”), None, Gtk.License.CUSTOM, “Something completely custom here.”); ```

New in version 1.5.

add_link(title, url)¶

Parameters:

title (str) – the link title
url (str) – the link URL

Adds an extra link to the Details page.

Extra links are displayed under the comment and website.

Underlines in title will be interpreted as indicating a mnemonic.

See [property`AboutDialog`:py:data::website<Adw.AboutDialog.props.website>].

New in version 1.5.

get_application_icon()¶

Returns:: the application icon name
Return type:: str

Gets the name of the application icon for self.

New in version 1.5.

get_application_name()¶

Returns:: the application name
Return type:: str

Gets the application name for self.

New in version 1.5.

get_artists()¶

Returns:: The list of artists
Return type:: [str] or None

Gets the list of artists of the application.

New in version 1.5.

get_comments()¶

Returns:: the comments
Return type:: str

Gets the comments about the application.

New in version 1.5.

get_copyright()¶

Returns:: the copyright information
Return type:: str

Gets the copyright information for self.

New in version 1.5.

get_debug_info()¶

Returns:: the debug information
Return type:: str

Gets the debug information for self.

New in version 1.5.

get_debug_info_filename()¶

Returns:: the debug information filename
Return type:: str

Gets the debug information filename for self.

New in version 1.5.

get_designers()¶

Returns:: The list of designers
Return type:: [str] or None

Gets the list of designers of the application.

New in version 1.5.

get_developer_name()¶

Returns:: the developer_name
Return type:: str

Gets the developer name for self.

New in version 1.5.

get_developers()¶

Returns:: The list of developers
Return type:: [str] or None

Gets the list of developers of the application.

New in version 1.5.

get_documenters()¶

Returns:: The list of documenters
Return type:: [str] or None

Gets the list of documenters of the application.

New in version 1.5.

get_issue_url()¶

Returns:: the issue tracker URL
Return type:: str

Gets the issue tracker URL for self.

New in version 1.5.

get_license()¶

Returns:: the license
Return type:: str

Gets the license for self.

New in version 1.5.

get_license_type()¶

Returns:: the license type
Return type:: Gtk.License

Gets the license type for self.

New in version 1.5.

get_release_notes()¶

Returns:: the release notes
Return type:: str

Gets the release notes for self.

New in version 1.5.

get_release_notes_version()¶

Returns:: the release notes version
Return type:: str

Gets the version described by the application’s release notes.

New in version 1.5.

get_support_url()¶

Returns:: the support page URL
Return type:: str

Gets the URL of the support page for self.

New in version 1.5.

get_translator_credits()¶

Returns:: The translator credits string
Return type:: str

Gets the translator credits string.

New in version 1.5.

get_version()¶

Returns:: the version
Return type:: str

Gets the version for self.

New in version 1.5.

get_website()¶

Returns:: the website URL
Return type:: str

Gets the application website URL for self.

New in version 1.5.

set_application_icon(application_icon)¶

Parameters:: application_icon (str) – the application icon name

Sets the name of the application icon for self.

The icon is displayed at the top of the main page.

New in version 1.5.

set_application_name(application_name)¶

Parameters:: application_name (str) – the application name

Sets the application name for self.

The name is displayed at the top of the main page.

New in version 1.5.

set_artists(artists)¶

Parameters:: artists ([str] or None) – the list of artists

Sets the list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

set_comments(comments)¶

Parameters:: comments (str) – the comments

Sets the comments about the application.

Comments will be shown on the Details page, above links.

Unlike [property`Gtk`.AboutDialog:comments], this string can be long and detailed. It can also contain links and Pango markup.

New in version 1.5.

set_copyright(copyright)¶

Parameters:: copyright (str) – the copyright information

Sets the copyright information for self.

The copyright information will be displayed on the Legal page, before the application license.

[method`AboutDialog`.add_legal_section] can be used to add copyright information for the application dependencies or other components.

New in version 1.5.

set_debug_info(debug_info)¶

Parameters:: debug_info (str) – the debug information

Sets the debug information for self.

Debug information will be shown on the Troubleshooting page. It’s intended to be attached to issue reports when reporting issues against the application.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [property`AboutDialog`:py:data::debug-info-filename<Adw.AboutDialog.props.debug_info_filename>] would be used as the suggested filename.

Debug information cannot contain markup or links.

New in version 1.5.

set_debug_info_filename(filename)¶

Parameters:: filename (str) – the debug info filename

Sets the debug information filename for self.

It will be used as the suggested filename when saving debug information to a file.

See [property`AboutDialog`:py:data::debug-info<Adw.AboutDialog.props.debug_info>].

New in version 1.5.

set_designers(designers)¶

Parameters:: designers ([str] or None) – the list of designers

Sets the list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

set_developer_name(developer_name)¶

Parameters:: developer_name (str) – the developer name

Sets the developer name for self.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like “AppName team”, “AppName developers” or “The AppName project”, and the individual contributors can be listed on the Credits page, with [property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>] and related properties.

New in version 1.5.

set_developers(developers)¶

Parameters:: developers ([str] or None) – the list of developers

Sets the list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

set_documenters(documenters)¶

Parameters:: documenters ([str] or None) – the list of documenters

Sets the list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

set_issue_url(issue_url)¶

Parameters:: issue_url (str) – the issue tracker URL

Sets the issue tracker URL for self.

The issue tracker link is displayed on the main page.

New in version 1.5.

set_license(license)¶

Parameters:: license (str) – the license

Sets the license for self.

This can be used to set a custom text for the license if it can’t be set via [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>].

When set, [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>] will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

[method`AboutDialog`.add_legal_section] can be used to add license information for the application dependencies or other components.

New in version 1.5.

set_license_type(license_type)¶

Parameters:: license_type (Gtk.License) – the license type

Sets the license for self from a list of known licenses.

If the application’s license is not in the list, [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If license_type is GTK_LICENSE_UNKNOWN, no information will be displayed.

If license_type is different from GTK_LICENSE_CUSTOM. [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

[method`AboutDialog`.add_legal_section] can be used to add license information for the application dependencies or other components.

New in version 1.5.

set_release_notes(release_notes)¶

Parameters:: release_notes (str) – the release notes

Sets the release notes for self.

Release notes are displayed on the the What’s New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AdwAboutDialog displays the version above the release notes. If set, the [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] of the property will be used as the version; otherwise, [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] is used.

New in version 1.5.

set_release_notes_version(version)¶

Parameters:: version (str) – the release notes version

Sets the version described by the application’s release notes.

The release notes version is displayed on the What’s New page, above the release notes.

If not set, [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See [property`AboutDialog`:py:data::release-notes<Adw.AboutDialog.props.release_notes>].

New in version 1.5.

set_support_url(support_url)¶

Parameters:: support_url (str) – the support page URL

Sets the URL of the support page for self.

The support page link is displayed on the main page.

New in version 1.5.

set_translator_credits(translator_credits)¶

Parameters:: translator_credits (str) – the translator credits

Sets the translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

set_version(version)¶

Parameters:: version (str) – the version

Sets the version for self.

The version is displayed on the main page.

If [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] is not set, the version will also be displayed above the release notes on the What’s New page.

New in version 1.5.

set_website(website)¶

Parameters:: website (str) – the website URL

Sets the application website URL for self.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesn’t have any other content.

Applications can add other links below, see [method`AboutDialog`.add_link].

New in version 1.5.

Signal Details¶

Adw.AboutDialog.signals.activate_link(about_dialog, uri)¶

Signal Name:

activate-link

Flags:

RUN_LAST

Parameters:

about_dialog (Adw.AboutDialog) – The object which received the signal
uri (str) – the URI to activate

Returns:

TRUE if the link has been activated

Return type:

bool

Emitted when a URL is activated.

Applications may connect to it to override the default behavior, which is to call [func`Gtk`.show_uri].

New in version 1.5.

Property Details¶

Adw.AboutDialog.props.application_icon¶

Name:: application-icon
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The name of the application icon.

The icon is displayed at the top of the main page.

New in version 1.5.

Adw.AboutDialog.props.application_name¶

Name:: application-name
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The name of the application.

The name is displayed at the top of the main page.

New in version 1.5.

Adw.AboutDialog.props.artists¶

Name:: artists
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

Adw.AboutDialog.props.comments¶

Name:: comments
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The comments about the application.

Comments will be shown on the Details page, above links.

Unlike [property`Gtk`.AboutDialog:comments], this string can be long and detailed. It can also contain links and Pango markup.

New in version 1.5.

Adw.AboutDialog.props.copyright¶

Name:: copyright
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The copyright information.

The copyright information will be displayed on the Legal page, above the application license.

[method`AboutDialog`.add_legal_section] can be used to add copyright information for the application dependencies or other components.

New in version 1.5.

Adw.AboutDialog.props.debug_info¶

Name:: debug-info
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The debug information.

Debug information will be shown on the Troubleshooting page. It’s intended to be attached to issue reports when reporting issues against the application.

AdwAboutDialog provides a quick way to save debug information to a file. When saving, [property`AboutDialog`:py:data::debug-info-filename<Adw.AboutDialog.props.debug_info_filename>] would be used as the suggested filename.

Debug information cannot contain markup or links.

New in version 1.5.

Adw.AboutDialog.props.debug_info_filename¶

Name:: debug-info-filename
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The debug information filename.

It will be used as the suggested filename when saving debug information to a file.

See [property`AboutDialog`:py:data::debug-info<Adw.AboutDialog.props.debug_info>].

New in version 1.5.

Adw.AboutDialog.props.designers¶

Name:: designers
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

Adw.AboutDialog.props.developer_name¶

Name:: developer-name
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The developer name.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like “AppName team”, “AppName developers” or “The AppName project”, and the individual contributors can be listed on the Credits page, with [property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>] and related properties.

New in version 1.5.

Adw.AboutDialog.props.developers¶

Name:: developers
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

Adw.AboutDialog.props.documenters¶

Name:: documenters
Type:: [str]
Default Value:: []
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::translator-credits<Adw.AboutDialog.props.translator_credits>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

Adw.AboutDialog.props.issue_url¶

Name:: issue-url
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The URL for the application’s issue tracker.

The issue tracker link is displayed on the main page.

New in version 1.5.

Adw.AboutDialog.props.license¶

Name:: license
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The license text.

This can be used to set a custom text for the license if it can’t be set via [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>].

When set, [property`AboutDialog`:py:data::license-type<Adw.AboutDialog.props.license_type>] will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

[method`AboutDialog`.add_legal_section] can be used to add license information for the application dependencies or other components.

New in version 1.5.

Adw.AboutDialog.props.license_type¶

Name:: license-type
Type:: Gtk.License
Default Value:: Gtk.License.UNKNOWN
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The license type.

Allows to set the application’s license froma list of known licenses.

If the application’s license is not in the list, [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If set to GTK_LICENSE_UNKNOWN, no information will be displayed.

If the license type is different from GTK_LICENSE_CUSTOM. [property`AboutDialog`:py:data::license<Adw.AboutDialog.props.license>] will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

[method`AboutDialog`.add_legal_section] can be used to add license information for the application dependencies or other components.

New in version 1.5.

Adw.AboutDialog.props.release_notes¶

Name:: release-notes
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The release notes of the application.

Release notes are displayed on the the What’s New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

Paragraph ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AdwAboutDialog displays the version above the release notes. If set, the [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] of the property will be used as the version; otherwise, [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] is used.

New in version 1.5.

Adw.AboutDialog.props.release_notes_version¶

Name:: release-notes-version
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The version described by the application’s release notes.

The release notes version is displayed on the What’s New page, above the release notes.

If not set, [property`AboutDialog`:py:data::version<Adw.AboutDialog.props.version>] will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See [property`AboutDialog`:py:data::release-notes<Adw.AboutDialog.props.release_notes>].

New in version 1.5.

Adw.AboutDialog.props.support_url¶

Name:: support-url
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The URL of the application’s support page.

The support page link is displayed on the main page.

New in version 1.5.

Adw.AboutDialog.props.translator_credits¶

Name:: translator-credits
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

[property`AboutDialog`:py:data::developers<Adw.AboutDialog.props.developers>]
[property`AboutDialog`:py:data::designers<Adw.AboutDialog.props.designers>]
[property`AboutDialog`:py:data::artists<Adw.AboutDialog.props.artists>]
[property`AboutDialog`:py:data::documenters<Adw.AboutDialog.props.documenters>]
[method`AboutDialog`.add_credit_section]
[method`AboutDialog`.add_acknowledgement_section]

New in version 1.5.

Adw.AboutDialog.props.version¶

Name:: version
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The version of the application.

The version is displayed on the main page.

If [property`AboutDialog`:py:data::release-notes-version<Adw.AboutDialog.props.release_notes_version>] is not set, the version will also be displayed above the release notes on the What’s New page.

New in version 1.5.

Adw.AboutDialog.props.website¶

Name:: website
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The URL of the application’s website.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesn’t have any other content.

Applications can add other links below, see [method`AboutDialog`.add_link].

New in version 1.5.