gtkstatusicon

			gtk+ reference manual
top \| description \| object hierarchy \| properties \| signals

gtkstatusicon — отображает значок в системном лотке

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

#include <gtk/gtk.h>


            gtkstatusicon;
gtkstatusicon* gtk_status_icon_new          (void);
gtkstatusicon* gtk_status_icon_new_from_pixbuf
                                            (gdkpixbuf *pixbuf);
gtkstatusicon* gtk_status_icon_new_from_file
                                            (const gchar *filename);
gtkstatusicon* gtk_status_icon_new_from_stock
                                            (const gchar *stock_id);
gtkstatusicon* gtk_status_icon_new_from_icon_name
                                            (const gchar *icon_name);
void        gtk_status_icon_set_from_pixbuf (gtkstatusicon *status_icon,
                                             gdkpixbuf *pixbuf);
void        gtk_status_icon_set_from_file   (gtkstatusicon *status_icon,
                                             const gchar *filename);
void        gtk_status_icon_set_from_stock  (gtkstatusicon *status_icon,
                                             const gchar *stock_id);
void        gtk_status_icon_set_from_icon_name
                                            (gtkstatusicon *status_icon,
                                             const gchar *icon_name);
gtkimagetype gtk_status_icon_get_storage_type
                                            (gtkstatusicon *status_icon);
gdkpixbuf*  gtk_status_icon_get_pixbuf      (gtkstatusicon *status_icon);
const gchar* gtk_status_icon_get_stock      (gtkstatusicon *status_icon);
const gchar* gtk_status_icon_get_icon_name  (gtkstatusicon *status_icon);
gint        gtk_status_icon_get_size        (gtkstatusicon *status_icon);
void        gtk_status_icon_set_tooltip     (gtkstatusicon *status_icon,
                                             const gchar *tooltip_text);
void        gtk_status_icon_set_visible     (gtkstatusicon *status_icon,
                                             gboolean visible);
gboolean    gtk_status_icon_get_visible     (gtkstatusicon *status_icon);
void        gtk_status_icon_set_blinking    (gtkstatusicon *status_icon,
                                             gboolean blinking);
gboolean    gtk_status_icon_get_blinking    (gtkstatusicon *status_icon);
gboolean    gtk_status_icon_is_embedded     (gtkstatusicon *status_icon);
void        gtk_status_icon_position_menu   (gtkmenu *menu,
                                             gint *x,
                                             gint *y,
                                             gboolean *push_in,
                                             gpointer user_data);
gboolean    gtk_status_icon_get_geometry    (gtkstatusicon *status_icon,
                                             gdkscreen **screen,
                                             gdkrectangle *area,
                                             gtkorientation *orientation);

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

  gobject
   +----gtkstatusicon

свойства

  "blinking"             gboolean              : read / write
  "file"                 gchararray            : write
  "icon-name"            gchararray            : read / write
  "pixbuf"               gdkpixbuf             : read / write
  "size"                 gint                  : read
  "stock"                gchararray            : read / write
  "storage-type"         gtkimagetype          : read
  "visible"              gboolean              : read / write

сигналы

"activate"  void        user_function      (gtkstatusicon *status_icon,
                                            gpointer       user_data)        : run first / action
"popup-menu"
            void        user_function      (gtkstatusicon *status_icon,
                                            guint          button,
                                            guint          activate_time,
                                            gpointer       user_data)          : run first / action
"size-changed"
            gboolean    user_function      (gtkstatusicon *status_icon,
                                            gint           size,
                                            gpointer       user_data)        : run last

описание

область уведомления или "system tray" обычно используется для размещения переходных значков указывающих некоторое специальное состояние. например, значок в системном лотке мог бы сообщить пользователю о пришедшем почтовом сообщении, или показывать быстрые короткие сообщения, или что нибудь аналогичное. основная идея в том, что значок в системном лотке выдающий небольшие сообщения является менее раздражающим, нежели всплывающий диалог.

gtkstatusicon объект может использоваться для отображения значка в системном лотке ("system tray"). значок может иметь подсказки, а пользователь может интерактивно взаимодействовать с ним, вызывая контекстное меню. критическая информация не должна отображаться только в gtkstatusicon, так как может быть невидима (например когда пользователь не включил на панели область уведомления). это может быть проверено с помощью gtk_status_icon_is_embedded().

в оконной системе x11, реализована следующая спецификация freedesktop.org "system tray" specification. осуществление "tray" аспекта этой спецификации может быть найдено например в gnome и kde.

помните gtkstatusicon это не виджет, а просто gobject. создание в виде виджета было бы не практично, так как системный лоток в win32 не позволяет внедрение произвольных виджетов.

