Learn R Programming

RGtk2 (version 2.20.1)

GtkAboutDialog: GtkAboutDialog

Description

Display information about an application

Arguments

Methods and Functions

gtkAboutDialogNew(show = TRUE) gtkAboutDialogGetName(object) gtkAboutDialogGetName(object) gtkAboutDialogSetName(object, name = NULL) gtkAboutDialogSetName(object, name = NULL) gtkAboutDialogGetProgramName(object) gtkAboutDialogSetProgramName(object, name) gtkAboutDialogGetVersion(object) gtkAboutDialogSetVersion(object, version = NULL) gtkAboutDialogGetCopyright(object) gtkAboutDialogSetCopyright(object, copyright = NULL) gtkAboutDialogGetComments(object) gtkAboutDialogSetComments(object, comments = NULL) gtkAboutDialogGetLicense(object) gtkAboutDialogSetLicense(object, license = NULL) gtkAboutDialogGetWrapLicense(object) gtkAboutDialogSetWrapLicense(object, wrap.license) gtkAboutDialogGetWebsite(object) gtkAboutDialogSetWebsite(object, website = NULL) gtkAboutDialogGetWebsiteLabel(object) gtkAboutDialogSetWebsiteLabel(object, website.label = NULL) gtkAboutDialogGetAuthors(object) gtkAboutDialogSetAuthors(object, authors) gtkAboutDialogGetArtists(object) gtkAboutDialogSetArtists(object, artists) gtkAboutDialogGetDocumenters(object) gtkAboutDialogSetDocumenters(object, documenters) gtkAboutDialogGetTranslatorCredits(object) gtkAboutDialogSetTranslatorCredits(object, translator.credits = NULL) gtkAboutDialogGetLogo(object) gtkAboutDialogSetLogo(object, logo = NULL) gtkAboutDialogGetLogoIconName(object) gtkAboutDialogSetLogoIconName(object, icon.name = NULL) gtkAboutDialogSetEmailHook(func, data = NULL) gtkAboutDialogSetUrlHook(func, data = NULL) gtkShowAboutDialog(parent, ...) gtkAboutDialog(show = TRUE)

Hierarchy

GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GtkWindow +----GtkDialog +----GtkAboutDialog

Interfaces

GtkAboutDialog implements AtkImplementorIface and GtkBuildable.

Detailed Description

The GtkAboutDialog offers a simple way to display information about a program like its logo, name, copyright, website and license. 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 dialog often contain links and email addresses. GtkAboutDialog supports this by offering global hooks, which are called when the user clicks on a link or email address, see gtkAboutDialogSetEmailHook and gtkAboutDialogSetUrlHook. Email addresses in the authors, documenters and artists properties are recognized by looking for , URLs are recognized by looking for http://url, with url extending to the next space, tab or line break. Since 2.18 GtkAboutDialog provides default website and email hooks that use gtkShowUri. If you want provide your own hooks overriding the default ones, it is important to do so before setting the website and email URL properties, like this: gtkShowAboutDialog(NULL, "name" = "ExampleCode", "logo" = example_logo, "title" = "About ExampleCode") To disable the default hooks, you can pass NULL as the hook func. Then, the GtkAboutDialog widget will not display the website or the email addresses as clickable. To make constructing a GtkAboutDialog as convenient as possible, you can use the function gtkShowAboutDialog which constructs and shows a dialog and keeps it around so that it can be shown again. Note that GTK+ sets a default title of _("About %s") on the dialog window (where %s is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a GtkAboutDialog, as shown in the following example: about$setTranslatorCredits(gettext("translator-credits")) Note that prior to GTK+ 2.12, the "program-name" property was called "name". This was changed to avoid the conflict with the "name" property.

Convenient Construction

gtkAboutDialog is the equivalent of gtkAboutDialogNew.

References

http://library.gnome.org/devel//gtk/GtkAboutDialog.html