GtkToolItem

GtkToolItem — Базовый класс виджетов, которые можно добавить в GtkToolShell

Функции

GtkToolItem *	gtk_tool_item_new ()
void	gtk_tool_item_set_homogeneous ()
gboolean	gtk_tool_item_get_homogeneous ()
void	gtk_tool_item_set_expand ()
gboolean	gtk_tool_item_get_expand ()
void	gtk_tool_item_set_tooltip_text ()
void	gtk_tool_item_set_tooltip_markup ()
void	gtk_tool_item_set_use_drag_window ()
gboolean	gtk_tool_item_get_use_drag_window ()
void	gtk_tool_item_set_visible_horizontal ()
gboolean	gtk_tool_item_get_visible_horizontal ()
void	gtk_tool_item_set_visible_vertical ()
gboolean	gtk_tool_item_get_visible_vertical ()
void	gtk_tool_item_set_is_important ()
gboolean	gtk_tool_item_get_is_important ()
PangoEllipsizeMode	gtk_tool_item_get_ellipsize_mode ()
GtkIconSize	gtk_tool_item_get_icon_size ()
GtkOrientation	gtk_tool_item_get_orientation ()
GtkToolbarStyle	gtk_tool_item_get_toolbar_style ()
GtkReliefStyle	gtk_tool_item_get_relief_style ()
gfloat	gtk_tool_item_get_text_alignment ()
GtkOrientation	gtk_tool_item_get_text_orientation ()
GtkWidget *	gtk_tool_item_retrieve_proxy_menu_item ()
GtkWidget *	gtk_tool_item_get_proxy_menu_item ()
void	gtk_tool_item_set_proxy_menu_item ()
void	gtk_tool_item_rebuild_menu ()
void	gtk_tool_item_toolbar_reconfigured ()
GtkSizeGroup *	gtk_tool_item_get_text_size_group ()

Свойства

gboolean	is-important	Чтение/Запись
gboolean	visible-horizontal	Чтение/Запись
gboolean	visible-vertical	Чтение/Запись

Сигналы

gboolean	create-menu-proxy	Выполнить последним
void	toolbar-reconfigured	Выполнить последним

Типы и значения

struct	GtkToolItem
struct	GtkToolItemClass

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

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkToolItem
                        ├── GtkToolButton
                        ╰── GtkSeparatorToolItem

Реализованные интерфейсы

GtkToolItem реализует AtkImplementorIface, GtkBuildable и GtkActivatable.

Файлы заголовков

#include <gtk/gtk.h>

Описание

GtkToolItems — виджеты, которые могут отображаться на панели инструментов. Для создания элемента панели инструментов, содержащего что-либо помимо кнопки, используйте gtk_tool_item_new(). Для добавления дочернего виджета в элемент панели инструментов используйте gtk_container_add().

Для элементов панели инструментов, содержащих кнопки, см. классы GtkToolButton, GtkToggleToolButton и GtkRadioToolButton.

Описание виджета панели инструментов см. в классе GtkToolbar, а описание интерфейса панели инструментов — в классе GtkToolShell.

Функции

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

void
gtk_tool_item_set_tooltip_text (GtkToolItem *tool_item,
                                const gchar *text);

Устанавливает текст, отображаемый в качестве всплывающей подсказки для элемента. См. gtk_widget_set_tooltip_text().

Параметры

tool_item	элемент GtkToolItem
text	текст, используемый в качестве всплывающей подсказки для `tool_item`

С версии: 2.12

void
gtk_tool_item_set_tooltip_markup (GtkToolItem *tool_item,
                                  const gchar *markup);

Устанавливает текст разметки, отображаемый в качестве всплывающей подсказки для элемента. См. gtk_widget_set_tooltip_markup().

Параметры

tool_item	элемент GtkToolItem
markup	текст разметки, используемый в качестве всплывающей подсказки для `tool_item`

С версии: 2.12

gtk_tool_item_set_use_drag_window ()

void
gtk_tool_item_set_use_drag_window (GtkToolItem *tool_item,
                                   gboolean use_drag_window);