детали

gtkstatusicon

typedef struct _gtkstatusicon gtkstatusicon;

gtk_status_icon_new ()

gtkstatusicon* gtk_status_icon_new          (void);

создаёт новый пустой объект значка состояния.

возвращает :

новый gtkstatusicon

начиная с версии 2.10

gtk_status_icon_new_from_pixbuf ()

gtkstatusicon* gtk_status_icon_new_from_pixbuf
                                            (gdkpixbuf *pixbuf);

создаёт новый значок состояния отображающий pixbuf.

изображение будет уменьшено для соответствия свободному пространству области уведомления при необходимости.

`pixbuf` :	gdkpixbuf
возвращает :	новый gtkstatusicon

начиная с версии 2.10

gtk_status_icon_new_from_file ()

gtkstatusicon* gtk_status_icon_new_from_file
                                            (const gchar *filename);

создаёт новый значок состояния отображающий файл filename.

`filename` :	имя файла
возвращает :	новый gtkstatusicon

начиная с версии 2.10

gtk_status_icon_new_from_stock ()

gtkstatusicon* gtk_status_icon_new_from_stock
                                            (const gchar *stock_id);

создаёт новый значок состояния отображающий заготовленный значок. например заготовленные значки с именами gtk_stock_open, gtk_stock_quit. вы можете зарегистрировать собственное имя заготовленного значка, смотрите gtk_icon_factory_add_default() и gtk_icon_factory_add().

`stock_id` :	id готового значка
возвращает :	новый gtkstatusicon

начиная с версии 2.10

gtk_status_icon_new_from_icon_name ()

gtkstatusicon* gtk_status_icon_new_from_icon_name
                                            (const gchar *icon_name);

создаёт новый значок состояния отображающий значок из текущемй темы значков. если текущая тема значков изменяется, значок будет соответственно обновляться.

`icon_name` :	имя значка
возвращает :	новый gtkstatusicon

начиная с версии 2.10

gtk_status_icon_set_from_pixbuf ()

void        gtk_status_icon_set_from_pixbuf (gtkstatusicon *status_icon,
                                             gdkpixbuf *pixbuf);

создаёт status_icon отображающий pixbuf. подробнее смотрите gtk_status_icon_new_from_pixbuf().

`status_icon` :	gtkstatusicon
`pixbuf` :	gdkpixbuf или `null`

начиная с версии 2.10

gtk_status_icon_set_from_file ()

void        gtk_status_icon_set_from_file   (gtkstatusicon *status_icon,
                                             const gchar *filename);

создаёт status_icon отображающий файл filename. подробнее смотрите gtk_status_icon_new_from_file().

`status_icon` :	gtkstatusicon
`filename` :	имя файла

начиная с версии 2.10

gtk_status_icon_set_from_stock ()

void        gtk_status_icon_set_from_stock  (gtkstatusicon *status_icon,
                                             const gchar *stock_id);

создаёт status_icon отображающий заготовленный значок с id stock_id. подробнее смотрите gtk_status_icon_new_from_stock().

`status_icon` :	gtkstatusicon
`stock_id` :	id заготовленного значка

начиная с версии 2.10

gtk_status_icon_set_from_icon_name ()

void        gtk_status_icon_set_from_icon_name
                                            (gtkstatusicon *status_icon,
                                             const gchar *icon_name);

создаёт status_icon отображающий значок по имени icon_name из текущемй темы значков. подробности смотрите gtk_status_icon_new_from_icon_name().

`status_icon` :	gtkstatusicon
`icon_name` :	имя значка

начиная с версии 2.10

gtk_status_icon_get_storage_type ()

gtkimagetype gtk_status_icon_get_storage_type
                                            (gtkstatusicon *status_icon);

получает тип изображения используемый gtkstatusicon для хранения данных изображения. если gtkstatusicon не имеет данных изображения, возвращаемое значение будет соответствовать gtk_image_empty.

`status_icon` :	gtkstatusicon
возвращает :	используемое изображение

начиная с версии 2.10

gtk_status_icon_get_pixbuf ()

gdkpixbuf*  gtk_status_icon_get_pixbuf      (gtkstatusicon *status_icon);

получает gdkpixbuf отображаемый gtkstatusicon. тип хранимого значка состояния должен быть gtk_image_empty или gtk_image_pixbuf (смотрите gtk_status_icon_get_storage_type()). вызывающий эту функцию не владеет ссылкой для возвращаемого изображения (pixbuf).

`status_icon` :	gtkstatusicon
возвращает :	отображаемый pixbuf, или `null` если изображение пустое.

