Gtk2::AboutDialog

Section: User Contributed Perl Documentation (3)
Updated: 2008-05-05
Index Return to Main Contents
 

NAME

Gtk2::AboutDialog  

HIERARCHY

  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Bin
                           +----Gtk2::Window
                                +----Gtk2::Dialog
                                     +----Gtk2::AboutDialog

 

INTERFACES

  Glib::Object::_Unregistered::AtkImplementorIface

 

METHODS

 

widget = Gtk2::AboutDialog->new

 

list = $about->get_artists

 

$about->set_artists ($artist1, ...)

* $artist1 (string)
* ... (list)
 

list = $about->get_authors

 

$about->set_authors ($author1, ...)

* $author1 (string)
* ... (list)
 

string or undef = $about->get_comments

 

$about->set_comments ($comments)

* $comments (string or undef)
 

string or undef = $about->get_copyright

 

$about->set_copyright ($copyright)

* $copyright (string or undef)
 

list = $about->get_documenters

 

$about->set_documenters ($documenter1, ...)

* $documenter1 (string)
* ... (list)
 

Gtk2::AboutDialog->set_email_hook ($func, $data=undef)

* $func (scalar)
* $data (scalar)
 

string or undef = $about->get_license

 

$about->set_license ($license)

* $license (string or undef)
 

pixbuf or undef = $about->get_logo

 

string or undef = $about->get_logo_icon_name

 

$about->set_logo_icon_name ($icon_name)

* $icon_name (string or undef)
 

$about->set_logo ($logo)

* $logo (Gtk2::Gdk::Pixbuf or undef)
 

string or undef = $about->get_program_name

 

$about->set_program_name ($name)

* $name (string or undef)
 

Gtk2->show_about_dialog ($parent, $first_property_name, ...)

* $parent (Gtk2::Window or undef)
* $first_property_name (string)
* ... (list) the rest of a list of name=>property value pairs.

This is a convenience function for showing an application's about box. The constructed dialog is associated with the parent window and reused for future invocations of this function.

The dialog is shown nonmodally, and will be hidden by any response.

 

string or undef = $about->get_translator_credits

 

$about->set_translator_credits ($translator_credits)

* $translator_credits (string or undef)
 

Gtk2::AboutDialog->set_url_hook ($func, $data=undef)

* $func (scalar)
* $data (scalar)
 

string or undef = $about->get_version

 

$about->set_version ($version)

* $version (string or undef)
 

string or undef = $about->get_website

 

string or undef = $about->get_website_label

 

$about->set_website_label ($website_label)

* $website_label (string or undef)
 

$about->set_website ($website)

* $website (string or undef)
 

boolean = $about->get_wrap_license

Since: gtk+ 2.8
 

$about->set_wrap_license ($wrap_license)

* $wrap_license (boolean)

Since: gtk+ 2.8

 

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 before setting the website and email URL properties, like this:

  $about_dialog->set_url_hook(\&launch_web_browser);
  $about_dialog->set_website($app_website);

otherwise the AboutDialog will not display the website and the email addresses as clickable.  

PROPERTIES

'artists' (Glib::Strv : readable / writable / private)
List of people who have contributed artwork to the program
'authors' (Glib::Strv : readable / writable / private)
List of authors of the program
'comments' (string : readable / writable / private)
Comments about the program
'copyright' (string : readable / writable / private)
Copyright information for the program
'documenters' (Glib::Strv : readable / writable / private)
List of people documenting the program
'license' (string : readable / writable / private)
The license of the program
'logo' (Gtk2::Gdk::Pixbuf : readable / writable / private)
A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list()
'logo-icon-name' (string : readable / writable / private)
A named icon to use as the logo for the about box.
'name' (string : readable / writable / private)
The name of the program. If this is not set, it defaults to g_get_application_name()
'translator-credits' (string : readable / writable / private)
Credits to the translators. This string should be marked as translatable
'version' (string : readable / writable / private)
The version of the program
'website' (string : readable / writable / private)
The URL for the link to the website of the program
'website-label' (string : readable / writable / private)
The label for the link to the website of the program. If this is not set, it defaults to the URL
'wrap-license' (boolean : readable / writable / private)
Whether to wrap the license text.
 

SEE ALSO

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin, Gtk2::Window, Gtk2::Dialog  

COPYRIGHT

Copyright (C) 2003-2008 by the gtk2-perl team.

This software is licensed under the LGPL. See Gtk2 for a full notice.


 

Index

NAME
HIERARCHY
INTERFACES
METHODS
widget = Gtk2::AboutDialog->new
list = $about->get_artists
$about->set_artists ($artist1, ...)
list = $about->get_authors
$about->set_authors ($author1, ...)
string or undef = $about->get_comments
$about->set_comments ($comments)
string or undef = $about->get_copyright
$about->set_copyright ($copyright)
list = $about->get_documenters
$about->set_documenters ($documenter1, ...)
Gtk2::AboutDialog->set_email_hook ($func, $data=undef)
string or undef = $about->get_license
$about->set_license ($license)
pixbuf or undef = $about->get_logo
string or undef = $about->get_logo_icon_name
$about->set_logo_icon_name ($icon_name)
$about->set_logo ($logo)
string or undef = $about->get_program_name
$about->set_program_name ($name)
Gtk2->show_about_dialog ($parent, $first_property_name, ...)
string or undef = $about->get_translator_credits
$about->set_translator_credits ($translator_credits)
Gtk2::AboutDialog->set_url_hook ($func, $data=undef)
string or undef = $about->get_version
$about->set_version ($version)
string or undef = $about->get_website
string or undef = $about->get_website_label
$about->set_website_label ($website_label)
$about->set_website ($website)
boolean = $about->get_wrap_license
$about->set_wrap_license ($wrap_license)
URL AND EMAIL HOOKS
PROPERTIES
SEE ALSO
COPYRIGHT

linux.jgfs.net manual pages