gtktoolitem

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

gtktoolitem — основной класс виджетов добавляемых к gtktoolbar

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

#include <gtk/gtk.h>


            gtktoolitem;
gtktoolitem* gtk_tool_item_new              (void);
void        gtk_tool_item_set_homogeneous   (gtktoolitem *tool_item,
                                             gboolean homogeneous);

gboolean    gtk_tool_item_get_homogeneous   (gtktoolitem *tool_item);
void        gtk_tool_item_set_expand        (gtktoolitem *tool_item,
                                             gboolean expand);

gboolean    gtk_tool_item_get_expand        (gtktoolitem *tool_item);
void        gtk_tool_item_set_tooltip       (gtktoolitem *tool_item,
                                             gtktooltips *tooltips,
                                             const gchar *tip_text,
                                             const gchar *tip_private);
void        gtk_tool_item_set_use_drag_window

                                            (gtktoolitem *toolitem,
                                             gboolean use_drag_window);
gboolean    gtk_tool_item_get_use_drag_window
                                            (gtktoolitem *toolitem);
void        gtk_tool_item_set_visible_horizontal

                                            (gtktoolitem *toolitem,
                                             gboolean visible_horizontal);
gboolean    gtk_tool_item_get_visible_horizontal
                                            (gtktoolitem *toolitem);
void        gtk_tool_item_set_visible_vertical

                                            (gtktoolitem *toolitem,
                                             gboolean visible_vertical);
gboolean    gtk_tool_item_get_visible_vertical
                                            (gtktoolitem *toolitem);
void        gtk_tool_item_set_is_important  (gtktoolitem *tool_item,
                                             gboolean is_important);

gboolean    gtk_tool_item_get_is_important  (gtktoolitem *tool_item);
gtkiconsize gtk_tool_item_get_icon_size     (gtktoolitem *tool_item);
gtkorientation gtk_tool_item_get_orientation

                                            (gtktoolitem *tool_item);
gtktoolbarstyle gtk_tool_item_get_toolbar_style
                                            (gtktoolitem *tool_item);
gtkreliefstyle gtk_tool_item_get_relief_style

                                            (gtktoolitem *tool_item);
gtkwidget*  gtk_tool_item_retrieve_proxy_menu_item
                                            (gtktoolitem *tool_item);
gtkwidget*  gtk_tool_item_get_proxy_menu_item

                                            (gtktoolitem *tool_item,
                                             const gchar *menu_item_id);
void        gtk_tool_item_set_proxy_menu_item
                                            (gtktoolitem *tool_item,
                                             const gchar *menu_item_id,
                                             gtkwidget *menu_item);
void        gtk_tool_item_rebuild_menu      (gtktoolitem *tool_item);

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

  gobject
   +----ginitiallyunowned
         +----gtkobject

               +----gtkwidget
                     +----gtkcontainer
                           +----gtkbin
                                 +----gtktoolitem
                                       +----gtktoolbutton
                                       +----gtkseparatortoolitem

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

gtktoolitem осуществляет atkimplementoriface.

свойства

  "is-important"         gboolean              : read / write
  "visible-horizontal"   gboolean              : read / write
  "visible-vertical"     gboolean              : read / write

сигналы

"create-menu-proxy"
            gboolean    user_function      (gtktoolitem *toolitem,
                                            gpointer     user_data)      : run last
"set-tooltip"
            gboolean    user_function      (gtktoolitem *toolitem,
                                            gtktooltips *tooltips,
                                            gchar       *tip_text,
                                            gchar       *tip_private,
                                            gpointer     user_data)        : run last
"toolbar-reconfigured"
            void        user_function      (gtktoolitem *toolitem,
                                            gpointer     user_data)      : run last

описание

gtktoolitem является виджетом для добавления на панель инструментов. для создания пункта панели инструментов содержащего что то ещё кроме кнопки, используйте gtk_tool_item_new(). для добавления дочернего виджета к пункту меню используйте gtk_container_add().

для пунктов панели инструментов которые содержат кнопки, смотрите gtktoolbutton, gtktoggletoolbutton и gtkradiotoolbutton классы.

смотрите класс gtktoolbar описывающий виджет панель инструментов.

детали

gtktoolitem

typedef struct _gtktoolitem gtktoolitem;

gtktoolitem структура содержит только закрытые данные. доступ к ней должен осуществляеться функциями описанными ниже.

gtk_tool_item_new ()

gtktoolitem* gtk_tool_item_new              (void);

создаёт новый gtktoolitem

возвращает :

новый gtktoolitem

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

gtk_tool_item_set_homogeneous ()

void        gtk_tool_item_set_homogeneous   (gtktoolitem *tool_item,
                                             gboolean homogeneous);

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

`tool_item` :	gtktoolitem:
`homogeneous` :	должен ли `tool_item` иметь однородный размер с другими пунктами

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

gtk_tool_item_get_homogeneous ()

gboolean    gtk_tool_item_get_homogeneous   (gtktoolitem *tool_item);

определяет имеет ли tool_item однородный размер с другими пунктами. смотрите gtk_tool_item_set_homogeneous().

`tool_item` :	gtktoolitem:
возвращает :	`true` если пункт однородного размера с другими пунктами.

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

gtk_tool_item_set_expand ()

void        gtk_tool_item_set_expand        (gtktoolitem *tool_item,
                                             gboolean expand);

устанавливает должен ли tool_item расширятся на всё свободное пространство если на панели его больше чем нужно для пункта. это заставляет пункт увеличиваться при увеличении панели и уменьшаться при её уменьшении.

`tool_item` :	gtktoolitem:
`expand` :	должен ли `tool_item` расширяться на всё доступное пространство.

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

gtk_tool_item_get_expand ()

gboolean    gtk_tool_item_get_expand        (gtktoolitem *tool_item);

определяет расширяется ли tool_item на всё доступное пространство. смотрите gtk_tool_item_set_expand().

`tool_item` :	gtktoolitem:
возвращает :	`true` если `tool_item` расширяется на всё доступное пространство.

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

gtk_tool_item_set_tooltip ()

void        gtk_tool_item_set_tooltip       (gtktoolitem *tool_item,
                                             gtktooltips *tooltips,
                                             const gchar *tip_text,
                                             const gchar *tip_private);

устанавливает объект gtktooltips используемый для tool_item, текст отображаемый как подсказка для пункта и дополнительный текст подсказки. смотрите gtk_tooltips_set_tip().

`tool_item` :	gtktoolitem:
`tooltips` :	используемый объект gtktooltips
`tip_text` :	текст используемый как подсказка для `tool_item`
`tip_private` :	текст используемый как дополнительная подсказка

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

gtk_tool_item_set_use_drag_window ()

void        gtk_tool_item_set_use_drag_window
                                            (gtktoolitem *toolitem,
                                             gboolean use_drag_window);

устанавливает имеет ли toolitem окно для перемещения. если true инструментальный пункт может использоваться как источник для перемещения с помощью gtk_drag_source_set(). когда toolitem имеет окно для перемещения оно будет перехватывать все события, даже те которые посланы дочернему виджету toolitem.

`toolitem` :	gtktoolitem
`use_drag_window` :	имеет ли `toolitem` окно для перемещения.

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

gtk_tool_item_get_use_drag_window ()

gboolean    gtk_tool_item_get_use_drag_window
                                            (gtktoolitem *toolitem);

определяет имеет ли toolitem окно для перемещения. смотрите gtk_tool_item_set_use_drag_window().

`toolitem` :	gtktoolitem
возвращает :	`true` если `toolitem` использует окно для перемещения.

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

gtk_tool_item_set_visible_horizontal ()

void        gtk_tool_item_set_visible_horizontal
                                            (gtktoolitem *toolitem,
                                             gboolean visible_horizontal);

устанавливает видим ли toolitem при горизонтальном расположении панели инструментов.

`toolitem` :	gtktoolitem
`visible_horizontal` :	видим ли `toolitem` при горизонтальном режиме панели

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

gtk_tool_item_get_visible_horizontal ()

gboolean    gtk_tool_item_get_visible_horizontal
                                            (gtktoolitem *toolitem);

определяет видим ли toolitem при горизонтальном режиме расположения панели.

`toolitem` :	gtktoolitem
возвращает :	`true` если `toolitem` видим при горизонтальном расположении панели.

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

gtk_tool_item_set_visible_vertical ()

void        gtk_tool_item_set_visible_vertical
                                            (gtktoolitem *toolitem,
                                             gboolean visible_vertical);

