Display information about an application
Class GtkAboutDialog
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 set_email_hook() and set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for
[...]
| Methods | |
| get_artists | Returns the string which are displayed in the artists tab of the secondary credits dialog. |
| get_authors | Returns the string which are displayed in the authors tab of the secondary credits dialog. |
| get_comments | Returns the comments string. |
| get_copyright | Returns the copyright string. |
| get_documenters | Returns the string which are displayed in the documenters tab of the secondary credits dialog. |
| get_license | Returns the license information |
| get_logo | Returns the pixbuf displayed as logo in the about dialog. |
| get_logo_icon_name | Returns the icon name displayed as logo in the about dialog. |
| get_name | Returns the program name displayed in the about dialog. |
| get_program_name | Returns the program name displayed in the about dialog. |
| get_translators_credits | Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog. |
| get_version | Returns the version string. |
| get_website | Returns the website URL. |
| get_website_label | Returns the label used for the website link. |
| get_wrap_license | Returns whether the license text in about is automatically wrapped. |
| set_artists | Sets the strings which are displayed in the artists tab of the secondary credits dialog. |
| set_authors | Sets the strings which are displayed in the authors tab of the secondary credits dialog. |
| set_comments | Sets the comments string to display in the about dialog. |
| set_copyright | Sets the copyright string to display in the about dialog. |
| set_documenters | Sets the strings which are displayed in the documenters tab of the secondary credits dialog. |
| set_email_hook | Installs a global function to be called whenever the user activates an email link in an about dialog. |
| set_license | Sets the license information to be displayed in the secondary license dialog. |
| set_logo | Sets the pixbuf to be displayed as logo in the about dialog. |
| set_logo_icon_name | Sets the pixbuf to be displayed as logo in the about dialog. |
| set_name | Sets the name to display in the about dialog. |
| set_program_name | Sets the name to display in the about dialog. |
| set_translator_credits | Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog. |
| set_url_hook | Installs a global function to be called whenever the user activates a URL link in an about dialog. |
| set_version | Sets the version string to display in the about dialog. |
| set_website | Sets the URL to use for the website link. |
| set_website_label | Sets the label to be used for the website link. It defaults to the website URL. |
| set_wrap_license | Sets whether the license text in about is automatically wrapped. |
Returns the string which are displayed in the artists tab of the secondary credits dialog.
GtkAboutDialog.get_artists()
| Return | string array containing the artists. |
Returns the string which are displayed in the authors tab of the secondary credits dialog.
GtkAboutDialog.get_authors()
| Return | A string array containing the authors. |
Returns the comments string.
GtkAboutDialog.get_comments()
| Return | The comments. |
Returns the copyright string.
GtkAboutDialog.get_copyright()
| Return | The copyright string. |
Returns the string which are displayed in the documenters tab of the secondary credits dialog.
GtkAboutDialog.get_documenters()
| Return | string array containing the documenters. |
Returns the license information
GtkAboutDialog.get_license()
| Return | The license information. |
Returns the pixbuf displayed as logo in the about dialog.
GtkAboutDialog.get_logo()
| Return | the pixbuf displayed as logo (or nil). |
Returns the icon name displayed as logo in the about dialog.
GtkAboutDialog.get_logo_icon_name()
| Return | the icon name displayed as logo. |
Returns the program name displayed in the about dialog.
GtkAboutDialog.get_name()
| Return | The program name. |
get_name has been deprecated since version 2.12 and should not be used in newly-written code. Use get_program_name() instead.
Returns the program name displayed in the about dialog.
GtkAboutDialog.get_program_name()
| Return | The program name. |
Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.
GtkAboutDialog.get_translators_credits()
| Return | The translator credits string. |
Returns the version string.
GtkAboutDialog.get_version()
| Return | The version string. |
Returns the website URL.
GtkAboutDialog.get_website()
| Return | The website URL. |
Returns the label used for the website link.
GtkAboutDialog.get_website_label()
| Return | The label used for the website link. |
Returns whether the license text in about is automatically wrapped.
GtkAboutDialog.get_wrap_license()
| Return | true if the license text is wrapped |
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
GtkAboutDialog.set_artists( artists )
| artists | array of strings |
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
GtkAboutDialog.set_authors( authors )
| authors | array of strings |
Sets the comments string to display in the about dialog.
GtkAboutDialog.set_comments( comments )
| comments | a comments string (or nil). |
This should be a short string of one or two lines.
Sets the copyright string to display in the about dialog.
GtkAboutDialog.set_copyright( copyright )
| copyright | the copyright string (or nil). |
This should be a short string of one or two lines.
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
GtkAboutDialog.set_documenters( documenters )
| documenters | array of strings. |
Installs a global function to be called whenever the user activates an email link in an about dialog.
GtkAboutDialog.set_email_hook( func, data )
| func | a function to call when an email link is activated, or nil. |
| data | data to pass to func, or nil. |
The function will get the dialog object as first parameter, the activated link as second parameter (string), and user data as third parameter.
Since 2.18 there exists a default function which uses gtk_show_uri(). To deactivate it, you can pass NULL for func.
Sets the license information to be displayed in the secondary license dialog.
GtkAboutDialog.set_license( license )
| license | the license information or nil. |
If license is nil, the license button is hidden.
Sets the pixbuf to be displayed as logo in the about dialog.
GtkAboutDialog.set_logo( logo )
| logo | a GdkPixbuf, or nil. |
If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.
Sets the pixbuf to be displayed as logo in the about dialog.
GtkAboutDialog.set_logo_icon_name( icon_name )
| icon_name | an icon name, or nil. |
If it is nil, the default window icon set with gtk_window_set_default_icon() will be used.
Sets the name to display in the about dialog.
GtkAboutDialog.set_name( name )
| name | the program name (or nil). |
If this is not set, it defaults to g_get_application_name().
set_name has been deprecated since version 2.12 and should not be used in newly-written code. Use set_program_name() instead.
Sets the name to display in the about dialog.
GtkAboutDialog.set_program_name( name )
| name | the program name |
If this is not set, it defaults to g_get_application_name().
Sets the translator credits string which is displayed in the translators tab of the secondary credits dialog.
GtkAboutDialog.set_translator_credits( translator_credits )
| translator_credits | the translator credits (or nil). |
Installs a global function to be called whenever the user activates a URL link in an about dialog.
GtkAboutDialog.set_url_hook( func, data )
| func | a function to call when a URL link is activated, or nil. |
| data | data to pass to func, or nil. |
The function will get the dialog object as first parameter, the activated link as second parameter (string), and user data as third parameter.
Since 2.18 there exists a default function which uses gtk_show_uri(). To deactivate it, you can pass NULL for func.
Sets the version string to display in the about dialog.
GtkAboutDialog.set_version( the )
| the | version string (or nil). |
Sets the URL to use for the website link.
GtkAboutDialog.set_website( a )
| a | URL string starting with "http:" (or nil). |
Note that that the hook functions need to be set up before calling this function.
Sets the label to be used for the website link. It defaults to the website URL.
GtkAboutDialog.set_website_label( website_label )
| website_label | the label used for the website link |
Sets whether the license text in about is automatically wrapped.
GtkAboutDialog.set_wrap_license( wrap_license )
| wrap_license | wether to wrap the license |