Устанавливает, будет ли у tool_item окно перетаскивания. Если TRUE, то элемент может использоваться как источник перетаскивания через gtk_drag_source_set(). Если у tool_item есть окно перетаскивания, оно будет перехватывать все события, даже те, которые в противном случае были бы отправлены дочернему элементу tool_item.

Параметры

tool_item	элемент GtkToolItem
use_drag_window	Имеет ли `tool_item` окно перетаскивания.

С версии: 2.4

gtk_tool_item_get_use_drag_window ()

gboolean
gtk_tool_item_get_use_drag_window (GtkToolItem *tool_item);

Возвращает, имеет ли tool_item окно перетаскивания. См. gtk_tool_item_set_use_drag_window().

Параметры

tool_item

элемент GtkToolItem

Возвращаемое значение

TRUE, если tool_item использует окно перетаскивания.

С версии: 2.4

gtk_tool_item_set_visible_horizontal ()

void
gtk_tool_item_set_visible_horizontal (GtkToolItem *tool_item,
                                      gboolean visible_horizontal);

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

Параметры

tool_item	элемент GtkToolItem
visible_horizontal	Будет ли `tool_item` видимым в горизонтальном режиме

С версии: 2.4

gtk_tool_item_get_visible_horizontal ()

gboolean
gtk_tool_item_get_visible_horizontal (GtkToolItem *tool_item);

Возвращает, будет ли tool_item виден на панелях инструментов, прикрепленных горизонтально.

Параметры

tool_item

элемент GtkToolItem

Возвращаемое значение

TRUE, если tool_item виден на горизонтально прикреплённых панелях инструментов.

С версии: 2.4

gtk_tool_item_set_visible_vertical ()

void
gtk_tool_item_set_visible_vertical (GtkToolItem *tool_item,
                                    gboolean visible_vertical);

Устанавливает, будет ли tool_item видимым, когда панель инструментов прикреплена вертикально. Некоторые элементы панели инструментов, такие как текстовые поля, слишком широки, чтобы быть полезными на вертикальной панели инструментов. Если visible_vertical равен FALSE, tool_item не будет отображаться на вертикальных панелях инструментов.

Параметры

tool_item	элемент GtkToolItem
visible_vertical	является ли `tool_item` видимым, когда панель инструментов находится в вертикальном режиме

С: 2.4

gtk_tool_item_get_visible_vertical ()

gboolean
gtk_tool_item_get_visible_vertical (GtkToolItem *tool_item);

Возвращает, видимым ли tool_item является при вертикальном размещении панели инструментов. См. gtk_tool_item_set_visible_vertical().

Параметры

tool_item

элемент GtkToolItem

Возвращаемое значение

Будет ли tool_item видимым при вертикальном размещении панели инструментов

С: 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» установлено, что известно как «текст приоритета».

Параметры

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_ellipsize_mode ()

PangoEllipsizeMode
gtk_tool_item_get_ellipsize_mode (GtkToolItem *tool_item);

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

Параметры

tool_item

элемент GtkToolItem

Возвращаемое значение

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

С: 2.20

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 .

[type int]

С: 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

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, означающее, что элемент панели инструментов должен отображать и значок, и метку, расположенные горизонтально

Возвращает

a GtkOrientation указывающий ориентацию текста, используемого для tool_item

С версии: 2.20

GtkWidget *
gtk_tool_item_retrieve_proxy_menu_item
                               (GtkToolItem *tool_item);

Возвращает GtkMenuItem, который был последним задан функцией gtk_tool_item_set_proxy_menu_item(), то есть GtkMenuItem, который будет отображаться в меню переполнения.

Параметры

tool_item

a GtkToolItem

Возвращает

The GtkMenuItem that is going to appear in the overflow menu for tool_item .

[transfer none]

С версии: 2.4

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	a GtkToolItem
menu_item_id	строка, используемая для идентификации элемента меню

Возвращает

The GtkMenuItem passed to gtk_tool_item_set_proxy_menu_item(), if the menu_item_ids match.

[transfer none]

С версии: 2.4

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	a GtkToolItem
menu_item_id	строка, используемая для идентификации `menu_item`
menu_item	a GtkMenuItem to be used in the overflow menu

