[ новости /+++ | форум | теги | ]

Каталог документации / Раздел "Программирование, языки" / Оглавление документа

Краткое описание

#include <gtk/gtk.h>


            GtkAboutDialog;
GtkWidget*  gtk_about_dialog_new            (void);
const gchar* gtk_about_dialog_get_name      (GtkAboutDialog *about);
void        gtk_about_dialog_set_name       (GtkAboutDialog *about,
                                             const gchar *name);
const gchar* gtk_about_dialog_get_version   (GtkAboutDialog *about);
void        gtk_about_dialog_set_version    (GtkAboutDialog *about,
                                             const gchar *version);
const gchar* gtk_about_dialog_get_copyright (GtkAboutDialog *about);
void        gtk_about_dialog_set_copyright  (GtkAboutDialog *about,
                                             const gchar *copyright);
const gchar* gtk_about_dialog_get_comments  (GtkAboutDialog *about);
void        gtk_about_dialog_set_comments   (GtkAboutDialog *about,
                                             const gchar *comments);
const gchar* gtk_about_dialog_get_license   (GtkAboutDialog *about);
void        gtk_about_dialog_set_license    (GtkAboutDialog *about,
                                             const gchar *license);
gboolean    gtk_about_dialog_get_wrap_license
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_wrap_license
                                            (GtkAboutDialog *about,
                                             gboolean wrap_license);
const gchar* gtk_about_dialog_get_website   (GtkAboutDialog *about);
void        gtk_about_dialog_set_website    (GtkAboutDialog *about,
                                             const gchar *website);
const gchar* gtk_about_dialog_get_website_label
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_website_label
                                            (GtkAboutDialog *about,
                                             const gchar *website_label);
const gchar* const * gtk_about_dialog_get_authors
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_authors    (GtkAboutDialog *about,
                                             const gchar **authors);
const gchar* const * gtk_about_dialog_get_artists
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_artists    (GtkAboutDialog *about,
                                             const gchar **artists);
const gchar* const * gtk_about_dialog_get_documenters
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_documenters
                                            (GtkAboutDialog *about,
                                             const gchar **documenters);
const gchar* gtk_about_dialog_get_translator_credits
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_translator_credits
                                            (GtkAboutDialog *about,
                                             const gchar *translator_credits);
GdkPixbuf*  gtk_about_dialog_get_logo       (GtkAboutDialog *about);
void        gtk_about_dialog_set_logo       (GtkAboutDialog *about,
                                             GdkPixbuf *logo);
const gchar* gtk_about_dialog_get_logo_icon_name
                                            (GtkAboutDialog *about);
void        gtk_about_dialog_set_logo_icon_name
                                            (GtkAboutDialog *about,
                                             const gchar *icon_name);
void        (*GtkAboutDialogActivateLinkFunc)
                                            (GtkAboutDialog *about,
                                             const gchar *link,
                                             gpointer data);
GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_email_hook
                                            (GtkAboutDialogActivateLinkFunc func,
                                             gpointer data,
                                             GDestroyNotify destroy);
GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_url_hook
                                            (GtkAboutDialogActivateLinkFunc func,
                                             gpointer data,
                                             GDestroyNotify destroy);
void        gtk_show_about_dialog           (GtkWindow *parent,
                                             const gchar *first_property_name,
                                             ...);

Иерархия объектов

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----GtkAboutDialog

Осуществляемые интерфейсы

GtkAboutDialog осуществляет AtkImplementorIface.

Свойства

  "artists"              GStrv                 : Read / Write
  "authors"              GStrv                 : Read / Write
  "comments"             gchararray            : Read / Write
  "copyright"            gchararray            : Read / Write
  "documenters"          GStrv                 : Read / Write
  "license"              gchararray            : Read / Write
  "logo"                 GdkPixbuf             : Read / Write
  "logo-icon-name"       gchararray            : Read / Write
  "name"                 gchararray            : Read / Write
  "translator-credits"   gchararray            : Read / Write
  "version"              gchararray            : Read / Write
  "website"              gchararray            : Read / Write
  "website-label"        gchararray            : Read / Write
  "wrap-license"         gboolean              : Read / Write