устанавливает видим ли toolitem при вертикальном расположении панели. некоторые инструментальные пункты, такие как поле для ввода текста, являются слишком широкими для размещения на вертикальной панели. если visible_vertical равен false toolitem не будет размещаться на вертикально расположенной панели инструментов.

`toolitem` :	gtktoolitem
`visible_vertical` :	должен ли быть видим `toolitem` при вертикальном режиме

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

gtk_tool_item_get_visible_vertical ()

gboolean    gtk_tool_item_get_visible_vertical
                                            (gtktoolitem *toolitem);

определяет видим ли toolitem при вертикальном расположении панели. смотрите gtk_tool_item_set_visible_vertical().

`toolitem` :	gtktoolitem
возвращает :	видим ли `toolitem` при вертикальном расположении

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

gtk_tool_item_set_is_important ()

void        gtk_tool_item_set_is_important  (gtktoolitem *tool_item,
                                             gboolean is_important);

устанавливает должен ли tool_item рассматриваться как важный. gtktoolbutton класс использует это свойство для определения показывать или скрыть ярлык когда стиль панели инструментов установлен в gtk_toolbar_both_horiz. как результат только инструментальные кнопки со свойством "is_important" имеют ярлыки, эффект известный как "priority text"

`tool_item` :	gtktoolitem
`is_important` :	должен ли инструментальный пункт рассматриваться как важный

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

gtk_tool_item_get_is_important ()

gboolean    gtk_tool_item_get_is_important  (gtktoolitem *tool_item);

определяет рассматривается ли tool_item как важный. смотрите gtk_tool_item_set_is_important()

`tool_item` :	gtktoolitem
возвращает :	`true` если `tool_item` рассматривается как важный.

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

gtk_tool_item_get_icon_size ()

gtkiconsize gtk_tool_item_get_icon_size     (gtktoolitem *tool_item);

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

`tool_item` :	gtktoolitem:
возвращает :	gtkiconsize указывает размер значка используемый для `tool_item`

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

gtk_tool_item_get_orientation ()

gtkorientation gtk_tool_item_get_orientation
                                            (gtktoolitem *tool_item);

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

`tool_item` :	gtktoolitem:
возвращает :	gtkorientation указывает ориентацию используемую для `tool_item`

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

gtk_tool_item_get_toolbar_style ()

gtktoolbarstyle gtk_tool_item_get_toolbar_style
                                            (gtktoolitem *tool_item);

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

возможные стили:

gtk_toolbar_both, означает отображение пункта панели с текстом под значком
gtk_toolbar_icons, означает отображение только значков на панели инструментов
gtk_toolbar_text, означает отображение пунктов панели только в виде текста
gtk_toolbar_both_horiz, означает отображение значков и текста размещенных рядом друг с другом горизонтально (однако помните, gtktoolbutton::has_text_horizontally не показывает ярлыки когда стиль панели инструментов установлен в gtk_toolbar_both_horiz).

`tool_item` :	gtktoolitem:
возвращает :	gtktoolbarstyle указывает стиль панели инструментов для `tool_item`.

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

gtk_tool_item_get_relief_style ()

gtkreliefstyle gtk_tool_item_get_relief_style
                                            (gtktoolitem *tool_item);

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

`tool_item` :	gtktoolitem:
возвращает :	gtkreliefstyle указывает стиль рельефа используемый для `tool_item`.

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

gtk_tool_item_retrieve_proxy_menu_item ()

gtkwidget*  gtk_tool_item_retrieve_proxy_menu_item
                                            (gtktoolitem *tool_item);

определяет последний установленный gtkmenuitem с помощью gtk_tool_item_set_proxy_menu_item(), то есть gtkmenuitem который будет появляться в меню переполнения панели.

`tool_item` :	gtktoolitem:
возвращает :	gtkmenuitem который появиться в меню переполнения для `tool_item`.

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

gtk_tool_item_get_proxy_menu_item ()

gtkwidget*  gtk_tool_item_get_proxy_menu_item
                                            (gtktoolitem *tool_item,
                                             const gchar *menu_item_id);

если menu_item_id соответствует строке помещаемой в gtk_tool_item_set_proxy_menu_item() возвращается соответствующий gtkmenuitem.

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

`tool_item` :	gtktoolitem:
`menu_item_id` :	строка используемая для идентификации пунктов меню
возвращает :	gtkmenuitem помещаемый в `gtk_tool_item_set_proxy_menu_item()`, если `menu_item_id`s соответствует.

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

