Class
AdwAboutWindow
since: 1.2
Description [src]
final class Adw.AboutWindow : Adw.Window
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Native, Gtk.Root, Gtk.ShortcutManager {
/* 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
Instance methods
adw_about_window_add_acknowledgement_section
Adds a section to the Acknowledgements page.
since: 1.2
adw_about_window_get_release_notes_version
Gets the version described by the application’s release notes.
since: 1.2
adw_about_window_set_license_type
Sets the license for self
from a list of known licenses.
since: 1.2
adw_about_window_set_release_notes_version
Sets the version described by the application’s release notes.
since: 1.2
Methods inherited from AdwWindow (4)
adw_window_add_breakpoint
Adds breakpoint
to self
.
since: 1.4
adw_window_get_content
Gets the content widget of self
.
since: 1
adw_window_get_current_breakpoint
Gets the current breakpoint.
since: 1.4
adw_window_set_content
Sets the content widget of self
.
since: 1
Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
unstable since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
unstable since: 4.0
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
unstable since: 4.10
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
unstable since: 4.10
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
unstable since: 4.10
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
unstable since: 4.10
gtk_accessible_get_platform_state
Query a platform state, such as focus.
unstable since: 4.10
gtk_accessible_reset_property
Resets the accessible property
to its default value.
unstable since: 4.0
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
unstable since: 4.0
gtk_accessible_reset_state
Resets the accessible state
to its default value.
unstable since: 4.0
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
unstable since: 4.10
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
unstable since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
unstable since: 4.0
gtk_accessible_update_property_value
Updates an array of accessible properties.
unstable since: 4.0
gtk_accessible_update_relation
Updates a list of accessible relations.
unstable since: 4.0
gtk_accessible_update_relation_value
Updates an array of accessible relations.
unstable since: 4.0
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
unstable since: 4.0
gtk_accessible_update_state_value
Updates an array of accessible states.
unstable since: 4.0
Methods inherited from GtkBuildable (1)
Methods inherited from GtkNative (5)
gtk_native_get_renderer
Returns the renderer that is used for this GtkNative
.
unstable since: 4.0
gtk_native_get_surface
Returns the surface of this GtkNative
.
unstable since: 4.0
gtk_native_get_surface_transform
Retrieves the surface transform of self
.
unstable since: 4.0
gtk_native_realize
Realizes a GtkNative
.
unstable since: 4.0
gtk_native_unrealize
Unrealizes a GtkNative
.
unstable since: 4.0
Methods inherited from GtkRoot (3)
gtk_root_get_display
Returns the display that this GtkRoot
is on.
unstable since: 4.0
gtk_root_get_focus
Retrieves the current focused widget within the root.
unstable since: 4.0
gtk_root_set_focus
If focus
is not the current focus widget, and is focusable, sets
it as the focus widget for the root.
unstable since: 4.0
Properties
Adw.AboutWindow:release-notes-version
The version described by the application’s release notes.
since: 1.2
Properties inherited from AdwWindow (2)
Adw.Window:content
The content widget.
since: 1
Adw.Window:current-breakpoint
The current breakpoint.
since: 1.4
Properties inherited from GtkWindow (25)
Gtk.Window:application
The GtkApplication
associated with the window.
unstable since: 4.0
Gtk.Window:child
The child widget.
unstable since: 4.0
Gtk.Window:decorated
Whether the window should have a frame (also known as decorations).
unstable since: 4.0
Gtk.Window:default-height
The default height of the window.
unstable since: 4.0
Gtk.Window:default-widget
The default widget.
unstable since: 4.0
Gtk.Window:default-width
The default width of the window.
unstable since: 4.0
Gtk.Window:deletable
Whether the window frame should have a close button.
unstable since: 4.0
Gtk.Window:destroy-with-parent
If this window should be destroyed when the parent is destroyed.
unstable since: 4.0
Gtk.Window:display
The display that will display this window.
unstable since: 4.0
Gtk.Window:focus-visible
Whether ‘focus rectangles’ are currently visible in this window.
unstable since: 4.0
Gtk.Window:focus-widget
The focus widget.
unstable since: 4.0
Gtk.Window:fullscreened
Whether the window is fullscreen.
unstable since: 4.0
Gtk.Window:handle-menubar-accel
Whether the window frame should handle F10 for activating menubars.
unstable since: 4.2
Gtk.Window:hide-on-close
If this window should be hidden when the users clicks the close button.
unstable since: 4.0
Gtk.Window:icon-name
Specifies the name of the themed icon to use as the window icon.
unstable since: 4.0
Gtk.Window:is-active
Whether the toplevel is the currently active window.
unstable since: 4.0
Gtk.Window:maximized
Whether the window is maximized.
unstable since: 4.0
Gtk.Window:mnemonics-visible
Whether mnemonics are currently visible in this window.
unstable since: 4.0
Gtk.Window:modal
If TRUE
, the window is modal.
unstable since: 4.0
Gtk.Window:resizable
If TRUE
, users can resize the window.
unstable since: 4.0
Gtk.Window:startup-id
A write-only property for setting window’s startup notification identifier.
unstable since: 4.0
Gtk.Window:suspended
Whether the window is suspended.
unstable since: 4.12
Gtk.Window:title
The title of the window.
unstable since: 4.0
Gtk.Window:titlebar
The titlebar widget.
unstable since: 4.6
Gtk.Window:transient-for
The transient parent of the window.
unstable since: 4.0
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
unstable since: 4.0
Gtk.Widget:can-target
Whether the widget can receive pointer events.
unstable since: 4.0
Gtk.Widget:css-classes
A list of css classes applied to this widget.
unstable since: 4.0
Gtk.Widget:css-name
The name of this widget in the CSS tree.
unstable since: 4.0
Gtk.Widget:cursor
The cursor used by widget
.
unstable since: 4.0
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
unstable since: 4.0
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
unstable since: 4.0
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
unstable since: 4.0
Gtk.Widget:has-default
Whether the widget is the default widget.
unstable since: 4.0
Gtk.Widget:has-focus
Whether the widget has the input focus.
unstable since: 4.0
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
unstable since: 4.0
Gtk.Widget:height-request
Override for height request of the widget.
unstable since: 4.0
Gtk.Widget:hexpand
Whether to expand horizontally.
unstable since: 4.0
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
unstable since: 4.0
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
unstable since: 4.0
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
unstable since: 4.0
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
unstable since: 4.0
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
unstable since: 4.0
Gtk.Widget:margin-top
Margin on top side of widget.
unstable since: 4.0
Gtk.Widget:name
The name of the widget.
unstable since: 4.0
Gtk.Widget:opacity
The requested opacity of the widget.
unstable since: 4.0
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
unstable since: 4.0
Gtk.Widget:parent
The parent widget of this widget.
unstable since: 4.0
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
unstable since: 4.0
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
unstable since: 4.0
Gtk.Widget:scale-factor
The scale factor of the widget.
unstable since: 4.0
Gtk.Widget:sensitive
Whether the widget responds to input.
unstable since: 4.0
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
unstable since: 4.0
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
unstable since: 4.0
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
unstable since: 4.0
Gtk.Widget:vexpand
Whether to expand vertically.
unstable since: 4.0
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
unstable since: 4.0
Gtk.Widget:visible
Whether the widget is visible.
unstable since: 4.0
Gtk.Widget:width-request
Override for width request of the widget.
unstable since: 4.0
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
unstable since: 4.0
Signals
Signals inherited from GtkWindow (5)
GtkWindow::activate-default
Emitted when the user activates the default widget
of window
.
unstable since: 4.0
GtkWindow::activate-focus
Emitted when the user activates the currently focused
widget of window
.
unstable since: 4.0
GtkWindow::close-request
Emitted when the user clicks on the close button of the window.
unstable since: 4.0
GtkWindow::enable-debugging
Emitted when the user enables or disables interactive debugging.
unstable since: 4.0
GtkWindow::keys-changed
Emitted when the set of accelerators or mnemonics that
are associated with window
changes.
unstable deprecated: 4.10 since: 4.0
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
unstable since: 4.0
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
unstable since: 4.0
GtkWidget::hide
Emitted when widget
is hidden.
unstable since: 4.0
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
unstable since: 4.0
GtkWidget::map
Emitted when widget
is going to be mapped.
unstable since: 4.0
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
unstable since: 4.0
GtkWidget::move-focus
Emitted when the focus is moved.
unstable since: 4.0
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
unstable since: 4.0
GtkWidget::realize
Emitted when widget
is associated with a GdkSurface
.
unstable since: 4.0
GtkWidget::show
Emitted when widget
is shown.
unstable since: 4.0
GtkWidget::state-flags-changed
Emitted when the widget state changes.
unstable since: 4.0
GtkWidget::unmap
Emitted when widget
is going to be unmapped.
unstable since: 4.0
GtkWidget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
unstable since: 4.0
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
unstable since: 2.0