AboutWindow

Object Hierarchy:

Description:

[ CCode ( type_id = "adw_about_window_get_type ()" ) ]
[ Version ( since = "1.2" ) ]
public sealed class AboutWindow : Window, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

A window showing information about the application.

An about window is typically opened when the user activates the `About …` item in the application's primary menu. All parts of the window are optional.

Main page

`AdwAboutWindow` prominently displays the application's icon, name, developer name and version. They can be set with the [ property@AboutWindow:application-icon], [property@AboutWindow:application-name], [property@AboutWindow:developer-name] and [ property@AboutWindow:version] respectively.

What's New

`AdwAboutWindow` provides a way for applications to display their release notes, set with the [property@AboutWindow:release-notes] property.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

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

Within paragraphs and list items, emphasis (`<em>`) 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@AboutWindow:version]. Use [ property@AboutWindow:release-notes-version] to override it.

Details

The Details page displays the application comments and links.

The comments can be set with the [property@AboutWindow: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@AboutWindow:website]. To add extra links below the website, use [method@AboutWindow.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

`AdwAboutWindow` displays the following two links on the main page:

* Support Questions, set with the [property@AboutWindow:support-url] property, * Report an Issue, set with the [property@AboutWindow:issue-url] property.

Additionally, applications can provide debugging information. It will be shown separately on the Troubleshooting page. Use the [ property@AboutWindow: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.

`AdwAboutWindow` provides a quick way to save debug information to a file. When saving, [property@AboutWindow: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@AboutWindow:developers] property, * Designers, set with the [property@AboutWindow:designers] property, * Artists, set with the [property@AboutWindow:artists] property, * Documenters, set with the [property@AboutWindow:documenters] property, * Translators, set with the [property@AboutWindow: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@AboutWindow.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@AboutWindow.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 mailto: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.

Licensing information can be quickly set from a list of known licenses with the [property@AboutWindow:license-type] property. If the application's license is not in the list, [property@AboutWindow:license] can be used instead.

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

Constructing

To make constructing an `AdwAboutWindow` as convenient as possible, you can use the function [func@show_about_window] which constructs and shows a window.

```c static void show_about (GtkApplication *app) { const char *developers[] = { "Angela Avery", NULL };

const char *designers[] = { "GNOME Design Team", NULL };

adw_show_about_window (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"), NULL); } ```

CSS nodes

`AdwAboutWindow` has a main CSS node with the name `window` and the style class `.about`.

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public string application_icon { get; set; }
The name of the application icon.
public string application_name { get; set; }
The name of the application.
public string[] artists { get; set; }
The list of artists of the application.
public string comments { get; set; }
The comments about the application.
public string copyright { get; set; }
The copyright information.
public string debug_info { get; set; }
The debug information.
public string debug_info_filename { get; set; }
The debug information filename.
public string[] designers { get; set; }
The list of designers of the application.
public string developer_name { get; set; }
The developer name.
public string[] developers { get; set; }
The list of developers of the application.
public string[] documenters { get; set; }
The list of documenters of the application.
public string issue_url { get; set; }
The URL for the application's issue tracker.
public string license { get; set; }
The license text.
public License license_type { get; set; }
The license type.
public string release_notes { get; set; }
The release notes of the application.
public string release_notes_version { get; set; }
The version described by the application's release notes.
public string support_url { get; set; }
The URL of the application's support page.
public string translator_credits { get; set; }
The translator credits string.
public string version { get; set; }
The version of the application.
public string website { get; set; }
The URL of the application's website.

Creation methods:

public AboutWindow ()
Creates a new `AdwAboutWindow`.
public AboutWindow.from_appdata (string resource_path, string? release_notes_version)
Creates a new `AdwAboutWindow` using AppStream metadata.

Methods:

public void add_acknowledgement_section (string? name, string[] people)
Adds a section to the Acknowledgements page.
public void add_credit_section (string? name, string[] people)
Adds an extra section to the Credits page.
public void add_legal_section (string title, string? copyright, License license_type, string? license)
Adds an extra section to the Legal page.
public void add_link (string title, string url)
Adds an extra link to the Details page.
public unowned string get_application_icon ()
Gets the name of the application icon for this .
public unowned string get_application_name ()
Gets the application name for this.
public unowned string[]? get_artists ()
Gets the list of artists of the application.
public unowned string get_comments ()
Gets the comments about the application.
public unowned string get_copyright ()
Gets the copyright information for this.
public unowned string get_debug_info ()
Gets the debug information for this.
public unowned string get_debug_info_filename ()
Gets the debug information filename for this .
public unowned string[]? get_designers ()
Gets the list of designers of the application.
public unowned string get_developer_name ()
Gets the developer name for this.
public unowned string[]? get_developers ()
Gets the list of developers of the application.
public unowned string[]? get_documenters ()
Gets the list of documenters of the application.
public unowned string get_issue_url ()
Gets the issue tracker URL for this.
public unowned string get_license ()
Gets the license for this.
public License get_license_type ()
Gets the license type for this.
public unowned string get_release_notes ()
Gets the release notes for this.
public unowned string get_release_notes_version ()
Gets the version described by the application's release notes.
public unowned string get_support_url ()
Gets the URL of the support page for this.
public unowned string get_translator_credits ()
Gets the translator credits string.
public unowned string get_version ()
Gets the version for this.
public unowned string get_website ()
Gets the application website URL for this.
public void set_application_icon (string application_icon)
Sets the name of the application icon for this .
public void set_application_name (string application_name)
Sets the application name for this.
public void set_artists (string[]? artists)
Sets the list of artists of the application.
public void set_comments (string comments)
Sets the comments about the application.
public void set_copyright (string copyright)
Sets the copyright information for this.
public void set_debug_info (string debug_info)
Sets the debug information for this.
public void set_debug_info_filename (string filename)
Sets the debug information filename for this .
public void set_designers (string[]? designers)
Sets the list of designers of the application.
public void set_developer_name (string developer_name)
Sets the developer name for this.
public void set_developers (string[]? developers)
Sets the list of developers of the application.
public void set_documenters (string[]? documenters)
Sets the list of documenters of the application.
public void set_issue_url (string issue_url)
Sets the issue tracker URL for this.
public void set_license (string license)
Sets the license for this.
public void set_license_type (License license_type)
Sets the license for this from a list of known licenses.
public void set_release_notes (string release_notes)
Sets the release notes for this.
public void set_release_notes_version (string version)
Sets the version described by the application's release notes.
public void set_support_url (string support_url)
Sets the URL of the support page for this.
public void set_translator_credits (string translator_credits)
Sets the translator credits string.
public void set_version (string version)
Sets the version for this.
public void set_website (string website)
Sets the application website URL for this.

Signals:

public signal bool activate_link (string uri)
Emitted when a URL is activated.

Inherited Members:

All known members inherited from class Adw.Window

All known members inherited from class Gtk.Window

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Native

All known members inherited from interface Gtk.Root

get_display

get_focus

set_focus

All known members inherited from interface Gtk.ShortcutManager

add_controller

remove_controller