logo top
Main Page   Widgets   Namespaces   Book  

Gtk::AboutDialog Class Reference
[Dialogs]

Inheritance diagram for Gtk::AboutDialog:

Inheritance graph
[legend]
List of all members.

Detailed Description

TODO.


Public Types

typedef sigc::slot< void,
AboutDialog&, const Glib::ustring& > 
SlotActivateLink
 For instance, void on_activate_link_url(AboutDialog& about_dialog, const Glib::ustring& link);.

Public Member Functions

 AboutDialog ()
Glib::StringArrayHandle get_artists () const
 Returns the string which are displayed in the artists tab of the secondary credits dialog.
Glib::StringArrayHandle get_authors () const
 Returns the string which are displayed in the authors tab of the secondary credits dialog.
Glib::ustring get_comments () const
 Returns the comments string.
Glib::ustring get_copyright () const
 Returns the copyright string.
Glib::StringArrayHandle get_documenters () const
 Returns the string which are displayed in the documenters tab of the secondary credits dialog.
Glib::ustring get_license () const
 Returns the license information.
Glib::RefPtr<const Gdk::Pixbufget_logo () const
 Returns the pixbuf displayed as logo in the about dialog.
Glib::RefPtr<Gdk::Pixbufget_logo ()
 Returns the pixbuf displayed as logo in the about dialog.
Glib::ustring get_logo_icon_name () const
 Returns the icon name displayed as logo in the about dialog.
Glib::ustring get_name () const
 Returns the program name displayed in the about dialog.
Glib::ustring get_translator_credits () const
 Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.
Glib::ustring get_version () const
 Returns the version string.
Glib::ustring get_website () const
 Returns the website URL.
Glib::ustring get_website_label () const
 Returns the label used for the website link.
const GtkAboutDialog* gobj () const
 Provides access to the underlying C GtkObject.
GtkAboutDialog* gobj ()
 Provides access to the underlying C GtkObject.
void set_artists (const Glib::StringArrayHandle& artists)
 Sets the strings which are displayed in the artists tab of the secondary credits dialog.
void set_authors (const Glib::StringArrayHandle& authors) const
 Sets the strings which are displayed in the authors tab of the secondary credits dialog.
void set_comments (const Glib::ustring& comments)
 Sets the comments string to display in the about dialog.
void set_copyright (const Glib::ustring& copyright)
 Sets the copyright string to display in the about dialog.
void set_documenters (const Glib::StringArrayHandle& documenters)
 Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
void set_license (const Glib::ustring& license)
 Sets the license information to be displayed in the secondary license dialog.
void set_logo (const Glib::RefPtr<Gdk::Pixbuf>& logo)
 Sets the pixbuf to be displayed as logo in the about dialog.
void set_logo_icon_name (const Glib::ustring& icon_name)
 Sets the pixbuf to be displayed as logo in the about dialog.
void set_name (const Glib::ustring& name)
 Sets the name to display in the about dialog.
void set_translator_credits (const Glib::ustring& translator_credits)
 Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.
void set_version (const Glib::ustring& version)
 Sets the version string to display in the about dialog.
void set_website (const Glib::ustring& website)
 Sets the URL to use for the website link.
void set_website_label (const Glib::ustring& website_label)
 Sets the label to be used for the website link.
virtual ~AboutDialog ()

Static Public Member Functions

static void set_email_hook (const SlotActivateLink& slot)
static void set_url_hook (const SlotActivateLink& slot)

Related Functions

(Note that these are not member functions.)

Gtk::AboutDialogwrap (GtkAboutDialog* object, bool take_copy=false)
 
Parameters:
object The C instance


Member Typedef Documentation

typedef sigc::slot<void, AboutDialog& , const Glib::ustring& > Gtk::AboutDialog::SlotActivateLink

For instance, void on_activate_link_url(AboutDialog& about_dialog, const Glib::ustring& link);.


Constructor & Destructor Documentation

virtual Gtk::AboutDialog::~AboutDialog (  )  [virtual]

Gtk::AboutDialog::AboutDialog (  ) 


Member Function Documentation

Glib::StringArrayHandle Gtk::AboutDialog::get_artists (  )  const

Returns the string which are displayed in the artists tab of the secondary credits dialog.

Returns:
A 0-terminated string array containing the artists. The array is owned by the about dialog and must not be modified.
.

Glib::StringArrayHandle Gtk::AboutDialog::get_authors (  )  const

Returns the string which are displayed in the authors tab of the secondary credits dialog.

Returns:
A 0-terminated string array containing the authors. The array is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_comments (  )  const

Returns the comments string.

Returns:
The comments. The string is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_copyright (  )  const

Returns the copyright string.

Returns:
The copyright string. The string is owned by the about dialog and must not be modified.
.

Glib::StringArrayHandle Gtk::AboutDialog::get_documenters (  )  const

Returns the string which are displayed in the documenters tab of the secondary credits dialog.

Returns:
A 0-terminated string array containing the documenters. The array is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_license (  )  const

Returns the license information.

Returns:
The license information. The string is owned by the about dialog and must not be modified.
.

