struct GtkAboutDialog

struct GtkAboutDialog;

The GtkAboutDialog struct contains only private fields and should not be directly accessed.

enum GtkLicense

typedef enum {
  GTK_LICENSE_UNKNOWN,
  GTK_LICENSE_CUSTOM,

  GTK_LICENSE_GPL_2_0,
  GTK_LICENSE_GPL_3_0,

  GTK_LICENSE_LGPL_2_1,
  GTK_LICENSE_LGPL_3_0,

  GTK_LICENSE_BSD,
  GTK_LICENSE_MIT_X11,

  GTK_LICENSE_ARTISTIC
} GtkLicense;

The type of license for an application.

This enumeration can be expanded at later date.

Since 3.0

gtk_about_dialog_new ()

GtkWidget *         gtk_about_dialog_new                (void);

Creates a new GtkAboutDialog.

Since 2.6

gtk_about_dialog_get_program_name ()

const gchar *       gtk_about_dialog_get_program_name   (GtkAboutDialog *about);

Returns the program name displayed in the about dialog.

Since 2.12

gtk_about_dialog_set_program_name ()

void                gtk_about_dialog_set_program_name   (GtkAboutDialog *about,
                                                         const gchar *name);

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

Since 2.12

gtk_about_dialog_get_version ()

const gchar *       gtk_about_dialog_get_version        (GtkAboutDialog *about);

Returns the version string.

Since 2.6

gtk_about_dialog_set_version ()

void                gtk_about_dialog_set_version        (GtkAboutDialog *about,
                                                         const gchar *version);

Sets the version string to display in the about dialog.

Since 2.6

gtk_about_dialog_get_copyright ()

const gchar *       gtk_about_dialog_get_copyright      (GtkAboutDialog *about);

Returns the copyright string.

Since 2.6

gtk_about_dialog_set_copyright ()

void                gtk_about_dialog_set_copyright      (GtkAboutDialog *about,
                                                         const gchar *copyright);

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

Since 2.6

gtk_about_dialog_get_comments ()

const gchar *       gtk_about_dialog_get_comments       (GtkAboutDialog *about);

Returns the comments string.

Since 2.6

gtk_about_dialog_set_comments ()

void                gtk_about_dialog_set_comments       (GtkAboutDialog *about,
                                                         const gchar *comments);

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

Since 2.6

gtk_about_dialog_get_license ()

const gchar *       gtk_about_dialog_get_license        (GtkAboutDialog *about);

Returns the license information.

Since 2.6

gtk_about_dialog_set_license ()

void                gtk_about_dialog_set_license        (GtkAboutDialog *about,
                                                         const gchar *license);

Sets the license information to be displayed in the secondary license dialog. If license is NULL, the license button is hidden.

Since 2.6

gtk_about_dialog_get_wrap_license ()

gboolean            gtk_about_dialog_get_wrap_license   (GtkAboutDialog *about);

Returns whether the license text in about is automatically wrapped.

Since 2.8

gtk_about_dialog_set_wrap_license ()

void                gtk_about_dialog_set_wrap_license   (GtkAboutDialog *about,
                                                         gboolean wrap_license);

Sets whether the license text in about is automatically wrapped.

Since 2.8

gtk_about_dialog_get_license_type ()

GtkLicense          gtk_about_dialog_get_license_type   (GtkAboutDialog *about);

Retrieves the license set using gtk_about_dialog_set_license_type()

Since 3.0

gtk_about_dialog_set_license_type ()

void                gtk_about_dialog_set_license_type   (GtkAboutDialog *about,
                                                         GtkLicense license_type);

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().

Since 3.0

gtk_about_dialog_get_website ()

const gchar *       gtk_about_dialog_get_website        (GtkAboutDialog *about);

Returns the website URL.

Since 2.6

gtk_about_dialog_set_website ()

void                gtk_about_dialog_set_website        (GtkAboutDialog *about,
                                                         const gchar *website);

Sets the URL to use for the website link.

Since 2.6

gtk_about_dialog_get_website_label ()

const gchar *       gtk_about_dialog_get_website_label  (GtkAboutDialog *about);

Returns the label used for the website link.

Since 2.6

gtk_about_dialog_set_website_label ()

void                gtk_about_dialog_set_website_label  (GtkAboutDialog *about,
                                                         const gchar *website_label);

Sets the label to be used for the website link.

Since 2.6

gtk_about_dialog_get_authors ()

const gchar * const * gtk_about_dialog_get_authors      (GtkAboutDialog *about);

Returns the string which are displayed in the authors tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_set_authors ()

void                gtk_about_dialog_set_authors        (GtkAboutDialog *about,
                                                         const gchar **authors);

Sets the strings which are displayed in the authors tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_get_artists ()

const gchar * const * gtk_about_dialog_get_artists      (GtkAboutDialog *about);

