| Top | |
|
|
|
| GStrv | artists | Read / Write |
| GStrv | authors | Read / Write |
| char * | comments | Read / Write |
| char * | copyright | Read / Write |
| GStrv | documenters | Read / Write |
| char * | license | Read / Write |
| CtkLicense | license-type | Read / Write |
| GdkPixbuf * | logo | Read / Write |
| char * | logo-icon-name | Read / Write |
| char * | program-name | Read / Write |
| char * | translator-credits | Read / Write |
| char * | version | Read / Write |
| char * | website | Read / Write |
| char * | website-label | Read / Write |
| gboolean | wrap-license | Read / Write |
GObject
╰── GInitiallyUnowned
╰── CtkWidget
╰── CtkContainer
╰── CtkBin
╰── CtkWindow
╰── CtkDialog
╰── CtkAboutDialog
The CtkAboutDialog 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. CtkAboutDialog
displays these as clickable links. By default, it calls ctk_show_uri_on_window()
when a user clicks one. The behaviour can be overridden with the
“activate-link” signal.
To specify a person with an email address, use a string like "Edgar Allan Poe <edgar@poe.com>". To specify a website with a title, use a string like "CTK+ team http://github.com/cafe-desktop/ctk".
To make constructing a CtkAboutDialog as convenient as possible, you can
use the function ctk_show_about_dialog() which constructs and shows a dialog
and keeps it around so that it can be shown again.
Note that CTK+ 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 CtkAboutDialog,
as shown in the following example:
1 2 3 4 5 6 |
GdkPixbuf *example_logo = gdk_pixbuf_new_from_file ("./logo.png", NULL); ctk_show_about_dialog (NULL, "program-name", "ExampleCode", "logo", example_logo, "title", _("About ExampleCode"), NULL); |
It is also possible to show a CtkAboutDialog like any other CtkDialog,
e.g. using ctk_dialog_run(). In this case, you might need to know that
the “Close” button returns the CTK_RESPONSE_CANCEL response id.
CtkWidget *
ctk_about_dialog_new (void);
Creates a new CtkAboutDialog.
Since: 2.6
const gchar *
ctk_about_dialog_get_program_name (CtkAboutDialog *about);
Returns the program name displayed in the about dialog.
Since: 2.12
void ctk_about_dialog_set_program_name (CtkAboutDialog *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
const gchar *
ctk_about_dialog_get_version (CtkAboutDialog *about);
Returns the version string.
Since: 2.6
void ctk_about_dialog_set_version (CtkAboutDialog *about,const gchar *version);
Sets the version string to display in the about dialog.
Since: 2.6
const gchar *
ctk_about_dialog_get_copyright (CtkAboutDialog *about);
Returns the copyright string.
Since: 2.6
void ctk_about_dialog_set_copyright (CtkAboutDialog *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
const gchar *
ctk_about_dialog_get_comments (CtkAboutDialog *about);
Returns the comments string.
Since: 2.6
void ctk_about_dialog_set_comments (CtkAboutDialog *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
const gchar *
ctk_about_dialog_get_license (CtkAboutDialog *about);
Returns the license information.
Since: 2.6
void ctk_about_dialog_set_license (CtkAboutDialog *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
gboolean
ctk_about_dialog_get_wrap_license (CtkAboutDialog *about);
Returns whether the license text in about
is
automatically wrapped.
Since: 2.8
void ctk_about_dialog_set_wrap_license (CtkAboutDialog *about,gboolean wrap_license);
Sets whether the license text in about
is
automatically wrapped.
Since: 2.8
CtkLicense
ctk_about_dialog_get_license_type (CtkAboutDialog *about);
Retrieves the license set using ctk_about_dialog_set_license_type()
Since: 3.0
void ctk_about_dialog_set_license_type (CtkAboutDialog *about,CtkLicense 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
ctk_about_dialog_set_license().
Since: 3.0
const gchar *
ctk_about_dialog_get_website (CtkAboutDialog *about);
Returns the website URL.
Since: 2.6
void ctk_about_dialog_set_website (CtkAboutDialog *about,const gchar *website);
Sets the URL to use for the website link.
Since: 2.6
const gchar *
ctk_about_dialog_get_website_label (CtkAboutDialog *about);
Returns the label used for the website link.
The label used for the website link. The string is owned by the about dialog and must not be modified.
Since: 2.6
void ctk_about_dialog_set_website_label (CtkAboutDialog *about,const gchar *website_label);
Sets the label to be used for the website link.
Since: 2.6
const gchar * const *
ctk_about_dialog_get_authors (CtkAboutDialog *about);
Returns the string which are displayed in the authors tab of the secondary credits dialog.
A
NULL-terminated string array containing the authors. The array is
owned by the about dialog and must not be modified.
[array zero-terminated=1][transfer none]
Since: 2.6
void ctk_about_dialog_set_authors (CtkAboutDialog *about,const gchar **authors);
Sets the strings which are displayed in the authors tab of the secondary credits dialog.
Since: 2.6
const gchar * const *
ctk_about_dialog_get_artists (CtkAboutDialog *about);
Returns the string which are displayed in the artists tab of the secondary credits dialog.
A
NULL-terminated string array containing the artists. The array is
owned by the about dialog and must not be modified.
[array zero-terminated=1][transfer none]
Since: 2.6
void ctk_about_dialog_set_artists (CtkAboutDialog *about,const gchar **artists);
Sets the strings which are displayed in the artists tab of the secondary credits dialog.
Since: 2.6
const gchar * const *
ctk_about_dialog_get_documenters (CtkAboutDialog *about);
Returns the string which are displayed in the documenters tab of the secondary credits dialog.
A
NULL-terminated string array containing the documenters. The
array is owned by the about dialog and must not be modified.
[array zero-terminated=1][transfer none]
Since: 2.6
void ctk_about_dialog_set_documenters (CtkAboutDialog *about,const gchar **documenters);
Sets the strings which are displayed in the documenters tab of the secondary credits dialog.
Since: 2.6
const gchar *
ctk_about_dialog_get_translator_credits
(CtkAboutDialog *about);
Returns the translator credits string which is displayed in the translators tab of the secondary credits dialog.
The translator credits string. The string is owned by the about dialog and must not be modified.
Since: 2.6
void ctk_about_dialog_set_translator_credits (CtkAboutDialog *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 2 3 |
CtkWidget *about = ctk_about_dialog_new (); ctk_about_dialog_set_translator_credits (CTK_ABOUT_DIALOG (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 CtkAboutDialog will detect if “translator-credits” is untranslated and hide the tab.
Since: 2.6
GdkPixbuf *
ctk_about_dialog_get_logo (CtkAboutDialog *about);
Returns the pixbuf displayed as logo in the about dialog.
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.
[transfer none]
Since: 2.6
void ctk_about_dialog_set_logo (CtkAboutDialog *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
ctk_window_set_default_icon() will be used.
Since: 2.6
const gchar *
ctk_about_dialog_get_logo_icon_name (CtkAboutDialog *about);
Returns the icon name displayed as logo in the about dialog.
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
void ctk_about_dialog_set_logo_icon_name (CtkAboutDialog *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
ctk_window_set_default_icon() will be used.
Since: 2.6
void ctk_about_dialog_add_credit_section (CtkAboutDialog *about,const gchar *section_name,const gchar **people);
Creates a new section in the Credits page.
about |
||
section_name |
The name of the section |
|
people |
The people who belong to that section. |
[array zero-terminated=1] |
Since: 3.4
void ctk_show_about_dialog (CtkWindow *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.
parent |
transient parent, or |
[allow-none] |
first_property_name |
the name of the first property |
|
... |
value of first property, followed by more properties, |
Since: 2.6
struct CtkAboutDialog;
The CtkAboutDialog contains only private fields and should not be directly accessed.
The type of license for an application.
This enumeration can be expanded at later date.
|
No license specified |
||
|
A license text is going to be specified by the developer |
||
|
The GNU General Public License, version 2.0 or later |
||
|
The GNU General Public License, version 3.0 or later |
||
|
The GNU Lesser General Public License, version 2.1 or later |
||
|
The GNU Lesser General Public License, version 3.0 or later |
||
|
The BSD standard license |
||
|
The MIT/X11 standard license |
||
|
The Artistic License, version 2.0 |
||
|
The GNU General Public License, version 2.0 only. Since 3.12. |
||
|
The GNU General Public License, version 3.0 only. Since 3.12. |
||
|
The GNU Lesser General Public License, version 2.1 only. Since 3.12. |
||
|
The GNU Lesser General Public License, version 3.0 only. Since 3.12. |
||
|
The GNU Affero General Public License, version 3.0 or later. Since: 3.22. |
||
|
The GNU Affero General Public License, version 3.0 only. Since: 3.22.27. |
||
|
The 3-clause BSD licence. Since: 3.24.20. |
||
|
The Apache License, version 2.0. Since: 3.24.20. |
||
|
The Mozilla Public License, version 2.0. Since: 3.24.20. |
Since: 3.0
“artists” property “artists” GStrv
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.
Owner: CtkAboutDialog
Flags: Read / Write
Since: 2.6
“authors” property “authors” GStrv
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.
Owner: CtkAboutDialog
Flags: Read / Write
Since: 2.6
“comments” property “comments” char *
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.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“copyright” property “copyright” char *
Copyright information for the program.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“documenters” property “documenters” GStrv
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.
Owner: CtkAboutDialog
Flags: Read / Write
Since: 2.6
“license” property “license” char *
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 CTK_LICENSE_CUSTOM
as a side effect.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“license-type” property“license-type” CtkLicense
The license of the program, as a value of the CtkLicense enumeration.
The CtkAboutDialog will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text.
If CTK_LICENSE_UNKNOWN is used, the link used will be the same
specified in the “website” property.
If CTK_LICENSE_CUSTOM is used, the current contents of the
“license” property are used.
For any other CtkLicense value, the contents of the “license” property are also set by this property as a side effect.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: CTK_LICENSE_UNKNOWN
Since: 3.0
“logo” property “logo” GdkPixbuf *
A logo for the about box. If it is NULL, the default window icon
set with ctk_window_set_default_icon() will be used.
Owner: CtkAboutDialog
Flags: Read / Write
Since: 2.6
“logo-icon-name” property “logo-icon-name” char *
A named icon to use as the logo for the about box. This property overrides the “logo” property.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: "image-missing"
Since: 2.6
“program-name” property “program-name” char *
The name of the program.
If this is not set, it defaults to g_get_application_name().
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.12
“translator-credits” property “translator-credits” char *
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.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“version” property “version” char *
The version of the program.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“website” property “website” char *
The URL for the link to the website of the program. This should be a string starting with "http://.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“website-label” property “website-label” char *
The label for the link to the website of the program.
Owner: CtkAboutDialog
Flags: Read / Write
Default value: NULL
Since: 2.6
“activate-link” signalgboolean user_function (CtkAboutDialog *label, char *uri, gpointer user_data)
The signal which gets emitted to activate a URI.
Applications may connect to it to override the default behaviour,
which is to call ctk_show_uri_on_window().
label |
The object on which the signal was emitted |
|
uri |
the URI that is activated |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 2.24