Struct gtk::AboutDialog

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

The GtkAboutDialog offers a simple way to display information about a program like its 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. GtkAboutDialog displays these as clickable links. By default, it calls show_uri_on_window() 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`>”. To specify a website with a title, use a string like “GTK+ team http://www.gtk.org”.

To make constructing a GtkAboutDialog 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 GtkAboutDialog, as shown in the following example:

⚠️ The following code is in C ⚠️

GdkPixbuf *example_logo = gdk_pixbuf_new_from_file ("./logo.png", NULL);
gtk_show_about_dialog (NULL,
                       "program-name", "ExampleCode",
                       "logo", example_logo,
                       "title", _("About ExampleCode"),
                       NULL);

It is also possible to show a AboutDialog like any other Dialog, e.g. using DialogExt::run(). In this case, you might need to know that the “Close” button returns the ResponseType::Cancel response id.

Implements

AboutDialogExt, DialogExt, GtkWindowExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, DialogExtManual, [GtkWindowExtManual][trait@crate::prelude::GtkWindowExtManual], ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl AboutDialog

pub const NONE: Option<&'static AboutDialog> = None

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.

Trait Implementations

impl Clone for AboutDialog

fn clone(&self) -> Self

Returns a copy of the value.

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

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for AboutDialog

type Parent = Dialog

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

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

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

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

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

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

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

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

const 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<Bin> for AboutDialog

impl IsA<Buildable> for AboutDialog

impl IsA<Container> for AboutDialog

impl IsA<Dialog> for AboutDialog

impl IsA<Widget> for AboutDialog

impl IsA<Window> for AboutDialog