С версии: 2.4

void
gtk_tool_item_rebuild_menu (GtkToolItem *tool_item);

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

Функция должна вызываться, когда элемент инструмента изменяет свое поведение в ответ на сигнал “create-menu-proxy”.

Параметры

tool_item

a GtkToolItem

С версии: 2.6

void
gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item);

Инициирует сигнал “toolbar_reconfigured” на tool_item. Реализации GtkToolbar и других GtkToolShell используют эту функцию для уведомления дочерних элементов, когда меняется какой-либо аспект их конфигурации.

Параметры

tool_item

a GtkToolItem

С версии: 2.14

gtk_tool_item_get_text_size_group ()

GtkSizeGroup *
gtk_tool_item_get_text_size_group (GtkToolItem *tool_item);

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

Параметры

tool_item

a GtkToolItem

Возвращает

a GtkSizeGroup.

[transfer none]

С версии: 2.20

Типы и значения

struct GtkToolItem

struct GtkToolItem;

Структура GtkToolItem содержит только закрытые данные. К ней следует обращаться только через описанные ниже функции.

struct GtkToolItemClass

struct GtkToolItemClass {
  GtkBinClass parent_class;

  /* signals */
  gboolean   (* create_menu_proxy)    (GtkToolItem *tool_item);
  void       (* toolbar_reconfigured) (GtkToolItem *tool_item);
};

Члены

`create_menu_proxy` ()	Сигнал, генерируемый, когда панели инструментов нужны данные от tool_item о том, должен ли элемент отображаться в меню переполнения панели инструментов.
`toolbar_reconfigured` ()	Сигнал, генерируемый, когда меняется какой-либо аспект конфигурации панели инструментов, в которой элемент является дочерним элементом.

Подробные сведения о свойствах

Свойство `“is-important”`

  “is-important”             gboolean

Указывает, считается ли элемент на панели инструментов важным. При значении TRUE кнопки на панели инструментов отображают текст в режиме GTK_TOOLBAR_BOTH_HORIZ.

Флаги: Чтение/Запись

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

Свойство `“visible-horizontal”`

  “visible-horizontal”       gboolean

Определяет, будет ли элемент на панели инструментов отображаться при горизонтальной ориентации панели инструментов.

Флаги: Чтение/Запись

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

Свойство `“visible-vertical”`

  “visible-vertical”         gboolean

Определяет, будет ли элемент на панели инструментов отображаться при вертикальной ориентации панели инструментов.

Флаги: Чтение/Запись

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

Подробные сведения о сигналах

Сигнал `“create-menu-proxy”`

gboolean
user_function (GtkToolItem *tool_item,
               gpointer     user_data)

Этот сигнал генерируется, когда панели инструментов необходима информация от 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() для обновления кэша и обеспечения перестроения меню переполнения панели инструментов.

Параметры

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

Возвращаемое значение

TRUE если сигнал был обработан, FALSE если нет

Флаги: Run Last

Сигнал `“toolbar-reconfigured”`

void
user_function (GtkToolItem *tool_item,
               gpointer     user_data)

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

gtk_tool_shell_get_orientation()
gtk_tool_shell_get_style()
gtk_tool_shell_get_icon_size()
gtk_tool_shell_get_relief_style() для определения внешнего вида панели инструментов и соответствующего изменения собственных параметров.

Параметры

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

Флаги: Run Last

См. также

GtkToolbar, GtkToolButton, GtkSeparatorToolItem

© 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/GtkToolItem.html

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_text ()

Параметры

gtk_tool_item_set_tooltip_markup ()

Параметры

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_ellipsize_mode ()

Параметры

Возвращаемое значение

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_get_text_alignment ()

Параметры

Возвращает

gtk_tool_item_get_text_orientation ()

Параметры

Возвращает

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 ()

Параметры

gtk_tool_item_toolbar-reconfigured ()

Параметры

gtk_tool_item_get_text_size_group ()

Свойство `“is-important”`

Свойство `“visible-horizontal”`

Свойство `“visible-vertical”`

Сигнал `“create-menu-proxy”`

Сигнал `“toolbar-reconfigured”`