GtkAboutDialog
GtkAboutDialog — Отображение информации о приложении
Функции
| GtkWidget * | gtk_about_dialog_new () |
| const gchar * | gtk_about_dialog_get_program_name () |
| void | gtk_about_dialog_set_program_name () |
| const gchar * | gtk_about_dialog_get_version () |
| void | gtk_about_dialog_set_version () |
| const gchar * | gtk_about_dialog_get_copyright () |
| void | gtk_about_dialog_set_copyright () |
| const gchar * | gtk_about_dialog_get_comments () |
| void | gtk_about_dialog_set_comments () |
| const gchar * | gtk_about_dialog_get_license () |
| void | gtk_about_dialog_set_license () |
| gboolean | gtk_about_dialog_get_wrap_license () |
| void | gtk_about_dialog_set_wrap_license () |
| GtkLicense | gtk_about_dialog_get_license_type () |
| void | gtk_about_dialog_set_license_type () |
| const gchar * | gtk_about_dialog_get_website () |
| void | gtk_about_dialog_set_website () |
| const gchar * | gtk_about_dialog_get_website_label () |
| void | gtk_about_dialog_set_website_label () |
| const gchar * const * | gtk_about_dialog_get_authors () |
| void | gtk_about_dialog_set_authors () |
| const gchar * const * | gtk_about_dialog_get_artists () |
| void | gtk_about_dialog_set_artists () |
| const gchar * const * | gtk_about_dialog_get_documenters () |
| void | gtk_about_dialog_set_documenters () |
| const gchar * | gtk_about_dialog_get_translator_credits () |
| void | gtk_about_dialog_set_translator_credits () |
| GdkPixbuf * | gtk_about_dialog_get_logo () |
| void | gtk_about_dialog_set_logo () |
| const gchar * | gtk_about_dialog_get_logo_icon_name () |
| void | gtk_about_dialog_set_logo_icon_name () |
| void | gtk_about_dialog_add_credit_section () |
| void | gtk_show_about_dialog () |
Свойства
| GStrv | artists | Чтение / Запись |
| GStrv | authors | Чтение / Запись |
| gchar * | comments | Чтение / Запись |
| gchar * | copyright | Чтение / Запись |
| GStrv | documenters | Чтение / Запись |
| gchar * | license | Чтение / Запись |
| GtkLicense | license-type | Чтение / Запись |
| GdkPixbuf * | logo | Чтение / Запись |
| gchar * | logo-icon-name | Чтение / Запись |
| gchar * | program-name | Чтение / Запись |
| gchar * | translator-credits | Чтение / Запись |
| gchar * | version | Чтение / Запись |
| gchar * | website | Чтение / Запись |
| gchar * | website-label | Чтение / Запись |
| gboolean | wrap-license | Чтение / Запись |
Сигналы
Типы и значения
| struct | GtkAboutDialog |
| enum | GtkLicense |
Иерархия объектов
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── GtkDialog ╰── GtkAboutDialog
Реализованные интерфейсы
GtkAboutDialog реализует интерфейсы AtkImplementorIface и GtkBuildable.
Файлы заголовков
#include <gtk/gtk.h>
Описание
GtkAboutDialog предоставляет простой способ отображения информации о программе, такой как её логотип, имя, авторские права, веб-сайт и лицензия. Также можно указать вклад авторов, документирующих, переводчиков и художников, работавших над программой. Диалоговое окно «О программе» обычно открывается, когда пользователь выбирает опцию About в меню Help. Все части диалогового окна являются необязательными.
Диалоговые окна «О программе» часто содержат ссылки и адреса электронной почты. GtkAboutDialog отображает их как нажимаемые ссылки. По умолчанию он вызывает gtk_show_uri(), когда пользователь нажимает на них. Это поведение можно переопределить с помощью сигнала «activate-link».
Для указания человека с адресом электронной почты используйте строку вида "Edgar Allan Poe <edgarpoe.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.
Возвращает
новый созданный GtkAboutDialog
С: 2.6
gtk_about_dialog_get_program_name ()
const gchar *
gtk_about_dialog_get_program_name (GtkAboutDialog *about); Возвращает имя программы, отображаемое в диалоге о программе.
Параметры
about |
Возвращает
Имя программы. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.12
gtk_about_dialog_set-program-name ()
void gtk_about_dialog_set_program_name (GtkAboutDialog *about,const gchar *name);
Устанавливает имя для отображения в диалоге о программе. Если это не задано, оно по умолчанию равно g_get_application_name().
Параметры
about | ||
name | имя программы |
С: 2.12
gtk_about-dialog-get-version ()
const gchar *
gtk_about_dialog_get_version (GtkAboutDialog *about); Возвращает строку версии.
Параметры
about |
Возвращает
Строка версии. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_version ()
void gtk_about_dialog_set_version (GtkAboutDialog *about,const gchar *version);
Устанавливает строку версии, которая будет отображаться в диалоге о программе.
Параметры
about | ||
version | строка версии. | [allow-none] |
С: 2.6
gtk_about-dialog-get-copyright ()
const gchar *
gtk_about_dialog_get_copyright (GtkAboutDialog *about); Возвращает строку авторских прав.
Параметры
about |
Возвращает
Строка авторских прав. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about-dialog-set-copyright ()
void gtk_about_dialog_set_copyright (GtkAboutDialog *about,const gchar *copyright);
Устанавливает строку авторских прав для отображения в диалоге о программе. Это должна быть короткая строка в одну или две строки.
Параметры
about | ||
copyright | строка авторских прав. | [allow-none] |
С: 2.6
gtk_about_dialog_get_comments ()
const gchar *
gtk_about_dialog_get_comments (GtkAboutDialog *about); Возвращает строку комментариев.
Параметры
about |
Возвращаемое значение
Строка комментариев. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
С: 2.6
gtk_about_dialog_set_comments ()
void gtk_about_dialog_set_comments (GtkAboutDialog *about,const gchar *comments);
Устанавливает строку комментариев для отображения в диалоговом окне "О программе". Она должна быть короткой строкой из одной или двух строк.
Параметры
about | ||
comments | строка комментариев. | [allow-none] |
С: 2.6
gtk_about_dialog_get_license ()
const gchar *
gtk_about_dialog_get_license (GtkAboutDialog *about); Возвращает информацию о лицензии.
Параметры
about |
Возвращаемое значение
Информация о лицензии. Строка принадлежит диалоговому окну "О программе" и не должна изменяться.
С: 2.6
gtk_about_dialog_set_license ()
void gtk_about_dialog_set_license (GtkAboutDialog *about,const gchar *license);
Устанавливает информацию о лицензии, которая будет отображаться во вторичном диалоговом окне лицензии. Если license имеет значение NULL, кнопка лицензии скрывается.
Параметры
about | ||
license | информация о лицензии или | [allow-none] |
С: 2.6
gtk_about_dialog_get_wrap-license ()
gboolean
gtk_about_dialog_get_wrap_license (GtkAboutDialog *about); Возвращает, автоматически ли обрезается текст лицензии в about.
Параметры
about |
Возвращаемое значение
TRUE, если текст лицензии обрезается
С: 2.8
gtk_about_dialog_set-wrap-license ()
void gtk_about_dialog_set_wrap_license (GtkAboutDialog *about,gboolean wrap_license);
Устанавливает, автоматически ли обрезается текст лицензии в about.
Параметры
about | ||
wrap_license | указывается, следует ли обрезать лицензию |
С: 2.8
gtk_about_dialog_get_license_type ()
GtkLicense
gtk_about_dialog_get_license_type (GtkAboutDialog *about); Получает лицензию, установленную с помощью gtk_about_dialog_set_license_type()
Параметры
about |
Возвращает
значение GtkLicense
С версии: 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 веб-сайта. Строка принадлежит диалогу о приложении и её нельзя изменять.
С версии: 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 |
Возвращает
Метка, используемая для ссылки на веб-сайт. Строка принадлежит диалогу о приложении и её нельзя изменять.
С версии: 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, содержащий авторов. Массив принадлежит диалогу о программе и его нельзя изменять.
[array zero-terminated=1][transfer none]
Since: 2.6
gtk_about_dialog_set_authors ()
void gtk_about_dialog_set_authors (GtkAboutDialog *about,const gchar **authors);
Устанавливает строки, отображаемые во вкладке «Авторы» диалога вторичных данных об авторских правах.
Параметры
about | ||
authors | массив строк, завершающийся | [array zero-terminated=1] |
Since: 2.6
gtk_about_dialog_get_artists ()
const gchar * const *
gtk_about_dialog_get_artists (GtkAboutDialog *about); Возвращает строку, отображаемую во вкладке «Художники» диалога вторичных данных об авторских правах.
Параметры
about |
Возвращаемое значение
Массив строк, завершающийся NULL, содержащий художников. Массив принадлежит диалогу о программе и его нельзя изменять.
[array zero-terminated=1][transfer none]
Since: 2.6
gtk_about_dialog_set_artists ()
void gtk_about_dialog_set_artists (GtkAboutDialog *about,const gchar **artists);
Устанавливает строки, отображаемые во вкладке «Художники» диалога вторичных данных об авторских правах.
Параметры
about | ||
artists | массив строк, завершающийся | [array zero-terminated=1] |
Since: 2.6
gtk_about_dialog_get_documenters ()
const gchar * const *
gtk_about_dialog_get_documenters (GtkAboutDialog *about); Возвращает строку, отображаемую во вкладке «Документаторы» диалога вторичных данных об авторских правах.
Параметры
about |
Возвращаемое значение
Массив строк, завершающийся NULL, содержащий документаторов. Массив принадлежит диалогу о программе и его нельзя изменять.
[array zero-terminated=1][transfer none]
Since: 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 |
Возвращает
Строку с данными о переводчиках. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_translator_credits ()
void gtk_about_dialog_set_translator_credits (GtkAboutDialog *about,const gchar *translator_credits);
Устанавливает строку с данными о переводчиках, отображаемую во вкладке «Переводчики» диалога вторичных данных о лицензировании.
Предполагается, что эта строка отображает переводчика языка, который в данный момент используется в пользовательском интерфейсе. Используя gettext(), простой способ достижения этого - отметить строку для перевода:
gtk_show_about_dialog (NULL, "program-name", "ExampleCode", "logo", example_logo, "title" _("About ExampleCode"), NULL);
Рекомендуется использовать стандартный идентификатор «translator-credits», так как переводчики уже знакомы с его назначением, и 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);
Устанавливает пиксел для отображения логотипа в диалоговом окне «О программе». Если это NULL, будет использоваться значок окна по умолчанию, установленный с помощью gtk_window_set_default_icon().
Параметры
about | объект GtkAboutDialog | |
logo | объект GdkPixbuf или | [allow-none] |
С: 2.6
gtk_about_dialog_get_logo_icon_name ()
const gchar *
gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about); Возвращает имя значка, отображаемого в качестве логотипа в диалоговом окне «О программе».
Параметры
about | объект GtkAboutDialog |
Возвращаемое значение
имя отображаемого значка логотипа. Строка принадлежит диалоговому окну. Если вы хотите сохранить ссылку на неё, необходимо вызвать 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 | объект GtkAboutDialog | |
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 | Объект GtkAboutDialog | |
section_name | Имя раздела | |
people | Список участников этого раздела. | [array zero-terminated=1] |
С: 3.4
gtk_show_about_dialog ()
void gtk_show_about_dialog (GtkWindow *parent,const gchar *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. |
С: 3.0
Подробное описание свойств
Свойство “artists”
“artists” GStrv
Авторы графического дизайна программы, представленные в виде NULL-ограниченного массива строк. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки, см. введение для более подробной информации.
Флаги: Чтение / Запись
С версии: 2.6
Свойство “authors”
“authors” GStrv
Авторы программы, представленные в виде NULL-ограниченного массива строк. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки, см. введение для более подробной информации.
Флаги: Чтение / Запись
С версии: 2.6
Свойство “comments”
“comments” gchar *
Комментарии к программе. Эта строка отображается в метке основного диалогового окна, поэтому она должна содержать краткое описание основного назначения программы, а не подробный список функций.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “copyright”
“copyright” gchar *
Информация об авторских правах на программу.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “documenters”
“documenters” GStrv
Авторы документации к программе, представленные в виде NULL-ограниченного массива строк. Каждая строка может содержать электронные адреса и URL-адреса, которые будут отображаться как ссылки, см. введение для более подробной информации.
Флаги: Чтение / Запись
С версии: 2.6
Свойство “license”
“license” gchar *
Лицензия программы. Эта строка отображается в текстовом представлении во вторичном диалоговом окне, поэтому допустимо использование длинного текста с несколькими абзацами. Обратите внимание, что текст будет переносить строки только в текстовом представлении, если свойство "wrap-license" установлено в TRUE; в противном случае текст должен содержать необходимые переводы строк. При установке этого свойства на значение, отличное от NULL, свойство “тип-лицензии” автоматически устанавливается в GTK_LICENSE_CUSTOM.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “license-type”
“license-type” GtkLicense
Лицензия программы, представленная в виде значения перечисления GtkLicense.
Программа GtkAboutDialog автоматически заполнит стандартное уведомление и предоставит пользователю ссылку на соответствующий онлайн-ресурс с текстом лицензии.
Если используется GTK_LICENSE_UNKNOWN, ссылка будет той же, что указана в свойстве “сайт”.
Если используется GTK_LICENSE_CUSTOM, будут использоваться текущие данные свойства “лицензия”.
Для любого другого значения перечисления GtkLicense содержимое свойства “лицензия” также устанавливается этим свойством как побочный эффект.
Флаги: Чтение / Запись
Значение по умолчанию: GTK_LICENSE_UNKNOWN
С версии: 3.0
Свойство “logo”
“logo” GdkPixbuf *
Логотип для диалогового окна "О программе". Если это NULL, будет использоваться значок окна по умолчанию, заданный с помощью gtk_window_set_default_icon().
Флаги: Чтение / Запись
С версии: 2.6
Свойство “logo-icon-name”
“logo-icon-name” gchar *
Имя иконки, используемой в качестве логотипа в окне «О программе». Это свойство переопределяет свойство «logo».
Флаги: Чтение / Запись
Значение по умолчанию: "image-missing"
С версии: 2.6
Свойство “program-name”
“program-name” gchar *
Имя программы. Если это свойство не задано, используется значение по умолчанию из g_get_application_name().
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.12
Свойство “translator-credits”
“translator-credits” gchar *
Данные о переводчиках. Эта строка должна быть отмечена как переводимая. Строка может содержать адреса электронной почты и URL-адреса, которые будут отображаться как ссылки. Подробнее см. вводную часть.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “version”
“version” gchar *
Версия программы.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “website”
“website” gchar *
URL веб-сайта программы. Строка должна начинаться с «http://».
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “website-label”
“website-label” gchar *
Метка для ссылки на веб-сайт программы.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “wrap-license”
“wrap-license” gboolean
Указывает, нужно ли обрезать текст в окне лицензии.
Флаги: Чтение / Запись
Значение по умолчанию: FALSE
С версии: 2.8
Подробное описание сигналов
Сигнал “activate-link”
gboolean user_function (GtkAboutDialog *label, gchar *uri, gpointer user_data)
Сигнал, который срабатывает при активации URI. Приложения могут подключиться к нему, чтобы переопределить стандартное поведение, которое заключается в вызове gtk_show_uri().
Параметры
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.22/GtkAboutDialog.html