![]() |
![]() |
It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.
About dialogs often contain links and email addresses. Gtk::AboutDialog supports this by offering global hooks, which are called when the user clicks on a link or email address, see set_email_hook() and set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for <user>, URLs are recognized by looking for http://url, with the URL extending to the next space, tab or line break.
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::Pixbuf> | get_logo () const |
Returns the pixbuf displayed as logo in the about dialog. | |
Glib::RefPtr<Gdk::Pixbuf> | get_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_program_name () const |
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. | |
bool | get_wrap_license () const |
Returns whether the license text in about is automatically wrapped. | |
const GtkAboutDialog* | gobj () const |
Provides access to the underlying C GtkObject. | |
GtkAboutDialog* | gobj () |
Provides access to the underlying C GtkObject. | |
Glib::PropertyProxy_ReadOnly< Glib::StringArrayHandle > | property_artists () const |
List of people who have contributed artwork to the program. | |
Glib::PropertyProxy<Glib::StringArrayHandle> | property_artists () |
List of people who have contributed artwork to the program. | |
Glib::PropertyProxy_ReadOnly< Glib::StringArrayHandle > | property_authors () const |
List of authors of the program. | |
Glib::PropertyProxy<Glib::StringArrayHandle> | property_authors () |
List of authors of the program. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_comments () const |
Comments about the program. | |
Glib::PropertyProxy<Glib::ustring> | property_comments () |
Comments about the program. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_copyright () const |
Copyright information for the program. | |
Glib::PropertyProxy<Glib::ustring> | property_copyright () |
Copyright information for the program. | |
Glib::PropertyProxy_ReadOnly< Glib::StringArrayHandle > | property_documenters () const |
List of people documenting the program. | |
Glib::PropertyProxy<Glib::StringArrayHandle> | property_documenters () |
List of people documenting the program. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_license () const |
The license of the program. | |
Glib::PropertyProxy<Glib::ustring> | property_license () |
The license of the program. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf >> | property_logo () const |
A logo for the about box. | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > | property_logo () |
A logo for the about box. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_logo_icon_name () const |
A named icon to use as the logo for the about box. | |
Glib::PropertyProxy<Glib::ustring> | property_logo_icon_name () |
A named icon to use as the logo for the about box. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. | |
Glib::PropertyProxy<Glib::ustring> | property_name () |
The name of the widget. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_program_name () const |
The name of the program. | |
Glib::PropertyProxy<Glib::ustring> | property_program_name () |
The name of the program. | |
Glib::PropertyProxy_ReadOnly< Glib::StringArrayHandle > | property_translator_credits () const |
Credits to the translators. | |
Glib::PropertyProxy<Glib::StringArrayHandle> | property_translator_credits () |
Credits to the translators. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_version () const |
The version of the program. | |
Glib::PropertyProxy<Glib::ustring> | property_version () |
The version of the program. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_website () const |
The URL for the link to the website of the program. | |
Glib::PropertyProxy<Glib::ustring> | property_website () |
The URL for the link to the website of the program. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_website_label () const |
The label for the link to the website of the program. | |
Glib::PropertyProxy<Glib::ustring> | property_website_label () |
The label for the link to the website of the program. | |
Glib::PropertyProxy_ReadOnly< bool > | property_wrap_license () const |
Whether to wrap the license text. | |
Glib::PropertyProxy<bool> | property_wrap_license () |
Whether to wrap the license text. | |
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_program_name (const Glib::ustring& name) |
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. | |
void | set_wrap_license (bool wrap_license) |
Sets whether the license text in about is automatically wrapped. | |
virtual | ~AboutDialog () |
Static Public Member Functions | |
static void | set_email_hook (const SlotActivateLink& slot) |
Installs a global callback to be called whenever the user activates an email link in an about dialog. | |
static void | set_url_hook (const SlotActivateLink& slot) |
Installs a global callback to be called whenever the user activates a URL link in an about dialog. | |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::AboutDialog* | wrap (GtkAboutDialog* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
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);.
virtual Gtk::AboutDialog::~AboutDialog | ( | ) | [virtual] |
Gtk::AboutDialog::AboutDialog | ( | ) |
Glib::StringArrayHandle Gtk::AboutDialog::get_artists | ( | ) | const |
Returns the string which are displayed in the artists tab of the secondary credits dialog.
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.
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.
Glib::ustring Gtk::AboutDialog::get_copyright | ( | ) | const |
Returns the copyright string.
Glib::StringArrayHandle Gtk::AboutDialog::get_documenters | ( | ) | const |
Returns the string which are displayed in the documenters tab of the secondary credits dialog.
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.
Glib::RefPtr<const Gdk::Pixbuf> Gtk::AboutDialog::get_logo | ( | ) | const |
Returns the pixbuf displayed as logo in the about dialog.
Glib::RefPtr<Gdk::Pixbuf> Gtk::AboutDialog::get_logo | ( | ) |
Returns the pixbuf displayed as logo in the about dialog.
Glib::ustring Gtk::AboutDialog::get_logo_icon_name | ( | ) | const |
Returns the icon name displayed as logo in the about dialog.
Glib::ustring Gtk::AboutDialog::get_name | ( | ) | const |
Returns the program name displayed in the about dialog.
Reimplemented from Gtk::Widget.
Glib::ustring Gtk::AboutDialog::get_program_name | ( | ) | const |
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.
Glib::ustring Gtk::AboutDialog::get_version | ( | ) | const |
Returns the version string.
Glib::ustring Gtk::AboutDialog::get_website | ( | ) | const |
Returns the website URL.
Glib::ustring Gtk::AboutDialog::get_website_label | ( | ) | const |
Returns the label used for the website link.
bool Gtk::AboutDialog::get_wrap_license | ( | ) | const |
Returns whether the license text in about is automatically wrapped.
true
if the license text is wrappedconst GtkAboutDialog* Gtk::AboutDialog::gobj | ( | ) | const [inline] |
GtkAboutDialog* Gtk::AboutDialog::gobj | ( | ) | [inline] |
Glib::PropertyProxy_ReadOnly<Glib::StringArrayHandle> Gtk::AboutDialog::property_artists | ( | ) | const |
List of people who have contributed artwork to the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::StringArrayHandle> Gtk::AboutDialog::property_artists | ( | ) |
List of people who have contributed artwork to the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::StringArrayHandle> Gtk::AboutDialog::property_authors | ( | ) | const |
List of authors of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::StringArrayHandle> Gtk::AboutDialog::property_authors | ( | ) |
List of authors of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_comments | ( | ) | const |
Comments about the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_comments | ( | ) |
Comments about the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_copyright | ( | ) | const |
Copyright information for the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_copyright | ( | ) |
Copyright information for the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::StringArrayHandle> Gtk::AboutDialog::property_documenters | ( | ) | const |
List of people documenting the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::StringArrayHandle> Gtk::AboutDialog::property_documenters | ( | ) |
List of people documenting the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_license | ( | ) | const |
The license of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_license | ( | ) |
The license of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::RefPtr<Gdk::Pixbuf>> Gtk::AboutDialog::property_logo | ( | ) | const |
A logo for the about box.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::RefPtr<Gdk::Pixbuf>> Gtk::AboutDialog::property_logo | ( | ) |
A logo for the about box.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_logo_icon_name | ( | ) | const |
A named icon to use as the logo for the about box.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_logo_icon_name | ( | ) |
A named icon to use as the logo for the about box.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_name | ( | ) | const |
The name of the widget.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gtk::Widget.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_name | ( | ) |
The name of the widget.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gtk::Widget.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_program_name | ( | ) | const |
The name of the program.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_program_name | ( | ) |
The name of the program.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::StringArrayHandle> Gtk::AboutDialog::property_translator_credits | ( | ) | const |
Credits to the translators.
This string should be marked as translatable.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::StringArrayHandle> Gtk::AboutDialog::property_translator_credits | ( | ) |
Credits to the translators.
This string should be marked as translatable.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_version | ( | ) | const |
The version of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_version | ( | ) |
The version of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_website | ( | ) | const |
The URL for the link to the website of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_website | ( | ) |
The URL for the link to the website of the program.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::AboutDialog::property_website_label | ( | ) | const |
The label for the link to the website of the program.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Glib::ustring> Gtk::AboutDialog::property_website_label | ( | ) |
The label for the link to the website of the program.
If this is not set
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Gtk::AboutDialog::property_wrap_license | ( | ) | const |
Whether to wrap the license text.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Gtk::AboutDialog::property_wrap_license | ( | ) |
Whether to wrap the license text.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
void Gtk::AboutDialog::set_artists | ( | const Glib::StringArrayHandle & | artists | ) |
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
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.
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.
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.
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.
documenters | A 0 -terminated array of strings. |
static void Gtk::AboutDialog::set_email_hook | ( | const SlotActivateLink& | slot | ) | [static] |
Installs a global callback to be called whenever the user activates an email link in an about dialog.
slot | A function or method to call when an email link is activated. |
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.
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.
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.
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().
name | The program name. |
Reimplemented from Gtk::Widget.
void Gtk::AboutDialog::set_program_name | ( | const Glib::ustring & | name | ) |
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"));
translator_credits | The translator credits. |
static void Gtk::AboutDialog::set_url_hook | ( | const SlotActivateLink& | slot | ) | [static] |
Installs a global callback to be called whenever the user activates a URL link in an about dialog.
slot | A function or method to call when a URL link is activated. |
void Gtk::AboutDialog::set_version | ( | const Glib::ustring & | version | ) |
Sets the version string to display in the about dialog.
version | The version string. |
void Gtk::AboutDialog::set_website | ( | const Glib::ustring & | website | ) |
Sets the URL to use for the website link.
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.
website_label | The label used for the website link. |
void Gtk::AboutDialog::set_wrap_license | ( | bool | wrap_license | ) |
Sets whether the license text in about is automatically wrapped.
wrap_license | Whether to wrap the license. |
Gtk::AboutDialog* wrap | ( | GtkAboutDialog * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |