GtkAboutDialog
GtkAboutDialog — Отображение информации о приложении
Функции
Свойства
| GStrv | artists | Чтение / Запись |
| GStrv | authors | Чтение / Запись |
| gchar * | comments | Чтение / Запись |
| gchar * | copyright | Чтение / Запись |
| GStrv | documenters | Чтение / Запись |
| gchar * | лицензия | Чтение / Запись |
| GtkLicense | тип лицензии | Чтение / Запись |
| GdkPixbuf * | логотип | Чтение / Запись |
| gchar * | имя значка логотипа | Чтение / Запись |
| gchar * | название программы | Чтение / Запись |
| gchar * | благодарности переводчикам | Чтение / Запись |
| gchar * | версия | Чтение / Запись |
| gchar * | веб-сайт | Чтение / Запись |
| gchar * | метка веб-сайта | Чтение / Запись |
| gboolean | обертка лицензии | Чтение / Запись |
Типы и Значения
| struct | GtkAboutDialog |
| перечисление | GtkLicense |
Иерархия объектов
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkWindow ╰── GtkDialog ╰── GtkAboutDialog
Реализованные интерфейсы
GtkAboutDialog реализует AtkImplementorIface и GtkBuildable.
Включаемые файлы
#include <gtk/gtk.h>
Описание
GtkAboutDialog предоставляет простой способ отображения информации о программе, например, её логотипа, имени, авторских прав, веб-сайта и лицензии. Также можно указать вклад авторов, составителей документации, переводчиков и художников, участвовавших в разработке программы. Окно "О программе" обычно открывается, когда пользователь выбирает опцию About в меню Help. Все части окна являются необязательными.
Окна "О программе" часто содержат ссылки и адреса электронной почты. GtkAboutDialog отображает их как нажимаемые ссылки. По умолчанию, он вызывает gtk_show_uri() при нажатии пользователем на ссылку. Поведение можно изменить с помощью сигнала «активировать ссылку».
Для указания человека с адресом электронной почты используйте строку вида "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 | объект GtkAboutDialog |
Возвращает
Имя программы. Строка принадлежит диалогу о программе и не должна изменяться.
С: 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 | объект GtkAboutDialog | |
name | имя программы |
С: 2.12
gtk_about_dialog_get_version ()
const gchar *
gtk_about_dialog_get_version (GtkAboutDialog *about); Возвращает строку версии.
Параметры
about | объект GtkAboutDialog |
Возвращает
Строку версии. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_version ()
void gtk_about_dialog_set_version (GtkAboutDialog *about,const gchar *version);
Устанавливает строку версии, которая будет отображаться в диалоге о программе.
Параметры
about | объект GtkAboutDialog | |
version | строка версии. | [allow-none] |
С: 2.6
gtk_about_dialog_get_copyright ()
const gchar *
gtk_about_dialog_get_copyright (GtkAboutDialog *about); Возвращает строку авторских прав.
Параметры
about | объект GtkAboutDialog |
Возвращает
Строка авторских прав. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_copyright ()
void gtk_about_dialog_set_copyright (GtkAboutDialog *about,const gchar *copyright);
Устанавливает строку авторских прав, которая будет отображаться в диалоге о программе. Должна быть короткой строкой из одной или двух строк.
Параметры
about | объект GtkAboutDialog | |
copyright | строка авторских прав. | [allow-none] |
С: 2.6
gtk_about_dialog_get_comments ()
const gchar *
gtk_about_dialog_get_comments (GtkAboutDialog *about); Возвращает строку комментариев.
Параметры
about | объект GtkAboutDialog |
Возвращает
Строка комментариев. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_comments ()
void gtk_about_dialog_set_comments (GtkAboutDialog *about,const gchar *comments);
Устанавливает строку комментариев, которая будет отображаться в диалоге о программе. Должна быть короткой строкой из одной или двух строк.
Параметры
about | объект GtkAboutDialog | |
comments | строка комментариев. | [allow-none] |
С: 2.6
gtk_about_dialog_get_license ()
const gchar *
gtk_about_dialog_get_license (GtkAboutDialog *about); Возвращает информацию о лицензии.
Параметры
about | объект GtkAboutDialog |
Возвращает
Информация о лицензии. Строка принадлежит диалогу о программе и не должна изменяться.
С: 2.6
gtk_about_dialog_set_license ()
void gtk_about_dialog_set_license (GtkAboutDialog *about,const gchar *license);
Устанавливает информацию о лицензии, которая будет отображаться во вторичном диалоге лицензии. Если license равен NULL, кнопка лицензии скрыта.
Параметры
about | объект GtkAboutDialog | |
license | информация о лицензии или | [allow-none] |
С: 2.6
gtk_about_dialog_get_wrap_license ()
gboolean
gtk_about_dialog_get_wrap_license (GtkAboutDialog *about); Возвращает значение, указывающее, автоматически ли обрезается текст лицензии в about.
Параметры
about | объект GtkAboutDialog |
Возвращает
TRUE, если текст лицензии обрезается
С: 2.8
gtk_about_dialog_set_wrap_license ()
void gtk_about_dialog_set_wrap_license (GtkAboutDialog *about,gboolean wrap_license);
Устанавливает значение, указывающее, автоматически ли обрезается текст лицензии в about.
Параметры
about | объект GtkAboutDialog | |
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 | объект GtkAboutDialog |
Возвращает
значение 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-адрес веб-сайта. Строка принадлежит диалоговому окну 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(), простой способ добиться этого — пометить строку для перевода:
gtk_show_about_dialog(NULL, "program-name","ExampleCode", "logo", example_logo, "title"_("About ExampleCode"), NULL);
Рекомендуется использовать стандартный идентификатор сообщения «translator-credits», так как переводчики уже знакомы с его назначением, и GtkAboutDialog обнаружит, если «translator-credits» не переведено, и скроет вкладку.
Параметры
about | объект GtkAboutDialog | |
translator_credits | благодарности переводчику. | [allow-none] |
С: 2.6
gtk_about_dialog_get_logo ()
GdkPixbuf *
gtk_about_dialog_get_logo (GtkAboutDialog *about); Возвращает pixbuf, отображаемый в качестве логотипа в диалоге о приложении.
Параметры
about | объект GtkAboutDialog |
Возвращаемое значение
отображаемый 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 | объект GtkAboutDialog | |
logo | [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 Lesser General Public License, версия 2.1 или более поздняя | |
GTK_LICENSE_LGPL_3_0 | GNU Lesser General Public License, версия 3.0 или более поздняя | |
GTK_LICENSE_BSD | Стандартная лицензия BSD | |
GTK_LICENSE_MIT_X11 | Стандартная лицензия MIT/X11 | |
GTK_LICENSE_ARTISTIC | Лицензия Artistic, версия 2.0 | |
GTK_LICENSE_GPL_2_0_ONLY | GNU General Public License, версия 2.0 только. С версии 3.12. | |
GTK_LICENSE_GPL_3_0_ONLY | GNU General Public License, версия 3.0 только. С версии 3.12. | |
GTK_LICENSE_LGPL_2_1_ONLY | GNU Lesser General Public License, версия 2.1 только. С версии 3.12. | |
GTK_LICENSE_LGPL_3_0_ONLY | GNU Lesser General Public License, версия 3.0 только. С версии 3.12. |
С версии: 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, свойство «license-type» устанавливается в GTK_LICENSE_CUSTOM как побочный эффект.
Флаги: Чтение / Запись
Значение по умолчанию: NULL
С версии: 2.6
Свойство “license-type”
“license-type” GtkLicense
Лицензия программы в виде значения перечисления GtkLicense.
Компонент GtkAboutDialog автоматически заполнит стандартное предупреждение и предоставит пользователю ссылку на соответствующий онлайн-ресурс для текста лицензии.
Если используется GTK_LICENSE_UNKNOWN, ссылка будет той же, что указана в свойстве «website».
Если используется GTK_LICENSE_CUSTOM, будут использоваться текущие данные свойства «license».
Для любого другого значения GtkLicense содержимое свойства «license» также устанавливается этим свойством как побочный эффект.
Флаги: Чтение / Запись
Значение по умолчанию: 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, если ссылка была активирована
Флаги: Run Last
С версии: 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.20/GtkAboutDialog.html