gtk_tool_item_set_proxy_menu_item ()

void        gtk_tool_item_set_proxy_menu_item
                                            (gtktoolitem *tool_item,
                                             const gchar *menu_item_id,
                                             gtkwidget *menu_item);

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

`tool_item` :	gtktoolitem:
`menu_item_id` :	строка используемая для идентификации `menu_item`
`menu_item` :	gtkmenuitem используемый в меню переполнения

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

gtk_tool_item_rebuild_menu ()

void        gtk_tool_item_rebuild_menu      (gtktoolitem *tool_item);

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

функция должна вызываться когда изменяется инструментальный пункт в ответ на сигнал "create_menu_proxy".

tool_item :

gtktoolitem

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

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

свойство "`is-important`"

  "is-important"         gboolean              : read / write

должен ли пункт панели рассматриваться как важный. если true, кнопки панели инструментов показывают текст в режиме gtk_toolbar_both_horiz.

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

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

  "visible-horizontal"   gboolean              : read / write

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

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

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

  "visible-vertical"     gboolean              : read / write

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

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

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

сигнал "create-menu-proxy"

gboolean    user_function                  (gtktoolitem *toolitem,
                                            gpointer     user_data)      : run last

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

вызвать gtk_tool_item_set_proxy_menu_item() с null указателем и вернуть true указывая что этот пункт не должен появляться в меню переполнения панели
вызвать gtk_tool_item_set_proxy_menu_item() с новым пунктом меню и вернуть true, или
вернуть false указывая на то, что сигнал не был обработан пунктом. это значит что пункт не появиться в меню переполнения панели если более поздний обработчик не установит пункт меню.

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

`toolitem` :	объект издающий сигнал
`user_data` :	пользовательские данные устанавливаемые при подключении обработчика
возвращает :	`true` если сигнал был обработан, `false` if not

сигнал "set-tooltip"

gboolean    user_function                  (gtktoolitem *toolitem,
                                            gtktooltips *tooltips,
                                            gchar       *tip_text,
                                            gchar       *tip_private,
                                            gpointer     user_data)        : run last

this signal is emitted when the toolitem's tooltip changes. application developers can use gtk_tool_item_set_tooltip() to set the item's tooltip.

`toolitem` :	объект издающий сигнал
`tooltips` :	the gtktooltips
`tip_text` :	the tooltip text
`tip_private` :	the tooltip private text
`user_data` :	пользовательские данные устанавливаемые при подключении обработчика
возвращает :	`true` если сигнал был обработан, `false` если нет

сигнал "toolbar-reconfigured"

void        user_function                  (gtktoolitem *toolitem,
                                            gpointer     user_data)      : run last

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

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

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

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

gtktoolbar

виджет панели инструментов

gtktoolbutton

подкласс gtktoolitem отображающий кнопки на панели инструментов

gtkseparatortoolitem

подкласс gtktoolitem который разделяет группы пунктов на панели инструментов

gtktoolitem

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

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

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

свойства

сигналы

описание

детали

gtktoolitem

gtk_tool_item_new ()

gtk_tool_item_set_homogeneous ()

gtk_tool_item_get_homogeneous ()

gtk_tool_item_set_expand ()

gtk_tool_item_get_expand ()

gtk_tool_item_set_tooltip ()

gtk_tool_item_set_use_drag_window ()

gtk_tool_item_get_use_drag_window ()

gtk_tool_item_set_visible_horizontal ()

gtk_tool_item_get_visible_horizontal ()

gtk_tool_item_set_visible_vertical ()

gtk_tool_item_get_visible_vertical ()

gtk_tool_item_set_is_important ()

gtk_tool_item_get_is_important ()

gtk_tool_item_get_icon_size ()

gtk_tool_item_get_orientation ()

gtk_tool_item_get_toolbar_style ()

gtk_tool_item_get_relief_style ()

gtk_tool_item_retrieve_proxy_menu_item ()

gtk_tool_item_get_proxy_menu_item ()

gtk_tool_item_set_proxy_menu_item ()

gtk_tool_item_rebuild_menu ()

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

свойство "is-important"

свойство "visible-horizontal"

свойство "visible-vertical"

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

сигнал "create-menu-proxy"

сигнал "set-tooltip"

сигнал "toolbar-reconfigured"

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

свойство "`is-important`"

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

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