Class
AdwAboutWindow
Description [src]
final class Adw.AboutWindow : Adw.Window {
/* No available fields */
}
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 AdwAboutWindow:application-icon
,
AdwAboutWindow:application-name
,
AdwAboutWindow:developer-name
and AdwAboutWindow:version
respectively.
What's New
AdwAboutWindow
provides a way for applications to display their release
notes, set with the AdwAboutWindow: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 AdwAboutWindow:version
. Use
AdwAboutWindow:release-notes-version
to override it.
Details
The Details page displays the application comments and links.
The comments can be set with the AdwAboutWindow:comments
property.
Unlike GtkAboutDialog:comments
, this string can be long and
detailed. It can also contain links and Pango markup.
To set the application website, use AdwAboutWindow:website
.
To add extra links below the website, use adw_about_window_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
AdwAboutWindow:support-url
property, - Report an Issue, set with the
AdwAboutWindow:issue-url
property.
Additionally, applications can provide debugging information. It will be
shown separately on the Troubleshooting page. Use the
AdwAboutWindow: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, AdwAboutWindow: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
AdwAboutWindow:developers
property, - Designers, set with the
AdwAboutWindow:designers
property, - Artists, set with the
AdwAboutWindow:artists
property, - Documenters, set with the
AdwAboutWindow:documenters
property, - Translators, set with the
AdwAboutWindow: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 adw_about_window_add_credit_section()
to add them.
The Acknowledgements page can be used to acknowledge additional people and
organizations for their non-development contributions. Use
adw_about_window_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 AdwAboutWindow: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 AdwAboutWindow:license-type
property. If the application’s
license is not in the list, AdwAboutWindow:license
can be used instead.
To add information about other modules, such as application dependencies or
data, use adw_about_window_add_legal_section()
.
Constructing
To make constructing an AdwAboutWindow
as convenient as possible, you can
use the function adw_show_about_window()
which constructs and shows a window.
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
.
Available since: | 1.2 |
Ancestors
- AdwWindow
- GtkWindow
- GtkWidget
- GInitiallyUnowned
- GObject
Constructors
adw_about_window_new_from_appdata
Creates a new AdwAboutWindow
using AppStream metadata.
Available since: 1.4
Instance methods
adw_about_window_add_acknowledgement_section
Adds a section to the Acknowledgements page.
Available since: 1.2
adw_about_window_get_application_icon
Gets the name of the application icon for self
.
Available since: 1.2
adw_about_window_get_debug_info_filename
Gets the debug information filename for self
.
Available since: 1.2
adw_about_window_get_developers
Gets the list of developers of the application.
Available since: 1.2
adw_about_window_get_documenters
Gets the list of documenters of the application.
Available since: 1.2
adw_about_window_get_release_notes_version
Gets the version described by the application’s release notes.
Available since: 1.2
adw_about_window_set_application_icon
Sets the name of the application icon for self
.
Available since: 1.2
adw_about_window_set_debug_info_filename
Sets the debug information filename for self
.
Available since: 1.2
adw_about_window_set_developers
Sets the list of developers of the application.
Available since: 1.2
adw_about_window_set_documenters
Sets the list of documenters of the application.
Available since: 1.2
adw_about_window_set_license_type
Sets the license for self
from a list of known licenses.
Available since: 1.2
adw_about_window_set_release_notes_version
Sets the version described by the application’s release notes.
Available since: 1.2
Methods inherited from AdwWindow (4)
adw_window_add_breakpoint
Adds breakpoint
to self
.
Available since: 1.4
adw_window_get_content
Gets the content widget of self
.
adw_window_get_current_breakpoint
Gets the current breakpoint.
Available since: 1.4
adw_window_set_content
Sets the content widget of self
.
Properties
Adw.AboutWindow:release-notes-version
The version described by the application’s release notes.
Available since: 1.2
Properties inherited from AdwWindow (2)
Adw.Window:content
The content widget.
Adw.Window:current-breakpoint
The current breakpoint.
Available since: 1.4