.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Gtk2::AboutDialog 3" .TH Gtk2::AboutDialog 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Gtk2::AboutDialog \- wrapper for GtkAboutDialog .SH HIERARCHY .IX Header "HIERARCHY" .Vb 9 \& Glib::Object \& +\-\-\-\-Glib::InitiallyUnowned \& +\-\-\-\-Gtk2::Object \& +\-\-\-\-Gtk2::Widget \& +\-\-\-\-Gtk2::Container \& +\-\-\-\-Gtk2::Bin \& +\-\-\-\-Gtk2::Window \& +\-\-\-\-Gtk2::Dialog \& +\-\-\-\-Gtk2::AboutDialog .Ve .SH INTERFACES .IX Header "INTERFACES" .Vb 2 \& Glib::Object::_Unregistered::AtkImplementorIface \& Gtk2::Buildable .Ve .SH METHODS .IX Header "METHODS" .SS "widget = Gtk2::AboutDialog\->\fBnew\fP" .IX Subsection "widget = Gtk2::AboutDialog->new" .ie n .SS "list = $about\->\fBget_artists\fP" .el .SS "list = \f(CW$about\fP\->\fBget_artists\fP" .IX Subsection "list = $about->get_artists" .ie n .SS "$about\->\fBset_artists\fP ($artist1, ...)" .el .SS "\f(CW$about\fP\->\fBset_artists\fP ($artist1, ...)" .IX Subsection "$about->set_artists ($artist1, ...)" .IP \(bu 4 \&\f(CW$artist1\fR (string) .IP \(bu 4 \&... (list) .ie n .SS "list = $about\->\fBget_authors\fP" .el .SS "list = \f(CW$about\fP\->\fBget_authors\fP" .IX Subsection "list = $about->get_authors" .ie n .SS "$about\->\fBset_authors\fP ($author1, ...)" .el .SS "\f(CW$about\fP\->\fBset_authors\fP ($author1, ...)" .IX Subsection "$about->set_authors ($author1, ...)" .IP \(bu 4 \&\f(CW$author1\fR (string) .IP \(bu 4 \&... (list) .ie n .SS "string or undef = $about\->\fBget_comments\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_comments\fP" .IX Subsection "string or undef = $about->get_comments" .ie n .SS "$about\->\fBset_comments\fP ($comments)" .el .SS "\f(CW$about\fP\->\fBset_comments\fP ($comments)" .IX Subsection "$about->set_comments ($comments)" .IP \(bu 4 \&\f(CW$comments\fR (string or undef) .ie n .SS "string or undef = $about\->\fBget_copyright\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_copyright\fP" .IX Subsection "string or undef = $about->get_copyright" .ie n .SS "$about\->\fBset_copyright\fP ($copyright)" .el .SS "\f(CW$about\fP\->\fBset_copyright\fP ($copyright)" .IX Subsection "$about->set_copyright ($copyright)" .IP \(bu 4 \&\f(CW$copyright\fR (string or undef) .ie n .SS "list = $about\->\fBget_documenters\fP" .el .SS "list = \f(CW$about\fP\->\fBget_documenters\fP" .IX Subsection "list = $about->get_documenters" .ie n .SS "$about\->\fBset_documenters\fP ($documenter1, ...)" .el .SS "\f(CW$about\fP\->\fBset_documenters\fP ($documenter1, ...)" .IX Subsection "$about->set_documenters ($documenter1, ...)" .IP \(bu 4 \&\f(CW$documenter1\fR (string) .IP \(bu 4 \&... (list) .ie n .SS "Gtk2::AboutDialog\->\fBset_email_hook\fP ($func, $data=undef)" .el .SS "Gtk2::AboutDialog\->\fBset_email_hook\fP ($func, \f(CW$data\fP=undef)" .IX Subsection "Gtk2::AboutDialog->set_email_hook ($func, $data=undef)" .IP \(bu 4 \&\f(CW$func\fR (scalar) .IP \(bu 4 \&\f(CW$data\fR (scalar) .ie n .SS "string or undef = $about\->\fBget_license\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_license\fP" .IX Subsection "string or undef = $about->get_license" .ie n .SS "$about\->\fBset_license\fP ($license)" .el .SS "\f(CW$about\fP\->\fBset_license\fP ($license)" .IX Subsection "$about->set_license ($license)" .IP \(bu 4 \&\f(CW$license\fR (string or undef) .ie n .SS "pixbuf or undef = $about\->\fBget_logo\fP" .el .SS "pixbuf or undef = \f(CW$about\fP\->\fBget_logo\fP" .IX Subsection "pixbuf or undef = $about->get_logo" .ie n .SS "string or undef = $about\->\fBget_logo_icon_name\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_logo_icon_name\fP" .IX Subsection "string or undef = $about->get_logo_icon_name" .ie n .SS "$about\->\fBset_logo_icon_name\fP ($icon_name)" .el .SS "\f(CW$about\fP\->\fBset_logo_icon_name\fP ($icon_name)" .IX Subsection "$about->set_logo_icon_name ($icon_name)" .IP \(bu 4 \&\f(CW$icon_name\fR (string or undef) .ie n .SS "$about\->\fBset_logo\fP ($logo)" .el .SS "\f(CW$about\fP\->\fBset_logo\fP ($logo)" .IX Subsection "$about->set_logo ($logo)" .IP \(bu 4 \&\f(CW$logo\fR (Gtk2::Gdk::Pixbuf or undef) .ie n .SS "string or undef = $about\->\fBget_program_name\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_program_name\fP" .IX Subsection "string or undef = $about->get_program_name" .ie n .SS "$about\->\fBset_program_name\fP ($name)" .el .SS "\f(CW$about\fP\->\fBset_program_name\fP ($name)" .IX Subsection "$about->set_program_name ($name)" .IP \(bu 4 \&\f(CW$name\fR (string or undef) .ie n .SS "Gtk2\->\fBshow_about_dialog\fP ($parent, $first_property_name, ...)" .el .SS "Gtk2\->\fBshow_about_dialog\fP ($parent, \f(CW$first_property_name\fP, ...)" .IX Subsection "Gtk2->show_about_dialog ($parent, $first_property_name, ...)" .IP \(bu 4 \&\f(CW$parent\fR (Gtk2::Window or undef) .IP \(bu 4 \&\f(CW$first_property_name\fR (string) .IP \(bu 4 \&... (list) the rest of a list of name=>property value pairs. .PP A convenience function for showing an application's about box. The constructed dialog is "transient for" \f(CW$parent\fR and associated with that widget so it's reused for future invocations. The dialog is non-modal and hidden by any response. .PP (This is implemented as a rewrite of \f(CW\*(C`gtk_show_about_dialog\*(C'\fR since it's not easy to construct a varargs call to that actual function. The intention is to behave the same though.) .ie n .SS "string or undef = $about\->\fBget_translator_credits\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_translator_credits\fP" .IX Subsection "string or undef = $about->get_translator_credits" .ie n .SS "$about\->\fBset_translator_credits\fP ($translator_credits)" .el .SS "\f(CW$about\fP\->\fBset_translator_credits\fP ($translator_credits)" .IX Subsection "$about->set_translator_credits ($translator_credits)" .IP \(bu 4 \&\f(CW$translator_credits\fR (string or undef) .ie n .SS "Gtk2::AboutDialog\->\fBset_url_hook\fP ($func, $data=undef)" .el .SS "Gtk2::AboutDialog\->\fBset_url_hook\fP ($func, \f(CW$data\fP=undef)" .IX Subsection "Gtk2::AboutDialog->set_url_hook ($func, $data=undef)" .IP \(bu 4 \&\f(CW$func\fR (scalar) .IP \(bu 4 \&\f(CW$data\fR (scalar) .ie n .SS "string or undef = $about\->\fBget_version\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_version\fP" .IX Subsection "string or undef = $about->get_version" .ie n .SS "$about\->\fBset_version\fP ($version)" .el .SS "\f(CW$about\fP\->\fBset_version\fP ($version)" .IX Subsection "$about->set_version ($version)" .IP \(bu 4 \&\f(CW$version\fR (string or undef) .ie n .SS "string or undef = $about\->\fBget_website\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_website\fP" .IX Subsection "string or undef = $about->get_website" .ie n .SS "string or undef = $about\->\fBget_website_label\fP" .el .SS "string or undef = \f(CW$about\fP\->\fBget_website_label\fP" .IX Subsection "string or undef = $about->get_website_label" .ie n .SS "$about\->\fBset_website_label\fP ($website_label)" .el .SS "\f(CW$about\fP\->\fBset_website_label\fP ($website_label)" .IX Subsection "$about->set_website_label ($website_label)" .IP \(bu 4 \&\f(CW$website_label\fR (string or undef) .ie n .SS "$about\->\fBset_website\fP ($website)" .el .SS "\f(CW$about\fP\->\fBset_website\fP ($website)" .IX Subsection "$about->set_website ($website)" .IP \(bu 4 \&\f(CW$website\fR (string or undef) .ie n .SS "boolean = $about\->\fBget_wrap_license\fP" .el .SS "boolean = \f(CW$about\fP\->\fBget_wrap_license\fP" .IX Subsection "boolean = $about->get_wrap_license" Since: gtk+ 2.8 .ie n .SS "$about\->\fBset_wrap_license\fP ($wrap_license)" .el .SS "\f(CW$about\fP\->\fBset_wrap_license\fP ($wrap_license)" .IX Subsection "$about->set_wrap_license ($wrap_license)" .IP \(bu 4 \&\f(CW$wrap_license\fR (boolean) .PP Since: gtk+ 2.8 .SH "URL AND EMAIL HOOKS" .IX Header "URL AND EMAIL HOOKS" When setting the website and email hooks for the Gtk2::AboutDialog widget, you should remember that the order is important: you should set the hook functions \&\fBbefore\fR setting the website and email URL properties, like this: .PP .Vb 2 \& $about_dialog\->set_url_hook(\e&launch_web_browser); \& $about_dialog\->set_website($app_website); .Ve .PP otherwise the AboutDialog will not display the website and the email addresses as clickable. .SH PROPERTIES .IX Header "PROPERTIES" .IP "'artists' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'artists' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" List of people who have contributed artwork to the program .IP "'authors' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'authors' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" List of authors of the program .IP "'comments' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'comments' (string : default undef : readable / writable / private / static-nick / static-blurb)" Comments about the program .IP "'copyright' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'copyright' (string : default undef : readable / writable / private / static-nick / static-blurb)" Copyright information for the program .IP "'documenters' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'documenters' (Glib::Strv : default undef : readable / writable / private / static-nick / static-blurb)" List of people documenting the program .IP "'license' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'license' (string : default undef : readable / writable / private / static-nick / static-blurb)" The license of the program .IP "'logo' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'logo' (Gtk2::Gdk::Pixbuf : default undef : readable / writable / private / static-nick / static-blurb)" A logo for the about box. If this is not set, it defaults to \fBgtk_window_get_default_icon_list()\fR .IP "'logo\-icon\-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'logo-icon-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" A named icon to use as the logo for the about box. .IP "'program\-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'program-name' (string : default undef : readable / writable / private / static-nick / static-blurb)" The name of the program. If this is not set, it defaults to \fBg_get_application_name()\fR .IP "'translator\-credits' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'translator-credits' (string : default undef : readable / writable / private / static-nick / static-blurb)" Credits to the translators. This string should be marked as translatable .IP "'version' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'version' (string : default undef : readable / writable / private / static-nick / static-blurb)" The version of the program .IP "'website' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'website' (string : default undef : readable / writable / private / static-nick / static-blurb)" The URL for the link to the website of the program .IP "'website\-label' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'website-label' (string : default undef : readable / writable / private / static-nick / static-blurb)" The label for the link to the website of the program. If this is not set, it defaults to the URL .IP "'wrap\-license' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4 .IX Item "'wrap-license' (boolean : default false : readable / writable / private / static-nick / static-blurb)" Whether to wrap the license text. .SH SIGNALS .IX Header "SIGNALS" .IP "boolean = \fBactivate-link\fR (Gtk2::AboutDialog, string)" 4 .IX Item "boolean = activate-link (Gtk2::AboutDialog, string)" .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin, Gtk2::Window, Gtk2::Dialog .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 2003\-2011 by the gtk2\-perl team. .PP This software is licensed under the LGPL. See Gtk2 for a full notice.