Returns the string which are displayed in the artists tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_set_artists ()

void                gtk_about_dialog_set_artists        (GtkAboutDialog *about,
                                                         const gchar **artists);

Sets the strings which are displayed in the artists tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_get_documenters ()

const gchar * const * gtk_about_dialog_get_documenters  (GtkAboutDialog *about);

Returns the string which are displayed in the documenters tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_set_documenters ()

void                gtk_about_dialog_set_documenters    (GtkAboutDialog *about,
                                                         const gchar **documenters);

Sets the strings which are displayed in the documenters tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_get_translator_credits ()

const gchar *       gtk_about_dialog_get_translator_credits
                                                        (GtkAboutDialog *about);

Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.

Since 2.6

gtk_about_dialog_set_translator_credits ()

void                gtk_about_dialog_set_translator_credits
                                                        (GtkAboutDialog *about,
                                                         const gchar *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:

1

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.

Since 2.6

gtk_about_dialog_get_logo ()

GdkPixbuf *         gtk_about_dialog_get_logo           (GtkAboutDialog *about);

Returns the pixbuf displayed as logo in the about dialog.

Since 2.6

gtk_about_dialog_set_logo ()

void                gtk_about_dialog_set_logo           (GtkAboutDialog *about,
                                                         GdkPixbuf *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.

Since 2.6

gtk_about_dialog_get_logo_icon_name ()

const gchar *       gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about);

Returns the icon name displayed as logo in the about dialog.

Since 2.6

gtk_about_dialog_set_logo_icon_name ()

void                gtk_about_dialog_set_logo_icon_name (GtkAboutDialog *about,
                                                         const gchar *icon_name);

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.

Since 2.6

gtk_show_about_dialog ()

void                gtk_show_about_dialog               (GtkWindow *parent,
                                                         const gchar *first_property_name,
                                                         ...);

This is a convenience function for showing an application's about box. The constructed dialog is associated with the parent window and reused for future invocations of this function.

Since 2.6

The "artists" property

  "artists"                  GStrv                 : Read / Write

The people who contributed artwork to the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Since 2.6

The "authors" property

  "authors"                  GStrv                 : Read / Write

The authors of the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Since 2.6

The "comments" property

  "comments"                 gchar*                : Read / Write

Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.

Default value: NULL

Since 2.6

The "copyright" property

  "copyright"                gchar*                : Read / Write

Copyright information for the program.

Default value: NULL

Since 2.6

The "documenters" property

  "documenters"              GStrv                 : Read / Write

The people documenting the program, as a NULL-terminated array of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Since 2.6

The "license" property

  "license"                  gchar*                : Read / Write

The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the "wrap-license" property is set to TRUE; otherwise the text itself must contain the intended linebreaks. When setting this property to a non-NULL value, the "license-type" property is set to GTK_LICENSE_CUSTOM as a side effect.

Default value: NULL

Since 2.6

The "license-type" property

  "license-type"             GtkLicense            : Read / Write

The license of the program, as a value of the GtkLicense enumeration.

The GtkAboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.

If GTK_LICENSE_UNKNOWN is used, the link used will be the same specified in the "website" property.

If GTK_LICENSE_CUSTOM is used, the current contents of the "license" property are used.

For any other GtkLicense value, the contents of the "license" property are also set by this property as a side effect.

Default value: GTK_LICENSE_UNKNOWN

Since 3.0

The "logo" property

  "logo"                     GdkPixbuf*            : Read / Write

A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list().

Since 2.6

The "logo-icon-name" property

  "logo-icon-name"           gchar*                : Read / Write

A named icon to use as the logo for the about box. This property overrides the "logo" property.

Default value: NULL

Since 2.6

The "program-name" property

  "program-name"             gchar*                : Read / Write

The name of the program. If this is not set, it defaults to g_get_application_name().

Default value: NULL

Since 2.12

The "translator-credits" property

  "translator-credits"       gchar*                : Read / Write

Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.

Default value: NULL

Since 2.6

The "version" property

  "version"                  gchar*                : Read / Write

The version of the program.

Default value: NULL

Since 2.6

The "website" property

  "website"                  gchar*                : Read / Write

The URL for the link to the website of the program. This should be a string starting with "http://.

Default value: NULL

Since 2.6

The "website-label" property

  "website-label"            gchar*                : Read / Write

The label for the link to the website of the program.

Default value: NULL

Since 2.6

The "wrap-license" property

  "wrap-license"             gboolean              : Read / Write

Whether to wrap the text in the license dialog.

Default value: FALSE

Since 2.8

The "activate-link" signal

gboolean            user_function                      (GtkAboutDialog *label,
                                                        gchar          *uri,
                                                        gpointer        user_data)      : Run Last

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().

Since 2.24