#include <about.h>
Inheritance diagram for Gnome::UI::About:
Public Member Functions | ||||
virtual | ~About () | |||
GnomeAbout * | gobj () | |||
Provides access to the underlying C GtkObject. | ||||
const GnomeAbout * | gobj () const | |||
Provides access to the underlying C GtkObject. | ||||
About (const Glib::ustring &name, const Glib::ustring &version, const Glib::ustring ©right, const Glib::ArrayHandle< Glib::ustring > &authors, const Glib::ArrayHandle< Glib::ustring > &documenters, const Glib::ustring &comments=Glib::ustring(), const Glib::ustring &translator_credits=Glib::ustring()) | ||||
Create an about box with the supplied information. | ||||
About (const Glib::ustring &name, const Glib::ustring &version, const Glib::ustring ©right, const Glib::ArrayHandle< Glib::ustring > &authors, const Glib::ArrayHandle< Glib::ustring > &documenters, const Glib::ustring &comments, const Glib::ustring &translator_credits, const Glib::RefPtr< Gdk::Pixbuf > &logo) | ||||
Create an about box with logo. | ||||
Related Functions | ||||
(Note that these are not member functions.) | ||||
Gnome::UI::About * | wrap (GnomeAbout *object, bool take_copy=false) | |||
|
For normal applications, an item to the help menu should be added to pop up the box. The box is supposed to contain a short description of the application together with the version string, copyright info, and a list of authors, documenters and translators.
virtual Gnome::UI::About::~About | ( | ) | [virtual] |
Gnome::UI::About::About | ( | const Glib::ustring & | name, | |
const Glib::ustring & | version, | |||
const Glib::ustring & | copyright, | |||
const Glib::ArrayHandle< Glib::ustring > & | authors, | |||
const Glib::ArrayHandle< Glib::ustring > & | documenters, | |||
const Glib::ustring & | comments = Glib::ustring() , |
|||
const Glib::ustring & | translator_credits = Glib::ustring() | |||
) |
Create an about box with the supplied information.
name | is the name of the application. | |
version | is the package version and is usually defined as VERSION if you use autoconf. | |
copyright | is the copyright notice, like "Copyright (c) 1913 Albert Einstein" . | |
authors | is a container with names of the authors of the application. | |
documenters | is a container with names of the documenters of the application. | |
comments | is the short description. | |
translator_credits | which always should be empty or the string "translator_credits" . |
// note to translators: please fill in your names and email addresses Glib::ustring translators = _("translator_credits"); if (translators == "translator_credits") translators = ""; // ...
The comment before the definition of the translator
string will survive into translator land.
When the user presses the OK button, the box will hide itself. So one way of implementing the about feature is to create the box once and store it somewhere for the lifetime of the main window, and then simply call show() and raise() on it when the about menu item is selected.
Gnome::UI::About::About | ( | const Glib::ustring & | name, | |
const Glib::ustring & | version, | |||
const Glib::ustring & | copyright, | |||
const Glib::ArrayHandle< Glib::ustring > & | authors, | |||
const Glib::ArrayHandle< Glib::ustring > & | documenters, | |||
const Glib::ustring & | comments, | |||
const Glib::ustring & | translator_credits, | |||
const Glib::RefPtr< Gdk::Pixbuf > & | logo | |||
) |
Create an about box with logo.
Contains an extra parameter which is a logo to display in the about box.
GnomeAbout* Gnome::UI::About::gobj | ( | ) | [inline] |
Provides access to the underlying C GtkObject.
const GnomeAbout* Gnome::UI::About::gobj | ( | ) | const [inline] |
Provides access to the underlying C GtkObject.
Gnome::UI::About * wrap | ( | GnomeAbout * | object, | |
bool | take_copy = false | |||
) | [related] |
object | The C instance |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |