ctk_tool_item_new ()

CtkToolItem *
ctk_tool_item_new (void);

Creates a new CtkToolItem

Since: 2.4

ctk_tool_item_set_homogeneous ()

void
ctk_tool_item_set_homogeneous (CtkToolItem *tool_item,
                               gboolean homogeneous);

Sets whether tool_item is to be allocated the same size as other homogeneous items. The effect is that all homogeneous items will have the same width as the widest of the items.

Since: 2.4

ctk_tool_item_get_homogeneous ()

gboolean
ctk_tool_item_get_homogeneous (CtkToolItem *tool_item);

Returns whether tool_item is the same size as other homogeneous items. See ctk_tool_item_set_homogeneous().

Since: 2.4

ctk_tool_item_set_expand ()

void
ctk_tool_item_set_expand (CtkToolItem *tool_item,
                          gboolean expand);

Sets whether tool_item is allocated extra space when there is more room on the toolbar then needed for the items. The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller.

Since: 2.4

ctk_tool_item_get_expand ()

gboolean
ctk_tool_item_get_expand (CtkToolItem *tool_item);

Returns whether tool_item is allocated extra space. See ctk_tool_item_set_expand().

Since: 2.4

ctk_tool_item_set_tooltip_text ()

void
ctk_tool_item_set_tooltip_text (CtkToolItem *tool_item,
                                const gchar *text);

Sets the text to be displayed as tooltip on the item. See ctk_widget_set_tooltip_text().

Since: 2.12

ctk_tool_item_set_tooltip_markup ()

void
ctk_tool_item_set_tooltip_markup (CtkToolItem *tool_item,
                                  const gchar *markup);

Sets the markup text to be displayed as tooltip on the item. See ctk_widget_set_tooltip_markup().

Since: 2.12

ctk_tool_item_set_use_drag_window ()

void
ctk_tool_item_set_use_drag_window (CtkToolItem *tool_item,
                                   gboolean use_drag_window);

Sets whether tool_item has a drag window. When TRUE the toolitem can be used as a drag source through ctk_drag_source_set(). When tool_item has a drag window it will intercept all events, even those that would otherwise be sent to a child of tool_item .

Since: 2.4

ctk_tool_item_get_use_drag_window ()

gboolean
ctk_tool_item_get_use_drag_window (CtkToolItem *tool_item);

Returns whether tool_item has a drag window. See ctk_tool_item_set_use_drag_window().

Since: 2.4

ctk_tool_item_set_visible_horizontal ()

void
ctk_tool_item_set_visible_horizontal (CtkToolItem *tool_item,
                                      gboolean visible_horizontal);

Sets whether tool_item is visible when the toolbar is docked horizontally.

Since: 2.4

ctk_tool_item_get_visible_horizontal ()

gboolean
ctk_tool_item_get_visible_horizontal (CtkToolItem *tool_item);

Returns whether the tool_item is visible on toolbars that are docked horizontally.

Since: 2.4

ctk_tool_item_set_visible_vertical ()

void
ctk_tool_item_set_visible_vertical (CtkToolItem *tool_item,
                                    gboolean visible_vertical);

Sets whether tool_item is visible when the toolbar is docked vertically. Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If visible_vertical is FALSE tool_item will not appear on toolbars that are docked vertically.

Since: 2.4

ctk_tool_item_get_visible_vertical ()

gboolean
ctk_tool_item_get_visible_vertical (CtkToolItem *tool_item);

Returns whether tool_item is visible when the toolbar is docked vertically. See ctk_tool_item_set_visible_vertical().

Since: 2.4

ctk_tool_item_set_is_important ()

void
ctk_tool_item_set_is_important (CtkToolItem *tool_item,
                                gboolean is_important);

Sets whether tool_item should be considered important. The CtkToolButton class uses this property to determine whether to show or hide its label when the toolbar style is CTK_TOOLBAR_BOTH_HORIZ. The result is that only tool buttons with the “is_important” property set have labels, an effect known as “priority text”

Since: 2.4

ctk_tool_item_get_is_important ()

gboolean
ctk_tool_item_get_is_important (CtkToolItem *tool_item);

Returns whether tool_item is considered important. See ctk_tool_item_set_is_important()

Since: 2.4

ctk_tool_item_get_ellipsize_mode ()

PangoEllipsizeMode
ctk_tool_item_get_ellipsize_mode (CtkToolItem *tool_item);

Returns the ellipsize mode used for tool_item . Custom subclasses of CtkToolItem should call this function to find out how text should be ellipsized.

Since: 2.20

ctk_tool_item_get_icon_size ()

CtkIconSize
ctk_tool_item_get_icon_size (CtkToolItem *tool_item);

Returns the icon size used for tool_item . Custom subclasses of CtkToolItem should call this function to find out what size icons they should use.

Since: 2.4

ctk_tool_item_get_orientation ()

CtkOrientation
ctk_tool_item_get_orientation (CtkToolItem *tool_item);

Returns the orientation used for tool_item . Custom subclasses of CtkToolItem should call this function to find out what size icons they should use.

Since: 2.4

ctk_tool_item_get_toolbar_style ()

CtkToolbarStyle
ctk_tool_item_get_toolbar_style (CtkToolItem *tool_item);

Returns the toolbar style used for tool_item . Custom subclasses of CtkToolItem should call this function in the handler of the CtkToolItem::toolbar_reconfigured signal to find out in what style the toolbar is displayed and change themselves accordingly

Possibilities are:

Since: 2.4

ctk_tool_item_get_relief_style ()

CtkReliefStyle
ctk_tool_item_get_relief_style (CtkToolItem *tool_item);

Returns the relief style of tool_item . See ctk_button_set_relief(). Custom subclasses of CtkToolItem should call this function in the handler of the “toolbar_reconfigured” signal to find out the relief style of buttons.

Since: 2.4

ctk_tool_item_get_text_alignment ()

gfloat
ctk_tool_item_get_text_alignment (CtkToolItem *tool_item);

Returns the text alignment used for tool_item . Custom subclasses of CtkToolItem should call this function to find out how text should be aligned.

Since: 2.20

ctk_tool_item_get_text_orientation ()

CtkOrientation
ctk_tool_item_get_text_orientation (CtkToolItem *tool_item);

Returns the text orientation used for tool_item . Custom subclasses of CtkToolItem should call this function to find out how text should be orientated.

Since: 2.20

ctk_tool_item_retrieve_proxy_menu_item ()

CtkWidget *
ctk_tool_item_retrieve_proxy_menu_item
                               (CtkToolItem *tool_item);

Returns the CtkMenuItem that was last set by ctk_tool_item_set_proxy_menu_item(), ie. the CtkMenuItem that is going to appear in the overflow menu.

Since: 2.4

ctk_tool_item_get_proxy_menu_item ()

CtkWidget *
ctk_tool_item_get_proxy_menu_item (CtkToolItem *tool_item,
                                   const gchar *menu_item_id);

If menu_item_id matches the string passed to ctk_tool_item_set_proxy_menu_item() return the corresponding CtkMenuItem.

Custom subclasses of CtkToolItem should use this function to update their menu item when the CtkToolItem changes. That the menu_item_ids must match ensures that a CtkToolItem will not inadvertently change a menu item that they did not create.

Since: 2.4

ctk_tool_item_set_proxy_menu_item ()

void
ctk_tool_item_set_proxy_menu_item (CtkToolItem *tool_item,
                                   const gchar *menu_item_id,
                                   CtkWidget *menu_item);

Sets the CtkMenuItem used in the toolbar overflow menu. The menu_item_id is used to identify the caller of this function and should also be used with ctk_tool_item_get_proxy_menu_item().

See also “create-menu-proxy”.

Since: 2.4

ctk_tool_item_rebuild_menu ()

void
ctk_tool_item_rebuild_menu (CtkToolItem *tool_item);

Calling this function signals to the toolbar that the overflow menu item for tool_item has changed. If the overflow menu is visible when this function it called, the menu will be rebuilt.

The function must be called when the tool item changes what it will do in response to the “create-menu-proxy” signal.

Since: 2.6

ctk_tool_item_toolbar_reconfigured ()

void
ctk_tool_item_toolbar_reconfigured (CtkToolItem *tool_item);

Emits the signal “toolbar_reconfigured” on tool_item . CtkToolbar and other CtkToolShell implementations use this function to notify children, when some aspect of their configuration changes.

Since: 2.14

ctk_tool_item_get_text_size_group ()

CtkSizeGroup *
ctk_tool_item_get_text_size_group (CtkToolItem *tool_item);

Returns the size group used for labels in tool_item . Custom subclasses of CtkToolItem should call this function and use the size group for labels.

Since: 2.20

struct CtkToolItem

struct CtkToolItem;

The CtkToolItem struct contains only private data. It should only be accessed through the functions described below.

struct CtkToolItemClass

struct CtkToolItemClass {
  CtkBinClass parent_class;

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

The “is-important” property

  “is-important”             gboolean

Whether the toolbar item is considered important. When TRUE, toolbar buttons show text in CTK_TOOLBAR_BOTH_HORIZ mode.

Owner: CtkToolItem

Flags: Read / Write

Default value: FALSE

The “visible-horizontal” property

  “visible-horizontal”       gboolean

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

Owner: CtkToolItem

Flags: Read / Write

Default value: TRUE

The “visible-vertical” property

  “visible-vertical”         gboolean

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

Owner: CtkToolItem

Flags: Read / Write

Default value: TRUE

The “create-menu-proxy” signal

gboolean
user_function (CtkToolItem *tool_item,
               gpointer     user_data)

This signal is emitted when the toolbar needs information from tool_item about whether the item should appear in the toolbar overflow menu. In response the tool item should either

The toolbar may cache the result of this signal. When the tool item changes how it will respond to this signal it must call ctk_tool_item_rebuild_menu() to invalidate the cache and ensure that the toolbar rebuilds its overflow menu.

Flags: Run Last

The “toolbar-reconfigured” signal

void
user_function (CtkToolItem *tool_item,
               gpointer     user_data)

This signal is emitted when some property of the toolbar that the item is a child of changes. For custom subclasses of CtkToolItem, the default handler of this signal use the functions

Flags: Run Last