Glib::RefPtr<const Gdk::Pixbuf> Gtk::AboutDialog::get_logo (  )  const

Returns the pixbuf displayed as logo in the about dialog.

Returns:
The pixbuf displayed as logo. The pixbuf is owned by the about dialog. If you want to keep a reference to it, you have to call Glib::object_ref() on it.
.

Glib::RefPtr<Gdk::Pixbuf> Gtk::AboutDialog::get_logo (  ) 

Returns the pixbuf displayed as logo in the about dialog.

Returns:
The pixbuf displayed as logo. The pixbuf is owned by the about dialog. If you want to keep a reference to it, you have to call Glib::object_ref() on it.
.

Glib::ustring Gtk::AboutDialog::get_logo_icon_name (  )  const

Returns the icon name displayed as logo in the about dialog.

Returns:
The icon name displayed as logo. The string is owned by the about dialog. If you want to keep a reference to it, you have to call Glib::strdup() on it.
.

Glib::ustring Gtk::AboutDialog::get_name (  )  const

Returns the program name displayed in the about dialog.

Returns:
The program name. The string is owned by the about dialog and must not be modified.
.

Reimplemented from Gtk::Widget.

Glib::ustring Gtk::AboutDialog::get_translator_credits (  )  const

Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

Returns:
The translator credits string. The string is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_version (  )  const

Returns the version string.

Returns:
The version string. The string is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_website (  )  const

Returns the website URL.

Returns:
The website URL. The string is owned by the about dialog and must not be modified.
.

Glib::ustring Gtk::AboutDialog::get_website_label (  )  const

Returns the label used for the website link.

Returns:
The label used for the website link. The string is owned by the about dialog and must not be modified.
.

const GtkAboutDialog* Gtk::AboutDialog::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

GtkAboutDialog* Gtk::AboutDialog::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

void Gtk::AboutDialog::set_artists ( const Glib::StringArrayHandle &  artists  ) 

Sets the strings which are displayed in the artists tab of the secondary credits dialog.

Parameters:
artists A 0-terminated array of strings.

void Gtk::AboutDialog::set_authors ( const Glib::StringArrayHandle &  authors  )  const

Sets the strings which are displayed in the authors tab of the secondary credits dialog.

Parameters:
authors A 0-terminated array of strings.

void Gtk::AboutDialog::set_comments ( const Glib::ustring &  comments  ) 

Sets the comments string to display in the about dialog.

This should be a short string of one or two lines.

Parameters:
comments A comments string.

void Gtk::AboutDialog::set_copyright ( const Glib::ustring &  copyright  ) 

Sets the copyright string to display in the about dialog.

This should be a short string of one or two lines.

Parameters:
copyright The copyright string.

void Gtk::AboutDialog::set_documenters ( const Glib::StringArrayHandle &  documenters  ) 

Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

Parameters:
documenters A 0-terminated array of strings.

static void Gtk::AboutDialog::set_email_hook ( const SlotActivateLink slot  )  [static]

void Gtk::AboutDialog::set_license ( const Glib::ustring &  license  ) 

Sets the license information to be displayed in the secondary license dialog.

If license is 0, the license button is hidden.

Parameters:
license The license information or 0.

void Gtk::AboutDialog::set_logo ( const Glib::RefPtr<Gdk::Pixbuf>&  logo  ) 

Sets the pixbuf to be displayed as logo in the about dialog.

If it is 0, the default window icon set with Gtk::Window::set_default_icon() will be used.

Parameters:
logo A Gdk::Pixbuf, or 0.

void Gtk::AboutDialog::set_logo_icon_name ( const Glib::ustring &  icon_name  ) 

Sets the pixbuf to be displayed as logo in the about dialog.

If it is 0, the default window icon set with Gtk::Window::set_default_icon() will be used.

Parameters:
icon_name An icon name, or 0.

void Gtk::AboutDialog::set_name ( const Glib::ustring &  name  ) 

Sets the name to display in the about dialog.

If this is not set, it defaults to Glib::get_application_name().

Parameters:
name The program name.

Reimplemented from Gtk::Widget.

void Gtk::AboutDialog::set_translator_credits ( const Glib::ustring &  translator_credits  ) 

Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.

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:

 gtk_about_dialog_set_translator_credits (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 Gtk::AboutDialog will detect if "translator-credits" is untranslated and hide the tab.

Parameters:
translator_credits The translator credits.

static void Gtk::AboutDialog::set_url_hook ( const SlotActivateLink slot  )  [static]

void Gtk::AboutDialog::set_version ( const Glib::ustring &  version  ) 

Sets the version string to display in the about dialog.

Parameters:
version The version string.

void Gtk::AboutDialog::set_website ( const Glib::ustring &  website  ) 

Sets the URL to use for the website link.

Parameters:
website A URL string starting with "http://".

void Gtk::AboutDialog::set_website_label ( const Glib::ustring &  website_label  ) 

Sets the label to be used for the website link.

It defaults to the website URL.

Parameters:
website_label The label used for the website link.


Friends And Related Function Documentation

Gtk::AboutDialog* wrap ( GtkAboutDialog *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for gtkmm 2.4 by Doxygen 1.5.1 © 1997-2001