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 FileLauncher::launch() when a user clicks one. The behaviour can be overridden with the 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.

Properties

artists

The people who contributed artwork to the program, as a NULL-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links.

Readable | Writeable

authors

The authors of the program, as a NULL-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Readable | Writeable

comments

Comments about the program.

This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

Readable | Writeable

copyright

Copyright information for the program.

Readable | Writeable

documenters

The people documenting the program, as a NULL-terminated array of strings.

Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Readable | Writeable

license

The license of the program, as free-form text.

This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the “wrap-license” property is set to TRUE; otherwise the text itself must contain the intended linebreaks.

When setting this property to a non-NULL value, the license-type property is set to GTK_LICENSE_CUSTOM as a side effect.

The text may contain links in this format <http://www.some.place/> and email references in the form <mail-to@some.body>, and these will be converted into clickable links.

Readable | Writeable

license-type

The license of the program.

The AboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If GTK_LICENSE_UNKNOWN is used, the link used will be the same specified in the website property.

If GTK_LICENSE_CUSTOM is used, the current contents of the license property are used.

For any other License value, the contents of the license property are also set by this property as a side effect.

Readable | Writeable

logo

A logo for the about box.

If it is NULL, the default window icon set with Window::set_default_icon_name will be used.

Readable | Writeable

logo-icon-name

A named icon to use as the logo for the about box.

This property overrides the logo property.

Readable | Writeable

program-name

The name of the program.

If this is not set, it defaults to the value returned by g_get_application_name().

Readable | Writeable

system-information

Information about the system on which the program is running.

This information is displayed in a separate page, therefore it is fine to use a long multi-paragraph text. Note that the text should contain the intended linebreaks.

The text may contain links in this format <http://www.some.place/> and email references in the form <mail-to@some.body>, and these will be converted into clickable links.

Readable | Writeable

translator-credits

Credits to the translators.

This string should be marked as translatable.

The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Readable | Writeable

version

The version of the program.

Readable | Writeable

website

The URL for the link to the website of the program.

This should be a string starting with http:// or https://.

Readable | Writeable

website-label

The label for the link to the website of the program.

Readable | Writeable

wrap-license

Whether to wrap the text in the license dialog.

Readable | Writeable

Window

application

The Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to None.

Readable | Writeable

child

The child widget.

Readable | Writeable

decorated

Whether the window should have a frame (also known as decorations).

Readable | Writeable

default-height

The default height of the window.

Readable | Writeable

default-widget

The default widget.

Readable | Writeable

default-width

The default width of the window.

Readable | Writeable

deletable

Whether the window frame should have a close button.

Readable | Writeable

destroy-with-parent

If this window should be destroyed when the parent is destroyed.

Readable | Writeable

display

The display that will display this window.

Readable | Writeable

focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

Readable | Writeable

focus-widget

The focus widget.

Readable | Writeable

fullscreened

Whether the window is fullscreen.

Setting this property is the equivalent of calling GtkWindowExt::fullscreen() or GtkWindowExt::unfullscreen(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

Readable | Writeable

hide-on-close

If this window should be hidden when the users clicks the close button.

Readable | Writeable

icon-name

Specifies the name of the themed icon to use as the window icon.

See IconTheme for more details.

Readable | Writeable

is-active

Whether the toplevel is the currently active window.

Readable

maximized

Whether the window is maximized.

Setting this property is the equivalent of calling GtkWindowExt::maximize() or GtkWindowExt::unmaximize(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

mnemonics-visible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

Readable | Writeable

modal

If true, the window is modal.

Readable | Writeable

resizable

If true, users can resize the window.

Readable | Writeable

startup-id

A write-only property for setting window’s startup notification identifier.

Writeable

title

The title of the window.

Readable | Writeable

titlebar

The titlebar widget.

Readable | Writeable

transient-for

The transient parent of the window.

Readable | Writeable | Construct

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

activate-link

Emitted every time a URL is activated.

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

Window

activate-default

Emitted when the user activates the default widget of @window.

This is a keybinding signal.

Action

activate-focus

Emitted when the user activates the currently focused widget of @window.

This is a keybinding signal.

Action

close-request

Emitted when the user clicks on the close button of the window.

enable-debugging

Emitted when the user enables or disables interactive debugging.

When @toggle is true, interactive debugging is toggled on or off, when it is false, the debugger will be pointed at the widget under the pointer.

This is a keybinding signal.

The default bindings for this signal are Ctrl-Shift-I and Ctrl-Shift-D.

Action

keys-changed

emitted when the set of accelerators or mnemonics that are associated with @window changes.

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

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 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 FileLauncher::launch().

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 HasParamSpec for AboutDialog

type ParamSpec = ParamSpecObject

type SetValue = AboutDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, AboutDialog>

fn param_spec_builder() -> Self::BuilderFn

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, Self: Sized,

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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