Class

AdwAboutDialog

unstable 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.

about-dialog

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:

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:

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:

about-dialog-credits

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

Hierarchy

hierarchy this AdwAboutDialog implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 ancestor_0 AdwDialog ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

Constructors

adw_about_dialog_new

Creates a new AdwAboutDialog.

unstable since: 1.5

adw_about_dialog_new_from_appdata

Creates a new AdwAboutDialog using AppStream metadata.

unstable since: 1.5

Instance methods

adw_about_dialog_add_acknowledgement_section

Adds a section to the Acknowledgements page.

unstable since: 1.5

adw_about_dialog_add_credit_section

Adds an extra section to the Credits page.

unstable since: 1.5

adw_about_dialog_add_legal_section

Adds an extra section to the Legal page.

unstable since: 1.5

adw_about_dialog_add_link

Adds an extra link to the Details page.

unstable since: 1.5

adw_about_dialog_get_application_icon

Gets the name of the application icon for self.

unstable since: 1.5

adw_about_dialog_get_application_name

Gets the application name for self.

unstable since: 1.5

adw_about_dialog_get_artists

Gets the list of artists of the application.

unstable since: 1.5

adw_about_dialog_get_comments

Gets the comments about the application.

unstable since: 1.5

adw_about_dialog_get_copyright

Gets the copyright information for self.

unstable since: 1.5

adw_about_dialog_get_debug_info

Gets the debug information for self.

unstable since: 1.5

adw_about_dialog_get_debug_info_filename

Gets the debug information filename for self.

unstable since: 1.5

adw_about_dialog_get_designers

Gets the list of designers of the application.

unstable since: 1.5

adw_about_dialog_get_developer_name

Gets the developer name for self.

unstable since: 1.5

adw_about_dialog_get_developers

Gets the list of developers of the application.

unstable since: 1.5

adw_about_dialog_get_documenters

Gets the list of documenters of the application.

unstable since: 1.5

adw_about_dialog_get_issue_url

Gets the issue tracker URL for self.

unstable since: 1.5

adw_about_dialog_get_license

Gets the license for self.

unstable since: 1.5

adw_about_dialog_get_license_type

Gets the license type for self.

unstable since: 1.5

adw_about_dialog_get_release_notes

Gets the release notes for self.

unstable since: 1.5

adw_about_dialog_get_release_notes_version

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

unstable since: 1.5

adw_about_dialog_get_support_url

Gets the URL of the support page for self.

unstable since: 1.5

adw_about_dialog_get_translator_credits

Gets the translator credits string.

unstable since: 1.5

adw_about_dialog_get_version

Gets the version for self.

unstable since: 1.5

adw_about_dialog_get_website

Gets the application website URL for self.

unstable since: 1.5

adw_about_dialog_set_application_icon

Sets the name of the application icon for self.

unstable since: 1.5

adw_about_dialog_set_application_name

Sets the application name for self.

unstable since: 1.5

adw_about_dialog_set_artists

Sets the list of artists of the application.

unstable since: 1.5

adw_about_dialog_set_comments

Sets the comments about the application.

unstable since: 1.5

adw_about_dialog_set_copyright

Sets the copyright information for self.

unstable since: 1.5

adw_about_dialog_set_debug_info

Sets the debug information for self.

unstable since: 1.5

adw_about_dialog_set_debug_info_filename

Sets the debug information filename for self.

unstable since: 1.5

adw_about_dialog_set_designers

Sets the list of designers of the application.

unstable since: 1.5

adw_about_dialog_set_developer_name

Sets the developer name for self.

unstable since: 1.5

adw_about_dialog_set_developers

Sets the list of developers of the application.

unstable since: 1.5

adw_about_dialog_set_documenters

Sets the list of documenters of the application.

unstable since: 1.5

adw_about_dialog_set_issue_url

Sets the issue tracker URL for self.

unstable since: 1.5

adw_about_dialog_set_license

Sets the license for self.

unstable since: 1.5

adw_about_dialog_set_license_type

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

unstable since: 1.5

adw_about_dialog_set_release_notes

Sets the release notes for self.

unstable since: 1.5

adw_about_dialog_set_release_notes_version

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

unstable since: 1.5

adw_about_dialog_set_support_url

Sets the URL of the support page for self.

unstable since: 1.5

adw_about_dialog_set_translator_credits

Sets the translator credits string.

unstable since: 1.5

adw_about_dialog_set_version

Sets the version for self.

unstable since: 1.5

adw_about_dialog_set_website

Sets the application website URL for self.

unstable since: 1.5

Methods inherited from AdwDialog (23)
adw_dialog_add_breakpoint

Adds breakpoint to self.

unstable since: 1.5

adw_dialog_close

Attempts to close self.

unstable since: 1.5

adw_dialog_force_close

Closes self.

unstable since: 1.5

adw_dialog_get_can_close

Gets whether self can be closed.

unstable since: 1.5

adw_dialog_get_child

Gets the child widget of self.

unstable since: 1.5

adw_dialog_get_content_height

Gets the height of the dialog’s contents.

unstable since: 1.5

adw_dialog_get_content_width

Gets the width of the dialog’s contents.

unstable since: 1.5

adw_dialog_get_current_breakpoint

Gets the current breakpoint.

unstable since: 1.5

adw_dialog_get_default_widget

Gets the default widget for self.

unstable since: 1.5

adw_dialog_get_focus

Gets the focus widget for self.

unstable since: 1.5

adw_dialog_get_follows_content_size

Gets whether to size content of self automatically.

unstable since: 1.5

adw_dialog_get_presentation_mode

Gets presentation mode for self.

unstable since: 1.5

adw_dialog_get_title

Gets the title of self.

unstable since: 1.5

adw_dialog_present

Presents self within parents window.

unstable since: 1.5

adw_dialog_set_can_close

Sets whether self can be closed.

unstable since: 1.5

adw_dialog_set_child

Sets the child widget of self.

unstable since: 1.5

adw_dialog_set_content_height

Sets the height of the dialog’s contents.

unstable since: 1.5

adw_dialog_set_content_width

Sets the width of the dialog’s contents.

unstable since: 1.5

adw_dialog_set_default_widget

Sets the default widget for self.

unstable since: 1.5

adw_dialog_set_focus

Sets the focus widget for self.

unstable since: 1.5

adw_dialog_set_follows_content_size

Sets whether to size content of self automatically.

unstable since: 1.5

adw_dialog_set_presentation_mode

Sets presentation mode for self.

unstable since: 1.5

adw_dialog_set_title

Sets the title of self.

unstable since: 1.5

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (18)
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:application-icon

The name of the application icon.

unstable since: 1.5

Adw.AboutDialog:application-name

The name of the application.

unstable since: 1.5

Adw.AboutDialog:artists

The list of artists of the application.

unstable since: 1.5

Adw.AboutDialog:comments

The comments about the application.

unstable since: 1.5

Adw.AboutDialog:copyright

The copyright information.

unstable since: 1.5

Adw.AboutDialog:debug-info

The debug information.

unstable since: 1.5

Adw.AboutDialog:debug-info-filename

The debug information filename.

unstable since: 1.5

Adw.AboutDialog:designers

The list of designers of the application.

unstable since: 1.5

Adw.AboutDialog:developer-name

The developer name.

unstable since: 1.5

Adw.AboutDialog:developers

The list of developers of the application.

unstable since: 1.5

Adw.AboutDialog:documenters

The list of documenters of the application.

unstable since: 1.5

Adw.AboutDialog:issue-url

The URL for the application’s issue tracker.

unstable since: 1.5

Adw.AboutDialog:license

The license text.

unstable since: 1.5

Adw.AboutDialog:license-type

The license type.

unstable since: 1.5

Adw.AboutDialog:release-notes

The release notes of the application.

unstable since: 1.5

Adw.AboutDialog:release-notes-version

The version described by the application’s release notes.

unstable since: 1.5

Adw.AboutDialog:support-url

The URL of the application’s support page.

unstable since: 1.5

Adw.AboutDialog:translator-credits

The translator credits string.

unstable since: 1.5

Adw.AboutDialog:version

The version of the application.

unstable since: 1.5

Adw.AboutDialog:website

The URL of the application’s website.

unstable since: 1.5

Properties inherited from AdwDialog (10)
Adw.Dialog:can-close

Whether the dialog can be closed.

unstable since: 1.5

Adw.Dialog:child

The child widget of the AdwDialog.

unstable since: 1.5

Adw.Dialog:content-height

The height of the dialog’s contents.

unstable since: 1.5

Adw.Dialog:content-width

The width of the dialog’s contents.

unstable since: 1.5

Adw.Dialog:current-breakpoint

The current breakpoint.

unstable since: 1.5

Adw.Dialog:default-widget

The default widget.

unstable since: 1.5

Adw.Dialog:focus-widget

The focus widget.

unstable since: 1.5

Adw.Dialog:follows-content-size

Whether to size content automatically.

unstable since: 1.5

Adw.Dialog:presentation-mode

The dialog’s presentation mode.

unstable since: 1.5

Adw.Dialog:title

The title of the dialog.

unstable 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

Adw.AboutDialog::activate-link

Emitted when a URL is activated.

unstable since: 1.5

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.

unstable since: 1.5

AdwDialog::closed

Emitted when the dialog is successfully closed.

unstable 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.

Class structure

struct AdwAboutDialogClass {
  AdwDialogClass parent_class;
  
}

No description available.

Class members
parent_class: AdwDialogClass

No description available.