class Gtk::AboutDialog

• Gtk::AboutDialog
• Gtk::Window
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

The Gtk::AboutDialog offers a simple way to display information about a program.

The shown information includes the programs' logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program.

An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.

About dialogs often contain links and email addresses. Gtk::AboutDialog displays these as clickable links. By default, it calls Gtk::show_uri when a user clicks one. The behaviour can be overridden with the [signal@Gtk.AboutDialog::activate-link] signal.

To specify a person with an email address, use a string like Edgar Allan Poe <edgar@poe.com>. To specify a website with a title, use a string like GTK team https://www.gtk.org.

To make constructing a Gtk::AboutDialog as convenient as possible, you can use the function Gtk::show_about_dialog which constructs and shows a dialog and keeps it around so that it can be shown again.

Note that GTK sets a default title of _("About %s") on the dialog window (where %s is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a Gtk::AboutDialog, as shown in the following example:

WARNING ⚠️ The following code is in c ⚠️

GFile *logo_file = g_file_new_for_path ("./logo.png");
Gdk::Texture *example_logo = gdk_texture_new_from_file (logo_file, NULL);
g_object_unref (logo_file);

gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title", _("About ExampleCode"),
                       NULL);

CSS nodes

Gtk::AboutDialog has a single CSS node with the name window and style class .aboutdialog.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::Native
• Gtk::Root
• Gtk::ShortcutManager

Defined in:

Constructors

• .new : self

  Creates a new Gtk::AboutDialog.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, application : Gtk::Application | Nil = nil, artists : Enumerable(String) | Nil = nil, authors : Enumerable(String) | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, child : Gtk::Widget | Nil = nil, comments : String | Nil = nil, copyright : String | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, decorated : Bool | Nil = nil, default_height : Int32 | Nil = nil, default_widget : Gtk::Widget | Nil = nil, default_width : Int32 | Nil = nil, deletable : Bool | Nil = nil, destroy_with_parent : Bool | Nil = nil, display : Gdk::Display | Nil = nil, documenters : Enumerable(String) | Nil = nil, focus_on_click : Bool | Nil = nil, focus_visible : Bool | Nil = nil, focus_widget : Gtk::Widget | Nil = nil, focusable : Bool | Nil = nil, fullscreened : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, handle_menubar_accel : Bool | 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, hide_on_close : Bool | Nil = nil, icon_name : String | Nil = nil, is_active : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, license : String | Nil = nil, license_type : Gtk::License | Nil = nil, logo : Gdk::Paintable | Nil = nil, logo_icon_name : String | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, maximized : Bool | Nil = nil, mnemonics_visible : Bool | Nil = nil, modal : Bool | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, program_name : String | Nil = nil, receives_default : Bool | Nil = nil, resizable : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, startup_id : String | Nil = nil, system_information : String | Nil = nil, title : String | Nil = nil, titlebar : Gtk::Widget | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, transient_for : Gtk::Window | 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, website_label : String | Nil = nil, width_request : Int32 | Nil = nil, wrap_license : Bool | Nil = nil)

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_credit_section(section_name : String, people : Enumerable(String)) : Nil

  Creates a new section in the "Credits" page.

• #artists : Enumerable(String)

  Returns the names of the artists which are displayed in the credits page.

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

  Sets the names of the artists to be displayed in the "Credits" page.

• #authors : Enumerable(String)

  Returns the names of the authors which are displayed in the credits page.

• #authors=(authors : Enumerable(String)) : Nil

  Sets the names of the authors which are displayed in the "Credits" page of the about dialog.

• #comments : String | Nil

  Returns the comments string.

• #comments=(value : String) : String
• #comments=(value : Nil) : Nil

  Set #comments property to nil.

• #comments=(comments : String | Nil) : Nil

  Sets the comments string to display in the about dialog.

• #comments? : String | Nil

  Same as #comments, but can return nil.

• #copyright : String | Nil

  Returns the copyright string.

• #copyright=(value : String) : String
• #copyright=(value : Nil) : Nil

  Set #copyright property to nil.

