Gnome::UI::About Class Reference

Small window for displaying brief info about the application. More...

#include <about.h>

Inheritance diagram for Gnome::UI::About:

Dialog

List of all members.

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 &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.
 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.
Glib::PropertyProxy
< Glib::ustring > 
property_name ()
 The name of the application.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_name () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy
< Glib::ustring > 
property_version ()
 Application version.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_version () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy
< Glib::ustring > 
property_copyright ()
 Copyright notice.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_copyright () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy
< Glib::ustring > 
property_comments ()
 Short description.
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_comments () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy
< Glib::ustring > 
property_translator_credits ()
 Translator credits string; should be empty or "translator_credits".
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_translator_credits () const
 You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Related Functions

(Note that these are not member functions.)

Gnome::UI::Aboutwrap (GnomeAbout *object, bool take_copy=false)
 A Glib::wrap() method for this object.


Detailed Description

Small window for displaying brief info about the application.

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.


Constructor & Destructor Documentation

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.

Parameters:
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".
If the application is being translated, the translator credits string should simply be "translator_credits" to allow the translators to translate this string into a list of names of themselves. To avoid getting the string "translator_credits" with untranslated runs of the program, test for whether the string is actually changed. For instance:

   // 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.


Member Function Documentation

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.

Glib::PropertyProxy<Glib::ustring> Gnome::UI::About::property_name (  ) 

The name of the application.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gnome::UI::About::property_name (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gnome::UI::About::property_version (  ) 

Application version.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gnome::UI::About::property_version (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gnome::UI::About::property_copyright (  ) 

Copyright notice.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gnome::UI::About::property_copyright (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gnome::UI::About::property_comments (  ) 

Short description.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gnome::UI::About::property_comments (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gnome::UI::About::property_translator_credits (  ) 

Translator credits string; should be empty or "translator_credits".

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gnome::UI::About::property_translator_credits (  )  const

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.


Friends And Related Function Documentation

Gnome::UI::About * wrap ( GnomeAbout *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
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.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated on Mon Sep 22 07:01:33 2008 for libgnomeuimm by  doxygen 1.5.6