начиная с версии 2.10

gtk_status_icon_get_stock ()

const gchar* gtk_status_icon_get_stock      (gtkstatusicon *status_icon);

получает id заготовленного значка отображаемого gtkstatusicon. тип хранимого значка состояния должен быть gtk_image_empty или gtk_image_stock (смотрите gtk_status_icon_get_storage_type()). возвращаемой строкой владеет gtkstatusicon и она не должна изменяться или освобождаться.

`status_icon` :	gtkstatusicon
возвращает :	id отображаемого заготовленного значка, или `null` если изображение пустое.

начиная с версии 2.10

gtk_status_icon_get_icon_name ()

const gchar* gtk_status_icon_get_icon_name  (gtkstatusicon *status_icon);

получает имя значка отображаемого gtkstatusicon. тип хранимого значка должен быть gtk_image_empty или gtk_image_icon_name (смотрите gtk_status_icon_get_storage_type()). возвращаемой строкой владеет gtkstatusicon и она не должна изменяться или освобождаться.

`status_icon` :	gtkstatusicon
возвращает :	имя отображаемого значка, или `null` если изображение пустое.

начиная с версии 2.10

gtk_status_icon_get_size ()

gint        gtk_status_icon_get_size        (gtkstatusicon *status_icon);

получает размер в пикселах который доступен для изображения. заготовленные значки и именованные значки адаптируются автоматически если изменяется размер области уведомления. для других типов хранения, может использоваться сигнал size-changed для реакции на изменение размера.

`status_icon` :	gtkstatusicon
возвращает :	размер который доступен для изображения

начиная с версии 2.10

gtk_status_icon_set_tooltip ()

void        gtk_status_icon_set_tooltip     (gtkstatusicon *status_icon,
                                             const gchar *tooltip_text);

устанавливает подсказку значка состояния.

`status_icon` :	gtkstatusicon
`tooltip_text` :	текст подсказки, или `null`

начиная с версии 2.10

gtk_status_icon_set_visible ()

void        gtk_status_icon_set_visible     (gtkstatusicon *status_icon,
                                             gboolean visible);

показывает или скрывает значок состояния.

`status_icon` :	gtkstatusicon
`visible` :	`true` для показа значка состояния, `false` для его скрытия

начиная с версии 2.10

gtk_status_icon_get_visible ()

gboolean    gtk_status_icon_get_visible     (gtkstatusicon *status_icon);

возвращает видим ли значок состояния или нет. помните что состояние видимости не гарантирует что пользователь реально видит значок, смотрите также gtk_status_icon_is_embedded().

`status_icon` :	gtkstatusicon
возвращает :	`true` если значок состояния видим

начиная с версии 2.10

gtk_status_icon_set_blinking ()

void        gtk_status_icon_set_blinking    (gtkstatusicon *status_icon,
                                             gboolean blinking);

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

`status_icon` :	gtkstatusicon
`blinking` :	`true` включает мерцание, `false` выключает

начиная с версии 2.10

gtk_status_icon_get_blinking ()

gboolean    gtk_status_icon_get_blinking    (gtkstatusicon *status_icon);

определяет мерцает ли значок, смотрите gtk_status_icon_set_blinking().

`status_icon` :	gtkstatusicon
возвращает :	`true` если значок мерцает

начиная с версии 2.10

gtk_status_icon_is_embedded ()

gboolean    gtk_status_icon_is_embedded     (gtkstatusicon *status_icon);

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

`status_icon` :	gtkstatusicon
возвращает :	`true` если значок встроен в область уведомления.

начиная с версии 2.10

gtk_status_icon_position_menu ()

void        gtk_status_icon_position_menu   (gtkmenu *menu,
                                             gint *x,
                                             gint *y,
                                             gboolean *push_in,
                                             gpointer user_data);

функция позиционирования меню для использования с gtk_menu_popup() размещающая menu выравненным относительно значка состояния user_data.

`menu` :	gtkmenu
`x` :	место для хранения возвращаемого значения x позиции
`y` :	место для хранения возвращаемого значения y позиции
`push_in` :	должно ли меню быть полного размера или сжатого.
`user_data` :	значок состояния для позиционирования меню

начиная с версии 2.10

gtk_status_icon_get_geometry ()

gboolean    gtk_status_icon_get_geometry    (gtkstatusicon *status_icon,
                                             gdkscreen **screen,
                                             gdkrectangle *area,
                                             gtkorientation *orientation);

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

помните, некторые платформы не позволяют gtk+ обеспечивать эту информацию.