• #copyright=(copyright : String | Nil) : Nil

  Sets the copyright string to display in the about dialog.

• #copyright? : String | Nil

  Same as #copyright, but can return nil.

• #documenters : Enumerable(String)

  Returns the name of the documenters which are displayed in the credits page.

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

  Sets the names of the documenters which are displayed in the "Credits" page.

• #hash(hasher)

  See Object#hash(hasher)

• #license : String | Nil

  Returns the license information.

• #license=(value : String) : String
• #license=(value : Nil) : Nil

  Set #license property to nil.

• #license=(license : String | Nil) : Nil

  Sets the license information to be displayed in the about dialog.

• #license? : String | Nil

  Same as #license, but can return nil.

• #license_type : Gtk::License

  Retrieves the license type.

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

  Sets the license of the application showing the about dialog from a list of known licenses.

• #logo : Gdk::Paintable | Nil

  Returns the paintable displayed as logo in the about dialog.

• #logo=(logo : Gdk::Paintable | Nil) : Nil

  Sets the logo in the about dialog.

• #logo_icon_name : String | Nil

  Returns the icon name displayed as logo in the about dialog.

• #logo_icon_name=(value : String) : String
• #logo_icon_name=(value : Nil) : Nil

  Set #logo_icon_name property to nil.

• #logo_icon_name=(icon_name : String | Nil) : Nil

  Sets the icon name to be displayed as logo in the about dialog.

• #logo_icon_name? : String | Nil

  Same as #logo_icon_name, but can return nil.

• #program_name : String | Nil

  Returns the program name displayed in the about dialog.

• #program_name=(value : String) : String
• #program_name=(value : Nil) : Nil

  Set #program_name property to nil.

• #program_name=(name : String | Nil) : Nil

  Sets the name to display in the about dialog.

• #program_name? : String | Nil

  Same as #program_name, but can return nil.

• #system_information : String | Nil

  Returns the system information that is shown in the about dialog.

• #system_information=(value : String) : String
• #system_information=(value : Nil) : Nil

  Set #system_information property to nil.

• #system_information=(system_information : String | Nil) : Nil

  Sets the system information to be displayed in the about dialog.

• #system_information? : String | Nil

  Same as #system_information, but can return nil.

• #translator_credits : String | Nil

  Returns the translator credits string which is displayed in the credits page.

• #translator_credits=(value : String) : String
• #translator_credits=(value : Nil) : Nil

  Set #translator_credits property to nil.

• #translator_credits=(translator_credits : String | Nil) : Nil

  Sets the translator credits string which is displayed in the credits page.

• #translator_credits? : String | Nil

  Same as #translator_credits, but can return nil.

• #version : String | Nil

  Returns the version string.

• #version=(value : String) : String
• #version=(value : Nil) : Nil

  Set #version property to nil.

• #version=(version : String | Nil) : Nil

  Sets the version string to display in the about dialog.

• #version? : String | Nil

  Same as #version, but can return nil.

• #website : String | Nil

  Returns the website URL.

• #website=(value : String) : String
• #website=(value : Nil) : Nil

  Set #website property to nil.

• #website=(website : String | Nil) : Nil

  Sets the URL to use for the website link.

• #website? : String | Nil

  Same as #website, but can return nil.

• #website_label : String | Nil

  Returns the label used for the website link.

• #website_label=(website_label : String) : Nil

  Sets the label to be used for the website link.

• #website_label=(value : Nil) : Nil

  Set #website_label property to nil.

• #website_label? : String | Nil

  Same as #website_label, but can return nil.

• #wrap_license : Bool

  Returns whether the license text in the about dialog is automatically wrapped.

• #wrap_license=(wrap_license : Bool) : Nil

  Sets whether the license text in the about dialog should be automatically wrapped.

• #wrap_license? : Bool

Constructor Detail

Class Method Detail

Instance Method Detail

Gtk::Widget *about = gtk_about_dialog_new ();
 gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
                                          _("translator-credits"));