Struct gtk4::AboutDialog

#[repr(transparent)]
pub struct AboutDialog { /* private fields */ }

The 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. AboutDialog displays these as clickable links. By default, it calls show_uri() when a user clicks one. The behaviour can be overridden with the signal::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 AboutDialog as convenient as possible, you can use the function 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 AboutDialog, as shown in the following example:

⚠️ The following code is in c ⚠️

GFile *logo_file = g_file_new_for_path ("./logo.png");
GdkTexture *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

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

Implements

GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl AboutDialog

pub fn new() -> AboutDialog

Creates a new AboutDialog.

Returns

a newly created AboutDialog

pub fn builder() -> AboutDialogBuilder

Creates a new builder-pattern struct instance to construct AboutDialog objects.

This method returns an instance of AboutDialogBuilder which can be used to create AboutDialog objects.

pub fn add_credit_section(&self, section_name: &str, people: &[&str])

Creates a new section in the “Credits” page.

section_name

The name of the section

people

The people who belong to that section

pub fn artists(&self) -> Vec<GString>

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

Returns

A NULL-terminated string array containing the artists

pub fn authors(&self) -> Vec<GString>

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

Returns

A NULL-terminated string array containing the authors

pub fn comments(&self) -> Option<GString>

Returns the comments string.

Returns

The comments

pub fn copyright(&self) -> Option<GString>

Returns the copyright string.

Returns

The copyright string

pub fn documenters(&self) -> Vec<GString>

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

Returns

A NULL-terminated string array containing the documenters

pub fn license(&self) -> Option<GString>

Returns the license information.

Returns

The license information

pub fn license_type(&self) -> License

Retrieves the license type.

Returns

a License value

pub fn logo(&self) -> Option<Paintable>

Returns the paintable displayed as logo in the about dialog.

Returns

the paintable displayed as logo or NULL if the logo is unset or has been set via set_logo_icon_name()

pub fn logo_icon_name(&self) -> Option<GString>

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

Returns

the icon name displayed as logo, or NULL if the logo has been set via set_logo()

pub fn program_name(&self) -> Option<GString>

Returns the program name displayed in the about dialog.

Returns

The program name

pub fn system_information(&self) -> Option<GString>

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

Returns

the system information

pub fn translator_credits(&self) -> Option<GString>

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

Returns

The translator credits string

pub fn version(&self) -> Option<GString>

Returns the version string.

Returns

The version string

pub fn website(&self) -> Option<GString>

Returns the website URL.

Returns

The website URL

pub fn website_label(&self) -> Option<GString>

Returns the label used for the website link.

Returns

The label used for the website link

pub fn wraps_license(&self) -> bool

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

Returns

TRUE if the license text is wrapped

pub fn set_artists(&self, artists: &[&str])

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

artists

the authors of the artwork of the application

pub fn set_authors(&self, authors: &[&str])

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

authors

the authors of the application

pub fn set_comments(&self, comments: Option<&str>)

Sets the comments string to display in the about dialog.

This should be a short string of one or two lines.

comments

a comments string

pub fn set_copyright(&self, copyright: Option<&str>)

Sets the copyright string to display in the about dialog.

This should be a short string of one or two lines.

copyright

the copyright string

pub fn set_documenters(&self, documenters: &[&str])

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

documenters

the authors of the documentation of the application

pub fn set_license(&self, license: Option<&str>)

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

If license is NULL, the license page is hidden.

license

the license information

pub fn set_license_type(&self, license_type: License)

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

This function overrides the license set using set_license().

license_type

the type of license

pub fn set_logo(&self, logo: Option<&impl IsA<Paintable>>)

Sets the logo in the about dialog.

logo

a gdk::Paintable

pub fn set_logo_icon_name(&self, icon_name: Option<&str>)

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

icon_name

an icon name

pub fn set_program_name(&self, name: Option<&str>)

Sets the name to display in the about dialog.

If name is not set, the string returned by g_get_application_name() is used.

name

the program name

pub fn set_system_information(&self, system_information: Option<&str>)

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

If system_information is NULL, the system information page is hidden.

See property::AboutDialog::system-information.

system_information

system information

pub fn set_translator_credits(&self, translator_credits: Option<&str>)

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

The intended use for this string is to display the translator of the language which is currently used in the user interface. Using gettext(), a simple way to achieve that is to mark the string for translation:

⚠️ The following code is in c ⚠️

GtkWidget *about = gtk_about_dialog_new ();
 gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
                                          _("translator-credits"));

It is a good idea to use the customary msgid “translator-credits” for this purpose, since translators will already know the purpose of that msgid, and since AboutDialog will detect if “translator-credits” is untranslated and omit translator credits.

translator_credits

the translator credits

pub fn set_version(&self, version: Option<&str>)

Sets the version string to display in the about dialog.

version

the version string

pub fn set_website(&self, website: Option<&str>)

Sets the URL to use for the website link.

website

a URL string starting with http://

pub fn set_website_label(&self, website_label: &str)

Sets the label to be used for the website link.

website_label

the label used for the website link

pub fn set_wrap_license(&self, wrap_license: bool)

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

wrap_license

whether to wrap the license

pub fn connect_activate_link<F: Fn(&Self, &str) -> Inhibit + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted every time a URL is activated.

Applications may connect to it to override the default behaviour, which is to call show_uri().

uri

the URI that is activated

Returns

TRUE if the link has been activated

pub fn connect_artists_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_authors_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_comments_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_copyright_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_documenters_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_license_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_license_type_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_logo_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_logo_icon_name_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_program_name_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_system_information_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_translator_credits_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_version_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_website_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_website_label_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_wrap_license_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for AboutDialog

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AboutDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AboutDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for AboutDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for AboutDialog

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for AboutDialog

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl ParentClassIs for AboutDialog

type Parent = Window

impl<OT: ObjectType> PartialEq<OT> for AboutDialog

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<OT: ObjectType> PartialOrd<OT> for AboutDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AboutDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AboutDialog

impl IsA<Accessible> for AboutDialog

impl IsA<Buildable> for AboutDialog

impl IsA<ConstraintTarget> for AboutDialog

impl IsA<Native> for AboutDialog

impl IsA<Root> for AboutDialog

impl IsA<ShortcutManager> for AboutDialog

impl IsA<Widget> for AboutDialog

impl IsA<Window> for AboutDialog