Class
AdwAboutDialog
since: 1.5
Description [src]
final class Adw.AboutDialog : Adw.Dialog
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}
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 AdwAboutDialog:application-icon
,
AdwAboutDialog:application-name
,
AdwAboutDialog:developer-name
and AdwAboutDialog:version
respectively.
What's New
AdwAboutDialog
provides a way for applications to display their release
notes, set with the AdwAboutDialog: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 AdwAboutDialog:version
. Use
AdwAboutDialog:release-notes-version
to override it.
Details
The Details page displays the application comments and links.
The comments can be set with the AdwAboutDialog: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 AdwAboutDialog:website
.
To add extra links below the website, use adw_about_dialog_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
AdwAboutDialog:support-url
property, - Report an Issue, set with the
AdwAboutDialog:issue-url
property.
Additionally, applications can provide debugging information. It will be
shown separately on the Troubleshooting page. Use the
AdwAboutDialog: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, AdwAboutDialog: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
AdwAboutDialog:developers
property, - Designers, set with the
AdwAboutDialog:designers
property, - Artists, set with the
AdwAboutDialog:artists
property, - Documenters, set with the
AdwAboutDialog:documenters
property, - Translators, set with the
AdwAboutDialog: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_dialog_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_dialog_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 AdwAboutDialog: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 AdwAboutDialog:license-type
property. If the application’s
license is not in the list, AdwAboutDialog:license
can be used instead.
To add information about other modules, such as application dependencies or
data, use adw_about_dialog_add_legal_section()
.
Constructing
To make constructing an AdwAboutDialog
as convenient as possible, you can
use the function adw_show_about_dialog()
which constructs and shows a dialog.
static void
show_about (GtkApplication *app)
{
const char *developers[] = {
"Angela Avery",
NULL
};
const char *designers[] = {
"GNOME Design Team",
NULL
};
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"),
NULL);
}
CSS nodes
AdwAboutDialog
has a main CSS node with the name dialog
and the
style class .about
.
Available since: 1.5
Instance methods
adw_about_dialog_add_acknowledgement_section
Adds a section to the Acknowledgements page.
since: 1.5
adw_about_dialog_get_release_notes_version
Gets the version described by the application’s release notes.
since: 1.5
adw_about_dialog_set_license_type
Sets the license for self
from a list of known licenses.
since: 1.5
adw_about_dialog_set_release_notes_version
Sets the version described by the application’s release notes.
since: 1.5
Methods inherited from AdwDialog (23)
adw_dialog_add_breakpoint
Adds breakpoint
to self
.
since: 1.5
adw_dialog_close
Attempts to close self
.
since: 1.5
adw_dialog_force_close
Closes self
.
since: 1.5
adw_dialog_get_can_close
Gets whether self
can be closed.
since: 1.5
adw_dialog_get_child
Gets the child widget of self
.
since: 1.5
adw_dialog_get_content_height
Gets the height of the dialog’s contents.
since: 1.5
adw_dialog_get_content_width
Gets the width of the dialog’s contents.
since: 1.5
adw_dialog_get_current_breakpoint
Gets the current breakpoint.
since: 1.5
adw_dialog_get_default_widget
Gets the default widget for self
.
since: 1.5
adw_dialog_get_focus
Gets the focus widget for self
.
since: 1.5
adw_dialog_get_follows_content_size
Gets whether to size content of self
automatically.
since: 1.5
adw_dialog_get_presentation_mode
Gets presentation mode for self
.
since: 1.5
adw_dialog_get_title
Gets the title of self
.
since: 1.5
adw_dialog_present
Presents self
within parent
‘s window.
since: 1.5
adw_dialog_set_can_close
Sets whether self
can be closed.
since: 1.5
adw_dialog_set_child
Sets the child widget of self
.
since: 1.5
adw_dialog_set_content_height
Sets the height of the dialog’s contents.
since: 1.5
adw_dialog_set_content_width
Sets the width of the dialog’s contents.
since: 1.5
adw_dialog_set_default_widget
Sets the default widget for self
.
since: 1.5
adw_dialog_set_focus
Sets the focus widget for self
.
since: 1.5
adw_dialog_set_follows_content_size
Sets whether to size content of self
automatically.
since: 1.5
adw_dialog_set_presentation_mode
Sets presentation mode for self
.
since: 1.5
adw_dialog_set_title
Sets the title of self
.
since: 1.5
Methods inherited from GtkAccessible (19)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Query a platform state, such as focus.
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Properties
Adw.AboutDialog:release-notes-version
The version described by the application’s release notes.
since: 1.5
Properties inherited from AdwDialog (10)
Adw.Dialog:can-close
Whether the dialog can be closed.
since: 1.5
Adw.Dialog:child
The child widget of the AdwDialog
.
since: 1.5
Adw.Dialog:content-height
The height of the dialog’s contents.
since: 1.5
Adw.Dialog:content-width
The width of the dialog’s contents.
since: 1.5
Adw.Dialog:current-breakpoint
The current breakpoint.
since: 1.5
Adw.Dialog:default-widget
The default widget.
since: 1.5
Adw.Dialog:focus-widget
The focus widget.
since: 1.5
Adw.Dialog:follows-content-size
Whether to size content automatically.
since: 1.5
Adw.Dialog:presentation-mode
The dialog’s presentation mode.
since: 1.5
Adw.Dialog:title
The title of the dialog.
since: 1.5
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
Signals
Signals inherited from AdwDialog (2)
AdwDialog::close-attempt
Emitted when the close button or shortcut is used, or
adw_dialog_close()
is called while AdwDialog:can-close
is set to
FALSE
.
since: 1.5
AdwDialog::closed
Emitted when the dialog is successfully closed.
since: 1.5
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when widget
is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when widget
is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when widget
is associated with a GdkSurface
.
GtkWidget::show
Emitted when widget
is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when widget
is going to be unmapped.
GtkWidget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
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.