Описание

GtkAboutDialog предлагает простой способ отображения информации о программе такой как эмблема, имя, авторское право, вебсайт и лицензия. Так же возможно предоставление информации об авторе, документации, переводах и прочей информации о программе. Диалог (about dialog) обычно открывается когда пользователь выбирает опцию About в меню Help. Все части диалога являются опциональными.

Диалог (About dialog) часто содержит ссылки и email адреса. GtkAboutDialog поддерживает их предлагая глобальные обработчики прерываний, которые вызываются когда пользователь нажимает на ссылку или email адрес, смотрите gtk_about_dialog_set_email_hook() и gtk_about_dialog_set_url_hook(). Email адреса в свойствах автор, документация и оформитель выглядят как <user@host>, URLs выглядят как http://url, где url распределяется до следующего пробела, табуляции или конца строки.

Чтобы сделать конструкцию GtkAboutDialog удобной на сколько это возможно, вы можете использовать функцию gtk_show_about_dialog() которая конструирует и показывает диалог.

Детали

GtkAboutDialog

typedef struct _GtkAboutDialog GtkAboutDialog;

GtkAboutDialog структура содержит только закрытые данные и не должна использоваться непосредственно.

gtk_about_dialog_new ()

GtkWidget*  gtk_about_dialog_new            (void);

Создаёт новый GtkAboutDialog.

Начиная с версии 2.6

gtk_about_dialog_get_name ()

const gchar* gtk_about_dialog_get_name      (GtkAboutDialog *about);

Возвращает имя программы отображаемое в диалоге (about dialog).

Начиная с версии 2.6

gtk_about_dialog_set_name ()

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

Устанавливает имя для отображения в диалоге (about dialog). Если оно не установлено, то по умолчанию g_get_application_name().

Начиная с версии 2.6

gtk_about_dialog_get_version ()

const gchar* gtk_about_dialog_get_version   (GtkAboutDialog *about);

Возвращает строку с версией программы.

Начиная с версии 2.6

gtk_about_dialog_set_version ()

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

Устанавливает строку версии отображаемой в диалоге (about dialog).

Начиная с версии 2.6

gtk_about_dialog_get_copyright ()

const gchar* gtk_about_dialog_get_copyright (GtkAboutDialog *about);

Возвращает строку авторского права.

Начиная с версии 2.6

gtk_about_dialog_set_copyright ()

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

Устанавливает строку авторского права отображаемой в диалоге. Это должна быть короткая строка в одну или две линии.

Начиная с версии 2.6

gtk_about_dialog_get_comments ()

const gchar* gtk_about_dialog_get_comments  (GtkAboutDialog *about);

Возвращает строку комментарий.

Начиная с версии 2.6

gtk_about_dialog_set_comments ()

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

Устанавливает строку комментарий отображаемой в диалоге. Это должна быть короткая строка в одну или две линии.

Начиная с версии 2.6

gtk_about_dialog_get_license ()

const gchar* gtk_about_dialog_get_license   (GtkAboutDialog *about);

Возвращает информацию о лицензии.

Начиная с версии 2.6

gtk_about_dialog_set_license ()

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

Устанавливает информацию о лицензии отображаемой во вторичном диалоге (license dialog). Если license равно NULL, кнопка «лицензия» скрыта.

Начиная с версии 2.6

gtk_about_dialog_get_wrap_license ()

gboolean    gtk_about_dialog_get_wrap_license
                                            (GtkAboutDialog *about);

Определяет нужно ли автоматически заворачивать текст лицензии в about.

Начиная с версии 2.8

gtk_about_dialog_set_wrap_license ()

void        gtk_about_dialog_set_wrap_license
                                            (GtkAboutDialog *about,
                                             gboolean wrap_license);

