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

#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