`status_icon` :	gtkstatusicon
`screen` :	место для хранения возвращаемого значения экрана, или null если информация не нужна
`area` :	место для хранения возвращаемого значения области занятой значком или null
`orientation` :	место для хранения возвращаемого значения ориентации панели в которую встроен значок или null. панель может быть сверху, снизу, с право, с лево.
возвращает :	`true` если информация заполнена

начиная с версии 2.10

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

свойство "`blinking`"

  "blinking"             gboolean              : read / write

мерцает или нет значок состояния.

значение по умолчанию : false

свойство "`file`"

  "file"                 gchararray            : write

имя файла для загрузки и отображения.

значение по умолчанию : null

свойство "`icon-name`"

  "icon-name"            gchararray            : read / write

имя значка из темы значков.

значение по умолчанию : null

свойство "`pixbuf`"

  "pixbuf"               gdkpixbuf             : read / write

gdkpixbuf для отображения.

свойство "`size`"

  "size"                 gint                  : read

размер значка.

допустимые значения : >= 0

значение по умолчанию : 0

свойство "`stock`"

  "stock"                gchararray            : read / write

stock id заготовленного изображения для отображения.

значение по умолчанию : null

свойство "`storage-type`"

  "storage-type"         gtkimagetype          : read

представление используемое для данных изображения.

значение по умолчанию : gtk_image_empty

свойство "`visible`"

  "visible"              gboolean              : read / write

видим или нет значок состояния.

значение по умолчанию : true

детали сигналов

сигнал "activate"

void        user_function                  (gtkstatusicon *status_icon,
                                            gpointer       user_data)        : run first / action

издаётся когда пользователь активирует значок состояния. способы активизации значка состояния зависят от платформы.

`status_icon` :	объект получающий сигнал
`user_data` :	данные пользователя устанавливаемые при подключении обработчика сигнала.

начиная с версии 2.10

сигнал "popup-menu"

void        user_function                  (gtkstatusicon *status_icon,
                                            guint          button,
                                            guint          activate_time,
                                            gpointer       user_data)          : run first / action

издаётся когда пользователь вызывает содержимое меню значка состояния. могут ли значки состояния иметь меню и как они активизируются зависит от платформы.

параметры button и activate_timeout должны помещаться как последние аргументы в gtk_menu_popup().

`status_icon` :	объект получающий сигнал
`button` :	кнопка которая была нажата, или 0 если сигнал не издаётся в ответ на событие нажатой кнопки
`activate_time` :	пауза события которое выполняет распространение сигнала
`user_data` :	данные пользователя устанавливаемые при подключении обработчика сигнала.

начиная с версии 2.10

сигнал "size-changed"

gboolean    user_function                  (gtkstatusicon *status_icon,
                                            gint           size,
                                            gpointer       user_data)        : run last

издаётся когда допустимый размер для изображения изменяется, например изменился размер области уведомления.

`status_icon` :	объект получающий сигнал
`size` :	новый размер
`user_data` :	данные пользователя устанавливаемые при подключении обработчика сигнала.
возвращает :	`true` если значок был обновлен до нового размера. иначе, gtk+ растянет значок до необходимого размера.

начиная с версии 2.10

gtkstatusicon

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

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

свойства

сигналы

описание

детали

gtkstatusicon

gtk_status_icon_new ()

gtk_status_icon_new_from_pixbuf ()

gtk_status_icon_new_from_file ()

gtk_status_icon_new_from_stock ()

gtk_status_icon_new_from_icon_name ()

gtk_status_icon_set_from_pixbuf ()

gtk_status_icon_set_from_file ()

gtk_status_icon_set_from_stock ()

gtk_status_icon_set_from_icon_name ()

gtk_status_icon_get_storage_type ()

gtk_status_icon_get_pixbuf ()

gtk_status_icon_get_stock ()

gtk_status_icon_get_icon_name ()

gtk_status_icon_get_size ()

gtk_status_icon_set_tooltip ()

gtk_status_icon_set_visible ()

gtk_status_icon_get_visible ()

gtk_status_icon_set_blinking ()

gtk_status_icon_get_blinking ()

gtk_status_icon_is_embedded ()

gtk_status_icon_position_menu ()

gtk_status_icon_get_geometry ()

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

свойство "blinking"

свойство "file"

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

свойство "pixbuf"

свойство "size"

свойство "stock"

свойство "storage-type"

свойство "visible"

детали сигналов

сигнал "activate"

сигнал "popup-menu"

сигнал "size-changed"

свойство "`blinking`"

свойство "`file`"

свойство "`icon-name`"

свойство "`pixbuf`"

свойство "`size`"

свойство "`stock`"

свойство "`storage-type`"

свойство "`visible`"