gtk.AboutDialog



class AboutDialog : gtk.Dialog.Dialog;
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 dialogs often contain links and email addresses. GtkAboutDialog displays these as clickable links. By default, it calls gtk_show_uri() when a user clicks one. The behaviour can be overridden with the #GtkAboutDialog::activate-link signal.

To specify a person with an email address, use a string like "Edgar Allan Poe ". To specify a website with a title, use a string like "GTK+ team http://www.gtk.org".

To make constructing a GtkAboutDialog as convenient as possible, you can use the function gtk_show_about_dialog() 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: |[ gtk_show_about_dialog (NULL, "program-name", "ExampleCode", "logo", example_logo, "title" ("About ExampleCode"), NULL); ]|

It is also possible to show a #GtkAboutDialog like any other #GtkDialog, e.g. using gtk_dialog_run(). In this case, you might need to know that the “Close” button returns the #GTK_RESPONSE_CANCEL response id.

protected GtkAboutDialog* gtkAboutDialog ;
the main Gtk struct

GtkAboutDialog* getAboutDialogStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkAboutDialog* gtkAboutDialog, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

static GType getType ();


this();
Creates a new #GtkAboutDialog.

Return:
a newly created #GtkAboutDialog

Since:
2.6

Throws:
ConstructionException GTK+ fails to create the object.

void addCreditSection (string sectionName, string[] people);
Creates a new section in the Credits page.

Params:
string sectionName The name of the section
string[] people The people who belong to that section

Since:
3.4

string[] getArtists ();
Returns the string which are displayed in the artists tab of the secondary credits dialog.

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

Since:
2.6

string[] getAuthors ();
Returns the string which are displayed in the authors tab of the secondary credits dialog.

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

Since:
2.6

string getComments ();
Returns the comments string.

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

Since:
2.6

string getCopyright ();
Returns the copyright string.

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

Since:
2.6

string[] getDocumenters ();
Returns the string which are displayed in the documenters tab of the secondary credits dialog.

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

Since:
2.6

string getLicense ();
Returns the license information.

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

Since:
2.6

GtkLicense getLicenseType ();
Retrieves the license set using gtk_about_dialog_set_license_type()

Return:
a #GtkLicense value

Since:
3.0

Pixbuf getLogo ();
Returns the pixbuf displayed as logo in the about dialog.

Return:
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 g_object_ref() on it.

Since:
2.6

string getLogoIconName ();
Returns the icon name displayed as logo in the about dialog.

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

Since:
2.6

string getProgramName ();
Returns the program name displayed in the about dialog.

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

Since:
2.12

string getTranslatorCredits ();
Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

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

Since:
2.6

string getVersion ();
Returns the version string.

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

Since:
2.6

string getWebsite ();
Returns the website URL.

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

Since:
2.6

string getWebsiteLabel ();
Returns the label used for the website link.

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

Since:
2.6

bool getWrapLicense ();
Returns whether the license text in @about is automatically wrapped.

Return:
%TRUE if the license text is wrapped

Since:
2.8

void setArtists (string[] artists);
Sets the strings which are displayed in the artists tab of the secondary credits dialog.

Params:
string[] artists a %NULL-terminated array of strings

Since:
2.6

void setAuthors (string[] authors);
Sets the strings which are displayed in the authors tab of the secondary credits dialog.

Params:
string[] authors a %NULL-terminated array of strings

Since:
2.6

void setComments (string comments);
Sets the comments string to display in the about dialog. This should be a short string of one or two lines.

Params:
string comments a comments string

Since:
2.6

void setCopyright (string copyright);
Sets the copyright string to display in the about dialog. This should be a short string of one or two lines.

Params:
string copyright the copyright string

Since:
2.6

void setDocumenters (string[] documenters);
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

Params:
string[] documenters a %NULL-terminated array of strings

Since:
2.6

void setLicense (string license);
Sets the license information to be displayed in the secondary license dialog. If @license is %NULL, the license button is hidden.

Params:
string license the license information or %NULL

Since:
2.6

void setLicenseType (GtkLicense licenseType);
Sets the license of the application showing the @about dialog from a list of known licenses.

This function overrides the license set using gtk_about_dialog_set_license().

Params:
GtkLicense licenseType the type of license

Since:
3.0

void setLogo (Pixbuf logo);
Sets the pixbuf to be displayed as logo in the about dialog. If it is %NULL, the default window icon set with gtk_window_set_default_icon() will be used.

Params:
Pixbuf logo a #GdkPixbuf, or %NULL

Since:
2.6

void setLogoIconName (string iconName);
Sets the pixbuf to be displayed as logo in the about dialog. If it is %NULL, the default window icon set with gtk_window_set_default_icon() will be used.

Params:
string iconName an icon name, or %NULL

Since:
2.6

void setProgramName (string name);
Sets the name to display in the about dialog. If this is not set, it defaults to g_get_application_name().

Params:
string name the program name

Since:
2.12

void setTranslatorCredits (string translatorCredits);
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 #GtkAboutDialog will detect if “translator-credits” is untranslated and hide the tab.

Params:
string translatorCredits the translator credits

Since:
2.6

void setVersion (string versio);
Sets the version string to display in the about dialog.

Params:
string versio the version string

Since:
2.6

void setWebsite (string website);
Sets the URL to use for the website link.

Params:
string website a URL string starting with "http://"

Since:
2.6

void setWebsiteLabel (string websiteLabel);
Sets the label to be used for the website link.

Params:
string websiteLabel the label used for the website link

Since:
2.6

void setWrapLicense (bool wrapLicense);
Sets whether the license text in @about is automatically wrapped.

Params:
bool wrapLicense whether to wrap the license

Since:
2.8

void addOnActivateLink (bool delegate(string, AboutDialog) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The signal which gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call gtk_show_uri().

Params:
uri the URI that is activated

Return:
%TRUE if the link has been activated

Since:
2.24

Page was generated with on Mon Mar 7 22:40:37 2016