GtkAboutDialog
GtkAboutDialog — Отображение информации о приложении
Функции
Свойства
| GStrv | artists | Чтение / Запись |
| GStrv | authors | Чтение / Запись |
| char * | comments | Чтение / Запись |
| char * | copyright | Чтение / Запись |
| GStrv | documenters | Чтение / Запись |
| char * | license | Чтение / Запись |
| GtkLicense | license-type | Чтение / Запись |
| GdkPixbuf * | logo | Чтение / Запись |
| char * | logo-icon-name | Чтение / Запись |
| char * | имя_программы | Чтение / Запись |
| char * | благодарности_переводчикам | Чтение / Запись |
| char * | версия | Чтение / Запись |
| char * | веб-сайт | Чтение / Запись |
| char * | метка_веб-сайта | Чтение / Запись |
| gboolean | обернуть_лицензию | Чтение / Запись |
Сигналы
| gboolean | activate-link | Выполнить последним |
Типы и значения
| struct | GtkAboutDialog |
| enum | GtkLicense |
Иерархия объектов
GObject
╰── GInitiallyUnowned
╰── GtkWidget
╰── GtkContainer
╰── GtkBin
╰── GtkWindow
╰── GtkDialog
╰── GtkAboutDialog
Реализованные интерфейсы
GtkAboutDialog реализует AtkImplementorIface и GtkBuildable.
Файлы заголовков
#include <gtk/gtk.h>
Описание
GtkAboutDialog предоставляет простой способ отображения информации о программе, такой как её логотип, имя, авторские права, веб-сайт и лицензия. Также возможно указать заслуги авторов, составителей документации, переводчиков и художников, работавших над программой. Окно "О программе" обычно открывается, когда пользователь выбирает соответствующий пункт в меню. Все части диалога необязательны.
Окна "О программе" часто содержат ссылки и адреса электронной почты. GtkAboutDialog отображает их как нажимаемые ссылки. По умолчанию он вызывает gtk_show_uri_on_window() при нажатии пользователем на ссылку. Это поведение можно изменить с помощью сигнала “activate-link”.
Для указания человека с адресом электронной почты используйте строку вида "Edgar Allan Poe <edgar@poe.com>". Для указания веб-сайта с заголовком используйте строку вида "GTK+ team http://www.gtk.org".
Для удобства создания GtkAboutDialog можно использовать функцию gtk_show_about_dialog(), которая создаёт и отображает диалоговое окно и сохраняет его для повторного отображения.
Обратите внимание, что GTK+ устанавливает по умолчанию заголовок _("About %s") для окна диалога (где %s заменяется именем приложения, но для обеспечения правильного перевода заголовка приложения должны явно устанавливать свойство title при создании GtkAboutDialog, как показано в следующем примере):
Также можно отобразить GtkAboutDialog как любое другое GtkDialog, например, используя gtk_dialog_run(). В этом случае вам может понадобиться знать, что кнопка «Закрыть» возвращает идентификатор ответа GTK_RESPONSE_CANCEL.
Функции
gtk_about_dialog_new ()
GtkWidget *
gtk_about_dialog_new (void); Создает новый GtkAboutDialog.
Returns
вновь созданный GtkAboutDialog
Since: 2.6
gtk_about_dialog_get_program_name ()
const gchar *
gtk_about_dialog_get_program_name (GtkAboutDialog *about); Возвращает имя программы, отображаемое в диалоговом окне "О программе".
Parameters
about |
Returns
Имя программы. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
Since: 2.12
gtk_about_dialog_set_program_name ()
void gtk_about_dialog_set_program_name (GtkAboutDialog *about,const gchar *name);
Устанавливает имя для отображения в диалоговом окне "О программе". Если это не установлено, по умолчанию используется g_get_application_name().
Parameters
about | ||
name | имя программы |
Since: 2.12
gtk_about_dialog_get_version ()
const gchar *
gtk_about_dialog_get_version (GtkAboutDialog *about); Возвращает строку версии.
Parameters
about |
Returns
Строка версии. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
Since: 2.6
gtk_about_dialog_set_version ()
void gtk_about_dialog_set_version (GtkAboutDialog *about,const gchar *version);
Устанавливает строку версии для отображения в диалоговом окне "О программе".
Parameters
about | ||
version | строка версии. | [allow-none] |
Since: 2.6
gtk_about_dialog_get_copyright ()
const gchar *
gtk_about_dialog_get_copyright (GtkAboutDialog *about); Возвращает строку авторских прав.
Parameters
about |
Returns
Строка авторских прав. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
Since: 2.6
gtk_about_dialog_set_copyright ()
void gtk_about_dialog_set_copyright (GtkAboutDialog *about,const gchar *copyright);
Устанавливает строку авторских прав для отображения в диалоговом окне "О программе". Это должна быть короткая строка из одной или двух строк.
Parameters
about | ||
copyright | строка авторских прав. | [allow-none] |
Since: 2.6
gtk_about_dialog_get_comments ()
const gchar *
gtk_about_dialog_get_comments (GtkAboutDialog *about); Возвращает строку комментариев.
Parameters
about |
Returns
Комментарии. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
Since: 2.6
gtk_about_dialog_set_comments ()
void gtk_about_dialog_set_comments (GtkAboutDialog *about,const gchar *comments);
Устанавливает строку комментариев для отображения в диалоговом окне "О программе". Это должна быть короткая строка из одной или двух строк.
Parameters
about | ||
comments | строка комментариев. | [allow-none] |
Since: 2.6
gtk_about_dialog_get_license ()
const gchar *
gtk_about_dialog_get_license (GtkAboutDialog *about); Возвращает информацию о лицензии.
Parameters
about |
Returns
Информация о лицензии. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
Since: 2.6
gtk_about_dialog_set_license ()
void gtk_about_dialog_set_license (GtkAboutDialog *about,const gchar *license);
Устанавливает информацию о лицензии для отображения во вторичном диалоговом окне лицензии. Если license является NULL, кнопка лицензии скрыта.
Parameters
about | ||
license | информация о лицензии или | [allow-none] |
Since: 2.6
gtk_about_dialog_get_wrap_license ()
gboolean
gtk_about_dialog_get_wrap_license (GtkAboutDialog *about); Возвращает, автоматически ли переносится текст лицензии в about.
Parameters
about |
Returns
TRUE если текст лицензии переносится
Since: 2.8
gtk_about_dialog_set_wrap_license ()
void gtk_about_dialog_set_wrap_license (GtkAboutDialog *about,gboolean wrap_license);
Устанавливает, автоматически ли переносится текст лицензии в about.
Parameters
about | ||
wrap_license | переносить ли лицензию |
Since: 2.8
gtk_about_dialog_get_license_type ()
GtkLicense
gtk_about_dialog_get_license_type (GtkAboutDialog *about); Извлекает лицензию, установленную с помощью gtk_about_dialog_set_license_type()
Parameters
about |
Returns
значение GtkLicense
Since: 3.0
gtk_about_dialog_set_license_type ()
void gtk_about_dialog_set_license_type (GtkAboutDialog *about,GtkLicense license_type);
Устанавливает лицензию приложения, показывающего диалоговое окно about из списка известных лицензий.
Эта функция переопределяет лицензию, установленную с помощью gtk_about_dialog_set_license().
Параметры
about | ||
license_type | тип лицензии |
С версии: 3.0
gtk_about_dialog_get_website ()
const gchar *
gtk_about_dialog_get_website (GtkAboutDialog *about); Возвращает URL веб-сайта.
Параметры
about |
Возвращает
URL веб-сайта. Строка принадлежит диалоговому окну about и не должна изменяться.
С версии: 2.6
gtk_about_dialog_set_website ()
void gtk_about_dialog_set_website (GtkAboutDialog *about,const gchar *website);
Устанавливает URL для ссылки на веб-сайт.
Параметры
about | ||
website | строка URL, начинающаяся с "http://". | [allow-none] |
С версии: 2.6
gtk_about_dialog_get_website_label ()
const gchar *
gtk_about_dialog_get_website_label (GtkAboutDialog *about); Возвращает метку, используемую для ссылки на веб-сайт.
Параметры
about |
Возвращает
Метка, используемая для ссылки на веб-сайт. Строка принадлежит диалоговому окну about и не должна изменяться.
С версии: 2.6
gtk_about_dialog_set_website_label ()
void gtk_about_dialog_set_website_label (GtkAboutDialog *about,const gchar *website_label);
Устанавливает метку, которая будет использоваться для ссылки на веб-сайт.
Параметры
about | ||
website_label | метка, используемая для ссылки на веб-сайт |
С версии: 2.6
gtk_about_dialog_get_authors ()
const gchar * const *
gtk_about_dialog_get_authors (GtkAboutDialog *about); Возвращает строку, которая отображается во вкладке авторов диалогового окна дополнительных данных.
Параметры
about |
Возвращает
Массив строк, завершенный NULL, содержащий авторов. Массив принадлежит диалоговому окну about и не должен изменяться.
[array zero-terminated=1][transfer none]
С версии: 2.6
gtk_about_dialog_set_authors ()
void gtk_about_dialog_set_authors (GtkAboutDialog *about,const gchar **authors);
Устанавливает строки, которые отображаются во вкладке авторов диалогового окна дополнительных данных.
Параметры
about | ||
authors | массив строк, завершенный | [array zero-terminated=1] |
С версии: 2.6
gtk_about_dialog_get_artists ()
const gchar * const *
gtk_about_dialog_get_artists (GtkAboutDialog *about); Возвращает строку, которая отображается во вкладке художников диалогового окна дополнительных данных.
Параметры
about |
Возвращает
Массив строк, завершенный NULL, содержащий художников. Массив принадлежит диалоговому окну about и не должен изменяться.
[array zero-terminated=1][transfer none]
С версии: 2.6
gtk_about_dialog_set_artists ()
void gtk_about_dialog_set_artists (GtkAboutDialog *about,const gchar **artists);
Устанавливает строки, которые отображаются во вкладке художников диалогового окна дополнительных данных.
Параметры
about | ||
artists | массив строк, завершенный | [array zero-terminated=1] |
С версии: 2.6
gtk_about_dialog_get_documenters ()
const gchar * const *
gtk_about_dialog_get_documenters (GtkAboutDialog *about); Возвращает строку, которая отображается во вкладке составителей документации диалогового окна дополнительных данных.
Параметры
about |
Возвращает
Массив строк, завершенный NULL, содержащий составителей документации. Массив принадлежит диалоговому окну about и не должен изменяться.
[array zero-terminated=1][transfer none]
С версии: 2.6
gtk_about_dialog_set_documenters ()
void gtk_about_dialog_set_documenters (GtkAboutDialog *about,const gchar **documenters);
Устанавливает строки, которые отображаются во вкладке составителей документации диалогового окна дополнительных данных.
Параметры
about | ||
documenters | массив строк, завершенный | [array zero-terminated=1] |
С версии: 2.6
gtk_about_dialog_get_translator_credits ()
const gchar *
gtk_about_dialog_get_translator_credits
(GtkAboutDialog *about); Возвращает строку с данными о переводчиках, которая отображается во вкладке переводчиков диалогового окна дополнительных данных.
Параметры
about |
Возвращает
Строка с данными о переводчиках. Строка принадлежит диалоговому окну about и не должна изменяться.
С версии: 2.6
gtk_about_dialog_set_translator_credits ()
void gtk_about_dialog_set_translator_credits (GtkAboutDialog *about,const gchar *translator_credits);
Устанавливает строку с данными о переводчике, которая отображается во вкладке переводчиков диалога дополнительных сведений.
Целевое использование этой строки — отображение переводчика языка, который в данный момент используется в пользовательском интерфейсе. Используя gettext(), простой способ достижения этой цели — пометить строку для перевода:
GdkPixbuf *example_logo = gdk_pixbuf_new_from_file ("./logo.png", NULL);
gtk_show_about_dialog (NULL,
"program-name", "ExampleCode",
"logo", example_logo,
"title", _("About ExampleCode"),
NULL);Рекомендуется использовать стандартный msgid «translator-credits», поскольку переводчики уже знают назначение этого msgid, и поскольку GtkAboutDialog обнаружит, если «translator-credits» не переведено, и скроет вкладку.
Параметры
about | ||
translator_credits | данные о переводчике. | [allow-none] |
С: 2.6
gtk_about_dialog_get_logo ()
GdkPixbuf *
gtk_about_dialog_get_logo (GtkAboutDialog *about); Возвращает pixbuf, отображаемый в качестве логотипа в диалоге о программе.
Параметры
about |
Возвращаемое значение
pixbuf, отображаемый в качестве логотипа. Pixbuf принадлежит диалогу о программе. Если вам нужно сохранить ссылку на него, необходимо вызвать g_object_ref().
[transfer none]
С: 2.6
gtk_about_dialog_set_logo ()
void gtk_about_dialog_set_logo (GtkAboutDialog *about,GdkPixbuf *logo);
Устанавливает pixbuf, который будет отображаться в качестве логотипа в диалоге о программе. Если он NULL, будет использоваться значок окна по умолчанию, установленный с помощью gtk_window_set_default_icon().
Параметры
about | ||
logo | a GdkPixbuf, или | [allow-none] |
С: 2.6
gtk_about_dialog_get_logo_icon_name ()
const gchar *
gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about); Возвращает имя значка, отображаемого в качестве логотипа в диалоге о программе.
Параметры
about |
Возвращаемое значение
имя значка, отображаемого в качестве логотипа. Строка принадлежит диалогу. Если вам нужно сохранить ссылку на неё, необходимо вызвать g_strdup().
С: 2.6
gtk_about_dialog_set_logo_icon_name ()
void gtk_about_dialog_set_logo_icon_name (GtkAboutDialog *about,const gchar *icon_name);
Устанавливает имя значка, который будет отображаться в качестве логотипа в диалоге о программе. Если оно NULL, будет использоваться значок окна по умолчанию, установленный с помощью gtk_window_set_default_icon().
Параметры
about | ||
icon_name | имя значка, или | [allow-none] |
С: 2.6
gtk_about_dialog_add_credit_section ()
void gtk_about_dialog_add_credit_section (GtkAboutDialog *about,const gchar *section_name,const gchar **people);
Создаёт новый раздел в странице «Сведения».
Параметры
about | ||
section_name | Имя раздела | |
people | Люди, которые принадлежат к этому разделу. | [array нуль-терминированный=1] |
С: 3.4
gtk_show_about_dialog ()
void gtk_show_about_dialog (GtkWindow *parent,const gchar *first_property_name,...);
Это вспомогательная функция для отображения диалога «О программе» приложения. Построенный диалог ассоциируется с родительским окном и используется повторно для последующих вызовов этой функции.
Параметры
parent | родительское окно, или | [allow-none] |
first_property_name | имя первой свойства | |
... | значение первой свойства, далее ещё свойства, |
С: 2.6
Типы и значения
struct GtkAboutDialog
struct GtkAboutDialog;
Структура GtkAboutDialog содержит только приватные поля и не должна использоваться напрямую.
перечисление GtkLicense
Тип лицензии приложения.
Это перечисление может быть расширено в будущем.
Элементы
GTK_LICENSE_UNKNOWN | Лицензия не указана | |
GTK_LICENSE_CUSTOM | Текст лицензии будет указан разработчиком. | |
GTK_LICENSE_GPL_2_0 | GNU Общая публичная лицензия, версия 2.0 или более поздняя | |
GTK_LICENSE_GPL_3_0 | GNU Общая публичная лицензия, версия 3.0 или более поздняя | |
GTK_LICENSE_LGPL_2_1 | GNU Небольшая общая публичная лицензия, версия 2.1 или более поздняя | |
GTK_LICENSE_LGPL_3_0 | GNU Небольшая общая публичная лицензия, версия 3.0 или более поздняя | |
GTK_LICENSE_BSD | Стандартная лицензия BSD | |
GTK_LICENSE_MIT_X11 | Стандартная лицензия MIT/X11 | |
GTK_LICENSE_ARTISTIC | Художественная лицензия, версия 2.0 | |
GTK_LICENSE_GPL_2_0_ONLY | GNU Общая публичная лицензия, версия 2.0 только. С версии 3.12. | |
GTK_LICENSE_GPL_3_0_ONLY | GNU Общая публичная лицензия, версия 3.0 только. С версии 3.12. | |
GTK_LICENSE_LGPL_2_1_ONLY | GNU Небольшая общая публичная лицензия, версия 2.1 только. С версии 3.12. | |
GTK_LICENSE_LGPL_3_0_ONLY | GNU Небольшая общая публичная лицензия, версия 3.0 только. С версии 3.12. | |
GTK_LICENSE_AGPL_3_0 | GNU Affero Общая публичная лицензия, версия 3.0 или более поздняя. С версии 3.22. | |
GTK_LICENSE_AGPL_3_0_ONLY | GNU Affero Общая публичная лицензия, версия 3.0 только. С версии 3.22.27. | |
GTK_LICENSE_BSD_3 | Лицензия BSD с тремя пунктами. С версии 3.24.20. | |
GTK_LICENSE_APACHE_2_0 | Лицензия Apache, версия 2.0. С версии 3.24.20. | |
GTK_LICENSE_MPL_2_0 | Mozilla Public License, версия 2.0. С версии 3.24.20. |
С версии: 3.0
Подробное описание свойств
Свойство “artists”
“artists” GStrv
Люди, внесшие вклад в иллюстрации программы, в виде массива строк, завершённого символом NULL. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки; для подробностей см. введение.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
С версии: 2.6
Свойство “authors”
“authors” GStrv
Авторы программы, в виде массива строк, завершённого символом NULL. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки; для подробностей см. введение.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
С версии: 2.6
Свойство “comments”
“comments” char *
Комментарии о программе. Эта строка отображается в метке основного диалогового окна, поэтому она должна представлять собой краткое описание основного назначения программы, а не подробный список функций.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “copyright”
“copyright” char *
Информация об авторских правах программы.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “documenters”
“documenters” GStrv
Люди, которые документировали программу, в виде массива строк, завершённого символом NULL. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки; для подробностей см. введение.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
С версии: 2.6
Свойство “license”
“license” char *
Лицензия программы. Эта строка отображается в текстовом представлении во вторичном диалоговом окне, поэтому можно использовать длинный многострочный текст. Обратите внимание, что текст форматируется в текстовом представлении только если свойство «wrap-license» установлено в TRUE; в противном случае текст должен сам содержать необходимые переводы строк. При установке этого свойства на значение, отличное от NULL, свойство “license-type” устанавливается в GTK_LICENSE_CUSTOM в качестве побочного эффекта.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “license-type”
“license-type” GtkLicense
Лицензия программы, как значение перечисления GtkLicense.
Библиотека GtkAboutDialog автоматически заполнит стандартное уведомление и предоставит пользователю ссылку на соответствующий онлайн-ресурс для текста лицензии.
Если используется GTK_LICENSE_UNKNOWN, ссылка будет той же, что указана в свойстве “website”.
Если используется GTK_LICENSE_CUSTOM, используются текущие содержимое свойства “license”.
Для любого другого значения GtkLicense, содержимое свойства “license” также устанавливается этим свойством как побочный эффект.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: GTK_LICENSE_UNKNOWN
С версии: 3.0
Свойство “logo”
“logo” GdkPixbuf *
Логотип для диалогового окна «О программе». Если он NULL, будет использоваться стандартный значок окна, установленный с помощью gtk_window_set_default_icon().
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
С версии: 2.6
Свойство “logo-icon-name”
“logo-icon-name” char *
Имя значка, используемого в качестве логотипа для диалогового окна «О программе». Это свойство переопределяет свойство “logo”.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: "image-missing"
С версии: 2.6
Свойство “program-name”
“program-name” char *
Название программы. Если не задано, используется значение по умолчанию g_get_application_name().
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.12
Свойство “translator-credits”
“translator-credits” char *
Благодарности переводчикам. Эта строка должна быть отмечена как переводимая. Строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки; для подробностей см. введение.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “version”
“version” char *
Версия программы.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “website”
“website” char *
URL для ссылки на веб-сайт программы. Должно быть строкой, начинающейся с «http://».
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “website-label”
“website-label” char *
Метка для ссылки на веб-сайт программы.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “wrap-license”
“wrap-license” gboolean
Указывает, нужно ли переносить текст в диалоговом окне лицензии.
Владелец: GtkAboutDialog
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
С версии: 2.8
Подробное описание сигналов
Сигнал “activate-link”
gboolean user_function (GtkAboutDialog *label, char *uri, gpointer user_data)
Сигнал, который генерируется для активации URI. Приложения могут подключиться к нему, чтобы переопределить стандартное поведение, которое заключается в вызове gtk_show_uri_on_window().
Параметры
label | Объект, на котором был сгенерирован сигнал | |
uri | активируемый URI | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Возвращаемое значение
TRUE если ссылка активирована
Флаги: Последнее выполнение
С версии: 2.24
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkAboutDialog.html