Устанавливает нужно ли автоматически заворачивать текст лицензии в about.

Начиная с версии 2.8

gtk_about_dialog_get_website ()

const gchar* gtk_about_dialog_get_website   (GtkAboutDialog *about);

Возвращает URL вебсайта.

Начиная с версии 2.6

gtk_about_dialog_set_website ()

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

Устанавливает URL используемый для ссылки на вебсайт.

Начиная с версии 2.6

gtk_about_dialog_get_website_label ()

const gchar* gtk_about_dialog_get_website_label
                                            (GtkAboutDialog *about);

Возвращает метку используемую для ссылки вебсайта.

Начиная с версии 2.6

gtk_about_dialog_set_website_label ()

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

Устанавливает метку используемую для ссылки вебсайта. По умолчанию это URL.

Начиная с версии 2.6

gtk_about_dialog_get_authors ()

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

Возвращает строку которая отображается во вкладке автор вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_set_authors ()

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

Устанавливает строки которые отображаются во вкладке авторы вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_get_artists ()

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

Возвращает строку которая отображается во вкладке оформители вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_set_artists ()

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

Устанавливает строки которые отображаются во вкладке оформители вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_get_documenters ()

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

Возвращает которая отображается во вкладке документация вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_set_documenters ()

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

Устанавливает строку которая отображается во вкладке документация вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_get_translator_credits ()

const gchar* gtk_about_dialog_get_translator_credits
                                            (GtkAboutDialog *about);

Возвращает строку содержащую переводчиков и отображаемую во вкладке перевод вторичного диалога (credits dialog).

Начиная с версии 2.6

gtk_about_dialog_set_translator_credits ()

void        gtk_about_dialog_set_translator_credits
                                            (GtkAboutDialog *about,
                                             const gchar *translator_credits);

Устанавливает строку содержащую переводчиков и отображаемую во вкладке перевод вторичного диалога (credits dialog).

Предполагается использовать эту строку для отображения текущемго языкового перевода используемого в пользовательском интерфейсе. Использование gettext(), простой способ добиться маркировки строки для перевода:

 gtk_about_dialog_set_translator_credits (about, _("translator-credits"));

Хорошая идея использовать общепринятые msgid "translator-credits" для этой цели, так как переводчики будут уже знать результат этого msgid, и так как GtkAboutDialog обнаружит если "translator-credits" будут не переведены и скроет вкладку.

Начиная с версии 2.6

gtk_about_dialog_get_logo ()

GdkPixbuf*  gtk_about_dialog_get_logo       (GtkAboutDialog *about);

Возвращает pixbuf отображаемый как логотип в диалоге (about dialog).

Начиная с версии 2.6

gtk_about_dialog_set_logo ()

void        gtk_about_dialog_set_logo       (GtkAboutDialog *about,
                                             GdkPixbuf *logo);

Устанавливает pixbuf для отображения логотипа в диалоге (about dialog). Если равен NULL, по умолчанию значок окна устанавливается с помощью gtk_window_set_default_icon().

Начиная с версии 2.6

gtk_about_dialog_get_logo_icon_name ()

const gchar* gtk_about_dialog_get_logo_icon_name
                                            (GtkAboutDialog *about);

Возвращает имя значка отображаемого как логотип в диалоге (about dialog).

Начиная с версии 2.6

gtk_about_dialog_set_logo_icon_name ()

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

Устанавливает pixbuf отображаемый как логотип в диалоге (about dialog). Если равен NULL, по умолчанию значок окна устанавливается с помощью gtk_window_set_default_icon().

Начиная с версии 2.6

GtkAboutDialogActivateLinkFunc ()

void        (*GtkAboutDialogActivateLinkFunc)
                                            (GtkAboutDialog *about,
                                             const gchar *link,
                                             gpointer data);

Тип функции которая вызывается когда URL или email ссылка активизируется.

gtk_about_dialog_set_email_hook ()

GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_email_hook
                                            (GtkAboutDialogActivateLinkFunc func,
                                             gpointer data,
                                             GDestroyNotify destroy);

Устанавливает глобальную функцию которая вызывается когда пользователь активизирует email ссылку в диалоге (about dialog).

Начиная с версии 2.6

gtk_about_dialog_set_url_hook ()

GtkAboutDialogActivateLinkFunc gtk_about_dialog_set_url_hook
                                            (GtkAboutDialogActivateLinkFunc func,
                                             gpointer data,
                                             GDestroyNotify destroy);

Устанавливает глобальную функцию вызываемую когда пользователь активизирует URL ссылку в диалоге (about dialog).

Начиная с версии 2.6

gtk_show_about_dialog ()

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

Это функция удобства для отображения окна информации о приложении. Конструируемый диалог ассоциируется с родительским окном и многократно используется для будущих запросов этой функции.

Начиная с версии 2.6

Свойство деталей

Свойство "artists"

  "artists"              GStrv                 : Read / Write

Люди которые внесли вклад в художественное оформление программы, в виде строк NULL-завершенного массива. Каждая строка может содержать email адрес и URLs, которые отображаются как ссылки, смотрите подробности выше.

Начиная с версии 2.6

Свойство "authors"

  "authors"              GStrv                 : Read / Write

Авторы программы, в виде строк NULL-завершенного массива. Каждая строка может содержать email адрес и URLs, которые отображаются как ссылки, смотрите подробности выше.

Начиная с версии 2.6

Свойство "comments"

  "comments"             gchararray            : Read / Write

Комментарии к программе. Эта строка отображается в ярлыке основного диалога, поэтому это должно быть короткое объяснение основных функций программы, а не детализированный список особенностей.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "copyright"

  "copyright"            gchararray            : Read / Write

Информация об авторском праве для программы.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "documenters"

  "documenters"          GStrv                 : Read / Write

Люди документирующие программу, как строки NULL-завершенного массива. Каждая строка может содержать email адрес и URLs, которые отображаются как ссылки, смотрите подробности выше.

Начиная с версии 2.6

Свойство "license"

  "license"              gchararray            : Read / Write

Лицензия программы. Эта стока отображается во вторичном диалоге в области просмотра текста, поэтому это может быть длинный текст. Помните этот текст завернут в область просмотра текста только если "wrap-license" свойство установлено в TRUE; иначе сам текст должен содержать намеченный linebreaks.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "logo"

  "logo"                 GdkPixbuf             : Read / Write

Логотип диалога (about box). Если не установлен, то по умолчанию gtk_window_get_default_icon_list().

Начиная с версии 2.6

Свойство "logo-icon-name"

  "logo-icon-name"       gchararray            : Read / Write

Именованный значок используемый как логотип для диалога (about box). Это свойство отменяет свойство logo.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "name"

  "name"                 gchararray            : Read / Write

Имя программы. Если не утановлено, то по умолчанию g_get_application_name().

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "translator-credits"

  "translator-credits"   gchararray            : Read / Write

Переводчики. Эта строка должна быть помечена как переводимая. Эта строка может содержать email адрес и URLs, которые отображаются как ссылки, смотрите подробности выше.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "version"

  "version"              gchararray            : Read / Write

Версия программы.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "website"

  "website"              gchararray            : Read / Write

URL для ссылки на вебсайт программы. Это должна быть строка начинающаяся с "http://.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "website-label"

  "website-label"        gchararray            : Read / Write

Метка для ссылки на вебсайт программы. Если не установлена, то по умолчанию используется URL определенный в свойстве website.

Значение по умолчанию: NULL

Начиная с версии 2.6

Свойство "wrap-license"

  "wrap-license"         gboolean              : Read / Write

Должен ли быть обернут текст в диалоге лицензия.

Значение по умолчанию: FALSE

Начиная с версии 2.8

Смотрите также

GTK_STOCK_ABOUT

Партнёры:

Хостинг: