class Adw::AboutDialog

• Adw::AboutDialog
• Adw::Dialog
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

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

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

What's New

Adw::AboutDialog provides a way for applications to display their release notes, set with the [property@AboutDialog: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 AboutDialog::version. Use [property@AboutDialog:release-notes-version] to override it.

Details

The Details page displays the application comments and links.

The comments can be set with the AboutDialog::comments property. Unlike Gtk::AboutDialog#comments, this string can be long and detailed. It can also contain links and Pango markup.

To set the application website, use AboutDialog::website. To add extra links below the website, use AboutDialog::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

Adw::AboutDialog displays the following two links on the main page:

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

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

Adw::AboutDialog provides a quick way to save debug information to a file. When saving, [property@AboutDialog: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 AboutDialog::developers property,
• Designers, set with the AboutDialog::designers property,
• Artists, set with the AboutDialog::artists property,
• Documenters, set with the AboutDialog::documenters property,
• Translators, set with the [property@AboutDialog: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 AboutDialog::add_credit_section to add them.

The Acknowledgements page can be used to acknowledge additional people and organizations for their non-development contributions. Use AboutDialog::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 AboutDialog::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 [property@AboutDialog:license-type] property. If the application's license is not in the list, AboutDialog::license can be used instead.

To add information about other modules, such as application dependencies or data, use AboutDialog::add_legal_section.

Other applications

Adw::AboutDialog can show links to your other apps at the end of the main page. To add them, use AboutDialog::add_other_app.

Constructing

To make constructing an Adw::AboutDialog as convenient as possible, you can use the function #show_about_dialog which constructs and shows a dialog.

WARNING ⚠️ The following code is in c ⚠️

static void
show_about (Gtk::Application *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/",
                         "license-type", GTK_LICENSE_GPL_3_0,
                         "developers", developers,
                         "designers", designers,
                         "translator-credits", _("translator-credits"),
                         NULL);
}

CSS nodes

Adw::AboutDialog has a main CSS node with the name dialog and the style class .about.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::ShortcutManager

Defined in:

Constructors

• .new : self

  Creates a new Adw::AboutDialog.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, application_icon : String | Nil = nil, application_name : String | Nil = nil, artists : Enumerable(String) | Nil = nil, can_close : Bool | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, child : Gtk::Widget | Nil = nil, comments : String | Nil = nil, content_height : Int32 | Nil = nil, content_width : Int32 | Nil = nil, copyright : String | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, current_breakpoint : Adw::Breakpoint | Nil = nil, cursor : Gdk::Cursor | Nil = nil, debug_info : String | Nil = nil, debug_info_filename : String | Nil = nil, default_widget : Gtk::Widget | Nil = nil, designers : Enumerable(String) | Nil = nil, developer_name : String | Nil = nil, developers : Enumerable(String) | Nil = nil, documenters : Enumerable(String) | Nil = nil, focus_on_click : Bool | Nil = nil, focus_widget : Gtk::Widget | Nil = nil, focusable : Bool | Nil = nil, follows_content_size : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, issue_url : String | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, license : String | Nil = nil, license_type : Gtk::License | Nil = nil, limit_events : Bool | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, presentation_mode : Adw::DialogPresentationMode | Nil = nil, receives_default : Bool | Nil = nil, release_notes : String | Nil = nil, release_notes_version : String | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, support_url : String | Nil = nil, title : String | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, translator_credits : String | Nil = nil, valign : Gtk::Align | Nil = nil, version : String | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, website : String | Nil = nil, width_request : Int32 | Nil = nil)
• .new_from_appdata(resource_path : String, release_notes_version : String | Nil) : self

  Creates a new Adw::AboutDialog using AppStream metadata.

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #activate_link_signal
• #add_acknowledgement_section(name : String | Nil, people : Enumerable(String)) : Nil

  Adds a section to the Acknowledgements page.

• #add_credit_section(name : String | Nil, people : Enumerable(String)) : Nil

  Adds an extra section to the Credits page.

• #add_legal_section(title : String, copyright : String | Nil, license_type : Gtk::License, license : String | Nil) : Nil

  Adds an extra section to the Legal page.

• #add_link(title : String, url : String) : Nil

  Adds an extra link to the Details page.

• #add_other_app(appid : String, name : String, summary : String) : Nil

  Adds another application to self.

• #application_icon : String

  Gets the name of the application icon for self.

• #application_icon=(application_icon : String) : Nil

  Sets the name of the application icon for self.

• #application_icon=(value : Nil) : Nil

  Set #application_icon property to nil.

• #application_icon? : String | Nil

  Same as #application_icon, but can return nil.

• #application_name : String

  Gets the application name for self.

• #application_name=(application_name : String) : Nil

  Sets the application name for self.

• #application_name=(value : Nil) : Nil

  Set #application_name property to nil.

• #application_name? : String | Nil

  Same as #application_name, but can return nil.

• #artists : Enumerable(String) | Nil

  Gets the list of artists of the application.

• #artists=(value : Enumerable(String)) : Enumerable(String)
• #artists=(artists : Enumerable(String) | Nil) : Nil

  Sets the list of artists of the application.

• #comments : String

  Gets the comments about the application.

• #comments=(comments : String) : Nil

  Sets the comments about the application.

• #comments=(value : Nil) : Nil

  Set #comments property to nil.

• #comments? : String | Nil

  Same as #comments, but can return nil.

• #copyright : String

  Gets the copyright information for self.

• #copyright=(copyright : String) : Nil

  Sets the copyright information for self.

• #copyright=(value : Nil) : Nil

  Set #copyright property to nil.

• #copyright? : String | Nil

  Same as #copyright, but can return nil.

• #debug_info : String

  Gets the debug information for self.

• #debug_info=(debug_info : String) : Nil

  Sets the debug information for self.

• #debug_info=(value : Nil) : Nil

  Set #debug_info property to nil.

• #debug_info? : String | Nil

  Same as #debug_info, but can return nil.

• #debug_info_filename : String

  Gets the debug information filename for self.

• #debug_info_filename=(filename : String) : Nil

  Sets the debug information filename for self.

• #debug_info_filename=(value : Nil) : Nil

  Set #debug_info_filename property to nil.

• #debug_info_filename? : String | Nil

  Same as #debug_info_filename, but can return nil.

• #designers : Enumerable(String) | Nil

  Gets the list of designers of the application.

• #designers=(value : Enumerable(String)) : Enumerable(String)
• #designers=(designers : Enumerable(String) | Nil) : Nil

  Sets the list of designers of the application.

• #developer_name : String

  Gets the developer name for self.

• #developer_name=(developer_name : String) : Nil

  Sets the developer name for self.

• #developer_name=(value : Nil) : Nil

  Set #developer_name property to nil.

• #developer_name? : String | Nil

  Same as #developer_name, but can return nil.

• #developers : Enumerable(String) | Nil

  Gets the list of developers of the application.

• #developers=(value : Enumerable(String)) : Enumerable(String)
• #developers=(developers : Enumerable(String) | Nil) : Nil

  Sets the list of developers of the application.

• #documenters : Enumerable(String) | Nil

  Gets the list of documenters of the application.

• #documenters=(value : Enumerable(String)) : Enumerable(String)
• #documenters=(documenters : Enumerable(String) | Nil) : Nil

  Sets the list of documenters of the application.

• #hash(hasher)

  See Object#hash(hasher)

• #issue_url : String

  Gets the issue tracker URL for self.

• #issue_url=(issue_url : String) : Nil

  Sets the issue tracker URL for self.

• #issue_url=(value : Nil) : Nil

  Set #issue_url property to nil.

• #issue_url? : String | Nil

  Same as #issue_url, but can return nil.

• #license : String

  Gets the license for self.

• #license=(license : String) : Nil

  Sets the license for self.

• #license=(value : Nil) : Nil

  Set #license property to nil.

• #license? : String | Nil

  Same as #license, but can return nil.

• #license_type : Gtk::License

  Gets the license type for self.

• #license_type=(license_type : Gtk::License) : Nil

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

• #release_notes : String

  Gets the release notes for self.

• #release_notes=(release_notes : String) : Nil

  Sets the release notes for self.

• #release_notes=(value : Nil) : Nil

  Set #release_notes property to nil.

• #release_notes? : String | Nil

  Same as #release_notes, but can return nil.

• #release_notes_version : String

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

• #release_notes_version=(version : String) : Nil

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

• #release_notes_version=(value : Nil) : Nil

  Set #release_notes_version property to nil.

• #release_notes_version? : String | Nil

  Same as #release_notes_version, but can return nil.

• #support_url : String

  Gets the URL of the support page for self.

• #support_url=(support_url : String) : Nil

  Sets the URL of the support page for self.

• #support_url=(value : Nil) : Nil

  Set #support_url property to nil.

• #support_url? : String | Nil

  Same as #support_url, but can return nil.

• #translator_credits : String

  Gets the translator credits string.

• #translator_credits=(translator_credits : String) : Nil

  Sets the translator credits string.

• #translator_credits=(value : Nil) : Nil

  Set #translator_credits property to nil.

• #translator_credits? : String | Nil

  Same as #translator_credits, but can return nil.

• #version : String

  Gets the version for self.

• #version=(version : String) : Nil

  Sets the version for self.

• #version=(value : Nil) : Nil

  Set #version property to nil.

• #version? : String | Nil

  Same as #version, but can return nil.

• #website : String

  Gets the application website URL for self.

• #website=(website : String) : Nil

  Sets the application website URL for self.

• #website=(value : Nil) : Nil

  Set #website property to nil.

• #website? : String | Nil

  Same as #website, but can return nil.

Constructor Detail

Class Method Detail

Instance Method Detail

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and a known license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_LGPL_2_1,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and custom license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_CUSTOM,
                                    "Custom license text");

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright only"),
                                    "© 2022 Example",
                                    GTK_LICENSE_UNKNOWN,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Custom license only"),
                                    NULL,
                                    GTK_LICENSE_CUSTOM,
                                    "Something completely custom here.");

adw_about_dialog_add_other_app (ADW_ABOUT_DIALOG (about),
                                "org.gnome.Boxes",
                                _("Boxes"),
                                _("Virtualization made simple"));