Struct gtk4::AboutDialog

source ·

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

Expand description

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.

An example GtkAboutDialog

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

Struct gtk4::AboutDialog

Implementations§

impl AboutDialog

pub fn new() -> AboutDialog

pub fn builder() -> AboutDialogBuilder

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

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

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

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

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

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

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

pub fn license_type(&self) -> License

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

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

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

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

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

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

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

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

pub fn wraps_license(&self) -> bool

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

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

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

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

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

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

pub fn set_license_type(&self, license_type: License)

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

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

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

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

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

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

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

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

pub fn set_wrap_license(&self, wrap_license: bool)

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

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

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

impl Debug for AboutDialog

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

impl Default for AboutDialog

fn default() -> Self

impl Display for AboutDialog

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

impl Hash for AboutDialog

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

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

impl Ord for AboutDialog

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

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

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

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

impl ParentClassIs for AboutDialog

type Parent = Window

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

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

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

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

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